<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li><li><code>qmk</code><ul><li><code>locking</code><ul><li><code>enabled</code><ul><li>Enable locking switch support.</li><li>Default: <code>false</code></li></ul></li><li><code>resync</code><ul><li>Keep switch state consistent with keyboard LED state.</li><li>Default: <code>false</code></li></ul></li></ul></li><li><code>tap_capslock_delay</code><ul><li>The delay between keydown and keyup for Caps Lock tap events in milliseconds.</li><li>Default: <code>80</code> (80 ms)</li></ul></li><li><code>tap_keycode_delay</code><ul><li>The delay between keydown and keyup for tap events in milliseconds.</li><li>Default: <code>0</code> (no delay)</li></ul></li></ul></li><li><code>tapping</code><ul><li><code>hold_on_other_key_press</code><ul><li>Default: <code>false</code></li></ul></li><li><code>hold_on_other_key_press_per_key</code><ul><li>Default: <code>false</code></li></ul></li><li><code>permissive_hold</code><ul><li>Default: <code>false</code></li></ul></li><li><code>permissive_hold_per_key</code><ul><li>Default: <code>false</code></li></ul></li><li><code>retro</code><ul><li>Default: <code>false</code></li></ul></li><li><code>retro_per_key</code><ul><li>Default: <code>false</code></li></ul></li><li><code>term</code><ul><li>Default: <code>200</code> (200 ms)</li></ul></li><li><code>term_per_key</code><ul><li>Default: <code>false</code></li></ul></li><li><code>toggle</code><ul><li>Default: <code>5</code></li></ul></li></ul></li></ul><h2id="apa102"tabindex="-1">APA102 <aclass="header-anchor"href="#apa102"aria-label="Permalink to "APA102 {#apa102}""></a></h2><p>Configures the <ahref="./drivers/apa102">APA102</a> driver.</p><ul><li><code>apa102</code><ul><li><code>clock_pin</code> (Required) <ul><li>The GPIO pin connected to <code>CI</code> on the first LED in the chain.</li></ul></li><li><code>data_pin</code> (Required) <ul><li>The GPIO pin connected to <code>DI</code> on the first LED in the chain.</li></ul></li><li><code>default_brightness</code><ul><li>The initial global brightness level (independent of the RGB data), from 0 to 31.</li><li>Default: <code>31</code></li></ul></li></ul></li></ul><h2id="audio"tabindex="-1">Audio <aclass="header-anchor"href="#audio"aria-label="Permalink to "Audio {#audio}""></a></h2><p>Configures the <ahref="./features/audio">Audio</a> feature.</p><ul><li><code>audio</code><ul><li><code>default</code><ul><li><code>on</code><ul><li>The default audio enabled state.</li><li>Default: <code>true</code></li></ul></li><li><code>clicky</code><ul><li>The default audio clicky enabled state.</li><li>Default: <code>true</code></li></ul></li></ul></li><li><code>driver</code><ul><li>The driver to use. Must be one of <code>dac_additive</code>, <code>dac_basic</code>, <code>pwm_software</code>, <code>pwm_hardware</code>.</li></ul></li><li><code>macro_beep</code><ul><li>Play a short beep for <code>\a</code> (ASCII <code>BEL</code>) characters in Send String macros.</li><li>Default: <code>false</code></li></ul></li><li><code>pins</code> (Required) <ul><li>The GPIO pin(s) connected to the speaker(s).</li></ul></li><li><code>power_control</code><ul><li><code>on_state</code><ul><li>The logical GPIO state required to turn the speaker on.</li><li>Default: <code>1</code> (on = high)</li></ul></li><li><code>pin</code><ul><li>The GPIO pin connected to speaker power circuit.</li></ul></li></ul></li><li><code>voices</code><ul><li>Use multiple audio voices.</li><li>Default: <code>false</code></li></ul></li></ul></li></ul><h2id="backlight"tabindex="-1">Backlight <aclass="header-anchor"href="#backlight"aria-label="Permalink to "Backlight {#backlight}""></a></h2><p>Configures the <ahref="./features/backlight">Backlight</a> feature.</p><ul><li><code>backlight</code><ul><li><code>as_caps_lock</code><ul><li>Use the backlight as a Caps Lock indicator.</li><li>Default: <code>false</code></li></ul></li><li><code>breathing</code><ul><li>Whether backlight breathing is enab
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li><li><code>layouts</code><ul><li>A dictionary of layouts supported by the keyboard.</li><li><code>LAYOUT_<layout_name></code><ul><li><code>layout</code><ul><li>A list of key dictionaries comprising the layout. Each key dictionary contains: <ul><li><code>matrix</code> (Required) <ul><li>The matrix position for the key.</li><li>Example: <code>[0, 4]</code> (row 0, column 4)</li></ul></li><li><code>x</code> (Required) <ul><li>The absolute position of the key in the horizontal axis, in key units.</li></ul></li><li><code>y</code> (Required) <ul><li>The absolute position of the key in the vertical axis, in key units.</li></ul></li><li><code>h</code><ul><li>The height of the key, in key units.</li><li>Default: <code>1</code> (1u)</li></ul></li><li><code>label</code><ul><li>What to name the key. This is <em>not</em> a key assignment as in the keymap, but should usually correspond to the keycode for the first layer of the default keymap.</li><li>Example: <code>"Escape"</code></li></ul></li><li><code>r</code><ul><li>The rotation angle in degrees. Currently not implemented.</li></ul></li><li><code>rx</code><ul><li>The absolute X position of the rotation axis. Currently not implemented.</li></ul></li><li><code>ry</code><ul><li>The absolute Y position of the rotation axis. Currently not implemented.</li></ul></li><li><code>w</code><ul><li>The width of the key, in key units.</li><li>Default: <code>1</code> (1u)</li></ul></li><li><code>encoder</code><ul><li>The index of an encoder this key should be linked to</li></ul></li><li>Example: <code>{"label": "Shift", "matrix": [4, 0], "x": 0, "y": 4.25, "w": 2.25}</code></li></ul></li></ul></li></ul></li></ul></li></ul><h2id="leader-key"tabindex="-1">Leader Key <aclass="header-anchor"href="#leader-key"aria-label="Permalink to "Leader Key {#leader-key}""></a></h2><p>Configures the <ahref="./features/leader_key">Leader Key</a> feature.</p><ul><li><code>leader_key</code><ul><li><code>timing</code><ul><li>Reset the <code>timeout</code> on each keypress.</li><li>Default: <code>false</code></li></ul></li><li><code>strict_processing</code><ul><li>Do not extract the tap keycodes from Layer-Tap and Mod-Tap key events.</li><li>Default: <code>false</code></li></ul></li><li><code>timeout</code><ul><li>The amount of time to complete a leader sequence in milliseconds.</li><li>Default: <code>300</code> (300 ms)</li></ul></li></ul></li></ul><h2id="led-matrix"tabindex="-1">LED Matrix <aclass="header-anchor"href="#led-matrix"aria-label="Permalink to "LED Matrix {#led-matrix}""></a></h2><p>Configures the <ahref="./features/led_matrix">LED Matrix</a> feature.</p><ul><li><code>led_matrix</code><ul><li><code>animations</code><ul><li>A dictionary of effects to enable or disable. Effects which are absent default to <code>false</code>.</li><li>Example:</li></ul><divclass="language-json vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">json</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li><li><code>center_point</code><ul><li>The centroid (geometric center) of the LEDs. Used for certain effects.</li><li>Default: <code>[112, 32]</code></li></ul></li><li><code>default</code><ul><li><code>animation</code><ul><li>The default effect. Must be one of <code>led_matrix.animations</code></li><li>Default: <code>"solid"</code></li></ul></li><li><code>on</code><ul><li>The default enabled state.</li><li>Default: <code>true</code></li></ul></li><li><code>val</code><ul><li>The default brightness level.</li><li>Default: <code>max_brightness</code></li></ul></li><li><code>speed</code><ul><li>The default animation speed.</li><li>Default: <code>128</code></li></ul></li></ul></li><li><code>driver</code> (Required) <ul><li>The driver to use. Must be one of <code>custom</code>, <code>is31fl3218</code>, <code>is31fl3731</code>, <code>is31fl3733</code>, <code>is31fl3736</code>, <code>is31fl3737</code>, <code>is31fl3741</code>, <code>is31fl3742a</code>, <code>is31fl3743a</code>, <code>is31fl3745</code>, <code>is31fl3746a</code>, <code>snled27351</code>.</li></ul></li><li><code>layout</code> (Required) <ul><li>List of LED configuration dictionaries. Each dictionary contains: <ul><li><code>flags</code> (Required) <ul><li>A bitfield of flags describing the type of LED.</li></ul></li><li><code>x</code> (Required) <ul><li>The position of the LED in the horizontal axis, from 0 to 224.</li></ul></li><li><code>y</code> (Required) <ul><li>The position of the LED in the vertical axis, from 0 to 64.</li></ul></li><li><code>matrix</code><ul><li>The key matrix position associated with the LED.</li><li>Example: <code>[0, 2]</code></li></ul></li><li>Example: <code>{"matrix": [2, 1], "x": 20, "y": 48, "flags": 2}</code></li></ul></li></ul></li><li><code>led_flush_limit</code><ul><li>Limits in milliseconds how frequently an animation will update the LEDs.</li><li>Default: <code>16</code></li></ul></li><li><code>led_process_limit</code><ul><li>Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness).</li><li>Default: <code>led_count / 5</code></li></ul></li><li><code>max_brightness</code><ul><li>The maximum value which brightness is scaled to, from 0 to 255.</li><li>Default: <code>255</code></li></ul></li><li><code>react_on_keyup</code><ul><li>Animations react to keyup instead of keydown.</li><li>Default: <code>false</code></li></ul></li><li><code>sleep</code><ul><li>Turn off the LEDs when the host goes to sleep.</li><li>Default: <code>false</code></li></ul></li><li><code>speed_steps</code><ul><li>The number of speed adjustment steps.</li><li>Default: <code>16</code></li></ul></li><li><code>split_count</code><ul><li>For split keyboards, the number of LEDs on each half.</li><li>Example: <code>[16, 16]</code></li></ul></li><li><code>timeout</code><ul><li>The LED activity timeout in milliseconds.</li><li>Default: <code>0</code> (no timeout)</li></ul></li><li><code>val_steps</code><ul><li>The number of brightness adjustment steps.</li><li>Default: <code>8</code></li></ul></li></ul></li></ul><h2id="matrix"tabindex="-1">Matrix <aclass="header-anchor"href="#matrix"aria-label="Permalink to "Matrix {#matrix}""></a></h2><ul><li><code>debounce</code><ul><li>The debounce time in milliseconds.</li><li>Default: <code>5</code> (5 ms)</li></ul></li><li><code>diode_direction</code><ul><li>Which way the diodes are "pointing". Unused for <code>matrix_pins.direct</code>. Must be one of <code>COL2ROW</code>, <code>ROW2COL</code>.</li></ul></li><li><code>matrix_pins</code><ul><li><code>cols</code><ul><li>A list of GPIO pins connected to the matrix columns.</li><li>Example: <code>["A0", "A1", "A2"]</code></li></ul></li><li><code>custom</code><ul><li>Whether to use a custom matrix scanning implementation.</li><li>Default: <code>false</code></li></ul></li><li><code>custom_lite</code><ul><li>Whether to use a &
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]</span></span></code></pre></div></li><li><code>ghost</code><ul><li>Whether the matrix has no anti-ghosting diodes.</li><li>Default: <code>false</code></li></ul></li><li><code>input_pressed_state</code><ul><li>The logical GPIO state of the input pins when a key is pressed.</li><li>Default: <code>0</code> (pressed = low)</li></ul></li><li><code>io_delay</code><ul><li>The amount of time to wait between row/col selection and col/row pin reading, in microseconds.</li><li>Default: <code>30</code> (30 µs)</li></ul></li><li><code>rows</code><ul><li>A list of GPIO pins connected to the matrix rows.</li><li>Example: <code>["B0", "B1", "B2"]</code></li></ul></li></ul></li></ul><h2id="mouse-keys"tabindex="-1">Mouse Keys <aclass="header-anchor"href="#mouse-keys"aria-label="Permalink to "Mouse Keys {#mouse-keys}""></a></h2><p>Configures the <ahref="./features/mouse_keys">Mouse Keys</a> feature.</p><ul><li><code>mouse_key</code><ul><li><code>delay</code></li><li><code>enabled</code><ul><li>Enables the Mouse Keys feature.</li><li>Default: <code>false</code></li></ul></li><li><code>interval</code></li><li><code>max_speed</code></li><li><code>time_to_max</code></li><li><code>wheel_delay</code></li></ul></li></ul><h2id="one-shot"tabindex="-1">One Shot <aclass="header-anchor"href="#one-shot"aria-label="Permalink to "One Shot {#one-shot}""></a></h2><p>Configures <ahref="./one_shot_keys">One Shot keys</a>.</p><ul><li><code>oneshot</code><ul><li><code>tap_toggle</code><ul><li>The number of times to tap the key in order to hold it.</li></ul></li><li><code>timeout</code><ul><li>The amount of time before the key is released in milliseconds.</li></ul></li></ul></li></ul><h2id="ps2"tabindex="-1">PS/2 <aclass="header-anchor"href="#ps2"aria-label="Permalink to "PS/2 {#ps2}""></a></h2><p>Configures the <ahref="./features/ps2_mouse">PS/2</a> feature.</p><ul><li><code>ps2</code><ul><li><code>clock_pin</code><ul><li>The GPIO pin connected to <code>CLK</code> on the PS/2 device.</li></ul></li><li><code>data_pin</code><ul><li>The GPIO pin connected to <code>DATA</code> on the PS/2 device.</li></ul></li><li><code>driver</code><ul><li>The PS/2 driver to use. Must be one of <code>busywait</code>, <code>interrupt</code>, <code>usart</code>, <code>vendor</code>.</li><li>Default: <code>"busywait"</code></li></ul></li><li><code>enabled</code><ul><li>Enable the PS/2 feature.</li><li>Default: <code>false</code></li></ul></li><li><code>mouse_enabled</code><ul><li>Enable the PS/2 mouse handling.</li><li>Default: <code>false</code></li></ul></li></ul></li></ul><h2id="qmk-lufa-bootloader"tabindex="-1">QMK LUFA Bootloader <aclass="header-anchor"href="#qmk-lufa-bootloader"aria-label="Permalink to "QMK LUFA Bootloader {#qmk-lufa-bootloader}""></a></h2><ul><li><code>qmk_lufa_bootloader</code><ul><li><code>esc_input</code> (Required) <ul><li>The GPIO pin connected to the designated "exit bootloader" key's row (if <code>COL2ROW</code>).</li></ul></li><li><code>esc_output</code> (Required) <ul><li>The GPIO pin connected to the designated "exit bootloader" key's column (if <code>COL2ROW</code>).</li></ul></li><li><code>led</code><ul><li>The GPIO pin connected to an LED to flash.</li></ul></li><li><code>speaker</code><ul><li>The GPIO pin connected to a speaker to click (can also be used for a second LED).</li></ul></li></ul></li></ul><h2id="rgblight"tabindex="-1">RGBLight <aclass="header-anchor"href="#rgblight"aria-label="Permalink to "RGBLight {#rgblight}""></a></h2><p>Configures the <ahref="./features/rgblight">RGB Lighting</a> feature.</p><ul><li><code>rgblight</code><ul><li><code>led_count</code> (Required) <ul><li>The number of LEDs in the chain.</li></ul></li><li><code>animations</code><ul><li>A dictionary of effects to enable or disable. Effects which are absent default to <code>false</code>.</li><li>Example:</li></ul><divclass="la
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li><li><code>brightness_steps</code><ul><li>The number of brightness adjustment steps.</li><li>Default: <code>17</code></li></ul></li><li><code>default</code><ul><li><code>animation</code><ul><li>The default effect. Must be one of <code>rgblight.animations</code></li><li>Default: <code>"static_light"</code></li></ul></li><li><code>on</code><ul><li>The default enabled state.</li><li>Default: <code>true</code></li></ul></li><li><code>hue</code><ul><li>The default hue value.</li><li>Default: <code>0</code></li></ul></li><li><code>sat</code><ul><li>The default saturation value.</li><li>Default: <code>255</code></li></ul></li><li><code>val</code><ul><li>The default brightness level.</li><li>Default: <code>max_brightness</code></li></ul></li><li><code>speed</code><ul><li>The default animation speed.</li><li>Default: <code>0</code></li></ul></li></ul></li><li><code>driver</code><ul><li>The driver to use. Must be one of <code>apa102</code>, <code>custom</code>, <code>ws2812</code>.</li><li>Default: <code>"ws2812"</code></li></ul></li><li><code>hue_steps</code><ul><li>The number of hue adjustment steps.</li><li>Default: <code>8</code></li></ul></li><li><code>layers</code><ul><li><code>blink</code><ul><li>Enable layer blinking API.</li><li>Default: <code>false</code></li></ul></li><li><code>enabled</code><ul><li>Enable RGB Lighting Layers.</li><li>Default: <code>false</code></li></ul></li><li><code>max</code><ul><li>The maximum layer count, from 1 to 32.</li><li>Default: <code>8</code></li></ul></li></ul></li><li><code>led_map</code><ul><li>Remap LED indices.</li><li>Example: <code>[4, 3, 2, 1, 0]</code></li></ul></li><li><code>max_brightness</code><ul><li>The maximum value which the HSV "V" component is scaled to, from 0 to 255.</li><li>Default: <code>255</code></li></ul></li><li><code>saturation_steps</code><ul><li>The number of saturation adjustment steps.</li><li>Default: <code>17</code></li></ul></li><li><code>sleep</code><ul><li>Turn off the LEDs when the host goes to sleep.</li><li>Default: <code>false</code></li></ul></li><li><code>split</code><ul><li>Enable synchronization between split halves.</li><li>Default: <code>false</code></li></ul></li><li><code>split_count</code><ul><li>When <code>rgblight.split</code> is enabled, the number of LEDs on each half.</li><li>Example: <code>[10, 10]</code></li></ul></li></ul></li></ul><h2id="rgb-matrix"tabindex="-1">RGB Matrix <aclass="header-anchor"href="#rgb-matrix"aria-label="Permalink to "RGB Matrix {#rgb-matrix}""></a></h2><p>Configures the <ahref="./features/rgb_matrix">RGB Matrix</a> feature.</p><ul><li><code>rgb_matrix</code><ul><li><code>animations</code><ul><li>A dictionary of effects to enable or disable. Effects which are absent default to <code>false</code>.</li><li>Example:</li></ul><divclass="language-json vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">json</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li><li><code>center_point</code><ul><li>The centroid (geometric center) of the LEDs. Used for certain effects.</li><li>Default: <code>[112, 32]</code></li></ul></li><li><code>default</code><ul><li><code>animation</code><ul><li>The default effect. Must be one of <code>rgb_matrix.animations</code></li><li>Default: <code>"solid_color"</code></li></ul></li><li><code>on</code><ul><li>The default enabled state.</li><li>Default: <code>true</code></li></ul></li><li><code>hue</code><ul><li>The default hue value.</li><li>Default: <code>0</code></li></ul></li><li><code>sat</code><ul><li>The default saturation value.</li><li>Default: <code>255</code></li></ul></li><li><code>val</code><ul><li>The default brightness level.</li><li>Default: <code>max_brightness</code></li></ul></li><li><code>speed</code><ul><li>The default animation speed.</li><li>Default: <code>128</code></li></ul></li></ul></li><li><code>driver</code> (Required) <ul><li>The driver to use. Must be one of <code>aw20216s</code>, <code>custom</code>, <code>is31fl3218</code>, <code>is31fl3236</code>, <code>is31fl3729</code>, <code>is31fl3731</code>, <code>is31fl3733</code>, <code>is31fl3736</code>, <code>is31fl3737</code>, <code>is31fl3741</code>, <code>is31fl3742a</code>, <code>is31fl3743a</code>, <code>is31fl3745</code>, <code>is31fl3746a</code>, <code>snled27351</code>, <code>ws2812</code>.</li></ul></li><li><code>hue_steps</code><ul><li>The number of hue adjustment steps.</li><li>Default: <code>8</code></li></ul></li><li><code>layout</code> (Required) <ul><li>List of LED configuration dictionaries. Each dictionary contains: <ul><li><code>flags</code> (Required) <ul><li>A bitfield of flags describing the type of LED.</li></ul></li><li><code>x</code> (Required) <ul><li>The position of the LED in the horizontal axis, from 0 to 224.</li></ul></li><li><code>y</code> (Required) <ul><li>The position of the LED in the vertical axis, from 0 to 64.</li></ul></li><li><code>matrix</code><ul><li>The key matrix position associated with the LED.</li><li>Example: <code>[0, 2]</code></li></ul></li><li>Example: <code>{"matrix": [2, 1], "x": 20, "y": 48, "flags": 2}</code></li></ul></li></ul></li><li><code>led_flush_limit</code><ul><li>Limits in milliseconds how frequently an animation will update the LEDs.</li><li>Default: <code>16</code></li></ul></li><li><code>led_process_limit</code><ul><li>Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness).</li><li>Default: <code>led_count / 5</code></li></ul></li><li><code>max_brightness</code><ul><li>The maximum value which the HSV "V" component is scaled to, from 0 to 255.</li><li>Default: <code>255</code></li></ul></li><li><code>react_on_keyup</code><ul><li>Animations react to keyup instead of keydown.</li><li>Default: <code>false</code></li></ul></li><li><code>sat_steps</code><ul><li>The number of saturation adjustment steps.</li><li>Default: <code>16</code></li></ul></li><li><code>sleep</code><ul><li>Turn off the LEDs when the host goes to sleep.</li><li>Default: <code>false</code></li></ul></li><li><code>speed_steps</code><ul><li>The number of speed adjustment steps.</li><li>Default: <code>16</code></li></ul></li><li><code>split_count</code><ul><li>For split keyboards, the number of LEDs on each half.</li><li>Example: <code>[16, 16]</code></li></ul></li><li><code>timeout</code><ul><li>The LED activity timeout in milliseconds.</li><li>Default: <code>0</code> (no timeout)</li></ul></li><li><code>val_steps</code><ul><li>The number of brightness adjustment steps.</li><li>Default: <code>16</code></li></ul></li></ul></li></ul><h2id="secure"tabindex="-1">Secure <aclass="header-anchor"href="#secure"aria-label="Permalink to "Secure {#secure}""></a></h2><p>Configures the <ahref="./features/secure">Secure</a> feature.</p><ul><li><code>secure</code><ul><li><code>enabled</code><ul><li>Enable the Secure feature.</li
