From e6cfdcd6b6b72f1a552ad9411e01cb4816e4eddc Mon Sep 17 00:00:00 2001 From: Aaron Bach Date: Thu, 29 Apr 2021 19:03:15 -0600 Subject: [PATCH] Remove SimpliSafe websocket documentation (#17643) --- source/_integrations/simplisafe.markdown | 83 +----------------------- 1 file changed, 2 insertions(+), 81 deletions(-) diff --git a/source/_integrations/simplisafe.markdown b/source/_integrations/simplisafe.markdown index 690d7171465..b22e33db76c 100644 --- a/source/_integrations/simplisafe.markdown +++ b/source/_integrations/simplisafe.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - **Freeze Sensor**: reports on the freeze sensor temperature*. - **Glass Break Sensor**: reports on the glass breakage sensor status*. - **Lock**: reports on `Door Locks` and can be used to lock and unlock a lock. -- **Motion Sensor**: triggers [events](#events) if the alarm is armed or if secret alerts are enabled in SimpliSafe. +- **Motion Sensor**: reports on motion detected. - **Siren**: reports on the siren status*. - **Smoke Detector**: reports on the smoke sensor status*. - **Water Sensor**: reports on water sensor status*. @@ -45,8 +45,7 @@ entity. ### `simplisafe.clear_notifications` Clear any existing notifications within the SimpliSafe cloud; this will mark existing -notifications as "read" in the SimpliSafe web and mobile apps, as well as prevent them -from triggering future `SIMPLISAFE_NOTIFICATION` events. +notifications as "read" in the SimpliSafe web and mobile apps. ### `simplisafe.remove_pin` @@ -89,81 +88,3 @@ 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 - -### `SIMPLISAFE_EVENT` - -`SIMPLISAFE_EVENT` events represent events that appear on the timeline of the SimpliSafe -web and mobile apps. When received, they 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 someone rings the doorbell, a -`SIMPLISAFE_EVENT` event will fire with the following event data: - -```python -{ - "event_type": "SIMPLISAFE_EVENT", - "data": { - "last_event_changed_by": "", - "last_event_type": "doorbell_detected", - "last_event_info": "Someone is at your \"Front Door\"", - "last_event_sensor_name": "Front Door", - "last_event_sensor_serial": "", - "last_event_sensor_type": "doorbell", - "system_id": [systemid], - "last_event_timestamp": "2021-01-28T22:01:32+00:00" - }, - "origin": "LOCAL", - "time_fired": "2021-01-28T22:01:37.478539+00:00", - "context": { - "id": "[id]", - "parent_id": null, - "user_id": null - } -} -``` - -`last_event_type` can have the following values: - -* `camera_motion_detected` -* `doorbell_detected` -* `entry_detected` -* `motion_detected` - -To build an automation using one of these, use `SIMPLISAFE_EVENT` -as an event trigger, with `last_event_type` as the `event_data`. -For example, the following will trigger when the doorbell rings: - -```yaml -trigger: - - platform: event - event_type: SIMPLISAFE_EVENT - event_data: - last_event_type: doorbell_detected -``` - -### `SIMPLISAFE_NOTIFICATION` - -`SIMPLISAFE_NOTIFICATION` events represent system notifications that would appear in the -messages section of the SimpliSafe web and mobile apps. When received, they come with -event data that contains the following keys: - -* `category`: The notification category (e.g., `error`) -* `code`: The SimpliSafe code for the notification -* `message`: The actual text of the notification -* `timestamp`: The UTC timestamp of the notification - -Note that when Home Assistant restarts, `SIMPLISAFE_NOTIFICATION` events will fire once -again for any notifications still active in the SimpliSafe web and mobile apps. To -prevent this, either (a) clear them in the web/mobile app or (b) utilize the -`simplisafe.clear_notifications` service described above.