Site updated at 2016-08-22 08:21:42 UTC
This commit is contained in:
Travis CI
parent
f9d65cbe57
commit
4acb07bf8e
559 changed files with 18878 additions and 21688 deletions
|
|
@ -93,62 +93,58 @@
|
|||
|
||||
<p>The sequence of actions is specified using the <a href="/getting-started/scripts/">Home Assistant Script Syntax</a>.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
||||
<span class="key">script</span>:
|
||||
<span class="key">message_temperature</span>:
|
||||
<span class="key">sequence</span>:
|
||||
<span class="comment"># This is Home Assistant Script Syntax</span>
|
||||
- <span class="string"><span class="content">service: notify.notify</span></span>
|
||||
<span class="key">data_template</span>:
|
||||
<span class="key">message</span>: <span class="string"><span class="content">Current temperature is {{ states.sensor.temperature.state }}</span></span>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||||
<span class="s">script</span><span class="pi">:</span>
|
||||
<span class="s">message_temperature</span><span class="pi">:</span>
|
||||
<span class="s">sequence</span><span class="pi">:</span>
|
||||
<span class="c1"># This is Home Assistant Script Syntax</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="s">Current temperature is {{ states.sensor.temperature.state }}</span>
|
||||
|
||||
<span class="comment"># Turns on the bedroom lights and then the living room lights 1 minute later</span>
|
||||
<span class="key">wakeup</span>:
|
||||
<span class="key">alias</span>: <span class="string"><span class="content">Wake Up</span></span>
|
||||
<span class="key">sequence</span>:
|
||||
<span class="comment"># This is Home Assistant Script Syntax</span>
|
||||
- <span class="string"><span class="content">event: LOGBOOK_ENTRY</span></span>
|
||||
<span class="key">event_data</span>:
|
||||
<span class="key">name</span>: <span class="string"><span class="content">Paulus</span></span>
|
||||
<span class="key">message</span>: <span class="string"><span class="content">is waking up</span></span>
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">device_tracker.paulus</span></span>
|
||||
<span class="key">domain</span>: <span class="string"><span class="content">light</span></span>
|
||||
- <span class="string"><span class="content">alias: Bedroom lights on</span></span>
|
||||
<span class="key">service</span>: <span class="string"><span class="content">light.turn_on</span></span>
|
||||
<span class="key">data</span>:
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">group.bedroom</span></span>
|
||||
<span class="key">brightness</span>: <span class="string"><span class="content">100</span></span>
|
||||
- <span class="string"><span class="content">delay:</span><span class="content">
|
||||
# supports seconds, milliseconds, minutes, hours
|
||||
minutes: 1</span></span>
|
||||
- <span class="string"><span class="content">alias: Living room lights on</span></span>
|
||||
<span class="key">service</span>: <span class="string"><span class="content">light.turn_on</span></span>
|
||||
<span class="key">data</span>:
|
||||
<span class="key">entity_id</span>: <span class="string"><span class="content">group.living_room</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<span class="c1"># Turns on the bedroom lights and then the living room lights 1 minute later</span>
|
||||
<span class="s">wakeup</span><span class="pi">:</span>
|
||||
<span class="s">alias</span><span class="pi">:</span> <span class="s">Wake Up</span>
|
||||
<span class="s">sequence</span><span class="pi">:</span>
|
||||
<span class="c1"># This is Home Assistant Script Syntax</span>
|
||||
<span class="pi">-</span> <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>
|
||||
<span class="pi">-</span> <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>
|
||||
<span class="pi">-</span> <span class="s">delay</span><span class="pi">:</span>
|
||||
<span class="c1"># supports seconds, milliseconds, minutes, hours</span>
|
||||
<span class="s">minutes</span><span class="pi">:</span> <span class="s">1</span>
|
||||
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Living room 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.living_room</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="passing-parameters-in-service-calls" href="#passing-parameters-in-service-calls"></a> Passing parameters in service calls</h3>
|
||||
|
||||
<p>As part of the service, parameters can be passed in that will be made available to the script as variables within templates.</p>
|
||||
|
||||
<p>There are two ways to activate scripts. One is using the generic <code>script.turn_on</code> service. To pass variables to the script with this service, call it using the following parameters:</p>
|
||||
<p>There are two ways to activate scripts. One is using the generic <code class="highlighter-rouge">script.turn_on</code> service. To pass variables to the script with this service, call it using the following parameters:</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre>{
|
||||
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">script.wakeup</span><span class="delimiter">"</span></span><span class="string"><span class="content">,</span></span>
|
||||
<span class="key"><span class="delimiter">"</span><span class="content">variables</span><span class="delimiter">"</span></span>: <span class="string"><span class="content">{</span><span class="content">
|
||||
"hello": "world",
|
||||
"name": "Paulus"</span></span>
|
||||
}
|
||||
}
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">{</span>
|
||||
<span class="s2">"</span><span class="s">entity_id"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">script.wakeup"</span><span class="pi">,</span>
|
||||
<span class="s2">"</span><span class="s">variables"</span><span class="pi">:</span> <span class="pi">{</span>
|
||||
<span class="s2">"</span><span class="s">hello"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">world"</span><span class="pi">,</span>
|
||||
<span class="s2">"</span><span class="s">name"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Paulus"</span>
|
||||
<span class="pi">}</span>
|
||||
<span class="pi">}</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>If you are calling the script service directly, for example <code>script.wakeup</code>. All service data will be made available as variables.</p>
|
||||
<p>If you are calling the script service directly, for example <code class="highlighter-rouge">script.wakeup</code>. All service data will be made available as variables.</p>
|
||||
|
||||
|
||||
</article>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue