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

2
components/binary_sensor.bbb_gpio/index.html
View file

@ -93,7 +93,7 @@
<li><strong>pin_name</strong> (<em>Required</em>): Pin numbers and corresponding names.
<ul>
<li><strong>name</strong> (<em>Required</em>): Friendly name to use for the frontend.</li>
<li><strong>bouncetime</strong> (<em>Optional</em>): Debounce time for reading input pin defined in miliseconds [ms]. Defaults to <code class="highlighter-rouge">50 ms</code>.</li>
<li><strong>bouncetime</strong> (<em>Optional</em>): Debounce time for reading input pin defined in milliseconds [ms]. Defaults to <code class="highlighter-rouge">50 ms</code>.</li>
<li><strong>invert_logic</strong> (<em>Optional</em>): If <code class="highlighter-rouge">true</code>, inverts the input logic to ACTIVE LOW. Default is <code class="highlighter-rouge">false</code> (ACTIVE HIGH).</li>
<li><strong>pull_mode</strong> (<em>Optional</em>): Type of internal pull resistor connected to input. Options are <code class="highlighter-rouge">UP</code> - pull-up resistor and <code class="highlighter-rouge">DOWN</code> - pull-down resistor. Defaults to <code class="highlighter-rouge">UP</code>.</li>
</ul>

2
components/binary_sensor.xiaomi_aqara/index.html
View file

@ -157,7 +157,7 @@
<td>Button (1st gen)</td>
<td>switch</td>
<td>WXKG01LM</td>
<td>on (thru long_click_press), off</td>
<td>on (through long_click_press), off</td>
<td><code class="highlighter-rouge">click</code></td>
<td><code class="highlighter-rouge">click_type</code></td>
<td><code class="highlighter-rouge">long_click_press</code>, <code class="highlighter-rouge">long_click_release</code>, <code class="highlighter-rouge">hold</code>, <code class="highlighter-rouge">single</code>, <code class="highlighter-rouge">double</code></td>

2
components/binary_sensor.zigbee/index.html
View file

@ -74,7 +74,7 @@
</h1>
</header>
<hr class="divider">
<p>A <code class="highlighter-rouge">zigbee</code> binary sensor in this context is a device connected to one of the digital input pins on a <a href="http://www.zigbee.org/">ZigBee</a> module. The states reported by such a device are limited to <code class="highlighter-rouge">on</code> or <code class="highlighter-rouge">off</code>. By default, a binary sensor is considered <code class="highlighter-rouge">on</code> when the ZigBee device’s digital input pin is held ‘high’ and considered <code class="highlighter-rouge">off</code> when it is held <code class="highlighter-rouge">low</code>. This behaviour can be inverted by setting the <code class="highlighter-rouge">on_state</code> configuration variable to <code class="highlighter-rouge">low</code>.</p>
<p>A <code class="highlighter-rouge">zigbee</code> binary sensor in this context is a device connected to one of the digital input pins on a <a href="http://www.zigbee.org/">ZigBee</a> module. The states reported by such a device are limited to <code class="highlighter-rouge">on</code> or <code class="highlighter-rouge">off</code>. By default, a binary sensor is considered <code class="highlighter-rouge">on</code> when the ZigBee device’s digital input pin is held ‘high’ and considered <code class="highlighter-rouge">off</code> when it is held <code class="highlighter-rouge">low</code>. This behavior can be inverted by setting the <code class="highlighter-rouge">on_state</code> configuration variable to <code class="highlighter-rouge">low</code>.</p>
<p>To enable a digital input pin as binary sensor in your installation, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">binary_sensor</span><span class="pi">:</span>

2
components/climate.ecobee/index.html
View file

@ -419,7 +419,7 @@ For ‘temp’, the current temperature is taken as the target temperature.
When None is provided as parameter, the hold_mode is turned off.
It is not possible to set a vacation hold; such hold has to be
defined on the thermostat directly. However, a vacation hold can be
cancelled.</p>
canceled.</p>
<table>
<thead>
<tr>

4
components/device_tracker.bluetooth_le_tracker/index.html
View file

@ -86,7 +86,7 @@ We have received <a href="https://github.com/home-assistant/home-assistant/issue
<p>Before you get started with this platform, please note that:</p>
<ul>
<li>This platform is incompatible with Windows</li>
<li>This platform requires access to the bluetooth stack, see <a href="#rootless-setup">Rootless Setup section</a> for further infomation</li>
<li>This platform requires access to the bluetooth stack, see <a href="#rootless-setup">Rootless Setup section</a> for further information</li>
</ul>
<p>To use the Bluetooth tracker in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
@ -104,7 +104,7 @@ We have received <a href="https://github.com/home-assistant/home-assistant/issue
<p>As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times.
Some BTLE devices (e.g. fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won’t see this device.</p>
<h2><a class="title-link" name="rootless-setup" href="#rootless-setup"></a> Rootless Setup</h2>
<p>Normaly accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see <a href="http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root">Stack Exchange</a> for more information).</p>
<p>Normally accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see <a href="http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root">Stack Exchange</a> for more information).</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get install libcap2-bin
<span class="gp">$ </span>sudo setcap <span class="s1">'cap_net_raw,cap_net_admin+eip'</span> <span class="sb">`</span>readlink -f <span class="se">\`</span>which python3<span class="se">\`</span><span class="sb">`</span>
</code></pre>

6
components/device_tracker.gpslogger/index.html
View file

@ -121,15 +121,15 @@
<li>Use the domain that Home Assistant is available on the internet or the public IP address. Can be a local IP address if you are using a VPN setup.</li>
<li>Only remove <code class="highlighter-rouge">[Port]</code> if your Home Assistant instance is using port 80. Otherwise set it to 8123.</li>
<li>For Home Assistant only the above URL, as written, will work - do not add or remove any parameters.</li>
<li>Make sure to include your <a href="/components/http/">API password</a> if you have configured a password. Add <code class="highlighter-rouge">&amp;api_password=[Your pasword]</code> to the end of the URL.</li>
<li>Make sure to include your <a href="/components/http/">API password</a> if you have configured a password. Add <code class="highlighter-rouge">&amp;api_password=[Your password]</code> to the end of the URL.</li>
<li>You can change the name of your device name by replacing <code class="highlighter-rouge">&amp;device=%SER</code> with <code class="highlighter-rouge">&amp;device=[Devicename]</code>.</li>
</ul>
<p>If your battery drains fast then you can tune the performence of GPSLogger under <strong>Performance</strong> -&gt; <strong>Location providers</strong></p>
<p>If your battery drains fast then you can tune the performance of GPSLogger under <strong>Performance</strong> -&gt; <strong>Location providers</strong></p>
<p class="img">
<img width="300" src="/images/components/gpslogger/performance.png" />
Performance
</p>
<p>A request can be forced from the app to test if everything is working fine. A succesful request will update the <code class="highlighter-rouge">known_devices.yaml</code> file with the device’s serial number.</p>
<p>A request can be forced from the app to test if everything is working fine. A successful request will update the <code class="highlighter-rouge">known_devices.yaml</code> file with the device’s serial number.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

2
components/fan.xiaomi_miio/index.html
View file

@ -74,7 +74,7 @@
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">xiaomi_miio</code> fan platform allows you to control the Xiaomi Air Purifier 2, Air Purifier 2S andd Air Purifier Pro.</p>
<p>The <code class="highlighter-rouge">xiaomi_miio</code> fan platform allows you to control the Xiaomi Air Purifier 2, Air Purifier 2S and Air Purifier Pro.</p>
<p>Currently, the supported features are</p>
<ul>
<li>On, Off</li>

4
components/frontend/index.html
View file

@ -109,11 +109,11 @@
</dd>
<dt><a class="title-link" name="extra_html_url" href="#extra_html_url"></a> extra_html_url</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Optional)</span><span class="description">List of addtional <a href="/developers/frontend_creating_custom_ui/">resources</a> to load in <code class="highlighter-rouge">latest</code> javascript mode.</span></p>
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Optional)</span><span class="description">List of additional <a href="/developers/frontend_creating_custom_ui/">resources</a> to load in <code class="highlighter-rouge">latest</code> javascript mode.</span></p>
</dd>
<dt><a class="title-link" name="extra_html_url_es5" href="#extra_html_url_es5"></a> extra_html_url_es5</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Optional)</span><span class="description">List of addtional <a href="/developers/frontend_creating_custom_ui/">resources</a> to load in <code class="highlighter-rouge">es5</code> javascript mode.</span></p>
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Optional)</span><span class="description">List of additional <a href="/developers/frontend_creating_custom_ui/">resources</a> to load in <code class="highlighter-rouge">es5</code> javascript mode.</span></p>
</dd>
<dt><a class="title-link" name="development_repo" href="#development_repo"></a> development_repo</dt>
<dd>

2
components/group/index.html
View file

@ -169,7 +169,7 @@ Notice in the example below that in order to refer to the group “Living Room
<span class="pi">-</span> <span class="s">group.all_scripts</span>
</code></pre>
</div>
<h2><a class="title-link" name="group-behaviour" href="#group-behaviour"></a> Group behaviour</h2>
<h2><a class="title-link" name="group-behavior" href="#group-behavior"></a> Group behavior</h2>
<p>When any member of a group is <code class="highlighter-rouge">on</code> then the group will also be <code class="highlighter-rouge">on</code>. Similarly with a device tracker, when any member of the group is <code class="highlighter-rouge">home</code> then the group is <code class="highlighter-rouge">home</code>.</p>
<h2><a class="title-link" name="customize-group-order" href="#customize-group-order"></a> Customize group order</h2>
<p>You can also order your groups using <a href="/docs/configuration/customizing-devices/">customize</a> with <code class="highlighter-rouge">order: </code> if they don’t show up in the order you want them in.</p>

2
components/hive/index.html
View file

@ -106,7 +106,7 @@
<li>Hive Active Heating (including hot water and Hive Multizone)</li>
<li>Hive Active Light Dimmable</li>
<li>Hive Active Light Cool to Warm White</li>
<li>Hive Active Light Colour Changing</li>
<li>Hive Active Light Color Changing</li>
<li>Hive Active Plug</li>
<li>Hive Window or Door Sensor</li>
<li>Hive Motion Sensor</li>

2
components/image_processing/index.html
View file

@ -81,7 +81,7 @@ If you are running Home Assistant over SSL or from within a container, you will
</p>
<h2><a class="title-link" name="alpr" href="#alpr"></a> ALPR</h2>
<p>Alpr entities attribute have a vehicle counter <code class="highlighter-rouge">vehicles</code> and all found plates as <code class="highlighter-rouge">plates</code>.</p>
<p>This event is trigger after OpenALPR found a new licence plate.</p>
<p>This event is trigger after OpenALPR found a new license plate.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml automation entry</span>
<span class="s">automation</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Open garage door</span>

2
components/input_datetime/index.html
View file

@ -144,7 +144,7 @@
</tr>
<tr>
<td><code class="highlighter-rouge">year</code><br /><code class="highlighter-rouge">month</code><br /><code class="highlighter-rouge">day</code></td>
<td>The year, month and day of the date.<br />(only availabel if <code class="highlighter-rouge">has_date: true</code>)</td>
<td>The year, month and day of the date.<br />(only available if <code class="highlighter-rouge">has_date: true</code>)</td>
</tr>
<tr>
<td><code class="highlighter-rouge">hour</code><br /><code class="highlighter-rouge">minute</code><br /><code class="highlighter-rouge">second</code></td>

2
components/input_number/index.html
View file

@ -111,7 +111,7 @@ Before version 0.55 this component was known as <code class="highlighter-rouge">
</dd>
<dt><a class="title-link" name="max" href="#max"></a> max</dt>
<dd>
<p class="desc"><span class="type">(<span class="float">float</span>)</span><span class="required">(Required)</span><span class="description">Maxium value.</span></p>
<p class="desc"><span class="type">(<span class="float">float</span>)</span><span class="required">(Required)</span><span class="description">Maximum value.</span></p>
</dd>
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>

2
components/knx/index.html
View file

@ -133,7 +133,7 @@
<ul>
<li><strong>fire_event</strong> (<em>Optional</em>): If set to True, platform will write all received KNX messages to event bus</li>
<li><strong>fire_event_filter</strong> (<em>Optional</em>): If <code class="highlighter-rouge">fire_event</code> is set <code class="highlighter-rouge">fire_event_filter</code> has to be specified. <code class="highlighter-rouge">fire_event_filter</code> defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.</li>
<li><strong>state_updater</strong> (<em>Optional</em>): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.</li>
<li><strong>state_updater</strong> (<em>Optional</em>): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behavior.</li>
<li><strong>time_address</strong> (<em>Optional</em>): Broadcast current local time to KNX bus with configured group address.</li>
</ul>
<h3><a class="title-link" name="services" href="#services"></a> Services</h3>

2
components/light.hive/index.html
View file

@ -79,7 +79,7 @@
<ul>
<li><strong>Hive Active Light Dimmable</strong></li>
<li><strong>Hive Active Light Cool to Warm White</strong></li>
<li><strong>Hive Active Light Colour Changing</strong></li>
<li><strong>Hive Active Light Color Changing</strong></li>
</ul>
<p class="note">
Full configuration details can be found on the main <a href="/components/hive/">Hive component</a> page.

1
components/light.yeelight/index.html
View file

@ -116,6 +116,7 @@ This component is tested to work with the following models. If you have a differ
<li><strong>YLDP03YL</strong>: LED Bulb (Color) - E26</li>
<li><strong>YLDD01YL</strong>: Lightstrip (Color)</li>
<li><strong>YLDD02YL</strong>: Lightstrip (Color)</li>
<li><strong>MJCTD01YL</strong>: Xiaomi Mijia Bedside Lamp - WIFI Version!</li>
</ul>
</article>
</div>

2
components/light.zigbee/index.html
View file

@ -74,7 +74,7 @@
</h1>
</header>
<hr class="divider">
<p>A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered <code class="highlighter-rouge">on</code> when the ZigBee device’s digital output is held <code class="highlighter-rouge">high</code> and considered <code class="highlighter-rouge">off</code> when it is held <code class="highlighter-rouge">low</code>. This behaviour can be inverted by setting the <code class="highlighter-rouge">on_state</code> configuration variable to <code class="highlighter-rouge">low</code>.</p>
<p>A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered <code class="highlighter-rouge">on</code> when the ZigBee device’s digital output is held <code class="highlighter-rouge">high</code> and considered <code class="highlighter-rouge">off</code> when it is held <code class="highlighter-rouge">low</code>. This behavior can be inverted by setting the <code class="highlighter-rouge">on_state</code> configuration variable to <code class="highlighter-rouge">low</code>.</p>
<p>To configure a digital output pin as light, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">light</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">Desk Lamp</span>

2
components/lirc/index.html
View file

@ -88,7 +88,7 @@ The configuration is slightly different :
- The former single <code class="highlighter-rouge">lirc</code> service is replaced with the three systemd services <code class="highlighter-rouge">lircd.service</code>, <code class="highlighter-rouge">lircmd.service</code> and <code class="highlighter-rouge">irexec.service</code>. There is no counterpart to the 0.9.0 <code class="highlighter-rouge">lirc</code> service which covered all of these. Using a separate transmitter device requires yet another service.
- 0.9.4 defaults to using systemd for controlling the services. This is not just start/stop functionality, systemd is used to implement new features and to address shortcomings in 0.9.0. However, traditional systemV scripts are also installed and could be used although this is less tested and not really documented.<br />
<br />
For more infomation have a look at <code class="highlighter-rouge">/usr/share/doc/lirc/README.Debian.gz</code> where the update process is explained when you have updated from jessie to stretch.
For more information have a look at <code class="highlighter-rouge">/usr/share/doc/lirc/README.Debian.gz</code> where the update process is explained when you have updated from jessie to stretch.
</p>
<h3><a class="title-link" name="configuring-lirc" href="#configuring-lirc"></a> Configuring LIRC</h3>
<p>Now teach LIRC about your particular remote control by preparing a lircd configuration file (<code class="highlighter-rouge">/etc/lirc/lircd.conf</code>). Search the <a href="http://lirc.sourceforge.net/remotes/">LIRC remote database</a> for your model. If you can’t find it, then you can always use the <code class="highlighter-rouge">irrecord</code> program to learn your remote. This will create a valid configuration file. Add as many remotes as you want by pasting them into the file. If <code class="highlighter-rouge">irrecord</code> doesn’t work (e.g. for some air conditioner remotes), then the <code class="highlighter-rouge">mode2</code> program is capable of reading the codes in raw mode, followed by <code class="highlighter-rouge">irrecord -a</code> to extract hex codes.</p>

