Skip to content

Commit 484562d

Browse files
committed
Merge branch 'current' into next
2 parents 60f8d3c + 6d8fad0 commit 484562d

23 files changed

+121
-108
lines changed

source/_components/binary_sensor.apcupsd.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ha_release: 0.13
1414

1515
In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
1616

17-
To enable this sensor, add the following lines to your `configuration.yaml` file:
17+
To enable this sensor, you first have to set up [apcupsd](/components/apcupsd/), and add the following lines to your `configuration.yaml` file:
1818

1919
```yaml
2020
# Example configuration.yaml entry

source/_components/binary_sensor.zigbee.markdown

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ sharing: true
99
footer: true
1010
logo: zigbee.png
1111
ha_category: Binary Sensor
12+
ha_release: 0.12
13+
ha_iot_class: "Local Polling"
1214
---
1315

14-
A `zigbee` binary sensor in this context is a device connected to one of the digital input pins on a [ZigBee](http://www.zigbee.org/) module. The states reported by such a device are limited to 'on' or 'off'. By default, a binary sensor is considered 'on' when the ZigBee device's digital input pin is held 'high' and considered 'off' when it is held 'low'. This behaviour can be inverted by setting the `on_state` configuration variable to `low`.
16+
A `zigbee` binary sha_release: 0.13ensor in this context is a device connected to one of the digital input pins on a [ZigBee](http://www.zigbee.org/) module. The states reported by such a device are limited to `on` or `off`. By default, a binary sensor is considered `on` when the ZigBee device's digital input pin is held 'high' and considered `off` when it is held `low`. This behaviour can be inverted by setting the `on_state` configuration variable to `low`.
1517

16-
To enable the ZigBee binary sensors in your installation, add the following lines to your `configuration.yaml`:
18+
To enable a digital input pin as binary sensor in your installation, add the following lines to your `configuration.yaml`:
1719

1820
```yaml
1921
# Example configuration.yaml entry
@@ -27,9 +29,8 @@ binary_sensor:
2729
2830
Configuration variables:
2931
30-
- **name** (*Required*): The name you'd like to give the binary sensor in Home Assistant.
31-
- **platform** (*Required*): Set to `zigbee`.
32+
- **name** (*Required*): The name you wouldd like to give the binary sensor in Home Assistant.
3233
- **pin** (*Required*): The number identifying which pin to use.
3334
- **address**: The long 64bit address of the remote ZigBee device whose digital input pin you'd like to sample. Do not include this variable if you want to sample the local ZigBee device's pins.
34-
- **on_state**: Either `high` (default) or `low`, depicting whether the binary sensor is considered 'on' when the pin is 'high' or 'low'.
35+
- **on_state**: Either `high` (default) or `low`, depicting whether the binary sensor is considered `on` when the pin is `high` or `low`.
3536

source/_components/camera.ffmpeg.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,5 @@ $ ffmpeg -i INPUT -an -f null -
5555
Now you can see what going wrong. Following list could be help to solve your trouble:
5656

