search

Keychron / qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families
https://qmk.fm
GNU General Public License v2.0
773 stars 1.04k forks source link

Keycodes for Space Cadet Keys seems wrong in Docs or Launcher (Keychron Q3 HE) #327

Open drandarov-io opened 2 weeks ago

drandarov-io commented 2 weeks ago

Issue Description

https://docs.qmk.fm/keycodes describes the space cadet keycodes as starting with SC_ , however inside https://launcher.keychron.com/#/keymap the keycodes they start with KC_.

This caused me quite a bit of confusion until I went over every single key in the launcher since the codes from the docs didn't work. Not sure if this is a general issue or just with the Q3 HE.

image

image

PeterMortensen commented 2 weeks ago

The Via clone is, well, a clone of Via, so what did you expect? Yes, that is a rhetorical question (mostly).

That is in KEYMAP → SPECIAL → "LS(" (about 15% down in the list). Keycode: KC_LSPO. From the documentation: SC_LSPO

PeterMortensen commented 2 weeks ago

An initial guess would be that some renaming happened in QMK, e.g., like for some keycodes for mouse actions (2024-07-03). And Via wasn't updated. And the Via clone is, well, a clone of Via.

The keycodes documentation page (that includes the space-cadet keycodes) is docs/keycodes.md.

Search (Bash) in the main QMK repository, default branch:

# -i   : Case insensitive. Alternative: --regexp-ignore-case
# -S   : 'Pickaxe'
# --all: In all branches
#
git log -i -S"space"  --  docs/keycodes.md | grep -i cadet

One of the hits is Normalise Space Cadet keycodes (numero 18864. 2022-10-27): 

KC_LSPO -> SC_LSPO etc.
KC_SFTENT -> SC_SENT

Conclusion

The keycodes aren't wrong per se, only their names, renamed on 2022-10-27. The confusion is caused by the constant renaming in QMK (and no mention of it in the QMK documentation); and related software, documentation, and guides not being updated in a timely manner. For the Vial fangirls/fanboys, the Vial client (the latest release, 0.7.1) hasn't been updated either (they are in "Keymap" → Quantum. For example, "LS (", hover text "KC_LSPO: Left Shift when held, ( when tapped". After assignment, it is (double clicking on the assigned key) "KC_LSPO. Computed value: 0x7C1A").

It affects not only the Q3 HE, but the whole QMK ecosystem.

lokher commented 1 day ago

It's fixed now, thank you for pointing it out.