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. You can also use a binary Output Component.

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
  - platform: status_led
    name: "Switch state"
    pin: GPIO2


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 (Optional, string): The name of the light.

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

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

  • output (Optional, ID): The id of the binary Output Component to use for this light.

  • 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.


If your Status LED is in an active-LOW mode (such as with the D1 Mini ESP8266 boards), use the inverted option of the Pin Schema:

  number: GPIO2
  inverted: true

See Also