diff --git a/source/_integrations/simplisafe.markdown b/source/_integrations/simplisafe.markdown index 6a7438df916..f7b5cec6a10 100644 --- a/source/_integrations/simplisafe.markdown +++ b/source/_integrations/simplisafe.markdown @@ -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 | | `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 | + +## 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=), +} +``` + +`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`