From 254d8d4cad4b1259c4c934da87ccefafe22248c0 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Sun, 10 Nov 2019 11:59:32 -0800 Subject: [PATCH 01/12] 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 0116385285cb..ca23293be17c 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 Ass 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 "smoke". 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: From 2a65cec63a3980ee186692beac2b10bfd131c442 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Sun, 10 Nov 2019 12:15:13 -0800 Subject: [PATCH 02/12] Update totalconnect.markdown --- source/_integrations/totalconnect.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index ca23293be17c..a5366d040640 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -27,7 +27,7 @@ The `triggered` state also provides a state attribute called `triggered_source` 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 "smoke". 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. +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 From 9df0b2894fd84c2dfb9b77e21248c77300ba5cf3 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Sun, 23 Feb 2020 16:05:11 -0800 Subject: [PATCH 03/12] Update totalconnect.markdown Supports https://github.com/home-assistant/home-assistant/pull/32126 --- source/_integrations/totalconnect.markdown | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 2b2ab3d5c479..e29f66bfd0a5 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -31,7 +31,9 @@ The TotalConnect API has limited zone type information. Home Assistant device c ## Configuration -To enable TotalConnect, add the following lines to your `configuration.yaml`: +To enable TotalConnect via the user interface, go to Configuration > Integrations > the "plus" button > Total Connect. + +To enable TotalConnect via `configuration.yaml` add the following lines: ```yaml totalconnect: @@ -40,10 +42,6 @@ totalconnect: ``` {% configuration %} -name: - description: Name of device in Home Assistant. - required: false - type: string username: description: Username used to sign into the TotalConnect app/web client. required: true From 302cece73d2c01ec0c36933ce7d38f4c0bd9c5d1 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Mon, 24 Feb 2020 01:53:25 +0100 Subject: [PATCH 04/12] :pencil2: Tweak --- source/_integrations/totalconnect.markdown | 43 ++++++++++++---------- 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index e29f66bfd0a5..88bad6f63847 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -6,32 +6,18 @@ ha_category: - Alarm - Binary Sensor ha_release: 0.42 +ha_config_flow: true --- The `totalconnect` integration provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies. -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 - -## 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. +## Configuration -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. +### Via the frontend -## Configuration +To enable TotalConnect via the user interface, go to **Configuration** > **Integrations** > the "plus" button > Total Connect. -To enable TotalConnect via the user interface, go to Configuration > Integrations > the "plus" button > Total Connect. +### Via the configuration file To enable TotalConnect via `configuration.yaml` add the following lines: @@ -78,3 +64,22 @@ automation: service: scene.turn_on entity_id: scene.OnArmedAway ``` + +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 + +## 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. From 7841bed5b920b7d8f8a0320ed877912ccb6971e7 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Thu, 5 Mar 2020 19:38:07 -0800 Subject: [PATCH 05/12] Update totalconnect.markdown Remove configuration by YAML since it is no longer supported. --- source/_integrations/totalconnect.markdown | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 88bad6f63847..9aec30b40064 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -13,19 +13,9 @@ The `totalconnect` integration provides connectivity with the Honeywell TotalCon ## Configuration -### Via the frontend - To enable TotalConnect via the user interface, go to **Configuration** > **Integrations** > the "plus" button > Total Connect. -### Via the configuration file - -To enable TotalConnect via `configuration.yaml` add the following lines: - -```yaml -totalconnect: - username: YOUR_USERNAME - password: YOUR_PASSWORD -``` +The configuration file is no longer supported. Remove your `totalconnect` entry from configuration.yaml. {% configuration %} username: From 48df74db0d701740c82525307a78b996e7d3346a Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Thu, 5 Mar 2020 20:20:17 -0800 Subject: [PATCH 06/12] Update totalconnect.markdown Fixed conflict --- source/_integrations/totalconnect.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 9aec30b40064..77aa35d7440f 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -7,6 +7,8 @@ ha_category: - Binary Sensor ha_release: 0.42 ha_config_flow: true +ha_codeowners: + - '@austinmroczek' --- The `totalconnect` integration provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies. From fcecf5b9696cdc86b9d10d866dbd0dee16670bbe Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Thu, 5 Mar 2020 21:22:44 -0800 Subject: [PATCH 07/12] Fix textlint error --- source/_integrations/totalconnect.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 77aa35d7440f..25927d1773a4 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -17,7 +17,7 @@ The `totalconnect` integration provides connectivity with the Honeywell TotalCon To enable TotalConnect via the user interface, go to **Configuration** > **Integrations** > the "plus" button > Total Connect. -The configuration file is no longer supported. Remove your `totalconnect` entry from configuration.yaml. +The configuration file is no longer supported. Remove your `totalconnect` entry from your configuration file. {% configuration %} username: From 3bf9983d05e80689c27a8fe81a8c642808625e8a Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Fri, 6 Mar 2020 07:44:22 -0800 Subject: [PATCH 08/12] removed white space. --- source/_integrations/totalconnect.markdown | 5 ----- 1 file changed, 5 deletions(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 25927d1773a4..72ed78f51a10 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -10,11 +10,9 @@ ha_config_flow: true ha_codeowners: - '@austinmroczek' --- - The `totalconnect` integration provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies. ## Configuration - To enable TotalConnect via the user interface, go to **Configuration** > **Integrations** > the "plus" button > Total Connect. The configuration file is no longer supported. Remove your `totalconnect` entry from your configuration file. @@ -33,7 +31,6 @@ password: You are highly encouraged to create a Total Connect user account specifically for Home Assistant. It should not have full administrative privileges. ## Automation example - ```yaml automation: - alias: "Alarm: Disarmed Daytime" @@ -60,7 +57,6 @@ automation: 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`. @@ -71,7 +67,6 @@ The `triggered` state also provides a state attribute called `triggered_source` - `Carbon Monoxide` is when carbon monoxide is detected ## 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. From 9488d14775ced93629e8aa3a660ae2f7416b0e43 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 6 Mar 2020 23:55:34 +0100 Subject: [PATCH 09/12] :pencil2: Tweak --- source/_integrations/totalconnect.markdown | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 72ed78f51a10..72a6aad9a888 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -10,9 +10,11 @@ ha_config_flow: true ha_codeowners: - '@austinmroczek' --- + The `totalconnect` integration provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies. ## Configuration + To enable TotalConnect via the user interface, go to **Configuration** > **Integrations** > the "plus" button > Total Connect. The configuration file is no longer supported. Remove your `totalconnect` entry from your configuration file. @@ -57,16 +59,19 @@ automation: 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 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 ## 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. +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. From 2a7e483824364dad38fe7dbc2fa6583cf6c37518 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Fri, 6 Mar 2020 16:26:16 -0800 Subject: [PATCH 10/12] Un-do the breaking change. Configuration.yaml is still allowed. --- source/_integrations/totalconnect.markdown | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 72a6aad9a888..cd6758343ae1 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -17,7 +17,12 @@ The `totalconnect` integration provides connectivity with the Honeywell TotalCon To enable TotalConnect via the user interface, go to **Configuration** > **Integrations** > the "plus" button > Total Connect. -The configuration file is no longer supported. Remove your `totalconnect` entry from your configuration file. +To enable TotalConnect via `configuration.yaml` add the following lines: +```yaml +totalconnect: + username: !secret your_username + password: !secret your_password +``` {% configuration %} username: From 3d5b41e7ab7ae4286a9614facaec21b4e656fce7 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Mon, 13 Apr 2020 22:02:06 -0700 Subject: [PATCH 11/12] Update source/_integrations/totalconnect.markdown Co-Authored-By: Franck Nijhof --- source/_integrations/totalconnect.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index cd6758343ae1..8b02d8322cd1 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -20,8 +20,8 @@ To enable TotalConnect via the user interface, go to **Configuration** > **Integ To enable TotalConnect via `configuration.yaml` add the following lines: ```yaml totalconnect: - username: !secret your_username - password: !secret your_password + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` {% configuration %} From 69ec851f2d420deb412810b01590dd4e3a66e983 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Mon, 13 Apr 2020 22:02:22 -0700 Subject: [PATCH 12/12] Update source/_integrations/totalconnect.markdown Co-Authored-By: Franck Nijhof --- source/_integrations/totalconnect.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 8b02d8322cd1..af113747aff9 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -18,6 +18,7 @@ The `totalconnect` integration provides connectivity with the Honeywell TotalCon To enable TotalConnect via the user interface, go to **Configuration** > **Integrations** > the "plus" button > Total Connect. To enable TotalConnect via `configuration.yaml` add the following lines: + ```yaml totalconnect: username: YOUR_USERNAME