2022-04-30 12:21:07 +10:00
---
title: Backlight Configuration
sidebar_label: Backlight
---
2022-04-30 12:22:13 +10:00
See the [backlight feature page ](../features/backlight.md ) for more details, including instructions for adding backlight support to a board.
2022-04-30 12:21:07 +10:00
2022-04-30 12:22:13 +10:00
See [Configuration Overview ](index.md ) for instructions on how to change these settings.
2022-04-30 12:21:07 +10:00
## Kconfig
Definition file: [zmk/app/Kconfig ](https://github.com/zmkfirmware/zmk/blob/main/app/Kconfig )
| Option | Type | Description | Default |
| ------------------------------------ | ---- | ----------------------------------------------------- | ------- |
| `CONFIG_ZMK_BACKLIGHT` | bool | Enables LED backlight | n |
| `CONFIG_ZMK_BACKLIGHT_BRT_STEP` | int | Brightness step in percent | 20 |
| `CONFIG_ZMK_BACKLIGHT_BRT_START` | int | Default brightness in percent | 40 |
| `CONFIG_ZMK_BACKLIGHT_ON_START` | bool | Default backlight state | y |
| `CONFIG_ZMK_BACKLIGHT_AUTO_OFF_IDLE` | bool | Turn off backlight when keyboard goes into idle state | n |
| `CONFIG_ZMK_BACKLIGHT_AUTO_OFF_USB` | bool | Turn off backlight when USB is disconnected | n |
2022-05-22 08:48:27 +10:00
:::note
The `*_START` settings only determine the initial backlight state. Any changes you make with the [backlight behavior ](../behaviors/backlight.md ) are saved to flash after a one minute delay and will be used after that.
:::
2022-04-30 12:21:07 +10:00
## Devicetree
Applies to: [`/chosen` node ](https://docs.zephyrproject.org/latest/build/dts/intro.html#aliases-and-chosen-nodes )
| Property | Type | Description |
| --------------- | ---- | -------------------------------------------- |
| `zmk,backlight` | path | The node for the backlight LED driver to use |
See the Zephyr devicetree bindings for LED drivers:
2022-11-15 09:58:28 +11:00
- [gpio-leds ](https://docs.zephyrproject.org/3.0.0/reference/devicetree/bindings/gpio/gpio-leds.html )
2022-04-30 12:21:07 +10:00
- [pwm-leds ](https://docs.zephyrproject.org/latest/build/dts/api/bindings/led/pwm-leds.html )
2022-04-30 12:22:13 +10:00
See the [backlight feature page ](../features/backlight.md ) for examples of the properties that must be set to enable backlighting.