https://github.com/nopnop2002/esp-idf-dfplayermini
DFPlayer - A Mini MP3 Player For ESP-IDF
https://github.com/nopnop2002/esp-idf-dfplayermini
dfplayer-mini esp-idf esp32 mp3 mp3-player
Last synced: about 1 year ago
JSON representation
DFPlayer - A Mini MP3 Player For ESP-IDF
- Host: GitHub
- URL: https://github.com/nopnop2002/esp-idf-dfplayermini
- Owner: nopnop2002
- License: mit
- Created: 2023-01-23T08:03:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T06:17:31.000Z (about 2 years ago)
- Last Synced: 2024-05-23T06:44:02.869Z (about 2 years ago)
- Topics: dfplayer-mini, esp-idf, esp32, mp3, mp3-player
- Language: C
- Homepage:
- Size: 1.48 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esp-idf-DFPlayerMini
DFPlayer - A Mini MP3 Player For ESP-IDF.
ESP32 has I2S output function.
By using ESP-ADF and I2S amplifier, MP3 files can be played.
However, ESP-ADF is esoteric and also depends on a specific version of ESP-IDF.
Also, for ESP32C2, I can't find any mention of I2S.
I made this for the purpose of playing MP3 files more easily.
I ported from [here](https://github.com/DFRobot/DFRobotDFPlayerMini) and used [this](https://github.com/nopnop2002/esp-idf-serial) component.
# Software requirements
ESP-IDF V5.0 or later.
ESP-IDF V4.4 release branch reached EOL in July 2024.
# Hardware requirements
DFPlayer - A Mini MP3 Player For Arduino.
https://www.dfrobot.com/index.php?route=product/product&product_id=1121
__Note for MP3-TF-16P__
Many suppliers sell MP3-TF-16P as DFPlayerMini.
However, since they are completely different products, they are not fully compatible.
This repository supports MP3-TF-16P, but I'm not sure if all features work.
The two on the top are MP3-TF-16P.
# MP3 Chip
DF Player Mini's MP3 IC has a wide variety of variations.
I own three DF Players, two with JC AA18 and one with YX5200.
JC AA18 works very stable.
But YX5200 give me this error sometime:
```
sending:7e ff 6 6 0 0 1e fe d7 ef
sending:7e ff 6 3 0 0 1 fe f7 ef
received:7e ff 6 40 0 0 4 fe b7 ef
DFPlayerError:Check Sum Not Match
```
In addition to this, there are YM5200, YM5300, MH2024K, GD3200B, etc.
There are also articles like this.
https://github.com/arendst/Tasmota/discussions/11737
https://forum.arduino.cc/t/df-player-warning/952842
https://discourse.voss.earth/t/probleme-mit-dem-dfplayer-mini/12203
# Installation
Copy all the contents of mp3Data to the SD card.
Insert the SD card into the player.
```Shell
git clone https://github.com/nopnop2002/esp-idf-DFPlayerMini
# mount your SD card
cp esp-idf-DFPlayerMini/mp3Data/* your_SD_card
# unmount your SD card and insert the SD card into the player
cd esp-idf-DFPlayerMini/GetStarted
idf.py menuconfig
idf.py flash
```
# Configuration
If you have problems, please enable debug mode.
# Wiring with built-in amplifier
|ESP32||DFPlayerMini||Speker|
|:-:|:-:|:-:|:-:|:-:|
|3.3V|--|VCC|||
|GPIO4(*)|--|RX|||
|GPIO5(*)|--|TX|||
|||SPK+|--|Speaker+|
|GND|--|GND|||
|||SPK-|--|Speaker-|
(*) You can change it using menuconfig.
__The built-in amplifier of this module is very sensitive to noise.__
Typical circuit
# Wiring with an external amplifier
|ESP32||DFPlayerMini||AMP|
|:-:|:-:|:-:|:-:|:-:|
|3.3V|--|VCC|--|VCC|
|GPIO4(*)|--|RX|||
|GPIO5(*)|--|TX|||
|||DAC_R|--|Right Channl Input|
|||DAC_I|--|Left Channl Input|
|GND|--|GND|--|GND|
Typical circuit
# Micro SD Card
I've tried several different brands of SD cards and some don't work.
I get this error.
I fixed it by replacing the SD card with another brand.
It's probably related to the power consumption of the SD card.
```
received:7e ff 6 3b 0 0 2 fe be ef
Card Removed!
```
# About sample mp3 data
I borrowed from here.(Japanese site)
This is a typical alarm used in elementary and junior high schools in Japan to announce the start and end of classes.
https://otologic.jp/free/se/school_bell01.html#google_vignette
# API
```
//----Mp3 play----
DF_next(); //Play next mp3
DF_previous(); //Play previous mp3
DF_play(1); //Play the first mp3
DF_loop(1); //Loop the first mp3
DF_pause(); //pause the mp3. This cannot be resumed, so it is the same as stop.
DF_start(); //start the mp3 from the pause
DF_playFolder(15, 4); //play specific mp3 in SD:/15/004.mp3; Folder Name(1~99); File Name(1~255)
DF_enableLoop(); //start loop current mp3 file.
DF_disableLoop(); //stop loop current mp3 file.
DF_enableLoopAll(); //start loop all mp3 files in SD.
DF_disableLoopAll(); //stop loop all mp3 files in SD.
DF_playMp3Folder(4); //play specific mp3 in SD:/MP3/0004.mp3; File Name(0~65535)
DF_advertise(3); //advertise specific mp3 in SD:/ADVERT/0003.mp3; File Name(0~65535)
DF_stopAdvertise(); //stop advertise
DF_playLargeFolder(2, 999); //play specific mp3 in SD:/02/004.mp3; Folder Name(1~10); File Name(1~1000)
DF_loopFolder(5); //loop all mp3 files in folder SD:/05.
DF_randomAll(); //Random play all the mp3.
//----Read imformation----
printf("%d",DF_readState()); //read device state
printf("%d",DF_readVolume()); //read current volume
printf("%d",DF_readEQ()); //read EQ setting
printf("%d",DF_readPlaybackMode()); //read playback mode setting
printf("%d",DF_DF_readSoftVersion()); //read software version
printf("%d",DF_readFileCounts(DFPLAYER_DEVICE_SD)); //read all file counts in SD card
printf("%d",DF_readCurrentFileNumber(DFPLAYER_DEVICE_SD)); //read current play file number in SD card
printf("%d",DF_readFileCountsInFolder(3)); //read fill counts in folder SD:/03
```
# For more info
Document is [here](https://picaxe.com/docs/spe033.pdf).
Product information is [here](https://www.dfrobot.com/wiki/index.php/DFPlayer_Mini_SKU:DFR0299).
# How to use this component in your project
Create idf_component.yml in the same directory as main.c.
```
YourProject --+-- CMakeLists.txt
+-- main --+-- main.c
+-- CMakeLists.txt
+-- idf_component.yml
```
Contents of idf_component.yml.
```
dependencies:
nopnop2002/DFPlayerMini:
path: components/DFRobotDFPlayerMini/
git: https://github.com/nopnop2002/esp-idf-DFPlayerMini.git
```
When you build a projects esp-idf will automaticly fetch repository to managed_components dir and link with your code.
```
YourProject --+-- CMakeLists.txt
+-- main --+-- main.c
| +-- CMakeLists.txt
| +-- idf_component.yml
+-- managed_components ----- nopnop2002__DFPlayerMini
```