auri.ee
keyboard stuff
1# `info.json` Reference {#info-json-reference}
2
3The information contained in `info.json` is combined with the `config.h` and `rules.mk` files, dynamically generating the necessary configuration for your keyboard at compile time. It is also used by the [QMK API](https://github.com/qmk/qmk_api), and contains the information [QMK Configurator](https://config.qmk.fm/) needs to display a representation of your keyboard. Its key/value pairs are ruled by the [`data/schemas/keyboard.jsonschema`](https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema) file. To learn more about the why and how of the schema file see the [Data Driven Configuration](data_driven_config) page.
4
5You can create `info.json` files at every level under `qmk_firmware/keyboards/<keyboard>`. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, `qmk_firmware/keyboards/clueboard/info.json` specifies information common to all Clueboard products, such as `manufacturer` and `maintainer`, while `qmk_firmware/keyboards/clueboard/66/info.json` contains more specific information about Clueboard 66%.
6
7## General Metadata {#general-metadata}
8
9* `keyboard_name` <Badge type="info">String</Badge> <Badge>Required</Badge>
10 * A free-form text string describing the keyboard. This will be used as the USB product string. Can include Unicode characters, escaped to ASCII eg. `\u03A8` (Ψ).
11 * Example: `"Clueboard 66%"`
12* `maintainer` <Badge type="info">String</Badge> <Badge>Required</Badge>
13 * GitHub username of the maintainer, or `qmk` for community maintained boards.
14 * Example: `"skullydazed"`
15* `manufacturer` <Badge type="info">String</Badge> <Badge>Required</Badge>
16 * A free-form text string describing the keyboard's manufacturer. This will be used as the USB manufacturer string. Can include Unicode characters, escaped to ASCII eg. `\u03A8` (Ψ).
17 * Example: `"Clueboard"`
18* `url` <Badge type="info">String</Badge> <Badge>Required</Badge>
19 * A URL to the keyboard's product page, [QMK Keyboards](https://browse.qmk.fm/) page, or other page describing information about the keyboard.
20 * Example: `"https://clueboard.co"`
21* `bootloader_instructions` <Badge type="info">String</Badge>
22 * Instructions for putting the keyboard into a mode that allows for firmware flashing.
23 * Example: `"Press the button marked RESET on the back of the PCB"`
24* `tags` <Badge type="info">Array: String</Badge>
25 * A list of tags describing the keyboard.
26 * Example: `["ortho", "split", "rgb"]`
27
28## Hardware Configuration {#hardware-configuration}
29
30* `board` <Badge type="info">String</Badge>
31 * Override the default ChibiOS board name (ARM-based keyboards only).
32 * Example: `"BLACKPILL_STM32_F411"`
33* `bootloader` <Badge type="info">String</Badge>
34 * The bootloader in use on the keyboard. Required if `development_board` is not specified.
35* `development_board` <Badge type="info">String</Badge>
36 * The microcontroller development board, if applicable.
37 * Example: `"promicro"`
38* `pin_compatible` <Badge type="info">String</Badge>
39 * The form factor of the development board, if applicable. Must be one of `elite_c`, `promicro`.
40* `processor` <Badge type="info">String</Badge>
41 * The microcontroller in use on the keyboard. Required if `development_board` is not specified.
42
43## Firmware Configuration {#firmware-configuration}
44
45* `build`
46 * `debounce_type`<Badge type="info">String</Badge>
47 * The debounce algorithm to use. Must be one of `asym_eager_defer_pk`, `custom`, `sym_defer_g`, `sym_defer_pk`, `sym_defer_pr`, `sym_eager_pk`, `sym_eager_pr`.
48 * `firmware_format`<Badge type="info">String</Badge>
49 * The format of the final output binary. Must be one of `bin`, `hex`, `uf2`.
50 * `lto`<Badge type="info">Boolean</Badge>
51 * Enable Link-Time Optimization.
52 * Default: `false`
53* `features`<Badge type="info">Object: Boolean</Badge>
54 * A dictionary of features to enable or disable.
55 * Example:
56 ```json
57 {
58 "rgb_matrix": true,
59 "rgblight": false
60 }
61 ```
62* `qmk`
63 * `locking`
64 * `enabled` <Badge type="info">Boolean</Badge>
65 * Enable locking switch support.
66 * Default: `false`
67 * `resync` <Badge type="info">Boolean</Badge>
68 * Keep switch state consistent with keyboard LED state.
69 * Default: `false`
70 * `tap_capslock_delay` <Badge type="info">Number</Badge>
71 * The delay between keydown and keyup for Caps Lock tap events in milliseconds.
72 * Default: `80` (80 ms)
73 * `tap_keycode_delay` <Badge type="info">Number</Badge>
74 * The delay between keydown and keyup for tap events in milliseconds.
75 * Default: `0` (no delay)
76* `tapping`
77 * `chordal_hold` <Badge type="info">Boolean</Badge>
78 * Default: `false`
79 * `hold_on_other_key_press` <Badge type="info">Boolean</Badge>
80 * Default: `false`
81 * `hold_on_other_key_press_per_key` <Badge type="info">Boolean</Badge>
82 * Default: `false`
83 * `permissive_hold` <Badge type="info">Boolean</Badge>
84 * Default: `false`
85 * `permissive_hold_per_key` <Badge type="info">Boolean</Badge>
86 * Default: `false`
87 * `retro` <Badge type="info">Boolean</Badge>
88 * Default: `false`
89 * `retro_per_key` <Badge type="info">Boolean</Badge>
90 * Default: `false`
91 * `term` <Badge type="info">Number</Badge>
92 * Default: `200` (200 ms)
93 * `term_per_key` <Badge type="info">Boolean</Badge>
94 * Default: `false`
95 * `toggle` <Badge type="info">Number</Badge>
96 * Default: `5`
97
98## APA102 {#apa102}
99
100Configures the [APA102](drivers/apa102) driver.
101
102* `apa102`
103 * `clock_pin` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
104 * The GPIO pin connected to `CI` on the first LED in the chain.
105 * `data_pin` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
106 * The GPIO pin connected to `DI` on the first LED in the chain.
107 * `default_brightness` <Badge type="info">Number</Badge>
108 * The initial global brightness level (independent of the RGB data), from 0 to 31.
109 * Default: `31`
110
111## Audio {#audio}
112
113Configures the [Audio](features/audio) feature.
114
115* `audio`
116 * `default`
117 * `on` <Badge type="info">Boolean</Badge>
118 * The default audio enabled state.
119 * Default: `true`
120 * `clicky` <Badge type="info">Boolean</Badge>
121 * The default audio clicky enabled state.
122 * Default: `true`
123 * `driver` <Badge type="info">String</Badge>
124 * The driver to use. Must be one of `dac_additive`, `dac_basic`, `pwm_software`, `pwm_hardware`.
125 * `macro_beep` <Badge type="info">Boolean</Badge>
126 * Play a short beep for `\a` (ASCII `BEL`) characters in Send String macros.
127 * Default: `false`
128 * `pins` <Badge type="info">Array: Pin</Badge> <Badge>Required</Badge>
129 * The GPIO pin(s) connected to the speaker(s).
130 * `power_control`
131 * `on_state` <Badge type="info">0|1</Badge>
132 * The logical GPIO state required to turn the speaker on.
133 * Default: `1` (on = high)
134 * `pin` <Badge type="info">Pin</Badge>
135 * The GPIO pin connected to speaker power circuit.
136 * `voices` <Badge type="info">Boolean</Badge>
137 * Use multiple audio voices.
138 * Default: `false`
139
140
141## Backlight {#backlight}
142
143Configures the [Backlight](features/backlight) feature.
144
145* `backlight`
146 * `as_caps_lock` <Badge type="info">Boolean</Badge>
147 * Use the backlight as a Caps Lock indicator.
148 * Default: `false`
149 * `breathing` <Badge type="info">Boolean</Badge>
150 * Whether backlight breathing is enabled.
151 * Default: `false`
152 * `breathing_period` <Badge type="info">Number</Badge>
153 * The length of one backlight breathing cycle in seconds.
154 * Default: `6` (6 seconds)
155 * `default`
156 * `on` <Badge type="info">Boolean</Badge>
157 * The default backlight enabled state.
158 * Default: `true`
159 * `breathing` <Badge type="info">Boolean</Badge>
160 * The default backlight breathing state.
161 * Default: `false`
162 * `brightness` <Badge type="info">Number</Badge>
163 * The default brightness level.
164 * Default: `max_brightness`
165 * `driver` <Badge type="info">String</Badge>
166 * The driver to use. Must be one of `custom`, `pwm`, `software`, `timer`.
167 * Default: `"pwm"`
168 * `levels` <Badge type="info">Number</Badge>
169 * The number of brightness levels (excluding off), from 1 to 31.
170 * Default: `3`
171 * `max_brightness` <Badge type="info">Number</Badge>
172 * The maximum PWM value which brightness is scaled to, from 0 to 255.
173 * Default: `255`
174 * `on_state` <Badge type="info">0|1</Badge>
175 * The logical GPIO state required to turn the LEDs on.
176 * Default: `1` (on = high)
177 * `pin` <Badge type="info">Pin</Badge>
178 * The GPIO pin connected to the backlight circuit.
179 * `pins` <Badge type="info">Array: Pin</Badge>
180 * A list of GPIO pins connected to the backlight LEDs (`software` and `timer` drivers only).
181
182## Battery
183
184Configures the [Battery](features/battery) feature.
185
186* `battery`
187 * `adc`
188 * `pin` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
189 * The GPIO pin connected to the voltage divider.
190 * `reference_voltage` <Badge type="info">Number</Badge>
191 * The ADC reverence voltage, in millivolts.
192 * Default: `3300`
193 * `divider_r1` <Badge type="info">Number</Badge>
194 * The voltage divider resistance, in kOhm. Set to 0 to disable.
195 * Default: `100`
196 * `divider_r2` <Badge type="info">Number</Badge>
197 * The voltage divider resistance, in kOhm. Set to 0 to disable.
198 * Default: `100`
199 * `resolution` <Badge type="info">Number</Badge>
200 * The ADC resolution configured for the ADC Driver.
201 * Default: `10`
202 * `driver` <Badge type="info">String</Badge> <Badge>Required</Badge>
203 * The driver to use. Must be one of `adc`, `custom`, `vendor`.
204 * `sample_interval` <Badge type="info">Number</Badge>
205 * The delay between sampling the battery in milliseconds.
206 * Default: `30000` (30 s)
207
208## Wireless/Bluetooth {#bluetooth}
209
210Configures the [Wireless](features/wireless) feature.
211
212* `bluetooth`
213 * `driver` <Badge type="info">String</Badge>
214 * The driver to use. Must be one of `custom`, `bluefruit_le`, `rn42`.
215
216## Bootmagic {#bootmagic}
217
218Configures the [Bootmagic](features/bootmagic) feature.
219
220* `bootmagic`
221 * `enabled` <Badge type="info">Boolean</Badge>
222 * Enables the Bootmagic feature.
223 * Default: `false`
224 * `matrix` <Badge type="info">Matrix</Badge>
225 * The matrix position of the key to check during startup. This should generally be set to the (physically) top left key.
226 * Default: `[0, 0]`
227
228## Caps Word {#caps-word}
229
230Configures the [Caps Word](features/caps_word) feature.
231
232* `caps_word`
233 * `both_shifts_turns_on` <Badge type="info">Boolean</Badge>
234 * Activate Caps Word by pressing both Shift keys.
235 * Default: `false`
236 * `double_tap_shift_turns_on` <Badge type="info">Boolean</Badge>
237 * Activate Caps Word by pressing Left Shift twice.
238 * Default: `false`
239 * `enabled` <Badge type="info">Boolean</Badge>
240 * Enables the Caps Word feature.
241 * Default: `false`
242 * `idle_timeout` <Badge type="info">Number</Badge>
243 * The amount of time before Caps Word automatically deactivates in milliseconds.
244 * Default: `5000` (5 seconds)
245 * `invert_on_shift` <Badge type="info">Boolean</Badge>
246 * Invert shift state instead of deactivating Caps Word when Shift is pressed.
247 * Default: `false`
248
249## Combo {#combo}
250
251Configures the [Combo](features/combo) feature.
252
253* `combo`
254 * `term` <Badge type="info">Number</Badge>
255 * The amount of time to recognize a combo in milliseconds.
256 * Default: `50` (50 ms)
257
258## DIP Switches {#dip-switch}
259
260Configures the [DIP Switches](features/dip_switch) feature.
261
262* `dip_switch`
263 * `enabled` <Badge type="info">Boolean</Badge>
264 * Enable the DIP Switches feature.
265 * Default: `false`
266 * `pins` <Badge type="info">Array: Pin</Badge>
267 * A list of GPIO pins connected to the MCU.
268 * `matrix_grid` <Badge type="info">Array: Matrix</Badge>
269 * A list of matrix locations in the key matrix.
270 * Example: `[ [0,6], [1,6], [2,6] ]`
271
272## EEPROM {#eeprom}
273
274Configures the [EEPROM](drivers/eeprom) driver.
275
276* `eeprom`
277 * `driver` <Badge type="info">String</Badge>
278 * The EEPROM backend to use. Must be one of `custom`, `i2c`, `legacy_stm32_flash`, `spi`, `transient`, `vendor`, `wear_leveling`.
279 * Default: `"vendor"`
280 * `wear_leveling`
281 * `driver` <Badge type="info">String</Badge>
282 * The driver to use. Must be one of `embedded_flash`, `legacy`, `rp2040_flash`, `spi_flash`, `custom`.
283 * `backing_size` <Badge type="info">Number</Badge>
284 * Number of bytes used by the wear-leveling algorithm for its underlying storage, and needs to be a multiple of the logical size.
285 * `logical_size` <Badge type="info">Number</Badge>
286 * Number of bytes “exposed” to the rest of QMK and denotes the size of the usable EEPROM.
287
288## Encoder {#encoder}
289
290Configures the [Encoder](features/encoders) feature.
291
292* `encoder`
293 * `rotary` <Badge type="info">Array: Object</Badge>
294 * A list of encoder objects.
295 * `pin_a` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
296 * The GPIO pin connected to the encoder's `A` pin.
297 * `pin_b` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
298 * The GPIO pin connected to the encoder's `B` pin.
299 * `resolution` <Badge type="info">Number</Badge>
300 * The number of edge transitions on both pins required to register an input.
301 * Default: `4`
302
303## Host {#host}
304
305* `host`
306 * `default`
307 * `nkro` <Badge type="info">Boolean</Badge>
308 * The default nkro state.
309 * Default: `false`
310
311## Indicators {#indicators}
312
313Configures the [LED Indicators](features/led_indicators) feature.
314
315* `indicators`
316 * `caps_lock` <Badge type="info">Pin</Badge>
317 * The GPIO pin connected to the Caps Lock LED.
318 * `compose` <Badge type="info">Pin</Badge>
319 * The GPIO pin connected to the Compose LED.
320 * `kana` <Badge type="info">Pin</Badge>
321 * The GPIO pin connected to the Kana LED.
322 * `num_lock` <Badge type="info">Pin</Badge>
323 * The GPIO pin connected to the Num Lock LED.
324 * `on_state` <Badge type="info">0|1</Badge>
325 * The logical GPIO state required to turn the LEDs on.
326 * Default: `1` (on = high)
327 * `scroll_lock` <Badge type="info">Pin</Badge>
328 * The GPIO pin connected to the Scroll Lock LED.
329
330## (Custom) Keycodes {#keycodes}
331
332Defines [custom keycodes](custom_quantum_functions#definining-a-new-keycode) for use within keymaps.
333
334* `keycodes` <Badge type="info">Array: Object</Badge>
335 * A list of keycode objects.
336 * `key` <Badge type="info">String</Badge> <Badge>Required</Badge>
337 * The enum name of the custom keycode.
338 * Example: `LAYER_CHANGE_BEEP_ON`
339 * `label` <Badge type="info">String</Badge>
340 * A short description of the custom keycode.
341 * `aliases` <Badge type="info">Array: String</Badge>
342 * A list of shortened names for the custom keycode.
343 * Example: `["LCBON", "LCB_ON"]`
344
345## Layouts {#layouts}
346
347The `layouts` portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout names, for example `LAYOUT_60_ansi` or `LAYOUT_60_iso`.
348
349Each key dictionary in a layout describes the physical properties of a key. If you are familiar with the Raw Data format for [Keyboard Layout Editor](https://keyboard-layout-editor.com), you will find many of the concepts the same. Key names and layout choices are reused wherever possible, but unlike KLE each key is stateless, inheriting no properties from the keys that came before it.
350
351All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
352
353The ISO enter key is represented by a 1.25u×2uh key. Renderers which utilize info.json layout data (such as `qmk info -l` and the QMK Configurator) should display this key as expected.
354
355* `community_layouts` <Badge type="info">Array: String</Badge>
356 * A list of community layouts supported by the keyboard.
357 * Example: `["60_ansi", "60_iso"]`
358* `layout_aliases` <Badge type="info">Object: String</Badge>
359 * A mapping of layout aliases to layout definitions.
360 * Example:
361 ```json
362 {
363 "LAYOUT_ansi": "LAYOUT_60_ansi",
364 "LAYOUT_iso": "LAYOUT_60_iso"
365 }
366 ```
367* `layouts` <Badge type="info">Object</Badge>
368 * A dictionary of layouts supported by the keyboard.
369 * `LAYOUT_<layout_name>` <Badge type="info">Object</Badge>
370 * `layout` <Badge type="info">Array: Object</Badge>
371 * A list of key dictionaries comprising the layout. Each key dictionary contains:
372 * `matrix` <Badge type="info">Matrix</Badge> <Badge>Required</Badge>
373 * The matrix position for the key.
374 * Example: `[0, 4]` (row 0, column 4)
375 * `x` <Badge type="info">KeyUnit</Badge> <Badge>Required</Badge>
376 * The absolute position of the key in the horizontal axis, in key units.
377 * `y` <Badge type="info">KeyUnit</Badge> <Badge>Required</Badge>
378 * The absolute position of the key in the vertical axis, in key units.
379 * `h` <Badge type="info">KeyUnit</Badge>
380 * The height of the key, in key units.
381 * Default: `1` (1u)
382 * `hand` <Badge type="info">String</Badge>
383 * The handedness of the key for Chordal Hold, either `"L"` (left hand), `"R"` (right hand), or `"*"` (either or exempted handedness).
384 * `label` <Badge type="info">String</Badge>
385 * What to name the key. This is *not* a key assignment as in the keymap, but should usually correspond to the keycode for the first layer of the default keymap.
386 * Example: `"Escape"`
387 * `r` <Badge type="info">Number</Badge>
388 * The rotation angle in degrees. Currently not implemented.
389 * `rx` <Badge type="info">Number</Badge>
390 * The absolute X position of the rotation axis. Currently not implemented.
391 * `ry` <Badge type="info">Number</Badge>
392 * The absolute Y position of the rotation axis. Currently not implemented.
393 * `w` <Badge type="info">KeyUnit</Badge>
394 * The width of the key, in key units.
395 * Default: `1` (1u)
396 * `encoder` <Badge type="info">Number</Badge>
397 * The index of an encoder this key should be linked to
398 * Example: `{"label": "Shift", "matrix": [4, 0], "x": 0, "y": 4.25, "w": 2.25}`
399
400## Leader Key {#leader-key}
401
402Configures the [Leader Key](features/leader_key) feature.
403
404* `leader_key`
405 * `timing` <Badge type="info">Boolean</Badge>
406 * Reset the `timeout` on each keypress.
407 * Default: `false`
408 * `strict_processing` <Badge type="info">Boolean</Badge>
409 * Do not extract the tap keycodes from Layer-Tap and Mod-Tap key events.
410 * Default: `false`
411 * `timeout` <Badge type="info">Number</Badge>
412 * The amount of time to complete a leader sequence in milliseconds.
413 * Default: `300` (300 ms)
414
415## LED Matrix {#led-matrix}
416
417Configures the [LED Matrix](features/led_matrix) feature.
418
419* `led_matrix`
420 * `animations` <Badge type="info">Object: Boolean</Badge>
421 * A dictionary of effects to enable or disable. Effects which are absent default to `false`.
422 * Example:
423 ```json
424 {
425 "alphas_mods": true,
426 "breathing": true,
427 "cycle_left_right": false
428 }
429 ```
430 * `center_point` <Badge type="info">Array: Number</Badge>
431 * The centroid (geometric center) of the LEDs. Used for certain effects.
432 * Default: `[112, 32]`
433 * `flag_steps` <Badge type="info">Array: Number</Badge>
434 * A list of flag bitfields that can be cycled through.
435 * Default: `[255, 5, 0]`
436 * `default`
437 * `animation` <Badge type="info">String</Badge>
438 * The default effect. Must be one of `led_matrix.animations`
439 * Default: `"solid"`
440 * `on` <Badge type="info">Boolean</Badge>
441 * The default enabled state.
442 * Default: `true`
443 * `val` <Badge type="info">Number</Badge>
444 * The default brightness level.
445 * Default: `max_brightness`
446 * `speed` <Badge type="info">Number</Badge>
447 * The default animation speed.
448 * Default: `128`
449 * `flags` <Badge type="info">Number</Badge>
450 * The default LED flags.
451 * Default: `255`
452 * `driver` <Badge type="info">String</Badge> <Badge>Required</Badge>
453 * The driver to use. Must be one of `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`.
454 * `layout` <Badge type="info">Array: Object</Badge> <Badge>Required</Badge>
455 * List of LED configuration dictionaries. Each dictionary contains:
456 * `flags` <Badge type="info">Number</Badge> <Badge>Required</Badge>
457 * A bitfield of flags describing the type of LED.
458 * `x` <Badge type="info">Number</Badge> <Badge>Required</Badge>
459 * The position of the LED in the horizontal axis, from 0 to 224.
460 * `y` <Badge type="info">Number</Badge> <Badge>Required</Badge>
461 * The position of the LED in the vertical axis, from 0 to 64.
462 * `matrix` <Badge type="info">Matrix</Badge>
463 * The key matrix position associated with the LED.
464 * Example: `[0, 2]`
465 * Example: `{"matrix": [2, 1], "x": 20, "y": 48, "flags": 2}`
466 * `led_flush_limit` <Badge type="info">Number</Badge>
467 * Limits in milliseconds how frequently an animation will update the LEDs.
468 * Default: `16`
469 * `led_process_limit` <Badge type="info">Number</Badge>
470 * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness).
471 * Default: `(led_count + 4) / 5`
472 * `max_brightness` <Badge type="info">Number</Badge>
473 * The maximum value which brightness is scaled to, from 0 to 255.
474 * Default: `255`
475 * `react_on_keyup` <Badge type="info">Boolean</Badge>
476 * Animations react to keyup instead of keydown.
477 * Default: `false`
478 * `sleep` <Badge type="info">Boolean</Badge>
479 * Turn off the LEDs when the host goes to sleep.
480 * Default: `false`
481 * `speed_steps` <Badge type="info">Number</Badge>
482 * The value by which to increment the speed.
483 * Default: `16`
484 * `split_count` <Badge type="info">Array: Number</Badge>
485 * For split keyboards, the number of LEDs on each half.
486 * Example: `[16, 16]`
487 * `timeout` <Badge type="info">Number</Badge>
488 * The LED activity timeout in milliseconds.
489 * Default: `0` (no timeout)
490 * `val_steps` <Badge type="info">Number</Badge>
491 * The value by which to increment the brightness.
492 * Default: `8`
493
494## Matrix {#matrix}
495
496* `debounce` <Badge type="info">Number</Badge>
497 * The debounce time in milliseconds.
498 * Default: `5` (5 ms)
499* `diode_direction` <Badge type="info">String</Badge>
500 * Which way the diodes are "pointing". Unused for `matrix_pins.direct`. Must be one of `COL2ROW`, `ROW2COL`.
501* `matrix_pins`
502 * `cols` <Badge type="info">Array: Pin</Badge>
503 * A list of GPIO pins connected to the matrix columns.
504 * Example: `["A0", "A1", "A2"]`
505 * `custom` <Badge type="info">Boolean</Badge>
506 * Whether to use a custom matrix scanning implementation.
507 * Default: `false`
508 * `custom_lite` <Badge type="info">Boolean</Badge>
509 * Whether to use a "lite" custom matrix scanning implementation.
510 * Default: `false`
511 * `direct` <Badge type="info">Array: Array: Pin</Badge>
512 * A 2-dimensional list of GPIO pins connected to each keyswitch, forming the "matrix" rows and columns.
513 * Example:
514 ```json
515 [
516 ["A0", "A1", "A2"],
517 ["B0", "B1", "B2"],
518 ["C0", "C1", "C2"]
519 ]
520 ```
521 * `ghost` <Badge type="info">Boolean</Badge>
522 * Whether the matrix has no anti-ghosting diodes.
523 * Default: `false`
524 * `input_pressed_state` <Badge type="info">0|1</Badge>
525 * The logical GPIO state of the input pins when a key is pressed.
526 * Default: `0` (pressed = low)
527 * `io_delay` <Badge type="info">Number</Badge>
528 * The amount of time to wait between row/col selection and col/row pin reading, in microseconds.
529 * Default: `30` (30 µs)
530 * `masked` <Badge type="info">Boolean</Badge>
531 * Whether unconfigured intersections should be ignored.
532 * Default: `false`
533 * `rows` <Badge type="info">Array: Pin</Badge>
534 * A list of GPIO pins connected to the matrix rows.
535 * Example: `["B0", "B1", "B2"]`
536
537## Mouse Keys {#mouse-keys}
538
539Configures the [Mouse Keys](features/mouse_keys) feature.
540
541* `mouse_key`
542 * `delay` <Badge type="info">Number</Badge>
543 * `enabled` <Badge type="info">Boolean</Badge>
544 * Enables the Mouse Keys feature.
545 * Default: `false`
546 * `interval` <Badge type="info">Number</Badge>
547 * `max_speed` <Badge type="info">Number</Badge>
548 * `time_to_max` <Badge type="info">Number</Badge>
549 * `wheel_delay` <Badge type="info">Number</Badge>
550
551## One Shot {#one-shot}
552
553Configures [One Shot keys](one_shot_keys).
554
555* `oneshot`
556 * `tap_toggle` <Badge type="info">Number</Badge>
557 * The number of times to tap the key in order to hold it.
558 * `timeout` <Badge type="info">Number</Badge>
559 * The amount of time before the key is released in milliseconds.
560
561## PS/2 {#ps2}
562
563Configures the [PS/2](features/ps2_mouse) feature.
564
565* `ps2`
566 * `clock_pin` <Badge type="info">Pin</Badge>
567 * The GPIO pin connected to `CLK` on the PS/2 device.
568 * `data_pin` <Badge type="info">Pin</Badge>
569 * The GPIO pin connected to `DATA` on the PS/2 device.
570 * `driver` <Badge type="info">String</Badge>
571 * The PS/2 driver to use. Must be one of `busywait`, `interrupt`, `usart`, `vendor`.
572 * Default: `"busywait"`
573 * `enabled` <Badge type="info">Boolean</Badge>
574 * Enable the PS/2 feature.
575 * Default: `false`
576 * `mouse_enabled` <Badge type="info">Boolean</Badge>
577 * Enable the PS/2 mouse handling.
578 * Default: `false`
579
580## QMK LUFA Bootloader {#qmk-lufa-bootloader}
581
582* `qmk_lufa_bootloader`
583 * `esc_input` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
584 * The GPIO pin connected to the designated "exit bootloader" key's row (if `COL2ROW`).
585 * `esc_output` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
586 * The GPIO pin connected to the designated "exit bootloader" key's column (if `COL2ROW`).
587 * `led` <Badge type="info">Pin</Badge>
588 * The GPIO pin connected to an LED to flash.
589 * `speaker` <Badge type="info">Pin</Badge>
590 * The GPIO pin connected to a speaker to click (can also be used for a second LED).
591
592## RGBLight {#rgblight}
593
594Configures the [RGB Lighting](features/rgblight) feature.
595
596* `rgblight`
597 * `led_count` <Badge type="info">Number</Badge> <Badge>Required</Badge>
598 * The number of LEDs in the chain.
599 * `animations` <Badge type="info">Object: Boolean</Badge>
600 * A dictionary of effects to enable or disable. Effects which are absent default to `false`.
601 * Example:
602 ```json
603 {
604 "breathing": true,
605 "rainbow_mood": true,
606 "snake": false
607 }
608 ```
609 * `brightness_steps` <Badge type="info">Number</Badge>
610 * The value by which to increment the brightness.
611 * Default: `17`
612 * `default`
613 * `animation` <Badge type="info">String</Badge>
614 * The default effect. Must be one of `rgblight.animations`
615 * Default: `"static_light"`
616 * `on` <Badge type="info">Boolean</Badge>
617 * The default enabled state.
618 * Default: `true`
619 * `hue` <Badge type="info">Number</Badge>
620 * The default hue value.
621 * Default: `0`
622 * `sat` <Badge type="info">Number</Badge>
623 * The default saturation value.
624 * Default: `255`
625 * `val` <Badge type="info">Number</Badge>
626 * The default brightness level.
627 * Default: `max_brightness`
628 * `speed` <Badge type="info">Number</Badge>
629 * The default animation speed.
630 * Default: `0`
631 * `driver` <Badge type="info">String</Badge>
632 * The driver to use. Must be one of `apa102`, `custom`, `ws2812`.
633 * Default: `"ws2812"`
634 * `hue_steps` <Badge type="info">Number</Badge>
635 * The value by which to increment the hue.
636 * Default: `8`
637 * `layers`
638 * `blink` <Badge type="info">Boolean</Badge>
639 * Enable layer blinking API.
640 * Default: `false`
641 * `enabled` <Badge type="info">Boolean</Badge>
642 * Enable RGB Lighting Layers.
643 * Default: `false`
644 * `max` <Badge type="info">Number</Badge>
645 * The maximum layer count, from 1 to 32.
646 * Default: `8`
647 * `led_map` <Badge type="info">Array: Number</Badge>
648 * Remap LED indices.
649 * Example: `[4, 3, 2, 1, 0]`
650 * `max_brightness` <Badge type="info">Number</Badge>
651 * The maximum value which the HSV "V" component is scaled to, from 0 to 255.
652 * Default: `255`
653 * `saturation_steps` <Badge type="info">Number</Badge>
654 * The value by which to increment the suturation.
655 * Default: `17`
656 * `sleep` <Badge type="info">Boolean</Badge>
657 * Turn off the LEDs when the host goes to sleep.
658 * Default: `false`
659 * `split` <Badge type="info">Boolean</Badge>
660 * Enable synchronization between split halves.
661 * Default: `false`
662 * `split_count` <Badge type="info">Array: Number</Badge>
663 * When `rgblight.split` is enabled, the number of LEDs on each half.
664 * Example: `[10, 10]`
665
666## RGB Matrix {#rgb-matrix}
667
668Configures the [RGB Matrix](features/rgb_matrix) feature.
669
670* `rgb_matrix`
671 * `animations` <Badge type="info">Object: Boolean</Badge>
672 * A dictionary of effects to enable or disable. Effects which are absent default to `false`.
673 * Example:
674 ```json
675 {
676 "alphas_mods": true,
677 "breathing": true,
678 "cycle_left_right": false
679 }
680 ```
681 * `center_point` <Badge type="info">Array: Number</Badge>
682 * The centroid (geometric center) of the LEDs. Used for certain effects.
683 * Default: `[112, 32]`
684 * `flag_steps` <Badge type="info">Array: Number</Badge>
685 * A list of flag bitfields that can be cycled through.
686 * Default: `[255, 5, 2, 0]`
687 * `default`
688 * `animation` <Badge type="info">String</Badge>
689 * The default effect. Must be one of `rgb_matrix.animations`
690 * Default: `"solid_color"`
691 * `on` <Badge type="info">Boolean</Badge>
692 * The default enabled state.
693 * Default: `true`
694 * `hue` <Badge type="info">Number</Badge>
695 * The default hue value.
696 * Default: `0`
697 * `sat` <Badge type="info">Number</Badge>
698 * The default saturation value.
699 * Default: `255`
700 * `val` <Badge type="info">Number</Badge>
701 * The default brightness level.
702 * Default: `max_brightness`
703 * `speed` <Badge type="info">Number</Badge>
704 * The default animation speed.
705 * Default: `128`
706 * `flags` <Badge type="info">Number</Badge>
707 * The default LED flags.
708 * Default: `255`
709 * `driver` <Badge type="info">String</Badge> <Badge>Required</Badge>
710 * The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3236`, `is31fl3729`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`.
711 * `hue_steps` <Badge type="info">Number</Badge>
712 * The value by which to increment the hue.
713 * Default: `8`
714 * `layout` <Badge type="info">Array: Object</Badge> <Badge>Required</Badge>
715 * List of LED configuration dictionaries. Each dictionary contains:
716 * `flags` <Badge type="info">Number</Badge> <Badge>Required</Badge>
717 * A bitfield of flags describing the type of LED.
718 * `x` <Badge type="info">Number</Badge> <Badge>Required</Badge>
719 * The position of the LED in the horizontal axis, from 0 to 224.
720 * `y` <Badge type="info">Number</Badge> <Badge>Required</Badge>
721 * The position of the LED in the vertical axis, from 0 to 64.
722 * `matrix` <Badge type="info">Matrix</Badge>
723 * The key matrix position associated with the LED.
724 * Example: `[0, 2]`
725 * Example: `{"matrix": [2, 1], "x": 20, "y": 48, "flags": 2}`
726 * `led_flush_limit` <Badge type="info">Number</Badge>
727 * Limits in milliseconds how frequently an animation will update the LEDs.
728 * Default: `16`
729 * `led_process_limit` <Badge type="info">Number</Badge>
730 * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness).
731 * Default: `(led_count + 4) / 5`
732 * `max_brightness` <Badge type="info">Number</Badge>
733 * The maximum value which the HSV "V" component is scaled to, from 0 to 255.
734 * Default: `255`
735 * `react_on_keyup` <Badge type="info">Boolean</Badge>
736 * Animations react to keyup instead of keydown.
737 * Default: `false`
738 * `sat_steps` <Badge type="info">Number</Badge>
739 * The value by which to increment the saturation.
740 * Default: `16`
741 * `sleep` <Badge type="info">Boolean</Badge>
742 * Turn off the LEDs when the host goes to sleep.
743 * Default: `false`
744 * `speed_steps` <Badge type="info">Number</Badge>
745 * The value by which to increment the speed.
746 * Default: `16`
747 * `split_count` <Badge type="info">Array: Number</Badge>
748 * For split keyboards, the number of LEDs on each half.
749 * Example: `[16, 16]`
750 * `timeout` <Badge type="info">Number</Badge>
751 * The LED activity timeout in milliseconds.
752 * Default: `0` (no timeout)
753 * `val_steps` <Badge type="info">Number</Badge>
754 * The value by which to increment the brightness.
755 * Default: `16`
756
757## Secure {#secure}
758
759Configures the [Secure](features/secure) feature.
760
761* `secure`
762 * `enabled` <Badge type="info">Boolean</Badge>
763 * Enable the Secure feature.
764 * Default: `false`
765 * `idle_timeout` <Badge type="info">Number</Badge>
766 * Timeout while unlocked before returning to the locked state. Set to `0` to disable.
767 * Default: `60000` (1 minute)
768 * `unlock_sequence` <Badge type="info">Array: Matrix</Badge>
769 * A list of up to five matrix locations comprising the "unlock sequence".
770 * Example: `[[0, 0], [0, 1], [4, 3]]`
771 * `unlock_timeout` <Badge type="info">Number</Badge>
772 * Timeout for the user to perform the unlock sequence. Set to `0` to disable.
773 * Default: `5000` (5 seconds)
774
775## Split Keyboard {#split-keyboard}
776
777Configures the [Split Keyboard](features/split_keyboard) feature.
778
779* `split`
780 * `bootmagic`
781 * `matrix`
782 * See [Bootmagic](#bootmagic) config.
783 * `dip_switch`
784 * `right`
785 * `pins`
786 * See [DIP Switches](#dip-switch) config.
787 * `enabled` <Badge type="info">Boolean</Badge>
788 * Enable the Split Keyboard feature.
789 * Default: `false`
790 * `encoder`
791 * `right`
792 * `rotary`
793 * See [Encoder](#encoder) config.
794 * `handedness`
795 * `pin` <Badge type="info">Pin</Badge>
796 * The GPIO pin connected to determine handedness.
797 * `matrix_grid` <Badge type="info">Array: Pin</Badge>
798 * The GPIO pins of the matrix position which determines the handedness.
799 * Example: `["A1", "B5"]`
800 * `matrix_pins`
801 * `right`
802 * See [Matrix](#matrix) config.
803 * `serial`
804 * `driver` <Badge type="info">String</Badge>
805 * The driver to use. Must be one of `bitbang`, `usart`, `vendor`.
806 * Default: `"bitbang"`
807 * `pin` <Badge type="info">Pin</Badge>
808 * The GPIO pin to use for transmit and receive.
809 * `speed` <Badge type="info">Number</Badge>
810 * The protocol speed, from `0` to `5` (fastest to slowest).
811 * Default: `1`
812 * `transport`
813 * `protocol` <Badge type="info">String</Badge>
814 * The split transport protocol to use. Must be one of `custom`, `i2c`, `serial`.
815 * `sync`
816 * `activity` <Badge type="info">Boolean</Badge>
817 * Mirror the activity timestamps to the secondary half.
818 * Default: `false`
819 * `detected_os` <Badge type="info">Boolean</Badge>
820 * Mirror the [detected OS](features/os_detection) to the secondary half.
821 * Default: `false`
822 * `haptic` <Badge type="info">Boolean</Badge>
823 * Mirror the haptic state and process haptic feedback to the secondary half.
824 * Default: `false`
825 * `layer_state` <Badge type="info">Boolean</Badge>
826 * Mirror the layer state to the secondary half.
827 * Default: `false`
828 * `indicators` <Badge type="info">Boolean</Badge>
829 * Mirror the indicator state to the secondary half.
830 * Default: `false`
831 * `matrix_state` <Badge type="info">Boolean</Badge>
832 * Mirror the main/primary half's matrix state to the secondary half.
833 * Default: `false`
834 * `modifiers` <Badge type="info">Boolean</Badge>
835 * Mirror the modifier state to the secondary half.
836 * Default: `false`
837 * `oled` <Badge type="info">Boolean</Badge>
838 * Mirror the OLED on/off status to the secondary half.
839 * Default: `false`
840 * `st7565` <Badge type="info">Boolean</Badge>
841 * Mirror the ST7565 on/off status to the secondary half.
842 * Default: `false`
843 * `wpm` <Badge type="info">Boolean</Badge>
844 * Mirror the current WPM value to the secondary half.
845 * Default: `false`
846 * `watchdog` <Badge type="info">Boolean</Badge>
847 * Reboot the secondary half if it loses connection.
848 * Default: `false`
849 * `watchdog_timeout` <Badge type="info">Number</Badge>
850 * The amount of time to wait for communication from the primary half in milliseconds.
851 * `usb_detect`
852 * `enabled` <Badge type="info">Boolean</Badge>
853 * Detect USB connection when determining split half roles.
854 * `polling_interval` <Badge type="info">Number</Badge>
855 * The polling frequency in milliseconds.
856 * Default: `10` (10 ms)
857 * `timeout` <Badge type="info">Number</Badge>
858 * The amount of time to wait for a USB connection in milliseconds.
859 * Default: `2000` (2 seconds)
860
861## Stenography {#stenography}
862
863Configures the [Stenography](features/stenography) feature.
864
865* `stenography`
866 * `enabled` <Badge type="info">Boolean</Badge>
867 * Enable the Stenography feature.
868 * Default: `false`
869 * `protocol` <Badge type="info">String</Badge>
870 * The Steno protocol to use. Must be one of `all`, `geminipr`, `txbolt`.
871 * Default: `"all"`
872
873## USB {#usb}
874
875* `usb`
876 * `device_version` <Badge type="info">String</Badge> <Badge>Required</Badge>
877 * A BCD version number in the format `MM.m.r` (up to `99.9.9`).
878 * Example: `"1.0.0"`
879 * `pid` <Badge type="info">String</Badge> <Badge>Required</Badge>
880 * The USB product ID as a four-digit hexadecimal number.
881 * Example: `"0x23B0"`
882 * `vid` <Badge type="info">String</Badge> <Badge>Required</Badge>
883 * The USB vendor ID as a four-digit hexadecimal number.
884 * Example: `"0xC1ED"`
885 * `max_power` <Badge type="info">Number</Badge>
886 * The maximum current draw the host should expect from the device. This does not control the actual current usage.
887 * Default: `500` (500 mA)
888 * `no_startup_check` <Badge type="info">Boolean</Badge>
889 * Disable USB suspend check after keyboard startup.
890 * Default: `false`
891 * `polling_interval` <Badge type="info">Number</Badge>
892 * The frequency at which the host should poll the keyboard for reports.
893 * Default: `1` (1 ms/1000 Hz)
894 * `shared_endpoint`
895 * `keyboard` <Badge type="info">Boolean</Badge>
896 * Send keyboard reports through the "shared" USB endpoint.
897 * Default: `false`
898 * `mouse` <Badge type="info">Boolean</Badge>
899 * Send mouse reports through the "shared" USB endpoint.
900 * Default: `true`
901 * `suspend_wakeup_delay` <Badge type="info">Number</Badge>
902 * The amount of time to wait after sending a wakeup packet, in milliseconds.
903 * Default: `0` (disabled)
904 * `wait_for_enumeration` <Badge type="info">Boolean</Badge>
905 * Force the keyboard to wait for USB enumeration before starting up.
906 * Default: `false`
907
908## WS2812 {#ws2812}
909
910Configures the [WS2812](drivers/ws2812) driver.
911
912* `ws2812`
913 * `driver` <Badge type="info">String</Badge>
914 * The driver to use. Must be one of `bitbang`, `custom`, `i2c`, `pwm`, `spi`, `vendor`.
915 * Default: `"bitbang"`
916 * `pin` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
917 * The GPIO pin connected to `DI` on the first LED in the chain (`bitbang`, `pwm`, `spi` and `vendor` drivers only).
918 * `i2c_address` <Badge type="info">String</Badge>
919 * The I²C address of the WS2812 controller (`i2c` driver only).
920 * Default: `"0xB0"`
921 * `i2c_timeout` <Badge type="info">Number</Badge>
922 * The I²C timeout in milliseconds (`i2c` driver only).
923 * Default: `100` (100 ms)
924 * `rgbw` <Badge type="info">Boolean</Badge>
925 * Enable RGBW LEDs.
926 * Default: `false`