README.md 1.9 KB
Lixie II for Arduino
This library is still maturing, but 95% of the functionality from the original Lixie 1/Edgelit libraries is here! For now, you can refer to the original library documentation for its usage is almost identical. Just change any ocurrance of "Lixie" in your code with "Lixie_II".
WARNING
UNLIKE THE ORIGINAL LIXIE LIBRARY, THIS ONE PREFERS THE ESPRESSIF/XTENSA ARCHITECTURE. (ESP8266 / ESP32 - NOT AVR)
This decision was made to allow for non-blocking animation code, as the Ticker library or ESP32's second core are great for this. The vast majority of Lixie 1 users were using Espressif controllers anyways for a cheap gateway for the Lixies to fetch internet time, stocks, analytics, etc. This means that any Arduino Unos, Micros, Pro Minis, Megas, those old controllers are still supported, but the animation system may bog things down slightly. If you haven't tried them yet, the Espressif microcontrollers are amazing - and unless you're going for low-power, (Lixies are not) AVR isn't quite right for something like this anymore.
Installation
The Lixie library relies on the FastLED library from Daniel Garcia, so make sure you have that installed as well!
~With Arduino Library Manager:~ COMING SOON!
~1. Open Sketch > Include Library > Manage Libraries in the Arduino IDE.~ ~2. Search for "Lixie_II", and select the latest version.~ ~3. Click the Install button and Arduino will prepare the library and examples for you!~
Manual Install:
- Click "Clone or Download" above to get an "Lixie_II-master.zip" file.
- Extract its contents to the libraries folder in your Arduino sketchbook. (".../Documents/Arduino/libraries" on Windows)
- Rename the folder from "Lixie_II-master" to "Lixie_II".