summary refs log tree commit diff
path: root/docs/feature_backlight.md
diff options
context:
space:
mode:
authorRockman18 <rockman18.spam@gmail.com>2019-01-29 01:57:56 +0100
committerDrashna Jaelre <drashna@live.com>2019-01-28 16:57:56 -0800
commitdf251d7a1387390383f12b3ff31d71d7e3de5a42 (patch)
tree8b0a5ca2fae4e8567ec857090d42925e3f347010 /docs/feature_backlight.md
parent0f507f01696eae0e8fe808d17a19db3f6d9e2ce4 (diff)
Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769)
* [BACKLIGHT_CAPS_LOCK_INDICATOR] Use backlight toggling as Caps Lock LED

I've implemented this feature because S65-X doesn't have LED indicators
and the existing led_set_kb(usb_led) function try to use backlight as
indicator but that creates an inconsistency with backlight_config state.

- define `BACKLIGHT_CAPS_LOCK_INDICATOR` to enable Caps Lock indicator
  using backlight (for keyboards without dedicated LED)

- Don't turn off LED indicators when suspend because backlight is
  already turned off. Else led_set(0) will turn back on backlight.

- Documentation has been updated

* [BACKLIGHT_CAPS_LOCK_INDICATOR] Turn off all LED indicators except Caps Lock if BACKLIGHT_CAPS_LOCK_INDICATOR

* [BACKLIGHT_CAPS_LOCK] Rename BACKLIGHT_CAPS_LOCK_INDICATOR

* [BACKLIGHT_CAPS_LOCK] Use new IS_LED_ON method
Diffstat (limited to 'docs/feature_backlight.md')
-rw-r--r--docs/feature_backlight.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index f7a35406c7..c7a1f131ed 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -40,6 +40,7 @@ To change the behaviour of the backlighting, `#define` these in your `config.h`:
 |---------------------|-------------|-------------------------------------------------------------------------------------------------------------|
 |`BACKLIGHT_PIN`      |`B7`         |The pin that controls the LEDs. Unless you are designing your own keyboard, you shouldn't need to change this|
 |`BACKLIGHT_LEVELS`   |`3`          |The number of brightness levels (maximum 15 excluding off)                                                   |
+|`BACKLIGHT_CAPS_LOCK`|*Not defined*|Enable Caps Lock indicator using backlight (for keyboards without dedicated LED)                             |
 |`BACKLIGHT_BREATHING`|*Not defined*|Enable backlight breathing, if hardware PWM is used                                                          |
 |`BREATHING_PERIOD`   |`6`          |The length of one backlight "breath" in seconds                                                              |