From eb19fb5b57487747d608fad986a70296da4deb12 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Sat, 25 Aug 2018 20:01:09 -0700 Subject: Helpful functions --- docs/feature_backlight.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'docs/feature_backlight.md') 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 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_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()`|Toggle backlight breathing | + +### 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 | -- cgit v1.2.3-24-g4f1b