aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_backlight.md
diff options
context:
space:
mode:
authorJames Young <xxiinophobia@yahoo.com>2020-02-29 12:00:00 -0800
committerJames Young <xxiinophobia@yahoo.com>2020-02-29 11:59:30 -0800
commit26eef35f07698d23aafae90e1c230b52e100a334 (patch)
treeeb8e43fc58ca55788e6e89430af0db55ea79e324 /docs/feature_backlight.md
parent85041ff05bf0e5f4ff4535caf6e638491a5614c8 (diff)
downloadqmk_firmware-26eef35f07698d23aafae90e1c230b52e100a334.tar.gz
qmk_firmware-26eef35f07698d23aafae90e1c230b52e100a334.zip
2020 February 29 Breaking Changes Update (#8064)
Diffstat (limited to 'docs/feature_backlight.md')
-rw-r--r--docs/feature_backlight.md20
1 files changed, 16 insertions, 4 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index e74aab1e3..7c68d74e1 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -119,10 +119,22 @@ When both timers are in use for Audio, the backlight PWM will not use a hardware
119 119
120To change the behavior of the backlighting, `#define` these in your `config.h`: 120To change the behavior of the backlighting, `#define` these in your `config.h`:
121 121
122|Define |Default |Description | 122|Define |Default |Description |
123|---------------------|-------------|--------------------------------------------------------------------------------------------------------------| 123|---------------------|-------------|-------------------------------------------------------------------------------------------------------------|
124|`BACKLIGHT_PIN` |`B7` |The pin that controls the LEDs. Unless you are designing your own keyboard, you shouldn't need to change this | 124|`BACKLIGHT_PIN` |`B7` |The pin that controls the LEDs. Unless you are designing your own keyboard, you shouldn't need to change this|
125|`BACKLIGHT_PINS` |*Not defined*|experimental: see below for more information | 125|`BACKLIGHT_PINS` |*Not defined*|experimental: see below for more information |
126|`BACKLIGHT_LEVELS` |`3` |The number of brightness levels (maximum 31 excluding off) |
127|`BACKLIGHT_CAPS_LOCK`|*Not defined*|Enable Caps Lock indicator using backlight (for keyboards without dedicated LED) |
128|`BACKLIGHT_BREATHING`|*Not defined*|Enable backlight breathing, if supported |
129|`BREATHING_PERIOD` |`6` |The length of one backlight "breath" in seconds |
130|`BACKLIGHT_ON_STATE` |`1` |The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low |
131
132### Backlight On State
133
134Most backlight circuits are driven by an N-channel MOSFET or NPN transistor. This means that to turn the transistor *on* and light the LEDs, you must drive the backlight pin, connected to the gate or base, *high*.
135Sometimes, however, a P-channel MOSFET, or a PNP transistor is used. In this case, when the transistor is on, the pin is driven *low* instead.
136
137This functionality is configured at the keyboard level with the `BACKLIGHT_ON_STATE` define.
126 138
127### Multiple backlight pins 139### Multiple backlight pins
128 140