jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move variable description

Browse Source
This commit is contained in:
Fabian Affolter 2016-09-07 09:41:40 +02:00
parent 7278cd96dc
commit e96e888306
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 24 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
source/_components/envisalink.markdown
View File

@ -10,10 +10,10 @@ footer: true
logo: eyezon.png
ha_category: Alarm
ha_release: 0.23
ha_iot_class: "Local Push"
---
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.
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.
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.
Please visit the [eyezon website](http://www.eyezon.com/) for further information about the evl3 and evl4 boards.
@ -23,54 +23,45 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](/components/sensor.envisalink/): Emulates an alpha-numeric keypad attached to the alarm panel
- [Alarm Control Panel](/components/alarm_control_panel.envisalink/): Reports on partition status, and can be used to arm/disarm the system
This is a fully event-based component- any event sent by the Envisalink device will be immediately reflected within Home Assistant.
## Configuration
This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.
An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required:
### Required Parameters
- **host**: The IP address of the Envisalink device on your home network.
- **panel_type**: `HONEYWELL` or `DSC`, depending upon which alarm system you have.
- **user_name**: Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same.
- **password**: Which password to authenticate with when connecting to the device.
- **code**: Your alarm panel's code, for authenticating user input during arm/disarm.
### Optional Parameters
- **port**: Which network port to connect with. Default: `4025`
- **evl_version**: 3 for evl3, or 4 for evl4. Default: `3`
- **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
- **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`
- **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.*
- **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.
#### Example
```yaml
# Example configuration.yaml entry
envisalink:
#optional
host: <envisalink IP address>
panel_type: HONEYWELL or DSC
user_name: YOUR_USERNAME
password: YOUR_PASSWORD
code: '1234'
port: 4025
evl_version: 3
keepalive_interval: 60
zonedump_interval: 30
#required
host: <envisalink IP address>
panel_type: HONEYWELL or DSC
user_name: <pass>
password: <pass>
code: '1234'
zones:
11:
name: 'Back Door'
type: 'opening'
21:
name: 'First Floor Motion'
type: 'motion'
partitions:
1:
name: 'Home Alarm'
```
Configuration variables:
- **host** (*Required*): The IP address of the Envisalink device on your home network.
- **panel_type** (*Required*): `HONEYWELL` or `DSC`, depending upon which alarm system you have.
- **user_name** (*Required*): Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same.
- **password** (*Required*): Which password to authenticate with when connecting to the device. EVL3 only works with max. 6 characters.
- **code** (*Required*): Your alarm panel's code, for authenticating user input during arm/disarm.
- **port** (*Optional*): Which network port to connect with. Default: `4025`
- **evl_version** (*Optional*): 3 for evl3, or 4 for evl4. Default: `3`
- **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.
- **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`
- **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.*
- **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.