gratux/rgb-cat-ears-esp32
1
0
Fork 0
mirror of https://dojo.spaceturtle.ninja/cats/rgb-cat-ears-esp32.git synced 2026-04-30 16:39:28 +02:00
Code Issues Projects Releases Packages Wiki Activity
ESP32 code for the RGB cat ears
51 commits 2 branches 0 tags 436 KiB
  • C 55.9%
  • C++ 42.4%
  • CMake 1.2%
  • Nix 0.5%
Find a file
Exact
Manuela Leipold ef8f30eab6 removed some comments
2026-03-13 10:33:13 +01:00
components removed some comments 2026-03-13 10:33:13 +01:00
main collision 2026-03-12 23:11:39 +01:00
.envrc Add direnv 2025-12-24 20:06:48 +01:00
.gitignore Add direnv 2025-12-24 20:06:48 +01:00
CMakeLists.txt Rename ESP-IDF project 2025-07-23 22:56:39 +02:00
flake.lock Add nix flake 2025-07-17 23:58:54 +02:00
flake.nix Add nix flake 2025-07-17 23:58:54 +02:00
Makefile Rename ESP-IDF project 2025-07-23 22:56:39 +02:00
README.md Basic OTA 2025-07-23 23:22:22 +02:00
sdkconfig.defaults Basic OTA 2025-07-23 23:22:22 +02:00

README.md

RGB Cat Ears: ESP32 Code

Based on ESP-IDF BLE Peripheral Example, ESP-ADF LED Pixel Display Example and ESP-IDF Native OTA Example.

Prerequisites

For normal Usage

  • A device that has the ability to flash an ESP32
    • This can be any device capable of running esptool or any device with WebUSB support
  • Refer to the main repository for a hardware overview

For development

Nix development environment

Classic development environment

ESP-IDF VS Code extension
  1. Espressif offers an official VS Code extension that has a built-in setup tool
  2. Try it first, before resorting to manual installation
Manual installation
  1. Create a directory for the toolchain: mkdir -p ~/esp && cd ~/esp
  2. Clone ESP-ADF version v2.7:
    • git clone https://github.com/espressif/esp-adf.git --recursive --branch=v2.7
  3. Clone ESP-IDF version v5.3.3:
    • git clone https://github.com/espressif/esp-idf.git --recursive --branch=v5.3.3
  4. Install the ESP-IDF toolchain: cd ~/esp/esp-idf && ./install.sh all
  5. Source the ESP-IDF environment: . ~/esp/esp-idf/export.sh
    • You either have to do this for every shell you intend to build the project in, or add this to your shell profile
  6. Install the ESP-ADF toolchain: cd ~/esp/esp-adf && ./install.sh
  7. Source the ESP-ADF environment: . ~/esp/esp-adf/export.sh
    • You either have to do this for every shell you intend to build the project in, or add this to your shell profile

Refer to the ESP-IDF docs and ESP-ADF docs for more details.

How to use

  1. Build the hardware as described in the main repository
  2. Flash the binary
  3. After flashing, use the web app to connect to the microcontroller running this software

How to develop

  1. If using Nix: First enter the dev shell using nix develop
  2. You can use VS Code with the C/C++ extension and the CMake Tools extension as an IDE
    • To open VS Code in the current directory, run code .
  3. Run this command once to set the correct target: 
    idf.py set-target esp32c3
  4. To build and flash the project and then open the serial monitor, run the following: 
    idf.py build flash monitor

How to deploy

  1. TBD