summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/build.md1
-rw-r--r--doc/keymap.md21
2 files changed, 22 insertions, 0 deletions
diff --git a/doc/build.md b/doc/build.md
index 88504f0965..ae8565010e 100644
--- a/doc/build.md
+++ b/doc/build.md
@@ -132,6 +132,7 @@ Optional. Note that ***comment out*** to disable them.
COMMAND_ENABLE = yes # Commands for debug and configuration
SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend
#NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA
+ #BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
### 3. Programmer
Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. Not needed if you use `FLIP`, `dfu-programmer` or `Teesy Loader`.
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