keyboard.jsonschema 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896
  1. {
  2. "$schema": "https://json-schema.org/draft/2020-12/schema#",
  3. "$id": "qmk.keyboard.v1",
  4. "title": "Keyboard Information",
  5. "definitions": {
  6. "encoder_config": {
  7. "type": "object",
  8. "properties": {
  9. "rotary": {
  10. "type": "array",
  11. "items": {
  12. "type": "object",
  13. "additionalProperties": false,
  14. "required": ["pin_a", "pin_b"],
  15. "properties": {
  16. "pin_a": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  17. "pin_b": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  18. "resolution": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  19. }
  20. }
  21. }
  22. }
  23. },
  24. "dip_switch_config": {
  25. "type": "object",
  26. "properties": {
  27. "pins": {
  28. "$ref": "qmk.definitions.v1#/mcu_pin_array"
  29. }
  30. }
  31. },
  32. },
  33. "type": "object",
  34. "not": { "required": [ "vendorId", "productId" ] }, // reject via keys...
  35. "properties": {
  36. "keyboard_name": {"$ref": "qmk.definitions.v1#/text_identifier"},
  37. "keyboard_folder": {"$ref": "qmk.definitions.v1#/keyboard"},
  38. "maintainer": {"$ref": "qmk.definitions.v1#/text_identifier"},
  39. "manufacturer": {"$ref": "qmk.definitions.v1#/text_identifier"},
  40. "url": {
  41. "type": "string",
  42. "format": "uri"
  43. },
  44. "development_board": {
  45. "type": "string",
  46. "enum": ["promicro", "elite_c", "elite_pi", "proton_c", "kb2040", "promicro_rp2040", "blok", "michi", "bit_c_pro", "stemcell", "bluepill", "blackpill_f401", "blackpill_f411", "bonsai_c4", "helios", "liatris", "imera"]
  47. },
  48. "pin_compatible": {
  49. "type": "string",
  50. "enum": ["promicro", "elite_c"]
  51. },
  52. "processor": {
  53. "type": "string",
  54. "enum": [
  55. "cortex-m0",
  56. "cortex-m0plus",
  57. "cortex-m3",
  58. "cortex-m4",
  59. "cortex-m7",
  60. "cortex-m23",
  61. "cortex-m33",
  62. "cortex-m35p",
  63. "cortex-m55",
  64. "cortex-m85",
  65. "MKL26Z64",
  66. "MK20DX128",
  67. "MK20DX256",
  68. "MK64FX512",
  69. "MK66FX1M0",
  70. "RP2040",
  71. "STM32F042",
  72. "STM32F072",
  73. "STM32F103",
  74. "STM32F303",
  75. "STM32F401",
  76. "STM32F405",
  77. "STM32F407",
  78. "STM32F411",
  79. "STM32F446",
  80. "STM32G431",
  81. "STM32G474",
  82. "STM32H723",
  83. "STM32H733",
  84. "STM32L412",
  85. "STM32L422",
  86. "STM32L432",
  87. "STM32L433",
  88. "STM32L442",
  89. "STM32L443",
  90. "GD32VF103",
  91. "WB32F3G71",
  92. "WB32FQ95",
  93. "atmega16u2",
  94. "atmega32u2",
  95. "atmega16u4",
  96. "atmega32u4",
  97. "at90usb162",
  98. "at90usb646",
  99. "at90usb647",
  100. "at90usb1286",
  101. "at90usb1287",
  102. "atmega32a",
  103. "atmega328p",
  104. "atmega328",
  105. "attiny85",
  106. "unknown"
  107. ]
  108. },
  109. "apa102": {
  110. "type": "object",
  111. "additionalProperties": false,
  112. "properties": {
  113. "data_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  114. "clock_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  115. "default_brightness": {
  116. "type": "integer",
  117. "minimum": 0,
  118. "maximum": 31
  119. }
  120. }
  121. },
  122. "audio": {
  123. "type": "object",
  124. "additionalProperties": false,
  125. "properties": {
  126. "default": {
  127. "type": "object",
  128. "additionalProperties": false,
  129. "properties": {
  130. "on": {"type": "boolean"},
  131. "clicky": {"type": "boolean"}
  132. }
  133. },
  134. "macro_beep": {"type": "boolean"},
  135. "pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
  136. "voices": {"type": "boolean"}
  137. }
  138. },
  139. "backlight": {
  140. "type": "object",
  141. "additionalProperties": false,
  142. "properties": {
  143. "driver": {
  144. "type": "string",
  145. "enum": ["pwm", "software", "timer", "custom"]
  146. },
  147. "default": {
  148. "type": "object",
  149. "additionalProperties": false,
  150. "properties": {
  151. "on": {"type": "boolean"},
  152. "breathing": {"type": "boolean"},
  153. "brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  154. }
  155. },
  156. "breathing": {"type": "boolean"},
  157. "breathing_period": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  158. "levels": {
  159. "type": "integer",
  160. "minimum": 1,
  161. "maximum": 31
  162. },
  163. "max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  164. "pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  165. "pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
  166. "on_state": {"$ref": "qmk.definitions.v1#/bit"},
  167. "as_caps_lock": {"type": "boolean"}
  168. }
  169. },
  170. "bluetooth": {
  171. "type": "object",
  172. "additionalProperties": false,
  173. "properties": {
  174. "driver": {
  175. "type": "string",
  176. "enum": ["bluefruit_le", "custom", "rn42"]
  177. }
  178. }
  179. },
  180. "bootmagic":{
  181. "type": "object",
  182. "additionalProperties": false,
  183. "properties": {
  184. "enabled": {"type": "boolean"},
  185. "matrix": {
  186. "type": "array",
  187. "minItems": 2,
  188. "maxItems": 2,
  189. "items": {
  190. "type": "integer",
  191. "minimum": 0
  192. }
  193. }
  194. }
  195. },
  196. "board": {
  197. "type": "string",
  198. "minLength": 2,
  199. "pattern": "^[a-zA-Z_][0-9a-zA-Z_]*$"
  200. },
  201. "bootloader": {
  202. "type": "string",
  203. "enum": [
  204. "apm32-dfu",
  205. "atmel-dfu",
  206. "bootloadhid",
  207. "caterina",
  208. "custom",
  209. "gd32v-dfu",
  210. "halfkay",
  211. "kiibohd",
  212. "lufa-dfu",
  213. "lufa-ms",
  214. "md-boot",
  215. "qmk-dfu",
  216. "qmk-hid",
  217. "rp2040",
  218. "stm32-dfu",
  219. "stm32duino",
  220. "tinyuf2",
  221. "uf2boot",
  222. "unknown",
  223. "usbasploader",
  224. "wb32-dfu"
  225. ]
  226. },
  227. "bootloader_instructions": {
  228. "type": "string",
  229. "description": "Instructions for putting the keyboard into a mode that allows for firmware flashing."
  230. },
  231. "build": {
  232. "type": "object",
  233. "additionalProperties": false,
  234. "properties": {
  235. "debounce_type": {
  236. "type": "string",
  237. "enum": ["asym_eager_defer_pk", "custom", "sym_defer_g", "sym_defer_pk", "sym_defer_pr", "sym_eager_pk", "sym_eager_pr"]
  238. },
  239. "firmware_format": {
  240. "type": "string",
  241. "enum": ["bin", "hex", "uf2"]
  242. },
  243. "lto": {"type": "boolean"}
  244. }
  245. },
  246. "diode_direction": {
  247. "type": "string",
  248. "enum": ["COL2ROW", "ROW2COL"]
  249. },
  250. "debounce": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  251. "caps_word": {
  252. "type": "object",
  253. "additionalProperties": false,
  254. "properties": {
  255. "enabled": {"type": "boolean"},
  256. "both_shifts_turns_on": {"type": "boolean"},
  257. "double_tap_shift_turns_on": {"type": "boolean"},
  258. "idle_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  259. "invert_on_shift": {"type": "boolean"}
  260. }
  261. },
  262. "combo": {
  263. "type": "object",
  264. "properties": {
  265. "count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  266. "term": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  267. }
  268. },
  269. "community_layouts": {
  270. "type": "array",
  271. "items": {"$ref": "qmk.definitions.v1#/filename"}
  272. },
  273. "dip_switch": {
  274. "$ref": "#/definitions/dip_switch_config",
  275. "properties": {
  276. "enabled": {"type": "boolean"},
  277. "matrix_grid": {
  278. "type": "array",
  279. "minItems": 1,
  280. "items": {
  281. "type": "array",
  282. "minItems": 2,
  283. "maxItems": 2,
  284. "items": {
  285. "type": "integer",
  286. "minimum": 0
  287. }
  288. }
  289. }
  290. }
  291. },
  292. "eeprom": {
  293. "properties": {
  294. "driver": {"type": "string"},
  295. "wear_leveling": {
  296. "type": "object",
  297. "additionalProperties": false,
  298. "properties": {
  299. "driver": {
  300. "type": "string",
  301. "enum": ["custom", "embedded_flash", "legacy", "rp2040_flash", "spi_flash"]
  302. },
  303. "backing_size": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  304. "logical_size": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  305. }
  306. }
  307. }
  308. },
  309. "encoder": {
  310. "$ref": "#/definitions/encoder_config",
  311. "properties": {
  312. "enabled": {"type": "boolean"}
  313. }
  314. },
  315. "features": {
  316. "$ref": "qmk.definitions.v1#/boolean_array",
  317. "propertyNames": { "$ref": "qmk.definitions.v1#/snake_case" }
  318. },
  319. "indicators": {
  320. "type": "object",
  321. "properties": {
  322. "caps_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  323. "num_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  324. "scroll_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  325. "compose": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  326. "kana": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  327. "on_state": {"$ref": "qmk.definitions.v1#/bit"}
  328. }
  329. },
  330. "keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
  331. "layout_aliases": {
  332. "type": "object",
  333. "additionalProperties": {"$ref": "qmk.definitions.v1#/layout_macro"}
  334. },
  335. "layouts": {
  336. "type": "object",
  337. "propertyNames": {"$ref": "qmk.definitions.v1#/layout_macro"},
  338. "additionalProperties": {
  339. "type": "object",
  340. "additionalProperties": false,
  341. "properties": {
  342. "filename": {
  343. "type": "string"
  344. },
  345. "c_macro": {
  346. "type": "boolean"
  347. },
  348. "json_layout": {
  349. "type": "boolean"
  350. },
  351. "layout": {
  352. "type": "array",
  353. "items": {
  354. "type": "object",
  355. "additionalProperties": false,
  356. "required": ["x", "y"],
  357. "properties": {
  358. "encoder": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  359. "label": {
  360. "type": "string",
  361. "pattern": "^[^\\n]*$"
  362. },
  363. "matrix": {
  364. "type": "array",
  365. "minItems": 2,
  366. "maxItems": 2,
  367. "items": {
  368. "type": "integer",
  369. "minimum": 0
  370. }
  371. },
  372. "r": {"$ref": "qmk.definitions.v1#/signed_decimal"},
  373. "rx": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
  374. "ry": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
  375. "h": {"$ref": "qmk.definitions.v1#/key_unit"},
  376. "w": {"$ref": "qmk.definitions.v1#/key_unit"},
  377. "x": {"$ref": "qmk.definitions.v1#/key_unit"},
  378. "y": {"$ref": "qmk.definitions.v1#/key_unit"}
  379. }
  380. }
  381. }
  382. }
  383. }
  384. },
  385. "leader_key": {
  386. "type": "object",
  387. "properties": {
  388. "timing": {"type": "boolean"},
  389. "strict_processing": {"type": "boolean"},
  390. "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  391. }
  392. },
  393. "matrix_pins": {
  394. "type": "object",
  395. "additionalProperties": false,
  396. "properties": {
  397. "custom": {"type": "boolean"},
  398. "custom_lite": {"type": "boolean"},
  399. "ghost": {"type": "boolean"},
  400. "input_pressed_state": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  401. "io_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  402. "direct": {
  403. "type": "array",
  404. "items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
  405. },
  406. "cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
  407. "rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
  408. }
  409. },
  410. "mouse_key": {
  411. "type": "object",
  412. "properties": {
  413. "enabled": {"type": "boolean"},
  414. "delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  415. "interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  416. "max_speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  417. "time_to_max": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  418. "wheel_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  419. }
  420. },
  421. "oneshot": {
  422. "type": "object",
  423. "properties": {
  424. "tap_toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  425. "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  426. }
  427. },
  428. "led_matrix": {
  429. "type": "object",
  430. "properties": {
  431. "animations": {
  432. "type": "object",
  433. "propertyNames": { "$ref": "qmk.definitions.v1#/snake_case" }
  434. "additionalProperties": {
  435. "type": "boolean"
  436. }
  437. },
  438. "default": {
  439. "type": "object",
  440. "additionalProperties": false,
  441. "properties": {
  442. "on": {"type": "boolean"},
  443. "animation": {"type": "string"},
  444. "val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  445. "speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  446. }
  447. },
  448. "driver": {"type": "string"},
  449. "center_point": {
  450. "type": "array",
  451. "minItems": 2,
  452. "maxItems": 2,
  453. "items": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  454. },
  455. "max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  456. "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  457. "val_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  458. "speed_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  459. "led_flush_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  460. "led_process_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  461. "react_on_keyup": {"type": "boolean"},
  462. "sleep": {"type": "boolean"},
  463. "split_count": {
  464. "type": "array",
  465. "minItems": 2,
  466. "maxItems": 2,
  467. "items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  468. },
  469. "layout": {
  470. "type": "array",
  471. "items": {
  472. "type": "object",
  473. "additionalProperties": false,
  474. "properties": {
  475. "matrix": {
  476. "type": "array",
  477. "minItems": 2,
  478. "maxItems": 2,
  479. "items": {
  480. "type": "integer",
  481. "minimum": 0
  482. }
  483. },
  484. "x": {"$ref": "qmk.definitions.v1#/key_unit"},
  485. "y": {"$ref": "qmk.definitions.v1#/key_unit"},
  486. "flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  487. }
  488. }
  489. }
  490. }
  491. },
  492. "rgb_matrix": {
  493. "type": "object",
  494. "properties": {
  495. "animations": {
  496. "type": "object",
  497. "propertyNames": { "$ref": "qmk.definitions.v1#/snake_case" }
  498. "additionalProperties": {
  499. "type": "boolean"
  500. }
  501. },
  502. "default": {
  503. "type": "object",
  504. "additionalProperties": false,
  505. "properties": {
  506. "on": {"type": "boolean"},
  507. "animation": {"type": "string"},
  508. "hue": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  509. "sat": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  510. "val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  511. "speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  512. }
  513. },
  514. "driver": {"type": "string"},
  515. "center_point": {
  516. "type": "array",
  517. "minItems": 2,
  518. "maxItems": 2,
  519. "items": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  520. },
  521. "max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  522. "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  523. "hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  524. "sat_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  525. "val_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  526. "speed_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  527. "led_flush_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  528. "led_process_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  529. "react_on_keyup": {"type": "boolean"},
  530. "sleep": {"type": "boolean"},
  531. "split_count": {
  532. "type": "array",
  533. "minItems": 2,
  534. "maxItems": 2,
  535. "items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  536. },
  537. "layout": {
  538. "type": "array",
  539. "items": {
  540. "type": "object",
  541. "additionalProperties": false,
  542. "properties": {
  543. "matrix": {
  544. "type": "array",
  545. "minItems": 2,
  546. "maxItems": 2,
  547. "items": {
  548. "type": "integer",
  549. "minimum": 0
  550. }
  551. },
  552. "x": {"$ref": "qmk.definitions.v1#/key_unit"},
  553. "y": {"$ref": "qmk.definitions.v1#/key_unit"},
  554. "flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  555. }
  556. }
  557. }
  558. }
  559. },
  560. "rgblight": {
  561. "type": "object",
  562. "additionalProperties": false,
  563. "properties": {
  564. "animations": {
  565. "type": "object",
  566. "propertyNames": { "$ref": "qmk.definitions.v1#/snake_case" }
  567. "additionalProperties": {
  568. "type": "boolean"
  569. }
  570. },
  571. "brightness_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  572. "default": {
  573. "type": "object",
  574. "additionalProperties": false,
  575. "properties": {
  576. "on": {"type": "boolean"},
  577. "animation": {"type": "string"},
  578. "hue": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  579. "sat": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  580. "val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  581. "speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
  582. }
  583. },
  584. "driver": {
  585. "type": "string",
  586. "enum": ["apa102", "custom", "ws2812"]
  587. },
  588. "hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  589. "layers": {
  590. "type": "object",
  591. "additionalProperties": false,
  592. "properties": {
  593. "blink": {"type": "boolean"},
  594. "enabled": {"type": "boolean"},
  595. "max": {
  596. "type": "integer",
  597. "minimum": 1,
  598. "maximum": 32
  599. },
  600. "override_rgb": {"type": "boolean"}
  601. }
  602. },
  603. "led_count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  604. "led_map": {
  605. "type": "array",
  606. "minItems": 2,
  607. "items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  608. },
  609. "max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  610. "pin": {
  611. "$ref": "qmk.definitions.v1#/mcu_pin",
  612. "$comment": "Deprecated: use ws2812.pin instead"
  613. },
  614. "rgbw": {"type": "boolean"},
  615. "saturation_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  616. "sleep": {"type": "boolean"},
  617. "split": {"type": "boolean"},
  618. "split_count": {
  619. "type": "array",
  620. "minItems": 2,
  621. "maxItems": 2,
  622. "items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  623. }
  624. }
  625. },
  626. "secure": {
  627. "type": "object",
  628. "additionalProperties": false,
  629. "properties": {
  630. "enabled": {"type": "boolean"},
  631. "unlock_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  632. "idle_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  633. "unlock_sequence": {
  634. "type": "array",
  635. "minItems": 1,
  636. "maxItems": 5,
  637. "items": {
  638. "type": "array",
  639. "minItems": 2,
  640. "maxItems": 2,
  641. "items": {
  642. "type": "integer",
  643. "minimum": 0
  644. }
  645. }
  646. }
  647. }
  648. },
  649. "stenography": {
  650. "type": "object",
  651. "additionalProperties": false,
  652. "properties": {
  653. "enabled": {"type": "boolean"},
  654. "protocol": {
  655. "type": "string",
  656. "enum": ["all", "geminipr", "txbolt"]
  657. }
  658. }
  659. },
  660. "ps2": {
  661. "type": "object",
  662. "additionalProperties": false,
  663. "properties": {
  664. "enabled": {"type": "boolean"},
  665. "mouse_enabled": {"type": "boolean"},
  666. "clock_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  667. "data_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  668. "driver": {
  669. "type": "string",
  670. "enum": ["busywait", "interrupt", "usart", "vendor"]
  671. }
  672. }
  673. },
  674. "split": {
  675. "type": "object",
  676. "additionalProperties": false,
  677. "properties": {
  678. "enabled": {"type": "boolean"},
  679. "bootmagic":{
  680. "type": "object",
  681. "additionalProperties": false,
  682. "properties": {
  683. "matrix": {
  684. "type": "array",
  685. "minItems": 2,
  686. "maxItems": 2,
  687. "items": {
  688. "type": "integer",
  689. "minimum": 0
  690. }
  691. }
  692. }
  693. },
  694. "matrix_pins": {
  695. "type": "object",
  696. "additionalProperties": false,
  697. "properties": {
  698. "right": {
  699. "type": "object",
  700. "additionalProperties": false,
  701. "properties": {
  702. "direct": {
  703. "type": "array",
  704. "items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
  705. },
  706. "cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
  707. "rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
  708. "unused": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
  709. }
  710. }
  711. }
  712. },
  713. "dip_switch": {
  714. "type": "object",
  715. "additionalProperties": false,
  716. "properties": {
  717. "right": {
  718. "$ref": "#/definitions/dip_switch_config"
  719. }
  720. }
  721. },
  722. "encoder": {
  723. "type": "object",
  724. "additionalProperties": false,
  725. "properties": {
  726. "right": {
  727. "$ref": "#/definitions/encoder_config"
  728. }
  729. }
  730. },
  731. "handedness": {
  732. "type": "object",
  733. "additionalProperties": false,
  734. "properties": {
  735. "pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  736. "matrix_grid": {
  737. "$ref": "qmk.definitions.v1#/mcu_pin_array",
  738. "minItems": 2,
  739. "maxItems": 2
  740. }
  741. }
  742. },
  743. "soft_serial_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  744. "soft_serial_speed": {
  745. "type": "integer",
  746. "minimum": 0,
  747. "maximum": 5
  748. },
  749. "transport": {
  750. "type": "object",
  751. "additionalProperties": false,
  752. "properties": {
  753. "protocol": {
  754. "type": "string",
  755. "enum": ["custom", "i2c", "serial", "serial_usart"]
  756. },
  757. "sync": {
  758. "type": "object",
  759. "additionalProperties": false,
  760. "properties": {
  761. "activity": {"type": "boolean"},
  762. "detected_os": {"type": "boolean"},
  763. "haptic": {"type": "boolean"},
  764. "layer_state": {"type": "boolean"},
  765. "indicators": {"type": "boolean"},
  766. "matrix_state": {"type": "boolean"},
  767. "modifiers": {"type": "boolean"},
  768. "oled": {"type": "boolean"},
  769. "st7565": {"type": "boolean"},
  770. "wpm": {"type": "boolean"}
  771. }
  772. }
  773. "watchdog": {"type": "boolean"},
  774. "watchdog_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  775. "sync_matrix_state": {
  776. "type": "boolean",
  777. "$comment": "Deprecated: use sync.matrix_state instead"
  778. },
  779. "sync_modifiers": {
  780. "type": "boolean",
  781. "$comment": "Deprecated: use sync.modifiers instead"
  782. }
  783. }
  784. },
  785. "usb_detect": {
  786. "type": "object",
  787. "additionalProperties": false,
  788. "properties": {
  789. "enabled": {"type": "boolean"},
  790. "polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  791. "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  792. }
  793. },
  794. "main": {
  795. "type": "string",
  796. "enum": ["eeprom", "left", "matrix_grid", "pin", "right"],
  797. "$comment": "Deprecated: use config.h options for now"
  798. },
  799. "matrix_grid": {
  800. "type": "array",
  801. "items": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  802. "$comment": "Deprecated: use split.handedness.matrix_grid instead"
  803. }
  804. }
  805. },
  806. "tags": {
  807. "type": "array",
  808. "items": {"type": "string"}
  809. },
  810. "tapping": {
  811. "type": "object",
  812. "properties": {
  813. "force_hold": {"type": "boolean"},
  814. "force_hold_per_key": {"type": "boolean"},
  815. "ignore_mod_tap_interrupt": {"type": "boolean"},
  816. "hold_on_other_key_press": {"type": "boolean"},
  817. "hold_on_other_key_press_per_key": {"type": "boolean"},
  818. "permissive_hold": {"type": "boolean"},
  819. "permissive_hold_per_key": {"type": "boolean"},
  820. "retro": {"type": "boolean"},
  821. "retro_per_key": {"type": "boolean"},
  822. "term": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  823. "term_per_key": {"type": "boolean"},
  824. "toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  825. }
  826. },
  827. "usb": {
  828. "type": "object",
  829. "additionalProperties": false,
  830. "properties": {
  831. "device_ver": {
  832. "$ref": "qmk.definitions.v1#/hex_number_4d",
  833. "$comment": "Deprecated: use device_version instead"
  834. },
  835. "device_version": {"$ref": "qmk.definitions.v1#/bcd_version"},
  836. "force_nkro": {"type": "boolean"},
  837. "pid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
  838. "vid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
  839. "max_power": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  840. "no_startup_check": {"type": "boolean"},
  841. "polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  842. "shared_endpoint": {
  843. "type": "object",
  844. "additionalProperties": false,
  845. "properties": {
  846. "keyboard": {"type": "boolean"},
  847. "mouse": {"type": "boolean"}
  848. }
  849. },
  850. "suspend_wakeup_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  851. "wait_for": {"type": "boolean"}
  852. }
  853. },
  854. "qmk": {
  855. "type": "object",
  856. "additionalProperties": false,
  857. "properties": {
  858. "keys_per_scan": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
  859. "tap_keycode_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  860. "tap_capslock_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
  861. "locking": {
  862. "type": "object",
  863. "additionalProperties": false,
  864. "properties": {
  865. "enabled": {"type": "boolean"},
  866. "resync": {"type": "boolean"}
  867. }
  868. }
  869. }
  870. },
  871. "qmk_lufa_bootloader": {
  872. "type": "object",
  873. "additionalProperties": false,
  874. "properties": {
  875. "esc_output": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  876. "esc_input": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  877. "led": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  878. "speaker": {"$ref": "qmk.definitions.v1#/mcu_pin"}
  879. }
  880. },
  881. "ws2812": {
  882. "type": "object",
  883. "additionalProperties": false,
  884. "properties": {
  885. "driver": {
  886. "type": "string",
  887. "enum": ["bitbang", "custom", "i2c", "pwm", "spi", "vendor"]
  888. },
  889. "pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
  890. "i2c_address": {"$ref": "qmk.definitions.v1#/hex_number_2d"},
  891. "i2c_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
  892. }
  893. }
  894. }
  895. }