166 lines
9.8 KiB
HTML
166 lines
9.8 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>Zone - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup zones within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/zone/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Zone">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/zone/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup zones within Home Assistant.">
|
||
<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="Zone">
|
||
<meta name="twitter:description" content="Instructions how to setup zones within Home Assistant.">
|
||
<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="/docs/">Docs</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">
|
||
Zone
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device to be within a zone, the state will take the name from the zone. Zones can also be used as a <a href="/getting-started/automation-trigger/#zone-trigger">trigger</a> or <a href="/getting-started/automation-condition/#zone-condition">condition</a> inside automation setups.</p>
|
||
<p>Zones support the usual method to specify multiple zones, use keys <code class="highlighter-rouge">zone:</code>, <code class="highlighter-rouge">zone 2:</code> etc.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">zone</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">School</span>
|
||
<span class="s">latitude</span><span class="pi">:</span> <span class="s">32.8773367</span>
|
||
<span class="s">longitude</span><span class="pi">:</span> <span class="s">-117.2494053</span>
|
||
<span class="s">radius</span><span class="pi">:</span> <span class="s">250</span>
|
||
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:school</span>
|
||
|
||
<span class="s">zone 2</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Work</span>
|
||
<span class="s">latitude</span><span class="pi">:</span> <span class="s">32.8753367</span>
|
||
<span class="s">longitude</span><span class="pi">:</span> <span class="s">-117.2474053</span>
|
||
|
||
<span class="c1"># This will override the default home zone</span>
|
||
<span class="s">zone 3</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Home</span>
|
||
<span class="s">latitude</span><span class="pi">:</span> <span class="s">32.8793367</span>
|
||
<span class="s">longitude</span><span class="pi">:</span> <span class="s">-117.2474053</span>
|
||
<span class="s">radius</span><span class="pi">:</span> <span class="s">100</span>
|
||
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:account-multiple</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): Friendly name of entry.</li>
|
||
<li><strong>latitude</strong> (<em>Required</em>): Latitude of the center point of the zone.</li>
|
||
<li><strong>longitude</strong> (<em>Required</em>): Longitude of the center point of the zone.</li>
|
||
<li><strong>radius</strong> (<em>Optional</em>): Optional radius in meters. Defaults to 100 meters.</li>
|
||
<li><strong>icon</strong> (<em>Optional</em>): Optional icon to show instead of name.</li>
|
||
<li><strong>passive</strong> (<em>Optional</em>): Optional boolean to only use the zone for automation and hide it from the UI and not use the zone for device tracker name. Defaults to false.</li>
|
||
</ul>
|
||
<h4><a class="title-link" name="home-zone" href="#home-zone"></a> Home zone</h4>
|
||
<p>If no configuration is given, the <code class="highlighter-rouge">zone</code> component will create a zone for home. This zone will use location given in the <code class="highlighter-rouge">configuration.yaml</code> file and have a radius of 100 meters. To override this, create a zone configuration and name it <strong>‘Home’</strong>.</p>
|
||
<p class="note">
|
||
Devices that are in the zone <strong>‘Home’</strong> will not appear on the map in the Home Assistant UI.
|
||
</p>
|
||
<h4><a class="title-link" name="icons" href="#icons"></a> Icons</h4>
|
||
<p>It is preferred to pick an icon to use for your zone. Pick any icon that you can find on <a href="https://materialdesignicons.com/">materialdesignicons.com</a> and prefix the name with <code class="highlighter-rouge">mdi:</code>. For example <code class="highlighter-rouge">mdi:school</code>, <code class="highlighter-rouge">mdi:worker</code>, <code class="highlighter-rouge">mdi:home</code>, <code class="highlighter-rouge">mdi:cart</code>, or <code class="highlighter-rouge">mdi:castle</code>.</p>
|
||
<h4>State</h4>
|
||
<p><code class="highlighter-rouge">zoning</code> is the state a <code class="highlighter-rouge">zone</code> has when it is configured. A <code class="highlighter-rouge">zone</code> doesn’t have another state, all configured zones are <code class="highlighter-rouge">zoning</code> all the time.</p>
|
||
</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/_components/zone.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/home-assistant.png' />
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Organization</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/group/'>Group</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/scene/'>Scenes</a>
|
||
</li>
|
||
<li>
|
||
Zone
|
||
</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>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</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>
|