jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-08-26 06:14:00 UTC

Browse source
This commit is contained in:
Travis CI 2017-08-26 06:14:00 +00:00
parent 0408a5478d
commit bf5e0c0bc2
733 changed files with 8077 additions and 1976 deletions
Download patch file Download diff file Expand all files Collapse all files

20
getting-started/automation-2/index.html
View file

@ -78,7 +78,7 @@
<p>We are defining a <a href="/docs/automation/trigger/">trigger</a> to track the sunset and tell it to fire when the sun is setting. When this event is triggered, the service <code class="highlighter-rouge">light.turn_on</code> is called without any parameters. Because we specify no parameters, it will turn on all the lights.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on light when sun sets</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on the lights when the sun sets</span>
<span class="s">initial_state</span><span class="pi">:</span> <span class="s">True</span>
<span class="s">hide_entity</span><span class="pi">:</span> <span class="s">False</span>
<span class="s">trigger</span><span class="pi">:</span>
@ -88,11 +88,11 @@
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
</code></pre>
</div>
<p>Starting with 0.28 automation rules can be reloaded from the <a href="/components/automation/">frontend</a> and are shown by default. With <a href="/components/automation/"><code class="highlighter-rouge">hide_entity:</code></a> you can control this behaviour. It’s very handy if you are working on your rules but when a rule is finished and you don’t want to see that rule in your frontend, you can set <code class="highlighter-rouge">hide_entity:</code> to <code class="highlighter-rouge">True</code>. To set an automation to be disabled when Home Assistant starts set <code class="highlighter-rouge">initial_state:</code> to <code class="highlighter-rouge">False</code>.</p>
<p>After a few days of running this automation rule, you come to realize that this automation rule is not good enough. It was already dark when the lights went on and the one day you weren’t home, the lights turned on anyway. Time for some tweaking. Let’s add an offset to the sunset trigger and a <a href="/docs/automation/condition/">condition</a> to only turn on the lights if anyone is home.</p>
<p>Starting with 0.28 automation rules can be reloaded from the <a href="/components/automation/">frontend</a> and are shown by default. With <a href="/components/automation/"><code class="highlighter-rouge">hide_entity:</code></a> you can control this behavior. It’s convenient if you are working on your rules, but when a rule is finished, and you don’t want to see that rule in your frontend, you can set <code class="highlighter-rouge">hide_entity:</code> to <code class="highlighter-rouge">True</code>. To set an automation to be disabled when Home Assistant starts set <code class="highlighter-rouge">initial_state:</code> to <code class="highlighter-rouge">False</code>.</p>
<p>After a few days of running this automation rule, you come to realize that this automation rule is not sufficient. It was already dark when the lights went on, and the one day you weren’t home, the lights turned on anyway. Time for some tweaking. Let’s add an offset to the sunset trigger and a <a href="/docs/automation/condition/">condition</a> to only turn on the lights if anyone is home.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on light when sun sets</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on the lights when the sun sets</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">sun</span>
<span class="s">event</span><span class="pi">:</span> <span class="s">sunset</span>
@ -105,8 +105,8 @@
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
</code></pre>
</div>
<p>Now you’re happy and all is good. You start to like this automation business and buy some more lights, this time you put them in the bedroom. But what you now realize is that when the sun is setting, the lights in the bedroom are also being turned on! Time to tweak the automation to only turn on the living room lights.</p>
<p>The first thing you do is to look at the entities in the developer tools (second icon) in the app. You see the names of your lights and you write them down: <code class="highlighter-rouge">light.table_lamp</code>, <code class="highlighter-rouge">light.bedroom</code>, <code class="highlighter-rouge">light.ceiling</code>.</p>
<p>Now you’re happy, and all is good. You start to like this automation business and buy some more lights, this time you put them in the bedroom. But what you now realize is that when the sun is setting, the lights in the bedroom are also being turned on! Time to tweak the automation to only turn on the living room lights.</p>
<p>The first thing you do is to look at the entities in the developer tools (second icon) in the app. You see the names of your lights, and you write them down: <code class="highlighter-rouge">light.table_lamp</code>, <code class="highlighter-rouge">light.bedroom</code>, <code class="highlighter-rouge">light.ceiling</code>.</p>
<p>Instead of hard coding the entity IDs of the lights in the automation rule, we will set up a group. This will allow us to see the living room separate in the app and be able to address it from automation rules.</p>
<p>So we tweak the config to add the group and have the automation rule only turn on the group.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
@ -116,7 +116,7 @@
<span class="pi">-</span> <span class="s">light.ceiling</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on light when sun sets</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on the light when the sun sets</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">sun</span>
<span class="s">event</span><span class="pi">:</span> <span class="s">sunset</span>
@ -130,8 +130,8 @@
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">group.living_room</span>
</code></pre>
</div>
<p>Christmas is coming along and you decide to buy a remote switch to control the Christmas lights from Home Assistant. You can’t claim to live in the house of the future if you’re still manually turning on your Christmas lights!</p>
<p>We hook the switch up to Home Assistant and grab the entity ID from the developer tools: <code class="highlighter-rouge">switch.christmas_lights</code>. We will update the group to include the switch and will change our <a href="/docs/automation/action/">action</a>. We are no longer able to call <code class="highlighter-rouge">light.turn_on</code> because we also want to turn on a switch. This is where <code class="highlighter-rouge">homeassistant.turn_on</code> comes to the rescue. This service is capable of turning any entity on.</p>
<p>Christmas is coming along, and you decide to buy a remote switch to control the Christmas lights from Home Assistant. You can’t claim to live in the house of the future if you’re still manually turning on your Christmas lights!</p>
<p>We hook the switch up to Home Assistant and grab the entity ID from the developer tools: <code class="highlighter-rouge">switch.christmas_lights</code>. We will update the group to include the switch and will change our <a href="/docs/automation/action/">action</a>. We are no longer able to call <code class="highlighter-rouge">light.turn_on</code> because we also want to turn on a switch. This is where <code class="highlighter-rouge">homeassistant.turn_on</code> comes to the rescue. This service is capable of turning on any entity.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">group</span><span class="pi">:</span>
<span class="s">living_room</span><span class="pi">:</span>
@ -140,7 +140,7 @@
<span class="pi">-</span> <span class="s">switch.christmas_lights</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on light when sun sets</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on the lights when the sun sets</span>
<span class="s">hide_entity</span><span class="pi">:</span> <span class="s">True</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">sun</span>

4
getting-started/configuration/index.html
View file

@ -76,12 +76,12 @@
<hr class="divider">
<p>When launched for the first time, Home Assistant will write a default configuration file, called <code class="highlighter-rouge">configuration.yaml</code>, enabling the web interface and <a href="/components/discovery/">device discovery</a>. It can take up to a minute for your devices to be discovered and appear in the user interface.</p>
<p>The <code class="highlighter-rouge">configuration.yaml</code> is written in <a href="/docs/configuration/yaml/">YAML</a>, stored in <a href="/docs/configuration/"><code class="highlighter-rouge">.homeassistant</code></a>, and can be modified with a text editor.</p>
<p>See the <a href="/components/">components overview page</a> to find sample entries for your devices and services. For a sensor that is showing <a href="/components/sensor.random/">random values</a>, the entry would looks like the sample below:</p>
<p>See the <a href="/components/">components overview page</a> to find sample entries for your devices and services. For a sensor that is showing <a href="/components/sensor.random/">random values</a>, the entry would look like the sample below:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">random</span>
</code></pre>
</div>
<p>The <a href="/docs/configuration/devices/">Setting up devices part</a> contains of the documentation additional details about adding device and services and <a href="/docs/configuration/customizing-devices/">customization</a>.</p>
<p>The <a href="/docs/configuration/devices/">Setting up devices part</a> contains the additional documentation details about adding devices and services and <a href="/docs/configuration/customizing-devices/">customization</a>.</p>
<p>For further details about configuration, please take a look at the <a href="/docs/configuration/">configuration documentation</a>.</p>
<h3><a href="/getting-started/automation/">Next step: Automate Home Assistant »</a></h3>
</article>