2
components/media_player.denonavr/index.html
View file

@ -125,7 +125,7 @@ If you have something else using the IP controller for your Denon AVR 3808CI, su
<ul>
<li>Additional option the control Denon AVR receivers with a builtin web server is using the HTTP interface with denonavr platform.</li>
<li>denonavr platform supports some additional functionalities like album covers, custom input source names and auto discovery.</li>
<li>Marantz receivers seem to a have quite simliar interface. Thus if you own one, give it a try.</li>
<li>Marantz receivers seem to a have quite similar interface. Thus if you own one, give it a try.</li>
</ul>
</article>
</div>

2
components/media_player.yamaha/index.html
View file

@ -121,7 +121,7 @@ your DNS) then.</li>
volume control and source selection. Playback controls, for instance
play and stop are available for sources that supports it.</li>
<li>The <code class="highlighter-rouge">play_media</code> service is implemented for <code class="highlighter-rouge">NET RADIO</code> source
only. The <code class="highlighter-rouge">media_id</code> is a <code class="highlighter-rouge">&gt;</code> separted string of the menu path on
only. The <code class="highlighter-rouge">media_id</code> is a <code class="highlighter-rouge">&gt;</code> separated string of the menu path on
the vtuner service. For instance <code class="highlighter-rouge">Bookmarks&gt;Internet&gt;WAMC 90.3 FM</code>.</li>
</ul>
<h3><a class="title-link" name="example-configuration" href="#example-configuration"></a> Example configuration</h3>

2
components/namecheapdns/index.html
View file

@ -76,7 +76,7 @@
<hr class="divider">
<p>With the <code class="highlighter-rouge">namecheapdns</code> component you can automatically update your dynamic DNS entry at <a href="https://www.namecheap.com/store/domains/freedns/">namecheapdns</a>.</p>
<p class="note warning">
Namecheap only supports IPv4 adresses to update.
Namecheap only supports IPv4 addresses to update.
</p>
<p>To use the component in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>

2
components/notify.facebook/index.html
View file

@ -106,7 +106,7 @@ The phone number used in <strong>target</strong> should be registered with Faceb
<span class="pi">-</span> <span class="s1">'</span><span class="s">+919784516314'</span>
</code></pre>
</div>
<p>You can also send messages to users that do not have stored their phone number with Facebook, but this requires a bit more work. The Messenger platform uses page specific user IDs instead of a global user ID. You will need to enable a webhook for the “messages” event in Facebook’s developer console. Once a user writes a message to a page, that webhook will then receive the user’s page specifc ID as part of the webhook’s payload. Below is a simple PHP script that reacts to the message “get my id” and sends a reply containing the user’s ID:</p>
<p>You can also send messages to users that do not have stored their phone number with Facebook, but this requires a bit more work. The Messenger platform uses page specific user IDs instead of a global user ID. You will need to enable a webhook for the “messages” event in Facebook’s developer console. Once a user writes a message to a page, that webhook will then receive the user’s page specific ID as part of the webhook’s payload. Below is a simple PHP script that reacts to the message “get my id” and sends a reply containing the user’s ID:</p>
<div class="language-php highlighter-rouge"><pre class="highlight"><code><span class="cp">&lt;?php</span>
<span class="nv">$access_token</span> <span class="o">=</span> <span class="s2">""</span><span class="p">;</span>

6
components/notify.pushsafer/index.html
View file

