Skip to content

Commit

Permalink
Merge pull request #119 from ReneeVandervelde/docs-update
Browse files Browse the repository at this point in the history 
Docs update
  • Loading branch information
@ReneeVandervelde
ReneeVandervelde authored May 21, 2023
2 parents a051922 + 07fdf54 commit 1912d9c
Show file tree
Hide file tree
Showing 126 changed files with 11,842 additions and 758 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Change Log

- Devices module for getting/updating device metadata.
- Resources module for listing bridge resources
- Scenes module for getting/updating scenes definitions for rooms.

### Deprecated:

- Deprecated value class list accessors, due to unbounded nature of collections.
- Deprecated value class `valueOf` methods in favor of using constructor directly.

2.0.0
-----
Expand Down
89 changes: 89 additions & 0 deletions docs/cli-overview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,67 @@ <h1>Bridge Discovery</h1>
port: 443
</code></pre>
</section>
<section>
<header>
<a name="security" href="#security">
<h1>Security</h1>
</a>
</header>
<p>
Shade is configured to use HTTPS by default when connecting to
the hue bridge. However, since connections are done on a local
network, the SSL certificate from the hue bridge must be trusted
on your system before establishing a connection.
</p>
<p>
For each command, you have the option to specify a security
scheme used for the HTTP connections.
</p>
<article>
<h2>Platform Trust (Default)</h2>
<p>
Platform trust is the default trust strategy for Shade.
This will defer validation of the HTTPS connection to your platform,
meaning you will have to manually install or mark the certificate
as trusted on your system in order to connect to the hue bridge.
</p>
<p>
This option requires no configuration within Shade. However,
it requires that the certificate be manually trusted in your
system.
</p>
</article>
<article>
<h2>Insecure Connection</h2>
<p>
If you trust the network that your commands are running on,
you can ignore the SSL connection with the <code>--insecure</code>
flag when running commands.
</p>
<p>
For security reasons it is not recommended that you use an
insecure connection unless you are on a trusted network.
</p>
</article>
<article>
<h2>Hue CA</h2>
<p>
The hue bridge is
<a href="https://developers.meethue.com/develop/application-design-guidance/using-https/">configured</a>
to use a custom CA in its HTTPS certificates. You can configure
Shade to trust this root certificate manually, by specifying
the IP and device ID of the bridge that were obtained during
discovery in the
<a href="reference/latest/structures/inkapplications.shade.structures/-properties-file-configuration/index.html">
Properties File
</a>
located in your home directory: <code>$HOME/.shade-cli.properties</code>
</p>
<pre><code class="properties">hostname=01234xxabcdef
security=hue
ip=192.168.1.5</code></pre>
</article>
</section>
<section>
<header>
<a name="authorize" href="#authorize">
Expand Down Expand Up @@ -307,5 +368,33 @@ <h1>Resources</h1>
</li>
</ul>
</section>
<section>
<header>
<a name="control-scenes" href="#control-scenes">
<h1>Scenes</h1>
</header>
<p>
You can control scenes with the following commands:
</p>
<ul>
<li>
<code>list-scenes</code> To get a list of all scenes configured
on the Hue bridge.
</li>
<li>
<code>get-scene</code> To get information for a single scene.
</li>
<li>
<code>update-scene</code> To update the configuration of a
specified scene.
</li>
<li>
<code>create-scene</code> To create a new scene.
</li>
<li>
<code>delete-scene</code> To remove a scene from the Hue bridge.
</li>
</ul>
</section>
</body>
</html>
223 changes: 169 additions & 54 deletions docs/reference/latest/auth/navigation.html
View file

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions docs/reference/latest/core/inkapplications.shade.core/-shade/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,21 @@ <h2 class="">Properties</h2>
</div>
</div>
</div>
<a data-name="-936743062%2FProperties%2F-2011752812" anchor-label="scenes" id="-936743062%2FProperties%2F-2011752812" data-filterable-set=":core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/commonMain" data-filterable-set=":core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="scenes.html"><span><span>scenes</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-936743062%2FProperties%2F-2011752812"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/commonMain"><a data-name="-936743062%2FProperties%2F-2011752812" anchor-label="scenes" id="-936743062%2FProperties%2F-2011752812" data-filterable-set=":core:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="scenes.html">scenes</a><span class="token operator">: </span><a href="../../../scenes/inkapplications.shade.scenes/-scene-controls/index.html">SceneControls</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1266496930%2FProperties%2F-2011752812" anchor-label="zones" id="1266496930%2FProperties%2F-2011752812" data-filterable-set=":core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/commonMain" data-filterable-set=":core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
Expand Down
66 changes: 66 additions & 0 deletions docs/reference/latest/core/inkapplications.shade.core/-shade/scenes.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>scenes</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>shade</span> </a> </div>
<div>latest
</div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":core:dokkaHtmlPartial/commonMain">common</button>
</div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageids="core::inkapplications.shade.core/Shade/scenes/#/PointingToDeclaration//-2011752812">
<div class="breadcrumbs"><a href="../../index.html">core</a><span class="delimiter">/</span><a href="../index.html">inkapplications.shade.core</a><span class="delimiter">/</span><a href="index.html">Shade</a><span class="delimiter">/</span><span class="current">scenes</span></div>
<div class="cover ">
<h1 class="cover"><span><span>scenes</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="scenes.html">scenes</a><span class="token operator">: </span><a href="../../../scenes/inkapplications.shade.scenes/-scene-controls/index.html">SceneControls</a></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>

</body></html>

Loading

0 comments on commit 1912d9c

Please sign in to comment.