diff options
| author | Phillip Tennen <phillip.ennen@gmail.com> | 2018-11-14 16:45:46 +0100 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-11-14 16:45:46 +0100 |
| commit | 0cda2f43e2c95fe5dd440e6391ae807f508b040b (patch) | |
| tree | 05d9cd5db86789ca0f475f43db7b0fbcb6251f1d /docs | |
| parent | f7fcba329dbd659a4bb37acdf7e2dc24204a81c8 (diff) | |
| download | qmk_firmware-0cda2f43e2c95fe5dd440e6391ae807f508b040b.tar.gz qmk_firmware-0cda2f43e2c95fe5dd440e6391ae807f508b040b.tar.xz | |
Backlight status functions (#4259)
* add functions to set specific backlight state
* add function to query backlight state
* update documentation with new backlight functions
* Update tmk_core/common/backlight.c
Co-Authored-By: codyd51 <phillip.ennen@gmail.com>
* Update tmk_core/common/backlight.h
Co-Authored-By: codyd51 <phillip.ennen@gmail.com>
* update docs for is_backlight_enabled() name change
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_backlight.md | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md index 7bb7e03a8..f7a35406c 100644 --- a/docs/feature_backlight.md +++ b/docs/feature_backlight.md @@ -54,14 +54,17 @@ In this handler, the value of an incrementing counter is mapped onto a precomput ## Backlight Functions -|Function |Description | -|----------|----------------------------------------------------------| -|`backlight_toggle()` |Turn the backlight on or off | -|`backlight_step()` |Cycle through backlight levels | -|`backlight_increase()` |Increase the backlight level | -|`backlight_decrease()` |Decrease the backlight level | -|`backlight_level(x)` |Sets the backlight level to specified level | -|`get_backlight_level()`|Return the current backlight level | +|Function |Description | +|----------|-----------------------------------------------------------| +|`backlight_toggle()` |Turn the backlight on or off | +|`backlight_enable()` |Turn the backlight on | +|`backlight_disable()` |Turn the backlight off | +|`backlight_step()` |Cycle through backlight levels | +|`backlight_increase()` |Increase the backlight level | +|`backlight_decrease()` |Decrease the backlight level | +|`backlight_level(x)` |Sets the backlight level to specified level | +|`get_backlight_level()` |Return the current backlight level | +|`is_backlight_enabled()`|Return whether the backlight is currently on | ### Backlight Breathing Functions |