Site updated at 2017-11-04 22:24:03 UTC
This commit is contained in:
Travis CI
parent
5d3bdbdafa
commit
6c2a38f42c
30 changed files with 168 additions and 112 deletions
|
|
@ -98,30 +98,38 @@ your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
|||
</dd>
|
||||
<dd>
|
||||
<dl class="nested">
|
||||
<dt><a class="title-link" name="friendly_name" href="#friendly_name"></a> friendly_name</dt>
|
||||
<dt><a class="title-link" name="sensor_name" href="#sensor_name"></a> sensor_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="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Required)</span><span class="description">The slug of the sensor.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="entity_id" href="#entity_id"></a> entity_id</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string, list">string | list</span>)</span><span class="required">(Optional)</span><span class="description">Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="device_class" href="#device_class"></a> device_class</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="device_class"><a href="/components/binary_sensor/#device_class">device_class</a></span>)</span><span class="required">(Optional)</span><span class="description">The type/class of the sensor to set the icon in the frontend.</span></p>
|
||||
<p class="default">Default value: None</p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="value_template" href="#value_template"></a> value_template</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="template"><a href="/docs/configuration/templating/">template</a></span>)</span><span class="required">(Required)</span><span class="description">Defines a template to set the state of the sensor.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="delay_on" href="#delay_on"></a> delay_on</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="time">time</span>)</span><span class="required">(Optional)</span><span class="description">The amount of time the template state must be <strong><em>met</em></strong> before this sensor will switch to <code class="highlighter-rouge">on</code>.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="delay_off" href="#delay_off"></a> delay_off</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="time">time</span>)</span><span class="required">(Optional)</span><span class="description">The amount of time the template state must be <strong><em>not met</em></strong> before this sensor will switch to <code class="highlighter-rouge">off</code>.</span></p>
|
||||
<dl class="nested">
|
||||
<dt><a class="title-link" name="friendly_name" href="#friendly_name"></a> friendly_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>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="entity_id" href="#entity_id"></a> entity_id</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string, list">string | list</span>)</span><span class="required">(Optional)</span><span class="description">Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="device_class" href="#device_class"></a> device_class</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="device_class"><a href="/components/binary_sensor/#device_class">device_class</a></span>)</span><span class="required">(Optional)</span><span class="description">The type/class of the sensor to set the icon in the frontend.</span></p>
|
||||
<p class="default">Default value: None</p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="value_template" href="#value_template"></a> value_template</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="template"><a href="/docs/configuration/templating/">template</a></span>)</span><span class="required">(Required)</span><span class="description">Defines a template to set the state of the sensor.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="delay_on" href="#delay_on"></a> delay_on</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="time">time</span>)</span><span class="required">(Optional)</span><span class="description">The amount of time the template state must be <strong><em>met</em></strong> before this sensor will switch to <code class="highlighter-rouge">on</code>.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="delay_off" href="#delay_off"></a> delay_off</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="time">time</span>)</span><span class="required">(Optional)</span><span class="description">The amount of time the template state must be <strong><em>not met</em></strong> before this sensor will switch to <code class="highlighter-rouge">off</code>.</span></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ Support for these components is provided by the Home Assistant community.
|
|||
<div class="filter-button-group">
|
||||
<a href='#all' class="btn">All (895)</a>
|
||||
<a href='#featured' class="btn featured">Featured</a>
|
||||
<a href='#version/0.57' class="btn added_in_current_version">Added in 0.57 (22)</a>
|
||||
<a href='#version/0.57' class="btn added_in_current_version">Added in 0.57 (23)</a>
|
||||
<a href='#version/0.56' class="btn added_one_version_ago">Added in 0.56 (23)</a>
|
||||
<a href='#version/0.55' class="btn added_two_versions_ago">Added in 0.55 (16)</a>
|
||||
<a href='#alarm' class="btn">Alarm (18)</a>
|
||||
|
|
@ -722,7 +722,7 @@ var allComponents = [
|
|||
{url:"/components/switch.rachio/", title:"Rachio Switch", cat:"switch", featured: false, v: "0.46", logo: "rachio.png"},
|
||||
{url:"/components/sensor.radarr/", title:"Radarr Sensor", cat:"sensor", featured: false, v: "0.47", logo: "radarr.png"},
|
||||
{url:"/components/climate.radiotherm/", title:"Radio Thermostat (3M Filtrete) Thermostat", cat:"climate", featured: false, v: "0.0", logo: "radiotherm.png"},
|
||||
{url:"/components/switch.rainbird/", title:"Rain Bird Switch", cat:"hub", featured: false, v: "0.5", logo: "rainbird.png"},
|
||||
{url:"/components/switch.rainbird/", title:"Rain Bird Switch", cat:"hub", featured: false, v: "0.57", logo: "rainbird.png"},
|
||||
{url:"/components/switch.rainmachine/", title:"RainMachine Switch", cat:"switch", featured: false, v: "0.51", logo: "rainmachine.png"},
|
||||
{url:"/components/binary_sensor.random/", title:"Random Binary Sensor", cat:"sensor", featured: false, v: "0.57", logo: "home-assistant.png"},
|
||||
{url:"/components/sensor.random/", title:"Random Sensor", cat:"sensor", featured: false, v: "0.32", logo: "home-assistant.png"},
|
||||
|
|
|
|||
|
|
@ -124,19 +124,19 @@
|
|||
<dl class="nested">
|
||||
<dt><a class="title-link" name="p1" href="#p1"></a> P1</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Show the particle sensors (particles 10 microns and below).</span></p>
|
||||
<p class="desc"><span class="description">Show the particle sensors (particles 10 microns and below).</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="p2" href="#p2"></a> P2</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Show the particle sensors (particles 2.5 microns and below).</span></p>
|
||||
<p class="desc"><span class="description">Show the particle sensors (particles 2.5 microns and below).</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="temperature" href="#temperature"></a> temperature</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Display the temperature from a weather sensor.</span></p>
|
||||
<p class="desc"><span class="description">Display the temperature from a weather sensor.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="humidity" href="#humidity"></a> humidity</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Display the humidity from a weather sensor.</span></p>
|
||||
<p class="desc"><span class="description">Display the humidity from a weather sensor.</span></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
|
|
|||
|
|
@ -85,26 +85,74 @@
|
|||
<span class="pi">-</span> <span class="s">weather</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<p>Configuration variables:</p>
|
||||
<ul>
|
||||
<li><strong>api_key</strong> (<em>Required</em>): Your API key for http://openweathermap.org/.</li>
|
||||
<li><strong>name</strong> (<em>Optional</em>): Additional name for the sensors. Default to platform name.</li>
|
||||
<li><strong>forecast</strong> (<em>Optional</em>): Enables the forecast. The default is to display the current conditions.</li>
|
||||
<li><strong>language</strong> (<em>Optional</em>): The language in which you want text results to be returned. It’s a two-characters string, eg. <code class="highlighter-rouge">en</code>, <code class="highlighter-rouge">es</code>, <code class="highlighter-rouge">ru</code>, <code class="highlighter-rouge">it</code>, etc. Defaults to English.</li>
|
||||
<li><strong>monitored_conditions</strong> array (<em>Required</em>): Conditions to display in the frontend.
|
||||
<ul>
|
||||
<li><strong>weather</strong>: A human-readable text summary.</li>
|
||||
<li><strong>temperature</strong>: The current temperature.</li>
|
||||
<li><strong>wind_speed</strong>: The wind speed.</li>
|
||||
<li><strong>wind_bearing</strong>: The wind bearing.</li>
|
||||
<li><strong>humidity</strong>: The relative humidity.</li>
|
||||
<li><strong>pressure</strong>: The sea-level air pressure in millibars.</li>
|
||||
<li><strong>clouds</strong>: Description about cloud coverage.</li>
|
||||
<li><strong>rain</strong>: The rain volume.</li>
|
||||
<li><strong>snow</strong>: The snow volume</li>
|
||||
</ul>
|
||||
</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="apk_key" href="#apk_key"></a> apk_key</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">Your API key for http://openweathermap.org/.</span></p>
|
||||
</dd>
|
||||
<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">Additional name for the sensors. Default to platform name.</span></p>
|
||||
<p class="default">Default value: OWM</p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="forecast" href="#forecast"></a> forecast</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Enables the forecast. The default is to display the current conditions.</span></p>
|
||||
<p class="default">Default value: false</p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="language" href="#language"></a> language</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The language in which you want text results to be returned. It’s a two-characters string, eg. <code class="highlighter-rouge">en</code>, <code class="highlighter-rouge">es</code>, <code class="highlighter-rouge">ru</code>, <code class="highlighter-rouge">it</code>, etc.</span></p>
|
||||
<p class="default">Default value: en</p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="monitored_conditions" href="#monitored_conditions"></a> monitored_conditions</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Required)</span><span class="description">Conditions to display in the frontend.</span></p>
|
||||
</dd>
|
||||
<dd>
|
||||
<dl class="nested">
|
||||
<dt><a class="title-link" name="weather" href="#weather"></a> weather</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">A human-readable text summary.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="temperature" href="#temperature"></a> temperature</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">The current temperature.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="wind_speed" href="#wind_speed"></a> wind_speed</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">The wind speed.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="wind_bearing" href="#wind_bearing"></a> wind_bearing</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">The wind bearing.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="humidity" href="#humidity"></a> humidity</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">The relative humidity.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="pressure" href="#pressure"></a> pressure</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">The sea-level air pressure in millibars.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="clouds" href="#clouds"></a> clouds</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">Description about cloud coverage.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="rain" href="#rain"></a> rain</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">The rain volume.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="snow" href="#snow"></a> snow</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="description">The snow volume.</span></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<p>Details about the API are available in the <a href="http://openweathermap.org/api">OpenWeatherMap documentation</a>.</p>
|
||||
</article>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -115,7 +115,7 @@
|
|||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
|
||||
</div>
|
||||
<div class='section'>
|
||||
Introduced in release: 0.5
|
||||
Introduced in release: 0.57
|
||||
</div>
|
||||
<div class='section'>
|
||||
This is a platform for
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue