Skip to content

A truly modular keyboard

C

firmware: README mentions MAPC, MACRO, HOLD and the keyact test

Nathanb24a77320956
diff --git a/firmware/README.md b/firmware/README.md
index ee365ae..4e52112 100644
--- a/firmware/README.md
+++ b/firmware/README.md
@@ -66,6 +66,9 @@ Each Keybit sends whatever its UID is mapped to in `Core/Src/keymap.c`, and
an unmapped Keybit sends nothing. The map is set with the line protocol in
`Core/Src/proto.c` (`HELLO`, `KEYS?`, `MAP`, `MAPC`, `SAVE` and so on) over
either the Nordic UART Service (6e400001-b5a3-f393-e0a9-e50e24dcca9e) or USB.
+A Keybit can also be a media key (`MAPC`), type a short macro (`MACRO`, up to
+16 taps), or do one thing on a tap and another while held (`HOLD`, like Escape
+on tap and Ctrl on hold).
`SAVE` writes it to the flash page just under CPU2's area (0x080CF000 with the
full stack).
@@ -82,10 +85,11 @@ frames instead of PLLSAI1, set in `USB_Device/App/usb_device.c`.
screen /dev/tty.usbmodem* 115200 # then type HELLO and enter
```
-The parser has a host check:
+The parser and the tap/hold/macro logic have host checks:
```sh
cc -std=c99 -Itest/stub -ICore/Inc test/proto_test.c Core/Src/proto.c -o /tmp/proto_test && /tmp/proto_test
+cc -std=c99 -ICore/Inc test/keyact_test.c Core/Src/keyact.c -o /tmp/keyact_test && /tmp/keyact_test
```
### First flash: the CPU2 BLE stack