summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2018-08-01 10:40:09 +1000
committerDrashna Jaelre <drashna@live.com>2018-07-31 17:40:09 -0700
commit9b7a3a0bc854ac4ed38930a66be508d175f02f9d (patch)
tree618032d248e394a9ec69a922ac471880167e9dac
parent1c88e4663d1d4342d151b804ec3155aa40c06855 (diff)
Docs: Add Usage section to backlight docs (#3537)
-rw-r--r--docs/feature_backlight.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index 0a1aa634ce..6140e6a0ab 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -4,11 +4,15 @@ Many keyboards support backlit keys by way of individual LEDs placed through or
The MCU can only supply so much current to its GPIO pins. Instead of powering the backlight directly from the MCU, the backlight pin is connected to a transistor or MOSFET that switches the power to the LEDs.
-## Caveats
+## Usage
-This feature is distinct from both the [RGB underglow](feature_rgblight.md) and [RGB matrix](feature_rgb_matrix.md) features as it usually allows for only a single colour per switch, though you can obviously use multiple different coloured LEDs on a keyboard.
+Most keyboards have backlighting enabled by default if they support it, but if it is not working for you, check that your `rules.mk` includes the following:
-Hardware PWM is only supported on certain pins of the MCU, so if the backlighting is not connected to one of them, a software implementation will be used, and backlight breathing will not be available. Currently the supported pins are `B5`, `B6`, `B7`, and `C6`.
+```make
+BACKLIGHT_ENABLE = yes
+```
+
+You should then be able to use the keycodes below to change the backlight level.
## Keycodes
@@ -22,6 +26,12 @@ Hardware PWM is only supported on certain pins of the MCU, so if the backlightin
|`BL_DEC` |Decrease the backlight level |
|`BL_BRTG`|Toggle backlight breathing |
+## Caveats
+
+This feature is distinct from both the [RGB underglow](feature_rgblight.md) and [RGB matrix](feature_rgb_matrix.md) features as it usually allows for only a single colour per switch, though you can obviously use multiple different coloured LEDs on a keyboard.
+
+Hardware PWM is only supported on certain pins of the MCU, so if the backlighting is not connected to one of them, a software implementation will be used, and backlight breathing will not be available. Currently the supported pins are `B5`, `B6`, `B7`, and `C6`.
+
## Configuration
To change the behaviour of the backlighting, `#define` these in your `config.h`: