diff options
author | fauxpark <fauxpark@gmail.com> | 2018-08-01 10:40:09 +1000 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2018-07-31 17:40:09 -0700 |
commit | 9b7a3a0bc854ac4ed38930a66be508d175f02f9d (patch) | |
tree | 618032d248e394a9ec69a922ac471880167e9dac /docs/feature_backlight.md | |
parent | 1c88e4663d1d4342d151b804ec3155aa40c06855 (diff) | |
download | qmk_firmware-9b7a3a0bc854ac4ed38930a66be508d175f02f9d.tar.gz qmk_firmware-9b7a3a0bc854ac4ed38930a66be508d175f02f9d.zip |
Docs: Add Usage section to backlight docs (#3537)
Diffstat (limited to 'docs/feature_backlight.md')
-rw-r--r-- | docs/feature_backlight.md | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md index 0a1aa634c..6140e6a0a 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 | |||
4 | 4 | ||
5 | 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. | 5 | 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. |
6 | 6 | ||
7 | ## Caveats | 7 | ## Usage |
8 | 8 | ||
9 | 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. | 9 | 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: |
10 | 10 | ||
11 | 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`. | 11 | ```make |
12 | BACKLIGHT_ENABLE = yes | ||
13 | ``` | ||
14 | |||
15 | You should then be able to use the keycodes below to change the backlight level. | ||
12 | 16 | ||
13 | ## Keycodes | 17 | ## Keycodes |
14 | 18 | ||
@@ -22,6 +26,12 @@ Hardware PWM is only supported on certain pins of the MCU, so if the backlightin | |||
22 | |`BL_DEC` |Decrease the backlight level | | 26 | |`BL_DEC` |Decrease the backlight level | |
23 | |`BL_BRTG`|Toggle backlight breathing | | 27 | |`BL_BRTG`|Toggle backlight breathing | |
24 | 28 | ||
29 | ## Caveats | ||
30 | |||
31 | 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. | ||
32 | |||
33 | 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`. | ||
34 | |||
25 | ## Configuration | 35 | ## Configuration |
26 | 36 | ||
27 | To change the behaviour of the backlighting, `#define` these in your `config.h`: | 37 | To change the behaviour of the backlighting, `#define` these in your `config.h`: |