2022-11-08 01:05:08 +00:00
|
|
|
// This file maps keys between `config.h` and `info.json`. It is used by QMK
|
|
|
|
|
// to correctly and consistently map back and forth between the two systems.
|
2021-01-31 20:46:00 +00:00
|
|
|
{
|
2022-11-08 01:05:08 +00:00
|
|
|
// Format:
|
|
|
|
|
// <config.h 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", "hex", "list", "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 config.h
|
|
|
|
|
// 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
|
|
|
|
|
// replace_with: use with a key marked deprecated or invalid to designate a replacement
|
2023-03-19 21:12:19 +00:00
|
|
|
"APA102_DI_PIN": {"info_key": "apa102.data_pin"},
|
|
|
|
|
"APA102_CI_PIN": {"info_key": "apa102.clock_pin"},
|
|
|
|
|
"APA102_DEFAULT_BRIGHTNESS": {"info_key": "apa102.default_brightness", "value_type": "int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "bool"},
|
|
|
|
|
"BACKLIGHT_BREATHING": {"info_key": "backlight.breathing", "value_type": "bool"},
|
|
|
|
|
"BREATHING_PERIOD": {"info_key": "backlight.breathing_period", "value_type": "int"},
|
2023-02-25 21:37:57 +00:00
|
|
|
"BACKLIGHT_CAPS_LOCK": {"info_key": "backlight.as_caps_lock", "value_type": "bool"},
|
2022-10-07 05:58:13 +00:00
|
|
|
"BACKLIGHT_LEVELS": {"info_key": "backlight.levels", "value_type": "int"},
|
2022-11-23 18:48:22 +00:00
|
|
|
"BACKLIGHT_LIMIT_VAL": {"info_key": "backlight.max_brightness", "value_type": "int"},
|
2022-06-14 11:30:31 +00:00
|
|
|
"BACKLIGHT_ON_STATE": {"info_key": "backlight.on_state", "value_type": "int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"BACKLIGHT_PIN": {"info_key": "backlight.pin"},
|
2022-11-23 18:48:22 +00:00
|
|
|
"BACKLIGHT_PINS": {"info_key": "backlight.pins", "value_type": "array"},
|
2022-11-30 04:27:21 +00:00
|
|
|
"BOOTMAGIC_LITE_ROW": {"info_key": "bootmagic.matrix.0", "value_type": "int"},
|
|
|
|
|
"BOOTMAGIC_LITE_COLUMN": {"info_key": "bootmagic.matrix.1", "value_type": "int"},
|
|
|
|
|
"BOOTMAGIC_LITE_ROW_RIGHT": {"info_key": "split.bootmagic.matrix.0", "value_type": "int"},
|
|
|
|
|
"BOOTMAGIC_LITE_COLUMN_RIGHT": {"info_key": "split.bootmagic.matrix.1", "value_type": "int"},
|
2022-05-14 06:00:32 +00:00
|
|
|
"BOTH_SHIFTS_TURNS_ON_CAPS_WORD": {"info_key": "caps_word.both_shifts_turns_on", "value_type": "bool"},
|
|
|
|
|
"CAPS_WORD_IDLE_TIMEOUT": {"info_key": "caps_word.idle_timeout", "value_type": "int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"COMBO_COUNT": {"info_key": "combo.count", "value_type": "int"},
|
|
|
|
|
"COMBO_TERM": {"info_key": "combo.term", "value_type": "int"},
|
|
|
|
|
"DEBOUNCE": {"info_key": "debounce", "value_type": "int"},
|
2021-01-31 20:46:00 +00:00
|
|
|
"DIODE_DIRECTION": {"info_key": "diode_direction"},
|
2022-05-14 06:00:32 +00:00
|
|
|
"DOUBLE_TAP_SHIFT_TURNS_ON_CAPS_WORD": {"info_key": "caps_word.double_tap_shift_turns_on", "value_type": "bool"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "bool"},
|
2021-08-18 20:52:41 +00:00
|
|
|
"DYNAMIC_KEYMAP_EEPROM_MAX_ADDR": {"info_key": "dynamic_keymap.eeprom_max_addr", "value_type": "int"},
|
|
|
|
|
"DYNAMIC_KEYMAP_LAYER_COUNT": {"info_key": "dynamic_keymap.layer_count", "value_type": "int"},
|
2022-10-22 22:51:24 +00:00
|
|
|
"HOLD_ON_OTHER_KEY_PRESS": {"info_key": "tapping.hold_on_other_key_press", "value_type": "bool"},
|
|
|
|
|
"HOLD_ON_OTHER_KEY_PRESS_PER_KEY": {"info_key": "tapping.hold_on_other_key_press_per_key", "value_type": "bool"},
|
2021-01-31 20:46:00 +00:00
|
|
|
"LAYOUTS": {"info_key": "layout_aliases", "value_type": "mapping"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"LEADER_PER_KEY_TIMING": {"info_key": "leader_key.timing", "value_type": "bool"},
|
|
|
|
|
"LEADER_KEY_STRICT_KEY_PROCESSING": {"info_key": "leader_key.strict_processing", "value_type": "bool"},
|
|
|
|
|
"LEADER_TIMEOUT": {"info_key": "leader_key.timeout", "value_type": "int"},
|
2021-01-31 20:46:00 +00:00
|
|
|
"LED_CAPS_LOCK_PIN": {"info_key": "indicators.caps_lock"},
|
|
|
|
|
"LED_NUM_LOCK_PIN": {"info_key": "indicators.num_lock"},
|
|
|
|
|
"LED_SCROLL_LOCK_PIN": {"info_key": "indicators.scroll_lock"},
|
2022-06-14 11:30:31 +00:00
|
|
|
"LED_COMPOSE_PIN": {"info_key": "indicators.compose"},
|
|
|
|
|
"LED_KANA_PIN": {"info_key": "indicators.kana"},
|
|
|
|
|
"LED_PIN_ON_STATE": {"info_key": "indicators.on_state", "value_type": "int"},
|
2022-09-20 23:45:07 +00:00
|
|
|
"LED_MATRIX_CENTER": {"info_key": "led_matrix.center_point", "value_type": "array.int"},
|
2022-09-18 19:32:47 +00:00
|
|
|
"LED_MATRIX_MAXIMUM_BRIGHTNESS": {"info_key": "led_matrix.max_brightness", "value_type": "int"},
|
2022-09-18 21:57:50 +00:00
|
|
|
"LED_MATRIX_SPLIT": {"info_key": "led_matrix.split_count", "value_type": "array.int"},
|
2022-09-26 04:40:15 +00:00
|
|
|
"LED_MATRIX_TIMEOUT": {"info_key": "led_matrix.timeout", "value_type": "int"},
|
2022-09-19 18:36:48 +00:00
|
|
|
"LED_MATRIX_HUE_STEP": {"info_key": "led_matrix.hue_steps", "value_type": "int"},
|
|
|
|
|
"LED_MATRIX_SAT_STEP": {"info_key": "led_matrix.sat_steps", "value_type": "int"},
|
|
|
|
|
"LED_MATRIX_VAL_STEP": {"info_key": "led_matrix.val_steps", "value_type": "int"},
|
|
|
|
|
"LED_MATRIX_SPD_STEP": {"info_key": "led_matrix.speed_steps", "value_type": "int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"MATRIX_HAS_GHOST": {"info_key": "matrix_pins.ghost", "value_type": "bool"},
|
2022-12-08 16:09:01 +00:00
|
|
|
"MATRIX_INPUT_PRESSED_STATE": {"info_key": "matrix_pins.input_pressed_state", "value_type": "int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"MATRIX_IO_DELAY": {"info_key": "matrix_pins.io_delay", "value_type": "int"},
|
|
|
|
|
"MOUSEKEY_DELAY": {"info_key": "mousekey.delay", "value_type": "int"},
|
|
|
|
|
"MOUSEKEY_INTERVAL": {"info_key": "mousekey.interval", "value_type": "int"},
|
|
|
|
|
"MOUSEKEY_MAX_SPEED": {"info_key": "mousekey.max_speed", "value_type": "int"},
|
|
|
|
|
"MOUSEKEY_TIME_TO_MAX": {"info_key": "mousekey.time_to_max", "value_type": "int"},
|
|
|
|
|
"MOUSEKEY_WHEEL_DELAY": {"info_key": "mousekey.wheel_delay", "value_type": "int"},
|
|
|
|
|
"ONESHOT_TIMEOUT": {"info_key": "oneshot.timeout", "value_type": "int"},
|
|
|
|
|
"ONESHOT_TAP_TOGGLE": {"info_key": "oneshot.tap_toggle", "value_type": "int"},
|
|
|
|
|
"PERMISSIVE_HOLD": {"info_key": "tapping.permissive_hold", "value_type": "bool"},
|
|
|
|
|
"PERMISSIVE_HOLD_PER_KEY": {"info_key": "tapping.permissive_hold_per_key", "value_type": "bool"},
|
2022-08-31 07:16:07 +00:00
|
|
|
"PS2_CLOCK_PIN": {"info_key": "ps2.clock_pin"},
|
|
|
|
|
"PS2_DATA_PIN": {"info_key": "ps2.data_pin"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"RETRO_TAPPING": {"info_key": "tapping.retro", "value_type": "bool"},
|
|
|
|
|
"RETRO_TAPPING_PER_KEY": {"info_key": "tapping.retro_per_key", "value_type": "bool"},
|
2021-01-31 20:46:00 +00:00
|
|
|
"RGB_DI_PIN": {"info_key": "rgblight.pin"},
|
|
|
|
|
"RGBLED_NUM": {"info_key": "rgblight.led_count", "value_type": "int"},
|
|
|
|
|
"RGBLED_SPLIT": {"info_key": "rgblight.split_count", "value_type": "array.int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"RGBLIGHT_LAYER_BLINK": {"info_key": "rgblight.layers.blink", "value_type": "bool"},
|
|
|
|
|
"RGBLIGHT_LAYERS": {"info_key": "rgblight.layers.enabled", "value_type": "bool"},
|
|
|
|
|
"RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF": {"info_key": "rgblight.layers.override_rgb", "value_type": "bool"},
|
2021-01-31 20:46:00 +00:00
|
|
|
"RGBLIGHT_LIMIT_VAL": {"info_key": "rgblight.max_brightness", "value_type": "int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"RGBLIGHT_MAX_LAYERS": {"info_key": "rgblight.layers.max", "value_type": "int"},
|
2021-01-31 20:46:00 +00:00
|
|
|
"RGBLIGHT_HUE_STEP": {"info_key": "rgblight.hue_steps", "value_type": "int"},
|
|
|
|
|
"RGBLIGHT_SAT_STEP": {"info_key": "rgblight.saturation_steps", "value_type": "int"},
|
|
|
|
|
"RGBLIGHT_VAL_STEP": {"info_key": "rgblight.brightness_steps", "value_type": "int"},
|
|
|
|
|
"RGBLIGHT_SLEEP": {"info_key": "rgblight.sleep", "value_type": "bool"},
|
|
|
|
|
"RGBLIGHT_SPLIT": {"info_key": "rgblight.split", "value_type": "bool"},
|
2022-09-20 23:45:07 +00:00
|
|
|
"RGB_MATRIX_CENTER": {"info_key": "rgb_matrix.center_point", "value_type": "array.int"},
|
2022-09-18 19:32:47 +00:00
|
|
|
"RGB_MATRIX_MAXIMUM_BRIGHTNESS": {"info_key": "rgb_matrix.max_brightness", "value_type": "int"},
|
2022-09-18 21:57:50 +00:00
|
|
|
"RGB_MATRIX_SPLIT": {"info_key": "rgb_matrix.split_count", "value_type": "array.int"},
|
2022-09-26 04:40:15 +00:00
|
|
|
"RGB_MATRIX_TIMEOUT": {"info_key": "rgb_matrix.timeout", "value_type": "int"},
|
2022-09-19 18:36:48 +00:00
|
|
|
"RGB_MATRIX_HUE_STEP": {"info_key": "rgb_matrix.hue_steps", "value_type": "int"},
|
|
|
|
|
"RGB_MATRIX_SAT_STEP": {"info_key": "rgb_matrix.sat_steps", "value_type": "int"},
|
|
|
|
|
"RGB_MATRIX_VAL_STEP": {"info_key": "rgb_matrix.val_steps", "value_type": "int"},
|
|
|
|
|
"RGB_MATRIX_SPD_STEP": {"info_key": "rgb_matrix.speed_steps", "value_type": "int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"RGBW": {"info_key": "rgblight.rgbw", "value_type": "bool"},
|
2021-02-28 21:25:09 +00:00
|
|
|
"QMK_ESC_OUTPUT": {"info_key": "qmk_lufa_bootloader.esc_output"},
|
|
|
|
|
"QMK_ESC_INPUT": {"info_key": "qmk_lufa_bootloader.esc_input"},
|
|
|
|
|
"QMK_LED": {"info_key": "qmk_lufa_bootloader.led"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"QMK_SPEAKER": {"info_key": "qmk_lufa_bootloader.speaker"},
|
2022-04-16 18:13:05 +00:00
|
|
|
"SECURE_UNLOCK_SEQUENCE": {"info_key": "secure.unlock_sequence", "value_type": "array.array.int", "to_json": false},
|
|
|
|
|
"SECURE_UNLOCK_TIMEOUT": {"info_key": "secure.unlock_timeout", "value_type": "int"},
|
|
|
|
|
"SECURE_IDLE_TIMEOUT": {"info_key": "secure.idle_timeout", "value_type": "int"},
|
2021-11-22 19:11:35 +00:00
|
|
|
"SENDSTRING_BELL": {"info_key": "audio.macro_beep", "value_type": "bool"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"SPLIT_MODS_ENABLE": {"info_key": "split.transport.sync_modifiers", "value_type": "bool"},
|
|
|
|
|
"SPLIT_TRANSPORT_MIRROR": {"info_key": "split.transport.sync_matrix_state", "value_type": "bool"},
|
|
|
|
|
"SPLIT_USB_DETECT": {"info_key": "split.usb_detect.enabled", "value_type": "bool"},
|
|
|
|
|
"SPLIT_USB_TIMEOUT": {"info_key": "split.usb_detect.timeout", "value_type": "int"},
|
|
|
|
|
"SPLIT_USB_TIMEOUT_POLL": {"info_key": "split.usb_detect.polling_interval", "value_type": "int"},
|
2022-10-06 09:52:42 +00:00
|
|
|
"SPLIT_WATCHDOG_ENABLE": {"info_key": "split.transport.watchdog", "value_type": "bool"},
|
|
|
|
|
"SPLIT_WATCHDOG_TIMEOUT": {"info_key": "split.transport.watchdog_timeout", "value_type": "int"},
|
2021-08-16 22:33:30 +00:00
|
|
|
"SOFT_SERIAL_PIN": {"info_key": "split.soft_serial_pin"},
|
|
|
|
|
"SOFT_SERIAL_SPEED": {"info_key": "split.soft_serial_speed"},
|
|
|
|
|
"TAP_CODE_DELAY": {"info_key": "qmk.tap_keycode_delay", "value_type": "int"},
|
|
|
|
|
"TAP_HOLD_CAPS_DELAY": {"info_key": "qmk.tap_capslock_delay", "value_type": "int"},
|
|
|
|
|
"TAPPING_TERM": {"info_key": "tapping.term", "value_type": "int"},
|
|
|
|
|
"TAPPING_TERM_PER_KEY": {"info_key": "tapping.term_per_key", "value_type": "bool"},
|
|
|
|
|
"TAPPING_TOGGLE": {"info_key": "tapping.toggle", "value_type": "int"},
|
|
|
|
|
"USB_MAX_POWER_CONSUMPTION": {"info_key": "usb.max_power", "value_type": "int"},
|
|
|
|
|
"USB_POLLING_INTERVAL_MS": {"info_key": "usb.polling_interval", "value_type": "int"},
|
|
|
|
|
"USB_SUSPEND_WAKEUP_DELAY": {"info_key": "usb.suspend_wakeup_delay", "value_type": "int"},
|
2023-03-30 01:21:02 +00:00
|
|
|
"WS2812_I2C_ADDRESS": {"info_key": "ws2812.i2c_address", "value_type": "hex"},
|
|
|
|
|
"WS2812_I2C_TIMEOUT": {"info_key": "ws2812.i2c_timeout", "value_type": "int"},
|
2022-06-09 20:02:16 +00:00
|
|
|
|
2022-11-08 01:05:08 +00:00
|
|
|
// Items we want flagged in lint
|
2022-06-09 20:02:16 +00:00
|
|
|
"NO_ACTION_MACRO": {"info_key": "_invalid.no_action_macro", "invalid": true},
|
|
|
|
|
"NO_ACTION_FUNCTION": {"info_key": "_invalid.no_action_function", "invalid": true},
|
|
|
|
|
"DESCRIPTION": {"info_key": "_invalid.usb_description", "invalid": true},
|
2022-09-03 18:44:42 +00:00
|
|
|
"DEBOUNCING_DELAY": {"info_key": "_invalid.debouncing_delay", "invalid": true, "replace_with": "DEBOUNCE"},
|
2022-06-09 20:02:16 +00:00
|
|
|
"PREVENT_STUCK_MODIFIERS": {"info_key": "_invalid.prevent_stuck_mods", "invalid": true},
|
2022-08-06 13:23:35 +00:00
|
|
|
"UNUSED_PINS": {"info_key": "_invalid.unused_pins", "deprecated": true},
|
2022-12-01 21:06:45 +00:00
|
|
|
"RGBLIGHT_ANIMATIONS": {"info_key": "_invalid.rgblight.animations.all", "value_type": "bool", "invalid": true},
|
2022-11-27 20:33:55 +00:00
|
|
|
"QMK_KEYS_PER_SCAN": {"info_key": "qmk.keys_per_scan", "value_type": "int", "deprecated": true},
|
2022-12-12 15:52:22 +00:00
|
|
|
"TAPPING_FORCE_HOLD": {"info_key": "tapping.force_hold", "value_type": "bool", "deprecated": true},
|
|
|
|
|
"TAPPING_FORCE_HOLD_PER_KEY": {"info_key": "tapping.force_hold_per_key", "value_type": "bool", "deprecated": true},
|
2022-12-13 11:20:07 +00:00
|
|
|
"IGNORE_MOD_TAP_INTERRUPT": {"info_key": "_deprecated.ignore_mod_tap_interrupt", "value_type": "bool", "deprecated": true},
|
|
|
|
|
"IGNORE_MOD_TAP_INTERRUPT_PER_KEY": {"info_key": "_invalid.ignore_mod_tap_interrupt_per_key", "invalid": true}
|
2022-11-27 20:33:55 +00:00
|
|
|
|
|
|
|
|
// USB params, need to mark as failure when specified in config.h, rather than deprecated
|
|
|
|
|
"PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.pid` in info.json"},
|
|
|
|
|
"VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.vid` in info.json"},
|
|
|
|
|
"PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false, "value_type": "str", "deprecated": true, "replace_with": "`keyboard_name` in info.json"},
|
|
|
|
|
"MANUFACTURER": {"info_key": "manufacturer", "value_type": "str", "deprecated": true, "replace_with": "`manufacturer` in info.json"},
|
|
|
|
|
"DEVICE_VER": {"info_key": "usb.device_version", "value_type": "bcd_version", "deprecated": true, "replace_with": "`usb.device_version` in info.json"}
|
2021-01-31 20:46:00 +00:00
|
|
|
}
|
