Sonos Cloud API - Better alerts & TTS

IZ13 · June 19, 2022, 4:08pm

wow. I feel dumb now. THANK YOU. I somehow cross named them. ( Was aware they are different, and named them differently intentionally - but somehow mixed up my naming convention )

iway · June 28, 2022, 3:25pm

For anyone using the great Google Cloud TTS with this, this is how it works, even for selecting language, voices, …:

service: media_player.play_media
data:
entity_id: media_player.yourplayer
media_content_id: >-
media-source://tts/google_cloud?language=de-DE&voice=de-DE-Wavenet-B&message=Your_text_here
media_content_type: music
extra:
volume: 30
play_on_bonded: true or false

Replace de-DE-Wavenet-B with your Google voice of choice.

You can say the content of an entity with this:
media-source://tts/google_cloud?language=de-DE&voice=de-DE-Wavenet-B&message=’{{
states.sensor.yoursensorhere.state }}’

eltonline · August 4, 2022, 7:27am

Since upgrading to HA 2022.6 and Sonos Cloud 0.3.0, I’ve had a few times when the integration suddenly stops working with error message “invalid access token”.

The first time it happened, I noticed log message “…Application Credentials have been imported and can be removed from configuration.yaml” - so I removed them. This didnt fix the issue so I deleted the integration (and restarted HA just in case). When I added the integration again, I wasnt prompted to enter a client ID or key (even after deleting from configuration.yaml and deleting the integration). But it remember them and the problem was fixed.

Today it failed again, after working fine for about 2 weeks.

2022-08-04 17:54:59.500 ERROR (MainThread) [custom_components.sonos_cloud] Household request failed (401): {"fault":{"faultstring":"Invalid Access Token","detail":{"errorcode":"keymanagement.service.invalid_access_token"}}}

This time I deleted the integration, then created new credentials in Sonos Dev account (even though the old ones hadn’t changed). When adding the integration again, it STILL didn’t ask for client credentials so I was forced to enter the new client ID and key in configuration.yaml. Now its working again.

Has anyone else had this problem after upgrading from configuration.yaml version?
Where are the client ID and key stored now and is there any way to delete them?

Thanks.

Eoin · August 4, 2022, 8:09am

I’ve had that a few times now as well, no particular pattern identified. On each occasion I have removed the Integration, rebooted and then re-added it. This has always prompted to re-authentication which I have done with the original details. Interesting I’m being prompted to re-authenticate and your not…

One difference is I have the client credentials commented out in my configuration.yaml

jjlawren · August 4, 2022, 1:24pm

It’s definitely not obvious, but they’re on the Integrations page hidden behind the top-right “…” button as “Application Credentials”:

This will hold the credentials imported from configuration.yaml or ones you add during the new onboarding flow.

I haven’t hit these 401 errors myself and I’m wondering if they’re transient. If you leave the credentials as-is and wait some time, does login with the same credentials later succeed?

systex · August 4, 2022, 3:43pm

I have this issue too, starting with the same upgrade to Sonos Cloud 0.3.0.

It does not start working again if I wait, at least after 24 hours.

Edit: I created a fresh Sonos Developer API key and deleted/reinstalled the integration. We’ll see how long it lasts…

eltonline · August 5, 2022, 11:16am

Thanks @jjlawren. I wasn’t aware HA stored OAuth credentials there. Makes perfect sense now.

To answer your question, both times when it stopped working I left it for about 24 hours and it continued to fail. So it doesnt appear to be transient and has been 100% reliable for many days leading up to those moments.

The first time I used the same OAuth credentials to get it working again, so I’m not sure where the 401 is coming from. Maybe HA itself? Let me know if you want me to enable verbose logging or check anything if it happens again. Happy to help because this is the best Sonos integration by far.

eltonline · August 5, 2022, 11:32am

Interesting. To clarify, after re-adding I was not prompted for the Sonos Dev Application credentials, but I was prompted for my main Sonos Account credentials. Next time I can try deleting the OAuth credentials from the Application Credentials page. Then I’ll see how long it lasts if the credentials aren’t imported from config.yaml.

jtayl0r · October 1, 2022, 4:55am

That’s pretty crappy. The native TTS is awesome and volume control would be a pretty dang useful feature when trying to use Sonos speakers for system announcements. Boo.

jjlawren · October 1, 2022, 5:33am

That’s a very old comment you’re replying to. Check out the examples for how to accomplish this today.

JustinFromAL · November 2, 2022, 2:32pm

This integration rocks, thanks for your hard work!

We like to have parties around sporting events and I’m using this to play music during commercial breaks/after scores/etc. It really ups the atmosphere! I basically created a “Soundboard” tab and can pick from what I’d like to hear.

One question though, is there a way to make an “interrupt” button? Sometimes I’ll start a song and the game will quickly come back from commercial and I don’t have a way to stop the playing media and return to the TV audio.

jjlawren · November 2, 2022, 3:28pm

The API states that currently playing alerts can be interrupted by followup calls. Perhaps try to play an “empty” alert to cancel what’s playing?

scott.parmenter · November 5, 2022, 2:57pm

@jjlawren I’m also seeing the “Invalid Access Token” error. I can’t pinpoint when it happens, but the error does not repeat and the integration works on subsequent attempts to use SONOS cloud. Seems to be occurring after a long (~8 hours) of no use of the integration.
Your comment mentions the use of the Application Credentials in the configuration.yaml file… I don’t have the credentials there. Just in the integration setup section of HA. Should the credentials be referenced in the configuration.yaml file?

jjlawren · November 6, 2022, 3:58am

Not sure I can make any guesses besides it being a transient issue with the cloud service.

No, that’s just old info from before the HA credentials store existed.

sebby · November 11, 2022, 3:24pm

I just loaded this integration, but can’t get it to work via a service call. this is what i am using:

service: media_player.play_media
data:
  entity_id: media_player.living_room_sonos_cloud
  media_content_id: media-source://google_cloud_say?lanaguage=en-GB&voice=en-GB-Standard-F&message=Testing Sonos text to speech
  media_content_type: music
  extra:
    volume: 50

I can call this service, and i get no errors in the log, but i also don’t get any voice on the sonos. If i go to the media tab and select google cloud TTS using the same media player as an output i do get playback on the sonos. I have tried the message with and without single quotes. anyone have any ideas?

Eoin · November 11, 2022, 11:33pm

Try something like this:

service: tts.google_cloud_say
data:
  entity_id: media_player.living_room_sonos_cloud
  message: Testing Sonos text to speech
  language: en-GB

sebby · November 12, 2022, 12:07am

thanks, that works, but… it doesn’t give me the options to set volume like in the play_media call. basically i was following the third example at https://github.com/jjlawren/sonos_cloud#examples

Eoin · November 12, 2022, 12:22am

This isn’t what your looking for but will work, go to the media_player.living_room_sonos_cloud entity and set the volume there, once set on the entity any time it’s called it will use that volume.

jjlawren · November 12, 2022, 12:30am

The format looks wrong. Try media-source://tts/google?... as the media_content_id.

sebby · November 12, 2022, 11:46am

that i didn’t know, thank you!