Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/riwanou/esp32-music-player
ESP32 music player using a buzzer and controlled by a web dashboard, a project from the master's program at Sorbonne University.
https://github.com/riwanou/esp32-music-player
Last synced: 2 days ago
JSON representation
ESP32 music player using a buzzer and controlled by a web dashboard, a project from the master's program at Sorbonne University.
- Host: GitHub
- URL: https://github.com/riwanou/esp32-music-player
- Owner: riwanou
- License: mit
- Created: 2024-04-26T10:16:52.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-26T10:20:45.000Z (9 months ago)
- Last Synced: 2024-11-11T19:43:12.816Z (2 months ago)
- Language: C
- Size: 2.04 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESP32 Music Player
## Overview
This project is an ESP32-based music player controlled via a web dashboard.
The ESP32 communicates with the web server using MQTT, with a broker hosted on
a raspberrypi.
Features include:
- Sending text to display on the ESP32 screen from the web dashboard.
- Real-time display of the ESP32 button status on the web dashboard.
- Fully functionnal music player with music selection, play/pause, next and
previous tracks, and display of song cover. The music is played using a buzzer
on the ESP32. Current song and player status are saved on the web server, so
refreshing the browser won't cause data loss.
- Play/pause the music player with the ESP32 button, this will be synced with
the webdashboard.
## Getting Started
To flash the code onto the ESP32 using `plateform.io`, refer to `esp32/
platformio.ini` for more details. You will need to modify the SSID and WIFI_PASS
in `esp32/main.cpp` to match your WIFI access point.
```bash
# get the compile_commands for use with clangd
pio run --target compiledb
# flash
pio run --target upload
# get the output
pio device monitor
```
Run the web server using Python. By default, the server run on port 8000,
and will try to connect to an MQTT broker. We are hosting a MQTT broker in a
raspberryPI using `mosquitto`. You can adjust the MQTT broker configuration
in `main.py`.
```bash
# install needed packages
pip3 install "paho-mqtt<2.0.0"
# start the webserver and MQTT client
python3 webserver/main.py
```
Then, you can access the web dashboard in your browser at `http://localhost:8000/`.
## Acknowledgements
A big thanks to the following open-source projects:
- [arduino songs](https://github.com/robsoncouto/arduino-songs): provide songs usable by the arduino buzzer.
- [mosquitto](https://mosquitto.org): an open source MQTT broker.
- [paho-mqtt](https://pypi.org/project/paho-mqtt/): a client library for MQTT.
- [arduino](https://www.arduino.cc): provide a library for interacting with the ESP32 components.
- [plateformio](https://platformio.org): ecosystem for IoT development.
- [beautiful shadow](https://getcssscan.com/css-box-shadow-examples): handpicked shadow styles.
- [heroicons](https://heroicons.com/): beautiful svg icons.