mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-07 17:36:50 +00:00
Update TotalConnect for config flow (#12171)
* Update totalconnect.markdown * Update totalconnect.markdown * Update totalconnect.markdown Supports https://github.com/home-assistant/home-assistant/pull/32126 * ✏️ Tweak * Update totalconnect.markdown Remove configuration by YAML since it is no longer supported. * Update totalconnect.markdown Fixed conflict * Fix textlint error * removed white space. * ✏️ Tweak * Un-do the breaking change. Configuration.yaml is still allowed. * Update source/_integrations/totalconnect.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Update source/_integrations/totalconnect.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Austin Mroczek
GitHub
parent
879e2ecf3d
commit
e0831e1008
@ -5,6 +5,7 @@ ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
ha_release: 0.42
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@austinmroczek'
|
||||
ha_domain: totalconnect
|
||||
@ -12,28 +13,11 @@ ha_domain: totalconnect
|
||||
|
||||
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.
|
||||
|
||||
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 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:
|
||||
@ -42,10 +26,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
|
||||
@ -59,7 +39,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"
|
||||
@ -82,3 +61,23 @@ 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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user