Idea for Binding: Spotify Connect binding

Gad_Ofir · September 23, 2018, 11:28am

Hi i have issue with step 6 on github

so i have the bdining installed i can see it in paper UI
i have secert and clinet id
i added a thing with the above

:24:22.977 [INFO ] [smarthome.event.ItemStateChangedEvent] - infoDate changed from 2018-09-23T14:21:22.976+0300 to 2018-09-23T14:24:22.977+0300
14:24:44.854 [ERROR] [est.core.internal.thing.ThingResource] - Exception during HTTP PUT request for update config at 'things/spotify:player:SpotifyBridge/config'
java.lang.IllegalStateException: Thing with UID spotify:player:SpotifyBridge has no handler attached.
        at org.eclipse.smarthome.core.thing.internal.ThingRegistryImpl.

can someone please tell me how to add this to the item file?
i dont like doing it from UI…

OH 2.3
Windows run
using this guide https://github.com/astenlund74/org.openhab.binding.spotify-binary

Masssssy · September 23, 2018, 2:16pm

I have done some experimenting with this today and come to a few conclusions. The Chromecast issue can be solved by hosting a x86 Android machine, run Tasker on that and then trigger that virtual tablet to cast to the correct device. The binding will then automatically update current device etc. This should be possible to automate 100% from OpenHAB calls to Tasker on this “virtual tablet”.

It’s not very pretty but it seems there is no support for anything better by Spotify/Google as of now.

Update: It is possible to ask Google assistant to “play music on the tv” to trigger the Spotify Chromecast device to wake up.

Der_Gute · September 24, 2018, 7:24am

Hi! Kudos for all your work.
I think there is a bug with the binding, so i explain what i want to do :).
I have a Amazon Echo infrastructure at home, but dont like the sound. I have a parallel Soundtouch (Bose) Infrastructure and i would like to hear the music with the soundtouch infrastructure, although triggering natural (without skills) commands to the echo in the room. (i.e. Alexa, play music).
Therefore my idea is: Track the Player State and afterwards check which device plays. Detect the corresponding Soundtouch Device and transfer the current play to the soundtouch device.

The Problem is:
The following doesnt work:
“Also if you want to transfer playing to another device you can simply start play on the other device in openHAB (you have to add that device as thing and start play on it). It will then start playing the song already playing on the other device.”

When i press the play button on another device although there is already a device playing, simply nothing happens.

Therefore i have made an (i dislike it because it could be all done with this binding) own solution by making a curl request to switch to the device( spotify api supports it-> Transfer a User’s Playback in Spotify Api Console).Great thanks to that, because i can use the authorizationtoken from the related item, to make my curl request
Do you think you can fix this?

Another question:

Do you have an example things file for the binding? This way we could choose whether we want to add things via paperui or manually as file (my preferred way)

best regards

gunfrem · September 24, 2018, 12:24pm

I’ve got the same problem. The controlls of the device don’t work. If I start music via my mobile on a connected device, I can pause, play, change playlist via the bridge, but the controlls of the devices don’t work. Also switching to an other device does not work.

Here my spotify items and sitemap:

BRIDGE

Player SpotifyPlayer_Bridge_Control "Spotify Control" (GF_LivingRoom_Spotify, gSpotify) {channel="spotify:player:393b0003:trackPlayer"}
Switch SpotifyPlayer_Bridge_Shuffle "Shuffle" (GF_LivingRoom_Spotify, gSpotify)  {channel="spotify:player:393b0003:deviceShuffle"}
Dimmer SpotifyPlayer_Bridge_Volume "Volume" (GF_LivingRoom_Spotify, gSpotify)   {channel="spotify:player:393b0003:deviceVolume"}
String SpotifyPlayer_Bridge_Title "Title [%s]" (GF_LivingRoom_Spotify, gSpotify)         {channel="spotify:player:393b0003:trackName"}
String SpotifyPlayer_Bridge_Interpret "Interpret [%s]" (GF_LivingRoom_Spotify, gSpotify)         {channel="spotify:player:393b0003:artistName"}
String SpotifyPlayer_Bridge_Album "Album [%s]"  (GF_LivingRoom_Spotify, gSpotify)       {channel="spotify:player:393b0003:albumName"}
String SpotifyPlayer_Bridge_Duration "Duration [%s]"  (GF_LivingRoom_Spotify, gSpotify) {channel="spotify:player:393b0003:trackDuration"}
String SpotifyPlayer_Bridge_Progress "Progress [%s]"  (GF_LivingRoom_Spotify, gSpotify) {channel="spotify:player:393b0003:trackProgress"}
String SpotifyPlayer_Bridge_TrackPlay "TackPlay" (GF_LivingRoom_Spotify, gSpotify)      {channel="spotify:player:393b0003:trackPlay"}

DEVICE HEOS

String SpotifyPlayer_HeosWZ_TrackPlay "TackPlay" (GF_LivingRoom_Spotify, gSpotify)      {channel="spotify:device:393b0003:19c9:trackPlay"}
Player SpotifyPlayer_HeosWZ_DevicePlayer "Player" (GF_LivingRoom_Spotify, gSpotify) {channel="spotify:device:393b0003:19c9:devicePlayer"}
String SpotifyPlayer_HeosWZ_DeviceName "Name" (GF_LivingRoom_Spotify, gSpotify) {channel="spotify:device:393b0003:19c9:deviceName"}

DEVICE Google Home

String SpotifyPlayer_GoogleHomeWohnzimmer_TrackPlay "TackPlay" (GF_LivingRoom_Spotify, gSpotify {channel="spotify:device:393b0003:d47a:trackPlay"}
Player SpotifyPlayer_GoogleHomeWohnzimmer_DevicePlayer "Player" (GF_LivingRoom_Spotify, gSpotify) {channel="spotify:device:393b0003:d47a:devicePlayer"}
String SpotifyPlayer_GoogleHomeWohnzimmer_DeviceName "Name" (GF_LivingRoom_Spotify, gSpotify) {channel="spotify:device:393b0003:d47a:deviceName"}

Sitemap snippit:

        Frame label="Spotify Bridge" {
            Default item=SpotifyPlayer_Bridge_Control
            Default item=SpotifyPlayer_Bridge_Shuffle
            Default item=SpotifyPlayer_Bridge_Volume
            Default item=SpotifyPlayer_Bridge_Title
            Default item=SpotifyPlayer_Bridge_Interpret
            Default item=SpotifyPlayer_Bridge_Album
            Default item=SpotifyPlayer_Bridge_Duration
            Default item=SpotifyPlayer_Bridge_Progress
            Selection item=SpotifyPlayer_Bridge_TrackPlay label="Playlist Spotify Heos" icon="music" mappings=["spotify:user:1121824159:playlist:7jzBjCIY8VSwshWJxqU17Z"="Gartenparty","spotify:user:europa.kinderprogramm:playlist:5e6XxV3vhHhdfqcjXScH8o"="3 ???"]
        }
        Frame label="Spotify auf Heos WZ" {
            Default item=SpotifyPlayer_HeosWZ_DeviceName
            Default item=SpotifyPlayer_HeosWZ_DevicePlayer
            Selection item=SpotifyPlayer_HeosWZ_TrackPlay label="Playlist Spotify Heos" icon="music" mappings=["spotify:user:1121824159:playlist:7jzBjCIY8VSwshWJxqU17Z"="Gartenparty","spotify:user:europa.kinderprogramm:playlist:5e6XxV3vhHhdfqcjXScH8o"="3 ???"]
        }
        Frame label="Spotify auf GoogleHome Wohnzimmer" {
            Default item=SpotifyPlayer_GoogleHomeWohnzimmer_DeviceName
            Default item=SpotifyPlayer_GoogleHomeWohnzimmer_DevicePlayer
            Selection item=SpotifyPlayer_GoogleHomeWohnzimmer_TrackPlay label="Playlist Spotify Heos" icon="music" mappings=["spotify:user:1121824159:playlist:7jzBjCIY8VSwshWJxqU17Z"="Gartenparty","spotify:user:europa.kinderprogramm:playlist:5e6XxV3vhHhdfqcjXScH8o"="3 ???"]
        }

hilbrand · September 24, 2018, 1:22pm

I’ve updated the Spotify binding jar with several Fixes:

Fixed playing tracks: it now detects if it’s a track or other (e.g. playlist, etc).
Fixed device id: it’s now a configuration property so it can be used to configure the device manually. (prior it was not possible to manually configure a device)
Renamed channel devicePlay to devicePlayer since that better reflects the name.
Removed channel deviceId from device thing: it’s already available as a property, so no need to have it as a channel.
Improved readme: added manual things file configuration example.
The dashboard tile has been removed. There is still some work in progress on the authorization part to bring it in line with other similar oauth2 usages in openHAB, so this part is expected to be changing. This won’t affect the working of the binding, only the way the refreshtoken is obtained.

If you manually configured the bridge thing you need to set the refreshToken in the configuration. You can see this refreshToken after you have authorized the binding in Paper UI in edit mode of the bridge. If you don’t add the refreshToken to your configuration you need to re-authorize after each restart (or for example if you update the binding jar) because with manual configuration the refreshToken is reset on init if not set manually. When you have added the bridge via PaperUI this won’t happen.

Der_Gute · September 24, 2018, 1:29pm

Hi Hilbrand!

Thanks for the update :).

From my understanding this does not address the problem i have mentioned, does it?

Best regards

hilbrand · September 24, 2018, 1:45pm

I could not see from your comment if you had manually created the things or via Paper UI. If you manually created the things you could not transfer playing, that did not work. That has been fixed. It should now work if you play on another device player it should start playing on the other device. It doesn’t call the specific transfer api, but simply calls play with a device id. This gives the same result. Did you have manual configured things? and if so does it now works for you?

Der_Gute · September 24, 2018, 1:49pm

I Created my things via Paperui because i failed with creating the things via things file.
I Created my items in item file but later i tried to do all this via paperui with the same result: i can play and pause the current playing device, but nothing happens when i press play on another device. i will test it and reply you later

hilbrand · September 24, 2018, 8:33pm

For configuration information look in the readme from the pull request: https://github.com/astenlund74/openhab2-addons/blob/master/addons/binding/org.openhab.binding.spotify/README.md . That url will always contain the latest information (until the binding is merged) the URL you referred to is outdated and will not be updated. In fact that whole repository is outdated and is not updated anymore.

Der_Gute · September 25, 2018, 11:06am

Just tried to create manual things with the following jar:

The bridge is created successfully, while the devices arent. the ID is not passed correctly.
When i add the things from Paperui, they are online.

May you provide a new .jar which contains all your changes as im not the born developer to compile by myself in a minute?
I will test the behaviour of playing tracks by another device with the new version.

Best regards

hilbrand · September 25, 2018, 12:01pm

The jar contains all the changes. So that should not be the problem Can you provide your configuration?Maybe a typo? of does it log any error?

Der_Gute · September 25, 2018, 12:37pm

Oh okay :).

Thats my things file. I masked the sensitive Data. My openhab.log does not show any syntax errors. The things are created in Paperui, but without ID.

Bridge spotify:player:anonym "anonym" [clientId="asdfg", clientSecret="asdfg", refreshToken="asdfg"]
{
Thing device 3b01 "Soundtouch10" [id="asdfg"]
//Thing device f4f8 "Soundtouch 300 Wohnzimmer Spotify" [id="ijklm"]
}

Some additional info: The ID exactly matches the one i got by adding the thing via paperui and checked the property

Best regards

hilbrand · September 25, 2018, 1:57pm

