Skip to content

Ejay-3D/MMM-SpotifyControl

Repository files navigation

MMM-SpotifyControl

Deprecated Module. No longer supported : See : https://github.com/eouia/MMM-Spotify for the new release .

A module for the MagicMirror project by Michael Teeuw to control ( Play/pause/forward etc... ) song on Spotify.

I have used part of the code of MMM-NOWPLAYINGONSPOTIFY module which use the same APIs call.

  • Thanks to raywo for creating the initial MMM-NOWPLAYINGONSPOTIFY module
  • Thanks to Mantha who initiate this idea to control spotify player and started the coding.
  • Special thanks to the very patient Sean creator of the MMM-Mk2Assistant module and who helped me a lot by teaching me some dev concept to achieve this module

How it works

This Module allow to control Spotify player on your Mirror . For now you can only control a single device. It could be your mirror if you are running Raspotify on it. Request to play a song it will be played on your select device in the config.js file. other command doesn't need a device to be set. So if you are already playing a song on another device, the modules allow you to control this device from your module. But if you request a new song or playlist the set device in config file will play it on it.

Installing

Follow the white rabbit...

Step 1 – Install the module

In your MagicMirror directory:

cd modules
git clone https://github.com/ejay-ibm/MMM-SpotifyControl.git
cd MMM-SpotifyControl
npm install

Step 2 – Create and authorize a Spotify app

In order to be able to connect to the Spotify API you need to create an app in the Spotify developer area. Then you need to authorise the app to access your personal data. Et voilà!

The module provides you with a special app which describes all the necessary steps and which guides you through the whole process. To use this app change into the authorization folder and start the app by typing node app.

cd authorization
node app

When the app is running you can access it by opening localhost:8888 in your browser. Provided you are doing this directly on your Raspberry Pi. If you want to access the app remotely just type the ip address or the name of your Raspberry like so for instance: http://raspi:8888.

Now just follow the steps described there. After successful authorisation the app will display a code snippet under the heading

Step 3: Configure your mirror**. Copy that snippet and paste it into your mirror’s config.js. Configure the rest to your needs and you’re good to go.

** If you are using NowPlayingOnSpotify Module already I suggest to update your Tokens as well in this module so both module will use the same tokens. do not use NowPlayingOnSpotify tokens in that module as they have less permissions and you will not be able to control the playback.

Step 4: Get your DeviceId**.

Important ! Play a song on the desired device first else it will not be shown

  • Click on Get token and select the scope :

  • Click Request Token then Try It !

On the left side you can see the deviceId matching with your device.

  • Copy the id and keep it for Step 4 .

Here is an example for an entry in config.js

{
    module: "MMM-SpotifyControl",

    config: {
        clientID: "<YOUR_CLIENT_ID>",
        clientSecret: "<YOUR_CLIENT_SECRET>",
        accessToken: "<YOUR_ACCESS_TOKEN>",
        refreshToken: "<YOUR_REFRESH_TOKEN>",
        deviceName: "<DEVICEID>"   // See Step 4
    }
}

Step 5: configure hook and command for the Mk2 assistant.

Here is a sample of hook and command set in your config.js file for your Mk2 assistant Module.

transcriptionHook: {
        PREV_SONG: {
           pattern: "previous song",   
           command: "PREV_SONG"
      },

        PAUSE_SPOTIFY: {
            pattern: "stop the music",
            command: "PAUSE_SPOTIFY"
        },
        RESUME_SPOTIFY: {
            pattern: "resume music",
            command: "RESUME_SPOTIFY"
        },
        PLAY_NEXT_SPOTIFY: {
            pattern: "next song",
            command: "PLAY_NEXT_SPOTIFY"
        },
    },
    command: {


        PAUSE_SPOTIFY: {
            notificationExec: {
                notification: "PAUSE_SPOTIFY"
            }
        },

        RESUME_SPOTIFY: {
            notificationExec: {
                notification: "RESUME_SPOTIFY"
            }
        },

        PLAY_NEXT_SPOTIFY: {
            notificationExec: {
                notification: "PLAY_NEXT_SPOTIFY"
            }
        },

        PREV_SONG: {
            notificationExec: {
               notification: "PLAY_PREVIOUS_SPOTIFY"  
         }
        },

    }

Usage :

You are now all set ! Start your mirror and say " Play Bob Marley on Spotify" ... and chill...

Known Issues :

  • when you request a new song, if raspotify just jump back to track start instead of changing the song, an update of raspotify is needed.
  • Previous song doesn't jump to the previous track , but restart the current one. No solution for this one. This is how the Spotify api works.

About

MMM-SpotifyControl

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published