summaryrefslogtreecommitdiffstats
path: root/docs/feature_backlight.md
diff options
context:
space:
mode:
authorAlex Ong <the.onga@gmail.com>2019-01-04 09:39:14 +0100
committerAlex Ong <the.onga@gmail.com>2019-01-04 09:39:14 +0100
commit47c91fc7f75ae0a477e55b687aa0fc30da0a283c (patch)
tree65ad39452748ff2e6d4a83ce54ede6ca22c9ada9 /docs/feature_backlight.md
parentac9b88e8ccbbf38762871504cd827ff0d941c426 (diff)
parent563ce3f225d981ce460c12ca5130dfe47af41df0 (diff)
downloadqmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.tar.gz
qmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.tar.xz
Merge branch 'master' of https://github.com/qmk/qmk_firmware
Diffstat (limited to 'docs/feature_backlight.md')
-rw-r--r--docs/feature_backlight.md22
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
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.
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.
+
+## Backlight Functions
+
+|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
+
+|Function |Description |
+|----------|----------------------------------------------------------|
+|`breathing_toggle()` |Turn the backlight breathing on or off |
+|`breathing_enable()` |Turns on backlight breathing |
+|`breathing_disable()` |Turns off backlight breathing |