Home Assistant custom component to start Spotify playback on an idle chromecast device or a Spotify Connect device (thanks to @kleinc80) which means that you can target your automation for chromecast as well as connect devices.
Spotcast implements a cast platform (requires Home Assistant Core 2022.2.0 or later), which enables Google Cast media player entities to play Spotify URI as well as to browse the Spotify library.
This component is not meant to be a full Spotify chromecast media_player but only serves to start the playback. Controlling the chromecast device and the Spotify playback after the initial start is done in their respective components. Because starting playback using the API requires more powerful token the username and password used for browser login is used.
Used by Spotify-Card.
This component is easiest installed using HACS.
Copy all files from custom_components/spotcast/ to custom_components/spotcast/ inside your config Home Assistant directory.
Spotcast is compatible with any version since 2021.12.0.
Note that as of v3.5.2 you must also have the official Home Assistant Spotify Integration installed and configured for this custom component to work. This is because it provides the correct device list which has the correct scopes in its token.
Spotcast uses two cookies to authenticate against Spotify in order to have access to the required services.
To obtain the cookies, these different methods can be used:
- Open a new Incognito window at
https://open.spotify.comand login to Spotify. - Press
Command+Option+I(Mac) orControl+Shift+IorF12. This should open the developer tools menu of your browser. - Go into the
applicationsection. - In the menu on the left go int
Storage/Cookies/open.spotify.com. - Find the
sp_dcandsp_keyand copy the values. - Close the window without logging out (Otherwise the cookies are made invalid).
- Open a new Incognito window at
https://open.spotify.comand login to Spotify. - Press
Command+Option+I(Mac) orControl+Shift+IorF12. This should open the developer tools menu of your browser. - Go into the
Storagesection. (You might have to click on the right arrows to reveal the section). - Select the
Cookiessub-menu and thenhttps://open.spotify.com. - Find the
sp_dcandsp_keyand copy the values. - Close the window without logging out (Otherwise the cookies are made invalid).
Add the following to your configuration.yaml:
spotcast:
sp_dc: !secret sp_dc
sp_key: !secret sp_key
country: SE #optional, added in 3.6.24Add accounts dict to the configuration and populate with a list of accounts to
be able to initiate playback using diffferent accounts than the default.
If you are using v3.5.2 or greater and thus also have the core Spotify Integration installed, then the additional accounts will also need to be added there as well for multiple accounts to work.
spotcast:
sp_dc: !secret primary_sp_dc
sp_key: !secret primary_sp_key
country: SE #optional, added in 3.6.24
accounts:
niklas:
sp_dc: !secret niklas_sp_dc
sp_key: !secret niklas_sp_key
ming:
sp_dc: !secret ming_sp_dc
sp_key: !secret ming_sp_keyPlease note: configuration.yaml is a plain text file and it is not recommended to store your passwords in this file.
By using the !secret tag you are directing Home Assistant to look inside the secrets.yaml file for your key instead.
For a single account add the following to your secrets.yaml file:
sp_dc: [your sp_dc here]
sp_key: [your sp_key here]For multiple accounts add the corresponding entries to your secrets.yaml file. For example, using the same accounts as above:
primary_sp_dc: [your sp_dc here]
primary_sp_key: [your sp_key here]
niklas_sp_dc: [niklas sp_dc here]
niklas_sp_key: [niklas sp_key here]
ming_sp_dc: [ming sp_dc here]
ming_sp_key: [ming sp_key here]The spotcast custom component creates a service called 'spotcast.start' in Home Assistant.
- service: spotcast.start
data:
spotify_device_id: "ab123c5d7347324c2b1234567890f8d6dc40350"
uri: "spotify:playlist:5xddIVAtLrZKtt4YGLM1SQ"
random_song: true- service: spotcast.start
data:
device_name: "Kitchen"
uri: "spotify:playlist:5xddIVAtLrZKtt4YGLM1SQ"
random_song: truewhere:
spotify_device_idis the device ID of the Spotify Connect devicedevice_nameis the friendly name of the chromecast deviceuriis the Spotify uri, supports all uris including track (limit to one track)searchis a search query to resolve into a uri. This parameter will be overlooked if a uri is providedcategorylet spotify pick a random playlist inside a given categorycountryrestrict country to use when looking for playlists inside a categorylimitrestrict number of playlists to return when looking in a category. Note that only a single playlist will be chosen randomly from them.random_songoptional parameter that starts the playback at a random position in the playlistrepeatoptional parameter that repeats the playlist/track (track|context|off)shuffleoptional parameter to set shuffle mode for playbackoffsetoptional parameter to set offset mode for playback. 0 is the first song
Optionally you can specify the entity_id of an existing Home Assistant chromecast media-player like:
- service: spotcast.start
data:
entity_id: "media_player.vardagsrum"
uri: "spotify:playlist:5xddIVAtLrZKtt4YGLM1SQ"To use the Spotcast service with a Spotify Connect device, you need the spotify_device_id. To find the spotify_device_id, multiple option are available.
- Go to Spotify developer console
- Click
GET TOKEN
- Select
user-read-playback-stateas a scope
- If prompt give permission to your Spotify profile
- For chromecast devices, make sure to play media on the device prior to checking the logs as they will not show unless active
- Press the option
Try it - Read the result in the console in the right.
- Enable the debug logs (instructions are in section
Enabling Debug Login this README) - Reboot Home Assistant
- Go to
Configuration >> Logs >> Load Full Home Assistant Log. - For chromecast devices, make sure to play media on the device prior to checking the logs as they will not show unless active
- Find the log entry
get_spotify_devicesand look for the device ID.
- Open the Spotify Web Player and sign in if needed
- Make sure you see your Sonos devices in the Connect popup
- Open your browser's DevTools (F12 for Chrome)
- Navigate to the Network tab
- Connect to the desired Sonos device in the Web Player
- Find the associated request in your DevTools
- The request URL looks something like this:
https://gew1-spclient.spotify.com/connect-state/v1/connect/transfer/from/my_web_player_device_id/to/my_sonos_device_id - The
my_sonos_device_idis thespotify_device_idyou are looking for.
2022-01-13 19:10:35 DEBUG (SyncWorker_0) [custom_components.spotcast.helpers] get_spotify_devices: media_player.spotify_felix: Spotify Félix Cusson: [{'id': '################################', 'is_active': True, 'is_private_session': False, 'is_restricted': False, 'name': 'Salon', 'type': 'CastAudio', 'volume_percent': 16}]
2022-01-13 19:10:35 DEBUG (SyncWorker_0) [custom_components.spotcast.helpers] get_spotify_devices: {'devices': [{'id': '###############################', 'is_active': False, 'is_private_session': False, 'is_restricted': False, 'name': 'Salon', 'type': 'CastAudio', 'volume_percent': 16}]}
# Look for
<...> Spotify Félix Cusson: [{'id': '################################', <- This is the device ID
- id: 'christmas_play_christmas_music'
alias: Christmas play Christmas music
initial_state: 'on'
trigger:
- event_data:
id: remote_windowlamps
event: 5002
platform: event
event_type: deconz_event
condition: []
action:
- service: spotcast.start
data:
uri: 'spotify:playlist:56Bor5fbMJlJV7oryb2p3k'
random_song: true
shuffle: true
start_volume: 50
entity_id: media_player.kitchen- service: spotcast.start
data:
search: "Brown Bird" # resolves to spotify:artist:5zzbSFZMVpvxSlWAkqqtHP at the time of writing
random_song: true
shuffle: true
start_volume: 50
entity_id: media_player.kitchenOmitting uri will transfer the playback to the specified device.
- service: spotcast.start
data:
device_name: "Speaker kitchen"Use the parameter force_playback to continue the user's playback even if nothing is currently playing.
- service: spotcast.start
data:
device_name: "Speaker kitchen"
force_playback: truewhere:
device_nameis the friendly name of the chromecastforce_playback(optional) true or false, true to continue the user's playback even if nothing is currently playing
- service: spotcast.start
data:
account: "niklas"
device_name: "Speaker kitchen"
uri: "spotify:playlist:5xddIVAtLrZKtt4YGLM1SQ"where:
accountis the name of account key in the accounts dictionary in the configurationdevice_nameis the friendly name of the chromecasturiis the Spotify uri, supports all uris including track (limit to one track)
Play the latest episode of a given podcast show.
- service: spotcast.start
data:
account: "niklas"
device_name: "Speaker kitchen"
uri: "spotify:show:6PeAI9SHRZhghU7NRPXvT3"
ignore_fully_played: truewhere
accountis the name of account key in the accounts dictionary in the configurationdevice_nameis the friendly name of the Chromecasturiis the spotify uri, (podcasts use the 'show' uri)ignore_fully_played(optional) true or false, true to ignore already fully played episodes (defaults to false and plays the latest released episode)
The sensor has the discovered chromecasts as both json and an array of objects. Since v3.4.0 it does not do its own discovery but relies on data from core cast. Add the following to the sensor section of the configuration:
sensor:
- platform: spotcast
country: SEThe country tag was added in v3.6.24. This tag is optional. If ommited or if you haven't updated the configuration since the update, it will default to "SE" (which it always did before)
Sensor name:
sensor.chromecast_devicesAttributes
devices_json: [
{
"name": "Speaker kitchen",
"cast_type": "audio",
"model_name": "Google Home",
"uuid": "xxxxx",
"manufacturer": "Google Inc."
},
{
"name": "Speakers upstairs",
"cast_type": "group",
"model_name": "Google Cast Group",
"uuid": "xxxx",
"manufacturer": "Google Inc."
},
{
"name": "Living room",
"cast_type": "cast",
"model_name": "HK Citation 300",
"uuid": "xxxx",
"manufacturer":"Harman Kardon"
}
]
last_update: 2019-05-01T15:27:49.828553+02:00
friendly_name: Chromecast DevicesThe components websocket api.
Method: spotcast/playlist supporting different playlist_types.
user, ordefaultfor user chosen saved playlistsfeaturedfor spotify "featured" playlists (not personalized)discover-weeklyfor personalized "Made for _____" (includes daily mixes)recently-playedfor "Recently Played"- ... any other
view idas found in the API at https://api.spotify.com/v1/views/personalized-recommendations
Example usage:
// Retrieve playlists
const res = await this.props.hass.callWS({
type: 'spotcast/playlists',
playlist_type: 'featured', // 'user' for saved playlists, 'featured' for spotify featured, or personalized view id
country_code: 'SV', // Optional country code used by featured playlists
limit: 20, // Optional limit, default is 10
account: 'ming' // optional account name
});
// Retrieve devices
const res = await this.props.hass.callWS({
type: 'spotcast/devices',
account: 'ming' // optional account name
});
// Retrieve player
const res = await this.props.hass.callWS({
type: 'spotcast/player',
account: 'ming' // optional account name
});In configuration.yaml for you HA add and attach those the relevant logs. Be sure to disable it later as it is quite noisy.
logger:
default: info
logs:
custom_components.spotcast: debugPlease do! Open a Pull Request with your improvements.
This project was made possible by the original creator Niklas Fondberg. All your great work are greatly appreciated.
Apache 2.0
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent