summaryrefslogtreecommitdiff
path: root/doc/keymap.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/keymap.md')
-rw-r--r--doc/keymap.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/keymap.md b/doc/keymap.md
index 474a706e0c..7d979eb7c6 100644
--- a/doc/keymap.md
+++ b/doc/keymap.md
@@ -430,6 +430,27 @@ See `keyboard/hhkb/keymap.c` for sample.
+### 2.5 Backlight Action
+These actions control the backlight.
+
+#### 2.5.1 Change backlight level
+Increase backlight level.
+
+ ACTION_BACKLIGHT_INCREASE()
+
+Decrease backlight level.
+
+ ACTION_BACKLIGHT_DECREASE()
+
+Step through backlight levels.
+
+ ACTION_BACKLIGHT_STEP()
+
+#### 2.5.2 Turn on / off backlight
+Turn the backlight on and off without changing level.
+
+ ACTION_BACKLIGHT_TOGGLE()
+
## 3. Layer switching Example