Qwiic MP3 Trigger Hookup Guide a learn.sparkfun.com tutorial

Available online at: http://sfe.io/t859

Contents

Introduction

Sometimes you just need to play an MP3 file. Whether it's a sound track as you enter the room or a pirate cackling when a dollar gets donated to the kid's museum. The Qwiic MP3 Trigger takes care of all the necessary bits, all you need to do is send a simple I2C command and listen.

SparkFun Qwiic MP3 Trigger

SparkFun Qwiic MP3 Trigger

DEV-15165
$19.95
4

Required Materials

The Qwiic MP3 Trigger does need a few additional items for you to get started, shown below. However, you may already have a few of these items, so feel free to modify your cart as necessary.

Hamburger Mini Speaker

Hamburger Mini Speaker

COM-14023
$4.95
2
USB 2.0 Cable A to C - 3 Foot

USB 2.0 Cable A to C - 3 Foot

CAB-15092
$3.95
microSD Card - 1GB (Class 4)

microSD Card - 1GB (Class 4)

COM-15107
$4.95
USB Wall Charger - 5V, 1A (Black)

USB Wall Charger - 5V, 1A (Black)

TOL-11456
$3.95
2
Note: If you want to add hardware connections for the triggers, you will probably some soldering equipment, hook-up wire, and some momentary buttons. Additionally, if you wish to interface with the board using a microcontroller, you should also grab a RedBoard Qwiic and some Qwiic cables.

Suggested Reading

If you’re unfamiliar with switches, jumper pads, or I2C be sure to checkout some of these foundational tutorials.

Logic Levels

Learn the difference between 3.3V and 5V devices and logic levels.

Switch Basics

A tutorial on electronics' most overlooked and underappreciated component: the switch! Here we explain the difference between momentary and maintained switches and what all those acronyms (NO, NC, SPDT, SPST, ...) stand for.

I2C

An introduction to I2C, one of the main embedded communications protocols in use today.

How to Work with Jumper Pads and PCB Traces

Handling PCB jumper pads and traces is an essential skill. Learn how to cut a PCB trace, add a solder jumper between pads to reroute connections, and repair a trace with the green wire method if a trace is damaged.

Qwiic Connect System

The Qwiic Keypad utilizes the Qwiic connect system. We recommend familiarizing yourself with the Logic Levels and I2C tutorials (above) before using it. Click on the banner above to learn more about our Qwiic products.

Hardware Overview

Electrical Characteristics

The Qwiic MP3 Trigger is designed to operate at 3.3V and must not be powered above 3.6V as this is the maximum operating voltage of microSD cards. The 5V power from the USB C connector tied to a robust AP2112 3.3V voltage regulator that can source up to 600mA for the board. Otherwise, the board can also be powered through the Qwiic connector.

Maximum Operating Voltages

All I/O pins are 5V tolerant but the board must but powered at 3.3V.

Recommended Operating Voltages

All I/O pins are designed to function at 3.3V. The board consumes 35mA at 3.3V in standby and can consume over 400mA when driving at 8 Ohm speaker at max volume.

Note: The Qwiic MP3 Trigger can be powered through either the USB C cable or the Qwiic connector when used in conjunction with the RedBoard Qwiic. However, when using the Qwiic connection make sure that the 3.3V line can source enough current for the amplifier.

MP3 and ATtiny84

At the heart of the Qwiic MP3 Trigger is the WT2003S MP3 decoder IC. This IC reads MP3s from the microSD card and will automatically mount the SD card as a jump drive if USB is detected. The ATtiny84A receives I2C commands and controls the MP3 decoder.

WT2003S IC and ATtiny84A IC

SD and USB

The SparkFun Qwiic MP3 Trigger works with 512MB to 32GB cards formatted in FAT32. We recommend the SparkFun 1GB MicroSD Card because it’s a good mix of low-cost and good performance for MP3 playing. Up to 255 songs can be loaded onto Qwiic MP3 Trigger.

The USB C and microSD connectors on the SparkFun Qwiic MP3 Trigger

The easiest way to add and remove MP3s to the Qwiic MP3 Trigger is to attach a USB C cable. This will enumerate the microSD card as a jump drive making it extremely easy to access the files on the card. Alternatively, if you don’t want to use USB, you can eject the microSD card and read/write to it using a normal USB SD adapter.

Qwiic Connectors

The Qwiic MP3 Trigger from SparkFun includes two Qwiic connectors to make daisy chaining this music player with a large variety of I2C devices. Checkout Qwiic for your next project.

Highlighted I2C port and Qwiic connectors

The I2C pins broken out on the board are tied directly to the Qwiic connectors.

Audio Amplifier

The speaker is boosted by a Class-D mono amplifier capable of outputting up to 1.4W. What does 1.4W mean? It's incredibly loud; great for making sure your mech effects are heard on the *con floor (i.e. _Comic_ - con, _Def_ - con, etc.) and wonderful for annoying your officemates. Both outputs have volume controlled by the SET_VOLUME command and is selectable between 32 levels. Additionally, there are PTH holes beside both connectors if a soldered connection is preferred.

Class D Amplifier on SparkFun Qwiic MP3 Trigger

Note: The volume can be adjusted in software using the SET_VOLUME 0x07 command (see Command Set section). The volume setting is saved to NVM (non-volatile memory) and loaded at power on.

Audio Outputs

A standard 3.5mm audio jack is provided making it easy to play your tunes over headphones or amplified desktop speakers like our Hamburger Speaker or any other amplifier.

3.5mm audio jack and poke-home connectors

A poke-home connector labeled Speaker is also provided in parallel to the 3.5mm jack. This is a friction fit type connector; simply push stranded or solid core wire (22AWG or larger) into the hole and the connector will grip the wire.

To use an external speaker, solder two wires onto the speaker and insert the wires into the poke home connector.

Inserting tinned speaker wires into the Qwiic MP3 Trigger

Wire inserted into the poke home connector.

To remove, push down on the tab with a ballpoint pen and gently pull on the wire.

Using pen to remove wire from poke home connector

Using pen to remove wire from poke home connector.

Jumpers

The Qwiic MP3 Trigger has three jumpers shown below:

Three jumpers on the SparkFun Qwiic MP3 Trigger

The default 7-bit I2C address of the Qwiic MP3 Trigger is 0x37. The ADR jumper is open be default and can be closed with solder to force the device’s I2C address to 0x36. This is handy if you need to have two Triggers on the same bus. If you need more than two devices on the bus, or if these addresses conflict with another I2C device the address can be changed in software. Please see the Command Set.

Cutting the I2C jumper will remove the 2.2k Ohm resistors from the I2C bus. If you have many devices on your I2C bus you may want to remove these jumpers. Not sure how to cut a jumper? Read here!

The INT jumper is located below the SparkFun logo and connects a 10K pull-up resistor to the INT pin. If you have multiple, open-drain, interrupt pins connected together you may want to remove this pull-up to better control the pull-up resistance.

I/O Pins

There are several I/O pins broken out on the board, which are described in the table below.

Pins on the Qwiic MP3 Player

Pin Name Type Description
RST Input Active low. Pull this pin low to reset the ATtiny84A, effectively resetting the Qwiic MP3 Trigger.
INT Output Active low. Goes low when track is finished playing. Goes high again when CLEAR_INTERRUPTS command is issued.
SCL Input Serial clock line of I2C interface. Qwiic MP3 Trigger does implement clock stretching and will hold the clock line low if it is unable to receive additional I2C data.
SDA Input/Output Serial data line of I2C interface.
3.3V Power Qwiic MP3 Trigger can be powered from 2.8V to 3.3V. Anything greater than 3.6V will damage the microSD card.
GND Power The ground pin.
Trigger 1-4 Input When a trigger pin is pulled to ground, the corresponding T00X.mp3 file is played. Pins can be combined to play T001 to T010. Pins are 5V tolerant.

Triggers

