Describe Sonos feature switches (#18897)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
jjlawren 2021-10-23 16:12:04 -05:00 committed by GitHub
parent 99b3511c31
commit dd6ead1dff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -25,6 +25,19 @@ The `sonos` integration allows you to control your [Sonos](https://www.sonos.com
{% include integrations/config_flow.md %}
## Feature controls
Speaker-level features are exposed as `switch` entities which allow direct control and indicate if the features are currently enabled.
- **All devices**: Crossfade, Status Light, Touch Controls
- **Home theater devices**: Night Sound & Speech Enhancement
<div class='note info'>
The Crossfade, Status Light, and Touch Controls entities are disabled by default, but can be enabled via the Sonos device page.
</div>
## Battery support
Battery sensors are fully supported for the `Sonos Roam` and `Sonos Move` devices on S2 firmware. `Sonos Move` speakers still on S1 firmware are supported but may update infrequently.
@ -181,21 +194,6 @@ Update an existing Sonos alarm.
| `enabled` | yes | Boolean for whether or not to enable this alarm.
| `include_linked_zones` | yes | Boolean that defines if the alarm also plays on grouped players.
### Service `sonos.set_option`
Set Sonos speaker options.
Night Sound and Speech Enhancement modes are only supported when playing from the TV source of products like Sonos Playbar and Sonos Beam. Other speaker types will ignore these options.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s that will have their options set.
| `buttons_enabled` | yes | Boolean to control the functioning of hardware buttons on the device.
| `crossfade` | yes | Boolean to control crossfading between songs.
| `night_sound` | yes | Boolean to control Night Sound mode.
| `speech_enhance` | yes | Boolean to control Speech Enhancement mode.
| `status_light` | yes | Boolean to control the Status (LED) Light.
### Service `sonos.play_queue`
Starts playing the Sonos queue.