460 lines
29 KiB
HTML
460 lines
29 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>Script Syntax - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<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">
|
|
<meta property="og:title" content="Script Syntax">
|
|
<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="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="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">
|
|
<link rel='shortcut icon' href='/images/favicon.ico' />
|
|
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
|
</head>
|
|
<body >
|
|
<header class='site-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>
|
|
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
|
</ul>
|
|
</nav>
|
|
<div class='search-container' style='display: none'>
|
|
<div class='search'>
|
|
<i class="icon-search"></i>
|
|
<input id='search' placeholder='Search the docs…'>
|
|
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
|
</div>
|
|
</div>
|
|
</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">
|
|
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/scripts.markdown'>Edit this page on GitHub</a></div>
|
|
<header>
|
|
<h1 class="title indent">
|
|
Script Syntax
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>Scripts are a sequence of actions that Home Assistant will execute. Scripts are available as an entity through the standalone <a href="/components/script/">Script component</a> but can also be embedded in <a href="/getting-started/automation-action/">automations</a> and <a href="/components/alexa/">Alexa/Amazon Echo</a> configurations.</p>
|
|
<p>The script syntax basic structure is a list of key/value maps that contain actions. If a script contains only 1 action, the wrapping list can be omitted.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example script component containing script syntax</span>
|
|
<span class="s">script</span><span class="pi">:</span>
|
|
<span class="s">example_script</span><span class="pi">:</span>
|
|
<span class="s">sequence</span><span class="pi">:</span>
|
|
<span class="c1"># This is written using the Script Syntax</span>
|
|
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
|
|
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.ceiling</span>
|
|
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">notify.notify</span>
|
|
<span class="s">data</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Turned</span><span class="nv"> </span><span class="s">on</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">ceiling</span><span class="nv"> </span><span class="s">light!'</span>
|
|
</code></pre>
|
|
</div>
|
|
<h3><a class="title-link" name="call-a-service" href="#call-a-service"></a> Call a Service</h3>
|
|
<p>The most important one is the action to call a service. This can be done in various ways. For all the different possibilities, have a look at the <a href="/getting-started/scripts-service-calls/">service calls page</a>.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">alias</span><span class="pi">:</span> <span class="s">Bedroom lights on</span>
|
|
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
|
|
<span class="s">data</span><span class="pi">:</span>
|
|
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">group.bedroom</span>
|
|
<span class="s">brightness</span><span class="pi">:</span> <span class="s">100</span>
|
|
</code></pre>
|
|
</div>
|
|
<h3><a class="title-link" name="test-a-condition" href="#test-a-condition"></a> Test a Condition</h3>
|
|
<p>While executing a script you can add a condition to stop further execution. When a condition does not return <code class="highlighter-rouge">true</code>, the script will finish. There are many different conditions which are documented at the <a href="/getting-started/scripts-conditions/">conditions page</a>.</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="s1">'</span><span class="s">home'</span>
|
|
</code></pre>
|
|
</div>
|
|
<h3><a class="title-link" name="delay" href="#delay"></a> Delay</h3>
|
|
<p>Delays are useful for temporarily suspending your script and start it at a later moment. We support different syntaxes for a delay as shown below.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Waits 1 hour</span>
|
|
<span class="s">delay</span><span class="pi">:</span> <span class="s">01:00</span>
|
|
</code></pre>
|
|
</div>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Waits 1 minute, 30 seconds</span>
|
|
<span class="s">delay</span><span class="pi">:</span> <span class="s">00:01:30</span>
|
|
</code></pre>
|
|
</div>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Waits 1 minute</span>
|
|
<span class="s">delay</span><span class="pi">:</span>
|
|
<span class="c1"># supports milliseconds, seconds, minutes, hours, days</span>
|
|
<span class="s">minutes</span><span class="pi">:</span> <span class="s">1</span>
|
|
</code></pre>
|
|
</div>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Waits however many minutes input_number.minute_delay is set to</span>
|
|
<span class="c1"># Valid formats include HH:MM and HH:MM:SS</span>
|
|
<span class="s">delay</span><span class="pi">:</span> <span class="s1">'</span><span class="s">00:{{</span><span class="nv"> </span><span class="s">states.input_number.minute_delay.state</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">int</span><span class="nv"> </span><span class="s">}}:00'</span>
|
|
</code></pre>
|
|
</div>
|
|
<h3><a class="title-link" name="wait" href="#wait"></a> Wait</h3>
|
|
<p>Wait until some things are complete. We support at the moment <code class="highlighter-rouge">wait_template</code> for waiting until a condition is <code class="highlighter-rouge">true</code>, see also on <a href="/docs/automation/trigger/#template-trigger">Template-Trigger</a>. It is possible to set a timeout after which the script will abort its execution if the condition is not satisfied. Timeout has the same syntax as <code class="highlighter-rouge">delay</code>.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># wait until media player have stop the playing</span>
|
|
<span class="s">wait_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.media_player.floor.state</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="s">'stop'</span><span class="nv"> </span><span class="s">}}"</span>
|
|
</code></pre>
|
|
</div>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># wait until a valve is < 10 or abort after 1 minutes.</span>
|
|
<span class="s">wait_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.climate.kitchen.attributes.valve</span><span class="nv"> </span><span class="s"><</span><span class="nv"> </span><span class="s">10</span><span class="nv"> </span><span class="s">}}"</span>
|
|
<span class="s">timeout</span><span class="pi">:</span> <span class="s">00:01:00</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>When using <code class="highlighter-rouge">wait_template</code> within an automation <code class="highlighter-rouge">trigger.entity_id</code> is supported for <code class="highlighter-rouge">state</code>, <code class="highlighter-rouge">numeric_state</code> and <code class="highlighter-rouge">template</code> triggers, see also <a href="/docs/automation/templating/#available-trigger-data">Available-Trigger-Data</a>.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">wait_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">is_state(trigger.entity_id,</span><span class="nv"> </span><span class="s">'on')</span><span class="nv"> </span><span class="s">}}"</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>It is also possible to use dummy variables, e.g., in scripts, when using <code class="highlighter-rouge">wait_template</code>.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Service call, e.g. from an automation.</span>
|
|
<span class="s">service</span><span class="pi">:</span> <span class="s">script.do_something</span>
|
|
<span class="s">data_template</span><span class="pi">:</span>
|
|
<span class="s">dummy</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">input_boolean.switch</span><span class="nv"> </span><span class="s">}}"</span>
|
|
|
|
<span class="c1"># Inside the script</span>
|
|
<span class="s">wait_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">is_state(dummy,</span><span class="nv"> </span><span class="s">'off')</span><span class="nv"> </span><span class="s">}}"</span>
|
|
</code></pre>
|
|
</div>
|
|
<h3><a class="title-link" name="fire-an-event" href="#fire-an-event"></a> Fire an Event</h3>
|
|
<p>This action allows you to fire an event. Events can be used for many things. It could trigger an automation or indicate to another component that something is happening. For instance, in the below example it is used to create an entry in the logbook.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">event</span><span class="pi">:</span> <span class="s">LOGBOOK_ENTRY</span>
|
|
<span class="s">event_data</span><span class="pi">:</span>
|
|
<span class="s">name</span><span class="pi">:</span> <span class="s">Paulus</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="s">is waking up</span>
|
|
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">device_tracker.paulus</span>
|
|
<span class="s">domain</span><span class="pi">:</span> <span class="s">light</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>You can also use event_data_template to fire an event with custom data. This could be used to pass data to another script awaiting
|
|
an event trigger.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">event</span><span class="pi">:</span> <span class="s">MY_EVENT</span>
|
|
<span class="s">event_data_template</span><span class="pi">:</span>
|
|
<span class="s">name</span><span class="pi">:</span> <span class="s">myEvent</span>
|
|
<span class="s">customData</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">myCustomVariable</span><span class="nv"> </span><span class="s">}}"</span>
|
|
</code></pre>
|
|
</div>
|
|
<h3><a class="title-link" name="raise-and-consume-custom-events" href="#raise-and-consume-custom-events"></a> Raise and Consume Custom Events</h3>
|
|
<p>The following automation shows how to raise a custom event called <code class="highlighter-rouge">event_light_state_changed</code> with <code class="highlighter-rouge">entity_id</code> as the event data. The action part could be inside a script or an automation.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Fire Event</span>
|
|
<span class="s">trigger</span><span class="pi">:</span>
|
|
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
|
|
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.kitchen</span>
|
|
<span class="s">to</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
|
|
<span class="s">action</span><span class="pi">:</span>
|
|
<span class="s">event</span><span class="pi">:</span> <span class="s">event_light_state_changed</span>
|
|
<span class="s">event_data</span><span class="pi">:</span>
|
|
<span class="s">state</span><span class="pi">:</span> <span class="s2">"</span><span class="s">on"</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>The following automation shows how to capture the custom event <code class="highlighter-rouge">event_light_state_changed</code>, and retrieve corresponding <code class="highlighter-rouge">entity_id</code> that was passed as the event data.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Capture Event</span>
|
|
<span class="s">trigger</span><span class="pi">:</span>
|
|
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
|
|
<span class="s">event_type</span><span class="pi">:</span> <span class="s">event_light_state_changed</span>
|
|
<span class="s">action</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">notify.notify</span>
|
|
<span class="s">data_template</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="s2">"</span><span class="s">kitchen</span><span class="nv"> </span><span class="s">light</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">turned</span><span class="nv"> </span><span class="s">{{</span><span class="nv"> </span><span class="s">trigger.event.data.state</span><span class="nv"> </span><span class="s">}}"</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='section'>
|
|
<h1 class="title delta">Topics</h1>
|
|
<ul class='divided sidebar-menu'>
|
|
<li>
|
|
<b><a href='/faq/'>FAQ </a></b> |
|
|
<b><a href='/docs/glossary/'>Glossary </a></b>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/installation/'>Installation </a></b>
|
|
<ul>
|
|
<li><a href='/hassio/'>Hass.io </a></li>
|
|
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
|
<li><a href='/docs/installation/hassbian/'>Hassbian </a></li>
|
|
<!--<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberry Pi All-in-One </a></li>-->
|
|
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
|
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/configuration/'>Configuration </a></b>
|
|
<ul>
|
|
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
|
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
|
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
|
<li><a href='/docs/configuration/entity-registry/'>Entity Registry </a></li>
|
|
<li><a href='/docs/configuration/customizing-devices/'>Customizing entities </a></li>
|
|
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
|
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b>Advanced Configuration</b>
|
|
<ul>
|
|
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
|
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
|
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
|
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
|
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
|
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
|
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b>Core objects</b>
|
|
<ul>
|
|
<li><a href='/docs/configuration/events/'>Events </a></li>
|
|
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/automation/'>Automation </a></b>
|
|
<ul>
|
|
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
|
<li><a href='/docs/automation/editor/'>Editor </a></li>
|
|
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
|
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
|
<li><a href='/docs/automation/action/'>Actions </a></li>
|
|
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/frontend/'>Frontend </a></b>
|
|
<ul>
|
|
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
|
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
|
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/backend/'>Backend </a></b>
|
|
<ul>
|
|
<li><a href='/docs/backend/database/'>Database </a></li>
|
|
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
|
<li><a href='/developers/api/'>API </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a class='active' href='/docs/scripts/'>Scripts </a></b>
|
|
<ul>
|
|
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
|
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
|
<li><a href='/docs/scripts/editor/'>Editor </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/tools/'>Tools and Helpers </a></b>
|
|
<ul>
|
|
<li><a href='/docs/tools/dev-tools/'>Developer Tools </a></li>
|
|
<li><a href='/docs/tools/hass/'>hass </a></li>
|
|
<li><a href='/docs/tools/benchmark/'>benchmark </a></li>
|
|
<li><a href='/docs/tools/check_config/'>check_config </a></li>
|
|
<li><a href='/docs/tools/credstash/'>credstash </a></li>
|
|
<li><a href='/docs/tools/db_migrator/'>db_migrator </a></li>
|
|
<li><a href='/docs/tools/ensure_config/'>ensure_config </a></li>
|
|
<li><a href='/docs/tools/influxdb_import/'>influxdb_import </a></li>
|
|
<li><a href='/docs/tools/influxdb_migrator/'>influxdb_migrator </a></li>
|
|
<li><a href='/docs/tools/keyring/'>keyring </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/z-wave/'>Z-Wave </a></b>
|
|
<ul>
|
|
<li><a href='/docs/z-wave/installation/'>Configuring the Z-Wave component </a></li>
|
|
<li><a href='/docs/z-wave/adding/'>Adding devices </a></li>
|
|
<li><a href='/docs/z-wave/control-panel/'>The Z-Wave control panel </a></li>
|
|
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
|
<li><a href='/docs/z-wave/devices/'>Devices </a> and <a href='/docs/z-wave/entities/'>Entities </a></li>
|
|
<li><a href='/docs/z-wave/query-stage/'>Query Stages </a> for devices</li>
|
|
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a> configuration</li>
|
|
<li><a href='/docs/z-wave/events/'>Events </a> and <a href='/docs/z-wave/services/'>Services </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/mqtt/'>MQTT </a></b>
|
|
<ul>
|
|
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
|
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
|
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
|
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
|
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
|
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
|
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
|
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b><a href='/docs/ecosystem/ios/'>iOS </a></b>
|
|
<ul>
|
|
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
|
<ul>
|
|
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
|
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
|
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
|
</ul>
|
|
<li>Advanced notifications</li>
|
|
<ul>
|
|
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
|
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
|
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
|
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
|
</ul>
|
|
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
|
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href='/docs/ecosystem/'>Ecosystem </a>
|
|
<ul>
|
|
<li>
|
|
<a href='/docs/autostart/'>Autostart </a>
|
|
<ul>
|
|
<li><a href='/docs/autostart/systemd/'>systemd (Linux) </a></li>
|
|
<li><a href='/docs/autostart/upstart/'>Upstart (Linux) </a></li>
|
|
<li><a href='/docs/autostart/init.d/'>init.d (Linux) </a></li>
|
|
<li><a href='/docs/autostart/macos/'>macOS </a></li>
|
|
<li><a href='/docs/autostart/synology/'>Synology NAS </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
|
</li>
|
|
<li>
|
|
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
|
</li>
|
|
<li>
|
|
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
|
<ul>
|
|
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
|
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
|
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
|
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
|
<li><a href='/docs/ecosystem/notebooks/database/'>Database </a></li>
|
|
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
Remote access
|
|
<ul>
|
|
<li><a href='/docs/ecosystem/apache/'>Apache </a></li>
|
|
<li><a href='/docs/ecosystem/caddy/'>Caddy Server </a></li>
|
|
<li><a href='/docs/ecosystem/nginx/'>NGINX </a></li>
|
|
<li><a href='/docs/ecosystem/nginx_subdomain/'>NGINX with subdomain</a></li>
|
|
<li><a href='/docs/ecosystem/tor/'>Tor Onion Service </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href='/docs/ecosystem/certificates/'>Certificates </a>
|
|
<ul>
|
|
<li><a href='/docs/ecosystem/certificates/tls_self_signed_certificate/'>Self-signed certificate </a></li>
|
|
<li><a href='/docs/ecosystem/certificates/tls_domain_certificate/'>Certificate domain owners </a></li>
|
|
<li><a href='/docs/ecosystem/certificates/lets_encrypt/'>Let's Encrypt (detailed) </a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
Backup
|
|
<ul>
|
|
<li><a href='/docs/ecosystem/backup/backup_github/'>Backup to GitHub </a></li>
|
|
<li><a href='/docs/ecosystem/backup/backup_dropbox/'>Backup to Dropbox </a></li>
|
|
<li><a href='/docs/ecosystem/backup/backup_usb/'>Backup to USB device </a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href='/docs/ecosystem/scenegen/'>scenegen </a></li>
|
|
<li><a href='/docs/ecosystem/synology/'>Synology </a></li>
|
|
<li><a href='/docs/ecosystem/hass-configurator/'>HASS Configurator </a></li>
|
|
</ul>
|
|
</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> (no support!).<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>
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
|
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
|
<script type="text/javascript">
|
|
docsearch({
|
|
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
|
indexName: 'home-assistant',
|
|
inputSelector: '#search',
|
|
debug: false // Set debug to true if you want to inspect the dropdown
|
|
});
|
|
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'none';
|
|
});
|
|
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'block';
|
|
document.getElementById('toggle').checked = false;
|
|
document.querySelector('.search-container input').focus();
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|