forked from mirrors/qmk_firmware
7060cb7b26
* Refactor steno into STENO_ENABLE_[ALL|GEMINI|BOLT]
* Update stenography documentation
* STENO_ENABLE_TXBOLT → STENO_ENABLE_BOLT
TXBOLT is a better name but BOLT is more consistent with the
pre-existing TX Bolt related constants, which all drop the "TX " prefix
* Comments
* STENO_ENABLE_[GEMINI|BOLT|ALL] → STENO_PROTOCOL = [geminipr|txbolt|all]
* Add note on lacking V-USB support
* Clear chord at the end of the switch(mode){send_steno_chord} block
* Return true if NOEVENT
* update_chord_xxx → add_xxx_key_to_chord
* Enable the defines for all the protocols if STENO_PROTOCOL = all
* Mention how to use `steno_set_mode`
* Set the default steno protocol to "all"
This is done so that existing keymaps invoking `steno_set_mode` don't
all suddenly break
* Add data driver equivalents for stenography feature
* Document format of serial steno packets
(Thanks dnaq)
* Add missing comma
38 lines
2.5 KiB
JSON
38 lines
2.5 KiB
JSON
# This file maps keys between `rules.mk` and `info.json`. It is used by QMK
|
|
# to correctly and consistently map back and forth between the two systems.
|
|
{
|
|
# Format:
|
|
# <rules.mk key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
|
|
# value_type: one of "array", "array.int", "bool", "int", "list", "hex", "mapping", "str", "raw"
|
|
# to_json: Default `true`. Set to `false` to exclude this mapping from info.json
|
|
# to_c: Default `true`. Set to `false` to exclude this mapping from rules.mk
|
|
# warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
|
|
# deprecated: Default `false`. Set to `true` to turn on warning when a value exists
|
|
# invalid: Default `false`. Set to `true` to generate errors when a value exists
|
|
"BOARD": {"info_key": "board"},
|
|
"BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false},
|
|
"BLUETOOTH": {"info_key": "bluetooth.driver"},
|
|
"CAPS_WORD_ENABLE": {"info_key": "caps_word.enabled", "value_type": "bool"},
|
|
"ENCODER_ENABLE": {"info_key": "encoder.enabled", "value_type": "bool"},
|
|
"FIRMWARE_FORMAT": {"info_key": "build.firmware_format"},
|
|
"KEYBOARD_SHARED_EP": {"info_key": "usb.shared_endpoint.keyboard", "value_type": "bool"},
|
|
"MOUSE_SHARED_EP": {"info_key": "usb.shared_endpoint.mouse", "value_type": "bool"},
|
|
"LAYOUTS": {"info_key": "community_layouts", "value_type": "list"},
|
|
"LED_MATRIX_DRIVER": {"info_key": "led_matrix.driver"},
|
|
"LTO_ENABLE": {"info_key": "build.lto", "value_type": "bool"},
|
|
"MCU": {"info_key": "processor", "warn_duplicate": false},
|
|
"MOUSEKEY_ENABLE": {"info_key": "mouse_key.enabled", "value_type": "bool"},
|
|
"NO_USB_STARTUP_CHECK": {"info_key": "usb.no_startup_check", "value_type": "bool"},
|
|
"PIN_COMPATIBLE": {"info_key": "pin_compatible"},
|
|
"SECURE_ENABLE": {"info_key": "secure.enabled", "value_type": "bool"},
|
|
"SPLIT_KEYBOARD": {"info_key": "split.enabled", "value_type": "bool"},
|
|
"SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "to_c": false},
|
|
"WAIT_FOR_USB": {"info_key": "usb.wait_for", "value_type": "bool"},
|
|
"STENO_ENABLE": {"info_key": "stenography.enabled", "value_type": "bool"},
|
|
"STENO_PROTOCOL": {"info_key": "stenography.protocol"},
|
|
|
|
# Items we want flagged in lint
|
|
"CTPC": {"info_key": "_deprecated.ctpc", "deprecated": true},
|
|
"CONVERT_TO_PROTON_C": {"info_key": "_deprecated.ctpc", "deprecated": true},
|
|
"VIAL_ENABLE": {"info_key": "_invalid.vial", "invalid": true},
|
|
}
|