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

Site updated at 2018-01-10 13:32:26 UTC

Browse source
This commit is contained in:
Travis CI 2018-01-10 13:32:27 +00:00
parent 6c80b4c470
commit 657005c4dd
30 changed files with 69 additions and 110 deletions
Download patch file Download diff file Expand all files Collapse all files

22
components/binary_sensor.template/index.html
View file

@ -108,10 +108,6 @@ your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<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>
@ -176,22 +172,16 @@ original switch can then be hidden by
<span class="s">value_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">is_state('switch.door',</span><span class="nv"> </span><span class="s">'on')</span><span class="nv"> </span><span class="s">}}"</span>
</code></pre>
</div>
<h3><a class="title-link" name="combining-multiple-sensors-and-using-entity_id" href="#combining-multiple-sensors-and-using-entity_id"></a> Combining Multiple Sensors, and Using <code class="highlighter-rouge">entity_id</code></h3>
<h3><a class="title-link" name="combining-multiple-sensors" href="#combining-multiple-sensors"></a> Combining Multiple Sensors</h3>
<p>This example combines multiple CO sensors into a single overall
status. When using templates with binary sensors, you need to return
<code class="highlighter-rouge">true</code> or <code class="highlighter-rouge">false</code> explicitly. <code class="highlighter-rouge">entity_id</code> is used to limit which
sensors are being monitored to update the state, making computing this
sensor far more efficient.</p>
<code class="highlighter-rouge">true</code> or <code class="highlighter-rouge">false</code> explicitly.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">binary_sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
<span class="s">sensors</span><span class="pi">:</span>
<span class="s">co</span><span class="pi">:</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">CO"</span>
<span class="s">device_class</span><span class="pi">:</span> <span class="s">gas</span>
<span class="s">entity_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor.bedroom_co_status</span>
<span class="pi">-</span> <span class="s">sensor.kitchen_co_status</span>
<span class="pi">-</span> <span class="s">sensor.wardrobe_co_status</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="pi">&gt;-</span>
<span class="no">{{ is_state('sensor.bedroom_co_status', 'Ok')</span>
<span class="no">and is_state('sensor.kitchen_co_status', 'Ok')</span>
@ -226,14 +216,6 @@ device tracking and Z-Wave multisensor presence sensors.</p>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
<span class="s">sensors</span><span class="pi">:</span>
<span class="s">people_home</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">device_tracker.sean</span>
<span class="pi">-</span> <span class="s">device_tracker.susan</span>
<span class="pi">-</span> <span class="s">binary_sensor.office_124</span>
<span class="pi">-</span> <span class="s">binary_sensor.hallway_134</span>
<span class="pi">-</span> <span class="s">binary_sensor.living_room_139</span>
<span class="pi">-</span> <span class="s">binary_sensor.porch_ms6_1_129</span>
<span class="pi">-</span> <span class="s">binary_sensor.family_room_144</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="pi">&gt;-</span>
<span class="no">{{ is_state('device_tracker.sean', 'home')</span>
<span class="no">or is_state('device_tracker.susan', 'home')</span>

10
components/cover.template/index.html
View file

@ -107,10 +107,6 @@ stop, position, and tilt commands of a cover.</p>
<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 switch only reacts to state changes of these entities. This will reduce the number of times the cover will try to update its state.</span></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">(Exclusive)</span><span class="description">Defines a template to get the state of the cover. Valid values are <code class="highlighter-rouge">open</code>/<code class="highlighter-rouge">true</code> or <code class="highlighter-rouge">closed</code>/<code class="highlighter-rouge">false</code>. <a href="#value_template"><code class="highlighter-rouge">value_template</code></a> and <a href="#position_template"><code class="highlighter-rouge">position_template</code></a> cannot be specified concurrently.</span></p>
@ -247,9 +243,6 @@ sensor into a cover.</p>
<span class="no">{% else %}</span>
<span class="no">mdi:window-closed</span>
<span class="no">{% endif %}</span>
<span class="no">entity_id:</span>
<span class="no">- cover.bedroom</span>
<span class="no">- cover.livingroom</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
@ -263,9 +256,6 @@ sensor into a cover.</p>
<span class="no">{% else %}</span>
<span class="no">closed</span>
<span class="no">{% endif %}</span>
<span class="no">entity_id:</span>
<span class="no">- cover.bedroom</span>
<span class="no">- cover.livingroom</span>
<span class="s">script</span><span class="pi">:</span>
<span class="s">cover_group</span><span class="pi">:</span>

4
components/light.template/index.html
View file

@ -110,10 +110,6 @@ brightness commands of a light.</p>
<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 switch only reacts to state changes of these entities. This will reduce the number of times the light will try to update its state.</span></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">(Optional)</span><span class="description">Defines a template to get the state of the light.</span></p>

11
components/sensor.template/index.html
View file

@ -105,10 +105,6 @@ from other entities.</p>
<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="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>
@ -127,12 +123,11 @@ from other entities.</p>
</div>
<h2><a class="title-link" name="considerations" href="#considerations"></a> Considerations</h2>
<p>If you are using the state of a platform that takes extra time to load, the
Template Sensor may get an <code class="highlighter-rouge">unknown</code> state during startup. This results
in error messages in your log file until that platform has completed loading.
If you use <code class="highlighter-rouge">is_state()</code> function in your template, you can avoid this situation.
Template Sensor may get an <code class="highlighter-rouge">unknown</code> state during startup. To avoid this (and the resulting
error messages in your log file), you can use <code class="highlighter-rouge">is_state()</code> function in your template.
For example, you would replace
<code class="highlighter-rouge"><span class="p">{</span><span class="err">{</span><span class="w"> </span><span class="err">states.switch.source.state</span><span class="w"> </span><span class="err">==</span><span class="w"> </span><span class="err">'on'</span><span class="w"> </span><span class="p">}</span><span class="err">}</span></code>
with this equivalent that returns <code class="highlighter-rouge">true</code>/<code class="highlighter-rouge">false</code> and never gives an unknown
with this equivalent that returns <code class="highlighter-rouge">true</code>/<code class="highlighter-rouge">false</code> and never gives an <code class="highlighter-rouge">unknown</code>
result:
<code class="highlighter-rouge"><span class="p">{</span><span class="err">{</span><span class="w"> </span><span class="err">is_state('switch.source',</span><span class="w"> </span><span class="err">'on')</span><span class="w"> </span><span class="p">}</span><span class="err">}</span></code></p>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>

4
components/switch.template/index.html
View file

@ -112,10 +112,6 @@ the components you have combined as <code class="highlighter-rouge">hidden</code
<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 switch only reacts to state changes of these entities. This will reduce the number of times the switch will try to update its state.</span></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 switch.</span></p>