<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} };</span></span></code></pre></div><p>The first part, <code>// Key Matrix to LED Index</code>, tells the system what key this LED represents by using the key's electrical matrix row & col. The second part, <code>// LED Index to Physical Position</code> represents the LED's physical <code>{ x, y }</code> position on the keyboard. The default expected range of values for <code>{ x, y }</code> is the inclusive range <code>{ 0..224, 0..64 }</code>. This default expected range is due to effects that calculate the center of the keyboard for their animations. The easiest way to calculate these positions is imagine your keyboard is a grid, and the top left of the keyboard represents <code>{ x, y }</code> coordinate <code>{ 0, 0 }</code> and the bottom right of your keyboard represents <code>{ 224, 64 }</code>. Using this as a basis, you can use the following formula to calculate the physical position:</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">x </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 224</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> /</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (NUMBER_OF_COLS </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> COL_POSITION</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">y </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 64</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> /</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (NUMBER_OF_ROWS </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ROW_POSITION</span></span></code></pre></div><p>Where NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout.</p><p>As mentioned earlier, the center of the keyboard by default is expected to be <code>{ 112, 32 }</code>, but this can be changed if you want to more accurately calculate the LED's physical <code>{ x, y }</code> positions. Keyboard designers can implement <code>#define LED_MATRIX_CENTER { 112, 32 }</code> in their config.h file with the new center point of the keyboard, or where they want it to be allowing more possibilities for the <code>{ x, y }</code> values. Do note that the maximum value for x or y is 255, and the recommended maximum is 224 as this gives animations runoff room before they reset.</p><p><code>// LED Index to Flag</code> is a bitmask, whether or not a certain LEDs is of a certain type. It is recommended that LEDs are set to only 1 type.</p><h2id="flags"tabindex="-1">Flags <aclass="header-anchor"href="#flags"aria-label="Permalink to "Flags {#flags}""></a></h2><table><thead><tr><th>Define</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>HAS_FLAGS(bits, flags)</code></td><td><em>n/a</em></td><td>Evaluates to <code>true</code> if <code>bits</code> has all <code>flags</code> set</td></tr><tr><td><code>HAS_ANY_FLAGS(bits, flags)</code></td><td><em>n/a</em></td><td>Evaluates to <code>true</code> if <code>bits</code> has any <code>flags</code> set</td></tr><tr><td><code>LED_FLAG_NONE</code></td><td><code>0x00</code></td><td>If this LED has no flags</td></tr><tr><td><code>LED_FLAG_ALL</code></td><td><code>0xFF</code></td><td>If this LED has all flags</td></tr><tr><td><code>LED_FLAG_MODIFIER</code></td><td><code>0x01</code></td><td>If the LED is on a modifier key</td></tr><tr><td><code>LED_FLAG_KEYLIGHT</code></td><td><code>0x04</code></td><td>If the LED is for key backlight</td></tr><tr><td><code>LED_FLAG_INDICATOR</code></td><td><code>0x08</code></td><td>If the LED is for keyboard state indication</td></tr></tbody></table><h2id="keycodes"tabindex="-1">Keycodes <aclass="header-anchor"href="#keycodes"aria-label="Permalink to "Keycodes {#keycodes}""></a></h2><table><thead><tr><th>Key</th><th>Aliases</th><th>Description</th></tr></thead><tbody><tr><td><code>QK_LED_MATRIX_ON</code></td><td><code>LM_ON</code></td><td>Turn on LED Matrix</td></tr><tr><td><code>QK_LED_MATRIX_OFF</code></td><td><code>LM_OFF</code></td><td>Turn off LED Matrix</td></tr><tr><td><code>QK_LED_MATRIX_TOGGLE</code></td><td><code>LM_TOGG</code></td><td>Toggle LED Matrix on or off</td></tr><tr><td><code>QK_LED_MATRIX_MODE_NEXT</code></td><td><code>LM_NEXT</code></td><td>Cycle through animations</td></tr><tr><td><code>QK_LED_MATRIX_MODE_PREVIOUS</code></td><td><code>LM_PREV</code></td><td>Cycle through animations in reverse</td></tr><tr><td><code>QK_LED_MATRIX_BRIGHTNESS_UP</code></td><td><code>LM_BRIU</code></td><td>Increase the brightness level</td></tr><tr><td><code>QK_LED_MATRIX_BRIGHTNESS_DOWN</code></td><td><code>LM_BRID</code></td><td>Decrease the brightness level</td></tr><tr><td><code>QK_LED_MATRIX_SPEED_UP</code></td><td><code>LM_SPDU</code></td><td>Increase the animation speed</td></tr><tr><td><code>QK_LED_MATRIX_SPEED_DOWN</code></td><td><code>LM_SPDD</code></td><td>Decrease the animation
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static single val, no speed support</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_ALPHAS_MODS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static dual val, speed is val for LEDs marked as modifiers</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_BAND,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Band fading brightness scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_CYCLE_LEFT_RIGHT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_CYCLE_UP_DOWN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling top to bottom</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_CYCLE_OUT_IN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling out to in</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_DUAL_BEACON,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient spinning around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_REACTIVE_SIMPLE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Pulses keys hit then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_REACTIVE_WIDE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Value pulses near a single key hit then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_REACTIVE_MULTIWIDE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Value pulses near multiple key hits then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_REACTIVE_CROSS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Value pulses the same column and row of a single key hit then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_REACTIVE_MULTICROSS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Value pulses the same column and row of multiple key hits then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_REACTIVE_NEXUS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Value pulses away on the same column and row of a single key hit then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_REACTIVE_MULTINEXUS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Value pulses away on the same column and row of multiple key hits then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_SPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Value pulses away from a single key hit then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID_MULTISPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Value pulses away from multiple key hits then fades out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_WAVE_LEFT_RIGHT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sine wave scrolling from left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_WAVE_UP_DOWN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sine wave scrolling from up to down</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span></code></pre></div><p>You can enable a single effect by defining <code>ENABLE_[EFFECT_NAME]</code> in your <code>config.h</code>:</p><table><thead><tr><th>Define</th><th>Description</th></tr></thead><tbody><tr><td><code>#define ENABLE_LED_MATRIX_ALPHAS_MODS</code></td><td>Enables <code>LED_MATRIX_ALPHAS_MODS</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_BREATHING</code></td><td>Enables <code>LED_MATRIX_BREATHING</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_BAND</code></td><td>Enables <code>LED_MATRIX_BAND</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_BAND_PINWHEEL</code></td><td>Enables <code>LED_MATRIX_BAND_PINWHEEL</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_BAND_SPIRAL</code></td><td>Enables <code>LED_MATRIX_BAND_SPIRAL</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_CYCLE_LEFT_RIGHT</code></td><td>Enables <code>LED_MATRIX_CYCLE_LEFT_RIGHT</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_CYCLE_UP_DOWN</code></td><td>Enables <code>LED_MATRIX_CYCLE_UP_DOWN</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_CYCLE_OUT_IN</code></td><td>Enables <code>LED_MATRIX_CYCLE_OUT_IN</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_DUAL_BEACON</code></td><td>Enables <code>LED_MATRIX_DUAL_BEACON</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_WAVE_LEFT_RIGHT</code></td><td>Enables <code>LED_MATRIX_WAVE_LEFT_RIGHT</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_WAVE_UP_DOWN</code></td><td>Enables <code>LED_MATRIX_WAVE_UP_DOWN</code></td></tr></tbody></table><table><thead><tr><th>Reactive Defines</th><th>Description</th></tr></thead><tbody><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_REACTIVE_SIMPLE</code></td><td>Enables <code>LED_MATRIX_SOLID_REACTIVE_SIMPLE</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_REACTIVE_WIDE</code></td><td>Enables <code>LED_MATRIX_SOLID_REACTIVE_WIDE</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTIWIDE</code></td><td>Enables <code>LED_MATRIX_SOLID_REACTIVE_MULTIWIDE</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_REACTIVE_CROSS</code></td><td>Enables <code>LED_MATRIX_SOLID_REACTIVE_CROSS</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTICROSS</code></td><td>Enables <code>LED_MATRIX_SOLID_REACTIVE_MULTICROSS</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_REACTIVE_NEXUS</code></td><td>Enables <code>LED_MATRIX_SOLID_REACTIVE_NEXUS</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTINEXUS</code></td><td>Enables <code>LED_MATRIX_SOLID_REACTIVE_MULTINEXUS</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_SPLASH</code></td><td>Enables <code>LED_MATRIX_SOLID_SPLASH</code></td></tr><tr><td><code>#define ENABLE_LED_MATRIX_SOLID_MULTISPLASH</code></td><td>Enables <code>LED_MATRIX_SOLID_MULTISPLASH</code></td></tr></tbody></table><divclass="tip custom-block"><pclass="custom-block-title">TIP</p><p>These modes introduce additional logic that can increase firmware size.</p></div><h2id="custom-led-matrix-effects"tabindex="-1">Custom LED Matrix Effects <aclass="header-anchor"href="#custom-led-matrix-effects"aria-label="Permalink to "Custom LED Matrix Effects {#custom-led-matrix-effects}""></a></h2><p>By setting <code>LED_MATRIX_CUSTOM_USER = yes</code> in <code>rules.mk</code>, new effects can be defined directly from your keymap or userspace, without having to edit any QMK core files. To declare new effects, create a <code>led_matrix_user.inc</code> file in the user keymap directory or userspace folder.</p><divclass="tip custom-block"><pclass="custom-block-title">TIP</p><p>Hardware maintainers who want to limit custom effects to a specific keyboard can create a <code>led_matrix_kb.inc</code> file in the root of the keyboard directory, and add <code>LED_MATRIX_CUSTOM_KB = yes</code> to the keyboard level <code>rules.mk</code>.</p></div><divclass="language-c vp-adaptive-theme"><buttontitle="C
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// e.g: A simple effect, self-contained within a single method</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// e.g: A more complex effect, relying on external methods and state, with</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// dedicated init and run methods</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#endif</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // LED_MATRIX_CUSTOM_EFFECT_IMPLS</span></span></code></pre></div><p>To switch to your custom effect programmatically, simply call <code>led_matrix_mode()</code> and prepend <code>LED_MATRIX_CUSTOM_</code> to the effect name your specified in <code>LED_MATRIX_EFFECT()</code>. For example, an effect declared as <code>LED_MATRIX_EFFECT(my_cool_effect)</code> would be referenced with:</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">led_matrix_mode</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(LED_MATRIX_CUSTOM_my_cool_effect);</span></span></code></pre></div><p>For inspiration and examples, check out the built-in effects under <code>quantum/led_matrix/animations/</code>.</p><h2id="additional-configh-options"tabindex="-1">Additional <code>config.h</code> Options <aclass="header-anchor"href="#additional-configh-options"aria-label="Permalink to "Additional `config.h` Options {#additional-configh-options}""></a></h2><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_KEYRELEASES</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // reactive effects respond to keyreleases (instead of keypresses)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_TIMEOUT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 0</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // number of milliseconds to wait until led automatically turns off</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_SLEEP</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // turn off effects when suspended</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_LED_PROCESS_LIMIT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (LED_MATRIX_LED_COUNT </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 4</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">/</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 5</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_LED_FLUSH_LIMIT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 16</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_MAXIMUM_BRIGHTNESS</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 255</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits maximum brightness of LEDs</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_DEFAULT_ON</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> true</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default enabled state, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_DEFAULT_MODE</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_SOLID</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default mode, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_DEFAULT_VAL</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_MATRIX_MAXIMUM_BRIGHTNESS</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default brightness value, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_DEFAULT_SPD</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 127</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default animation speed, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_DEFAULT_FLAGS</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_FLAG_ALL</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default LED flags, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LED_MATRIX_SPLIT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { X, Y }</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR</span></span></code></pre></div><h2id="eeprom-storage"tabindex="-1">EEPROM storage <aclass="header-anchor"href="#eeprom-storage"aria-label="Permalink to "EEPROM storage {#eeprom-storage}""></a></h2><p>The EEPROM for it is currently shared with the RGB Matrix system (it's generally assumed only one feature would be used at a time).</p><h2id="callbacks"tabindex="-1">Callbacks <aclass="header-anchor"href="#callbacks"aria-label="Permalink to "Callbacks {#callbacks}""></a></h2><h3id="indicators"tabindex="-1">Indicators <aclass="header-anchor"href="#indicators"aria-label="Permalink to "Indicators {#indicators}""></a></h3><p>If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, then you can use the <code>led_matrix_indicators_kb</code> function on the keyboard level source file, or <code>led_matrix_indicators_user</code> function in the user <code>keymap.c</code>.</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">bool</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> led_matrix_indicators_kb</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>In addition, there are the advanced indicator functions. These are aimed at those with heavily customized displays, where rendering every LED per cycle is expensive. This includes a special macro to help make this easier to use: <code>LED_MATRIX_INDICATOR_SET_VALUE(i, v)</code>.</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> led_matrix_indicators_advanced_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_min</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_max</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h2id="api"tabindex="-1">API <aclass="header-anchor"href="#api"aria-label="Permalink to "API {#api}""></a></h2><h3id="api-led-matrix-toggle"tabindex="-1"><code>void led_matrix_toggle(void)</code><aclass="header-anchor"href="#api-led-matrix-toggle"aria-label="Permalink to "`void led_matrix_toggle(void)` {#api-led-matrix-toggle}""></a></h3><p>Toggle LED Matrix on or off.</p><hr><h3id="api-led-matrix-toggle-noeeprom"tabindex="-1"><code>void led_matrix_toggle_noeeprom(void)</code><aclass="header-anchor"href="#api-led-matrix-toggle-noeeprom"aria-label="Permalink to "`void led_matrix_toggle_noeeprom(void)` {#api-led-matrix-toggle-noeeprom}""></a></h3><p>Toggle LED Matrix on or off. New state is not written to EEPROM.</p><hr><h3id="api-led-matrix-enable"tabindex="-1"><code>void led_matrix_enable(void)</code><aclass="header-anchor"href="#api-led-matrix-enable"aria-label="Permalink to "`void led_matrix_enable(void)` {#api-led-matrix-enable}""></a></h3><p>Turn LED Matrix on.</p><hr><h3id="api-led-matrix-enable-noeeprom"tabindex="-1"><code>void led_matrix_enable_noeeprom(void)</code><aclass="header-anchor"href="#api-led-matrix-enable-noeeprom"aria-label="Permalink to "`void led_matrix_enable_noeeprom(void)` {#api-led-matrix-enable-noeeprom}""></a></h3><p>Turn LED Matrix on. New state is not written to EEPROM.</p><hr><h3id="api-led-matrix-disable"tabindex="-1"><code>void led_matrix_disable(void)</code><aclass="header-anchor"href="#api-led-matrix-disable"aria-label="Permalink to "`void led_matrix_disable(void)` {#api-led-matrix-disable}""></a></h3><p>Turn LED Matrix off.</p><hr><h3id="api-led-matrix-disable-noeeprom"tabindex="-1"><code>void led_matrix_disable_noeeprom(void)</code><aclass="header-anchor"href="#api-led-matrix-disable-noeeprom"aria-label="Permalink to "`void led_matrix_disable_noeeprom(void)` {#api-led-matrix-disable-noeeprom}""></a></h3><p>Turn LED Matrix off. New state is not written to EEPROM.</p><hr><h3id="api-led-matrix-is-enabled"tabindex="-1"><code>bool led_matrix_is_enabled(void)</code><aclass="header-anchor"href="#api-led-matrix-is-enabled"aria-label="Permalink to "`bool led_matrix_is_enabled(void)` {#api-led-matrix-is-enabled}""></a></h3><p>Get the current enabled state of LED Matrix.</p><h4id="api-led-matrix-is-enabled-return"tabindex="-1">Return Value <aclass="header-anchor"href="#api-led-matrix-is-enabled-return"aria-label="Permalink to "Return Value {#api-led-matrix-is-enabled-return}""></a></h4><p><code>true</code> if LED Matrix is enabled.</p><hr><h3id="led-matrix-set-value"tabindex="-1"><code>void led_matrix_set_value(uint8_t index, uint8_t v)</code><aclass="header-anchor"href="#led-matrix-set-value"aria-label="Permalink to "`void led_matrix_set_value(uint8_t index, uint8_t v)` {#led-matrix-set-value}""></a></h3><p>Set the brightness of a single LED.</p><p>This function can only be run from within an effect or indicator callback, otherwise the currently running animation will simply overwrite it on the next frame.</p><h4id="api-led-matrix-set-value-arguments"tabindex="-1">Arguments <aclass="header-anchor"href="#api-led-matrix-set-value-arguments"aria-label="Permalink to "Arguments {#api-led-matrix-set-value-arguments}""></a></h4><ul><li><code>uint8_t index</code><br> The LED index, from 0 to <code>LED_MATRIX_LED_COUNT - 1</code>.</li><li><code>uint8_t v</code><br> The brightness value to set.</li></ul><hr><h3id="api-led-matrix-set-value-all"tabindex="-1"><code>void led_matrix_set_value_all(uint8_t v)</code><aclass="header-anchor"href="#api-led-matrix-set-value-all"aria-label="Permalink to "`void led_matrix_set_value_all(uint8_t v)` {#api-led-matrix-set-value-all}""></a></h3><p>Set the brightness of all LEDs.</p><p>This function can only be run from within an effect or indi
