231 lines
No EOL
9.6 KiB
HTML
231 lines
No EOL
9.6 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="Paulus Schoutsen">
|
||
<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/home-assistant-logo-2164x2164.png">
|
||
|
||
<meta name="twitter:card" content="summary">
|
||
<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/home-assistant-logo-2164x2164.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>Getting started <i class="icon icon-caret-down"></i></a>
|
||
<ul>
|
||
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
|
||
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
|
||
<li><a href='/getting-started/devices/'>Adding devices</a></li>
|
||
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
|
||
<li><a href='/getting-started/automation/'>Automation</a></li>
|
||
<li><a href='/getting-started/templating/'>Templating</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href='/components/'>Components</a></li>
|
||
<li><a href='/cookbook'>Examples</a></li>
|
||
<li>
|
||
<a>Developers <i class="icon icon-caret-down"></i></a>
|
||
<ul>
|
||
<li><a href="/developers/">Setup Development</a></li>
|
||
<li><a href="/developers/architecture/">Architecture</a></li>
|
||
<li><a href="/developers/frontend/">Frontend development</a></li>
|
||
<li><a href="/developers/creating_components/">
|
||
Creating components
|
||
</a></li>
|
||
<li><a href="/developers/add_new_platform/">
|
||
Adding platform support
|
||
</a></li>
|
||
<li><a href="/developers/api/">API</a></li>
|
||
<li><a href="/developers/credits/">Credits</a></li>
|
||
</ul>
|
||
</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="/components/automation/#zone-trigger">trigger</a> or <a href="/components/automation/#zone-condition">condition</a> inside automation setups.</p>
|
||
|
||
<p>Zones support the usual method to specify multiple zones, use keys <code>zone:</code>, <code>zone 2:</code> etc.</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
||
<span class="key">zone</span>:
|
||
<span class="key">name</span>: <span class="string"><span class="content">School</span></span>
|
||
<span class="key">latitude</span>: <span class="string"><span class="content">32.8773367</span></span>
|
||
<span class="key">longitude</span>: <span class="string"><span class="content">-117.2494053</span></span>
|
||
<span class="key">radius</span>: <span class="string"><span class="content">250</span></span>
|
||
<span class="key">icon</span>: <span class="string"><span class="content">mdi:school</span></span>
|
||
|
||
<span class="key">zone 2</span>:
|
||
<span class="key">name</span>: <span class="string"><span class="content">Work</span></span>
|
||
<span class="key">latitude</span>: <span class="string"><span class="content">32.8753367</span></span>
|
||
<span class="key">longitude</span>: <span class="string"><span class="content">-117.2474053</span></span>
|
||
|
||
<span class="comment"># This will override the default home zone</span>
|
||
<span class="key">zone 3</span>:
|
||
<span class="key">name</span>: <span class="string"><span class="content">Home</span></span>
|
||
<span class="key">latitude</span>: <span class="string"><span class="content">32.8793367</span></span>
|
||
<span class="key">longitude</span>: <span class="string"><span class="content">-117.2474053</span></span>
|
||
<span class="key">radius</span>: <span class="string"><span class="content">100</span></span>
|
||
<span class="key">icon</span>: <span class="string"><span class="content">mdi:account-multiple</span></span>
|
||
</pre></div>
|
||
</div>
|
||
</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>
|
||
</ul>
|
||
|
||
<h4><a class="title-link" name="home-zone" href="#home-zone"></a> Home zone</h4>
|
||
|
||
<p>If no configuration is given, the <code>zone</code> component will create a zone for home. This zone will use location given in the <code>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>
|
||
|
||
<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 zone that you can find on <a href="https://materialdesignicons.com/">materialdesignicons.com</a> and prefix the name with <code>mdi:</code>. For example <code>mdi:school</code>, <code>mdi:worker</code>, <code>mdi:home</code>, <code>mdi:cart</code>, or <code>mdi:castle</code>.</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/balloob/home-assistant.io/tree/master/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://github.com/balloob/home-assistant'><i class="icon-github"></i></a>
|
||
|
||
<div class="credit">
|
||
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>
|
||
|
||
<!--[if lt IE 7]>
|
||
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
|
||
<![endif]-->
|
||
|
||
<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> |