Document new dict format for siren.available_tones (#1016)

This commit is contained in:
Raman Gupta 2021-08-09 07:18:58 -04:00 committed by GitHub
parent 3af7ea3aaf
commit 0bccdb6fb1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -13,8 +13,8 @@ Properties should always only return information from memory and not do I/O (lik
| Name | Type | Default | Description |
| ----------------------- | ------ | ------------------------------------- | --------------------------------------------------------------------------------------- |
| is_on | bool | `NotImplementedError()` | Whether the device is on or off. |
| available_tones | list | `NotImplementedError()` | The list of available tones on the device to pass into the `turn_on` service. Requires `SUPPORT_TONES` feature. |
| is_on | bool | `NotImplementedError()` | Whether the device is on or off. |
| available_tones | list or dict | `NotImplementedError()` | The list or dictionary of available tones on the device to pass into the `turn_on` service. If a dictionary is provided, when a user uses the dict value of a tone, it will get converted to the corresponding dict key before being passed on to the integration platform. Requires `SUPPORT_TONES` feature. |
### Tones