sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Allow strings in keymap. Replace with keys in keyboard _init cycle.

Browse Source
This commit is contained in:
John Morrison
2022-04-25 20:16:48 +01:00
committed by xs5871
parent a4d6a44a04
commit 9f964aba36
4 changed files with 43 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/config_and_keymap.md
View File

@@ -2,9 +2,9 @@
KMK is configured through a rather large plain-old-Python class called
`KMKKeyboard`. Subclasses of this configuration exist which pre-fill defaults
for various known keyboards (for example, many QMK, TMK, or ZMK keyboards
are supported with a nice!nano, or through our ItsyBitsy to Pro Micro pinout adapter.
This class is the main interface between end users and the inner workings of KMK.
for various known keyboards (for example, many QMK, TMK, or ZMK keyboards
are supported with a nice!nano, or through our ItsyBitsy to Pro Micro pinout adapter.
This class is the main interface between end users and the inner workings of KMK.
Let's dive in!
- Edit or create a file called `main.py` on your `CIRCUITPY` drive. You can also
@@ -73,6 +73,13 @@ print(dir(board))
keyboard.keymap = [[KC.A, KC.B]]
```
- You can also define the keymap with strings. They get replaced with `Key` objects
when the keyboard is started:
```python
keyboard.keymap = [['A', 'B']]
```
You can further define a bunch of other stuff:
- `keyboard.debug_enabled` which will spew a ton of debugging information to the serial