Update SimpliSafe docs for new service structure (#20066)

This commit is contained in:
Aaron Bach 2021-12-02 13:01:57 -07:00 committed by GitHub
parent f9a8396d6d
commit b768b91761
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -74,10 +74,6 @@ Copy/paste this code parameter into Home Assistant to finish setting up the inte
## Services ## Services
Note that the `system_id` parameter required by the below service calls can be discovered
by looking at the device state attributes for the integration's `alarm_control_panel`
entity.
### `simplisafe.clear_notifications` ### `simplisafe.clear_notifications`
Clear any existing notifications within the SimpliSafe cloud; this will mark existing Clear any existing notifications within the SimpliSafe cloud; this will mark existing
@ -90,7 +86,6 @@ Remove a SimpliSafe PIN (by label or PIN value).
| Service Data Attribute | Optional | Description | | Service Data Attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------- | | ---------------------- | -------- | -------------------------------- |
| `system_id` | no | The ID of a SimpliSafe system |
| `label_or_pin` | no | The PIN label or value to remove | | `label_or_pin` | no | The PIN label or value to remove |
### `simplisafe.set_pin` ### `simplisafe.set_pin`
@ -99,7 +94,6 @@ Set a SimpliSafe PIN.
| Service Data Attribute | Optional | Description | | Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------- | | ---------------------- | -------- | ------------------------------------------- |
| `system_id` | no | The ID of the system to remove the PIN from |
| `label` | no | The label to show in the SimpliSafe UI | | `label` | no | The label to show in the SimpliSafe UI |
| `pin` | no | The PIN value to use | | `pin` | no | The PIN value to use |
@ -107,16 +101,8 @@ Set a SimpliSafe PIN.
Set one or more system properties. Set one or more system properties.
For any property denoting a volume, the following values should be used:
* Off: `0`
* Low: `1`
* Medium: `2`
* High: `3`
| Service Data Attribute | Optional | Description | | Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------------------------------- |
| `system_id` | no | The ID of a SimpliSafe system |
| `alarm_duration` | yes | The number of seconds a triggered alarm should sound | | `alarm_duration` | yes | The number of seconds a triggered alarm should sound |
| `chime_volume` | yes | The volume of the door chime | | `chime_volume` | yes | The volume of the door chime |
| `entry_delay_away` | yes | The number of seconds to delay triggering when entering with an "away" state | | `entry_delay_away` | yes | The number of seconds to delay triggering when entering with an "away" state |