SimpliSafe

The simplisafe integration integrates SimpliSafe home security (V2 and V3) systems into Home Assistant. Multiple SimpliSafe accounts can be accommodated.

There is currently support for the following device types within Home Assistant:

• Alarm control panel: reports on the current alarm status and can be used to arm and disarm the system.

• CO detector: reports on the carbon monoxide sensor status*.

• Entry sensor: reports on the current entry sensor status*.

• 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: reports on motion detected*.

• Siren: reports on the siren status*.

• Smoke Detector: reports on the smoke sensor status*.

• Smoke+CO Detector: reports on the smoke and carbon monoxide sensor status*.

• Water Sensor: reports on water sensor status*.

• Sensor status is only available for SimpliSafe V3 systems and is updated once every 30 seconds, so information displayed in Home Assistant may be delayed.

SimpliSafe Plans

SimpliSafe offers several monitoring plans. All plans (including the free plan) should work with this integration.

配置

要将 SimpliSafe hub 添加到您的 Home Assistant 实例中，请使用此 My 按钮：

SimpliSafe 可以被 Home Assistant 自动发现。如果发现了实例， 它将显示为 已发现。您可以立即进行设置。

Getting an Authorization Code

SimpliSafe authenticates users via its web app. Due to technical limitations, there is a manual step when adding the integration. For in-depth guidance, refer to step 6 of the simplisafe-python documentation on authentication.

Actions

simplisafe.remove_pin

Remove a SimpliSafe PIN (by label or PIN value).

simplisafe.set_pin

Set a SimpliSafe PIN.

simplisafe.system_properties

Set one or more system properties.

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:

• last_event_changed_by: the PIN that triggered the event (if appropriate)
• last_event_type: the type of event
• last_event_info: a human-friendly string describing the event in more detail
• last_event_sensor_name: the sensor that triggered the event (if appropriate)
• last_event_sensor_serial: the serial number of the sensor that triggered the event (if appropriate)
• last_event_sensor_type: the type of sensor that triggered the event (if appropriate)
• system_id: the system ID to which the event belongs
• last_event_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:

{
    "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:

• automatic_test
• camera_motion_detected
• doorbell_detected
• device_test
• secret_alert_triggered
• sensor_paired_and_named
• user_initiated_test

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:

triggers:
  - trigger: event
    event_type: SIMPLISAFE_EVENT
    event_data:
        last_event_type: doorbell_detected

Using secret alerts for sensor changes

For cases where the default polling数据轮询是定期查询设备或服务以检查更新或检索数据的过程。通过定义自定义轮询间隔，您可以控制系统检查新数据的频率，这有助于优化性能并减少不必要的网络流量。 [Learn more] interval of 30 seconds is too long for automations, you can use secret alerts to get push notifications of a sensor being triggered.

To enable secret alerts for sensor changes, follow these steps:

1. Enable the secret alert for the device in the Simplisafe App.
2. Make a note of the serial number of the device.
   • You can see it in the top-left corner of the page where you set the alert.
3. Use the following event trigger:

triggers:
  - trigger: event
    event_type: SIMPLISAFE_EVENT
    event_data:
        last_event_type: secret_alert_triggered
        last_event_sensor_serial: "abc123xyz"  # Replace with your device's serial number (use lowercase letters)

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 clear_notifications button provided by the alarm control panel.