Mirrors_Framework/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-12-06 14:24:04 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[DOCS] Add keycodes to info.json docs. More precise matrix masking info (#25801)

Browse Source
This commit is contained in:
Jacek Królikowski
2025-12-04 13:15:43 +01:00
committed by GitHub
parent bf0b88c423
commit d39015a401
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/reference_info_json.md
View File

@@ -327,6 +327,21 @@ Configures the [LED Indicators](features/led_indicators) feature.
* `scroll_lock` <Badge type="info">Pin</Badge>
* The GPIO pin connected to the Scroll Lock LED.
## (Custom) Keycodes {#keycodes}
Defines [custom keycodes](custom_quantum_functions#definining-a-new-keycode) for use within keymaps.
* `keycodes` <Badge type="info">Array: Object</Badge>
* A list of keycode objects.
* `key` <Badge type="info">String</Badge> <Badge>Required</Badge>
* The enum name of the custom keycode.
* Example: `LAYER_CHANGE_BEEP_ON`
* `label` <Badge type="info">String</Badge>
* A short description of the custom keycode.
* `aliases` <Badge type="info">Array: String</Badge>
* A list of shortened names for the custom keycode.
* Example: `["LCBON", "LCB_ON"]`
## Layouts {#layouts}
The `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`.
@@ -513,7 +528,7 @@ Configures the [LED Matrix](features/led_matrix) feature.
* The amount of time to wait between row/col selection and col/row pin reading, in microseconds.
* Default: `30` (30 µs)
* `masked` <Badge type="info">Boolean</Badge>
* Whether configured intersections should be ignored.
* Whether unconfigured intersections should be ignored.
* Default: `false`
* `rows` <Badge type="info">Array: Pin</Badge>
* A list of GPIO pins connected to the matrix rows.