jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-11-15 22:44:41 UTC

Browse source
This commit is contained in:
Travis CI 2017-11-15 22:44:42 +00:00
parent 42f8c0dd23
commit f483e8e1b8
31 changed files with 139 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

13
components/binary_sensor.digital_ocean/index.html
View file

@ -84,10 +84,15 @@
<span class="pi">-</span> <span class="s1">'</span><span class="s">coreos-512mb-nyc3-01'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>droplets</strong> (<em>Required</em>): List of droplets you want to control.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="droplets" href="#droplets"></a> droplets</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Required)</span><span class="description">List of droplets you want to monitor.</span></p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

14
components/binary_sensor.iss/index.html
View file

@ -82,10 +82,16 @@
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">iss</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>show_on_map</strong> (<em>Optional</em>): Option to show the position of the ISS on the map. Defaults to <code class="highlighter-rouge">False</code>.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="show_on_map" href="#show_on_map"></a> show_on_map</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optionsl)</span><span class="description">Option to show the position of the ISS on the map.</span></p>
<p class="default">Default value: false</p>
</dd>
</dl>
</div>
<p class="note warning">
If you set <code class="highlighter-rouge">show_on_map</code> <code class="highlighter-rouge">True</code> then the location attributes are named <code class="highlighter-rouge">latitude</code> and <code class="highlighter-rouge">longitude</code>. The default name of the location attributes is <code class="highlighter-rouge">lat</code> and <code class="highlighter-rouge">long</code> to avoid showing them on the map.
</p>

13
components/digital_ocean/index.html
View file

@ -82,10 +82,15 @@
<span class="s">access_token</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>access_token</strong> (<em>Required</em>): Your Digital Ocean API access token.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="access_token" href="#access_token"></a> access_token</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">Your Digital Ocean API access token.</span></p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

31
components/sensor.random/index.html
View file

@ -81,13 +81,30 @@
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">random</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): Name of the sensor to use in the frontend. Defaults to <code class="highlighter-rouge">Random Sensor</code>.</li>
<li><strong>minimum</strong> (<em>Optional</em>): Lower limit for the values. Defaults to <code class="highlighter-rouge">0</code>.</li>
<li><strong>maximum</strong> (<em>Optional</em>): Upper limit for the values. Defaults to <code class="highlighter-rouge">20</code>.</li>
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the units of measurement of the sensor, if any.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Name to use in the frontend.</span></p>
<p class="default">Default value: Random Sensor</p>
</dd>
<dt><a class="title-link" name="minimum" href="#minimum"></a> minimum</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Lower limit for the values.</span></p>
<p class="default">Default value: 0</p>
</dd>
<dt><a class="title-link" name="maximum" href="#maximum"></a> maximum</dt>
<dd>
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">Upper limit for the values.</span></p>
<p class="default">Default value: 20</p>
</dd>
<dt><a class="title-link" name="unit_of_measurement" href="#unit_of_measurement"></a> unit_of_measurement</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Defines the units of measurement of the sensor, if any.</span></p>
</dd>
</dl>
</div>
<p>See the <a href="https://home-assistant.io/docs/configuration/platform_options/">entity component options</a> to control how often the main component polls the random sensor. The default is 30 seconds.</p>
</article>
</div>

13
components/switch.digital_ocean/index.html
View file

@ -84,10 +84,15 @@
<span class="pi">-</span> <span class="s1">'</span><span class="s">coreos-512mb-nyc3-01'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>droplets</strong> (<em>Required</em>): List of droplets you want to control.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="droplets" href="#droplets"></a> droplets</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Required)</span><span class="description">List of droplets you want to control.</span></p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

19
components/weather.bom/index.html
View file

@ -80,11 +80,20 @@
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">bom</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): The name you would like to give to the weather station.</li>
<li><strong>station</strong> (<em>Optional</em>): The station ID string; defaults to the closest station. See the <a href="/components/sensor.bom/"><code class="highlighter-rouge">sensor.bom</code> docs</a> for details on how to find the ID of a station.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The name you would like to give to the weather station.</span></p>
</dd>
<dt><a class="title-link" name="station" href="#station"></a> station</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The station ID string. See the <a href="/components/sensor.bom/"><code class="highlighter-rouge">sensor.bom</code> docs</a> for details on how to find the ID of a station.</span></p>
<p class="default">Default value: The closest station</p>
</dd>
</dl>
</div>
<p class="note">
This platform is an alternative to the <a href="/components/sensor.bom/"><code class="highlighter-rouge">bom</code></a> sensor.
The weather platform is easier to configure but less customizable.