Site updated at 2016-08-12 06:33:52 UTC

components/sensor.template/index.html

@@ -96,14 +96,14 @@
 <div class="highlighter-coderay"><div class="CodeRay">
   <div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
 <span class="key">sensor</span>:
-  <span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
-  <span class="key">sensors</span>:
-    <span class="key">solar_angle</span>:
-      <span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sun.sun.attributes.elevation }}'</span></span>
-      <span class="key">friendly_name</span>: <span class="string"><span class="content">'Sun angle'</span></span>
-      <span class="key">unit_of_measurement</span>: <span class="string"><span class="content">'degrees'</span></span>
-    <span class="key">sunrise</span>:
-      <span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sun.sun.attributes.next_rising }}'</span></span>
+  - <span class="string"><span class="content">platform: template</span></span>
+    <span class="key">sensors</span>:
+      <span class="key">solar_angle</span>:
+        <span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sun.sun.attributes.elevation }}'</span></span>
+        <span class="key">friendly_name</span>: <span class="string"><span class="content">'Sun angle'</span></span>
+        <span class="key">unit_of_measurement</span>: <span class="string"><span class="content">'degrees'</span></span>
+      <span class="key">sunrise</span>:
+        <span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sun.sun.attributes.next_rising }}'</span></span>
 </pre></div>
 </div>
 </div>
@@ -116,8 +116,7 @@
       <li><strong>friendly_name</strong> (<em>Optional</em>): Name to use in the Frontend.</li>
       <li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the units of measurement of the sensor, if any.</li>
       <li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract a value from the payload.</li>
-      <li><strong>warnings</strong> (<em>Optional</em>): Turn off warnings (useful if the sensor is loaded before devices it depends on).</li>
-      <li><strong>entity_id</strong> (<em>Optional</em>): 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 it’s state.</li>
+      <li><strong>entity_id</strong> (<em>Optional</em>): 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 it’s state.</li>
     </ul>
   </li>
 </ul>
@@ -132,12 +131,12 @@
 
 <div class="highlighter-coderay"><div class="CodeRay">
   <div class="code"><pre><span class="key">sensor</span>:
-  <span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
-  <span class="key">sensors</span>:
-    <span class="key">solar_angle</span>:
-      <span class="key">value_template</span>: <span class="string"><span class="content">'{{ &quot;%+.1f&quot;|format(states.sun.sun.attributes.elevation) }}'</span></span>
-      <span class="key">friendly_name</span>: <span class="string"><span class="content">'Sun Angle'</span></span>
-      <span class="key">unit_of_measurement</span>: <span class="string"><span class="content">'°'</span></span>
+  - <span class="string"><span class="content">platform: template</span></span>
+    <span class="key">sensors</span>:
+      <span class="key">solar_angle</span>:
+        <span class="key">value_template</span>: <span class="string"><span class="content">'{{ &quot;%+.1f&quot;|format(states.sun.sun.attributes.elevation) }}'</span></span>
+        <span class="key">friendly_name</span>: <span class="string"><span class="content">'Sun Angle'</span></span>
+        <span class="key">unit_of_measurement</span>: <span class="string"><span class="content">'°'</span></span>
 </pre></div>
 </div>
 </div>
@@ -148,11 +147,11 @@
 
 <div class="highlighter-coderay"><div class="CodeRay">
   <div class="code"><pre><span class="key">sensor</span>:
-  <span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
-  <span class="key">sensors</span>:
-    <span class="key">sun_state</span>:
-      <span class="key">value_template</span>: <span class="string"><span class="content">'{% if is_state(&quot;sun.sun&quot;, &quot;above_horizon&quot;) %}up{% else %}down{% endif %}'</span></span>
-      <span class="key">friendly_name</span>: <span class="string"><span class="content">'Sun state'</span></span>
+  - <span class="string"><span class="content">platform: template</span></span>
+    <span class="key">sensors</span>:
+      <span class="key">sun_state</span>:
+        <span class="key">value_template</span>: <span class="string"><span class="content">'{% if is_state(&quot;sun.sun&quot;, &quot;above_horizon&quot;) %}up{% else %}down{% endif %}'</span></span>
+        <span class="key">friendly_name</span>: <span class="string"><span class="content">'Sun state'</span></span>
 </pre></div>
 </div>
 </div>
@@ -161,11 +160,11 @@
 
 <div class="highlighter-coderay"><div class="CodeRay">
   <div class="code"><pre><span class="key">sensor</span>:
-  <span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
-  <span class="key">sensors</span>:
-    <span class="key">glances</span>:
-      <span class="key">value_template</span>: <span class="string"><span class="content">'{% if is_state(&quot;sensor.process_glances&quot;, &quot;off&quot;) %}not running{% else %}running{% endif %}'</span></span>
-      <span class="key">friendly_name</span>: <span class="string"><span class="content">'Glances'</span></span>
+  - <span class="string"><span class="content">platform: template</span></span>
+    <span class="key">sensors</span>:
+      <span class="key">glances</span>:
+        <span class="key">value_template</span>: <span class="string"><span class="content">'{% if is_state(&quot;sensor.process_glances&quot;, &quot;off&quot;) %}not running{% else %}running{% endif %}'</span></span>
+        <span class="key">friendly_name</span>: <span class="string"><span class="content">'Glances'</span></span>
 </pre></div>
 </div>
 </div>