Hmm. It works on my machine Maybe some caching of the old jar. In Paper UI can you edit the id of the device Thing? If not you would still have the old version loaded. (The jar should be 75443 bytes) You could disable the spotify things in the things file (if you haven’t tried it) and wait till they are removed, and then enable them again Or give the thing another id for example something else instead of the 3b01 Otherwise I’m not sure what causes this problem or it might be a different openHAB version. I’m running a 2.4 snapshot.

Der_Gute · September 25, 2018, 2:23pm

Indeed i used the old version! With the new one and the things file i already sent, i get a NPE (the bridge stays offline). in Trace mode i can see that spotify API is still reachable, because it obtained a new refreshtoken:

[INFO ] [nternal.handler.SpotifyBridgeHandler] - Unexpected error during polling status, please report if this keeps ocurring:
java.lang.NullPointerException: null
        at org.openhab.binding.spotify.internal.handler.SpotifyDeviceHandler.updateDeviceStatus(SpotifyDeviceHandler.java:99) ~[?:?]
        at org.openhab.binding.spotify.internal.handler.SpotifyBridgeHandler.lambda$5(SpotifyBridgeHandler.java:315) ~[?:?]
        at java.util.stream.MatchOps$1MatchSink.accept(MatchOps.java:90) ~[?:?]
        at java.util.ArrayList$ArrayListSpliterator.tryAdvance(ArrayList.java:1351) ~[?:?]
        at java.util.stream.ReferencePipeline.forEachWithCancel(ReferencePipeline.java:126) ~[?:?]
        at java.util.stream.AbstractPipeline.copyIntoWithCancel(AbstractPipeline.java:498) ~[?:?]
        at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:485) ~[?:?]
        at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) ~[?:?]
        at java.util.stream.MatchOps$MatchOp.evaluateSequential(MatchOps.java:230) ~[?:?]
        at java.util.stream.MatchOps$MatchOp.evaluateSequential(MatchOps.java:196) ~[?:?]
        at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[?:?]
        at java.util.stream.ReferencePipeline.anyMatch(ReferencePipeline.java:449) ~[?:?]
        at org.openhab.binding.spotify.internal.handler.SpotifyBridgeHandler.lambda$4(SpotifyBridgeHandler.java:312) ~[?:?]
        at java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:174) [?:?]
        at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1374) [?:?]
        at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481) [?:?]
        at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) [?:?]
        at java.util.stream.ForEachOps$ForEachOp.evaluateSequential(ForEachOps.java:151) [?:?]
        at java.util.stream.ForEachOps$ForEachOp$OfRef.evaluateSequential(ForEachOps.java:174) [?:?]
        at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) [?:?]
        at java.util.stream.ReferencePipeline.forEach(ReferencePipeline.java:418) [?:?]
        at org.openhab.binding.spotify.internal.handler.SpotifyBridgeHandler.updateDevicesStatus(SpotifyBridgeHandler.java:316) [241:org.openhab.binding.spotify:2.4.0.201809241312]
        at org.openhab.binding.spotify.internal.handler.SpotifyBridgeHandler.pollStatus(SpotifyBridgeHandler.java:270) [241:org.openhab.binding.spotify:2.4.0.201809241312]
        at org.openhab.binding.spotify.internal.handler.SpotifyBridgeHandler.initialize(SpotifyBridgeHandler.java:232) [241:org.openhab.binding.spotify:2.4.0.201809241312]
        at sun.reflect.GeneratedMethodAccessor75.invoke(Unknown Source) ~[?:?]
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[?:?]
        at java.lang.reflect.Method.invoke(Method.java:498) ~[?:?]
        at org.eclipse.smarthome.core.internal.common.AbstractInvocationHandler.invokeDirect(AbstractInvocationHandler.java:153) [94:org.eclipse.smarthome.core:0.10.0.oh240M3]
        at org.eclipse.smarthome.core.internal.common.Invocation.call(Invocation.java:53) [94:org.eclipse.smarthome.core:0.10.0.oh240M3]
        at java.util.concurrent.FutureTask.run(FutureTask.java:266) [?:?]
        at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142) [?:?]
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617) [?:?]
        at java.lang.Thread.run(Thread.java:748) [?:?]

