aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_backlight.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-08-25 20:01:09 -0700
committerskullydazed <skullydazed@users.noreply.github.com>2018-08-26 07:32:15 -0700
commiteb19fb5b57487747d608fad986a70296da4deb12 (patch)
tree7aa8a1f56d5ddcea043354046ce084e41345e8b9 /docs/feature_backlight.md
parent91cf4b00c5dbc5e981e9cc997529a93dca066f3f (diff)
downloadqmk_firmware-eb19fb5b57487747d608fad986a70296da4deb12.tar.gz
qmk_firmware-eb19fb5b57487747d608fad986a70296da4deb12.zip
Helpful functions
Diffstat (limited to 'docs/feature_backlight.md')
-rw-r--r--docs/feature_backlight.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index 6140e6a0a..8f883e08f 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -51,3 +51,22 @@ In this way `OCRxx` essentially controls the duty cycle of the LEDs, and thus th
51 51
52The 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. 52The 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.
53In 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. 53In 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_step()` |Cycle through backlight levels |
61|`backlight_increase()` |Increase the backlight level |
62|`backlight_decrease()` |Decrease the backlight level |
63|`backlight_level(x)` |Sets the backlight level to specified level |
64|`get_backlight_level()`|Toggle backlight breathing |
65
66### Backlight Breathing Functions
67
68|Function |Description |
69|----------|----------------------------------------------------------|
70|`breathing_toggle()` |Turn the backlight breathing on or off |
71|`breathing_enable()` |Turns on backlight breathing |
72|`breathing_disable()` |Turns off backlight breathing |