jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for SimpliSafe events (#12081)

Browse Source 
* Add documentation for SimpliSafe events

* Restrict which events get fired (per code review)

* Code review comments from parent PR
This commit is contained in:
Aaron Bach 2020-02-14 11:25:14 -07:00 committed by GitHub
parent 6a460da759
commit bb94b7b687
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/_integrations/simplisafe.markdown
View File

@ -92,3 +92,41 @@ For any property denoting a volume, the following values should be used:
| `exit_delay_home` | yes | The number of seconds to delay triggering when exiting with a "home" state | | `exit_delay_home` | yes | The number of seconds to delay triggering when exiting with a "home" state |
| `light` | yes | Whether the light on the base station should display when armed | | `light` | yes | Whether the light on the base station should display when armed |
| `voice_prompt_volume` | yes | The volume of the base station's voice prompts | | `voice_prompt_volume` | yes | The volume of the base station's voice prompts |
## Events
Automations can listen for `SIMPLISAFE_EVENT` events. Anytime one of these events is
received, it will come with event data that contains the following keys:
* `changed_by`: the PIN that triggered the event (if appropriate)
* `event_type`: the type of event
* `info`: a human-friendly string describing the event in more detail
* `sensor_name`: the sensor that triggered the event (if appropriate)
* `sensor_serial`: the serial number of the sensor that triggered the event (if appropriate)
* `sensor_type`: the type of sensor that triggered the event (if appropriate)
* `system_id`: the system ID to which the event belongs
* `timestamp`: the UTC datetime at which the event was received
For example, when the system is armed by "remote" means (via the web app, etc.), a
`SIMPLISAFE_EVENT` event will fire with the following event data:
```python
{
"changed_by": "",
"event_type": "armed_home",
"info": "System Armed (Home) by Remote Management",
"sensor_name": "",
"sensor_serial": "",
"sensor_type": "remote",
"system_id": 123456,
"timestamp": datetime.datetime(2020, 2, 13, 23, 1, 13, tzinfo=<UTC>),
}
```
`event_type`, being one of the key fields automations might be built from, can have the
following values:
* `camera_motion_detected`
* `doorbell_detected`
* `entry_detected`
* `motion_detected`