From 78af8f9c23ff89b4ed897f7be8161e9d418e6120 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Mon, 3 Feb 2020 02:36:24 -0800 Subject: [PATCH] Add functions to TotalConnect (#11160) * Update totalconnect.markdown * Update totalconnect.markdown --- source/_integrations/totalconnect.markdown | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index bba1396b5e1..2b2ab3d5c47 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -4,23 +4,34 @@ description: Instructions on how to integrate TotalConnect alarms into Home Assi logo: honeywell-tc.png ha_category: - Alarm + - Binary Sensor ha_release: 0.42 --- -The `totalconnect` platform provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies. +The `totalconnect` integration provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies. -This platform supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night` and `alarm_disarm`. +If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Raspbian, run the command `apt install libxml2-dev libxmlsec1-dev` with sudo. + +## Alarm Control Panel + +The integration provides an Alarm Control Panel for each TotalConnect location. It uses the name of your location from TotalConnect. For example, if your location name in TotalConnect is "Home", then you will get `alarm_control_panel.home` in Home Assistant. + +The alarm control panel supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night` and `alarm_disarm`. The `triggered` state also provides a state attribute called `triggered_source` giving more detail on what triggered the alarm: - `Police/Medical` is when sensors detected a burglar and/or a person pushed the Police or Medical button - `Fire/Smoke` is when fire or smoke is detected, or a person pushed the Fire button - `Carbon Monoxide` is when carbon monoxide is detected -If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Raspbian, run the command `apt install libxml2-dev libxmlsec1-dev` with sudo. +## Binary Sensor + +The integration provides a Binary Sensor for each TotalConnect zone. To see zones in TotalConnect "fault" status, your TotalConnect account must have "Sensor Events" enabled. Your alarm monitoring company may charge an extra fee to enable this. + +The TotalConnect API has limited zone type information. Home Assistant device class `door` is assigned to TotalConnect door, window, perimeter, motion sensor, and most alarm panel buttons. The sensor will appear as `True` if the door is open (either fault or triggered in TotalConnect) and `False` otherwise. Device class `smoke` is assigned to TotalConnect smoke detectors and buttons with physical alarm panel "Response Type" setting of "Fire No Verification". The sensor will appear as `True` if smoke is detected. Device class `gas` is assigned to TotalConnect carbon monoxide detectors. The sensor will appear as `True` if gas is detected. ## Configuration -To enable this, add the following lines to your `configuration.yaml`: +To enable TotalConnect, add the following lines to your `configuration.yaml`: ```yaml totalconnect: