drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Polish Configurator section

Browse source
This commit is contained in:
James Young 2020-02-25 17:22:05 -08:00 • committed by skullydazed
parent 503b52652c
commit d5f34c4810
5 changed files with 30 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/reference_configurator_support.md
View file

@ -10,11 +10,11 @@ To understand how the Configurator understands keyboards, first one must underst
```
|---------------|
|NLk| / | * | - |
|---+---+-------|
|---+---+---+---|
|7 |8 |9 | + |
|---+---+---| │
|---+---+---| |
|4 |5 |6 | |
|---+---+-------|
|---+---+---+---|
|1 |2 |3 |Ent|
|-------+---| |
|0 | . | |
@ -130,18 +130,20 @@ Use the `keyboard_name` object to set the name of the keyboard. For instruction
The `layouts` object contains the data that represents the physical layout of the keyboard. It has an object `LAYOUT`, which needs to match the name of our layout macro from `numpad.h`. The `LAYOUT` object itself has an object named `layout`, which contains one JSON object for each physical key on our keyboard, formatted as follows:
```
┌ The name of the key. Not displayed in the Configurator.
│ ┌ The key's X-axis location, in key units from the
│ │ keyboard's left edge.
│ │ ┌ The key's Y-axis location, in key units from
│ │ │ the keyboard's top (rear-facing) edge.
The name of the key. Not displayed in the Configurator.
|
| The key's X-axis location, in key units from the
| | keyboard's left edge.
| |
| | The key's Y-axis location, in key units from
| | | the keyboard's top (rear-facing) edge.
↓ ↓ ↓
{"label":"Num Lock", "x":0, "y":0},
```
Some objects will also have `"w"` and `"h"` keys, which represent a key's width and height, respectively.
?> For more on the `info.json` files, see [QMK Keyboard Guidelines: Keyboard Metadata](hardware_keyboard_guidelines.md?id=keyboard-metadata)
?> For more on the `info.json` files, see [`info.json` Format](reference_info_json.md).
## How the Configurator Programs Keys