Site updated at 2017-12-03 15:23:57 UTC

This commit is contained in:
Travis CI 2017-12-03 15:23:58 +00:00
parent ce6c5b8ee1
commit 9affd94f4e
26 changed files with 90 additions and 109 deletions

View file

@ -113,10 +113,7 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
</ul>
<h2><a class="title-link" name="automation-examples" href="#automation-examples"></a> Automation Examples</h2>
<p>Heres an example of <code class="highlighter-rouge">input_number</code> being used as a trigger in an automation.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code>
<span class="c1"># Example configuration.yaml entry using 'input_number' as a trigger in an automation</span>
<span class="c1"># Define input_number</span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry using 'input_number' as a trigger in an automation</span>
<span class="s">input_number</span><span class="pi">:</span>
<span class="s">bedroom_brightness</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Brightness</span>
@ -124,8 +121,6 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
<span class="s">min</span><span class="pi">:</span> <span class="s">0</span>
<span class="s">max</span><span class="pi">:</span> <span class="s">254</span>
<span class="s">step</span><span class="pi">:</span> <span class="s">1</span>
<span class="c1"># Automation. </span>
<span class="s">automation</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Bedroom Light - Adjust Brightness</span>
<span class="s">trigger</span><span class="pi">:</span>
@ -133,7 +128,7 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">input_number.bedroom_brightness</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="c1"># Note the use of 'data_template:' below rather than the normal 'data:' if you weren't using an input variable</span>
<span class="c1"># Note the use of 'data_template:' below rather than the normal 'data:' if you weren't using an input variable</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.bedroom</span>
<span class="s">brightness</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">trigger.to_state.state</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">int</span><span class="nv"> </span><span class="s">}}'</span>
@ -141,10 +136,7 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
</code></pre>
</div>
<p>Another code example using <code class="highlighter-rouge">input_number</code>, this time being used in an action in an automation.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code>
<span class="c1"># Example configuration.yaml entry using 'input_number' in an action in an automation</span>
<span class="c1"># Define 'input_select'</span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry using 'input_number' in an action in an automation</span>
<span class="s">input_select</span><span class="pi">:</span>
<span class="s">scene_bedroom</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Scene</span>
@ -156,8 +148,6 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
<span class="pi">-</span> <span class="s">Relax</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">OFF'</span>
<span class="s">initial</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Select'</span>
<span class="c1"># Define input_number</span>
<span class="s">input_number</span><span class="pi">:</span>
<span class="s">bedroom_brightness</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Brightness</span>
@ -165,8 +155,6 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
<span class="s">min</span><span class="pi">:</span> <span class="s">0</span>
<span class="s">max</span><span class="pi">:</span> <span class="s">254</span>
<span class="s">step</span><span class="pi">:</span> <span class="s">1</span>
<span class="c1"># Automation. </span>
<span class="s">automation</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Bedroom Light - Custom</span>
<span class="s">trigger</span><span class="pi">:</span>
@ -175,18 +163,14 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
<span class="s">to</span><span class="pi">:</span> <span class="s">CUSTOM</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="c1"># Again, note the use of 'data_template:' rather than the normal 'data:' if you weren't using an input variable.</span>
<span class="c1"># Again, note the use of 'data_template:' rather than the normal 'data:' if you weren't using an input variable.</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.bedroom</span>
<span class="s">brightness</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.input_number.bedroom_brightness.state</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">int</span><span class="nv"> </span><span class="s">}}'</span>
</code></pre>
</div>
<p>Example of <code class="highlighter-rouge">input_number</code> being used in a bidirectional manner, both being set by and controlled by an MQTT action in an automation.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code>
<span class="c1"># Example configuration.yaml entry using 'input_number' in an action in an automation</span>
<span class="c1"># Define input_number</span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry using 'input_number' in an action in an automation</span>
<span class="s">input_number</span><span class="pi">:</span>
<span class="s">target_temp</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Target Heater Temperature Slider</span>
@ -195,33 +179,30 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
<span class="s">step</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s">step</span>
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:target</span>
<span class="c1"># Automation. </span>
<span class="c1"># This automation script runs when a value is received via MQTT on retained topic: setTemperature</span>
<span class="c1"># It sets the value slider on the GUI. This slides also had its own automation when the value is changed.</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Set temp slider</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
<span class="s">topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">setTemperature"</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">input_number.set_value</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">input_number.target_temp</span>
<span class="s">value</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">trigger.payload}}'</span>
<span class="c1"># This automation script runs when the target temperature slider is moved.</span>
<span class="c1"># It publishes its value to the same MQTT topic it is also subscribed to.</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Temp slider moved</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">input_number.target_temp</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">mqtt.publish</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Set temp slider</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
<span class="s">topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">setTemperature"</span>
<span class="s">retain</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">payload</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.input_number.target_temp.state</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">int</span><span class="nv"> </span><span class="s">}}'</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">input_number.set_value</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">input_number.target_temp</span>
<span class="s">value</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">trigger.payload}}'</span>
<span class="c1"># This automation script runs when the target temperature slider is moved.</span>
<span class="c1"># It publishes its value to the same MQTT topic it is also subscribed to.</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Temp slider moved</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">input_number.target_temp</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">mqtt.publish</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">setTemperature"</span>
<span class="s">retain</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">payload</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.input_number.target_temp.state</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">int</span><span class="nv"> </span><span class="s">}}'</span>
</code></pre>
</div>
</article>