X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Ffeature_backlight.md;h=5336e85266e2e0fe341bf3112d0c77f580d10238;hb=ade22f8e2c272044ea2f80ff6fe5ca9576858939;hp=97421c0432976cd1f0e736434f1a8e7c045c7e8f;hpb=4931510ad38aadb1769c9241bfad0c3d77ad687f;p=qmk_firmware.git diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md index 97421c043..5336e8526 100644 --- a/docs/feature_backlight.md +++ b/docs/feature_backlight.md @@ -10,18 +10,18 @@ These keycodes control the backlight. Most keyboards use this for single color i |---------|------------------------------------------| |`BL_TOGG`|Turn the backlight on or off | |`BL_STEP`|Cycle through backlight levels | -|`BL_ON` |Set backlight to max brightness | -|`BL_OFF` |Turn backlight off | -|`BL_INC` |Increase backlight level | -|`BL_DEC` |Decrease backlight level | -|`BL_BRTG`|Toggle backlight breathing | +|`BL_ON` |Set the backlight to max brightness | +|`BL_OFF` |Turn the backlight off | +|`BL_INC` |Increase the backlight level | +|`BL_DEC` |Decrease the backlight level | +|`BL_BRTG`|Toggle backlight breathing | Note that for backlight breathing, you need to have `#define BACKLIGHT_BREATHING` in your config.h. ## Configuration Options in `config.h` * `BACKLIGHT_PIN B7` defines the pin that controlls the LEDs. Unless you design your own keyboard, you don't need to set this. -* `BACKLIGHT_LEVELS 3` defines the number of brightness levels (excluding OFF). +* `BACKLIGHT_LEVELS 3` defines the number of brightness levels (maximum 15 excluding off). * `BACKLIGHT_BREATHING` if defined, enables backlight breathing. Note that this is only available if `BACKLIGHT_PIN` is B5, B6 or B7. * `BREATHING_PERIOD 6` defines the length of one backlight "breath" in seconds.