diff options
| author | Joel Challis | 2023-09-29 19:31:21 +0200 |
|---|---|---|
| committer | GitHub | 2023-09-29 19:31:21 +0200 |
| commit | 6910ed2de5c8935712b646e1c2143c4e7e5f9bea (patch) | |
| tree | d6a653458c169162ece1a18aa7e38469b856a762 /docs/feature_backlight.md | |
| parent | 2eed1f5bad453b11e9f2190239f9c43f4dde979d (diff) | |
Add _DEFAULT_ON lighting configuration options (#21865)
Diffstat (limited to 'docs/feature_backlight.md')
| -rw-r--r-- | docs/feature_backlight.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md index 2f9381e3dc..89916aa813 100644 --- a/docs/feature_backlight.md +++ b/docs/feature_backlight.md @@ -37,8 +37,9 @@ Add the following to your `config.h`: |`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_ON` |`true` |Enable backlight upon clearing the EEPROM | +|`BACKLIGHT_DEFAULT_BREATHING`|`false` |Whether to enable backlight breathing upon clearing the EEPROM | |`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 | |`BACKLIGHT_PWM_PERIOD` |2048Hz |Defaults to `BACKLIGHT_PWM_COUNTER_FREQUENCY / 2048`, which results in a PWM frequency of 2048Hz. | Unless you are designing your own keyboard, you generally should not need to change the `BACKLIGHT_PIN` or `BACKLIGHT_ON_STATE`. |