qmk_firmware/lib/python/qmk/cli/generate
Pascal Getreuer 544ddde113
[Core] Add Chordal Hold, an "opposite hands rule" tap-hold option similar to 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.
2025-01-27 12:32:23 +01:00
..
__init__.py Ensure that safe_commands always run (#13199) 2021-06-14 16:51:58 -07:00
api.py Fix more qmk generate-api fallout from userspace support (#22619) 2023-12-06 17:59:42 +11:00
autocorrect_data.py [CLI] Don't exit() when certain exceptions occur. (#23442) 2024-06-15 10:37:47 +01:00
compilation_database.py clangd enhancements. (#23310) 2024-05-02 20:08:41 +10:00
config_h.py Rename encoder pins defines (#24003) 2024-07-03 17:18:27 +10:00
develop_pr_list.py Changelog 2022q1 (#16380) 2022-02-23 17:33:08 +00:00
dfu_header.py Update LUFA submodule (#18168) 2022-08-26 12:19:34 +10:00
docs.py Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
info_json.py qmk format-json: Expose full key path and respect sort_keys (#20836) 2023-05-20 22:15:05 +10:00
keyboard_c.py [Core] Add Chordal Hold, an "opposite hands rule" tap-hold option similar to Achordion, Bilateral Combinations. (#24560) 2025-01-27 12:32:23 +01:00
keyboard_h.py default_keyboard.h generation tweaks (#24715) 2024-12-15 19:06:05 +00:00
keycodes_tests.py [Test] Reset timer for every unit test and provide timestamps for log messages (#17028) 2022-12-15 02:31:08 +11:00
keycodes.py Generate switch statement helpers for keycode ranges (#20059) 2023-11-01 13:11:42 +11:00
keymap_h.py Generate keymap dd keycodes to header (#20273) 2024-06-17 21:51:53 +01:00
make_dependencies.py Enable 'keyboard.json' as a build target (#22891) 2024-03-10 16:20:25 +11:00
rgb_breathe_table.py Minor alignment of rgb_breathe_table generator (#19403) 2022-12-23 11:11:56 +00:00
rules_mk.py Generate keymap.json config options more forcefully (#21960) 2023-09-13 01:12:46 +01:00
version_h.py Add commit info to version.h (#19542) 2023-02-02 18:23:27 +00:00