npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

pimatic-spotify

v0.0.3

Published

Pimatic Plugin to integrate Spotify

Downloads

1

Readme

pimatic-spotify

A pimatic plugin to connect to and control Spotify Connect players on your network. This plugin was developed against Apple and Denon devices. Similar hardware should work equally well.

Status of Implementation

Since the first release the following features have been implemented:

  • Autodiscovery of Spotify Connect devices and Playlists
  • Pimatic devices for the above, respectively extending from AVPlayer and Presence Sensor devices
  • Rule Actions to play a playlist on a device, and set the volume.
  • The presence predicate can be used to detect if a playlist is being played

Roadmap:

  • Creating a login device, for aesthetic purposes.

Requirements

  • Spotify Premium account
  • Spotify App created via https://developer.spotify.com/dashboard/applications
  • Redirect URI correctly set in the Spotify app (usually http://Pimatic-Server-IP:8888/callback)
  • Client ID and secret obtained from the Spotify app

Contributions / Credits

The project depends on the Node integration with the Spotify API through spotify-web-api-node by Michael Thelin (https://github.com/thelinmichael/spotify-web-api-node)

Configuration

  • Add the plugin to your config.json, or via the GUI (Do not forget to activate)
  • The authentication server listens on port 8888 by default, you can change this in the Plugin Config
  • Restart Pimatic
  • Browse to http://:8888/login, to allow Pimatic to access Spotify via OAuth2. You are logging in at Spotify, so your Spotify user credentials are not saved or obtained locally
  • Run device autodiscovery and add your devices
  • Create rules to Play playlists on devices of your choice, e.g.
    • when Bathroom Light is turned on then play Songs to Sing in the Shower on Bathroom Speaker and set volume of Bathroom Speaker to 30%

Plugin Configuration

{
  "plugin": "spotify",
  "debug": false,
  "clientID": "<Spotify app Client ID>",
  "secret": "<Spotify App Secret",
  "auth_port": 8888
}

The plugin has the following configuration properties:

| Property | Default | Type | Description | |:------------------|:---------|:--------|:------------------------------------------------| | debug | false | Boolean | Debug messages to pimatic log, if set to true | | clientID | none | String | Client ID obtained in Spotify API app | | secret | none | String | Secret obtained in Spotify API app | | auth_port | 8888 | Number | TCP port for the authentication server |

Device Configuration

Default settings through autodiscovery should work fine.

SpotifyPlayer

{
  "class": "SpotifyPlayer",
  "name": "Bathroom Speaker",
  "id": "spotify-player-bathroom-speaker",
  "spotify_id": "3b859.....",
  "spotify_type": "Speaker"
}

The device has the following configuration properties:

| Property | Default | Type | Description | |:--------------------|:----------|:--------|:--------------------------------------------------------| | spotify_id | '' | String | Spotify device ID (Autodiscovery) | | spotify_type | 'Speaker' | Enum | Spotify device ID (Autodiscovery) |

SpotifyPlaylist

{
  "class": "SpotifyPlaylist",
  "name": "Songs to Sing in the Shower",
  "id": "spotify-playlist-songs-to-sing-in-the-shower",
  "spotify_id": "37i9dQZF1DWSqmBTGDYngZ",
  "spotify_type": "playlist",
  "spotify_uri": "spotify:playlist:37i9dQZF1DWSqmBTGDYngZ"
}

| Property | Default | Type | Description | |:--------------------|:-----------|:--------|:-------------------------------------------------| | spotify_id | '' | String | Spotify ID of the playlist (Autodiscovery) | | spotify_type | 'playlist' | String | Spotify type (Always playlist for now | | spotify_uri | '' | String | Spotify URI for Playlist (Autodiscovery) |

Predicates and Actions

The following predicates are supported:

  • {device} is present|absent (For Playlist devices)

The following actions are supported:

  • play on (For Player devices)
  • set volume of to 50% (For Player devices, variables are supported)

License

Copyright (c) 2022, Danny Wigmans and contributors. All rights reserved.

GPL-3.0