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 for further information about the AlarmDecoder devices.
There is currently support for the following device types within Home Assistant:
- Binary Sensor: Reports on zone status
- Sensor: Emulates a keypad display
- Alarm Control Panel: Reports on alarm status, and can be used to arm/disarm the system
This is a fully event-based component. Any event sent by the AlarmDecoder device will be immediately reflected within Home Assistant.
alarmdecoder section must be present in the
configuration.yaml file and contain the following options as required:
# Example configuration.yaml entry alarmdecoder: device: type: socket host: 192.168.1.20 port: 10000 panel_display: false zones: 01: name: 'Smoke Detector' type: 'smoke' rfid: '0123456' 02: name: 'Front Door' type: 'opening'
(list)(Required)List of variables for the AlarmDecoder device.
(string)(Required)The type of AlarmDecoder device: socket, serial or USB.
Default value: socket
(string)(Optional)The IP address of the AlarmDecoder device on your home network, if using socket type.
Default value: localhost
(integer)(Optional)The IP address of the AlarmDecoder device on your home network, if using socket type.
Default value: 10000
(string)(Optional)The path of the AlarmDecoder device, if using serial type.
Default value: /dev/ttyUSB0
(string)(Optional)The baud rate of the AlarmDecoder device, if using serial type.
Default value: 115200
(boolean)(Optional)Create a sensor called sensor.alarm_display to match the Alarm Keypad display.
Default value: false
(list)(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 docs. Note: If no zones are specified, Home Assistant will not load any binary_sensor components.
(string)(Required)A name for the zone.
(string)(Optional)A type for the zone. Here you can find a list of Device Classes.
Default value: opening
(string)(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.
(integer)(Optional)The loop number associated with RF zones (1, 2, 3, or 4). Providing this field allows Home Assistant to read open/closed status from the raw sensor data in addition to from the panel display, meaning it can correctly show a bypassed RF zone as open or closed when the alarm is armed. (This is an alternative to relayaddr/relaychan below for RF zones.)
(integer)(Inclusive)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.
(integer)(Inclusive)Channel of the relay expander board to associate with the zone. (ex: 1, 2, 3, or 4)