Skip to content

Home Automation configs

Davide Perini edited this page Jul 1, 2024 · 45 revisions

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 the entities will be available in Home Assistant, open a dashboard and add them to it. Entities name contains the Luciferin keyword so it's easy to find them. 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.glow_worm_luciferin 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_smoothing_level Higher levels will smooth transitions from one color to another but LEDs will be less responsive to quick changes.
select.luciferin_profiles Choose the profile you want to use.
number.luciferin_white_temp Choose white temperature.
button.reboot_glow_worm_luciferin Reboot Glow Worm device.
sensor.glow_worm_luciferin_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.last_update_glow_worm_luciferin This sensor shows you the last time Glow Worm device was sighted. Useful to check if the device is alive.
sensor.firefly_luciferin_producing Firefly Luciferin screen capture framerate (FPS).
sensor.firefly_luciferin_consuming Firefly Luciferin throughput, it shows how fast Luciferin is sending data to the Glow Worm device. (FPS)
sensor.glow_worm_luciferin_consuming It shows how fast Glow Worm Luciferin is processing the received data. (FPS)
sensor.luciferin_ldr It shows the reading of the LDR from 0% to 100%. (Room brightness)
switch.luciferin_bias_light Start and stop the screen capture on Firefly Luciferin.

SCREENSHOT

If you want to manually add entities you can use this ready to use package. This method is recommeded for power users that wants to have better control on the integration, most users should use the automatic method described above that benefits from "automatic udpates".


Google Home integration via HA

Please configure Google Home with Home Assistant, then add this 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.

Clone this wiki locally