Software doesn't always have to be amazing. Sometimes, it can just be useful.
Our family loves music. We almost always have some sort of music going on in the background at our house. We have a number of Sonos speakers and subscriptions to the major music providers, giving us a lot of flexibility in what to listen to and where.
Unfortunately, having the world's music at the ready has some downsides. Especially if you're four years old.
This is Nika. She also loves music. Unfortunately, she does not yet know how to read, which is a real pain when she wants to pick out music. One option would be to buy CDs, but then she has to keep them from getting scratched and remember which tracks are the songs she likes. Also, we'd have to buy a huge amount of CDs (or burn a similar number of CDs) and a CD player when we already have three subscription music services and speakers throughout the house. I hoped for a better way.
What I wanted was something sturdier and cheaper than CDs. I don't really need them to store audio. We have Spotify for that. I'd rather they just identify what audio Nika would like to play.
Each RFID card has a serial number encoded in it. This is the value the reader will be picking up. The RFID reader acts like a USB keyboard. When you scan one of the cards, it "types" in the eight character serial number printed on the front of the card. We'll map that eight digit code to a song, album, or playlist that Nika wants to play and send that to a specified speaker.
I hooked the RFID reader up to a Raspberry Pi 3 running Raspbian. I'll normally use a Raspberry Pi for projects like this because they're small enough to embed into a project and cheap enough to dedicate one entirely for one purpose. Arduinos are another popular choice, but are much lower-level than what I needed for this project. A Raspberry Pi 3 also comes with wireless LAN support, so I don't have to run an ethernet cable to connect to Spotify/Sonos.
Disclaimer: This is a hobby project. There are no tests. It's not well-factored. I hope it helps you all the same.
The full code is located here: https://github.com/McPolemic/nika_tunes/
I didn't realize I'd need
reader.py at first. I was going to read the codes from STDIN. Unfortunately, I didn't think ahead. When I started putting things together, I realized that I wanted this to work without logging in (which means no STDIN). I needed to read raw keys from the RFID reader, which means digging down into Linux's
evdev system. I looked through Rubygems but didn't find a library that worked to my liking.
Python is the one of the main programming languages of the Raspberry Pi and as such has really good libraries for any number of lower-level concerns. In particular, it has good support for the
evdev Linux subsystem. Rather than continue trying to get Ruby to play nice, I used Python to handle the keyboard.
reader.py takes keyboard events from the reader that look like this:
KEYBOARD DOWN KEY_0 KEYBOARD UP KEY_0 KEYBOARD DOWN KEY_1 KEYBOARD UP KEY_1 KEYBOARD DOWN KEY_ENTER KEYBOARD UP KEY_ENTER KEYBOARD DOWN KEY_2 KEYBOARD UP KEY_2 KEYBOARD DOWN KEY_ENTER KEYBOARD UP KEY_ENTER
and translates it into nice, pipeable output like this:
The output from this is piped to
nika_tunes.rb, which handles searching for songs and playing them on a Sonos speaker.
This file has three classes:
Spotify is a wrapper for the
rspotify gem. It handles searching for individual songs and playlists. Searching takes between 1/10th and 1/4 of a second, which can add up, so it also handles caching the results locally. Once we have the result saved, it takes around 1/1000th of a second.
Jukebox wraps all interactions with the Sonos speakers. It takes in a speaker name and a Spotify wrapper. Notably, because I ran into some problems getting the
sonos gem to work with Spotify URLs, it handles the less-than-pleasant encoding workarounds.
CodeReader orchestrates the whole thing. It has a dictionary that maps between our unique codes (e.g. '08931021') and the action we'd like the jukebox to play (
jukebox.play_spotify_track('Remember Me')). By using Spotify to search for the track instead of encoding specific tracks, I've (hopefully) made it easier to read and easier to manage down the road as we add more songs and albums. It runs forever in the
repl method, which waits for input, runs the resulting action, and repeats.
By scanning a card, it finds and plays the specified song pretty quickly.
We printed out pictures and glued them to the various RFID cards. I started out with nine to see how she felt.
Often, I feel like posts like this don't delve enough into the challenges someone can encounter, making it feel like everything went swimmingly. I ran into quite a few challenges which are worth mentioning.
- I didn't realize RFID cards and readers have different frequencies and bought the wrong reader at first. I returned it and bought the right one.
- I thought I could always read from STDIN. Only after assembling it did I realize I'd have to read directly from the keyboard.
- Sonos apparently rolled out some encrypted method of retrieving metadata from Spotify, breaking third-party integration. I don't really understand this, but it means that I have to escape the URL and do without song/artist name in the Sonos controller. In practice, this isn't a big deal.
- I was really worried about the responsiveness of this. If Nika scanned a card and it played two seconds later, it would feel broken. I ended up adding a lot of timing logging and caching to ensure it feels snappy.
- I originally used Nika's glitter glue to glue the printed out pictures to the RFID cards. You can imagine my surprise when I realized glitter glue doesn't work super well. Luckily, Liz has more craft experience than I do and had some recommendations.
- I used Docker so I could develop on my fast desktop and then deploy it to the Raspberry Pi. I didn't realize/remember that they are different platforms (x86 vs ARM), which comes with a whole mess of problems. I still like Docker for packaging, but I should've moved it sooner onto the Raspberry Pi.
Of course, now that it's a hit, the first thing she wants is more songs! While editing the source code and redeploying is okay for now, I think I'm going to want to move the lookup from unique code to action. It likely belongs in a SQLite database with a small web frontend so that Liz can edit it without too much hassle.