Site updated at 2016-08-22 08:21:42 UTC
This commit is contained in:
Travis CI
parent
f9d65cbe57
commit
4acb07bf8e
559 changed files with 18878 additions and 21688 deletions
|
|
@ -91,175 +91,155 @@
|
|||
|
||||
<p>Conditions can be used within a script or automation to prevent further execution. A condition will look at the system right now. For example a condition can test if a switch is currently turned on or off.</p>
|
||||
|
||||
<h4><a class="title-link" name="and-condition" href="#and-condition"></a> AND condition</h4>
|
||||
<h3><a class="title-link" name="and-condition" href="#and-condition"></a> AND condition</h3>
|
||||
|
||||
<p>Test multiple conditions in 1 condition statement. Passes if all embedded conditions are valid.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">and</span></span>
|
||||
<span class="key">conditions</span>:
|
||||
- <span class="string"><span class="content">condition: state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">'device_tracker.paulus'</span></span>
|
||||
<span class="key">state</span>: <span class="string"><span class="content">'home'</span></span>
|
||||
- <span class="string"><span class="content">condition: numeric_state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">'sensor.temperature'</span></span>
|
||||
<span class="key">below</span>: <span class="string"><span class="content">'20'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">and</span>
|
||||
<span class="s">conditions</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">device_tracker.paulus'</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">home'</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">numeric_state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">sensor.temperature'</span>
|
||||
<span class="s">below</span><span class="pi">:</span> <span class="s1">'</span><span class="s">20'</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="or-condition" href="#or-condition"></a> OR condition</h4>
|
||||
<h3><a class="title-link" name="or-condition" href="#or-condition"></a> OR condition</h3>
|
||||
|
||||
<p>Test multiple conditions in 1 condition statement. Passes if any embedded conditions is valid.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">or</span></span>
|
||||
<span class="key">conditions</span>:
|
||||
- <span class="string"><span class="content">condition: state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">'device_tracker.paulus'</span></span>
|
||||
<span class="key">state</span>: <span class="string"><span class="content">'home'</span></span>
|
||||
- <span class="string"><span class="content">condition: numeric_state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">'sensor.temperature'</span></span>
|
||||
<span class="key">below</span>: <span class="string"><span class="content">'20'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">or</span>
|
||||
<span class="s">conditions</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">device_tracker.paulus'</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">home'</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">numeric_state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">sensor.temperature'</span>
|
||||
<span class="s">below</span><span class="pi">:</span> <span class="s1">'</span><span class="s">20'</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="mixed--and-and-or-conditions" href="#mixed--and-and-or-conditions"></a> MIXED AND and OR conditions</h4>
|
||||
<h3><a class="title-link" name="mixed--and-and-or-conditions" href="#mixed--and-and-or-conditions"></a> MIXED AND and OR conditions</h3>
|
||||
|
||||
<p>Test multiple AND and OR conditions in 1 condition statement. Passes if any embedded conditions is valid.<br />
|
||||
<p>Test multiple AND and OR conditions in 1 condition statement. Passes if any embedded conditions is valid.
|
||||
This allows you to mix several AND and OR conditions together.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">and</span></span>
|
||||
<span class="key">conditions</span>:
|
||||
- <span class="string"><span class="content">condition: state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">'device_tracker.paulus'</span></span>
|
||||
<span class="key">state</span>: <span class="string"><span class="content">'home'</span></span>
|
||||
- <span class="string"><span class="content">condition: or</span></span>
|
||||
<span class="key">conditions</span>:
|
||||
- <span class="string"><span class="content">condition: state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">sensor.weather_precip</span></span>
|
||||
<span class="key">state</span>: <span class="string"><span class="content">'rain'</span></span>
|
||||
- <span class="string"><span class="content">condition: numeric_state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">'sensor.temperature'</span></span>
|
||||
<span class="key">below</span>: <span class="string"><span class="content">'20'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">and</span>
|
||||
<span class="s">conditions</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">device_tracker.paulus'</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">home'</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">or</span>
|
||||
<span class="s">conditions</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sensor.weather_precip</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">rain'</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">numeric_state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">sensor.temperature'</span>
|
||||
<span class="s">below</span><span class="pi">:</span> <span class="s1">'</span><span class="s">20'</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="numeric-state-condition" href="#numeric-state-condition"></a> Numeric state condition</h4>
|
||||
<h3><a class="title-link" name="numeric-state-condition" href="#numeric-state-condition"></a> Numeric state condition</h3>
|
||||
|
||||
<p>This type of condition attempts to parse the state of specified entity as a number and triggers if the value matches all of the above or below thresholds.</p>
|
||||
|
||||
<p>For above, the condition passes if <code>value >= above</code>. For below, the condition passes if <code>value <= below</code>. If both <code>below</code> and <code>above</code> are specified, both tests have to pass.</p>
|
||||
<p>For above, the condition passes if <code class="highlighter-rouge">value >= above</code>. For below, the condition passes if <code class="highlighter-rouge">value <= below</code>. If both <code class="highlighter-rouge">below</code> and <code class="highlighter-rouge">above</code> are specified, both tests have to pass.</p>
|
||||
|
||||
<p>You can optionally use a <code>value_template</code> to process the value of the state before testing it.</p>
|
||||
<p>You can optionally use a <code class="highlighter-rouge">value_template</code> to process the value of the state before testing it.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">numeric_state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">sensor.temperature</span></span>
|
||||
<span class="key">above</span>: <span class="string"><span class="content">17</span></span>
|
||||
<span class="key">below</span>: <span class="string"><span class="content">25</span></span>
|
||||
<span class="comment"># If your sensor value needs to be adjusted</span>
|
||||
<span class="key">value_template</span>:
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">numeric_state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sensor.temperature</span>
|
||||
<span class="s">above</span><span class="pi">:</span> <span class="s">17</span>
|
||||
<span class="s">below</span><span class="pi">:</span> <span class="s">25</span>
|
||||
<span class="c1"># If your sensor value needs to be adjusted</span>
|
||||
<span class="s">value_template</span><span class="pi">:</span> <span class="pi">{{</span> <span class="nv">float(state.state) + 2</span> <span class="pi">}}</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="state-condition" href="#state-condition"></a> State condition</h4>
|
||||
<h3><a class="title-link" name="state-condition" href="#state-condition"></a> State condition</h3>
|
||||
|
||||
<p>Tests if an entity is a specified state.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">device_tracker.paulus</span></span>
|
||||
<span class="key">state</span>: <span class="string"><span class="content">not_home</span></span>
|
||||
<span class="comment"># optional: trigger only if state was this for last X time.</span>
|
||||
<span class="key">for</span>:
|
||||
<span class="key">hours</span>: <span class="string"><span class="content">1</span></span>
|
||||
<span class="key">minutes</span>: <span class="string"><span class="content">10</span></span>
|
||||
<span class="key">seconds</span>: <span class="string"><span class="content">5</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">device_tracker.paulus</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s">not_home</span>
|
||||
<span class="c1"># optional: trigger only if state was this for last X time.</span>
|
||||
<span class="s">for</span><span class="pi">:</span>
|
||||
<span class="s">hours</span><span class="pi">:</span> <span class="s">1</span>
|
||||
<span class="s">minutes</span><span class="pi">:</span> <span class="s">10</span>
|
||||
<span class="s">seconds</span><span class="pi">:</span> <span class="s">5</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="sun-condition" href="#sun-condition"></a> Sun condition</h4>
|
||||
<h3><a class="title-link" name="sun-condition" href="#sun-condition"></a> Sun condition</h3>
|
||||
|
||||
<p>The sun condition can test if the sun has already set or risen when a trigger occurs. The <code>before</code> and <code>after</code> keys can only be set to <code>sunset</code> or <code>sunrise</code>. They have a corresponding optional offset value (<code>before_offset</code>, <code>after_offset</code>) that can be added, similar to the <a href="/getting-started/automation-trigger/#sun-trigger">sun trigger</a>.</p>
|
||||
<p>The sun condition can test if the sun has already set or risen when a trigger occurs. The <code class="highlighter-rouge">before</code> and <code class="highlighter-rouge">after</code> keys can only be set to <code class="highlighter-rouge">sunset</code> or <code class="highlighter-rouge">sunrise</code>. They have a corresponding optional offset value (<code class="highlighter-rouge">before_offset</code>, <code class="highlighter-rouge">after_offset</code>) that can be added, similar to the <a href="/getting-started/automation-trigger/#sun-trigger">sun trigger</a>.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">sun</span></span>
|
||||
<span class="key">after</span>: <span class="string"><span class="content">sunset</span></span>
|
||||
<span class="comment"># Optional offset value</span>
|
||||
<span class="key">after_offset</span>: <span class="string"><span class="delimiter">"</span><span class="content">-1:00:00</span><span class="delimiter">"</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">sun</span>
|
||||
<span class="s">after</span><span class="pi">:</span> <span class="s">sunset</span>
|
||||
<span class="c1"># Optional offset value</span>
|
||||
<span class="s">after_offset</span><span class="pi">:</span> <span class="s2">"</span><span class="s">-1:00:00"</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="template-condition" href="#template-condition"></a> Template condition</h4>
|
||||
<h3><a class="title-link" name="template-condition" href="#template-condition"></a> Template condition</h3>
|
||||
|
||||
<p>The template condition will test if the <a href="/topics/templating/">given template</a> renders a value equal to true. This is achieved by having the template result in a true boolean expression or by having the template render ‘true’.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">template</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ states.device_tracker.iphone.attributes.battery > 50 }}'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">template</span>
|
||||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.device_tracker.iphone.attributes.battery</span><span class="nv"> </span><span class="s">></span><span class="nv"> </span><span class="s">50</span><span class="nv"> </span><span class="s">}}'</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Within an automation, template conditions also have access to the <code>trigger</code> variable as <a href="/getting-started/automation-templating/">described here</a>.</p>
|
||||
<p>Within an automation, template conditions also have access to the <code class="highlighter-rouge">trigger</code> variable as <a href="/getting-started/automation-templating/">described here</a>.</p>
|
||||
|
||||
<h4><a class="title-link" name="time-condition" href="#time-condition"></a> Time condition</h4>
|
||||
<h3><a class="title-link" name="time-condition" href="#time-condition"></a> Time condition</h3>
|
||||
|
||||
<p>The time condition can test if it is after a specified time, before a specified time or if it is a certain day of the week</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">time</span></span>
|
||||
<span class="comment"># At least one of the following is required.</span>
|
||||
<span class="key">after</span>: <span class="string"><span class="content">'15:00:00'</span></span>
|
||||
<span class="key">before</span>: <span class="string"><span class="content">'23:00:00'</span></span>
|
||||
<span class="key">weekday</span>:
|
||||
- <span class="string"><span class="content">mon</span></span>
|
||||
- <span class="string"><span class="content">wed</span></span>
|
||||
- <span class="string"><span class="content">fri</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">time</span>
|
||||
<span class="c1"># At least one of the following is required.</span>
|
||||
<span class="s">after</span><span class="pi">:</span> <span class="s1">'</span><span class="s">15:00:00'</span>
|
||||
<span class="s">before</span><span class="pi">:</span> <span class="s1">'</span><span class="s">23:00:00'</span>
|
||||
<span class="s">weekday</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">mon</span>
|
||||
<span class="pi">-</span> <span class="s">wed</span>
|
||||
<span class="pi">-</span> <span class="s">fri</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Valid values for <code>weekday</code> are <code>mon</code>, <code>tue</code>, <code>wed</code>, <code>thu</code>, <code>fri</code>, <code>sat</code>, <code>sun</code>.</p>
|
||||
<p>Valid values for <code class="highlighter-rouge">weekday</code> are <code class="highlighter-rouge">mon</code>, <code class="highlighter-rouge">tue</code>, <code class="highlighter-rouge">wed</code>, <code class="highlighter-rouge">thu</code>, <code class="highlighter-rouge">fri</code>, <code class="highlighter-rouge">sat</code>, <code class="highlighter-rouge">sun</code>.</p>
|
||||
|
||||
<h4><a class="title-link" name="zone-condition" href="#zone-condition"></a> Zone condition</h4>
|
||||
<h3><a class="title-link" name="zone-condition" href="#zone-condition"></a> Zone condition</h3>
|
||||
|
||||
<p>Zone conditions test if an entity is in a certain zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the <a href="/components/device_tracker.owntracks/">OwnTracks platform</a> and the <a href="/components/device_tracker.icloud/">iCloud platform</a>.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">condition</span>: <span class="string"><span class="content">zone</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">device_tracker.paulus</span></span>
|
||||
<span class="key">zone</span>: <span class="string"><span class="content">zone.home</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">condition</span><span class="pi">:</span> <span class="s">zone</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">device_tracker.paulus</span>
|
||||
<span class="s">zone</span><span class="pi">:</span> <span class="s">zone.home</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="examples" href="#examples"></a> Examples</h4>
|
||||
<h3><a class="title-link" name="examples" href="#examples"></a> Examples</h3>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre> <span class="key">condition</span>:
|
||||
- <span class="string"><span class="content">condition: numeric_state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">sun.sun</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">''</span></span>
|
||||
<span class="key">below</span>: <span class="string"><span class="content">1</span></span>
|
||||
- <span class="string"><span class="content">condition: state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">light.living_room</span></span>
|
||||
<span class="key">state</span>: <span class="string"><span class="content">'off'</span></span>
|
||||
- <span class="string"><span class="content">condition: time</span></span>
|
||||
<span class="key">before</span>: <span class="string"><span class="content">'23:00:00'</span></span>
|
||||
<span class="key">after</span>: <span class="string"><span class="content">'14:00:00'</span></span>
|
||||
- <span class="string"><span class="content">condition: state</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">script.light_turned_off_5min</span></span>
|
||||
<span class="key">state</span>: <span class="string"><span class="content">'off'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="s">condition</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">numeric_state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sun.sun</span>
|
||||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">'</span>
|
||||
<span class="s">below</span><span class="pi">:</span> <span class="s">1</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.living_room</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">time</span>
|
||||
<span class="s">before</span><span class="pi">:</span> <span class="s1">'</span><span class="s">23:00:00'</span>
|
||||
<span class="s">after</span><span class="pi">:</span> <span class="s1">'</span><span class="s">14:00:00'</span>
|
||||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">script.light_turned_off_5min</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue