Home Automation configs - sblantipodi/firefly_luciferin GitHub Wiki

Home Assistant integration

Thanks to the MQTT protocol, Luciferin can be easily integrated into your preferred Home Automation system.

Once Firefly Luciferin is up and running, please follow the steps below:

  • Settings -> Network tab -> MQTT discovery topic
  • Click the button

Entities will be automatically added to Home Assistant via MQTT Auto Discovery.
You can customize the MQTT discovery topic or use the default one for Home Assistant.

As soon as you click the button, all entities will be available in Home Assistant. Open a dashboard and add them to it.
Entity names contain the Luciferin keyword, making them easy to find.
If you have more than one Glow Worm Luciferin device, the entity will contain the name of the MQTT topic the device is using.

Here are the entities you'll find in your Home Assistant setup:

Entity Description
light.luciferin_switch Turn on/off light, change color and brightness.
select.luciferin_effect_selector Choose your preferred effect.
select.luciferin_color_mode Choose between RGB, RGBW, RGBW mixed (Brighter), RGBW (RGB only) mode.
select.luciferin_aspect_ratio Switch aspect ratio between Fullscreen, Pillarbox, Letterbox, Auto.
select.luciferin_gamma Choose the preferred gamma.
select.luciferin_frame_generation Smoothing control for Frame generation.
select.luciferin_smoothing_ema Smoothing control for Exponential Moving Average (EMA).
select.luciferin_profiles Choose the profile you want to use.
number.luciferin_white_temp Choose white temperature.
button.luciferin_reboot_glow_worm Reboot Glow Worm device.
sensor.luciferin_glow_worm_version Glow Worm Luciferin version.
sensor.luciferin_number_of_leds Number of LEDs in use on the Glow Worm Luciferin device.
sensor.luciferin_gpio GPIO in use on the Glow Worm Luciferin device.
sensor.luciferin_wifi Glow Worm Luciferin WiFi signal strength.
sensor.luciferin_last_update_glow_worm Last time Glow Worm device was sighted. Useful to check if the device is alive.
sensor.luciferin_firefly_producing Firefly Luciferin screen capture framerate (FPS).
sensor.luciferin_firefly_consuming Firefly Luciferin throughput, shows how fast Luciferin is sending data to the Glow Worm device (FPS).
sensor.luciferin_glow_worm_consuming Shows how fast Glow Worm Luciferin is processing the received data (FPS).
sensor.luciferin_ldr Reading of the LDR from 0% to 100% (room brightness).
switch.luciferin_bias_light Start and stop the screen capture on Firefly Luciferin.

SCREENSHOT

Luciferin integration supports automatic updates.


Google Home integration via HA

Please configure Google Home with Home Assistant,
then add these lines to your configuration.yaml file:

google_assistant:
  expose_by_default: false
  entity_config:
    light.glowworm:
      name: "glowworm"
      room: 'Roomname'

Be sure that your ESP is connected to WiFi/MQTT network, quick guide here.