Adding docs for new AlarmDecoder (#2373)

* Adding docs for new AlarmDecoder

* moved to 0.43 release, I hope
tweak usb docs
This commit is contained in:
hawk259 2017-04-21 11:59:59 -04:00 committed by Paulus Schoutsen
parent d2b167df1b
commit 982e5f9639
5 changed files with 113 additions and 0 deletions

View File

@ -0,0 +1,20 @@
---
layout: page
title: "AlarmDecoder Alarm Control Panel"
description: "Instructions how to setup the AlarmDecoder Alarm control panel within Home Assistant."
date: 2017-04-02 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: alarmdecoder.png
ha_category: Alarm
ha_release: 0.43
ha_iot_class: "Local Push"
---
The `alarmdecoder` alarm control panel platform allows you to control your [AlarmDecoder](https://www.alarmdecoder.com) alarms.
The requirement is that you have setup your [AlarmDecoder hub](/components/alarmdecoder/).

View File

@ -0,0 +1,55 @@
---
layout: page
title: "AlarmDecoder Alarm"
description: "Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an AlarmDecoder device."
date: 2017-04-02 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: alarmdecoder.png
ha_category: Alarm
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 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 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.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/components/binary_sensor.alarmdecoder/): Reports on zone status
- [Sensor](/components/sensor.alarmdecoder/): Emulates an keypad display
- [Alarm Control Panel](/components/alarm_control_panel.alarmdecoder/): 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.
An `alarmdecoder` section must be present in the `configuration.yaml` file and contain the following options as required:
```yaml
# Example configuration.yaml entry
alarmdecoder:
device:
type: socket
host: 192.168.1.20
port: 10000
panel_display: On
zones:
01:
name: 'Smoke Detector'
type: 'smoke'
02:
name: 'Front Door'
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`
- **baud** (*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 dispaly. 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.*

View File

@ -0,0 +1,20 @@
---
layout: page
title: "AlarmDecoder Binary Sensor"
description: "Instructions how to integrate AlarmDecoder binary sensors into Home Assistant."
date: 2017-04-02 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: alarmdecoder.png
ha_release: 0.43
ha_category: Binary Sensor
ha_iot_class: "Local Push"
---
The `alarmdecoder` alarm control panel platform allows you to control your [AlarmDecoder](https://www.alarmdecoder.com) alarms.
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.
The requirement is that you have setup your [AlarmDecoder hub](/components/alarmdecoder/).

View File

@ -0,0 +1,18 @@
---
layout: page
title: "AlarmDecoder Sensor"
description: "Instructions how to integrate AlarmDecoder sensors into Home Assistant."
date: 2017-04-02 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: alarmdecoder.png
ha_release: 0.43
ha_category: Sensor
ha_iot_class: "Local Push"
---
The `alarmdecoder` alarm control panel platform allows you to control your [AlarmDecoder](https://www.alarmdecoder.com) alarms.
The requirement is that you have setup your [AlarmDecoder hub](/components/alarmdecoder/).

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB