These keycodes control the backlight. Most keyboards use this for single color in-switch lighting.
||Turn the backlight on or off|
||Cycle through backlight levels|
||Set the backlight to max brightness|
||Turn the backlight off|
||Increase the backlight level|
||Decrease the backlight level|
||Toggle backlight breathing|
Note that for backlight breathing, you need to have
#define BACKLIGHT_BREATHING in your config.h.
Configuration Options in
BACKLIGHT_PIN B7defines the pin that controlls the LEDs. Unless you design your own keyboard, you don't need to set this.
BACKLIGHT_LEVELS 3defines the number of brightness levels (maximum 15 excluding off).
BACKLIGHT_BREATHINGif defined, enables backlight breathing. Note that this is only available if
BACKLIGHT_PINis B5, B6 or B7.
BREATHING_PERIOD 6defines the length of one backlight "breath" in seconds.
Notes on Implementation
To change the brightness when using pins B5, B6 or B7, the PWM (Pulse Width Modulation) functionality of the on-chip timer is used.
The timer is a counter that counts up to a certain TOP value (
0xFFFF set in ICR1) before resetting to 0.
We also set an OCR1x register.
When the counter reaches the value stored in that register, the PWM pin drops to low.
The PWM pin is pulled high again when the counter resets to 0.
Therefore, OCR1x basically sets the duty cycle of the LEDs and as such the brightness where
0 is the darkest and
0xFFFF the brightest setting.
To enable the breathing effect, we register an interrupt handler to be called whenever the counter resets (with
In this handler, which gets called roughly 244 times per second, we compute the desired brightness using a precomputed brightness curve.
To disable breathing, we can just disable the respective interrupt vector and reset the brightness to the desired level.