RGB Underglow Behavior

Summary#

This page contains RGB Underglow behaviors supported by ZMK.

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

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

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

Here is a table describing the action for each define:

Define	Action
`RGB_TOG`	Toggles the RGB feature on and off
`RGB_HUI`	Increases the hue of the RGB feature
`RGB_HUD`	Decreases the hue of the RGB feature
`RGB_SAI`	Increases the saturation of the RGB feature
`RGB_SAD`	Decreases the saturation of the RGB feature
`RGB_BRI`	Increases the brightness of the RGB feature
`RGB_BRD`	Decreases the brightness of the RGB feature
`RGB_SPI`	Increases the speed of the RGB feature effect's animation
`RGB_SPD`	Decreases the speed of the RGB feature effect's animation
`RGB_EFF`	Cycles the RGB feature's effect forwards
`RGB_EFR`	Cycles the RGB feature's effect reverse
`RGB_COLOR_HSB`	Sets a specific HSB (HSV) value for the underglow

Reference: &rgb_ug
Parameter #1: The RGB action define, e.g. RGB_TOG or RGB_BRI
Parameter #2: Only applies to RGB_COLOR_HSB and is the HSB values of the color to set within parenthesis and separated by a common (see below for an example)

When specifying HSB values you'll need to use RGB_COLOR_HSB(h, s, b) in your keymap file. See below for an example.

Value Limits:

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