@ -90,7 +90,7 @@
<li><strong>private_key</strong> (<em>Required</em>): Your private or alias key. Private key = send the notification to all devices with standard params, alias key send the notification to the devices stored in the alias with predefined params.</li>
</ul>
<h3><a class="title-link" name="examples" href="#examples"></a> Examples</h3>
<p>Message to two devices with formated text.</p>
<p>Message to two devices with formatted text.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Test to 2 devices"</span><span class="p">,</span><span class="w">
</span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attention [b]bold[/b] text[br][url=https://www.pushsafer.com]Link to Pushsafer[/url]"</span><span class="p">,</span><span class="w">
@ -107,7 +107,7 @@
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>Message to one device with formated text and image from an external URL.</p>
<p>Message to one device with formatted text and image from an external URL.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Test to 1 device with image from an url"</span><span class="p">,</span><span class="w">
</span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attention [i]italic[/i] Text[br][url=https://home-assistant.io/]Testlink[/url]"</span><span class="p">,</span><span class="w">
@ -127,7 +127,7 @@
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>Message to two devices and one device group with formated text and local image.</p>
<p>Message to two devices and one device group with formatted text and local image.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Test to 3 devices with local image"</span><span class="p">,</span><span class="w">
</span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attention [i]italic[/i] Text[br][url=https://home-assistant.io/]Testlink[/url]"</span><span class="p">,</span><span class="w">

2
components/pilight/index.html
View file

@ -89,7 +89,7 @@
<li><strong>host</strong> (<em>Required</em>): The IP address of the computer running the pilight-daemon, e.g. 192.168.1.32.</li>
<li><strong>port</strong> (<em>Required</em>): The network port to connect to. The usual port is <a href="https://manual.pilight.org/development/api.html">5000</a>.</li>
<li><strong>send_delay</strong> (<em>Optional</em>): You can define a send delay as a fraction of seconds if you experience transmission problems when you try to switch multiple switches at once. This can happen when you use a <a href="https://github.com/pilight/pilight-usb-nano">pilight USB Nano</a> as hardware and switches a whole group of multiple switches on or off. Tested values are between 0.3 and 0.8 seconds depending on the hardware.</li>
<li><strong>whitelist</strong> (<em>Optional</em>): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbours weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true.</li>
<li><strong>whitelist</strong> (<em>Optional</em>): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbors weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true.</li>
</ul>
<p>In this example only received RF codes using a daycom or Intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight <a href="https://manual.pilight.org/development/api.html">API</a>.</p>
<p>A full configuration sample could look like the sample below:</p>

2
components/remember_the_milk/index.html
View file

@ -94,7 +94,7 @@
<dl class="">
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">Name of the RTM account, as you can have serveral accounts in RTM. The name must be unique.</span></p>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">Name of the RTM account, as you can have several accounts in RTM. The name must be unique.</span></p>
</dd>
<dt><a class="title-link" name="api_key" href="#api_key"></a> api_key</dt>
<dd>

2
components/sensor.buienradar/index.html
View file

@ -117,7 +117,7 @@
<li><strong>groundtemperature</strong>: The current ground temperature (in <a href="https://en.wikipedia.org/wiki/Celsius">C</a>).</li>
<li><strong>windspeed</strong>: The wind speed in <a href="https://en.wikipedia.org/wiki/M/s">m/s</a>.</li>
<li><strong>windforce</strong>: The wind speed/force in <a href="https://en.wikipedia.org/wiki/Beaufort_scale">Bft</a>.</li>
<li><strong>winddirection</strong>: Where the wind is coming from: N (North),Z (south), NO (Noth-East), etc.</li>
<li><strong>winddirection</strong>: Where the wind is coming from: N (North),Z (south), NO (North-East), etc.</li>
<li><strong>windazimuth</strong>: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.</li>
<li><strong>pressure</strong>: The sea-level air pressure in <a href="https://en.wikipedia.org/wiki/Hectopascal">hPa</a>.</li>
<li><strong>visibility</strong>: Visibility in meters (<a href="https://en.wikipedia.org/wiki/Metre">m</a>).</li>

6
components/sensor.deutsche_bahn/index.html
View file

@ -8,7 +8,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Deutsche Bahn - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate timetable data for travelling in Germany within Home Assistant.">
<meta name="description" content="Instructions how to integrate timetable data for traveling in Germany within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.deutsche_bahn/">
<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/components/sensor.deutsche_bahn/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate timetable data for travelling in Germany within Home Assistant.">
<meta property="og:description" content="Instructions how to integrate timetable data for traveling in Germany within Home Assistant.">
<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="Deutsche Bahn">
<meta name="twitter:description" content="Instructions how to integrate timetable data for travelling in Germany within Home Assistant.">
<meta name="twitter:description" content="Instructions how to integrate timetable data for traveling in Germany within Home Assistant.">
<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">

6
components/sensor.dublin_bus_transport/index.html
View file

@ -8,7 +8,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Dublin Bus Transport - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate timetable data for travelling on Dublin Bus within Home Assistant.">
<meta name="description" content="Instructions how to integrate timetable data for traveling on Dublin Bus within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.dublin_bus_transport/">
<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/components/sensor.dublin_bus_transport/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate timetable data for travelling on Dublin Bus within Home Assistant.">
<meta property="og:description" content="Instructions how to integrate timetable data for traveling on Dublin Bus within Home Assistant.">
<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="Dublin Bus Transport">
<meta name="twitter:description" content="Instructions how to integrate timetable data for travelling on Dublin Bus within Home Assistant.">
<meta name="twitter:description" content="Instructions how to integrate timetable data for traveling on Dublin Bus within Home Assistant.">
<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">

2
components/sensor.envirophat/index.html
View file

@ -77,7 +77,7 @@
<p>The <code class="highlighter-rouge">envirophat</code> sensor platform allows you to display information collected by an <a href="https://shop.pimoroni.com/products/enviro-phat">Enviro pHAT</a> add-on board for the Raspberry Pi. The board features a wide range of sensors, such as:</p>
<ul>
<li>BMP280 temperature/pressure sensor</li>
<li>TCS3472 light and RGB colour sensor with two LEDs for illumination</li>
<li>TCS3472 light and RGB color sensor with two LEDs for illumination</li>
<li>LSM303D accelerometer/magnetometer sensor</li>
<li>ADS1015 4-channel 3.3v, analog to digital sensor (ADC)</li>
</ul>

2
components/sensor.geo_rss_events/index.html
View file

@ -109,7 +109,7 @@ incidents from the NSW Rural Fire Service.</p>
<ul>
<li><strong>url</strong> (<em>Required</em>): Full URL of the GeoRSS feed.</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the sensor used in generating the entity id. Default is ‘Event Service’.</li>
<li><strong>radius</strong> (<em>Optional</em>): The distance in kilometres around the Home Assistant’s coordinates in which events are considered. Default is: 20km.</li>
<li><strong>radius</strong> (<em>Optional</em>): The distance in kilometers around the Home Assistant’s coordinates in which events are considered. Default is: 20km.</li>
<li><strong>categories</strong> (<em>Optional</em>): List of event category names found in the GeoRSS feed. A separate sensor is created for each category defined. Default is to join events from all categories into an ‘Any’ category.</li>
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): The type of events found in the GeoRSS feed. Default is ‘Events’.</li>
</ul>

2
components/sensor.influxdb/index.html
View file

@ -108,7 +108,7 @@
</ul>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<h3><a class="title-link" name="full-configuration" href="#full-configuration"></a> Full configuration</h3>
<p>The example configuration entry bellow create two request to your local InfluxDB instance, one to the database <code class="highlighter-rouge">db1</code>, the other to <code class="highlighter-rouge">db2</code>:</p>
<p>The example configuration entry below create two request to your local InfluxDB instance, one to the database <code class="highlighter-rouge">db1</code>, the other to <code class="highlighter-rouge">db2</code>:</p>
<ul>
<li><code class="highlighter-rouge">select last(value) as value from "°C" where "name" = "foo"</code></li>
<li><code class="highlighter-rouge">select min(tmp) as value from "%" where "entity_id" = ''salon'' and time &gt; now() - 1h</code></li>

2
components/sensor.lacrosse/index.html
View file

@ -81,7 +81,7 @@
<li>Technoline TX 29 DTH-IT (including humidity)</li>
</ul>
<h2><a class="title-link" name="setup" href="#setup"></a> Setup</h2>
<p>Since the sensor change their ID after each powercycle/battery change you can check what sensor IDs are availble by using the command-line tool <code class="highlighter-rouge">pylacrosse</code> from the pylacrosse package.</p>
<p>Since the sensor change their ID after each powercycle/battery change you can check what sensor IDs are available by using the command-line tool <code class="highlighter-rouge">pylacrosse</code> from the pylacrosse package.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo pylacrosse -d /dev/ttyUSB0 scan
</code></pre>
</div>

2
components/sensor.london_air/index.html
View file

@ -75,7 +75,7 @@
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">london_air</code> component <a href="http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json">queries</a> the London air quality <a href="https://www.londonair.org.uk/LondonAir/API/">data feed</a> provided by Kings College London. A single sensor will be added for each <code class="highlighter-rouge">location</code> (<a href="https://en.wikipedia.org/wiki/List_of_London_boroughs">local authority district or borough</a>) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available.</p>
<p>Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described <a href="http://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json">here</a> and are Carbon Monoxide (<a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx">CO2</a>), Nitrogen Dioxide (<a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx">NO2</a>), Ozone (<a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx">O3</a>), Sulphur Dioxide (<a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx">SO2</a>), PM2.5 &amp; PM10 <a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx">particulates</a>. The <code class="highlighter-rouge">latitude</code> and <code class="highlighter-rouge">longitude</code> of each site is accessible through a <code class="highlighter-rouge">data</code> attribute of the sensor, as are details about the pollutants monitored at that site. The <code class="highlighter-rouge">sites</code> attribute of a sensor displays how many monitoring sites that sensor covers. The <code class="highlighter-rouge">updated</code> attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes.</p>
<p>Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described <a href="http://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json">here</a> and are Carbon Monoxide (<a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx">CO2</a>), Nitrogen Dioxide (<a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx">NO2</a>), Ozone (<a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx">O3</a>), Sulfur Dioxide (<a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx">SO2</a>), PM2.5 &amp; PM10 <a href="http://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx">particulates</a>. The <code class="highlighter-rouge">latitude</code> and <code class="highlighter-rouge">longitude</code> of each site is accessible through a <code class="highlighter-rouge">data</code> attribute of the sensor, as are details about the pollutants monitored at that site. The <code class="highlighter-rouge">sites</code> attribute of a sensor displays how many monitoring sites that sensor covers. The <code class="highlighter-rouge">updated</code> attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes.</p>
<p>To add sensors to Home-assistant for all possible areas/boroughs add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for a single sensor</span>
<span class="s">sensor</span><span class="pi">:</span>

10
components/sensor.nederlandse_spoorwegen/index.html
View file

@ -8,7 +8,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Nederlandse Spoorwegen - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate timetable data for travelling by train in the Netherlands within Home Assistant.">
<meta name="description" content="Instructions how to integrate timetable data for traveling by train in the Netherlands within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.nederlandse_spoorwegen/">
<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/components/sensor.nederlandse_spoorwegen/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate timetable data for travelling by train in the Netherlands within Home Assistant.">
<meta property="og:description" content="Instructions how to integrate timetable data for traveling by train in the Netherlands within Home Assistant.">
<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="Nederlandse Spoorwegen">
<meta name="twitter:description" content="Instructions how to integrate timetable data for travelling by train in the Netherlands within Home Assistant.">
<meta name="twitter:description" content="Instructions how to integrate timetable data for traveling by train in the Netherlands within Home Assistant.">
<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">
@ -96,11 +96,11 @@
<ul>
<li><strong>email</strong> (<em>Required</em>): The email address you used to request the API password.</li>
<li><strong>password</strong> (<em>Required</em>): The API password provided by the Nederlandse Spoorwegen.</li>
<li><strong>routes</strong> array (<em>Required</em>): List of travelling routes.
<li><strong>routes</strong> array (<em>Required</em>): List of traveling routes.
<ul>
<li><strong>name</strong> (<em>Required</em>): Name of the route.</li>
<li><strong>from</strong> (<em>Required</em>): The start station.</li>
<li><strong>to</strong> (<em>Required</em>): Direction of the travelling.</li>
<li><strong>to</strong> (<em>Required</em>): Direction of the traveling.</li>
<li><strong>via</strong> (<em>Optional</em>): Optional other station you wish to visit in between.</li>
</ul>
</li>

2
components/sensor.onewire/index.html
View file

@ -87,7 +87,7 @@
</ul>
<p>The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using dedicated interface adapter (e.g <a href="https://datasheets.maximintegrated.com/en/ds/DS9490-DS9490R.pdf">DS9490R</a>).</p>
<h4>Raspberry Pi setup</h4>
<p>In order ot setup 1-Wire support on Raspberry Pi, you’ll need to edit <code class="highlighter-rouge">/boot/config.txt</code> following <a href="https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire">this documentation</a>. Don’t use the <code class="highlighter-rouge">mount_dir</code> option.</p>
<p>In order to setup 1-Wire support on Raspberry Pi, you’ll need to edit <code class="highlighter-rouge">/boot/config.txt</code> following <a href="https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire">this documentation</a>. Don’t use the <code class="highlighter-rouge">mount_dir</code> option.</p>
<h4>Interface adapter setup</h4>
<p>When an interface adapter is used, sensors can be accessed on Linux hosts via <a href="http://owfs.org/">owfs 1-Wire file system</a>. When using an interface adapter and the owfs, the <code class="highlighter-rouge">mount_dir</code> option must be configured to correspond a directory, where owfs device tree has been mounted.</p>
<p class="note warning">

2
components/sensor.pvoutput/index.html
View file

@ -74,7 +74,7 @@
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">pvoutput</code> sensor platform consumes informations from <a href="http://pvoutput.org/">PVOutput</a> which were uploaded by your solar photovoltaic (PV) system.</p>
<p>The <code class="highlighter-rouge">pvoutput</code> sensor platform consumes information from <a href="http://pvoutput.org/">PVOutput</a> which were uploaded by your solar photovoltaic (PV) system.</p>
<p>To add PVOutput details to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>

2
components/sensor.rest/index.html
View file

@ -230,7 +230,7 @@ User-Agent: Home Assistant
<span class="s">User-Agent</span><span class="pi">:</span> <span class="s">Home Assistant REST sensor</span>
</code></pre>
</div>
<h3><a class="title-link" name="fetch-multiple-json-values-and-present-them-as-attibutes" href="#fetch-multiple-json-values-and-present-them-as-attibutes"></a> Fetch multiple JSON values and present them as attibutes</h3>
<h3><a class="title-link" name="fetch-multiple-json-values-and-present-them-as-attributes" href="#fetch-multiple-json-values-and-present-them-as-attributes"></a> Fetch multiple JSON values and present them as attributes</h3>
<p><a href="http://www.jsontest.com">JSON Test</a> returns the current time, date and milliseconds since epoch from <a href="http://date.jsontest.com/">http://date.jsontest.com/</a>.</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">rest</span>

2
components/sensor.scrape/index.html
View file

@ -140,7 +140,7 @@
</code></pre>
</div>
<h3><a class="title-link" name="get-the-latest-podcast-episode-file-url" href="#get-the-latest-podcast-episode-file-url"></a> Get the latest podcast episode file URL</h3>
<p>If you want to get the file URL for the latest episode of your <a href="https://hasspodcast.io/">favourite podcast</a>, so you can pass it on to a compatible media player.</p>
<p>If you want to get the file URL for the latest episode of your <a href="https://hasspodcast.io/">favorite podcast</a>, so you can pass it on to a compatible media player.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<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">scrape</span>

6
components/sensor.swiss_public_transport/index.html
View file

@ -8,7 +8,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Swiss Public Transport - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate timetable data for travelling in Switzerland within Home Assistant.">
<meta name="description" content="Instructions how to integrate timetable data for traveling in Switzerland within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.swiss_public_transport/">
<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/components/sensor.swiss_public_transport/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate timetable data for travelling in Switzerland within Home Assistant.">
<meta property="og:description" content="Instructions how to integrate timetable data for traveling in Switzerland within Home Assistant.">
<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="Swiss Public Transport">
<meta name="twitter:description" content="Instructions how to integrate timetable data for travelling in Switzerland within Home Assistant.">
<meta name="twitter:description" content="Instructions how to integrate timetable data for traveling in Switzerland within Home Assistant.">
<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">

12
components/sensor.vasttrafik/index.html
View file

@ -8,7 +8,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Västtrafik Public Transport - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate timetable data for travelling in Sweden within Home Assistant.">
<meta name="description" content="Instructions how to integrate timetable data for traveling in Sweden within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.vasttrafik/">
<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/components/sensor.vasttrafik/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate timetable data for travelling in Sweden within Home Assistant.">
<meta property="og:description" content="Instructions how to integrate timetable data for traveling in Sweden within Home Assistant.">
<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="Västtrafik Public Transport">
<meta name="twitter:description" content="Instructions how to integrate timetable data for travelling in Sweden within Home Assistant.">
<meta name="twitter:description" content="Instructions how to integrate timetable data for traveling in Sweden within Home Assistant.">
<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">
@ -74,7 +74,7 @@
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">vasttrafik</code> sensor will provide you travelling details for the larger Göteborg area in Sweden from the <a href="https://vasttrafik.se/">Västtrafik</a> public transportation service.</p>
<p>The <code class="highlighter-rouge">vasttrafik</code> sensor will provide you traveling details for the larger Göteborg area in Sweden from the <a href="https://vasttrafik.se/">Västtrafik</a> public transportation service.</p>
<p>You must create an application <a href="https://developer.vasttrafik.se/portal/#/applications">here</a> to obtain a <code class="highlighter-rouge">key</code> and a <code class="highlighter-rouge">secret</code>.</p>
<p>Add the data to your <code class="highlighter-rouge">configuration.yaml</code> file as shown in the example:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
@ -90,11 +90,11 @@
<ul>
<li><strong>key</strong> (<em>Required</em>): The API key to access your Västtrafik account.</li>
<li><strong>secret</strong> (<em>Required</em>): The API secret to access your Västtrafik account.</li>
<li><strong>departures</strong> array (<em>Required</em>): List of travelling routes.
<li><strong>departures</strong> array (<em>Required</em>): List of traveling routes.
<ul>
<li><strong>name</strong> (<em>Optional</em>): Name of the route.</li>
<li><strong>from</strong> (<em>Required</em>): The start station.</li>
<li><strong>heading</strong> (<em>Optional</em>): Direction of the travelling.</li>
<li><strong>heading</strong> (<em>Optional</em>): Direction of the traveling.</li>
<li><strong>delay</strong> (<em>Optional</em>): Delay in minutes. Defaults to 0.</li>
</ul>
</li>

2
components/switch.zigbee/index.html
View file

@ -74,7 +74,7 @@
</h1>
</header>
<hr class="divider">
<p>A ZigBee switch in this context is a device connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a switch is considered <code class="highlighter-rouge">on</code> when the ZigBee device’s digital output is held <code class="highlighter-rouge">high</code> and considered <code class="highlighter-rouge">off</code> when it is held <code class="highlighter-rouge">low</code>. This behaviour can be inverted by setting the <code class="highlighter-rouge">on_state</code> configuration variable to <code class="highlighter-rouge">low</code>.</p>
<p>A ZigBee switch in this context is a device connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a switch is considered <code class="highlighter-rouge">on</code> when the ZigBee device’s digital output is held <code class="highlighter-rouge">high</code> and considered <code class="highlighter-rouge">off</code> when it is held <code class="highlighter-rouge">low</code>. This behavior can be inverted by setting the <code class="highlighter-rouge">on_state</code> configuration variable to <code class="highlighter-rouge">low</code>.</p>
<p>To configure a digital output pin as switch, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">switch</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">Pond Fountain</span>

6
components/timer/index.html
View file

@ -75,7 +75,7 @@
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">timer</code> component aims to simplify automations based on (dynamic) durations.</p>
<p>When a timer finishes or gets cancelled the corresponding events are fired. This allows you to differentiate if a timer has switched from <code class="highlighter-rouge">active</code> to <code class="highlighter-rouge">idle</code> because the given duration has elapsed or it has been cancelled. To control timers in your automations you can use the services mentioned below. When calling the <code class="highlighter-rouge">start</code> service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering any events. This for example makes it easy to create timed lights that get triggered by motion.</p>
<p>When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from <code class="highlighter-rouge">active</code> to <code class="highlighter-rouge">idle</code> because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the services mentioned below. When calling the <code class="highlighter-rouge">start</code> service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering any events. This for example makes it easy to create timed lights that get triggered by motion.</p>
<p class="note warning">
With the current implementation timers don’t persist over restarts. After a restart they will be idle again, together with their initial configuration.
</p>
@ -108,7 +108,7 @@ With the current implementation timers don’t persist over restarts. After a re
<tbody>
<tr>
<td>timer.cancelled</td>
<td>Fired when a timer has been cancelled</td>
<td>Fired when a timer has been canceled</td>
</tr>
<tr>
<td>timer.finished</td>
@ -160,7 +160,7 @@ If no <code class="highlighter-rouge">entity_id</code> is given all active timer
</tbody>
</table>
<h4><a class="title-link" name="service-timercancel" href="#service-timercancel"></a> Service <code class="highlighter-rouge">timer.cancel</code></h4>
<p>Cancel an active timer. This resets the duration to the last known initial value without firing the <code class="highlighter-rouge">timer.finished</code> event. If no <code class="highlighter-rouge">entity_id</code> is given all active timers will be cancelled.</p>
<p>Cancel an active timer. This resets the duration to the last known initial value without firing the <code class="highlighter-rouge">timer.finished</code> event. If no <code class="highlighter-rouge">entity_id</code> is given all active timers will be canceled.</p>
<table>
<thead>
<tr>

2
components/volvooncall/index.html
View file

@ -115,7 +115,7 @@
<li><strong>username</strong> (<em>Required</em>): The username associated with your Volvo On Call account.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given Volvo On Call account.</li>
<li><strong>region</strong> (<em>Optional</em>): The region where the Volvo is registered. Needs to be set for users in North America or China.</li>
<li><strong>service_url</strong> (<em>Optional</em>): The service URL to use for Volvo On Call. Normally not neccessary to specify.</li>
<li><strong>service_url</strong> (<em>Optional</em>): The service URL to use for Volvo On Call. Normally not necessary to specify.</li>
<li><strong>name</strong> (<em>Optional</em>): Make it possible to provide a name for the vehicles.</li>
<li><strong>resources</strong> (<em>Optional</em>): A list of resources to display (defaults to all available).</li>
<li><strong>scandinavian_miles</strong> (<em>Optional</em>): If set to yes, Scandinavian miles (“mil”) are used for distances and fuel range (defaults to no).</li>

2
components/wink/index.html
View file

@ -96,7 +96,7 @@ When using the configurator make sure the initial setup is performed on the same
</code></pre>
</div>
<h3><a class="title-link" name="full-oauth-authentication-legacy" href="#full-oauth-authentication-legacy"></a> Full oauth authentication (legacy).</h3>
<p>This should be used for users that obtained their client_id and client_secret via email from Wink support prior to <a href="https://developer.wink.com">developer.wink.com’s</a> existance.</p>
<p>This should be used for users that obtained their client_id and client_secret via email from Wink support prior to <a href="https://developer.wink.com">developer.wink.com’s</a> existence.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">wink</span><span class="pi">:</span>
<span class="s">email</span><span class="pi">:</span> <span class="s">YOUR_WINK_EMAIL_ADDRESS</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">YOUR_WINK_PASSWORD</span>