Site updated at 2017-12-24 16:31:04 UTC
This commit is contained in:
Travis CI
parent
1b94ba3d97
commit
38a5dbcd99
26 changed files with 121 additions and 86 deletions
|
|
@ -96,21 +96,54 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
|
|||
<span class="s">mode</span><span class="pi">:</span> <span class="s">box</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<p>Configuration variables:</p>
|
||||
<ul>
|
||||
<li><strong>[alias]</strong> (<em>Required</em>): Alias for the input. Multiple entries are allowed.
|
||||
<ul>
|
||||
<li><strong>min</strong> (<em>Required</em>): Minimum value.</li>
|
||||
<li><strong>max</strong> (<em>Required</em>): Maximum value.</li>
|
||||
<li><strong>name</strong> (<em>Optional</em>): Friendly name of the input.</li>
|
||||
<li><strong>initial</strong> (<em>Optional</em>): Initial value when Home Assistant starts. Defaults to 0.</li>
|
||||
<li><strong>step</strong> (<em>Optional</em>): Step value for the slider. Defaults to 1.</li>
|
||||
<li><strong>mode</strong> (<em>Optional</em>): Can specify <code class="highlighter-rouge">box</code>, or <code class="highlighter-rouge">slider</code>. Defaults to <code class="highlighter-rouge">slider</code>.</li>
|
||||
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Unit of measurement in which the value of the slider is expressed in.</li>
|
||||
<li><strong>icon</strong> (<em>Optional</em>): Icon to display in front of the box/slider in the frontend. Refer to the <a href="https://home-assistant.io/docs/configuration/customizing-devices/#possible-values">Customizing devices</a> page for possible values.</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="input_number" href="#input_number"></a> input_number</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Required)</span><span class="description">Alias for the input. Multiple entries are allowed.</span></p>
|
||||
</dd>
|
||||
<dd>
|
||||
<dl class="nested">
|
||||
<dt><a class="title-link" name="min" href="#min"></a> min</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="float">float</span>)</span><span class="required">(Required)</span><span class="description">Minimum value.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="max" href="#max"></a> max</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="float">float</span>)</span><span class="required">(Required)</span><span class="description">Maxium value.</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">Friendly name of the input.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="initial" href="#initial"></a> initial</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="float">float</span>)</span><span class="required">(Optional)</span><span class="description">Initial value when Home Assistant starts.</span></p>
|
||||
<p class="default">Default value: 0</p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="step" href="#step"></a> step</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="float">float</span>)</span><span class="required">(Optional)</span><span class="description">Step value for the slider. Smallest value <code class="highlighter-rouge">0.001</code>.</span></p>
|
||||
<p class="default">Default value: 1</p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="mode" href="#mode"></a> mode</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="box | slider">box | slider</span>)</span><span class="required">(Optional)</span><span class="description">Can specify <code class="highlighter-rouge">box</code> or <code class="highlighter-rouge">slider</code>.</span></p>
|
||||
<p class="default">Default value: slider</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">Unit of measurement in which the value of the slider is expressed in.</span></p>
|
||||
</dd>
|
||||
<dt><a class="title-link" name="icon" href="#icon"></a> icon</dt>
|
||||
<dd>
|
||||
<p class="desc"><span class="type">(<span class="icon">icon</span>)</span><span class="required">(Optional)</span><span class="description">Icon to display in front of the box/slider in the frontend. Refer to the <a href="https://home-assistant.io/docs/configuration/customizing-devices/#possible-values">Customizing devices</a> page for possible values.</span></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h2><a class="title-link" name="automation-examples" href="#automation-examples"></a> Automation Examples</h2>
|
||||
<p>Here’s 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>
|
||||
|
|
@ -131,8 +164,7 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
|
|||
<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>
|
||||
|
||||
<span class="s">brightness</span><span class="pi">:</span> <span class="s2">"</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>
|
||||
</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>
|
||||
|
|
@ -166,7 +198,7 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
|
|||
<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>
|
||||
<span class="s">brightness</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">states('input_number.bedroom_brightness')</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>
|
||||
|
|
@ -179,20 +211,23 @@ 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"># 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="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">topic</span><span class="pi">:</span> <span class="s1">'</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="s">value</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">trigger.payload</span><span class="nv"> </span><span class="s">}}"</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="s">automation</span><span class="pi">:</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>
|
||||
|
|
@ -200,9 +235,9 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
|
|||
<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">topic</span><span class="pi">:</span> <span class="s1">'</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">payload</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">states('input_number.target_temp')</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>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue