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

Site updated at 2018-01-25 17:33:45 UTC

Browse source
This commit is contained in:
Travis CI 2018-01-25 17:33:45 +00:00
parent 2a429df2b2
commit 94552b64db
144 changed files with 304 additions and 301 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/autostart/init.d/index.html
View file

@ -77,7 +77,7 @@
<hr class="divider">
<p>Home Assistant can run as a daemon within init.d with the script below.</p>
<h3><a class="title-link" name="1-copy-script" href="#1-copy-script"></a> 1. Copy script</h3>
<p>Copy either the deamon script or the Python environment scrip at the end of this page to <code class="highlighter-rouge">/etc/init.d/hass-daemon</code> depending on your installation.</p>
<p>Copy either the daemon script or the Python environment scrip at the end of this page to <code class="highlighter-rouge">/etc/init.d/hass-daemon</code> depending on your installation.</p>
<p>After that, set the script to be executable:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo chmod +x /etc/init.d/hass-daemon
</code></pre>
@ -129,7 +129,8 @@
<span class="c"># Typically /usr/bin/hass</span>
<span class="nv">HASS_BIN</span><span class="o">=</span><span class="s2">"hass"</span>
<span class="nv">RUN_AS</span><span class="o">=</span><span class="s2">"USER"</span>
<span class="nv">PID_FILE</span><span class="o">=</span><span class="s2">"/var/run/hass.pid"</span>
<span class="nv">PID_DIR</span><span class="o">=</span><span class="s2">"/var/run"</span>
<span class="nv">PID_FILE</span><span class="o">=</span><span class="s2">"</span><span class="nv">$PID_DIR</span><span class="s2">/hass.pid"</span>
<span class="nv">CONFIG_DIR</span><span class="o">=</span><span class="s2">"/var/opt/homeassistant"</span>
<span class="nv">LOG_DIR</span><span class="o">=</span><span class="s2">"/var/log/homeassistant"</span>
<span class="nv">LOG_FILE</span><span class="o">=</span><span class="s2">"</span><span class="nv">$LOG_DIR</span><span class="s2">/home-assistant.log"</span>

2
docs/configuration/basic/index.html
View file

@ -99,7 +99,7 @@
<li><strong>whitelist_external_dirs</strong> (<em>Optional</em>): List of folders that can be used as sources for sending files.</li>
</ul>
<h3><a class="title-link" name="password-protecting-the-web-interface" href="#password-protecting-the-web-interface"></a> Password protecting the web interface</h3>
<p>First, you’ll want to add a password for the Home Assistant web interface. Use your favourite text editor to open <code class="highlighter-rouge">configuration.yaml</code> and edit the <code class="highlighter-rouge">http</code> section:</p>
<p>First, you’ll want to add a password for the Home Assistant web interface. Use your favorite text editor to open <code class="highlighter-rouge">configuration.yaml</code> and edit the <code class="highlighter-rouge">http</code> section:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">http</span><span class="pi">:</span>
<span class="s">api_password</span><span class="pi">:</span> <span class="s">YOUR_PASSWORD</span>
</code></pre>

2
docs/configuration/group_visibility/index.html
View file

@ -77,7 +77,7 @@
<hr class="divider">
<p>After filling Home Assistant with all your precious home automation devices, you usually end up with a cluttered interface and lots of groups that are not interesting in your current context. What if you just want to show groups that are interesting <em>now</em> and hide the rest? That’s when group visibility comes to play.</p>
<h2><a class="title-link" name="changing-visibility-of-a-group" href="#changing-visibility-of-a-group"></a> Changing visibility of a group</h2>
<p>To change visibility of a group, use the service <code class="highlighter-rouge">group.set_visibility</code>, pass the group name as <code class="highlighter-rouge">entity_id</code> and use <code class="highlighter-rouge">visible</code> to decide wheter the group should be shown or hidden.</p>
<p>To change visibility of a group, use the service <code class="highlighter-rouge">group.set_visibility</code>, pass the group name as <code class="highlighter-rouge">entity_id</code> and use <code class="highlighter-rouge">visible</code> to decide whether the group should be shown or hidden.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">service</span><span class="pi">:</span> <span class="s">group.set_visibility</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">group.basement</span>
<span class="s">data</span><span class="pi">:</span>

2
docs/configuration/packages/index.html
View file

@ -133,7 +133,7 @@ light:
Components inside packages can only specify platform entries using configuration style 1, where all the platforms are grouped under the component name.
</p>
<h3><a class="title-link" name="create-a-packages-folder" href="#create-a-packages-folder"></a> Create a packages folder</h3>
<p>One way to organise packages would be to create a folder named “packages” in your Home Assistant configuration directory. In the packages directory you can store any number of packages in a YAML file. This entry in your <code class="highlighter-rouge">configuration.yaml</code> will load all packages:</p>
<p>One way to organize packages would be to create a folder named “packages” in your Home Assistant configuration directory. In the packages directory you can store any number of packages in a YAML file. This entry in your <code class="highlighter-rouge">configuration.yaml</code> will load all packages:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">homeassistant</span><span class="pi">:</span>
<span class="s">packages</span><span class="pi">:</span> <span class="kt">!include_dir_named</span> <span class="s">packages</span>
</code></pre>

22
docs/ecosystem/appdaemon/api/index.html
View file

@ -97,7 +97,7 @@
<li>Following a change in the status of Daylight Savings Time</li>
<li>Following a restart of Home Assistant</li>
</ul>
<p>In every case, the App is responsible for recreating any state it might need as if it were the first time it was ever started. If <code class="highlighter-rouge">initialize()</code> is called, the app can safely assume that it is either being loaded for the first time, or that all callbacks and timers have been cancelled. In either case, the APP will need to recreate them. Depending upon the application it may be desirable for the App to establish state such as whether or not a particular light is on, within the <code class="highlighter-rouge">initialize()</code> function to ensure that everything is as expected or to make immediate remedial action (e.g. turn off a light that might have been left on by mistake when the app was restarted).</p>
<p>In every case, the App is responsible for recreating any state it might need as if it were the first time it was ever started. If <code class="highlighter-rouge">initialize()</code> is called, the app can safely assume that it is either being loaded for the first time, or that all callbacks and timers have been canceled. In either case, the APP will need to recreate them. Depending upon the application it may be desirable for the App to establish state such as whether or not a particular light is on, within the <code class="highlighter-rouge">initialize()</code> function to ensure that everything is as expected or to make immediate remedial action (e.g. turn off a light that might have been left on by mistake when the app was restarted).</p>
<p>After the <code class="highlighter-rouge">initialize()</code> function is in place, the rest of the app consists of functions that are called by the various callback mechanisms, and any additional functions the user wants to add as part of the program logic. Apps are able to subscribe to 2 main classes of events:</p>
<ul>
<li>Scheduled Events</li>
@ -461,7 +461,7 @@
</code></pre>
</div>
<h3><a class="title-link" name="cancel_listen_state" href="#cancel_listen_state"></a> cancel_listen_state()</h3>
<p>Cancel a <code class="highlighter-rouge">listen_state()</code> callback. This will mean that the App will no longer be notified for the specific state change that has been cancelled. Other state changes will continue to be monitored.</p>
<p>Cancel a <code class="highlighter-rouge">listen_state()</code> callback. This will mean that the App will no longer be notified for the specific state change that has been canceled. Other state changes will continue to be monitored.</p>
<h4><a class="title-link" name="synopsis" href="#synopsis"></a> Synopsis</h4>
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">cancel_listen_state</span><span class="p">(</span><span class="n">handle</span><span class="p">)</span>
</code></pre>
@ -937,7 +937,7 @@
</code></pre>
</div>
<h3><a class="title-link" name="notify" href="#notify"></a> notify()</h3>
<p>This is a convenience function for the <code class="highlighter-rouge">notify.notify</code> service. It will send a notification to your defualt notification service. If you have more than one, use <code class="highlighter-rouge">call_service()</code> to call the specific notification service you require instead.</p>
<p>This is a convenience function for the <code class="highlighter-rouge">notify.notify</code> service. It will send a notification to your default notification service. If you have more than one, use <code class="highlighter-rouge">call_service()</code> to call the specific notification service you require instead.</p>
<h4><a class="title-link" name="synopsis" href="#synopsis"></a> Synopsis</h4>
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">notify</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
</code></pre>
@ -1069,7 +1069,7 @@
<p>The name of the event that caused the callback, e.g. <code class="highlighter-rouge">"MODE_CHANGE"</code> or <code class="highlighter-rouge">call_service</code>.</p>
<h4><a class="title-link" name="data" href="#data"></a> data</h4>
<p>A dictionary containing any additional information associated with the event.</p>
<h3><a class="title-link" name="use-of-events-for-signalling-between-home-assistant-and-appdaemon" href="#use-of-events-for-signalling-between-home-assistant-and-appdaemon"></a> Use of Events for Signalling between Home Assistant and AppDaemon</h3>
<h3><a class="title-link" name="use-of-events-for-signaling-between-home-assistant-and-appdaemon" href="#use-of-events-for-signaling-between-home-assistant-and-appdaemon"></a> Use of Events for Signaling between Home Assistant and AppDaemon</h3>
<p>Home Assistant allows for the creation of custom events and existing components can send and receive them. This provides a useful mechanism for signaling back and forth between Home Assistant and AppDaemon. For instance, if you would like to create a UI Element to fire off some code in Home Assistant, all that is necessary is to create a script to fire a custom event, then subscribe to that event in AppDaemon. The script would look something like this:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">alias</span><span class="pi">:</span> <span class="s">Day</span>
<span class="s">sequence</span><span class="pi">:</span>
@ -1180,7 +1180,7 @@
</code></pre>
</div>
<h4><a class="title-link" name="returns" href="#returns"></a> Returns</h4>
<p>A localised Python time object representing the current AppDaemon time.</p>
<p>A localized Python time object representing the current AppDaemon time.</p>
<h4><a class="title-link" name="parameters" href="#parameters"></a> Parameters</h4>
<p>None</p>
<h4><a class="title-link" name="example" href="#example"></a> Example</h4>
@ -1194,7 +1194,7 @@
</code></pre>
</div>
<h4><a class="title-link" name="returns" href="#returns"></a> Returns</h4>
<p>A localised Python time object representing the current AppDaemon date.</p>
<p>A localized Python time object representing the current AppDaemon date.</p>
<h4><a class="title-link" name="parameters" href="#parameters"></a> Parameters</h4>
<p>None</p>
<h4><a class="title-link" name="example" href="#example"></a> Example</h4>
@ -1208,7 +1208,7 @@
</code></pre>
</div>
<h4><a class="title-link" name="returns" href="#returns"></a> Returns</h4>
<p>A localised Python datetime object representing the current AppDaemon date and time.</p>
<p>A localized Python datetime object representing the current AppDaemon date and time.</p>
<h4><a class="title-link" name="parameters" href="#parameters"></a> Parameters</h4>
<p>None</p>
<h4><a class="title-link" name="example" href="#example"></a> Example</h4>
@ -1216,13 +1216,13 @@
</code></pre>
</div>
<h3><a class="title-link" name="convert_utc" href="#convert_utc"></a> convert_utc()</h3>
<p>Home Assistant provides timestamps of several different sorts that may be used to gain additional insight into state changes. These timestamps are in UTC and are coded as ISO 8601 Combined date and time strings. <code class="highlighter-rouge">convert_utc()</code> will accept one of these strings and convert it to a localised Python datetime object representing the timestamp</p>
<p>Home Assistant provides timestamps of several different sorts that may be used to gain additional insight into state changes. These timestamps are in UTC and are coded as ISO 8601 Combined date and time strings. <code class="highlighter-rouge">convert_utc()</code> will accept one of these strings and convert it to a localized Python datetime object representing the timestamp</p>
<h4><a class="title-link" name="synopsis" href="#synopsis"></a> Synopsis</h4>
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">convert_utc</span><span class="p">(</span><span class="n">utc_string</span><span class="p">)</span>
</code></pre>
</div>
<h4><a class="title-link" name="returns" href="#returns"></a> Returns</h4>
<p><code class="highlighter-rouge">convert_utc(utc_string)</code> returns a localised Python datetime object representing the timestamp.</p>
<p><code class="highlighter-rouge">convert_utc(utc_string)</code> returns a localized Python datetime object representing the timestamp.</p>
<h4><a class="title-link" name="parameters" href="#parameters"></a> Parameters</h4>
<h5><a class="title-link" name="utc_string" href="#utc_string"></a> utc_string</h5>
<p>An ISO 8601 encoded date and time string in the following format: <code class="highlighter-rouge">2016-07-13T14:24:02.040658-04:00</code></p>
@ -1411,7 +1411,7 @@
</div>
<p>Note the timestamps in the log - AppDaemon believes it is now just before sunset and will process any callbacks appropriately.</p>
<h3><a class="title-link" name="speeding-things-up" href="#speeding-things-up"></a> Speeding things up</h3>
<p>Some Apps need to run for periods of a day or two for you to test all aspects. This can be time consuming, but Time Travel can also help here in two ways. The first is by speeding up time. To do this, simply use the <code class="highlighter-rouge">-t</code> option on the command line. This specifies the amount of time a second lasts while time travelling. The default of course is 1 second, but if you change it to <code class="highlighter-rouge">0.1</code> for instance, AppDaemon will work 10x faster. If you set it to <code class="highlighter-rouge">0</code>, AppDaemon will work as fast as possible and, depending in your hardware, may be able to get through an entire day in a matter of minutes. Bear in mind however, due to the threaded nature of AppDaemon, when you are running with <code class="highlighter-rouge">-t 0</code> you may see actual events firing a little later than expected as the rest of the system tries to keep up with the timer. To set the tick time, start AppDaemon as follows:</p>
<p>Some Apps need to run for periods of a day or two for you to test all aspects. This can be time consuming, but Time Travel can also help here in two ways. The first is by speeding up time. To do this, simply use the <code class="highlighter-rouge">-t</code> option on the command line. This specifies the amount of time a second lasts while time traveling. The default of course is 1 second, but if you change it to <code class="highlighter-rouge">0.1</code> for instance, AppDaemon will work 10x faster. If you set it to <code class="highlighter-rouge">0</code>, AppDaemon will work as fast as possible and, depending in your hardware, may be able to get through an entire day in a matter of minutes. Bear in mind however, due to the threaded nature of AppDaemon, when you are running with <code class="highlighter-rouge">-t 0</code> you may see actual events firing a little later than expected as the rest of the system tries to keep up with the timer. To set the tick time, start AppDaemon as follows:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>appdaemon -t 0.1
</code></pre>
</div>
@ -1433,7 +1433,7 @@
</code></pre>
</div>
<h3><a class="title-link" name="a-note-on-times" href="#a-note-on-times"></a> A Note on Times</h3>
<p>Some Apps you write may depend on checking times of events relative to the current time. If you are time travelling this will not work if you use standard python library calls to get the current time and date etc. For this reason, always use the AppDamon supplied <code class="highlighter-rouge">time()</code>, <code class="highlighter-rouge">date()</code> and <code class="highlighter-rouge">datetime()</code> calls, documented earlier. These calls will consult with AppDaemon’s internal time rather than the actual time and give you the correct values.</p>
<p>Some Apps you write may depend on checking times of events relative to the current time. If you are time traveling this will not work if you use standard python library calls to get the current time and date etc. For this reason, always use the AppDamon supplied <code class="highlighter-rouge">time()</code>, <code class="highlighter-rouge">date()</code> and <code class="highlighter-rouge">datetime()</code> calls, documented earlier. These calls will consult with AppDaemon’s internal time rather than the actual time and give you the correct values.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

2
docs/ecosystem/backup/backup_github/index.html
View file

@ -168,7 +168,7 @@ git push origin master
<h3><a class="title-link" name="step-7-configuration-file-testing" href="#step-7-configuration-file-testing"></a> Step 7: Configuration file testing</h3>
<p><a href="https://travis-ci.org">Travis CI</a> is a continuous integration testing system that runs every time the code in your repository is updated and allows you to validate that your code works on a fresh install.</p>
<ul>
<li><a href="https://travis-ci.org/auth">Authorise Travis CI</a> to have access to your github repos.</li>
<li><a href="https://travis-ci.org/auth">Authorize Travis CI</a> to have access to your github repos.</li>
<li>Create the build script that travis will run to test your repo.</li>
<li>Create a dummy secrets.yaml for Travis.</li>
</ul>

2
docs/ecosystem/certificates/lets_encrypt/index.html
View file

@ -135,7 +135,7 @@ Before exposing your Home Assistant instance to the outside world it is ESSENTIA
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ifconfig
</code></pre>
</div>
<p>You will receive an ouput similar to the image below:</p>
<p>You will receive an output similar to the image below:</p>
<p class="img">
<img src="/images/screenshots/ip-set.jpg" />
Screenshot

2
docs/ecosystem/ios/notifications/actions/index.html
View file

@ -94,7 +94,7 @@
</ol>
<p>When sending a notification:</p>
<ol>
<li>Send a notification with <code class="highlighter-rouge">data.push.category</code> set to a pre-defined notification category identifer.</li>
<li>Send a notification with <code class="highlighter-rouge">data.push.category</code> set to a pre-defined notification category identifier.</li>
<li>Push notification delivered to device</li>
<li>User opens notification.</li>
<li>Action tapped</li>

2
docs/frontend/browsers/index.html
View file

@ -76,7 +76,7 @@
</header>
<hr class="divider">
<p>Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don’t test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works. The “Release” column contains the release number which were tested. This doen’t mean that older or newer releases not work.</p>
<p>If a browser is listed as working but you are still having problems, it is possible that some add-on or extension may be the problem. Some add-ons or extenstion are known to cause issue with the frontend, but it’s not possible to test them all. If you are having issues with the frontend displaying correctly, you should disable all your add-ons or extensions and enable them one at a time.</p>
<p>If a browser is listed as working but you are still having problems, it is possible that some add-on or extension may be the problem. Some add-ons or extension are known to cause issue with the frontend, but it’s not possible to test them all. If you are having issues with the frontend displaying correctly, you should disable all your add-ons or extensions and enable them one at a time.</p>
<p>We would appreciate if you help to keep this page up-to-date and add feedback.</p>
<h2><a class="title-link" name="microsoft-windows" href="#microsoft-windows"></a> Microsoft Windows</h2>
<table>

2
docs/glossary/index.html
View file

@ -123,7 +123,7 @@
<b>Hassbian</b>: <p><a href="/docs/installation/hassbian/">Hassbian</a> is a customized operating system specifically tailored for Raspberry Pi users. It is one of the easiest way of installing and running Home Assistant on a Raspberry Pi.</p>
</li>
<li>
<b>Packages</b>: <p><a href="/docs/configuration/packages/">Packages</a> allow you to bundle different component configuations together.</p>
<b>Packages</b>: <p><a href="/docs/configuration/packages/">Packages</a> allow you to bundle different component configurations together.</p>
</li>
<li>
<b>Platform</b>: <p><a href="/docs/configuration/platform_options/">Platforms</a> make the connection to a specific software or hardware platform. For example, the <code class="highlighter-rouge">pushbullet</code> platform works with the service pushbullet.com to send notifications.</p>

2
docs/installation/docker/index.html
View file

@ -94,7 +94,7 @@ netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=8123 conne
</div>
<p>This will let you access your Home Assistant portal from http://localhost:8123, and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the docker container.</p>
<h3><a class="title-link" name="synology-nas" href="#synology-nas"></a> Synology NAS</h3>
<p>As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatability-information, if your NAS is supported), see https://www.synology.com/en-us/dsm/app_packages/Docker</p>
<p>As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see https://www.synology.com/en-us/dsm/app_packages/Docker</p>
<p>The steps would be:</p>
<ul>
<li>Install “Docker” package on your Synology NAS</li>

2
docs/installation/hassbian/customization/index.html
View file

@ -80,7 +80,7 @@ The tool is available by running <code class="highlighter-rouge">hassbian-config
<h3>Install scripts</h3>
<p>To view the available packages run <code class="highlighter-rouge">hassbian-config show</code> and <code class="highlighter-rouge">sudo hassbian-config install PACKAGENAME</code>.</p>
<ul>
<li>Install Hue. Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component thats used with Amazon Echo, Google Home and Mycroft.ai.</li>
<li>Install Hue. Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component that’s used with Amazon Echo, Google Home and Mycroft.ai.</li>
<li>Install MariaDB. This script installs MariaDB and it’s dependencies for use with the recorder component in Home Assistant. No database or database user is created during this setup and will need to be created manually.</li>
<li>Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects official repository. Now includes websocket support.</li>
<li>Install Libcec. Adds local <a href="/components/hdmi_cec/">HDMI CEC support</a>. <em>This scipt is currently brooken upstream since it currently doesn’t build properly for Python &gt;3.4</em></li>

2
docs/installation/vagrant/index.html
View file

@ -88,7 +88,7 @@ Vagrant is intended for testing/development only. It is NOT recommended for perm
</code></pre>
</div>
<p class="note">
The following instructions will assume you changed your working directory to be <code class="highlighter-rouge">home-assistant/virtualization/vagrant</code>. This is mandatory because Vagrant will look for informations about the running VM inside that folder and won’t work otherwise
The following instructions will assume you changed your working directory to be <code class="highlighter-rouge">home-assistant/virtualization/vagrant</code>. This is mandatory because Vagrant will look for information about the running VM inside that folder and won’t work otherwise
</p>
<p class="note">
When using Vagrant on Windows, change git’s <code class="highlighter-rouge">auto.crlf</code> to input before cloning the Home Assistant repository. With input setting git won’t automatically change line endings from Unix LF to Windows CRLF. Shell scripts executed during provision won’t work with Windows line endings.

2
docs/installation/virtualenv/index.html
View file

@ -137,7 +137,7 @@
<h3><a class="title-link" name="notes" href="#notes"></a> Notes</h3>
<ul>
<li>In the future, if you want to start Home Assistant manually again, follow step 2, 3 and 5.</li>
<li>It’s recommanded to run Home Assistant as a dedicated user.</li>
<li>It’s recommended to run Home Assistant as a dedicated user.</li>
</ul>
<p class="info">
Looking for more advanced guides? Check our <a href="/docs/installation/raspberry-pi/">Rasbian guide</a> or the <a href="/docs/installation/">other installation guides</a>.

6
docs/scripts/index.html
View file

@ -8,7 +8,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Script Syntax - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Documention for the Home Assistant Script Syntax.">
<meta name="description" content="Documentation for the Home Assistant Script Syntax.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/docs/scripts/">
<meta property="fb:app_id" content="338291289691179">
@ -16,12 +16,12 @@
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/docs/scripts/">
<meta property="og:type" content="article">
<meta property="og:description" content="Documention for the Home Assistant Script Syntax.">
<meta property="og:description" content="Documentation for the Home Assistant Script Syntax.">
<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="Script Syntax">
<meta name="twitter:description" content="Documention for the Home Assistant Script Syntax.">
<meta name="twitter:description" content="Documentation for the Home Assistant Script Syntax.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">

5
docs/z-wave/adding/index.html
View file

@ -81,7 +81,7 @@
<li>Go to the <a href="/docs/z-wave/control-panel/">Z-Wave control panel</a> in the Home Assistant frontend</li>
<li>Click the <strong>Add Node</strong> button in the <em>Z-Wave Network Management</em> card - this will place the controller in inclusion mode</li>
<li>Activate your device to be included by following the instructions provided with the device</li>
<li>With the device in its final location, run a <em>Heal</em></li>
<li>With the device in its final location, run a <em>Heal Network</em></li>
</ol>
<p>Don’t use this for <a href="https://home-assistant.io/docs/z-wave/adding/#adding-secure-devices">secure devices</a>, since this is likely to limit the features the device supports.</p>
<p class="note warning">
@ -115,6 +115,7 @@ Ensure you keep a backup of this key. If you have to rebuild your system and don
<li>Go to the <a href="/docs/z-wave/control-panel/">Z-Wave control panel</a> in the Home Assistant frontend</li>
<li>Click the <strong>Add Node Secure</strong> button in the <em>Z-Wave Network Management</em> card - this will place the controller in inclusion mode</li>
<li>Activate your device to be included by following the instructions provided with the device</li>
<li>With the device in its final location, run a <em>Heal Network</em></li>
</ol>
<h2><a class="title-link" name="removing-devices" href="#removing-devices"></a> Removing Devices</h2>
<p>To remove (exclude) a Z-Wave device from your system:</p>
@ -122,7 +123,7 @@ Ensure you keep a backup of this key. If you have to rebuild your system and don
<li>Go to the Z-Wave control panel in the Home Assistant frontend</li>
<li>Click the <strong>Remove Node</strong> button in the <em>Z-Wave Network Management</em> card - this will place the controller in exclusion mode</li>
<li>Activate your device to be excluded by following the instructions provided with the device</li>
<li>With the device in its final location, run a <em>Heal</em></li>
<li>Run a <em>Heal Network</em> so all the other nodes learn about its removal</li>
</ol>
</article>
</div>

4
docs/z-wave/control-panel/index.html
View file

