summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-05-27 15:21:15 +1000
committerGitHub <noreply@github.com>2021-05-26 22:21:15 -0700
commit06aea834c420d5c11bbcf64d37596cb0cee9af98 (patch)
treee76319f1d5a4ba22c38d8d899f74a348f37caae3 /docs
parente128d454206a2d0622b96d7793758ad7e6965f3d (diff)
Backlight: add defines for default level and breathing state (#12560)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_backlight.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index 74511dd43f..d47ecc6824 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -62,15 +62,17 @@ Valid driver values are `pwm`, `software`, `custom` or `no`. See below for help
To configure the backlighting, `#define` these in your `config.h`:
-| Define | Default | Description |
-|------------------------|---------------|-------------------------------------------------------------------------------------------------------------------|
-| `BACKLIGHT_PIN` | *Not defined* | The pin that controls the LED(s) |
-| `BACKLIGHT_LEVELS` | `3` | The number of brightness levels (maximum 31 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 supported |
-| `BREATHING_PERIOD` | `6` | The length of one backlight "breath" in seconds |
-| `BACKLIGHT_ON_STATE` | `1` | The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low |
-| `BACKLIGHT_LIMIT_VAL ` | `255` | The maximum duty cycle of the backlight -- `255` allows for full brightness, any lower will decrease the maximum. |
+|Define |Default |Description |
+|-----------------------------|------------------|-----------------------------------------------------------------------------------------------------------------|
+|`BACKLIGHT_PIN` |*Not defined* |The pin that controls the LED(s) |
+|`BACKLIGHT_LEVELS` |`3` |The number of brightness levels (maximum 31 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 supported |
+|`BREATHING_PERIOD` |`6` |The length of one backlight "breath" in seconds |
+|`BACKLIGHT_ON_STATE` |`1` |The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low |
+|`BACKLIGHT_LIMIT_VAL` |`255` |The maximum duty cycle of the backlight -- `255` allows for full brightness, any lower will decrease the maximum.|
+|`BACKLIGHT_DEFAULT_LEVEL` |`BACKLIGHT_LEVELS`|The default backlight level to use upon clearing the EEPROM |
+|`BACKLIGHT_DEFAULT_BREATHING`|*Not defined* |Whether to enable backlight breathing upon clearing the EEPROM |
Unless you are designing your own keyboard, you generally should not need to change the `BACKLIGHT_PIN` or `BACKLIGHT_ON_STATE`.