Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 2.46 KB

README.md

File metadata and controls

31 lines (19 loc) · 2.46 KB
Raw

Lixie II

Lixie II for Arduino

This library is still maturing, but all of the functionality from the original Lixie 1/Edgelit libraries is here! For now, you can refer to the Getting Started Guide, the included "Introduction Tour" example, or the original Lixie 1 library documentation for its usage is almost identical. There is now support for all but a few deprecated "Lixie 1" functions. Just change any ocurrance of "Lixie" in your code with "Lixie_II".

WARNING

UNLIKE THE ORIGINAL LIXIE LIBRARY, THIS ONE REALLY PREFERS THE ESPRESSIF/XTENSA ARCHITECTURE. (ESP8266 / ESP32)

This design choice 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 older controllers like Arduino Unos, Micros, Pro Minis and Megas 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 Lixie II.

Installation

The Lixie II library relies on the FastLED library from Daniel Garcia, so make sure you have that installed as well! You can get it via the Arduino Library Manager in your Arduino window by clicking "Sketch > Include Library > Manage Libraries" and searching for "FastLED" in the smaller window that appears. (Just click "Install" for the latest version)

Installing the Lixie II Library

With Arduino Library Manager:

  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:

  1. Click "Clone or Download" above to get an "Lixie_II-master.zip" file.
  2. Extract its contents to the libraries folder in your Arduino sketchbook. ("C:/Users/YOUR_USERNAME/Documents/Arduino/libraries" on Windows)
  3. Rename the folder from "Lixie_II-master" to "Lixie_II".