info_config.json 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. # This file maps keys between `config.h` and `info.json`. It is used by QMK
  2. # to correctly and consistently map back and forth between the two systems.
  3. {
  4. # Format:
  5. # <config.h key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
  6. # value_type: one of "array", "array.int", "bool", "int", "hex", "list", "mapping", "str", "raw"
  7. # to_json: Default `true`. Set to `false` to exclude this mapping from info.json
  8. # to_c: Default `true`. Set to `false` to exclude this mapping from config.h
  9. # warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
  10. # deprecated: Default `false`. Set to `true` to turn on warning when a value exists
  11. # invalid: Default `false`. Set to `true` to generate errors when a value exists
  12. # replace_with: use with a key marked deprecated or invalid to designate a replacement
  13. "AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "bool"},
  14. "BACKLIGHT_BREATHING": {"info_key": "backlight.breathing", "value_type": "bool"},
  15. "BREATHING_PERIOD": {"info_key": "backlight.breathing_period", "value_type": "int"},
  16. "BACKLIGHT_LEVELS": {"info_key": "backlight.levels", "value_type": "int"},
  17. "BACKLIGHT_ON_STATE": {"info_key": "backlight.on_state", "value_type": "int"},
  18. "BACKLIGHT_PIN": {"info_key": "backlight.pin"},
  19. "BOTH_SHIFTS_TURNS_ON_CAPS_WORD": {"info_key": "caps_word.both_shifts_turns_on", "value_type": "bool"},
  20. "CAPS_WORD_IDLE_TIMEOUT": {"info_key": "caps_word.idle_timeout", "value_type": "int"},
  21. "COMBO_COUNT": {"info_key": "combo.count", "value_type": "int"},
  22. "COMBO_TERM": {"info_key": "combo.term", "value_type": "int"},
  23. "DEBOUNCE": {"info_key": "debounce", "value_type": "int"},
  24. "DEVICE_VER": {"info_key": "usb.device_ver", "value_type": "hex"},
  25. # TODO: Replace ^^^ with vvv
  26. #"DEVICE_VER": {"info_key": "usb.device_version", "value_type": "bcd_version"},
  27. "DIODE_DIRECTION": {"info_key": "diode_direction"},
  28. "DOUBLE_TAP_SHIFT_TURNS_ON_CAPS_WORD": {"info_key": "caps_word.double_tap_shift_turns_on", "value_type": "bool"},
  29. "FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "bool"},
  30. "DYNAMIC_KEYMAP_EEPROM_MAX_ADDR": {"info_key": "dynamic_keymap.eeprom_max_addr", "value_type": "int"},
  31. "DYNAMIC_KEYMAP_LAYER_COUNT": {"info_key": "dynamic_keymap.layer_count", "value_type": "int"},
  32. "IGNORE_MOD_TAP_INTERRUPT": {"info_key": "tapping.ignore_mod_tap_interrupt", "value_type": "bool"},
  33. "IGNORE_MOD_TAP_INTERRUPT_PER_KEY": {"info_key": "tapping.ignore_mod_tap_interrupt_per_key", "value_type": "bool"},
  34. "LAYOUTS": {"info_key": "layout_aliases", "value_type": "mapping"},
  35. "LEADER_PER_KEY_TIMING": {"info_key": "leader_key.timing", "value_type": "bool"},
  36. "LEADER_KEY_STRICT_KEY_PROCESSING": {"info_key": "leader_key.strict_processing", "value_type": "bool"},
  37. "LEADER_TIMEOUT": {"info_key": "leader_key.timeout", "value_type": "int"},
  38. "LED_CAPS_LOCK_PIN": {"info_key": "indicators.caps_lock"},
  39. "LED_NUM_LOCK_PIN": {"info_key": "indicators.num_lock"},
  40. "LED_SCROLL_LOCK_PIN": {"info_key": "indicators.scroll_lock"},
  41. "LED_COMPOSE_PIN": {"info_key": "indicators.compose"},
  42. "LED_KANA_PIN": {"info_key": "indicators.kana"},
  43. "LED_PIN_ON_STATE": {"info_key": "indicators.on_state", "value_type": "int"},
  44. "MANUFACTURER": {"info_key": "manufacturer"},
  45. "MATRIX_HAS_GHOST": {"info_key": "matrix_pins.ghost", "value_type": "bool"},
  46. "MATRIX_IO_DELAY": {"info_key": "matrix_pins.io_delay", "value_type": "int"},
  47. "MOUSEKEY_DELAY": {"info_key": "mousekey.delay", "value_type": "int"},
  48. "MOUSEKEY_INTERVAL": {"info_key": "mousekey.interval", "value_type": "int"},
  49. "MOUSEKEY_MAX_SPEED": {"info_key": "mousekey.max_speed", "value_type": "int"},
  50. "MOUSEKEY_TIME_TO_MAX": {"info_key": "mousekey.time_to_max", "value_type": "int"},
  51. "MOUSEKEY_WHEEL_DELAY": {"info_key": "mousekey.wheel_delay", "value_type": "int"},
  52. "ONESHOT_TIMEOUT": {"info_key": "oneshot.timeout", "value_type": "int"},
  53. "ONESHOT_TAP_TOGGLE": {"info_key": "oneshot.tap_toggle", "value_type": "int"},
  54. "PERMISSIVE_HOLD": {"info_key": "tapping.permissive_hold", "value_type": "bool"},
  55. "PERMISSIVE_HOLD_PER_KEY": {"info_key": "tapping.permissive_hold_per_key", "value_type": "bool"},
  56. "RETRO_TAPPING": {"info_key": "tapping.retro", "value_type": "bool"},
  57. "RETRO_TAPPING_PER_KEY": {"info_key": "tapping.retro_per_key", "value_type": "bool"},
  58. "RGB_DI_PIN": {"info_key": "rgblight.pin"},
  59. "RGBLED_NUM": {"info_key": "rgblight.led_count", "value_type": "int"},
  60. "RGBLED_SPLIT": {"info_key": "rgblight.split_count", "value_type": "array.int"},
  61. "RGBLIGHT_EFFECT_ALTERNATING": {"info_key": "rgblight.animations.alternating", "value_type": "bool"},
  62. "RGBLIGHT_EFFECT_BREATHING": {"info_key": "rgblight.animations.breathing", "value_type": "bool"},
  63. "RGBLIGHT_EFFECT_CHRISTMAS": {"info_key": "rgblight.animations.christmas", "value_type": "bool"},
  64. "RGBLIGHT_EFFECT_KNIGHT": {"info_key": "rgblight.animations.knight", "value_type": "bool"},
  65. "RGBLIGHT_EFFECT_RAINBOW_MOOD": {"info_key": "rgblight.animations.rainbow_mood", "value_type": "bool"},
  66. "RGBLIGHT_EFFECT_RAINBOW_SWIRL": {"info_key": "rgblight.animations.rainbow_swirl", "value_type": "bool"},
  67. "RGBLIGHT_EFFECT_RGB_TEST": {"info_key": "rgblight.animations.rgb_test", "value_type": "bool"},
  68. "RGBLIGHT_EFFECT_SNAKE": {"info_key": "rgblight.animations.snake", "value_type": "bool"},
  69. "RGBLIGHT_EFFECT_STATIC_GRADIENT": {"info_key": "rgblight.animations.static_gradient", "value_type": "bool"},
  70. "RGBLIGHT_EFFECT_TWINKLE": {"info_key": "rgblight.animations.twinkle"},
  71. "RGBLIGHT_LAYER_BLINK": {"info_key": "rgblight.layers.blink", "value_type": "bool"},
  72. "RGBLIGHT_LAYERS": {"info_key": "rgblight.layers.enabled", "value_type": "bool"},
  73. "RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF": {"info_key": "rgblight.layers.override_rgb", "value_type": "bool"},
  74. "RGBLIGHT_LIMIT_VAL": {"info_key": "rgblight.max_brightness", "value_type": "int"},
  75. "RGBLIGHT_MAX_LAYERS": {"info_key": "rgblight.layers.max", "value_type": "int"},
  76. "RGBLIGHT_HUE_STEP": {"info_key": "rgblight.hue_steps", "value_type": "int"},
  77. "RGBLIGHT_SAT_STEP": {"info_key": "rgblight.saturation_steps", "value_type": "int"},
  78. "RGBLIGHT_VAL_STEP": {"info_key": "rgblight.brightness_steps", "value_type": "int"},
  79. "RGBLIGHT_SLEEP": {"info_key": "rgblight.sleep", "value_type": "bool"},
  80. "RGBLIGHT_SPLIT": {"info_key": "rgblight.split", "value_type": "bool"},
  81. "RGBW": {"info_key": "rgblight.rgbw", "value_type": "bool"},
  82. "PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false},
  83. "PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex"},
  84. "VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex"},
  85. "QMK_ESC_OUTPUT": {"info_key": "qmk_lufa_bootloader.esc_output"},
  86. "QMK_ESC_INPUT": {"info_key": "qmk_lufa_bootloader.esc_input"},
  87. "QMK_LED": {"info_key": "qmk_lufa_bootloader.led"},
  88. "QMK_SPEAKER": {"info_key": "qmk_lufa_bootloader.speaker"},
  89. "SECURE_UNLOCK_SEQUENCE": {"info_key": "secure.unlock_sequence", "value_type": "array.array.int", "to_json": false},
  90. "SECURE_UNLOCK_TIMEOUT": {"info_key": "secure.unlock_timeout", "value_type": "int"},
  91. "SECURE_IDLE_TIMEOUT": {"info_key": "secure.idle_timeout", "value_type": "int"},
  92. "SENDSTRING_BELL": {"info_key": "audio.macro_beep", "value_type": "bool"},
  93. "SPLIT_MODS_ENABLE": {"info_key": "split.transport.sync_modifiers", "value_type": "bool"},
  94. "SPLIT_TRANSPORT_MIRROR": {"info_key": "split.transport.sync_matrix_state", "value_type": "bool"},
  95. "SPLIT_USB_DETECT": {"info_key": "split.usb_detect.enabled", "value_type": "bool"},
  96. "SPLIT_USB_TIMEOUT": {"info_key": "split.usb_detect.timeout", "value_type": "int"},
  97. "SPLIT_USB_TIMEOUT_POLL": {"info_key": "split.usb_detect.polling_interval", "value_type": "int"},
  98. "SOFT_SERIAL_PIN": {"info_key": "split.soft_serial_pin"},
  99. "SOFT_SERIAL_SPEED": {"info_key": "split.soft_serial_speed"},
  100. "TAP_CODE_DELAY": {"info_key": "qmk.tap_keycode_delay", "value_type": "int"},
  101. "TAP_HOLD_CAPS_DELAY": {"info_key": "qmk.tap_capslock_delay", "value_type": "int"},
  102. "TAPPING_FORCE_HOLD": {"info_key": "tapping.force_hold", "value_type": "bool"},
  103. "TAPPING_FORCE_HOLD_PER_KEY": {"info_key": "tapping.force_hold_per_key", "value_type": "bool"},
  104. "TAPPING_TERM": {"info_key": "tapping.term", "value_type": "int"},
  105. "TAPPING_TERM_PER_KEY": {"info_key": "tapping.term_per_key", "value_type": "bool"},
  106. "TAPPING_TOGGLE": {"info_key": "tapping.toggle", "value_type": "int"},
  107. "USB_MAX_POWER_CONSUMPTION": {"info_key": "usb.max_power", "value_type": "int"},
  108. "USB_POLLING_INTERVAL_MS": {"info_key": "usb.polling_interval", "value_type": "int"},
  109. "USB_SUSPEND_WAKEUP_DELAY": {"info_key": "usb.suspend_wakeup_delay", "value_type": "int"},
  110. # Items we want flagged in lint
  111. "NO_ACTION_MACRO": {"info_key": "_invalid.no_action_macro", "invalid": true},
  112. "NO_ACTION_FUNCTION": {"info_key": "_invalid.no_action_function", "invalid": true},
  113. "DESCRIPTION": {"info_key": "_invalid.usb_description", "invalid": true},
  114. "DEBOUNCING_DELAY": {"info_key": "_invalid.debouncing_delay", "invalid": true, "replace_with": "DEBOUNCE"},
  115. "PREVENT_STUCK_MODIFIERS": {"info_key": "_invalid.prevent_stuck_mods", "invalid": true},
  116. "UNUSED_PINS": {"info_key": "_invalid.unused_pins", "deprecated": true},
  117. "RGBLIGHT_ANIMATIONS": {"info_key": "rgblight.animations.all", "value_type": "bool", "deprecated": true},
  118. "QMK_KEYS_PER_SCAN": {"info_key": "qmk.keys_per_scan", "value_type": "int", "deprecated": true}
  119. }