Add notes on Sonos mic sensor, descriptions of additional entities (#20976)

This commit is contained in:
jjlawren 2022-01-04 11:45:50 -06:00 committed by GitHub
parent da8d0af6ec
commit 8d8778296f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -28,13 +28,21 @@ The `sonos` integration allows you to control your [Sonos](https://www.sonos.com
## Feature controls & sensors ## Feature controls & sensors
Speaker-level features are exposed as `number` or `switch` entities which report current values and allow direct control. Speaker-level controls are exposed as `number` or `switch` entities. Additionally, various `sensor` and `binary_sensor` entities are provided.
- **All devices**: Bass, Treble, Crossfade, Status Light, Touch Controls ### Controllable features
- **Home theater devices**: Night Sound, Speech Enhancement, Surround Enabled, Audio Input Format (read-only)
- **All devices**: Alarms, Bass, Treble, Crossfade, Status Light, Touch Controls
- **Home theater devices**: Night Sound, Speech Enhancement, Surround Enabled
- **When paired with a sub**: Subwoofer Enabled - **When paired with a sub**: Subwoofer Enabled
## Battery support ### Sensors
- **Devices with battery**: Battery level, Power state
- **Home theater devices**: Audio Input Format
- **Voice-enabled devices**: Microphone Enabled
### Battery support notes
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. 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.
@ -46,10 +54,14 @@ The battery sensors rely on working change events or updates will be delayed. S1
</div> </div>
## Alarm support ### Alarm support notes
The Sonos integration adds one `switch` for each alarm set in the Sonos app. The alarm switches are detected, deleted and assigned automatically and come with several attributes that help to monitor Sonos alarms. The Sonos integration adds one `switch` for each alarm set in the Sonos app. The alarm switches are detected, deleted and assigned automatically and come with several attributes that help to monitor Sonos alarms.
### Microphone support notes
The microphone can only be enabled/disabled from physical buttons on the Sonos device and cannot be controlled from Home Assistant. A `binary_sensor` reports its current state.
## Playing media ## Playing media
Sonos accepts a variety of `media_content_id` formats in the `media_player.play_media` service, but most commonly as URIs. For example, both Spotify and Tidal share links can be provided as-is. Playback of [music hosted on a Plex server](/integrations/plex#sonos-playback) is possible. Direct HTTP/HTTPS links to local or remote media files can also be used if the Sonos device can reach the URI directly, but specific media encoding support may vary. Sonos accepts a variety of `media_content_id` formats in the `media_player.play_media` service, but most commonly as URIs. For example, both Spotify and Tidal share links can be provided as-is. Playback of [music hosted on a Plex server](/integrations/plex#sonos-playback) is possible. Direct HTTP/HTTPS links to local or remote media files can also be used if the Sonos device can reach the URI directly, but specific media encoding support may vary.