diff --git a/source/_components/abode.markdown b/source/_components/abode.markdown index 092ca11cdc7..fc5d5d9beea 100644 --- a/source/_components/abode.markdown +++ b/source/_components/abode.markdown @@ -19,22 +19,91 @@ Please visit the [Abode website](https://goabode.com/) for further information a There is currently support for the following device types within Home Assistant: -- [Alarm Control Panel](/components/alarm_control_panel.abode/): Reports on current alarm status and can be used to arm/disarm the system -- [Binary Sensor](/components/binary_sensor.abode/): Reports on `Door Contacts` (open or closed), `Motion Camera` (motion detected or not), `Water Sensors` (detected or not), `Keypad` (online or not), `Glass Break` (online or not), `Status Display` (online or not) -- [Cover](/components/cover.abode/): Reports on `Secure Barriers` (open or closed) and can be used to open/close the cover -- [Lock](/components/cover.abode/): Reports on `Door Locks` (locked or unlocked) and can be used to lock/unlock the door -- [Switch](/components/switch.abode/): Reports on `Power Switch Sensors` (on or off) and can be used to turn the power switch sensor on/off +- [Alarm Control Panel](/components/alarm_control_panel.abode/): Reports on the current alarm status and can be used to arm and disarm the system. +- [Binary Sensor](/components/binary_sensor.abode/): Reports on `Quick Actions`, `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. +- [Camera](/components/camera.abode/): Reports on `Camera` devices and will download and show the latest captured still image. +- [Cover](/components/cover.abode/): Reports on `Secure Barriers` and can be used to open and close the cover. +- [Lock](/components/cover.abode/): Reports on `Door Locks` and can be used to lock and unlock the door. +- [Light](/components/light.abode/): Reports on `Dimmer` lights and can be used to dim, change color, or turn the light on and off. +- [Switch](/components/switch.abode/): Reports on `Power Switch` devices and can be used to turn the power switch on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them. -An `abode` section must be present in the `configuration.yaml` file and contain the following options as required: +## {% linkable_title Configuration %} + +To use Abode devices in your installation, add the following `abode` section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry abode: username: abode_username password: abode_password + name: Abode Alarm System + polling: False + exclude: + - 'ZW:0000000034' + - 'RF:00000011' + lights: + - 'ZW:0000000022' ``` Configuration variables: -- **username** (*Required*): Username for the Abode account. -- **password** (*Required*): Password for Abode account. +- **username** (*Required*): Username for your Abode account. +- **password** (*Required*): Password for your Abode account. +- **name** (*Optional*): The name for your alarm controller. +- **polling** (*Optional*): Enable polling if cloud push updating is less reliable. Will update the devices once every 30 seconds. Defaults to False. +- **exclude** (*Optional*): A list of devices to exclude from Home Assistant by their Abode `device_id`, found within the component attributes. +- **lights** (*Optional*): A list of switch devices that Home Assistant should treat as lights by the switches Abode `device_id`, found within the component attributes. + +## {% linkable_title Events %} + +There are a number of events that can be triggered from Abode. They are grouped into the below events: + +- **abode_alarm**: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms. +- **abode_alarm_end**: Fired when an alarm end event is triggered from Abode. +- **abode_automation**: Fired when an Automation is triggered from Abode. +- **abode_panel_fault**: Fired when there is a fault with the Abode hub. This includes events like loss of power, low battery, tamper switches, polling failures, and signal interference. +- **abode_panel_restore**: Fired when the panel fault is restored. + +All events have the fields: + +Field | Description +----- | ----------- +`device_id` | The Abode device ID of the event. +`device_name` | The Abode device name of the event. +`device_type` | The Abode device type of the event. +`event_code` | The event code of the event. +`event_name` | The name of the event. +`event_type` | The type of the event. +`event_utc` | The UTC timestamp of the event. +`user_name` | The Abode user that triggered the event, if applicable. +`date` | The date of the event in the format `MM/DD/YYYY`. +`time` | The time of the event in the format `HH:MM AM`. + +There is a unique list of known event_codes that can be found [here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt). + +## {% linkable_title Services %} + +### {% linkable_title Service `change_setting` %} + +Change settings on your Abode system. For a full list of settings and valid values, consult the [AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings). + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `setting` | No | The setting you wish to change. +| `value` | No | The value you wish to change the setting to. + +### {% linkable_title Service `capture_image` %} + +Request a new still image from your Abode IR camera. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | No | String or list of strings that point at `entity_id`s of Abode cameras. + +### {% linkable_title Service `trigger_quick_action` %} + +Trigger a quick action automation on your Abode system. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | No | String or list of strings that point at `entity_id`s of binary_sensors that represent your Abode quick actions. \ No newline at end of file diff --git a/source/_components/binary_sensor.abode.markdown b/source/_components/binary_sensor.abode.markdown index ba50026fb1c..14e8e14533a 100644 --- a/source/_components/binary_sensor.abode.markdown +++ b/source/_components/binary_sensor.abode.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Push" The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms. -This component will automatically add `Door Contact`, `Motion Camera`, `Water Sensor`, `Keypad`, `Glass Break`, and `Status Display` binary sensors that are configured in your Abode account. +This component will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. + +This component will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action). The requirement is that you have setup your [Abode hub](/components/abode/). diff --git a/source/_components/camera.abode.markdown b/source/_components/camera.abode.markdown new file mode 100644 index 00000000000..9a08123e1a3 --- /dev/null +++ b/source/_components/camera.abode.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "Abode Camera" +description: "Instructions how to integrate Abode cameras into Home Assistant." +date: 2017-08-26 13:28 +sidebar: true +comments: false +sharing: true +footer: true +logo: abode.jpg +ha_release: 0.52 +ha_category: Camera +ha_iot_class: "Cloud Push" +--- + +The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms. + +This component will automatically add `Cameras` configured in your Abode account. You can request a new still image capture by passing the `entity_id` of your cameras to the [capture_image service](/components/abode/#capture_image). + +The requirement is that you have setup your [Abode hub](/components/abode/). diff --git a/source/_components/light.abode.markdown b/source/_components/light.abode.markdown new file mode 100644 index 00000000000..16ff896d84e --- /dev/null +++ b/source/_components/light.abode.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "Abode Light" +description: "Instructions how to integrate Abode lights into Home Assistant." +date: 2017-08-26 13:28 +sidebar: true +comments: false +sharing: true +footer: true +logo: abode.jpg +ha_release: 0.52 +ha_category: Cover +ha_iot_class: "Cloud Push" +--- + +The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms. + +This component will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration). + +The requirement is that you have setup your [Abode hub](/components/abode/). diff --git a/source/_components/switch.abode.markdown b/source/_components/switch.abode.markdown index d0fd60e809e..8979b0e2866 100644 --- a/source/_components/switch.abode.markdown +++ b/source/_components/switch.abode.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Push" The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms. -This component will automatically add `Power Switch Sensors` configured in your Abode account. +This component will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration). + +This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations. The requirement is that you have setup your [Abode hub](/components/abode/).