Skip to content
This repository has been archived by the owner on Mar 20, 2021. It is now read-only.

Latest commit

 

History

History
178 lines (109 loc) · 5.12 KB

README.md

File metadata and controls

178 lines (109 loc) · 5.12 KB

#Spot

Simple Spotify-powered tunes for your office.

##Origins

This project is heavily inspired by Play. Which is an awesome iTunes-based solution.

##Requirements

  • OS X
  • Spotify = 0.8 <--See Setup below
  • (Slack, Campfire, or HipChat) with Hubot (optional but recommended)

##Setup

You'll need an AppleScript'able version of Spotify. See this gist.

Clone the repo:

git clone https://github.com/minton/Spot.git && cd Spot

Install gems:

bundle install

Set Up Environment Variables:

Optional: To provide a link to your audio stream in the web interface, define an environment variable SPOT_FEED_URL

```
export SPOT_FEED_URL="//your/audio/feed/listen.m3u"
```

Start Spot:

rake start

The server will start up here: localhost:5051.

Spotify will open and Repeat and Shuffle will be turned on.

You should now open your favorite playlist or radio station.

##Airplay Support

You'll need to Enable access for assistive devices in System Preferences for this to work.

Accessibility

##Usage

Spot can technically be used by any client capable of GET/PUT/POST requests as described below but it was really designed to be controlled via Hubot in Campfire. You can find the latest Spot Hubot script here: Spot.coffee.

###Hubot

hubot play! - Plays current playlist or song.
hubot pause - Pause the music.
hubot next - Plays the next song.
hubot back - Plays the previous song.
hubot playing? - Returns the currently-played song.
hubot play <song> - Play a particular song. This plays the first most popular result.
hubot volume? - Returns the current volume level.
hubot volume [0-100] - Sets the volume.
hubot volume+ - Bumps the volume.
hubot volume- - Bumps the volume down.
hubot mute - Sets the volume to 0.
hubot [name here] says turn it down - Sets the volume to 15 and blames [name here].
hubot say <message> - Tells hubot to read a message aloud.
hubot find <song> - See if Spotify knows about a song without attempting to play it.
hubot airplay <Apple TV> - Tell Spot to broadcast to the specified Apple TV.
hubot spot - Restart Spot
hubot respot - Restart Spotify

###Clients

Window Spot for Windows

Ugly ScreenShot

iSpot for iOS

iSpot ScreenShot

###API

What song is playing:

~$ curl -i -H "Accept: application/json" -X GET http://localhost:5051/playing

HTTP/1.1 200 OK
Content-Length: 50
Now playing “Raise Your Weapon” by Deadmau5...

Album art for current song:

~$ wget http://localhost:5051/playing.png

100%[======================================>] 87,510      --.-K/s   in 0s
2012-12-21 21:20:38 (518 MB/s) - ‘playing.png’ saved [87510/87510]

Play a specific song:

~$ curl -i -H "Accept: application/json" -X POST -d "q=Raise your weapon" http://localhost:5051/find

HTTP/1.1 200 OK
Content-Length: 50
Now playing “Raise Your Weapon” by Deadmau5...

Play the music:

~$ curl -i -H "Accept: application/json" -X PUT http://localhost:5051/play

HTTP/1.1 200 OK
Content-Length: 50
Now playing “Raise Your Weapon” by Deadmau5...

Pause the music:

~$ curl -i -H "Accept: application/json" -X PUT http://localhost:5051/pause

HTTP/1.1 200 OK
Content-Length: 21
Everything is paused.

Mute the music:

~$ curl -i -H "Accept: application/json" -X PUT http://localhost:5051/mute

HTTP/1.1 200 OK
Content-Length: 7
Shhh...

What's the volume set at:

~$ curl -i -H "Accept: application/json" -X  GET http://localhost:5051/volume

HTTP/1.1 200 OK
Content-Length: 2
42

Set the volume:

~$ curl -i -H "Accept: application/json" -X PUT -d "volume=42" http://localhost:5051/volume

HTTP/1.1 200 OK
Content-Length: 2
41 <--Close enough :)

Skip to the next track:

~$ curl -i -H "Accept: application/json" -X PUT http://localhost:5051/next

HTTP/1.1 200 OK
Content-Length: 56
Onwards! Now playing “Ghosts N Stuff” by Deadmau5...

Play the previous track:

~$ curl -i -H "Accept: application/json" -X PUT http://localhost:5051/back

HTTP/1.1 200 OK
Content-Length: 71
Let's hear it again! Now playing “Raise Your Weapon” by Deadmau5...

#Author

Spot was lovingly crafted by @minton. You should follow me for good karma!

#Art

Hubot image from Cameron McEfee found here: http://octodex.github.com/hubot/

Campfire image from 37signals.

Spotify image from Spotify.