Skip to main content

LED Indicators Configuration

See the LED indicators feature page for more details.

See Configuration Overview for instructions on how to change these settings.

Kconfig

Definition files:

ConfigTypeDescriptionDefault
CONFIG_ZMK_INDICATOR_LEDS_INIT_PRIORITYintIndicator LED device driver initialization priority91

CONFIG_ZMK_INDICATOR_LEDS_INIT_PRIORITY must be set to a larger value than CONFIG_LED_INIT_PRIORITY.

Indicator LED Driver

This driver maps HID indicator states to LED API devices.

Devicetree

Applies to: compatible = "zmk,indicator-leds"

Definition file: zmk/app/dts/bindings/indicators/zmk,indicator-leds.yaml

PropertyTypeDescriptionDefault
indicatorintThe HID_INDICATOR_* value to indicate
ledsphandlesOne or more LED devices to control
active-brightnessintLED brightness in percent when the indicator is active100
inactive-brightnessintLED brightness in percent when the indicator is not active0
disconnected-brightnessintLED brightness in percent when the keyboard is not connected0
on-while-idleboolKeep LEDs enabled even when the keyboard is idle and on battery powerfalse

The indicator property must be one of the HID_INDICATOR_* values defined in zmk/app/include/dt-bindings/zmk/hid_indicators.h. You may also combine values with | to make the LED be lit when any of the indicator states are active.