There are four trigger pins at the top of the board. When pulled low these pins begin playing whatever file is named T001.mp3 to T010.mp3. For example, if you attach a momentary button to Pin 3 and GND, when you press that button the T003.mp3 file will immediately be played. This allows you to start playing sound effects with the touch of a button without any programming!

Four trigger pins at the top of Qwiic MP3 Trigger

Single Trigger

For a basic triggered setup, load four files named T001.mp3, T002.mp3, T003.mp3, and T004.mp3 on the microSD card. Use a wire or button to connect a trigger pin to ground and the associated track will begin playing. Once you have the setup working, use any momentary button to allow a user to cause an MP3 to start playing.

Using Multiple Triggers

By pulling multiple pins down simultaneously the four triggers can play up to ten tracks: T001 to T010. When a trigger pin is detected the pin values are added together. For example, pulling pins 2 and 4 low at the same time will play track T006.mp3 as will pulling pins 1, 2, and 3 low at the same time.

Interrupt Pin

The Qwiic MP3 Trigger has an INT pin which is configured as an open-drain pin with an on board 10K Ohm pull-up.

INT pin and jumper

The INT pin will go low when a track has stopped playing. Once the CLEAR_INTERRUPTS 0x0D command has been received, the INT pin will become high-impedance and will return to a high level.

If you have multiple devices with bussed interrupt pins you may want to cut the INT jumper to remove the 10K pull-up resistor.

Qwiic MP3 Trigger Library

Note: This section assumes you are using the latest version of the Arduino IDE on your desktop. If this is your first time using Arduino, please review our tutorial on installing the Arduino IDE. If you have not previously installed an Arduino library, please check out our installation guide.

The SparkFun Qwiic MP3 Trigger Arduino library demonstrates how to control all the features of the Qwiic MP3 Trigger. We recommend downloading the SparkFun library through the Arduino library manager by searching 'SparkFun MP3 Trigger'. Alternatively you can grab the zip here from the GitHub repository:

SparkFun Qwiic MP3 Trigger Arduino Library (ZIP)

Once you have the library installed checkout the various examples.

Command Set

The SparkFun Qwiic MP3 Trigger library takes care of all these commands for you. However, if you want to implement your own interface, the following commands are available (see list below). The Qwiic MP3 Trigger uses standard I2C communication to receive commands and send responses. By default, the unshifted I2C address of the Qwiic MP3 Trigger is 0x37. The write byte is 0x6E and the read byte is 0x6F.

Here is an example I2C transaction showing how to set the volume level to 10:

Logic trace showing 0x6E 0x07 0x0A

Here is an example I2C transaction showing how to read the device ID (0x39):

Logic trace showing 0x6E 0x10 0x6F 0x39

The following commands are available:

Command Que

The ATtiny84A receives commands over I2C. It then records the I2C commands into a command que. The que is sent FIFO over serial to the WT2003S at 9600bps. The WT2003S then requires an undetermined amount of time to respond. This means that commands are not instantaneously executed by the Qwiic MP3 Trigger and some commands may require a certain amount of time to before the Qwiic MP3 Trigger has loaded a valid response.

I2C traces showing how to read a song name

An Example GET_SONG_NAME. Do you know the answer?

For example, GET_SONG_NAME can be issued by the master microcontroller to the Qwiic MP3 Trigger. The QMP3 then transmits a serial command to the WT2003S. After a certain amount of time (unfortunately there are no max times defined by the WT2003S datasheet) the WT2003S will respond via serial. This can take 15 to 40ms. At that time, the song name will be loaded onto the Qwiic MP3 Trigger and can be read over I2C by the master microcontroller.

In order to avoid clock stretching by the Qwiic MP3 Trigger and tying up the I2C bus, the Qwiic MP3 Trigger will release the bus after every command is received. Therefore, it is up to the user to wait the minimum 50ms between the WRITE GET_SONG_NAME and the READ I2C commands.

Power Up Time

The MP3 decoder IC on the Qwiic MP3 Trigger is the WT2003S. It requires approximately 1500ms after power on to mount the SD card. Normally, the Qwiic MP3 Trigger is powered while the user writes and re-writes sketches so the user does not notice this boot time. The boot time only comes into effect when user initially powers their project. The main controller (such as an Uno) needs to wait up to 2 seconds before giving up communicating with the Qwiic MP3 Trigger. The SparkFun Qwiic MP3 Trigger library takes care of the 2 second wait but if you’re writing your own implementation then consider the following example code:

language:c
if (isConnected() == false)
{
    delay(2000); //Device may take up to 1500ms to mount the SD card

    //Try again
    if (isConnected() == false)
        return (false); //No device detected
}
return (true); //We're all setup!

Maximum Song Count

Up to 255 songs can be loaded onto Qwiic MP3 Trigger and triggered through the command interface.

Example 1: Play Track 1

The Qwiic MP3 Trigger can be used both as a standalone board or with the Qwiic connect system. In this case, we will be using the RedBoard Qwiic as the microcontroller in the Qwiic system.

For both options, make sure to load an MP3 file labeled T001.mp3 onto the MicroSD card.

Standalone: Using Trigger 1

By default the firmware installed on the ATtiny84 allows you to play tracks using the triggers. For more details, see the Triggers section of the Hardware Overview. Simply plug in the SD card, power the Qwiic MP3 Trigger, and short the Trigger Pin 1 to GND. Everytime you short both pins, T001.mp3 will play.

Using trigger pins

Triggering the first track to play by shorting Trigger 1 with a pair tweezers. Click on image for a closer view of the hardware setup.

Arduino Library: Using RedBoard Qwiic

Plug in the SD card into the MP3 Trigger. Then, connect the Qwiic MP3 Trigger to the RedBoard Qwiic using a Qwiic cable.

Triggering with a RedBoard

Triggering the first track to play through the Qwiic connection. Click on image for a closer view of the hardware setup.

Upload Example1-PlaySong.ino using the Arduino IDE to the RedBoard Qwiic. Once uploaded, the RedBoard will check for the Qwiic MP3 Trigger, set the volume to 10 and then play T001.mp3. Pressing the RESET button on the RedBoard will run the sketch again.

Resources and Going Further

Have fun with your new tunes maker!

For more on the Qwiic MP3 Trigger, check out the links below:

Need some inspiration? Check out some of these related tutorials:

MP3 Player Shield Music Box

Music Box Project based on the Dr. Who TARDIS.

Sound Page Guide

How to use the Lilypad MP3 Player and some Bare Conductive Paint to make a fandom silhouette sound trigger page.

Photon Battery Shield Hookup Guide

The Photon Battery Shield has everything your Photon needs to run off, charge, and monitor a LiPo battery. Read through this hookup guide to get started using it.

Check out these other Qwiic tutorials:

Transparent Graphical OLED Breakout Hookup Guide

The future is here! Our Qwiic Transparent Graphical OLED Breakout allows you to display custom images on a transparent screen using either I2C or SPI connections.

Qwiic Human Presence Sensor (AK9753) Hookup Guide

How to get started with your Qwiic enabled AK9753 Human Presence Sensor.

LTE Cat M1/NB-IoT Shield Hookup Guide

The SparkFun LTE CAT M1/NB-IoT Shield equips your Arduino or Arduino-compatible microcontroller with access to data networks across the globe. This shield adds wireless, high-bandwidth cellular functionality to your IoT project!

Qwiic Twist Hookup Guide

Take your volume knob beyond 11 with the Qwiic Twist digital RGB LED encoder via I2C!

Or check out these blog posts:

Enginursday: The Dug Collar

July 12, 2018

The MP3 Music Box

February 19, 2019

Enginursday: The Qwiic Jukebox

April 4, 2019

Enginursday: 3D Printed Harry Potter Talking Head

August 8, 2019

learn.sparkfun.com | CC BY-SA 3.0 | SparkFun Electronics | Niwot, Colorado