Skip to main content

Elgato Light smart home integration, free and open source

Elgato Light integration for Gladys Assistant

Elgato Key Light, Ring Light and Light Strip on the local network: brightness, white, color.

View on GitHubAll integrations

Control your Elgato lights from Gladys, over your local network: Key Light, Key Light Air, Key Light Mini, Ring Light and Light Strip. On and off, brightness, the white from warm to cold, the colour of a Light Strip, the battery of a Key Light Mini, and two scene actions: make lights blink, and set several lights in one go for a video call. No account and no cloud: Gladys talks to each light directly, like the Elgato Control Center app does.

Developed without the hardware: feedback welcome. This integration was built and tested against real answers of Elgato lights recorded by the python-elgato and Home Assistant projects, and against a simulated light, not against a real one. If something does not work as described, please say so on the Gladys forum or in the issues.

What you need​

  • Gladys Assistant 5.1.0 or later.
  • Elgato lights already set up with the Elgato Control Center app, connected to the Wi-Fi of the same network as Gladys.
  • Nothing else: no Elgato account, no key, no internet access. The lights answer on TCP port 9123 of your local network.

Set up​

  1. Install the integration from the Gladys catalog. The install screen asks for one permission: Gladys may look for the _elg._tcp service on your network (mDNS), the way Control Center finds the lights.
  2. Open its Configuration. Nothing is required; the options are:
    • IP addresses of Elgato lights: only for the lights automatic discovery does not find, separated by commas (for example 192.168.1.50, 192.168.1.51). Control Center shows the address of each light in its settings; your router lists it too. A name (keylight.lan) and a port (192.168.1.50:9123) are accepted.
    • Refresh interval: how often each light is read, from 5 to 60 seconds (10 by default). It is how fast Gladys sees a change made from Control Center, a Stream Deck or the buttons of the light.
    • Language of the feature names: English, French, German or Spanish (French by default). The names of the features are given when the device is added.
  3. Open the Discover tab: one device per light. Click Add, pick a room, save.
  4. Missing a light? Click Search for Elgato lights in the Configuration screen: the message under the button lists the lights found and the ones that do not answer.

A light that changes address is found again within 15 minutes, without a new device in Gladys: it is identified by its serial number.

The Gladys devices​

Each light becomes one Gladys device, named after the name given in Control Center, or after its product and the end of its serial number (for example Elgato Key Light Air 0002). Rename it as you like.

FeatureWhat it isLights
LightOn / offEvery light
Brightness1 to 100 %; 0 turns the light offEvery light
Color temperatureThe white, from 2900 K (warm) to 7000 K (cold)Every light
HueThe colour, 0 to 360°Light Strip
Saturation0 % (white) to 100 % (vivid colour)Light Strip
ColorThe colour, for the colour wheel of the dashboardLight Strip
BatteryCharge level, in %Key Light Mini
ChargingWhether the battery is chargingKey Light Mini
  • Choosing a brightness, a white or a colour also turns the light on.
  • A Light Strip shows either a white or a colour: in white mode its hue, saturation and colour are not updated, in colour mode its colour temperature is not.
  • When a light no longer answers, its badge says it is unreachable and Gladys keeps its last state (Elgato lights may drop off the Wi-Fi while still lit).

Configuration buttons​

  • Search for Elgato lights: searches the network again now, and lists the lights found.
  • Make a light blink: choose a light, it blinks for a few seconds. Handy to tell which light is which before naming them.

Dashboard​

No dedicated widget: the light panel of the Gladys dashboard already has every control of an Elgato light (power, brightness bar, warm-to-cold slider, colour wheel with hue and saturation for the Light Strip). Add the device to a Devices in room box, or to any box that shows devices.

Scenes​

Triggers​

No trigger of its own: use the usual device state trigger on the features (the light turned on, the brightness changed, the battery below 20 %...).

Actions​

  • Make Elgato lights blink: one or more lights blink for a few seconds, then go back to their setting.
  • Set Elgato lights: turns one or more lights on with a brightness (1 to 100 %) and a color temperature (2900 to 7000 K), both optional, in a single request per light: the light does not show its previous setting first. A Light Strip in colour mode switches to white when a temperature is given.

Both actions give the number of lights reached to the next actions, and fail only when no light answered.

Scene ideas​

  • Video call: when the calendar event "Meeting" starts → Set Elgato lights on the two Key Lights of the desk, 40 % and 5000 K; at its end, turn them off.
  • Silent doorbell: when the doorbell rings → Make Elgato lights blink on the office lights, for whoever wears headphones.
  • Low battery: when the Battery of the Key Light Mini goes below 15 % → send a message "Charge the Key Light Mini".
  • Evening: at sunset → turn the Light Strip on, color temperature 2900 K, brightness 30 %.

Troubleshooting​

  • No light found automatically: check that the lights and Gladys are on the same network (a guest network or a separate IoT VLAN blocks the discovery). Enter the IP addresses in the configuration: this works across networks as long as Gladys can reach port 9123. Giving the lights a fixed address in your router helps too.
  • "not answering": the light is unplugged, its battery is empty, or it lost the Wi-Fi. Control Center shows the same then. It comes back by itself as soon as it answers again.
  • The white or colour in Gladys is a little different from Control Center: the lights work in mireds and in whole hue degrees; Gladys shows the nearest kelvin value (to 10 K) and colour.
  • The integration logs what it finds and what does not answer: open the integration logs from the Gladys interface (LOG_LEVEL=debug shows every reading).

Limits​

  • Changes made outside Gladys (Control Center, Stream Deck, the buttons of the light) are seen at the next reading, within the refresh interval: the lights send nothing by themselves. Gladys reads each light with one small local request per interval (two for a Key Light Mini, which also gives its battery). The local API has no quota and no terms of use; no internet traffic.
  • Not offered: the power-on behaviour, the fade durations, the studio mode and the energy saving of the Key Light Mini, firmware updates (use Control Center), the scenes of the Light Strip Pro.
  • One Gladys device per light: the lights are not grouped.
  • Developed without a real Elgato light: what could not be checked is listed in the README.

This integration is not affiliated with Elgato or Corsair. Elgato, Key Light, Ring Light and Light Strip are trademarks of Corsair Memory, Inc.

Configuration settings​

These are the settings Elgato Light asks for in its configuration screen in Gladys.

SettingTypeRequiredDescription
Finding your Elgato lightssectionNoElgato lights on the same network as Gladys are found automatically: open the Discovery tab. Set them up first in the Elgato Control Center app. If one is missing, enter its IP address below.
IP addresses of Elgato lightsstringNoOptional, separated by commas. Only needed for the lights automatic discovery does not find.
Refresh intervalselectNoHow often each light is read, to follow the changes made from the Elgato app or the buttons of the light.
Language of the feature namesselectNoNames given to the features of new devices (Light, Brightness, Color temperature...).

How to install Elgato Light in Gladys​

  1. In Gladys, open Integrations: Elgato Light appears in the catalog, next to the native integrations, with a community badge.
  2. Click Install. Gladys pulls the Docker image (ghcr.io/guim31/gladys-elgato:1.0.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration).
  3. Open the Configuration screen of the integration, fill in the settings, and save.
  4. You can also install it directly from its repository URL: https://github.com/guim31/gladys-elgato.

Elgato Light requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.

Not running Gladys yet? It is free and open source: follow the installation guide to get started.

About external integrations​

Elgato Light is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by guim31, not by the Gladys core team.

Subscribe to the Gladys Assistant newsletter

A few emails per month about new releases and project news. Sent by Pierre-Gilles Leymarie, founder of the project. Unsubscribe anytime 🙂
Last updated on