You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/binary_sensor.apcupsd.markdown
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ ha_release: 0.13
14
14
15
15
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.
16
16
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:
Copy file name to clipboardExpand all lines: source/_components/binary_sensor.zigbee.markdown
+6-5Lines changed: 6 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,13 @@ sharing: true
9
9
footer: true
10
10
logo: zigbee.png
11
11
ha_category: Binary Sensor
12
+
ha_release: 0.12
13
+
ha_iot_class: "Local Polling"
12
14
---
13
15
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`.
15
17
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`:
17
19
18
20
```yaml
19
21
# Example configuration.yaml entry
@@ -27,9 +29,8 @@ binary_sensor:
27
29
28
30
Configuration variables:
29
31
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.
32
33
- **pin** (*Required*): The number identifying which pin to use.
33
34
- **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`.
Copy file name to clipboardExpand all lines: source/_components/camera.ffmpeg.markdown
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -55,5 +55,5 @@ $ ffmpeg -i INPUT -an -f null -
55
55
Now you can see what going wrong. Following list could be help to solve your trouble:
56
56
57
57
- `[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).
Copy file name to clipboardExpand all lines: source/_components/camera.netatmo.markdown
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ ha_release: 0.22
15
15
16
16
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.
17
17
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`:
Copy file name to clipboardExpand all lines: source/_components/envisalink.markdown
+24-33Lines changed: 24 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -10,10 +10,10 @@ footer: true
10
10
logo: eyezon.png
11
11
ha_category: Alarm
12
12
ha_release: 0.23
13
+
ha_iot_class: "Local Push"
13
14
---
14
15
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.
17
17
18
18
Please visit the [eyezon website](http://www.eyezon.com/) for further information about the evl3 and evl4 boards.
19
19
@@ -23,54 +23,45 @@ There is currently support for the following device types within Home Assistant:
23
23
-[Sensor](/components/sensor.envisalink/): Emulates an alpha-numeric keypad attached to the alarm panel
24
24
-[Alarm Control Panel](/components/alarm_control_panel.envisalink/): Reports on partition status, and can be used to arm/disarm the system
25
25
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.
29
27
30
28
An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required:
31
29
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
-
49
30
```yaml
31
+
# Example configuration.yaml entry
50
32
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'
52
38
port: 4025
53
39
evl_version: 3
54
40
keepalive_interval: 60
55
41
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
-
64
42
zones:
65
43
11:
66
44
name: 'Back Door'
67
45
type: 'opening'
68
-
69
46
21:
70
47
name: 'First Floor Motion'
71
48
type: 'motion'
72
-
73
49
partitions:
74
50
1:
75
51
name: 'Home Alarm'
76
52
```
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.
Copy file name to clipboardExpand all lines: source/_components/http.markdown
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -49,3 +49,5 @@ The `http` platforms are not real platforms within the meaning of the terminolog
49
49
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.
50
50
51
51
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/`.
Copy file name to clipboardExpand all lines: source/_components/light.zigbee.markdown
+11-10Lines changed: 11 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -9,19 +9,13 @@ sharing: true
9
9
footer: true
10
10
logo: zigbee.png
11
11
ha_category: Light
12
+
ha_release: 0.12
13
+
ha_iot_class: "Local Polling"
12
14
---
13
15
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`.
15
17
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:
25
19
26
20
```yaml
27
21
light:
@@ -31,3 +25,10 @@ light:
31
25
address: 0013A20040791FA2
32
26
on_state: low
33
27
```
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.
Copy file name to clipboardExpand all lines: source/_components/media_player.panasonic_viera.markdown
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ The `panasonic_viera` platform allows you to control a Panasonic Viera TV.
18
18
Currently known supported models:
19
19
20
20
- TX-P42STW50
21
+
- TC-P65VT30
21
22
22
23
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).
23
24
@@ -37,4 +38,3 @@ Configuration variables:
37
38
- **host** (*Required*): The IP of the Panasonic Viera TV, e.g. `192.168.0.10`
38
39
- **port** (*Optional*): The port of your Panasonic Viera TV. Defaults to `55000`
39
40
- **name** (*Optional*): The name you would like to give to the Panasonic Viera TV.
Copy file name to clipboardExpand all lines: source/_components/notify.html5.markdown
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ Chrome supports notification actions, which are configurable buttons that arrive
71
71
"actions": [
72
72
{
73
73
"action": "open",
74
-
"icon": "/static/icons/favicon-192x192.png"
74
+
"icon": "/static/icons/favicon-192x192.png",
75
75
"title": "Open Home Assistant"
76
76
},
77
77
{
@@ -85,7 +85,7 @@ Chrome supports notification actions, which are configurable buttons that arrive
85
85
86
86
#### {% linkable_title Data %}
87
87
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).
Copy file name to clipboardExpand all lines: source/_components/notify.nma.markdown
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -30,8 +30,8 @@ notify:
30
30
Configuration variables:
31
31
32
32
- **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.
34
34
35
-
Details for the (API)[https://www.notifymyandroid.com/api.jsp].
35
+
Details for the [API](https://www.notifymyandroid.com/api.jsp).
36
36
37
37
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
0 commit comments