4
getting-started/index.html
View file

@ -74,7 +74,7 @@
</h1>
</header>
<hr class="divider">
<p>You will need to install Home Assistant before we can get started. You can install Home Assistant on your computer or you can turn a Raspberry Pi into a dedicated Home Assistant hub.</p>
<p>You will need to install Home Assistant before we can get started. You can install Home Assistant on your computer, or you can turn a Raspberry Pi into a dedicated Home Assistant hub.</p>
<div class="text-center hass-option-cards">
<a class="option-card" href="/hassio/">
<div class="img-container">
@ -90,7 +90,7 @@
</a>
</div>
<p><br /></p>
<p>For alternative installation methods please take a look at the <a href="/docs/installation/">installation documentation</a>.</p>
<p>For alternative installation methods, please take a look at the <a href="/docs/installation/">installation documentation</a>.</p>
<p>If you run into any issues, please see <a href="/docs/installation/troubleshooting/">the troubleshooting page</a> or <a href="/help/">communication channels</a>. It contains solutions to many commonly encountered issues.</p>
<h3><a href="/getting-started/configuration/">Next step: Configuring Home Assistant »</a></h3>
</article>

4
getting-started/presence-detection/index.html
View file

@ -77,7 +77,7 @@
<p class="note">
We care about privacy. Collected data is <b>only</b> stored in your instance of Home Assistant.
</p>
<p>Presence detection detects if people are home, which is the most important input for automation. Knowing who is home or where they are will open a whole range of other automation options:</p>
<p>Presence detection detects if people are home, which is the most valuable input for automation. Knowing who is home or where they are, will open a whole range of other automation options:</p>
<ul>
<li>Send me a notification when my child arrives at school</li>
<li>Turn on the AC when I leave work</li>
@ -88,7 +88,7 @@ Screenshot of Home Assistant showing a school, work and home zone and two people
</p>
<h3><a class="title-link" name="setting-it-up" href="#setting-it-up"></a> Setting it up</h3>
<p>The device tracker component offers presence detection for Home Assistant. It supports two different methods for presence detection: scan for connected devices on the local network and connect to third party service.</p>
<p>Scanning for connected devices is easy to setup. See the instructions for our <a href="/components/#presence-detection">supported routers</a> or <a href="/components/device_tracker.nmap_tracker/">scan the network using nmap</a>. This approach does have its limitations, however: it will only be able to detect if a device is home, and iPhones may show as not home inaccurately (as iPhones disconnect from WiFi if idle).</p>
<p>Scanning for connected devices is easy to setup. See the instructions for our <a href="/components/#presence-detection">supported routers</a> or <a href="/components/device_tracker.nmap_tracker/">scan the network using nmap</a>. This approach does have its limitations, however: it will only be able to detect if a device is at home, and iPhones may show as not home inaccurately (as iPhones disconnect from WiFi if idle).</p>
<p>Home Assistant currently supports multiple third-party services for presence detection: <a href="/components/device_tracker.owntracks/">OwnTracks</a>, <a href="/components/device_tracker.gpslogger/">GPSLogger</a> and <a href="/components/device_tracker.locative/">Locative</a>. OwnTracks is an app that you install on your iPhone or Android phone that allows you to push the location of your device to Home Assistant using an MQTT broker. An MQTT broker is an Internet of Things communication platform that you can <a href="/components/mqtt/#run-your-own">freely host yourself</a> or get <a href="/components/mqtt/#run-your-own">a private instance for free in the cloud</a>.</p>
<p class="note">
OwnTracks communicates directly with your MQTT broker; no data will pass through their servers.