Components and supplies
Arduino UNO
LED (generic)
JustBoom IR Remote
LiPo Battery
Resistor 221 ohm
Capacitor 100 µF
Speaker: 0.25W, 8 ohms
Adafruit Powerboost 1000c
Rotary potentiometer (generic)
Arduino MP3 Shield
Resistor 475 ohm
Resistor 330 ohm
Resistor 100 ohm
Slide Switch
Resistor 1k ohm
Resistor 10k ohm
Pushbutton switch 12mm
SunFounder PN532 NFC Module
IR Remote Receiver
Tools and machines
Soldering iron (generic)
3D Printer (generic)
Hot glue gun (generic)
Project description
Code
Fairytale2
arduino
Fairytale Main program --------------------------------------------------------------------------------------- This programm will play albums (audiobooks or music) stored on the SD card inserted into the Adafruit Music Maker Shield. Selection of the album/audiobook to play is done by placing corresponding NFC Tags on the NFC Reader. There are two pissibilities on how the connection between an NFC Tag and the corresponding album on the SD card can be setup: 1. An NDEF Message written to the tag in the form of: en [directory name] 2. Via the so called TrackDB - txt-files for each album in the directory trackdb0 NDEF Implementation --------------------------------------------------------------------------------------- This implementation is based on the Speedmaster PN532 and Don's NDEF Library. Upon detection of an NFC Tag at the reader it will check if there is at least one NDEF Message on the tag. This message must be of the form en [directory name] for example, the audiobook "Finding Nemo", stored in files in the directory /findnemo would have an NDEF message on the tag which reads as en findnemo There may also be a second NDEF message for the track to start playback with and this would be in the form of en 1 for the first track. To use this implementation you have to activate the configuration option NFCNDEF below and you will have to write the NDEF Messages with the directory name. This can bedone with the program staticNFCWriter.ino from this repository. The downside of this implementation is it's lack for an usable update of the track to start playback with - I simply could not get it to work. Secondly the implementation lacks a reliable way of detecting the absence of a tag. Therefore the playback can only be stopped by turning the box off. The third problem is with the used progmem. The two libraries also consume way more progmem than the Adafruit PN532 library due to which I switched to: TrackDB-Implementation: --------------------------------------------------------------------------------------- Upon detection of an NFC Tag, the program will retrieve the tag's UID and use this to scan what I call the TrackDB to find a matching directory to play. The TrackDB is a list of files in a special directory (TRACKDB0) on the SD card. The TrackDB files are named after the directory of the album and their respective content is of the form: taguid:directory:track For example, the audiobook "Finding Dorie" is stored in the directory /findorie on the SD Card. The corresponding TrackDB file is stored at /trackdb0/findorie.txt It contains exactly one line: 46722634231761290:findorie:1 This line connects the Tag UID with the aformentioned directory plus the number of the track with which to start playback: 46722634231761290 the UID of the NFC Tag findorie the directory from which to play the files 1 the number of the track with which to start playback - here the 1st To use this implementation you need to activate the configuration NFCTRACKDB You will also need to create the necessary TrackDb files. This can be done with the program createTrackDb.ino from this repository. Playback and controls --------------------------------------------------------------------------------------- Regardless of the way the program retrieved the information on which directory to play (NDEF message or TrackDB), it will store this in the global var plrCurrentFolder and then start a for-loop beginning with the provided first track until all consecutive numbered tracks are played - for this it counts the number of files in the given dierctory. While the album (or file) is played an operations light is fading up and down in intensity. After playback of all files is finished, the program will resume it's main loop, delay operation for roughly 15 seconds (to give the user the chance to remove the just used Tag from the reader) and then wait until it detects the next tag. While advancing through the files in the directory, the program will update the TrackDB-File with the number of the currently played track. Doing so allows for interrupted playbacks - tag is removed and later put back on when the playback will start with the last track in playback. Restrictions --------------------------------------------------------------------------------------- For this to work, a couple of restrictions are in place: 1. All filenames must be in the format trackXXX.mp3, where XXX is a numbering from 001 to 127 2. Follows from 1: You can have a maximum of 127 files per directory. I use a char to count the files in a directory to preserve memory and need the ability to return -1 in case of an error 3. All directory names must be exactly 8 chars long. You may use any combination of a-z and 0-9 chars for the directory name though 4. if a file is missing in a consecutive order, you may get a glitch in the sound 5. As the Adafruit Music Maker Shield library does not support to jump to a specific position within a file, the box can always only start from the beginning of a track. Warnings and errors --------------------------------------------------------------------------------------- On warnings or errors a warning or error light is lit up respectively. There are 3 different warning or error conditions: 1) Missing information for playback warning 2) Low Battery warning 2) Missing hardware error Errors shown via the error light (also cause the system to halt): - Music Maker Shield not found - Music Maker shield not on an interrupt enabled pin - SD card not found - NFC Reader not found Warnings shown via a light (Arduino can stay turned on): - Low battery warning (surely the arduino will turn off but until then it will operate) - no directory found for the NFC Tag (aka TrackDB is missing an entry for the Tag) - no directory found on the SD card that match the NFC Tag TrackDB record - no files in the provided directory - a missing file in a consecutive list of ordered files in the directory this may happen in case the files are not numerically ordered without a gap: track001.mp3 exist, track002.mp3 is missing but track003.mp3 exists again Additionally to the warning or error lights certain messages are spoken through the music . maker shield. Voiced errors and warnings are: - Low Battery warning - no directory found for the NFC Tag (aka TrackDB is missing an entry for the Tag) - no directory found on the SD card that match the NFC Tag TrackDB record - no file(s) in the directory on the SD card Controls --------------------------------------------------------------------------------------- 4 buttons are included: - Previous Track - play the previous track in a consecurtive list of ordered files - Next Track - play the next track in a consecurtive list of ordered files - Pause / Resume - pauses the playback or unpauses a paused playback - Light on / off - turn the operations light fader on or off The box is capable of being controlled by a remote control with the following functions - Volume Up - increase volume by 5 per click - Volume Down - decrease volume by 5 per click - Previous Track - play the previous track in a consecurtive list of ordered files - Next Track - play the next track in a consecurtive list of ordered files - Pause / Resume - pauses the playback or unpauses a paused playback - Light on / off - turn the operations light fader on or off Used Pins: --------------------------------------------------------------------------------------- NAME PIN USAGE - CLK / PN532_SCK 13 SPI Clock shared with VS1053, SD card and NFC breakout board - MISO / PN532_MISO 12 Input data from VS1053, SD card and NFC breakout board - MOSI / PN532_MOSI 11 Output data to VS1053, SD card and NFC breakout board - SHIELD_CS 7 VS1053 chip select pin (output) - SHIELD_DCS 6 VS1053 Data/command select pin (output) - DREQ 3 VS1053 Data request, ideally an Interrupt pin - CARDCS 4 SD Card chip select pin - PN532_SS 10 NFC breakout board chip select pin - infoLedPin 5 the pin to which the operation led is connected to - warnLedPin 8 the pin to which the warning led is connected to - errorLedPin 9 the pin to which the error led is connected to e.g. used for LBO of powerboost 1000c - volPotPin A0 the analog input pin that we use for the potentiometer - btnLinePin A1 pin to which the button line (4 buttons) is connected to - batLowPin A2 the pin on which the powerboost 1000c indicates a low baterry - iRRemotePin A3 the pin on which the IR Remote Receiver is connected to - programming A4 the pin the program button is connected to. The program button changes the functionality of the overall program in that (if pressed) the code will register a new tag for use with an album directory currently not connected to a tag Functionality yet to come! Configuration --------------------------------------------------------------------------------------- Some features (as e.g. Remote Control, Buttons or operation LED etc.) can be turned off or on via #define switches in the code below. #define IRREMOTE enables the IR Remote Control option #define BUTTONS enables the 4 control buttons #define VOLUMEPOT enables the volume potentiometer #define LOWBAT enables the low battery warning with light and voice #define OPRLIGHT enables the operations light on the front of the box #define OPRLIGHTTIME enables time based operations light - turns off the light after 30 Minutes #define NFCNDEF enables the use of NDEF messages to get the directory for a tag #define NFCTRACKDB enables the use of the TrackDB to get the directiry for a tag #define RESUMELAST enables the option to resume last played album upon startup. This is achieved via a file in the TrackDB and works without a tag but uses the pause/resume button instead
Fairytale2
arduino
Fairytale Main program --------------------------------------------------------------------------------------- This programm will play albums (audiobooks or music) stored on the SD card inserted into the Adafruit Music Maker Shield. Selection of the album/audiobook to play is done by placing corresponding NFC Tags on the NFC Reader. There are two pissibilities on how the connection between an NFC Tag and the corresponding album on the SD card can be setup: 1. An NDEF Message written to the tag in the form of: en [directory name] 2. Via the so called TrackDB - txt-files for each album in the directory trackdb0 NDEF Implementation --------------------------------------------------------------------------------------- This implementation is based on the Speedmaster PN532 and Don's NDEF Library. Upon detection of an NFC Tag at the reader it will check if there is at least one NDEF Message on the tag. This message must be of the form en [directory name] for example, the audiobook "Finding Nemo", stored in files in the directory /findnemo would have an NDEF message on the tag which reads as en findnemo There may also be a second NDEF message for the track to start playback with and this would be in the form of en 1 for the first track. To use this implementation you have to activate the configuration option NFCNDEF below and you will have to write the NDEF Messages with the directory name. This can bedone with the program staticNFCWriter.ino from this repository. The downside of this implementation is it's lack for an usable update of the track to start playback with - I simply could not get it to work. Secondly the implementation lacks a reliable way of detecting the absence of a tag. Therefore the playback can only be stopped by turning the box off. The third problem is with the used progmem. The two libraries also consume way more progmem than the Adafruit PN532 library due to which I switched to: TrackDB-Implementation: --------------------------------------------------------------------------------------- Upon detection of an NFC Tag, the program will retrieve the tag's UID and use this to scan what I call the TrackDB to find a matching directory to play. The TrackDB is a list of files in a special directory (TRACKDB0) on the SD card. The TrackDB files are named after the directory of the album and their respective content is of the form: taguid:directory:track For example, the audiobook "Finding Dorie" is stored in the directory /findorie on the SD Card. The corresponding TrackDB file is stored at /trackdb0/findorie.txt It contains exactly one line: 46722634231761290:findorie:1 This line connects the Tag UID with the aformentioned directory plus the number of the track with which to start playback: 46722634231761290 the UID of the NFC Tag findorie the directory from which to play the files 1 the number of the track with which to start playback - here the 1st To use this implementation you need to activate the configuration NFCTRACKDB You will also need to create the necessary TrackDb files. This can be done with the program createTrackDb.ino from this repository. Playback and controls --------------------------------------------------------------------------------------- Regardless of the way the program retrieved the information on which directory to play (NDEF message or TrackDB), it will store this in the global var plrCurrentFolder and then start a for-loop beginning with the provided first track until all consecutive numbered tracks are played - for this it counts the number of files in the given dierctory. While the album (or file) is played an operations light is fading up and down in intensity. After playback of all files is finished, the program will resume it's main loop, delay operation for roughly 15 seconds (to give the user the chance to remove the just used Tag from the reader) and then wait until it detects the next tag. While advancing through the files in the directory, the program will update the TrackDB-File with the number of the currently played track. Doing so allows for interrupted playbacks - tag is removed and later put back on when the playback will start with the last track in playback. Restrictions --------------------------------------------------------------------------------------- For this to work, a couple of restrictions are in place: 1. All filenames must be in the format trackXXX.mp3, where XXX is a numbering from 001 to 127 2. Follows from 1: You can have a maximum of 127 files per directory. I use a char to count the files in a directory to preserve memory and need the ability to return -1 in case of an error 3. All directory names must be exactly 8 chars long. You may use any combination of a-z and 0-9 chars for the directory name though 4. if a file is missing in a consecutive order, you may get a glitch in the sound 5. As the Adafruit Music Maker Shield library does not support to jump to a specific position within a file, the box can always only start from the beginning of a track. Warnings and errors --------------------------------------------------------------------------------------- On warnings or errors a warning or error light is lit up respectively. There are 3 different warning or error conditions: 1) Missing information for playback warning 2) Low Battery warning 2) Missing hardware error Errors shown via the error light (also cause the system to halt): - Music Maker Shield not found - Music Maker shield not on an interrupt enabled pin - SD card not found - NFC Reader not found Warnings shown via a light (Arduino can stay turned on): - Low battery warning (surely the arduino will turn off but until then it will operate) - no directory found for the NFC Tag (aka TrackDB is missing an entry for the Tag) - no directory found on the SD card that match the NFC Tag TrackDB record - no files in the provided directory - a missing file in a consecutive list of ordered files in the directory this may happen in case the files are not numerically ordered without a gap: track001.mp3 exist, track002.mp3 is missing but track003.mp3 exists again Additionally to the warning or error lights certain messages are spoken through the music . maker shield. Voiced errors and warnings are: - Low Battery warning - no directory found for the NFC Tag (aka TrackDB is missing an entry for the Tag) - no directory found on the SD card that match the NFC Tag TrackDB record - no file(s) in the directory on the SD card Controls --------------------------------------------------------------------------------------- 4 buttons are included: - Previous Track - play the previous track in a consecurtive list of ordered files - Next Track - play the next track in a consecurtive list of ordered files - Pause / Resume - pauses the playback or unpauses a paused playback - Light on / off - turn the operations light fader on or off The box is capable of being controlled by a remote control with the following functions - Volume Up - increase volume by 5 per click - Volume Down - decrease volume by 5 per click - Previous Track - play the previous track in a consecurtive list of ordered files - Next Track - play the next track in a consecurtive list of ordered files - Pause / Resume - pauses the playback or unpauses a paused playback - Light on / off - turn the operations light fader on or off Used Pins: --------------------------------------------------------------------------------------- NAME PIN USAGE - CLK / PN532_SCK 13 SPI Clock shared with VS1053, SD card and NFC breakout board - MISO / PN532_MISO 12 Input data from VS1053, SD card and NFC breakout board - MOSI / PN532_MOSI 11 Output data to VS1053, SD card and NFC breakout board - SHIELD_CS 7 VS1053 chip select pin (output) - SHIELD_DCS 6 VS1053 Data/command select pin (output) - DREQ 3 VS1053 Data request, ideally an Interrupt pin - CARDCS 4 SD Card chip select pin - PN532_SS 10 NFC breakout board chip select pin - infoLedPin 5 the pin to which the operation led is connected to - warnLedPin 8 the pin to which the warning led is connected to - errorLedPin 9 the pin to which the error led is connected to e.g. used for LBO of powerboost 1000c - volPotPin A0 the analog input pin that we use for the potentiometer - btnLinePin A1 pin to which the button line (4 buttons) is connected to - batLowPin A2 the pin on which the powerboost 1000c indicates a low baterry - iRRemotePin A3 the pin on which the IR Remote Receiver is connected to - programming A4 the pin the program button is connected to. The program button changes the functionality of the overall program in that (if pressed) the code will register a new tag for use with an album directory currently not connected to a tag Functionality yet to come! Configuration --------------------------------------------------------------------------------------- Some features (as e.g. Remote Control, Buttons or operation LED etc.) can be turned off or on via #define switches in the code below. #define IRREMOTE enables the IR Remote Control option #define BUTTONS enables the 4 control buttons #define VOLUMEPOT enables the volume potentiometer #define LOWBAT enables the low battery warning with light and voice #define OPRLIGHT enables the operations light on the front of the box #define OPRLIGHTTIME enables time based operations light - turns off the light after 30 Minutes #define NFCNDEF enables the use of NDEF messages to get the directory for a tag #define NFCTRACKDB enables the use of the TrackDB to get the directiry for a tag #define RESUMELAST enables the option to resume last played album upon startup. This is achieved via a file in the TrackDB and works without a tag but uses the pause/resume button instead
Fairytale25
Fairytale Main program V25
Fairytale25
Fairytale Main program V25
Documentation
Top Plate
This is the top plate onto which NFC tags attached to figures can be laid and under which the NFC board is attached
Top Plate
Buttons holder
This is the button holder that is glued in the inside of the cube to hold the buttons in place
Buttons holder
Rubber inlets
Used to close the outlets in the cube
Rubber inlets
Cube
This is the main body cube in which all components reside
Cube
Buttons holder
This is the button holder that is glued in the inside of the cube to hold the buttons in place
Buttons holder
Top Plate
This is the top plate onto which NFC tags attached to figures can be laid and under which the NFC board is attached
Top Plate
Rubber inlets
Used to close the outlets in the cube
Rubber inlets
Cube
This is the main body cube in which all components reside
Cube
Buttons
The 5 buttons that come in the front of the cube
Buttons
Comments
Only logged in users can leave comments
siliconchris
0 Followers
•0 Projects
Table of contents
Intro
0
0