diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_backlight.md | 1 | ||||
| -rw-r--r-- | docs/feature_rgblight.md | 6 | ||||
| -rw-r--r-- | docs/reference_info_json.md | 7 |
3 files changed, 11 insertions, 3 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md index d032c33f18..2f9381e3dc 100644 --- a/docs/feature_backlight.md +++ b/docs/feature_backlight.md @@ -39,6 +39,7 @@ Add the following to your `config.h`: |`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 | +|`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`. diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 39b7e6a6f1..2bdfe6a7cf 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md @@ -370,9 +370,9 @@ If you need to change your RGB lighting in code, for example in a macro to chang Example: ```c -sethsv(HSV_WHITE, (LED_TYPE *)&led[0]); // led 0 -sethsv(HSV_RED, (LED_TYPE *)&led[1]); // led 1 -sethsv(HSV_GREEN, (LED_TYPE *)&led[2]); // led 2 +sethsv(HSV_WHITE, (rgb_led_t *)&led[0]); // led 0 +sethsv(HSV_RED, (rgb_led_t *)&led[1]); // led 1 +sethsv(HSV_GREEN, (rgb_led_t *)&led[2]); // led 2 rgblight_set(); // Utility functions do not call rgblight_set() automatically, so they need to be called explicitly. ``` diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index 91581afc73..b81aacb43c 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md @@ -202,6 +202,13 @@ Configures the [EEPROM](eeprom_driver.md) driver. * `driver` * The EEPROM backend to use. Must be one of `custom`, `i2c`, `legacy_stm32_flash`, `spi`, `transient`, `vendor`, `wear_leveling`. * Default: `"vendor"` + * `wear_leveling` + * `driver` + * The driver to use. Must be one of `embedded_flash`, `legacy`, `rp2040_flash`, `spi_flash`, `custom`. + * `backing_size` + * Number of bytes used by the wear-leveling algorithm for its underlying storage, and needs to be a multiple of the logical size. + * `logical_size` + * Number of bytes “exposed” to the rest of QMK and denotes the size of the usable EEPROM. ## Encoder :id=encoder |