You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

1.4 KiB

title sidebar_label
Backlight Behavior Backlight

Summary

This page contains backlight behaviors supported by ZMK.

Backlight Action Defines

Backlight actions defines are provided through the dt-bindings/zmk/backlight.h header, which is added at the top of the keymap file:

#include <dt-bindings/zmk/backlight.h>

This will allow you to reference the actions defined in this header such as BL_TOG.

Here is a table describing the action for each define:

Define Action
BL_ON Turn on backlight
BL_OFF Turn off backlight
BL_TOG Toggle backlight on and off
BL_INC Increase brightness
BL_DEC Decrease brightness
BL_CYCLE Cycle brightness
BL_SET Set a specific brightness

Behavior Binding

  • Reference: &bl
  • Parameter #1: The backlight action define, e.g. BL_TOG or BL_INC
  • Parameter #2: Only applies to BL_SETand is the brightness value

Examples

  1. Toggle backlight on/off

    &bl BL_TOG
    
  2. Sets a specific brightness

    &bl BL_SET 50
    

Split Keyboards

Backlight behaviors are global: This means that when triggered, they affect both the central and peripheral side of split keyboards.