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
|
|
@ -91,60 +91,54 @@
|
|||
|
||||
<p>Home Assistant uses the <a href="http://yaml.org/">YAML</a> syntax for configuration. YAML might take a while to get used to but is really powerful in allowing you to express complex configurations.</p>
|
||||
|
||||
<p>For each component that you want to use in Home Assistant, you add code in your <code>configuraton.yaml</code> file to specify its settings.<br />
|
||||
<p>For each component that you want to use in Home Assistant, you add code in your <code class="highlighter-rouge">configuraton.yaml</code> file to specify its settings.
|
||||
The following example entry specifies that you want to use the <a href="/components/notify">notify component</a> with the <a href="/components/notify.pushbullet">pushbullet platform</a>.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">notify</span>:
|
||||
<span class="key">platform</span>: <span class="string"><span class="content">pushbullet</span></span>
|
||||
<span class="key">api_key</span>: <span class="string"><span class="delimiter">"</span><span class="content">o.1234abcd</span><span class="delimiter">"</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">pushbullet</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">notify</span><span class="pi">:</span>
|
||||
<span class="s">platform</span><span class="pi">:</span> <span class="s">pushbullet</span>
|
||||
<span class="s">api_key</span><span class="pi">:</span> <span class="s2">"</span><span class="s">o.1234abcd"</span>
|
||||
<span class="s">name</span><span class="pi">:</span> <span class="s">pushbullet</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
<li>A <strong>component</strong> provides the core logic for some functionality (like <code>notify</code> provides sending notifications).</li>
|
||||
<li>A <strong>platform</strong> makes the connection to a specific software or hardware platform (like <code>pushbullet</code> works with the service from pushbullet.com).</li>
|
||||
<li>A <strong>component</strong> provides the core logic for some functionality (like <code class="highlighter-rouge">notify</code> provides sending notifications).</li>
|
||||
<li>A <strong>platform</strong> makes the connection to a specific software or hardware platform (like <code class="highlighter-rouge">pushbullet</code> works with the service from pushbullet.com).</li>
|
||||
</ul>
|
||||
|
||||
<p>The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a <code>-</code> while mappings have the format <code>key: value</code>. If you specify duplicate keys, the last value for a key is used.</p>
|
||||
<p>The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a <code class="highlighter-rouge">-</code> while mappings have the format <code class="highlighter-rouge">key: value</code>. If you specify duplicate keys, the last value for a key is used.</p>
|
||||
|
||||
<p>Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested “inside” things that are one level higher. So in the above example, <code>platform: pushbullet</code> is a property of (nested inside) the <code>notify</code> component.<br />
|
||||
Getting the right indentation can be tricky if you’re not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.<br />
|
||||
You can use <a href="http://www.yamllint.com/">YAMLLint</a> to check if your YAML-syntax is correct before loading it into Home Assistant which will save you some time. <br />
|
||||
<p>Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested “inside” things that are one level higher. So in the above example, <code class="highlighter-rouge">platform: pushbullet</code> is a property of (nested inside) the <code class="highlighter-rouge">notify</code> component.
|
||||
Getting the right indentation can be tricky if you’re not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.
|
||||
You can use <a href="http://www.yamllint.com/">YAMLLint</a> to check if your YAML-syntax is correct before loading it into Home Assistant which will save you some time.
|
||||
<em>Please pay attention on not putting in private data, as it is a 3rd-party website not maintained by Home Assistant.</em></p>
|
||||
|
||||
<p>Lines that start with <strong>#</strong> are comments and are ignored by the system.</p>
|
||||
|
||||
<p>The next example shows an <a href="/components/input_select">input_select</a> component that uses a block collection for the options values.<br />
|
||||
The other properties (like name) are specified using mappings. Note that the second line just has <code>threat:</code> with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it.</p>
|
||||
<p>The next example shows an <a href="/components/input_select">input_select</a> component that uses a block collection for the options values.
|
||||
The other properties (like name) are specified using mappings. Note that the second line just has <code class="highlighter-rouge">threat:</code> with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it.</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">input_select</span>:
|
||||
<span class="key">threat</span>:
|
||||
<span class="key">name</span>: <span class="string"><span class="content">Threat level</span></span>
|
||||
<span class="comment"># A collection is used for options</span>
|
||||
<span class="key">options</span>:
|
||||
- <span class="string"><span class="content">0</span></span>
|
||||
- <span class="string"><span class="content">1</span></span>
|
||||
- <span class="string"><span class="content">2</span></span>
|
||||
- <span class="string"><span class="content">3</span></span>
|
||||
<span class="key">initial</span>: <span class="string"><span class="content">0</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">input_select</span><span class="pi">:</span>
|
||||
<span class="s">threat</span><span class="pi">:</span>
|
||||
<span class="s">name</span><span class="pi">:</span> <span class="s">Threat level</span>
|
||||
<span class="c1"># A collection is used for options</span>
|
||||
<span class="s">options</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">0</span>
|
||||
<span class="pi">-</span> <span class="s">1</span>
|
||||
<span class="pi">-</span> <span class="s">2</span>
|
||||
<span class="pi">-</span> <span class="s">3</span>
|
||||
<span class="s">initial</span><span class="pi">:</span> <span class="s">0</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>The following example shows nesting a collection of mappings in a mapping. In Home Assistant, this would create two sensors that each use the MQTT platform but have different values for their <code>state_topic</code> (one of the properties used for MQTT sensors).</p>
|
||||
<p>The following example shows nesting a collection of mappings in a mapping. In Home Assistant, this would create two sensors that each use the MQTT platform but have different values for their <code class="highlighter-rouge">state_topic</code> (one of the properties used for MQTT sensors).</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="key">sensor</span>:
|
||||
- <span class="string"><span class="content">platform: mqtt</span></span>
|
||||
<span class="key">state_topic</span>: <span class="string"><span class="content">sensor/topic</span></span>
|
||||
- <span class="string"><span class="content">platform: mqtt</span></span>
|
||||
<span class="key">state_topic</span>: <span class="string"><span class="content">sensor2/topic</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<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">mqtt</span>
|
||||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s">sensor/topic</span>
|
||||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
|
||||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s">sensor2/topic</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a href="/getting-started/basic/">Next step: Setting up the basics »</a></h3>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue