Zero Button Audiobook Player based on Rapberry Pi
Python Shell
Latest commit c6d88ce Jan 15, 2015 @2m Update README.md

README.md

Zero Button Audiobook Player

Gitter

Demo video

This project is based on Raspberry Pi and hugely inspired by The One Button Audiobook player. I too have grandmother who is visually impaired and loves listening to audiobooks. Until now she has been doing this using old DVD player, which worked quite well, but that player does not save its state. So every time its turned off and back on it begins to play audiobook from the beginning.

So naturally this was a great opportunity for a Raspberry Pi project. However I went a little bit further and did not add any buttons at all. This audiobook player can be controlled using simple HTTP queries (mostly for debugging) or using NFC tags.

So the plan is to add some NFC tag stickers on empty DVD or CD cases. Actually anything might work which is quite bulky. So every NFC tag (or empty CD case in this case) references some audiobook in the internal player memory. When someone puts a tag over the player, it starts playing respective audiobook from its last state.

This player saves its state every couple of seconds. So whenever my grandmother gets bored of listening to it she can plug the player out of the mains socket. When the player is turned back on, it starts right from its last saved state.

I believe using this kind of technology will will present the smallest learning curve (if any). I will see what my grandmother thinks of it after couple of months using it.

How it came about

This is my first Raspberry Pi project. So here I will try to enumerate every step that I took to make this project be.

Hardware

I got a Raspberry Pi for this project from ModMyPi. I also bought a case, SD to microSD card adapter and HDMI to DVI adapter from there.

It took some time to locate a suitable NFC reader. It had to be quite small so it fitted into RPi case. I chose PN532 NFC RFID module kit which I saw mentioned in couple of SIB Vision blog posts.

Firstly this blog post helped me to change NFC module protocol from default I2C to HSU (or UART). Secondly, another post mentioned everything I needed to know to successfully connect this NFC module to Raspberry Pi.

So I unsoldered 0 Ohm resistor from bit 1 of HIS0 pin and then shortened bit 0 of HIS0 pin, which was harder than it sounds because of my gigantic soldering iron. Next I tweaked those mentioned config files and connected NFC module to RPi. It was quite simple. I had some problems installing libnfc but more on that later.

Software

I chose to use Python for this project, which comes already in a Rasbian Weezy which I installed into microSD card and successfully booted RPi for the first time.

I am quite limited in some parts of working in Linux. For example I was not quite sure how to configure network on Raspberry Pi. This is what helped me to Share Internet Connection with Linux from my Windows PC.

For music playing part I installed MPD using a tutorial from here and also installed Python MPD2. I had some problems with this. Mainly some commands (seek for example) in Python did not work. I believe the problem was caused because apt-get installed 0.16.0 version of MPD and Python MPD2 already bumped its support to MPD version 0.17.0 which maybe broke some backwards compatibility.

There are couple of distinctive logical modules in this project:

  • audio file player;
  • state saver;
  • web interface;
  • nfc interface.

All of these need to interchange messages when some event occurs. I figured Actor Model should work here quite well and installed Pykka which is a python implementation of actor model. I am quite new (self taught and worked only on toy projects) to actors, so I am not sure if I used Pykka in a best way. However my code seems to work and it is not very ugly.

NFC part of this project is handled by the open source libnfc. To install (compile) this library first I followed an article from Adafruit on NFC on Raspberry Pi. However that article is a little bit outdated and libnfc has to be installed a little bit differently from version 1.7.0. As members of libnfc forum pointed out here and here before compilation libnfc must be configured with only one parameter. ./configure --with-drivers=pn532_uart Then after sudo make install a configuration file for Raspberry Pi must be copied to a directory which is checked by libnfc on startup. sudo cp contrib/libnfc/pn532_uart_on_rpi.conf.sample /usr/local/etc/nfc/devices.d/pn532_uart_on_rpi.conf Make sure to create target directory before issuing this command. After these steps a set of commands can be used to debug or check whether libnfc works as expected.

  • LIBNFC_LOG_LEVEL=3 nfc-list Enabling debug with environment variable is helpful to determine which directories libnfc is scanning for configuration files.
  • nfc-scan-device -i -v Will list all devices detected by libnfc.
  • nfc-poll Will listen for any NFC tags for 30 seconds and will print tag information if it detects any.

That is pretty much it. All of these parts combined make a pretty neat Zero Button Audiobook Player. :)

I used merged MP3 audiobooks. However after merging MPD was not able to play past the first part. I used mp3val to clean and fix merged MP3 files.

Software Architecture

Here I will list logical modules of the software and their relations. All modules are mostly pykka actor proxy objects. So whenever you see that one actor is calling a method of other actor, it really is not the case. Behind the scenes a message is sent from one actor to another. So all these calls are asynchronous.

Zbap.py

The main project file which creates and initializes all actors. It also from time to time gives a tick to actors which need to do periodic tasks. The whole project is started by executing python Zbap.py.

This ticking actors implementation is one place where I think is implemented wrongly according to the Actor Model. At first these actors had a infinite loop inside them, but in this case these actors would continue looping even if main program was killed. So to have better control of the program flow, I moved the loop to the Zbap.py file.

MpdActor.py

This actor connects to MPD using mpd-python2 and is responsible of controlling MPD. It has methods such as getCurrentSong and playByNameFrom which are quite self documenting. These methods are for other actors to call.

StateActor.py

Actor which saves currently playing song and the amount of seconds played from the beginning every so often. State is saved to data/state.json file. It also provides playFromLastState method for other actors which when called starts playing an audio file from its last saved state.

TagActor.py

Actor which translates between audio file tag and its file name. The mapping between audio file names and tags is provided in data/tags.py file.

WebActor.py

This actor provides HTTP interface to the audiobook player. This is really helpful when debugging given that HTTP calls can be made using a web browser from any computer connected to the same network as Raspberry Pi. Available commands:

  • http://<raspberry_pi_ip>:8080/play/<tag> Starts playing a song identified by a tag from its last known state.
  • http://<raspberry_pi_ip>:8080/play/<tag>/fromStart Starts playing a song identified by a tag from the start.

NfcActor.py

Actor which periodically checks if there is a NFC tag nearby by calling nfc-list command. If NFC tag is found, this actor parses the tag from the command output and gives it to the TagActor.py asking to play the audio file.