5757
- `[rtsp @ ...] UDP timeout, retrying with TCP`: You need to set RTSP transport in the configuration with: `input: -rtsp_transport tcp -i INPUT`
58-
- `[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size`: FFmpeg need more data or time for autodetect. You can set the `analyzeduration` and/or `probesize` option, play with this value. If you know the needed value you can set it with: `input: -analyzeduration xy -probesize xy tcp -i INPUT`. More information about that can be found on [FFmpeg](https://www.ffmpeg.org/ffmpeg-formats.html#Description).
58+
- `[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size`: FFmpeg need more data or time for autodetect. You can set the `analyzeduration` and/or `probesize` option, play with this value. If you know the needed value you can set it with: `input: -analyzeduration xy -probesize xy -i INPUT`. More information about that can be found on [FFmpeg](https://www.ffmpeg.org/ffmpeg-formats.html#Description).
5959

source/_components/camera.netatmo.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ha_release: 0.22
1515

1616
The `netatmo` camera platform is consuming the information provided by a [Netatmo Welcome](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera.
1717

18-
To enable the Netatmo camera, add the following lines to your `configuration.yaml`:
18+
To enable the Netatmo camera, you first have to set up [netatmo](/components/netatmo/), and add the following lines to your `configuration.yaml`:
1919

2020
```yaml
2121
# Example configuration.yaml entry

source/_components/envisalink.markdown

Lines changed: 24 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ footer: true
1010
logo: eyezon.png
1111
ha_category: Alarm
1212
ha_release: 0.23
13+
ha_iot_class: "Local Push"
1314
---
1415

15-
This component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and it's sensors to provide Home Assistant with rich information about their homes.
16-
Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this component is built. Currently, the Envisalink version 4 is the latest model. This component supports both the evl3 and the evl4.
16+
The `envisalink` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and it's sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this component is built. Currently, the Envisalink version 4 is the latest model. This component supports both the evl3 and the evl4.
1717

1818
Please visit the [eyezon website](http://www.eyezon.com/) for further information about the evl3 and evl4 boards.
1919

@@ -23,54 +23,45 @@ There is currently support for the following device types within Home Assistant:
2323
- [Sensor](/components/sensor.envisalink/): Emulates an alpha-numeric keypad attached to the alarm panel
2424
- [Alarm Control Panel](/components/alarm_control_panel.envisalink/): Reports on partition status, and can be used to arm/disarm the system
2525

26-
This is a fully event-based component- any event sent by the Envisalink device will be immediately reflected within Home Assistant.
27-
28-
## Configuration
26+
This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.
2927

3028
An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required:
3129

32-
### Required Parameters
33-
- **host**: The IP address of the Envisalink device on your home network.
34-
- **panel_type**: `HONEYWELL` or `DSC`, depending upon which alarm system you have.
35-
- **user_name**: Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same.
36-
- **password**: Which password to authenticate with when connecting to the device.
37-
- **code**: Your alarm panel's code, for authenticating user input during arm/disarm.
38-
39-
### Optional Parameters
40-
- **port**: Which network port to connect with. Default: `4025`
41-
- **evl_version**: 3 for evl3, or 4 for evl4. Default: `3`
42-
- **keepalive_interval**: This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Default: `60` seconds
43-
- **zonedump_interval**: This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
44-
- **zones**: Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. *Note- if no zones are specified, Home Assistant will not load any binary_sensor components.*
45-
- **partitions**: Again, Envisalink boards do not tell us what is in use, and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.
46-
47-
#### Example
48-
4930
```yaml
31+
# Example configuration.yaml entry
5032
envisalink:
51-
#optional
33+
host: <envisalink IP address>
34+
panel_type: HONEYWELL or DSC
35+
user_name: YOUR_USERNAME
36+
password: YOUR_PASSWORD
37+
code: '1234'
5238
port: 4025
5339
evl_version: 3
5440
keepalive_interval: 60
5541
zonedump_interval: 30
56-
57-
#required
58-
host: <envisalink IP address>
59-
panel_type: HONEYWELL or DSC
60-
user_name: <pass>
61-
password: <pass>
62-
code: '1234'
63-
6442
zones:
6543
11:
6644
name: 'Back Door'
6745
type: 'opening'
68-
6946
21:
7047
name: 'First Floor Motion'
7148
type: 'motion'
72-
7349
partitions:
7450
1:
7551
name: 'Home Alarm'
7652
```
53+
54+
Configuration variables:
55+
56+
- **host** (*Required*): The IP address of the Envisalink device on your home network.
57+
- **panel_type** (*Required*): `HONEYWELL` or `DSC`, depending upon which alarm system you have.
58+
- **user_name** (*Required*): Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same.
59+
- **password** (*Required*): Which password to authenticate with when connecting to the device. EVL3 only works with max. 6 characters.
60+
- **code** (*Required*): Your alarm panel's code, for authenticating user input during arm/disarm.
61+
- **port** (*Optional*): Which network port to connect with. Default: `4025`
62+
- **evl_version** (*Optional*): 3 for evl3, or 4 for evl4. Default: `3`
63+
- **keepalive_interval** (*Optional*): This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Defaults to `60` seconds.
64+
- **zonedump_interval** (*Optional*): This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
65+
- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. *Note: if no zones are specified, Home Assistant will not load any binary_sensor components.*
66+
- **partitions** (*Optional*): Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.
67+

source/_components/http.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,5 @@ The `http` platforms are not real platforms within the meaning of the terminolog
4949
To use those kind of [sensors](/components/sensor.http/) or [binary sensors](components/binary_sensor.http/) in your installation no configuration in Home Assistant is needed. All configuration is done on the devices themselves. This means that you must be able to edit the target URL or endpoint and the payload. The entity will be created after the first message has arrived.
5050

5151
All [requests](/developers/rest_api/#post-apistatesltentity_id) need to be sent to the endpoint of the device and must be **POST**.
52+
53+
If you want to use Home Assistant to host or serve static files then create a directory called `www` under the `.homeassistant` configuration path. The static files in `.homeassistant/www/` can be accessed by the following URL `http://your.domain:8123/local/`.

source/_components/light.zigbee.markdown

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,13 @@ sharing: true
99
footer: true
1010
logo: zigbee.png
1111
ha_category: Light
12+
ha_release: 0.12
13+
ha_iot_class: "Local Polling"
1214
---
1315

14-
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 'on' when the ZigBee device's digital output is held 'high' and considered 'off' when it is held 'low'. This behaviour can be inverted by setting the `on_state` configuration variable to `low`.
16+
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 `on` when the ZigBee device's digital output is held `high` and considered `off` when it is held `low`. This behaviour can be inverted by setting the `on_state` configuration variable to `low`.
1517

16-
To configure a digital output pin as a light, use the following variables:
17-
18-
- **name** (*Required*): The name you'd like to give the light in Home Assistant.
19-
- **platform** (*Required*): Set to `zigbee`.
20-
- **pin** (*Required*): The number identifying which pin to use.
21-
- **address**: The long 64bit address of the remote ZigBee device whose digital output pin you'd like to switch. Do not include this variable if you want to switch the local ZigBee device's pins.
22-
- **on_state**: Either `high` (default) or `low`, depicting whether the digital output pin is pulled high or low when the light is turned on.
23-
24-
#### Example
18+
To configure a digital output pin as light, add the following to your `configuration.yaml` file:
2519

2620
```yaml
2721
light:
@@ -31,3 +25,10 @@ light:
3125
address: 0013A20040791FA2
3226
on_state: low
3327
```
28+
29+
Configuration variables:
30+
31+
- **name** (*Required*): The name you' would like to give the light in Home Assistant.
32+
- **pin** (*Required*): The number identifying which pin to use.
33+
- **address**: The long 64 bit address of the remote ZigBee device whose digital output pin you wouldd like to switch. Do not include this variable if you want to switch the local ZigBee device's pins.
34+
- **on_state**: Either `high` (default) or `low`, depicting whether the digital output pin is pulled `high` or `low` when the light is turned on.

source/_components/media_player.panasonic_viera.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ The `panasonic_viera` platform allows you to control a Panasonic Viera TV.
1818
Currently known supported models:
1919

2020
- TX-P42STW50
21+
- TC-P65VT30
2122

2223
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io).
2324

@@ -37,4 +38,3 @@ Configuration variables:
3738
- **host** (*Required*): The IP of the Panasonic Viera TV, e.g. `192.168.0.10`
3839
- **port** (*Optional*): The port of your Panasonic Viera TV. Defaults to `55000`
3940
- **name** (*Optional*): The name you would like to give to the Panasonic Viera TV.
40-

source/_components/notify.html5.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Chrome supports notification actions, which are configurable buttons that arrive
7171
"actions": [
7272
{
7373
"action": "open",
74-
"icon": "/static/icons/favicon-192x192.png"
74+
"icon": "/static/icons/favicon-192x192.png",
7575
"title": "Open Home Assistant"
7676
},
7777
{
@@ -85,7 +85,7 @@ Chrome supports notification actions, which are configurable buttons that arrive
8585

8686
#### {% linkable_title Data %}
8787

88-
Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`) will be sent back to you in the [callback events](http://localhost:4000/components/notify.html5/#automating-notification-events).
88+
Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`) will be sent back to you in the [callback events](#automating-notification-events).
8989

9090
```json
9191
{

source/_components/notify.nma.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ notify:
3030
Configuration variables:
3131
3232
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
33-
- **api_key** (*Required*): Enter the API key for NMA.
33+
- **api_key** (*Required*): The API key for NMA.
3434

35-
Details for the (API)[https://www.notifymyandroid.com/api.jsp].
35+
Details for the [API](https://www.notifymyandroid.com/api.jsp).
3636

3737
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

source/_components/pilight.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ To integrate pilight into Home Assistant, add the following section to your `con
2424
```yaml
2525
# Example configuration.yaml entry
2626
pilight:
27-
- host: 127.0.0.1
28-
port: 5000
29-
whitelist: # optional
30-
protocol:
31-
- daycom
32-
- intertechno
33-
id:
34-
- 42
27+
host: 127.0.0.1
28+
port: 5000
29+
whitelist: # optional
30+
protocol:
31+
- daycom
32+
- intertechno
33+
id:
34+
- 42
3535
```
3636
3737
Configuration variables:

source/_components/sensor.apcupsd.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ha_category: Sensor
1313

1414
The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command.
1515

16-
To use this sensor platform, you first have to set up [apcupsd](https://home-assistant.io/components/apcupsd/) and add the following to your `configuration.yaml` file:
16+
To use this sensor platform, you first have to set up [apcupsd](/components/apcupsd/), and add the following to your `configuration.yaml` file:
1717

1818
```yaml
1919
# Example configuration.yaml entry

source/_components/sensor.netatmo.markdown

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ ha_category: Weather
1414

1515
The `netatmo` sensor platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) device.
1616

17-
To enable the Netatmo sensor, add the following lines to your `configuration.yaml`:
17+
18+
19+
To enable the Netatmo sensor, you first have to set up [netatmo](/components/netatmo/), and add the following lines to your `configuration.yaml`:
1820

1921
```yaml
2022
# Example configuration.yaml entry
@@ -53,7 +55,7 @@ sensor:
5355
5456
Configuration variables:
5557
56-
- **station** (*Optionnal*): The name of the weather station. Needed if several stations are associated with the account.
58+
- **station** (*Optional*): The name of the weather station. Needed if several stations are associated with the account.
5759
- **modules** (*Required*): Modules to use. Multiple entries allowed.
5860
- **module_name** array (*Required*): Name of the module.
5961
- **temperature**: Current temperature.
@@ -76,8 +78,7 @@ Configuration variables:
7678
7779
### {% linkable_title Find your modules name %}
7880
79-
You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters (See screenshot)
80-
You have to provide these name in your Home Assistant configuration file.
81+
You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters. You have to provide these name in your Home Assistant `configuration.yaml` file.
8182

8283
<p class='img'>
8384
<img src='/images/screenshots/netatmo_module.png' />

source/_components/sensor.torque.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ sensor:
4747
4848
Configuration variables:
4949
50-
- **name** (*Required*): Vehicle name (your choice).
51-
- **email**: Email address configured in Torque application.
50+
- **name** (*Optional*): Vehicle name (your choice).
51+
- **email** (*Required*): Email address configured in Torque application.

source/_components/sensor.zigbee.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ sharing: true
99
footer: true
1010
logo: zigbee.png
1111
ha_category: Sensor
12+
ha_release: 0.12
13+
ha_iot_class: "Local Polling"
1214
---
1315

1416
There are two types of [ZigBee](http://www.zigbee.org/) sensor available to Home Assistant:

source/_components/switch.netio.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The `netio` switch platform allows you to control your [Netio](http://www.netio-
1818

1919
To use Netio devices in your installation, add the following to your `configuration.yaml` file:
2020

21-
```
21+
```yaml
2222
# Example configuration.yaml entry
2323
switch:
2424
- platform: netio

0 commit comments

Comments
 (0)