Status LED Light

The status_led light platform allows to share a single LED for indicating the status of the device (when on error/warning state) or as binary light (when on OK state). This is useful for devices with only one LED available.

It provides the combined functionality of status_led component and a binary light component over a single shared GPIO led.

When the device is on error/warning state, the function of status_led will take precedence and control the blinking of the LED. When the device is in OK state, the LED will be restored to the state of the binary light function and can be controlled as such.

# Example configuration entry
light:
  - platform: status_led
    name: "Switch state"
    pin: GPIO2

Note

When using this platform the high level status_led component should not be included (at least over the same pin), as its functionality is directly provided by this platform.

The only difference is that the platform won’t be loaded in OTA safe mode, while the component would be.

Configuration variables:

  • name (Required, string): The name of the light.

  • pin (Required, Pin Schema): The GPIO pin to operate the LED on.

  • id (Optional, ID): Manually specify the ID used for code generation.

  • effects (Optional, list): A list of light effects to use for this light, though binary lights only support very few of them.

  • All other options from Light.

See Also