Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stef1949/lumifur_controller
ESP32 controller code for an LED matrix display designed for a Protogen mask. It features various facial expressions and animations, which can be controlled via Bluetooth Low Energy (BLE) using an ESP32 development board. The project includes a boot-up animation with scrolling text and supports multiple facial expressions such as idle, happy
https://github.com/stef1949/lumifur_controller
cpp esp32 led-controller ledmatrix microcontroller protogen richies3d
Last synced: 18 days ago
JSON representation
ESP32 controller code for an LED matrix display designed for a Protogen mask. It features various facial expressions and animations, which can be controlled via Bluetooth Low Energy (BLE) using an ESP32 development board. The project includes a boot-up animation with scrolling text and supports multiple facial expressions such as idle, happy
- Host: GitHub
- URL: https://github.com/stef1949/lumifur_controller
- Owner: stef1949
- License: bsd-3-clause
- Created: 2024-11-03T03:57:46.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T18:40:22.000Z (3 months ago)
- Last Synced: 2024-11-10T19:39:46.409Z (3 months ago)
- Topics: cpp, esp32, led-controller, ledmatrix, microcontroller, protogen, richies3d
- Language: C++
- Homepage:
- Size: 33.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LumiFur Controller
A program for controlling an LED matrix display for a Protogen mask, featuring various facial expressions and Bluetooth LE control with an ESP32.
## Table of Contents
- [Features](#features) ✨
- [Hardware Requirements](#hardware-requirements) 🛠️
- [Software Requirements](#software-requirements) 💻
- [Installation](#installation) ⚙️
- [Usage](#usage) 📖
- [Facial Expressions](#facial-expressions) 😃
- [Contributing](#contributing) 🤝
- [License](#license) 📜
## Features ✨
- Multiple facial expressions (idle, happy, angry, playful, silly, kinky, and more)
- Smooth blinking animations
- Bluetooth Low Energy (BLE) connectivity to switch expressions remotely
- Boot-up animation with scrolling text
## Hardware Requirements 🛠️
- ESP32 development board
- 14 x MAX7219 8x8 LED matrix modules
- Connecting wires and power supply
## Software Requirements 💻
- VSCode with PlatformIO Extension
- MD_MAX72XX library
- NimBLE-Arduino library
## Installation ⚙️
1. Clone the repository:
```sh
git clone https://github.com/stef1949/LumiFur_Controller.git
```
2. Install the required libraries in Arduino IDE:
### MD_MAX72XX Library:
- Go to Sketch > Include Library > Manage Libraries...
- Search for MD_MAX72XX and install it.
### NimBLE-Arduino Library:
- Follow the installation instructions here.
3. Open the project:
- Open main.cpp in the Arduino IDE.
4. Configure hardware settings if necessary:
- Check the pin definitions (CLK_PIN, DATA_PIN, CS_PIN) and adjust them to match your setup.
## Usage 📖
1. Connect your ESP32 to the computer via USB.
2. Select the correct board and port in the Arduino IDE.
3. Click Upload to flash the code.
### Assemble the hardware:
- Connect the LED matrix modules to the ESP32 according to your wiring configuration.
### Operate the Protogen mask:
1. Power on the device.
2. The mask will display the default idle face with animations.
3. Use the LumiFur app to connect to 'LumiFur_BLE'.
4. Send values between 1 and 8 to change facial expressions.
### Facial Expressions 😃
- 1 - Idle Face
- 2 - Happy Face
- 3 - Angry Face
- 4 - Playful Face
- 5 - Silly Face
- 6 - Kinky Face
- 7 - Death Face
- 8 - Edgy Face
## Contributing 🤝
Contributions are welcome! Please fork the repository and submit a pull request with your improvements.
## License 📜
This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.