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-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update AlarmDecoder component configuration (#7079)

Browse Source 
* Update AlarmDecoder component configuration

* 🚑 Fix error

* 🚑 Fix the byte variable
This commit is contained in:
Klaas Schoute 2018-10-25 23:04:37 +02:00 committed by Franck Nijhof
parent 4badbe3bf9
commit a803267730
1 changed files with 65 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
source/_components/alarmdecoder.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.43
ha_iot_class: "Local Push"
---
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its 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 Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its 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 Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices.
@ -34,7 +34,7 @@ alarmdecoder:
type: socket
host: 192.168.1.20
port: 10000
panel_display: On
panel_display: false
zones:
01:
name: 'Smoke Detector'
@ -45,15 +45,66 @@ alarmdecoder:
type: 'opening'
```
Configuration variables:
- **type** (*Required*): The type of AlarmDecoder device: socket, serial or USB
- **host** (*Optional*): The IP address of the AlarmDecoder device on your home network, if using socket type. Default: `localhost`
- **port** (*Optional*): The port of the AlarmDecoder device on your home network, if using socket type. Default: `10000`
- **path** (*Optional*): The path of the AlarmDecoder device, if using socket type. Default: `/dev/ttyUSB0`
- **baudrate** (*Optional*): The baud rate of the AlarmDecoder device, if using serial type. Default: `115200`
- **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad display. Default: `off`
- **zones** (*Optional*): AlarmDecoder has 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. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
- **rfid** (*Optional*): The RF serial-number associated with RF zones. Providing this field allows Home Assistant to associate raw sensor data to a given zone, allowing direct monitoring of the state, battery, and supervision status.
- **relayaddr** (*Optional*): Address of the relay expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed.
- **relaychan** (*Optional*): Channel of the relay expander board to associate with the zone. (ex: 1, 2, 3, or 4)
{% configuration %}
device:
description: List of variables for the AlarmDecoder device.
required: true
type: list
keys:
type:
description: "The type of AlarmDecoder device: socket, serial or USB."
required: true
default: socket
type: string
host:
description: The IP address of the AlarmDecoder device on your home network, if using socket type.
required: false
default: localhost
type: string
port:
description: The IP address of the AlarmDecoder device on your home network, if using socket type.
required: false
default: 10000
type: integer
path:
description: The path of the AlarmDecoder device, if using serial type.
required: false
default: "/dev/ttyUSB0"
type: string
baudrate:
description: The baud rate of the AlarmDecoder device, if using serial type.
required: false
default: 115200
type: string
panel_display:
description: Create a sensor called sensor.alarm_display to match the Alarm Keypad display.
required: false
default: false
type: boolean
zones:
description: "AlarmDecoder has 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. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*"
required: false
type: list
keys:
name:
description: A name for the zone.
required: true
type: string
type:
description: "A type for the zone. Here you can find a list of [Device Classes](https://www.home-assistant.io/components/binary_sensor/#device-class)."
required: false
default: opening
type: string
rfid:
description: The RF serial-number associated with RF zones. Providing this field allows Home Assistant to associate raw sensor data to a given zone, allowing direct monitoring of the state, battery, and supervision status.
required: false
type: string
relayaddr:
description: "Address of the relay expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed."
required: inclusive
type: integer
relaychan:
description: "Channel of the relay expander board to associate with the zone. (ex: 1, 2, 3, or 4)"
required: inclusive
type: integer
{% endconfiguration %}