aboutsummaryrefslogtreecommitdiff
path: root/docs/reference_info_json.md
Commit message (Collapse)AuthorAgeFilesLines
* [Docs] Unify lighting step descriptions (#25167)ClownFish2025-04-171-11/+11
| | | unify lighting step descriptions and defaults across docs
* [Core] Add Chordal Hold, an "opposite hands rule" tap-hold option similar to ↵Pascal Getreuer2025-01-271-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Achordion, Bilateral Combinations. (#24560) * Chordal Hold: restrict what chords settle as hold * Chordal Hold: docs and further improvements * Fix formatting. * Doc rewording and minor edit. * Support Chordal Hold of multiple tap-hold keys. * Fix formatting. * Simplification and additional test. * Fix formatting. * Tighten tests. * Add test two_mod_taps_same_hand_hold_til_timeout. * Revise handing of pairs of tap-hold keys. * Generate a default chordal_hold_layout. * Document chordal_hold_handedness(). * Add license notice to new and branched files in PR. * Add `tapping.chordal_hold` property for info.json. * Update docs/reference_info_json.md * Revise "hand" jsonschema. * Chordal Hold: Improved layout handedness heuristic. This commit improves the heuristic used in generate-keyboard-c for inferring key handedness from keyboard.json geometry data. Heuristic summary: 1. If the layout is symmetric (e.g. most split keyboards), guess the handedness based on the sign of (x - layout_x_midpoint). 2. Otherwise, if the layout has a key of >=6u width, it is probably the spacebar. Form a dividing line through the spacebar, nearly vertical but with a slight angle to follow typical row stagger. 3. Otherwise, assume handedness based on the widest horizontal separation. I have tested this strategy on a couple dozen keyboards and found it to work reliably. * Use Optional instead of `| None`. * Refactor to avoid lambdas. * Remove trailing comma in chordal_hold_layout. * Minor docs edits. * Revise to allow combining multiple same-hand mods. This commit revises Chordal Hold as described in discussion in https://github.com/qmk/qmk_firmware/pull/24560#discussion_r1894655238 1. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓, RCTL_T(KC_A)↑" before the tapping term, RCTL_T(KC_A) is settled as tapped. 2. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓, RSFT_T(KC_C)↑", both RCTL_T(KC_A) and RSFT_T(KC_C) are settled as tapped. 3. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓, KC_U↓" (all keys on the same side), both RCTL_T(KC_A) and RSFT_T(KC_C) are settled as tapped. 4. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓, LSFT_T(KC_T)↓", with the third key on the other side, we allow Permissive Hold or Hold On Other Keypress to decide how/when to settle the keys. 5. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓" held until the tapping term, the keys are settled as held. 1–3 provide same-hand roll protection. 4–5 are for combining multiple same-hand modifiers. I've updated the unit tests and have been running it on my keyboard, for a few hours so far, and all seems good. I really like this scheme. It allows combining same-side mods, yet it also has roll protection on streaks. For me, this feels like Achordion, but clearly better streak handling and improved responsiveness. * Fix formatting. * Add a couple tests with LT keys. * Remove stale use of CHORDAL_HOLD_LAYOUT. * Fix misspelling lastest -> latest * Handling tweak for LTs and tests. * Fix formatting. * More tests with LT keys. * Fix formatting.
* Revert removal of `QK_OUTPUT_AUTO`, fixup docs to reflect. (#24593)Nick Brassel2024-11-141-2/+2
|
* [docs] Turn on icons for external links (#24580)Ryan2024-11-091-1/+1
|
* [docs] `reference_info_json`: add type hints (#24443)Ryan2024-09-301-232/+232
|
* Move split.soft_serial_pin to split.serial.pin (#24127)Joel Challis2024-07-181-2/+2
|
* Implement data driven serial driver (#23923)Joel Challis2024-06-171-0/+4
|
* [docs] Organize driver & feature docs into subfolders (#23848)Ryan2024-06-021-22/+22
| | | | Co-authored-by: Nick Brassel <nick@tzarc.org>
* Vitepress conversion of docs. (#23795)Nick Brassel2024-05-301-54/+54
|
* Remove 'split.transport.protocol=serial_usart' (#23668)Joel Challis2024-05-101-1/+1
|
* Rename `RGBW` define to `WS2812_RGBW` (#23585)Ryan2024-04-281-3/+3
|
* Add audio driver to keyboard.json schema (#23616)Joel Challis2024-04-261-0/+2
|
* Fix WAIT_FOR_USB handling (#23598)Joel Challis2024-04-241-1/+1
|
* LED drivers: add support for IS31FL3236 (#23264)Ryan2024-03-171-1/+1
|
* [Audio] Add support for audio shutdown pin (#22731)Drashna Jaelre2024-03-061-0/+7
| | | | Co-authored-by: Ryan <fauxpark@gmail.com>
* Add RGB matrix & LED Matrix support for IS31FL3729 (#21944)HorrorTroll2024-02-171-1/+1
| | | | | Co-authored-by: Xelus22 <preyas22@gmail.com> Co-authored-by: dexter93 <d3xter93@gmail.com>
* Remove redundant audio eeconfig init (#22736)Joel Challis2023-12-241-0/+7
|
* Enable linking of encoders to switch within layout macros (#22264)Joel Challis2023-11-201-0/+2
|
* Implement data driven lighting defaults (#21825)Joel Challis2023-11-011-2/+63
|
* Add dd mapping for hardware based split handedness (#22369)Joel Challis2023-11-011-0/+6
|
* Implement data driven dip switches (#22017)Joel Challis2023-10-291-0/+18
| | | | | * Add data driven dip switches * Autogen weak matrix_mask
* Add DD mappings for locking switch (#22242)jack2023-10-251-0/+7
| | | | Co-authored-by: Ryan <fauxpark@gmail.com>
* Support additional split sync items for info.json (#22193)Joel Challis2023-10-211-6/+31
|
* Rename CKLED2001 driver to SNLED27351 (#22071)Ryan2023-10-041-2/+2
|
* is31fl3737/3741: add LED Matrix support (#22163)Ryan2023-10-031-1/+1
|
* is31fl3733: complete LED Matrix support (#22149)Ryan2023-09-271-1/+1
|
* is31fl3218: Add LED Matrix support (#22126)Ryan2023-09-271-1/+1
| | | | Co-authored-by: Joel Challis <git@zvecr.com>
* is31fl3736: extract single-color API (#22133)Ryan2023-09-271-1/+1
|
* More data driven RGB/LED Matrix config (#21939)Joel Challis2023-09-271-0/+24
|
* Update WS2812 docs and add APA102 docs (#22106)Ryan2023-09-251-1/+1
| | | | Co-authored-by: Nick Brassel <nick@tzarc.org>
* Complete RGB Matrix support for IS31FL3218 (#22004)Ryan2023-09-171-1/+1
|
* aw20216: driver naming cleanups (#21891)Ryan2023-09-131-1/+1
|
* Implement data driven wear leveling (#21906)Joel Challis2023-09-051-0/+7
| | | | | | | | | | | | | | | | | | | | | | * DD encoder map, wear leveling * remove encoder map from DD let's avoid the support headache * wear leveling: specify the allowed drivers by name Co-authored-by: Ryan <fauxpark@gmail.com> * Add additional params * Relocate under eeprom * disable parsing --------- Co-authored-by: Dimitris Mantzouranis <d3xter93@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Rework info.json reference (#21324)Ryan2023-08-261-351/+673
| | | | | | | | | | | | | | | | | * Rework info.json reference * Apply suggestions from code review Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Update backlight.pins description * Add rgblight.driver and lowercase other driver names * Remove `split.main` and `split.matrix_grid` for now as they are not working yet --------- Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
* Remove `all` from list of animations in `info.json` (#19978)Joel Challis2023-03-011-1/+0
|
* Rework input_pressed_state docs (#19267)Joel Challis2022-12-081-1/+15
| | | | | * Revert changes to porting * Update reference_info_json.md
* DD bootmagic config (#19201)Joel Challis2022-11-301-0/+21
| | | | | | | * DD bootmagic config * Also enable * docs
* Fix headers in info.json reference (#19202)Joel Challis2022-11-301-7/+7
|
* [Docs] Update reference_info_json.md (#18817)Ndot2022-11-281-4/+4
| | | | | | | | | | | | | * [Docs] Update reference_info_json.md - Makes it easier to find keyboard.jsonschema. - Adds a reference to the Data Driven page. * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Additional DD backlight config (#19124)Joel Challis2022-11-231-0/+7
| | | | | * Additional dd backlight config * Update docs
* [docs] Improve documentation regarding info.json (#18508)Less/Rikki2022-09-291-9/+20
| | | | | * docs: raise info.json awareness * docs: note that DD migration is WIP
* Update reference_info_json.md (#18518)Markus Knutsson2022-09-291-1/+20
| | | | | | | | | | | | | | | | | | | | | | | | | * Update reference_info_json.md * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Merge remote-tracking branch 'origin/master' into developzvecr2022-07-131-0/+22
|\
| * Add basic secure docs (#17577)Joel Challis2022-07-131-0/+22
| |
* | Merge remote-tracking branch 'origin/master' into developQMK Bot2022-07-021-2/+53
|\|
| * Add LED backlight/indicator info to reference_info_json.md (#17010)Josh Hinnebusch2022-07-021-2/+53
| | | | | | Co-authored-by: Joel Challis <git@zvecr.com>
* | Allow encoder config from info.json (#17295)Joel Challis2022-06-201-0/+36
|/
* [Docs] clarify inner array of direct pin matrix (#17437)evils2022-06-211-1/+1
|
* Fix in-page links in reference_info_json.md (#16487)peepeetee2022-03-071-3/+3
|
* CLI: Parse USB device version BCD (#14580)Ryan2022-01-171-2/+4
| | | | | * CLI: Parse USB device version BCD * Apply suggestions
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-23 16:43:00 +0000