Update yale_smart_alarm documentation (#17900)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
G Johansson 2021-07-24 21:12:54 +02:00 committed by GitHub
parent 947f485286
commit 17c8ec652f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,6 +5,9 @@ ha_category:
- Alarm
ha_release: 0.78
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@gjohanssson-ST'
ha_domain: yale_smart_alarm
ha_platforms:
- alarm_control_panel
@ -12,42 +15,12 @@ ha_codeowners:
- '@gjohansson-ST'
---
The `yale_smart_alarm` platform provides connectivity with the Yale Smart Alarm systems and Smart Hub through Yale's API.
The Yale Smart Living integration provides connectivity with the Yale Smart Alarm systems and Smart Hub through Yale's API.
This platform supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night` (duplicate of home) and `alarm_disarm`.
This platform supports the following services: `alarm_arm_away`, `alarm_arm_home` and `alarm_disarm`.
Currently only one alarm is supported.
## Configuration
To enable, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
alarm_control_panel:
- platform: yale_smart_alarm
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
name:
description: Name of device in Home Assistant.
required: false
type: string
username:
description: Username used to sign into the Yale app/web client.
required: true
type: string
password:
description: Password used to sign into the Yale app/web client.
required: true
type: string
area_id:
description: Area ID of the device when talking to Yale's API if required.
required: false
type: integer
default: 1
{% endconfiguration %}
{% include integrations/config_flow.md %}
## Automation example