2023-02-08 11:43:33 +01:00

2.8 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_codeowners, ha_quality_scale, ha_domain, ha_zeroconf, ha_platforms, ha_integration_type
title description ha_category ha_release ha_iot_class ha_config_flow ha_codeowners ha_quality_scale ha_domain ha_zeroconf ha_platforms ha_integration_type
Elgato Light Instructions on how to integrate an Elgato Light with Home Assistant.
Light
0.104 Local Polling true
@frenck
platinum elgato true
button
diagnostics
light
sensor
switch
device

The Elgato Lights sets the bar for high-end studio lightning. The LED lights are created and designed specifically for streamers and content creators, many of whom operate on platforms like YouTube and Twitch.

The following light productions from Elgato have been tested with this integration:

{% include integrations/config_flow.md %}

Lights

This integration adds the Key Light device as a light in Home Assistant, and allows you to control the color temperature, brightness, and its on/off state.

When using the Elgato Light Strip, color support is automatically detected and enabled in Home Assistant.

Other entities

Besides the above mentioned light entity, this integration also provides other secondary entities that can be useful for monitoring and controlling your Elgato light.

Sensors

If you have a Key Light Mini, Home Assistant will provide an additional sensor that indicates the level of your battery in percent (%).

Switches

If you have a Key Light Mini, Home Assistant will provide an additional switch that allows the control of the "Studio mode" of your light. When studio mode is enabled, your battery will not be used and bypassed.

Services

Service elgato.identify

The identify service shortly blinks the Elgato light. Originally meant as a way to identify which light you are talking to; it can also be used as a service to create a visual notification.

This service also works when the light is turned off and will turn off the light after the identification sequence has been completed.

{% my developer_call_service badge service="elgato.identify" %}

Service data attribute Optional Description
entity_id Yes String or list of Elgato light entity IDs.

Example automation, in YAML format, that triggers a visual notification when a binary sensor (a doorbell) is triggered:

- alias: Visual doorbell notification example
  trigger:
    - platform: state
      entity_id: binary_sensor.doorbell
      to: "on"
  action:
    - service: elgato.identify
      target:
        entity_id: light.elgato_key_light