Quick start - sblantipodi/firefly_luciferin GitHub Wiki

What You Don't Need

You can set up Glow Worm Luciferin even if you are not an expert:

  1. You don't need to be a developer.
  2. You don't need to be an electrical engineer.
  3. You don't need a lot of time to complete the setup.

What You Need

  1. A PC for screen capture: Windows or Linux (macOS support coming soon). The captured images are sent to the LED strip behind your monitor.
  2. A microcontroller: ESP8266 or ESP32 are recommended. The ESP32-S3 is the preferred choice.
  3. An addressable LED strip: SK6812 is recommended.
  4. A power supply for the LED strip.
  5. [Optional] An MQTT server or a Home Automation system (e.g., Home Assistant, OpenHAB).

Install Glow Worm Luciferin Firmware on Your Microcontroller

ESP8266 and ESP32 microcontrollers are preferred because they are cheap, stable, and have built-in WiFi.
If you are buying components now, consider the ESP32-S3 for the best performance.

  • Install the firmware using the
    Web Installer
  • or download the firmware from here and flash it using your preferred tool.

Firmware types:

  • FULL Firmware: supports remote control and automatic updates. You must configure WiFi or Ethernet. USB connection is optional.
  • LIGHT Firmware: requires a USB cable.

Driving LEDs via WiFi/Ethernet is faster than USB and is recommended if your WiFi signal is strong or if your microcontroller supports Ethernet.

Connect the LED Strip to Your Microcontroller

Circuit Diagram

Notes:

  • For FULL firmware without USB, connect the 5V microcontroller pin to the power supply.
  • For low-quality microcontrollers, adding a capacitor, resistor, and logic level converter can help stabilize the circuit.
  • If you don't want to design your own PCB, see the Compatible Hardware section.

Install the LED Strip Behind Your Monitor

  • Use double-sided tape for an easy and removable installation.
  • The LED strip can be positioned clockwise or counterclockwise.

Install Firefly Luciferin Software on Your PC

  • Download and install Firefly Luciferin
    Firefly Luciferin
  • Launch the software and select the firmware type you installed (Full or Light).
  1. Go to the LEDs Config tab.
  2. Enter the number of LEDs and the strip orientation, then click Save.
  3. Firefly Luciferin will auto-discover your Glow Worm Luciferin device.

Settings Screen

By default, the firmware drives 50 LEDs. Firefly Luciferin will update the firmware with your configured number of LEDs when the Bias Light effect starts.

Advanced Features

Want to use it as a lamp, control it remotely, apply special effects, or integrate with Home Automation?