360 lines
No EOL
21 KiB
HTML
360 lines
No EOL
21 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>Conditions - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Documentation about all available conditions.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/getting-started/scripts-conditions/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Conditions">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/getting-started/scripts-conditions/">
|
||
<meta property="og:type" content="website">
|
||
<meta property="og:description" content="Documentation about all available conditions.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
|
||
<meta name="twitter:title" content="Conditions">
|
||
<meta name="twitter:description" content="Documentation about all available conditions.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
|
||
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
|
||
<body >
|
||
|
||
<header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
|
||
<li><a href='/getting-started/'>Getting started</a></li>
|
||
<li><a href='/components/'>Components</a></li>
|
||
<li><a href='/cookbook/'>Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</header>
|
||
|
||
|
||
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
|
||
|
||
<article class="page">
|
||
|
||
|
||
|
||
|
||
<header>
|
||
<h1 class="title indent">
|
||
Conditions
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<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>
|
||
|
||
<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="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>
|
||
|
||
<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="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>
|
||
|
||
<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.
|
||
This allows you to mix several AND and OR conditions together.</p>
|
||
|
||
<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>
|
||
|
||
<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 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 class="highlighter-rouge">value_template</code> to process the value of the state before testing it.</p>
|
||
|
||
<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>
|
||
|
||
<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="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>
|
||
|
||
<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 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="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>
|
||
|
||
<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="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 class="highlighter-rouge">trigger</code> variable as <a href="/getting-started/automation-templating/">described here</a>.</p>
|
||
|
||
<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="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 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>
|
||
|
||
<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="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>
|
||
|
||
<h3><a class="title-link" name="examples" href="#examples"></a> Examples</h3>
|
||
|
||
<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>
|
||
|
||
|
||
</article>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
|
||
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/getting-started/scripts-conditions.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Getting Started Guide</h1>
|
||
<ul class='divided sidebar-menu'>
|
||
<li>
|
||
<a href='/getting-started/'>Installation </a>
|
||
<ul>
|
||
<li><a href='/getting-started/installation-raspberry-pi/'>Raspberry Pi </a></li>
|
||
<li><a href='/getting-started/installation-raspberry-pi-all-in-one/'>Raspberry Pi All-In-One Installer </a></li>
|
||
<li><a href='/getting-started/installation-docker/'>Docker </a></li>
|
||
<li><a href='/getting-started/installation-vagrant/'>Vagrant </a></li>
|
||
<li><a href='/getting-started/installation-synology/'>Synology NAS </a></li>
|
||
<li><a href='/getting-started/installation-virtualenv/'>Virtualenv Linux </a></li>
|
||
<li><a href='/getting-started/updating/'>Updating </a></li>
|
||
<li><a href='/getting-started/troubleshooting/'>Troubleshooting </a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href='/getting-started/configuration/'>Configuration </a>
|
||
<ul>
|
||
<li><a href='/getting-started/yaml/'>YAML </a></li>
|
||
<li><a href='/getting-started/basic/'>Basic information </a></li>
|
||
<li><a href='/getting-started/devices/'>Setting up devices </a></li>
|
||
<li><a href='/getting-started/customizing-devices/'>Customizing devices and services </a></li>
|
||
<li><a href='/getting-started/presence-detection/'>Presence Detection </a></li>
|
||
<li><a href='/getting-started/troubleshooting-configuration/'>Troubleshooting </a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href='/getting-started/automation/'>Automation </a>
|
||
<ul>
|
||
<li><a href='/getting-started/automation-create-first/'>Tutorial </a></li>
|
||
<li><a href='/getting-started/automation-trigger/'>Triggers </a></li>
|
||
<li><a href='/getting-started/automation-condition/'>Conditions </a></li>
|
||
<li><a href='/getting-started/automation-action/'>Actions </a></li>
|
||
<li><a href='/getting-started/automation-templating/'>Templates </a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href='/getting-started/scripts/'>Scripts </a>
|
||
<ul>
|
||
<li><a href='/getting-started/scripts-service-calls/'>Service Calls </a></li>
|
||
<li><a class='active' href='/getting-started/scripts-conditions/'>Conditions </a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href='/getting-started/z-wave/'>Z-Wave </a>
|
||
<ul>
|
||
<li><a href='/getting-started/z-wave-controllers/'>USB Controllers </a></li>
|
||
<li><a href='/getting-started/z-wave-settings/'>Modifying Settings </a></li>
|
||
<li><a href='/getting-started/z-wave-device-specific/'>Device Specific </a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href='/getting-started/autostart/'>Autostart </a>
|
||
<ul>
|
||
<li><a href='/getting-started/autostart-systemd/'>Linux - systemd </a></li>
|
||
<li><a href='/getting-started/autostart-upstart/'>Linux - Upstart </a></li>
|
||
<li><a href='/getting-started/autostart-macos/'>OS X </a></li>
|
||
<li><a href='/getting-started/autostart-synology/'>Synology NAS </a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href='/topics/'>Advanced Topics </a></li>
|
||
<li><a href='/getting-started/android/'>Add to Android Homescreen </a></li>
|
||
<li><a href='/getting-started/browsers/'>Browser Compatibility List </a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
|
||
</div>
|
||
</aside>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
</body>
|
||
</html> |