@ -106,7 +106,7 @@
<p><strong>Rename Node</strong> sets a node’s name - this won’t happen immediately, and requires you to restart Home Assistant (not reboot) to set the new name</p>
</li>
<li>
<p><strong>Heal Node</strong> starts healing of the node.(Update neighbour list and update return routes)</p>
<p><strong>Heal Node</strong> starts healing of the node.(Update neighbor list and update return routes)</p>
</li>
<li><strong>Test Node</strong> sends no_op test messages to the node. This could in theory bring back a dead node.</li>
</ul>
@ -165,7 +165,7 @@ Battery powered devices need to be awake before you can use the Z-Wave control p
<p>You can set the <em>wakeup</em> interval (in seconds) of the device, this is shown for all devices that can be battery powered, even if they are currently mains powered. The wakeup interval only applies when those devices are battery powered.</p>
<p>Underneath that you can select any supported configuration parameter to see the current setting. You can then change this and select <strong>Set Config Parameter</strong> to updated it. Battery powered devices will be updated the next time they wake.</p>
<h2><a class="title-link" name="node-user-codes" href="#node-user-codes"></a> Node user codes</h2>
<p>If your node has user codes, you can set and delete them. The format is raw hex Ascii code. Bellow the input you will see your actual code. For normal nodes this is as follows:</p>
<p>If your node has user codes, you can set and delete them. The format is raw hex Ascii code. Below the input you will see your actual code. For normal nodes this is as follows:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">\x30 = 0</span>
<span class="s">\x31 = 1</span>
<span class="s">\x32 = 2</span>

2
docs/z-wave/device-specific/index.html
View file

@ -85,7 +85,7 @@ These devices will either show as a binary sensor or a sensor called <code class
<p>Home Assistant stores logs from Z-Wave in <code class="highlighter-rouge">OZW_log.txt</code> in the Home Assistant config directory, when you pair a secure device you should see communication from the node with lines starting with <code class="highlighter-rouge">info: NONCES</code> in <code class="highlighter-rouge">OZW_log.txt</code> when the device is paired successfully with a secure connection.</p>
<h3><a class="title-link" name="specific-devices" href="#specific-devices"></a> Specific Devices</h3>
<h3><a class="title-link" name="aeotec-z-stick" href="#aeotec-z-stick"></a> Aeotec Z-Stick</h3>
<p>It’s totally normal for your Z-Wave stick to cycle through its LEDs (Yellow, Blue and Red) while plugged into your system. If you don’t like this behaviour it can be turned off.</p>
<p>It’s totally normal for your Z-Wave stick to cycle through its LEDs (Yellow, Blue and Red) while plugged into your system. If you don’t like this behavior it can be turned off.</p>
<p>Use the following example commands from a terminal session on your Pi where your Z-Wave stick is connected.</p>
<p>Turn off “Disco lights”:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span><span class="nb">echo</span> -e -n <span class="s2">"</span><span class="se">\x</span><span class="s2">01</span><span class="se">\x</span><span class="s2">08</span><span class="se">\x</span><span class="s2">00</span><span class="se">\x</span><span class="s2">F2</span><span class="se">\x</span><span class="s2">51</span><span class="se">\x</span><span class="s2">01</span><span class="se">\x</span><span class="s2">00</span><span class="se">\x</span><span class="s2">05</span><span class="se">\x</span><span class="s2">01</span><span class="se">\x</span><span class="s2">51"</span> &gt; /dev/serial/by-id/usb-0658_0200-if00

4
docs/z-wave/installation/index.html
View file

@ -85,7 +85,7 @@
</code></pre>
</div>
<p class="note">
The installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspbery Pi.
The installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi.
</p>
<h2><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h2>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
@ -228,7 +228,7 @@ The device type is <code class="highlighter-rouge">c</code> (character special)
</div>
<p>Ensure you keep a backup of this key. If you have to rebuild your system and don’t have a backup of this key, you won’t be able to reconnect to any security devices. This may mean you have to do a factory reset on those devices, and your controller, before rebuilding your Z-Wave network.</p>
<h2><a class="title-link" name="first-run" href="#first-run"></a> First Run</h2>
<p>The (compilation and) installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspbery Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.</p>
<p>The (compilation and) installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.</p>
<p>The first run after adding a device is when the <code class="highlighter-rouge">zwave</code> component will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process.</p>
<h2><a class="title-link" name="troubleshooting" href="#troubleshooting"></a> Troubleshooting</h2>
<h3><a class="title-link" name="component-could-not-be-set-up" href="#component-could-not-be-set-up"></a> Component could not be set up</h3>