aboutsummaryrefslogtreecommitdiffstats
path: root/docs/feature_backlight.md
AgeCommit message (Collapse)Author
2019-12-14Convert backlight to follow driver rules pattern - update docsGravatar zvecr
2019-11-02Initial migration of software PWM backlight (#6709)Gravatar Joel Challis
* Initial migration of software PWM backlight * First pass at backlight driver docs * Correct driver name in docs * Run backlight_task when using BACKLIGHT_PINS * Resolve backlight docs TODOs
2019-10-05ARM - Initial backlight support (#6487)Gravatar Joel Challis
* Move AVR backlight to own file, add borrowed ARM implementation * Tiny fix for backlight custom logic * Remove duplicate board from rebase * Fix f303 onekey example * clang-format * clang-format * Remove backlight keymap debug * Initial pass of ARM backlight docs * Initial pass of ARM backlight docs - resolve todos * fix rules validation logic * Add f072 warning * Add f072 warning * tidy up breathing in backlight keymap * tidy up breathing in backlight keymap * add missing break to backlight keymap
2019-09-20Add support for 328P hardware backlight on B1/B2 (#6776)Gravatar fauxpark
2019-09-15Clarify the backlight_level API doc slightly (#6733)Gravatar xster
* Clarify the backlight_level API doc slightly * review
2019-08-08Improve backlight PWM pin support (#6202)Gravatar fauxpark
* Improve backlight PWM pin support * I accidentally an equals sign * Another typo * Order by pin number * Throw an error if backlight pin is C4 or C5 on 16/32U4 * Use else for clarity * Minor alignment adjustments
2019-07-18Correct backlight on state docs (#6358)Gravatar fauxpark
* Correct backlight on state docs * Reword to make it less confusing
2019-07-16Extend maximum number of backlight levels to 31 (#6351)Gravatar fauxpark
2019-06-19Fix breathing always on for soft PWM (#5983)Gravatar fauxpark
* Fix breathing always on for soft PWM * Remove reference to hardware PWM pins in BACKLIGHT_BREATHING description Now, breathing will only be unsupported when Timers 1 and 3 are both used by Audio * Document BACKLIGHT_ON_STATE and its purpose
2019-06-17Fix backlight breathing on C6 (#6102)Gravatar fauxpark
* Fix backlight breathing on C6 * Account for ATmega32A's single TIMSK register (MT40) * Document hardware PWM on D4 for ATmega32A * Add C6 and D4 to BACKLIGHT_PIN description
2019-04-22Fix #3566 use an hardware timer for software PWM stability (#3615)Gravatar Brice Figureau
With my XD60, I noticed that when typing the backlight was flickering. The XD60 doesn't have the backlight wired to a hardware PWM pin. I assumed it was a timing issue in the matrix scan that made the PWM lit the LED a bit too longer. I verified it because the more keys that were pressed, the more lighting I observed. This patch makes the software PWM be called during CPU interruptions. It works almost like the hardware PWM, except instead of using the CPU waveform generation, the CPU will fire interruption when the LEDs need be turned on or off. Using the same timer system as for hardware PWM, when the counter will reach OCRxx (the current backlight level), an Output Compare match interrupt will be fired and we'll turn the LEDs off. When the counter reaches its maximum value, an overflow interrupt will be triggered in which we turn the LEDs on. This way we replicate the hardware backlight PWM duty cycle. This gives a better time stability of the PWM computation than pure software PWM, leading to a flicker free backlight. Since this is reusing the hardware PWM code, software PWM also supports backlight breathing. Note that if timer1 is used for audio, backlight will use timer3, and if timer3 is used for audio backlight will use timer1. If both timers are used for audio, then this feature is disabled and we revert to the matrix scan based PWM computation. Signed-off-by: Brice Figureau <brice@daysofwonder.com>
2019-01-28Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769)Gravatar Rockman18
* [BACKLIGHT_CAPS_LOCK_INDICATOR] Use backlight toggling as Caps Lock LED I've implemented this feature because S65-X doesn't have LED indicators and the existing led_set_kb(usb_led) function try to use backlight as indicator but that creates an inconsistency with backlight_config state. - define `BACKLIGHT_CAPS_LOCK_INDICATOR` to enable Caps Lock indicator using backlight (for keyboards without dedicated LED) - Don't turn off LED indicators when suspend because backlight is already turned off. Else led_set(0) will turn back on backlight. - Documentation has been updated * [BACKLIGHT_CAPS_LOCK_INDICATOR] Turn off all LED indicators except Caps Lock if BACKLIGHT_CAPS_LOCK_INDICATOR * [BACKLIGHT_CAPS_LOCK] Rename BACKLIGHT_CAPS_LOCK_INDICATOR * [BACKLIGHT_CAPS_LOCK] Use new IS_LED_ON method
2018-11-14Backlight status functions (#4259)Gravatar Phillip Tennen
* 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
2018-10-26Fix incorrect doctoring in feature.backlight.md (#4244)Gravatar Phillip Tennen
I'm guessing someone deleted a row at some point in the past, but I didn't blame it.
2018-08-26Helpful functionsGravatar Drashna Jaelre
2018-07-31Docs: Add Usage section to backlight docs (#3537)Gravatar fauxpark
2018-07-30Backlighting docs (#3526)Gravatar fauxpark
* Some words about backlighting * Link to RGB feature pages
2018-01-12Clarify that we actually have max 16 total backlight levelsGravatar fauxpark
2018-01-12Remove reference to BL_x in keycodes.md, and add BL_BRTGGravatar fauxpark
2018-01-01backlight breathing overhaul (#2187)Gravatar Balz Guenat
* add breathing to bananasplit * backlight breathing overhaul * fix the backlight_tick thing. * fix for vision_division backlight * fix a few keymaps and probably break breathing for some weirdly set-up boards. * remove BL_x keycodes because they made unreasonable assumptions * some fixes for BL keycodes * integer cie lightness scaling * use cie lightness for non-breathing backlight and make breathing able to reach true max brightness
2017-12-09Format keycode tablesGravatar fauxpark
2017-08-16break up keymaps and quantum keycodes into files by featureGravatar skullY