aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_backlight.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_backlight.md')
-rw-r--r--docs/feature_backlight.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index 6bb2bbed8..a558af64e 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -62,14 +62,15 @@ Valid driver values are `pwm`, `software`, `custom` or `no`. See below for help
62 62
63To configure the backlighting, `#define` these in your `config.h`: 63To configure the backlighting, `#define` these in your `config.h`:
64 64
65|Define |Default |Description | 65| Define | Default | Description |
66|---------------------|-------------|-------------------------------------------------------------------------------------| 66|------------------------|---------------|-------------------------------------------------------------------------------------------------------------------|
67|`BACKLIGHT_PIN` |*Not defined*|The pin that controls the LED(s) | 67| `BACKLIGHT_PIN` | *Not defined* | The pin that controls the LED(s) |
68|`BACKLIGHT_LEVELS` |`3` |The number of brightness levels (maximum 31 excluding off) | 68| `BACKLIGHT_LEVELS` | `3` | The number of brightness levels (maximum 31 excluding off) |
69|`BACKLIGHT_CAPS_LOCK`|*Not defined*|Enable Caps Lock indicator using backlight (for keyboards without dedicated LED) | 69| `BACKLIGHT_CAPS_LOCK` | *Not defined* | Enable Caps Lock indicator using backlight (for keyboards without dedicated LED) |
70|`BACKLIGHT_BREATHING`|*Not defined*|Enable backlight breathing, if supported | 70| `BACKLIGHT_BREATHING` | *Not defined* | Enable backlight breathing, if supported |
71|`BREATHING_PERIOD` |`6` |The length of one backlight "breath" in seconds | 71| `BREATHING_PERIOD` | `6` | The length of one backlight "breath" in seconds |
72|`BACKLIGHT_ON_STATE` |`1` |The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low| 72| `BACKLIGHT_ON_STATE` | `1` | The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low |
73| `BACKLIGHT_LIMIT_VAL ` | `255` | The maximum duty cycle of the backlight -- `255` allows for full brightness, any lower will decrease the maximum. |
73 74
74Unless you are designing your own keyboard, you generally should not need to change the `BACKLIGHT_PIN` or `BACKLIGHT_ON_STATE`. 75Unless you are designing your own keyboard, you generally should not need to change the `BACKLIGHT_PIN` or `BACKLIGHT_ON_STATE`.
75 76