diff options
| author | Alex Ong <the.onga@gmail.com> | 2019-01-04 19:39:14 +1100 |
|---|---|---|
| committer | Alex Ong <the.onga@gmail.com> | 2019-01-04 19:39:14 +1100 |
| commit | 47c91fc7f75ae0a477e55b687aa0fc30da0a283c (patch) | |
| tree | 65ad39452748ff2e6d4a83ce54ede6ca22c9ada9 /docs/feature_backlight.md | |
| parent | ac9b88e8ccbbf38762871504cd827ff0d941c426 (diff) | |
| parent | 563ce3f225d981ce460c12ca5130dfe47af41df0 (diff) | |
| download | qmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.tar.gz qmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.zip | |
Merge branch 'master' of https://github.com/qmk/qmk_firmware
Diffstat (limited to 'docs/feature_backlight.md')
| -rw-r--r-- | docs/feature_backlight.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md index 6140e6a0a..f7a35406c 100644 --- a/docs/feature_backlight.md +++ b/docs/feature_backlight.md | |||
| @@ -51,3 +51,25 @@ In this way `OCRxx` essentially controls the duty cycle of the LEDs, and thus th | |||
| 51 | 51 | ||
| 52 | The breathing effect is achieved by registering an interrupt handler for `TIMER1_OVF_vect` that is called whenever the counter resets, roughly 244 times per second. | 52 | The breathing effect is achieved by registering an interrupt handler for `TIMER1_OVF_vect` that is called whenever the counter resets, roughly 244 times per second. |
| 53 | In this handler, the value of an incrementing counter is mapped onto a precomputed brightness curve. To turn off breathing, the interrupt handler is simply disabled, and the brightness reset to the level stored in EEPROM. | 53 | In this handler, the value of an incrementing counter is mapped onto a precomputed brightness curve. To turn off breathing, the interrupt handler is simply disabled, and the brightness reset to the level stored in EEPROM. |
| 54 | |||
| 55 | ## Backlight Functions | ||
| 56 | |||
| 57 | |Function |Description | | ||
| 58 | |----------|-----------------------------------------------------------| | ||
| 59 | |`backlight_toggle()` |Turn the backlight on or off | | ||
| 60 | |`backlight_enable()` |Turn the backlight on | | ||
| 61 | |`backlight_disable()` |Turn the backlight off | | ||
| 62 | |`backlight_step()` |Cycle through backlight levels | | ||
| 63 | |`backlight_increase()` |Increase the backlight level | | ||
| 64 | |`backlight_decrease()` |Decrease the backlight level | | ||
| 65 | |`backlight_level(x)` |Sets the backlight level to specified level | | ||
| 66 | |`get_backlight_level()` |Return the current backlight level | | ||
| 67 | |`is_backlight_enabled()`|Return whether the backlight is currently on | | ||
| 68 | |||
| 69 | ### Backlight Breathing Functions | ||
| 70 | |||
| 71 | |Function |Description | | ||
| 72 | |----------|----------------------------------------------------------| | ||
| 73 | |`breathing_toggle()` |Turn the backlight breathing on or off | | ||
| 74 | |`breathing_enable()` |Turns on backlight breathing | | ||
| 75 | |`breathing_disable()` |Turns off backlight breathing | | ||
