blob: cb9a85a830ed6e9df0285e01984aaf863dbda073 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
---
title: Backlight Behavior
sidebar_label: Backlight
---
## Summary
This page contains [backlight](../features/backlight.md) behaviors supported by ZMK.
## Backlight Action Defines
Backlight actions defines are provided through the [`dt-bindings/zmk/backlight.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/backlight.h) header,
which is added at the top of the keymap file:
```
#include <dt-bindings/zmk/backlight.h>
```
This will allow you to reference the actions defined in this header such as `BL_TOG`.
Here is a table describing the action for each define:
| Define | Action |
| ---------- | --------------------------- |
| `BL_ON` | Turn on backlight |
| `BL_OFF` | Turn off backlight |
| `BL_TOG` | Toggle backlight on and off |
| `BL_INC` | Increase brightness |
| `BL_DEC` | Decrease brightness |
| `BL_CYCLE` | Cycle brightness |
| `BL_SET` | Set a specific brightness |
## Behavior Binding
- Reference: `&bl`
- Parameter #1: The backlight action define, e.g. `BL_TOG` or `BL_INC`
- Parameter #2: Only applies to `BL_SET`and is the brightness value
### Examples
1. Toggle backlight on/off
```
&bl BL_TOG
```
1. Sets a specific brightness
```
&bl BL_SET 50
```
## Split Keyboards
Backlight behaviors are global: This means that when triggered, they affect both the central and peripheral side of split keyboards.
|
