From 37aced25852ab5d490b4522adf38b6e0c93bd69b Mon Sep 17 00:00:00 2001 From: Dom Date: Fri, 7 Sep 2018 11:23:08 +0100 Subject: [PATCH] Yale Smart Alarm component docs (#6176) * Add New Yale Smart Alarm Component Documentation * Update Yale Alarm Documentation --- ...rm_control_panel.yale_smart_alarm.markdown | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 source/_components/alarm_control_panel.yale_smart_alarm.markdown diff --git a/source/_components/alarm_control_panel.yale_smart_alarm.markdown b/source/_components/alarm_control_panel.yale_smart_alarm.markdown new file mode 100644 index 00000000000..f2dc607b157 --- /dev/null +++ b/source/_components/alarm_control_panel.yale_smart_alarm.markdown @@ -0,0 +1,60 @@ +--- +layout: page +title: "Yale Smart Alarm Control" +description: "Instructions on how to integrate Yale Smart Alarms into Home Assistant." +date: 2018-09-01 11:11 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Alarm +ha_release: 0.78 +--- + +The `yale_smart_alarm` platform 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`. +Currently only one alarm is supported. + + +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 variables: + +- **name** (*Optional*): Name of device in Home Assistant. +- **username** (*Required*): Username used to sign into the Yale app/web client. +- **password** (*Required*): Password used to sign into the Yale app/web client. +- **area_id** (*Optional*): Area ID of the device when talking to Yale's API if required ('1' by default). + +Automation example: + +```yaml +automation: + - alias: "Alarm: Disarmed Daytime" + trigger: + platform: state + entity_id: alarm_control_panel.yale_smart_alarm + to: 'disarmed' + condition: + condition: sun + before: sunset + action: + service: scene.turn_on + entity_id: scene.OnDisarmedDaytime + - alias: "Alarm: Armed Away" + trigger: + platform: state + entity_id: alarm_control_panel.yale_smart_alarm + to: 'armed_away' + action: + service: scene.turn_on + entity_id: scene.OnArmedAway +```