Welican Gemina

A custom ESP32 module that controls WS2811 lights, a 1.3" OLED I2C, a MSGEQ7 Microphone board, and 2 encoders.

Your README file is normally the first entry point to your code. It should tell people why they should use your module, how they can install it, and how they can use it. Standardizing how you write your README makes creating and maintaining your READMEs easier. Great documentation takes work!

This repository contains:

1. Board Design to show the custom ESP32 boarddesigned for this project.

TODOs

• WIFI Manager
• Saving Favorites
  • Favorites Menu
• Settings
  • Set Led Count
  • Show IP
  • Timeout (short, medium, long, extra long, never)
    • Show Weather/Clock
    • Turn off
  • Clock Types
  • Random Mode Speed (short, medium, long, extra long, never)
  • Color Order (RGB, GRB, etc)
  • Factory Reset (reset EPROM values to default, favorites, highscores)
• Random Mode at beginning of categories
• Fade between patterns (to prevent quick spins on pattern knob)
• Audio Input morphs Music Visualizer category lights
• More visualizers (VZ)
  • Random VZ for each category (at the beginning of category)
  • Differnt types of random (at the end of category)
• Weather status
  • By Zipcode
  • VZ based on weather
• Get Time
  • Show time in top menu

Table of Contents

• Background
• Install
  • Install Arduino Libraries
  • VS Code & C++
• Related Documents
• Maintainers
• Contributing
• Helpful Links
• FastLed Examples
• License

Background

  // TODO add stuff

Install

This project requires the Arduino IDE.

1. Install Arduino IDE.

2. In the Ardunio IDE, go to File > Preferences (CTRL + Comma).

   

3. Enter https://dl.espressif.com/dl/package_esp32_index.json into the “Additional Board Manager URLs” field as shown in the figure below. Then, click the “OK” button.

   

• Note: if you already have the ESP8266 boards URL, you can separate the URLs with a comma as follows: https://dl.espressif.com/dl/package_esp32_index.json, http://arduino.esp8266.com/stable/package_esp8266com_index.json

4. Open the Boards Manager. Go to Tools > Board > Boards Manager

   

5. Search for ESP32 and press install button for the “ESP32 by Espressif Systems“

   

   • That’s it! Make sure to change the Board under the Tools menu to “ESP32 Dev Module”

Install Arduino Libraries

6. Libraries Tools > Manage Libraries (Location is User Directory\Documents\Arduino\libraries)

• ESP32Encoder
• FastLED
  • FastLED Samguyer Fork *Optional
• arduinoFFT
• U8g2
• ESPAsyncWebServer *Must be installed manually
• ASyncTCP *Must be installed manually
• ESP32 File System Tool *Must be installed manually by copying to Tools folder!! Read instructions carefully.

Create Wifi Credentials file

7. Create a file called Secrets.h in the main folder. That file should include the following:

#define WIFI_SSID "your-wifi-ssid-goes-here"
#define WIFI_PASSWORD "your-wifi-password-goes-here"
#define OPEN_WEATHER_API_KEY "your-open-weather-api-key"

You will need to replace the strings with your WIFI SSID and PASSWORD

VS Code & C++

• .vscode/c_app_properties.json
• Arduino Extension
• C++ Extension
• GitLens Extension

Related Documents

• Welican Project Doc - The brain-dump file created by @Kinectus
• BOM - Price / Cost spreadsheet created by @Kinectus

Maintainers

• @Kinectus

• @MaylorTaylor

Contributing

Feel free to dive in! Open an issue or submit PRs.

Standard Readme follows the Contributor Covenant Code of Conduct.

Helpful Links

• C++ Classes
• Custom XBM Image Convert
• Arduino C++ & VSCode
• Arduino Intellisense VSCode
• Experimental FastLED RGBSet
• Refactoring out DELAY
• UG82 Screen Library
• Strings for CPP

FastLED Examples

• Demos
• Demos 2
• Demos 3
• Flagpole
• Chase Demo

License

MIT License © Welican LLC