@@ -180,33 +179,36 @@
 
 <p>The <a href="/components/binary_sensor.template/">Binary template sensor</a> is the one in similar cases if you prefer to see an icon instead of text.</p>
 
-<h3><a class="title-link" name="multiline-example-with-an-if-test-and-warnings-disabled" href="#multiline-example-with-an-if-test-and-warnings-disabled"></a> Multiline example with an if test (and warnings disabled)</h3>
+<h3><a class="title-link" name="multiline-example-with-an-if-test" href="#multiline-example-with-an-if-test"></a> Multiline example with an if test</h3>
 
-<p>This example shows a multiple line template with and if test. It looks at a sensing switch and shows on/off in the frontend. It disables warnings to avoid log messages where the switch it depends on isn’t loaded yet.</p>
+<p>This example shows a multiple line template with and if test. It looks at a sensing switch and shows on/off in the frontend.</p>
 
 <div class="highlighter-coderay"><div class="CodeRay">
   <div class="code"><pre><span class="key">sensor</span>:
-  <span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
-  <span class="key">sensors</span>:
-    <span class="key">kettle</span>:
-      <span class="key">friendly_name</span>: <span class="string"><span class="content">'Kettle'</span></span>
-      <span class="key">value_template</span>: <span class="string"><span class="delimiter">&gt;-</span><span class="content">
-          {%- if is_state(&quot;switch.kettle&quot;, &quot;off&quot;) %}
-              off
-          {%  elif states.switch.kettle.attributes.kwh &lt; 1000 %}
-              standby
-          {% elif is_state(&quot;switch.kettle&quot;, &quot;on&quot;) %}
-              on
-          {% else %}
-              failed
-          {%- endif %}</span></span>
+  - <span class="string"><span class="content">platform: template</span></span>
+    <span class="key">sensors</span>:
+      <span class="key">kettle</span>:
+        <span class="key">friendly_name</span>: <span class="string"><span class="content">'Kettle'</span></span>
+        <span class="key">value_template</span>: <span class="string"><span class="delimiter">&gt;-</span><span class="content">
+            {%- if is_state(&quot;switch.kettle&quot;, &quot;off&quot;) %}
+                off
+            {%  elif states.switch.kettle.attributes.kwh &lt; 1000 %}
+                standby
+            {% elif is_state(&quot;switch.kettle&quot;, &quot;on&quot;) %}
+                on
+            {% else %}
+                failed
+            {%- endif %}</span></span>
 
-     <span class="key">warnings</span>: <span class="string"><span class="content">Off</span></span>
+      <span class="key">next_sensor</span>:
+      [<span class="error">...]</span>
 </pre></div>
 </div>
 </div>
 
-<p>(please note the blank line to close the multi-line template)</p>
+<p class="note">
+Please note the blank line to close the multi-line template.
+</p>
 
 <h3><a class="title-link" name="change-the-unit-of-measurment" href="#change-the-unit-of-measurment"></a> Change the unit of measurment</h3>
 
@@ -214,16 +216,16 @@
 
 <div class="highlighter-coderay"><div class="CodeRay">
   <div class="code"><pre><span class="key">sensor</span>:
-  <span class="key">platform</span>: <span class="string"><span class="content">template</span></span>
-  <span class="key">sensors</span>:
-    <span class="key">transmission_down_speed_kbps</span>:
-      <span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sensor.transmission_down_speed.state | multiply(1024) }}'</span></span>
-      <span class="key">friendly_name</span>: <span class="string"><span class="content">'Transmission Down Speed'</span></span>
-      <span class="key">unit_of_measurement</span>: <span class="string"><span class="content">'kB/s'</span></span>
-    <span class="key">transmission_up_speed_kbps</span>:
-      <span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sensor.transmission_up_speed.state | multiply(1024) }}'</span></span>
-      <span class="key">friendly_name</span>: <span class="string"><span class="content">'Transmission Up Speed'</span></span>
-      <span class="key">unit_of_measurement</span>: <span class="string"><span class="content">'kB/s'</span></span>
+  - <span class="string"><span class="content">platform: template</span></span>
+    <span class="key">sensors</span>:
+      <span class="key">transmission_down_speed_kbps</span>:
+        <span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sensor.transmission_down_speed.state | multiply(1024) }}'</span></span>
+        <span class="key">friendly_name</span>: <span class="string"><span class="content">'Transmission Down Speed'</span></span>
+        <span class="key">unit_of_measurement</span>: <span class="string"><span class="content">'kB/s'</span></span>
+      <span class="key">transmission_up_speed_kbps</span>:
+        <span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.sensor.transmission_up_speed.state | multiply(1024) }}'</span></span>
+        <span class="key">friendly_name</span>: <span class="string"><span class="content">'Transmission Up Speed'</span></span>
+        <span class="key">unit_of_measurement</span>: <span class="string"><span class="content">'kB/s'</span></span>
 </pre></div>
 </div>
 </div>