any hints?

hilbrand · September 25, 2018, 2:35pm

I think this can happen if you have a thing that was created with the old jar and is now loaded with the new jar. In that case internally the id is null (Because it was previously set in another place). So please remove all previously added/created things (possible only need for the once created via Paper UI).

Der_Gute · September 25, 2018, 3:07pm

Ich have done that by moving the Things File and moving this one Back. Should ne enough,shouldnt IT?ah okay ich understood. Letzte me try:)

Der_Gute · September 25, 2018, 3:54pm

OK. Update:
Things and items working .but play in another device does not work. Tolles reproduce: play Something in Spotify app in Smartphone and send to another device via Spotify Connect in App.
Then click play in another device via paperui. Result: IT changes icon to play and immediately back to pause. It does not start playing the chosen track in MS device selected in paperui. Instead IT Plays in the device chosen in Spotify app in Smartphone. In trace log i cant see the request that normally is performed when pressing play

hilbrand · September 27, 2018, 6:40am

I’ve updated the Spotify Binding jar. It contains an improvement with transferring playing to another device. This will improve start playing on another device to be more reliable. (Thanks goes to @Der_Gute for helping test this improvement). If you have an earlier or older version of the jar installed and you might need to recreate the things and/or clear your cache in order it work again.

nignac · September 30, 2018, 6:55pm

Hi, i’ve updated to the latest version.

Some remarks:
After a restart of openhab the bridge and things stay offline, but everything works as expected.
The Authorization need to be done only once?

Could you provide a Example .thing file?
The refreshTokes ia automatically updated by the binding?

A minor issue is, after I play a playlist, the ShuffleMode is always set back to OFF.

Thank you

PS: In combnation with the Allplay binding, i could combine players for multimroom audio and change between a Stream and Spotify.

hilbrand · September 30, 2018, 9:13pm

After a restart of openhab the bridge and things stay offline, but everything works as expected.
The Authorization need to be done only once?

Did you create the brigde/thing with Paper UI or via a things file? If created via Paper UI then the authorization should have to be done only once. If not let me know. If created via things file you need to set the refreshToken in the things file otherwise you need to authorize after each restart, or even each time the things file is updated.

Could you provide a Example .thing file?

See the README. (Note, as mentioned above add the refreshToken to the bridge configuration to avoid having to reauthorize, this information is not yet clearly mentioned in the readme)

github.com

astenlund74/openhab2-addons/blob/master/addons/binding/org.openhab.binding.spotify/README.md

# Binding for Spotify and Spotify Connect Devices

This binding implements a bridge to the Spotify Player Web API and makes it possible to discover Spotify Connect Devices available on your Spotify Premium account.

## Configuring the binding

The binding requires you to register an Application with Spotify Web API at [https://developer.spotify.com](https://developer.spotify.com) - this will get you a set of Client ID and Client Secret parameters to be used by your binding configuration.

### Create Spotify Application

Follow the instructions in the tutorial at [https://developer.spotify.com/web-api/tutorial/](https://developer.spotify.com/web-api/tutorial/).
Follow instructions under:

 1. Setting Up Your Account
 1. Registering Your Application

- Step 6: entering Website information can be skipped.
- Step 7: setting Redirect URIs is **very important**

When registering your new Spotify Application for openHAB Spotify Bridge you have to specify the allowed "Redirect URIs" aka white-listed addresses.

This file has been truncated. show original

The refreshTokes ia automatically updated by the binding?

No only when you have clicked on authorize in the connectspotify page is it set once. After that only the accessToken is set automatically. That’s why you need to set the refreshToken in a things file (if you use a things file). If for some reason the refreshToken becomes invalid you need to reauthorize it via the connectspotify page.

A minor issue is, after I play a playlist, the ShuffleMode is always set back to OFF.

If the SuffleMode is set back to off this might be a something the Spotify Api does by itself. The binding just updates to the state as reported by Spotify. You might see if there is any information on this on the Spotify forums.