info.json
This file is used by the QMK API. It contains the information QMK Configurator needs to display a representation of your keyboard. You can also set metadata here.
You can create info.json
files at every level under qmk_firmware/keyboards/<name>
to specify this metadata. 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 manufacturer
and maintainer
, while qmk_firmware/keyboards/clueboard/66/info.json
specifies more specific information about Clueboard 66%.
info.json
FormatThe info.json
file is a JSON formatted dictionary with the following keys available to be set. You do not have to set all of them, merely the keys that apply to your keyboard.
keyboard_name
Clueboard 66%
manufacturer
Clueboard
url
https://clueboard.co
maintainer
qmk
for community maintained boards.skullydazed
debounce
5
diode_direction
DIRECT_PINS
in the hardware configuration for more details.layout_aliases
layouts
it maps to.layouts
matrix_pins
rgblight
usb
Within our info.json
file the layouts
portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout macros, for example LAYOUT_ansi
or LAYOUT_iso
.
layout
Each Key Dictionary in a layout describes the physical properties of a key. If you are familiar with the Raw Code for https://keyboard-layout-editor.com you will find many of the concepts the same. We re-use the same key names and layout choices wherever possible, but unlike keyboard-layout-editor each key is stateless, inheriting no properties from the keys that came before it.
All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
x
y
w
1
h
1
label
matrix
[0, 4]
Currently QMK supports connecting switches either directly to GPIO pins or via a switch matrix. At this time you can not combine these, they are mutually exclusive.
Most keyboards use a switch matrix to connect keyswitches to the MCU. You can define your pin columns and rows to configure your switch matrix. When defining switch matrices you should also define your diode_direction
.
Example:
{
"diode_direction": "COL2ROW",
"matrix_pins": {
"cols": ["F4", "E6", "B1", "D2"],
"rows": ["B0", "D3", "D5", "D4", "D6"]
}
}
Direct pins are when you connect one side of the switch to GND and the other side to a GPIO pin on your MCU. No diode is required, but there is a 1:1 mapping between switches and pins.
When specifying direct pins you need to arrange them in nested arrays. The outer array consists of rows, while the inner array is a text string corresponding to a pin. You can use null
to indicate an empty spot in the matrix.
Example:
{
"matrix_pins": {
"direct": [
["A10", "A9"],
["A0", "B8"],
[null, "B11"],
["B9", "A8"],
["A7", "B1"],
[null, "B2"]
]
}
}
This section controls the legacy WS2812 support in QMK. This should not be confused with the RGB Matrix feature, which can be used to control both WS2812 and ISSI RGB LEDs.
The following items can be set. Not every value is required.
led_count
pin
animations
sleep
true
to enable lighting during host sleepsplit
true
to enable synchronization functionality between split halvessplit_count
max_brightness
hue_steps
saturation_steps
brightness_steps
Example:
{
"rgblight": {
"led_count": 4,
"pin": "F6",
"hue_steps": 10,
"saturation_steps": 17,
"brightness_steps": 17,
"animations": {
"all": true
}
}
}
The following animations can be enabled:
Key | Description |
---|---|
all |
Enable all additional animation modes. |
alternating |
Enable alternating animation mode. |
breathing |
Enable breathing animation mode. |
christmas |
Enable christmas animation mode. |
knight |
Enable knight animation mode. |
rainbow_mood |
Enable rainbow mood animation mode. |
rainbow_swirl |
Enable rainbow swirl animation mode. |
rgb_test |
Enable RGB test animation mode. |
snake |
Enable snake animation mode. |
static_gradient |
Enable static gradient mode. |
twinkle |
Enable twinkle animation mode. |
Every USB keyboard needs to have its USB parmaters defined. At a minimum you need to set vid, pid, and device version.
Example:
{
"usb": {
"vid": "0xC1ED",
"pid": "0x23B0",
"device_ver": "0x0001"
}
}