Compare commits

..
Author SHA1 Message Date
Joel Challis
58e319b764 lint 2026-07-03 22:37:11 +01:00
Joel Challis
21823a69b8 Fix args handling 2026-07-03 22:31:32 +01:00
Joel Challis
c6ef6c580f Require --keyboard for some CLI subcommands 2026-07-03 22:27:10 +01:00
QMK Bot
e38f3097cb Merge remote-tracking branch 'origin/master' into develop 2026-07-03 03:49:08 +00:00
Pascal Getreuer
cf93bbb78f
[Docs] Tap-hold doc improvements and suggest an HRMs starter recipe (#26284)
* Enhance tap-hold docs.

* Minor edits.

* Move note on Quick Tap to a sub bullet for visibility.

Co-authored-by: Drashna Jaelre <drashna@live.com>

---------

Co-authored-by: Drashna Jaelre <drashna@live.com>
2026-07-03 11:48:28 +08:00
QMK Bot
9f75ab2c92 Merge remote-tracking branch 'origin/master' into develop 2026-06-26 13:20:50 +00:00
Trent Piepho
b1093e9da5
Fix VERBOSE make flag (#26289)
The docs say set this to true to enable verbose output, but setting it to
anything, even "false", would enable verbose mode.

The qmk python build program actually does this, supplying "VERBOSE=false"
to make, which turns verbose mode on, not off!  The reason it's not verbose
is that the wrapper also adds the "-s" switch that has the same effect as
turning verbose mode back off.

After fixing the flag, there's no reason to add the "-s", so remove that code.
2026-06-26 14:20:10 +01:00
Nick Brassel
5734360a86
Restrict the EXTRAKEY_ENABLE System Control HID usage range. (#26295) 2026-06-25 16:29:47 +10:00
Joel Challis
0ec0cdde81
Consistently handle datablock init (#26282) 2026-06-24 20:36:51 +01:00
QMK Bot
ee9354d36e Merge remote-tracking branch 'origin/master' into develop 2026-06-23 20:31:27 +00:00
dependabot[bot]
0cb6461c6a
Bump actions/cache from 5 to 6 (#26293)
Bumps [actions/cache](https://github.com/actions/cache) from 5 to 6.
- [Release notes](https://github.com/actions/cache/releases)
- [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md)
- [Commits](https://github.com/actions/cache/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/cache
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-06-23 21:30:44 +01:00
Joel Challis
dd905c9531
Split ducky/one2sf/1967st into ansi/iso variants (#26277) 2026-06-23 15:31:31 +01:00
Joel Challis
963986c475
Automatically handle duplicate matrix LED mappings (#26278) 2026-06-22 18:31:14 +01:00
QMK Bot
aae4189aa4 Merge remote-tracking branch 'origin/master' into develop 2026-06-22 17:28:58 +00:00
Benoit Brummer
198026cf27
ploopyco: fix bitwise typos in opt_encoder_tiny state definitions (#26288)
Fixes a bug in the state machine definitions within `opt_encoder_tiny.c` that caused severely delayed or unresponsive scrolling.
2026-06-22 18:28:13 +01:00
Joel Challis
fd624d016b
Fix nifty_numpad issues (#26283)
* eeconfig_init_kb_datablock should not call eeconfig_init_user_datablock

* Fix lint warnings
2026-06-21 10:49:42 +01:00
gitaen
6741f9dc26
Add converter/thinkpad_t6x/pico_t61 keyboard (#26266)
This adds support for Frank Adams pico_t61 board which is similar to
the currently supported converter/thinkpad_t6x/rpi_pico one.

Common options and shared default keymap have been moved to the upper
directory (keyboards/converter/thinkpad_t6x).
2026-06-19 19:40:51 +01:00
QMK Bot
f8910d3a60 Merge remote-tracking branch 'origin/master' into develop 2026-06-19 16:32:31 +00:00
dependabot[bot]
c638100030
Bump actions/checkout from 6 to 7 (#26274)
Bumps [actions/checkout](https://github.com/actions/checkout) from 6 to 7.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-06-19 17:30:08 +01:00
Arca Artem
1d2f52e407
process_key_lock: clear entire key state in cancel_key_lock() (#26269)
cancel_key_lock() called UNSET_KEY_STATE(0x0), which expands to clearing
only bit 0 of key_state[0]. The lock state is a 256-bit map spread across
key_state[0..3], so every locked key other than keycode 0x00 stayed
latched after a cancel.

Zero all four words so cancel_key_lock() releases every locked key, as
its name and its public declaration in process_key_lock.h imply.
2026-06-19 17:24:11 +01:00
Jack Sangdahl
746eff22db
Add additional layouts for mkh_studio/bully (#26271)
* Add extra spacebar layouts

- Rename LAYOUT -> LAYOUT_all
  - Resize keys to not be 0.5u tall
- Add layout alias for the above
- Add LAYOUT_split_space
- Add LAYOUT_full_space

* Remove whitepsace
2026-06-18 15:59:10 -07:00
Joel Challis
d36397fdd4
Implement Plover HID for VUSB (#26267) 2026-06-19 06:55:21 +10:00
Joel Challis
8522bb342d
Enable modules to persist data (#26201) 2026-06-18 18:43:32 +01:00
precondition
721affff7b
repeat_key.c: add implementation for get_last_record (#26263)
The `get_last_record` signature was present in repeat_key.h but without
any implementation in repeat_key.c which caused compilation errors for
any user of `get_last_record`.
2026-06-18 18:41:12 +01:00
gitaen
4f6c5d2745
Remove pin ordering restriction in RP2040 ps2 driver (#26256) 2026-06-15 09:36:02 +10:00
Nick Brassel
92dc82ae08
Plover HID cleanup. (#26262) 2026-06-15 08:33:35 +10:00
Graham Held
b64014d5df
Custom plover HID report type (#26018)
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: dnaq <dnaq@users.noreply.github.com>
2026-06-14 12:38:34 +10:00
Puneet Dixit
0d401d1182
Preserve Azoteq mouse buttons (#26248)
Co-authored-by: Deepak kudi <deepakkudi23@adsl-172-10-9-116.dsl.sndg02.sbcglobal.net>
2026-06-14 09:04:01 +10:00
QMK Bot
6ada0933db Merge remote-tracking branch 'origin/master' into develop 2026-06-13 21:20:24 +00:00
Nick Brassel
85886db43b
Fixup make format-core, make pytest, make format-and-pytest. (#26259) 2026-06-13 22:19:43 +01:00
QMK Bot
0515002e7d Merge remote-tracking branch 'origin/master' into develop 2026-06-13 12:29:41 +00:00
mellanslag-de
d8c8872753
Key Overrides: Fix Ghost Modifier Bug on macOS (with Karabiner Elements) (#25886) 2026-06-13 22:28:41 +10:00
QMK Bot
7f702d2262 Merge remote-tracking branch 'origin/master' into develop 2026-06-13 12:06:29 +00:00
yiancar
520b726b5c
Float65 Keyboard (#26197)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: yiancar <yiancar@gmail.com>
2026-06-13 22:00:51 +10:00
QMK Bot
6a0e2a8868 Merge remote-tracking branch 'origin/master' into develop 2026-06-13 11:30:00 +00:00
Samuel Baumgartner
4dc0a6e9e3
Feature/owlab link65 (#26163)
Co-authored-by: Joel Challis <git@zvecr.com>
2026-06-13 21:29:19 +10:00
QMK Bot
90082403de Merge remote-tracking branch 'origin/master' into develop 2026-06-10 23:54:21 +00:00
Futats
7b30455a93
Fix python syntax errors in except clauses (#26254)
* Update rules_mk.py

fix syntax error

* Update config_h.py

second syntax error
2026-06-11 07:53:41 +08:00
QMK Bot
cffafbbdc7 Merge remote-tracking branch 'origin/master' into develop 2026-06-09 18:27:28 +00:00
Yoichiro Tanaka
1ef87578e2
Fix audio.pins in keyboard.json not being converted to C defines (#26107)
* Fix audio.pins in keyboard.json not being converted to C defines

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Fix audio.pins in keyboard.json not being converted to C defines

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Fix 'list index out of range' on missing config

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: zvecr <git@zvecr.com>
2026-06-09 11:26:41 -07:00
QMK Bot
55be8f2c2b Merge remote-tracking branch 'origin/master' into develop 2026-06-08 00:37:23 +00:00
Joel Challis
f34bc9a6bc
Partially revert 26073 (#26252) 2026-06-08 08:36:45 +08:00
QMK Bot
df94ffcc66 Merge remote-tracking branch 'origin/master' into develop 2026-06-03 21:49:34 +00:00
フィルターペーパー
486f01f513
Trim copilot PR review instructions (#26240)
* Trim copilot PR review instructions

* Remove  unactionable and subjective rules
* Limit review to keyboards only
* Defer advance code review to collaborators

* Improve non-pristine default keymap message

* Clarify info.json rules for PR review

* Narrow applyTo scope to keyboards/**
2026-06-04 05:48:47 +08:00
QMK Bot
ee74da3a4d Merge remote-tracking branch 'origin/master' into develop 2026-06-01 11:34:14 +00:00
dependabot[bot]
c53dd0fbb6
Bump postcss from 8.5.8 to 8.5.15 in /builddefs/docsgen (#26243)
Bumps [postcss](https://github.com/postcss/postcss) from 8.5.8 to 8.5.15.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/postcss/compare/8.5.8...8.5.15)

---
updated-dependencies:
- dependency-name: postcss
  dependency-version: 8.5.15
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-06-01 12:33:30 +01:00
QMK Bot
480d808683 Merge remote-tracking branch 'origin/master' into develop 2026-06-01 08:08:15 +00:00
Nick Brassel
11abc31420
Additional bootstrapper safety checks (#26242)
* Unset `grep` options to prevent issues with forcing colour.
* Treat `musl`-based Linux distros are unsupported.
* Fix bootstrapper tests
2026-06-01 09:07:29 +01:00
zvecr
62a8db33a3 Branch point for 2026q3 Breaking Change 2026-06-01 07:59:12 +01:00
zvecr
f0c79ee455 Merge branch 'develop' 2026-06-01 07:51:54 +01:00
zvecr
6b54261fa5 Merge point for 2026q2 breaking changes. 2026-06-01 02:24:35 +01:00
zvecr
58d4decf48 Stub out changelog 2026-06-01 02:21:55 +01:00
Joel Challis
a9efff322c
Fail when a duplicate module name is detected (#26238) 2026-05-29 20:32:28 +01:00
Joel Challis
7b51d7e665
Add API version assertion for split_data_sync module (#26237) 2026-05-29 07:56:36 +01:00
QMK Bot
613d63aa66 Merge remote-tracking branch 'origin/master' into develop 2026-05-28 03:21:00 +00:00
ascYAOBT
5b630f7a08
Add hnk100 (#25909) 2026-05-28 04:20:21 +01:00
QMK Bot
286bc43459 Merge remote-tracking branch 'origin/master' into develop 2026-05-28 02:05:49 +00:00
Joel Challis
2ea1a0192f
Fix qmk compile -km <keyboard> -km all (#26234)
Pass required print_failures argument to mass compile commands.
2026-05-28 03:05:01 +01:00
QMK Bot
25f641f2ff Merge remote-tracking branch 'origin/master' into develop 2026-05-27 02:32:14 +00:00
Julian Yap
1620390d67
Add new keyboard - Pando58 (#26148) 2026-05-27 03:31:34 +01:00
QMK Bot
781b8ff406 Merge remote-tracking branch 'origin/master' into develop 2026-05-26 23:44:11 +00:00
Joel Challis
05c4322c65
Align Mouse USB descriptor (#26230) 2026-05-27 00:43:26 +01:00
tom-royle
462556f4de
Add the Troyle/macro keys dual keyboard to QMK (#25806) 2026-05-27 00:42:50 +01:00
フィルターペーパー
d19204824d
Mask out active mods when unregistering after retro tapping (#26127)
Do not unregister modifiers still held by other keys
2026-05-27 00:20:24 +01:00
QMK Bot
2fa6ed6631 Merge remote-tracking branch 'origin/master' into develop 2026-05-26 22:29:47 +00:00
blindassassin111
c20d0a83b5
Adding support for the KHS-01 (#26101) 2026-05-26 23:29:08 +01:00
QMK Bot
719b03f9c1 Merge remote-tracking branch 'origin/master' into develop 2026-05-26 20:22:01 +00:00
Jubakuba
3c338996f0
Adding Volt 80 Custom PCB Support (#26158)
* Adding Volt 80 Custom PCB Support

* update license

* lint fix

* requested changes

* requested changes 2

* requested changes 3 because I'm incompetent

* requested changes

* drashna recommends

* Update keyboards/percent_studio_aftermarket/keyboard.json

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Update keyboards/percent_studio_aftermarket/keymaps/default/keymap.c

Co-authored-by: Joel Challis <git@zvecr.com>

* Update keyboards/percent_studio_aftermarket/keyboard.json

Co-authored-by: Joel Challis <git@zvecr.com>

* Update keyboards/percent_studio_aftermarket/percent_studio_aftermarket.c

Co-authored-by: Joel Challis <git@zvecr.com>

* Update keyboards/percent_studio_aftermarket/percent_studio_aftermarket.c

Co-authored-by: Joel Challis <git@zvecr.com>

* Fix JSON formatting by removing extra lines

---------

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2026-05-26 13:21:19 -07:00
Simon Arlott
06c24a811e
[Keyboard] Add nomis/rpi_pico_25x1 macropad (#25346) 2026-05-26 03:24:57 +01:00
QMK Bot
e56d518fc9 Merge remote-tracking branch 'origin/master' into develop 2026-05-26 02:17:58 +00:00
Andrew Kannan
3a8ea37a13
Add Minimi40 to QMK (#25575) 2026-05-26 03:17:19 +01:00
QMK Bot
fdcf53854a Merge remote-tracking branch 'origin/master' into develop 2026-05-26 00:43:27 +00:00
Klesh Wong
f8aec1f50c
fix(input): Resolve lost mouse clicks in PS/2 streaming mode (#25942) 2026-05-26 01:42:44 +01:00
QMK Bot
47fd58e63e Merge remote-tracking branch 'origin/master' into develop 2026-05-26 00:38:03 +00:00
Simon
2604a49cda
Candy87 PCB Firmware (#24298) 2026-05-26 01:37:24 +01:00
QMK Bot
e3b26fa6ba Merge remote-tracking branch 'origin/master' into develop 2026-05-25 01:51:09 +00:00
X-Bows Tech
c701efbb53
Add Numpad_V2 (#26164) 2026-05-25 02:50:28 +01:00
QMK Bot
88cf7d87ec Merge remote-tracking branch 'origin/master' into develop 2026-05-25 01:48:41 +00:00
sizezero
d9bf44c7a9
[Keyboard] add aokay/mid1 (#26004) 2026-05-25 02:48:02 +01:00
Logan Butler
f31df2ed6b
Add reverse keymap to SouthPad v2 (#25707) 2026-05-24 16:34:32 +01:00
QMK Bot
e4bf68ca94 Merge remote-tracking branch 'origin/master' into develop 2026-05-23 23:04:17 +00:00
Idle Builds
393d3a5b21
Add Idle Builds Dinkey 32|30 keyboard (#26175) 2026-05-24 00:03:49 +01:00
Idle Builds
5e3985024d
Add Idle Builds Dinkey 34 keyboard (#26176) 2026-05-24 00:03:31 +01:00
QMK Bot
459542a255 Merge remote-tracking branch 'origin/master' into develop 2026-05-23 22:45:56 +00:00
Jon Colverson
12e5b7db97
[Keyboard] Add PicoLX (#26220) 2026-05-23 23:45:12 +01:00
QMK Bot
9879063f8c Merge remote-tracking branch 'origin/master' into develop 2026-05-23 22:34:25 +00:00
Dominic
316fc06d8c
Support for Alatus PCB (#26116) 2026-05-23 23:33:44 +01:00
QMK Bot
4d25dfae32 Merge remote-tracking branch 'origin/master' into develop 2026-05-23 05:04:40 +00:00
Erick Bazán
a033e172b9
[Keyboard] Add Wolf Singa Kohaku Solder, Solder RGB, and Hotswap (#26105) 2026-05-23 06:03:58 +01:00
QMK Bot
e9ee03983e Merge remote-tracking branch 'origin/master' into develop 2026-05-23 04:53:50 +00:00
diegorodriguezv
a187ebeec6
Add szr35 keyboard (#25662) 2026-05-23 05:53:07 +01:00
QMK Bot
e173b4020d Merge remote-tracking branch 'origin/master' into develop 2026-05-23 04:41:08 +00:00
VPavliashvili
ffe57097eb
Add ergo-v-1 keyboard (#25908) 2026-05-23 05:40:28 +01:00
George Norton
6ee28ac86f
Clip mouse report values to the logical range from the USB descriptor. (#26195) 2026-05-23 04:08:44 +01:00
QMK Bot
a3caec1580 Merge remote-tracking branch 'origin/master' into develop 2026-05-23 03:07:56 +00:00
sigman
99a67d1172
Changing VID for Southpaw65ext (#26104)
* fix: assign vid instead of generic

* fix: add copyright clause in keymaps

* review: 0x1209 -> vid

* change: vid 0x7f00

* fix: hex number case
2026-05-23 11:07:15 +08:00
QMK Bot
08d91c3d4e Merge remote-tracking branch 'origin/master' into develop 2026-05-23 00:39:19 +00:00
Yoichi NAKAYAMA
7e9c4508c8
[Docs][MouseKeys] Document the effect of the acceleration key in default mode. (#26213)
* Document the effect of the acceleration key in default mode.

* Move description into TIPS

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>

---------

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2026-05-23 08:38:40 +08:00
Pascal Getreuer
9d47119457
[Core] Options to constrain Speculative Hold: SPECULATIVE_HOLD_ONE_KEY and SPECULATIVE_HOLD_FLOW_TERM. (#26099) 2026-05-22 22:50:52 +01:00
QMK Bot
4b19065f7b Merge remote-tracking branch 'origin/master' into develop 2026-05-22 21:39:19 +00:00
Chris West
ed0d5fde7b
Fix spelling error in feature_layers.md (#26227)
Corrected spelling of 'tricker' to 'trickier' in the Advanced Users section.
2026-05-22 22:38:37 +01:00
Konstantin Đorđević
cf2dcd6e24
Add usage clarifications to docs/features/unicode.md (#26156)
* Add usage clarifications to docs/features/unicode.md

* Apply suggestions from code review

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>

---------

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2026-05-22 13:57:44 +08:00
QMK Bot
62d25f02a4 Merge remote-tracking branch 'origin/master' into develop 2026-05-19 01:59:28 +00:00
Joel Challis
0269eea2c9
Add EECONFIG_{KB,USER}_DATA_SIZE docs (#26200) 2026-05-19 02:58:50 +01:00
QMK Bot
078ec10e42 Merge remote-tracking branch 'origin/master' into develop 2026-05-17 03:07:28 +00:00
Nick Brassel
1836382f66
GCC 16.1 compatibility fix. (#26216)
Co-authored-by: Joel Challis <git@zvecr.com>
2026-05-17 13:06:47 +10:00
Serge Baranov
0efd817f42
fix(ws2812-pwm): allow WS2812_PWM_TICK_FREQUENCY override (#26186)
Wrap the define in #ifndef so a keyboard's config.h can set it. The
default (CPU_CLOCK / 2) works for a fixed SYSCLK, but boards that
change SYSCLK at runtime (meletrix/zoom_tkl drops to 16 MHz on
battery) need a tick frequency that divides into both the high and
low TMRCLKs. Every other knob in the file is already #ifndef-guarded;
this one was the only flat #define.
2026-05-17 00:14:52 +01:00
Joel Challis
ce4f342ceb
Remove FORCE_NKRO (#26206) 2026-05-16 02:27:19 +01:00
Joel Challis
2b88b7b20a
Ignore Uninteresting test warnings during test teardown (#26161) 2026-05-09 18:10:34 +08:00
Joel Challis
1a56fbece2
Fix USER_PRINT stripping out uprintf (#25919) 2026-05-07 22:33:31 +01:00
Joel Challis
a498daf627
Migrate SPLIT_OLED_ENABLE (#26194) 2026-05-07 22:32:38 +01:00
Joel Challis
5db9f2fb41
Remove OLED_DISPLAY_128X32 config (#26190) 2026-05-07 22:27:02 +01:00
Kenneth Fossen
c9f942e43c
Add Handwired Bouvet Macropad (#26040)
* Bouvet MacroPad v1

* Working macropad and encoders

* Fix matrix, and custom keymap

* The perfect developer keyboard

* Move to handwired

* Rev 1.1

* Move to handwired

* Turn off debugging

* Fix copyright

* qmk lint

* Update keyboard.json

* cleanup

* Update image

* Move encoder config

* Update keyboards/handwired/bouvet/macropad/v1/keyboard.json

Co-authored-by: Joel Challis <git@zvecr.com>

* Cleanup

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2026-05-03 10:02:39 -07:00
フィルターペーパー
8d8cd1ca61
Minor combo code optimisation (#26073)
* Remove redundant index initialisation
* Add early break for overlap scan
* Remove dead no_combo_keys_pressed code
* Avoid duplicate timer reset
2026-05-03 04:06:27 +01:00
QMK Bot
f0622da7a8 Merge remote-tracking branch 'origin/master' into develop 2026-05-03 03:02:54 +00:00
prkrln
504533b3b4
Add pad9 keyboard (#26051) 2026-05-03 04:02:11 +01:00
QMK Bot
c5391ca2d6 Merge remote-tracking branch 'origin/master' into develop 2026-04-30 23:27:43 +00:00
Sinopoli Mauro
ba9642c83d
Add sector245/s245_streamdeck keyboard (#26013) 2026-05-01 00:26:54 +01:00
QMK Bot
4a962d7679 Merge remote-tracking branch 'origin/master' into develop 2026-04-30 22:57:56 +00:00
Joel Challis
c2f7a5b5c5
Fix config.h bool parsing (#26166) 2026-04-30 23:57:08 +01:00
Joel Challis
e2c7d621a1
Add workaround for undefined reference to weak function under mingw (#26167) 2026-04-30 23:56:35 +01:00
Scott Lamb
0c5e36d056
Fix make test:all failures seen on macOS Tahoe (#26136) 2026-04-28 19:31:00 +01:00
Joel Challis
7d40a3328f
Require "url" field to not be empty (#25152) 2026-04-26 13:48:59 +10:00
Joel Challis
21c193f77b
Print correct test names (#26160) 2026-04-19 08:37:12 +08:00
Joel Challis
1182760a7c
Bind gtest colour to QMKs 'COLOR' variable (#26159) 2026-04-19 08:34:54 +08:00
QMK Bot
60638d3043 Merge remote-tracking branch 'origin/master' into develop 2026-04-18 03:55:46 +00:00
Isaac Rex
ccc6c6ce0b
[Keyboard] Added Nifty Numpad (#23019)
* Initial commit of Nifty Numpad keyboard

* Initial commit of Nifty Numpad keyboard

* Fixed double repo

* Updated available effects

* Added a default and VIA keymap, moved cadence to its own keymap

* Fixed qmk_firmware submodule issue

* Updated Nifty Numpad readme

Updated Cadence keymap

Updated vscode settings to match QMK master

* Added Nifty Numpad

* Added config.h to idle_rgb_example

* renamed info.json, removed rules.mk

* Updated to conform with most recent PR checklist

- Removed VIA keymap
- Formatted keyboard.json with qmk format-json
- Updated custom keycodes in nifty_numpad.h to start at QK_USER

* Address review feedback

- Remove the config.h file from the idle_rgb_example keymap as the only
  settings was equal to the default
- Added empty endline to the end of idle_rgb_example/rules.mk and post_rules.mk
- Updated RGB_DEF custom keycode to QK_KB

* Removed commented layout visuals

* Updated RGB Matrix keycodes

* Updated use of eeconfig_update_kb_datablock to new signature
2026-04-17 20:55:09 -07:00
Dimitris Mantzouranis
cc291cff7f
VIA v13 (#26001) 2026-04-17 08:53:05 +10:00
Joel Challis
70694abdfe
Bump googletest to v1.16.0 (#26154) 2026-04-16 15:23:15 +01:00
Joel Challis
1daa191e09
Add includes for std::setw (#26153) 2026-04-16 00:38:42 +01:00
QMK Bot
2ddd7c0667 Merge remote-tracking branch 'origin/master' into develop 2026-04-14 10:23:24 +00:00
ijouw
2dc7d991b1
Either output Unicode or insert in Leader sequence (#25940) 2026-04-14 11:18:33 +01:00
kbd0
c93ef27143
[Keyboard] Add Kbd0 Curve0 75% ANSI (#25997) 2026-04-14 11:17:28 +01:00
QMK Bot
3a7e4d933e Merge remote-tracking branch 'origin/master' into develop 2026-04-14 10:03:12 +00:00
Nick Brassel
15e8658e81
Deploy qmk_udev during bootstrap, updated CLI bootstrap docs (#26147) 2026-04-14 11:02:31 +01:00
QMK Bot
710e041c39 Merge remote-tracking branch 'origin/master' into develop 2026-04-13 21:50:08 +00:00
Toast
c6475e0476
Implement num lock light for Keychron V5 (#26019) 2026-04-13 22:49:27 +01:00
QMK Bot
d99f3acd8c Merge remote-tracking branch 'origin/master' into develop 2026-04-13 20:29:42 +00:00
Danny
3001d81e3d
Add Sinc LM Rev. 1 (#26134) 2026-04-13 16:28:59 -04:00
QMK Bot
84cd973c49 Merge remote-tracking branch 'origin/master' into develop 2026-04-11 09:15:48 +00:00
dependabot[bot]
407e6e242e
Bump actions/github-script from 8 to 9 (#26142)
Bumps [actions/github-script](https://github.com/actions/github-script) from 8 to 9.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](https://github.com/actions/github-script/compare/v8...v9)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: '9'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-04-11 10:15:09 +01:00
QMK Bot
2c98f3782a Merge remote-tracking branch 'origin/master' into develop 2026-04-09 12:26:50 +00:00
QMK Bot
18ed7c6caf
[CI] Format code according to conventions (#26138)
Format code according to conventions
2026-04-09 13:26:08 +01:00
QMK Bot
cbb8d156b0 Merge remote-tracking branch 'origin/master' into develop 2026-04-09 11:04:35 +00:00
Joel Challis
92c0e2cee1
Align C formatting extensions (#26137) 2026-04-09 12:03:53 +01:00
QMK Bot
ded30bb42e Merge remote-tracking branch 'origin/master' into develop 2026-04-09 10:31:14 +00:00
Joel Challis
6a11370434
Avoid BrokenPipeError errors in qmk clean 2026-04-09 11:30:33 +01:00
Nick Brassel
dd74b2326f
ChibiOS, ChibiOS-Contrib updates (redux) (#26079)
* Reapply "Update ChibiOS, ChibiOS-Contrib." (#26074)

This reverts commit c0bbf2f0f9.

* Updated repo.

* Update `lib/chibios` to 21.11.5 release.
2026-04-06 21:05:36 +10:00
Joel Challis
fbb0acdaa0
Remove deprecated isLeftHand (#25897)
Refactor deprecated isLeftHand
2026-04-06 08:49:05 +08:00
QMK Bot
a34c3b915e Merge remote-tracking branch 'origin/master' into develop 2026-04-05 05:39:18 +00:00
Joel Challis
2bd8e43256
Enhance checks for invalid keyboard build targets (#26122)
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2026-04-05 15:38:40 +10:00
QMK Bot
915edc3a3f Merge remote-tracking branch 'origin/master' into develop 2026-04-05 05:38:20 +00:00
Joel Challis
933cb8cc35
Update CI workflow to dynamically set keymaps (#26120) 2026-04-05 15:37:41 +10:00
QMK Bot
50a411c95e Merge remote-tracking branch 'origin/master' into develop 2026-04-02 07:24:20 +00:00
Joel Challis
1426eedfc1
Fix cache list command in CI workflow 2026-04-02 08:23:41 +01:00
QMK Bot
7b4565a409 Merge remote-tracking branch 'origin/master' into develop 2026-04-02 05:00:38 +00:00
Joel Challis
e4b998ccb0
Only attempt cache deletion if exists (#26124) 2026-04-02 16:00:00 +11:00
QMK Bot
4dd01f4331 Merge remote-tracking branch 'origin/master' into develop 2026-04-01 08:41:58 +00:00
Joel Challis
b5af7a3390
Enable ccache within CI (#26121) 2026-04-01 19:41:19 +11:00
windexlight
593cd168c6
Fix possible repeat key infinite recursion (#25926)
Guard against infinite recursion when pressing this sequence after fresh boot: repeat key press -> another key press/release -> repeat key release.
2026-03-31 11:12:01 +01:00
QMK Bot
c31ebfeb0a Merge remote-tracking branch 'origin/master' into develop 2026-03-30 04:26:07 +00:00
Joel Challis
ed80e21858
Resolve 'using serial compilation of 2 LTRANS jobs' warning (#26113) 2026-03-30 15:25:29 +11:00
Joel Challis
6f4a45e392
Fix color diagnostics for arm-none-eabi-gcc (#26115) 2026-03-30 14:42:29 +11:00
QMK Bot
53e1f9e0bd Merge remote-tracking branch 'origin/master' into develop 2026-03-30 03:25:10 +00:00
Joel Challis
9d24bc8a33
Fix userspace detection in Makefile (#26117) 2026-03-30 11:24:32 +08:00
Joel Challis
534f59a169
Fix cc-option on arm-none-eabi-gcc (#26114)
Fix `cc-option` on ARM

Modify cc-option to ignore unresolved symbols during compilation tests.
2026-03-30 10:25:46 +08:00
Joel Challis
7382c0a6f2
Remove deprecated audio pin defines (#26111) 2026-03-28 07:29:27 +00:00
Joel Challis
43a27da296
Remove override of QK_{LED,RGB}_MATRIX_TOGGLE keycode (#25672) 2026-03-28 02:41:17 +00:00
Dominic Clifton
3d0ccbb1d5
Add an mcu_reset impl for the kiibohd bootloader. (#25963)
* Fixes resetting and split watchdog on the Ergodox Infinity.
2026-03-28 02:31:07 +00:00
QMK Bot
a20facf8ec Merge remote-tracking branch 'origin/master' into develop 2026-03-27 04:02:51 +00:00
QMK Bot
c7fde3d8cc
[CI] Format code according to conventions (#26108)
Format code according to conventions
2026-03-27 03:56:53 +00:00
QMK Bot
941b63c9a9 Merge remote-tracking branch 'origin/master' into develop 2026-03-27 03:16:07 +00:00
Sebastian Morgenstern
0fdb5df94d
Added new pttbutton keyboard (#25952) 2026-03-27 03:15:28 +00:00
QMK Bot
d340f3396f Merge remote-tracking branch 'origin/master' into develop 2026-03-19 19:28:33 +00:00
Joel Challis
bd500ae092
Detect PRs bypassing DD changes (#26094) 2026-03-20 06:27:49 +11:00
QMK Bot
12f92db5d9 Merge remote-tracking branch 'origin/master' into develop 2026-03-19 03:41:28 +00:00
Peter Cock
fec01edaa4
Explain how to use STORE_SETUPS and PRINT_SETUPS (#26070)
* Explain how to use STORE_SETUPS and PRINT_SETUPS

I found the instructions a little terse, but managed.

This also adds a note about PRINT_SETUPS reporting random numbers if STORE_SETUPS hasn't been used.

* Remove line breaks

Existing docs seem to use a mix of hard line breaks at sentence
ends, or 80 chars-ish, versus no line breaks in paragraphs.

* Suggestion during review

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>

---------

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2026-03-19 11:40:49 +08:00
QMK Bot
9da27a3dcf Merge remote-tracking branch 'origin/master' into develop 2026-03-19 02:22:05 +00:00
Peter Cock
7619e991cf
QMK avoids raw line breaks within paragraphs in Markdown (#26080)
* QMK avoids raw line breaks within paragraphs in Markdown

Mentioned in passing during a few of my recent documentation pull requests, eg #26070.

* Suggestion during review

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>

---------

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2026-03-19 10:16:35 +08:00
QMK Bot
a3529e1c25 Merge remote-tracking branch 'origin/master' into develop 2026-03-19 01:51:12 +00:00
Dasky
627ad33233
Fix pointing device driver typo (#26091)
fix typo
2026-03-18 18:50:33 -07:00
Dominic Clifton
1f96f890fa
Always generate .map files. (#25961)
* Always generate .map files.

Useful when NOT compiling with debugging C/CXX/AS flags too!

e.g. to find which source file was used to compile-in a weak reference.

* Shorten comment phrase

---------

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2026-03-16 18:31:16 +08:00
QMK Bot
1a3728db21 Merge remote-tracking branch 'origin/master' into develop 2026-03-16 03:13:48 +00:00
フィルターペーパー
2cbcd76ef0
License violations updates. (#26076) 2026-03-16 03:12:18 +00:00
Joel Challis
322e673bcb
Remove use of andstor/file-existence-action (#26078) 2026-03-16 03:12:04 +00:00
QMK Bot
c27e3aee19 Merge remote-tracking branch 'origin/master' into develop 2026-03-16 02:24:32 +00:00
dependabot[bot]
4be8880177
Bump geekyeggo/delete-artifact from 5 to 6 (#26077)
Bumps [geekyeggo/delete-artifact](https://github.com/geekyeggo/delete-artifact) from 5 to 6.
- [Release notes](https://github.com/geekyeggo/delete-artifact/releases)
- [Changelog](https://github.com/GeekyEggo/delete-artifact/blob/main/CHANGELOG.md)
- [Commits](https://github.com/geekyeggo/delete-artifact/compare/v5...v6)

---
updated-dependencies:
- dependency-name: geekyeggo/delete-artifact
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-03-16 02:23:53 +00:00
フィルターペーパー
86fbc9efe0
Remove blockader user keymap (#26075) 2026-03-16 01:45:39 +00:00
Nick Brassel
c0bbf2f0f9
Revert "Update ChibiOS, ChibiOS-Contrib." (#26074) 2026-03-16 12:29:22 +11:00
QMK Bot
f63d01d786 Merge remote-tracking branch 'origin/master' into develop 2026-03-15 11:22:22 +00:00
Jalal El Mansouri
709628dfb2
Honor BUILD_DIR in mass_compile.py (#25586) 2026-03-15 22:07:43 +11:00
Marcus Ofenhed
f01698b3f8
Add resolution information to digitizer (#25958)
Co-authored-by: Marcus Ofenhed <>
2026-03-15 21:59:23 +11:00
QMK Bot
53c0e30e96
[CI] Format code according to conventions (#26072) 2026-03-15 21:31:43 +11:00
フィルターペーパー
2afc217124
Refactor Pixel Fractal effect (#26071) 2026-03-15 21:29:36 +11:00
HorrorTroll
e4de46b3b0
Added PixArt PMW-3325 mouse sensor driver (#26065)
* Added support PMW3325 sensor driver

* Missing PMW3325 on pointing device document

* Suggested changes resolved
2026-03-15 21:28:40 +11:00
Joel Challis
b6ff72cb03
Bump vitepress to 1.6.4 (#26067) 2026-03-15 21:25:45 +11:00
HorrorTroll
cd78765edc
Update WL backing store from 16 to 32-bit for AT32 (#26066)
Update backing store from 16 to 32-bit for AT32
2026-03-15 02:06:19 -07:00
QMK Bot
71b6b46534 Merge remote-tracking branch 'origin/master' into develop 2026-03-14 15:31:46 +00:00
Joel Challis
e5faeea94d
Unit tests should not run when docs change (#26068) 2026-03-14 15:31:07 +00:00
QMK Bot
263d56ce7e Merge remote-tracking branch 'origin/master' into develop 2026-03-14 13:30:55 +00:00
vuvoth
7ec819eb22
docs: remove hardware link in Ferris Sweep README (#26069)
remove hardware link in Ferris Sweep readme

Corrected wording for Ferris sweep hardware description.
2026-03-14 07:30:14 -06:00
Joel Challis
f7a77c8b70
Update lint to check all keymaps within the repo (#25970) 2026-03-13 23:20:28 +00:00
QMK Bot
53953f4229 Merge remote-tracking branch 'origin/master' into develop 2026-03-13 23:18:13 +00:00
Brandon
7785e87029
Add nulldesignco/v1/nullpad (#26057) 2026-03-13 23:17:29 +00:00
QMK Bot
4b3b32e173 Merge remote-tracking branch 'origin/master' into develop 2026-03-13 23:00:34 +00:00
Peter Cock
afb5335bf3
Switch missing default handler in OS detection docs (#26064)
Switch was missing default handler: control reaches end of non-void function

This warning gets treated as an error on Github Actions
2026-03-13 22:59:54 +00:00
Nick Brassel
e83672fdc4
Update ChibiOS, ChibiOS-Contrib. (#25730) 2026-03-13 18:52:49 +11:00
QMK Bot
af6b953b2c Merge remote-tracking branch 'origin/master' into develop 2026-03-12 10:06:03 +00:00
Nick Brassel
9fd72b352b
Extra bootstrap release package filtering. (#26039) 2026-03-12 21:05:24 +11:00
QMK Bot
59e1a0d437 Merge remote-tracking branch 'origin/master' into develop 2026-03-11 16:43:42 +00:00
Joel Challis
7fe0c9c746
[CI] Build unit tests in parallel (#26058) 2026-03-11 16:43:02 +00:00
QMK Bot
311e915d96 Merge remote-tracking branch 'origin/master' into develop 2026-03-10 23:33:53 +00:00
Joel Challis
5629ecf5ff
Add bootloadHID support to qmk flash (#26053) 2026-03-10 23:33:14 +00:00
QMK Bot
e2f62925d9 Merge remote-tracking branch 'origin/master' into develop 2026-03-10 02:41:42 +00:00
Peter Cock
01e30d407c
[Docs] Show how to flip semicolon and colon (#26030)
* Show how to flip semicolon and colon

* Apply whitespace suggestions from code review

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Match line-wrapping

Co-authored-by: Joel Challis <git@zvecr.com>

---------

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2026-03-09 19:41:03 -07:00
QMK Bot
d87e72a9b3 Merge remote-tracking branch 'origin/master' into develop 2026-03-10 01:51:17 +00:00
dependabot[bot]
acdc8a1374
Bump actions/download-artifact from 7 to 8 (#26038)
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 7 to 8.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/v7...v8)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-03-10 01:50:49 +00:00
dependabot[bot]
d73c91f19b
Bump actions/upload-artifact from 6 to 7 (#26037)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-03-10 01:50:37 +00:00
QMK Bot
dfb6158c62 Merge remote-tracking branch 'origin/master' into develop 2026-03-09 22:07:13 +00:00
dependabot[bot]
40e81ad893
Bump rollup from 4.31.0 to 4.59.0 in /builddefs/docsgen (#26036)
Bumps [rollup](https://github.com/rollup/rollup) from 4.31.0 to 4.59.0.
- [Release notes](https://github.com/rollup/rollup/releases)
- [Changelog](https://github.com/rollup/rollup/blob/master/CHANGELOG.md)
- [Commits](https://github.com/rollup/rollup/compare/v4.31.0...v4.59.0)

---
updated-dependencies:
- dependency-name: rollup
  dependency-version: 4.59.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-03-09 22:00:42 +00:00
QMK Bot
a1a2e3a390 Merge remote-tracking branch 'origin/master' into develop 2026-03-09 21:17:10 +00:00
Joel Challis
3dcdf41d1c
Fix split data sync link in community modules docs (#26055) 2026-03-09 21:16:30 +00:00
zvecr
6d7589e249 Branch point for 2026q2 Breaking Change 2026-03-08 00:52:03 +00:00
zvecr
d55d65b77f Merge branch 'develop' 2026-03-08 00:46:27 +00:00
zvecr
a56496640e Merge point for 2026q1 breaking changes. 2026-03-07 23:47:50 +00:00
Nick Brassel
032c2aa974
2026q1 develop changelog. (#26046) 2026-03-07 23:46:38 +00:00
QMK Bot
1874bc94e2 Merge remote-tracking branch 'origin/master' into develop 2026-02-24 19:23:41 +00:00
Joel Challis
9e8199c411
Print keymap name within new-keymap error message (#26034) 2026-02-24 19:23:04 +00:00
Joel Challis
4733a2df16
Promote duplication of defaults check to error (#26025) 2026-02-20 15:45:26 +00:00
Joel Challis
2d46c96732
Remove deprecated GPIO defines (#26028) 2026-02-20 14:37:16 +00:00
QMK Bot
3b99406d50 Merge remote-tracking branch 'origin/master' into develop 2026-02-20 12:56:59 +00:00
Joel Challis
7bea08cb12
Enable strict linting for keyboard PRs (#26026) 2026-02-20 12:56:19 +00:00
Joel Challis
5591a68b65
Allow custom data sync for community modules (#25955)
* Allow custom data sync for community modules

* Stub out community_config.h codegen

* Fix SPLIT_TRANSACTION_RPC logic
2026-02-19 22:03:26 +11:00
QMK Bot
a0166fef43 Merge remote-tracking branch 'origin/master' into develop 2026-02-18 00:07:04 +00:00
Joel Challis
e52319b751
Check PRs for invalid keyboard build targets (#25992) 2026-02-18 00:06:23 +00:00
Joel Challis
cde41cf611
Remove config_h_features from generated info.json (#26024) 2026-02-17 22:24:03 +00:00
QMK Bot
878fafeeb8 Merge remote-tracking branch 'origin/master' into develop 2026-02-17 17:01:30 +00:00
Jakob Schikowski
1ba0300da7
Fix JSON type for SELECT_SOFT_SERIAL_SPEED (#26003) 2026-02-17 10:00:51 -07:00
Joel Challis
f8daa3cc40
Add 'none of the above' to new-keyboard dev board prompt (#25998) 2026-02-16 02:18:04 +00:00
QMK Bot
bef076f23e Merge remote-tracking branch 'origin/master' into develop 2026-02-13 18:22:34 +00:00
Joshua Diamond
3ac6f603a8
Mark encoders as such in dmqdesign/spin (#25973) 2026-02-13 18:22:06 +00:00
Joel Challis
63a3fc3591
Fix qmk flash handling of paths relative to qmk_firmware (#25993) 2026-02-13 18:21:51 +00:00
Joel Challis
036c6100bd
Fix incorrect matrix_scan_custom implementations (#25999) 2026-02-13 18:21:36 +00:00
フィルターペーパー
403211f7f8
Remove unused headers (#26011) 2026-02-13 18:20:18 +00:00
フィルターペーパー
888d42d64c
Remove redundant unsigned comparison in apa102_set_brightness (#26010) 2026-02-13 12:35:08 +00:00
フィルターペーパー
6b2a2ab7ac
Return INVALID_DEFERRED_TOKEN on allocation failure (#26012)
Return the proper deferred_token type instead of boolean false.
2026-02-13 14:51:33 +08:00
フィルターペーパー
edd2e3d354
Remove duplicate include of host.h (#26007) 2026-02-12 15:58:59 +00:00
フィルターペーパー
6b423c98e5
Remove an unreachable break statement (#26006) 2026-02-12 15:58:31 +00:00
フィルターペーパー
36cdac8fd3
Remove redundant EEPROM update (#26008) 2026-02-12 15:58:13 +00:00
QMK Bot
59cc10451b
[CI] Format code according to conventions (#26005)
Format code according to conventions
2026-02-11 20:35:16 +00:00
QMK Bot
031277c6d3 Merge remote-tracking branch 'origin/master' into develop 2026-02-11 20:24:10 +00:00
ivan
45ccd2e935
Add ows steno board (#25984) 2026-02-11 12:23:30 -08:00
QMK Bot
4f7a7873c8
[CI] Format code according to conventions (#26000)
Format code according to conventions
2026-02-11 16:06:13 +00:00
Josip Šimun Kuči
5ad6d44e18
[Keyboard] Add Soldered Macro Pad (#25834)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2026-02-12 01:16:55 +11:00
Joel Challis
fac1210609
Enforce EOL when formatting files (#24989) 2026-02-11 07:39:49 +08:00
Joel Challis
a170e6f191
Update lint to validate keymap names (#25969) 2026-02-10 16:48:09 +00:00
Joel Challis
db4d8823d6
Migrate ROW_SHIFTER to core MATRIX_ROW_SHIFTER (#25977) 2026-02-10 16:47:41 +00:00
Joel Challis
9aec0e2c9f
Remove some unnecessary matrix externs (#25975) 2026-02-10 16:47:25 +00:00
QMK Bot
08a064c56d Merge remote-tracking branch 'origin/master' into develop 2026-02-10 08:58:26 +00:00
Mikko Turunen
b01ed7d34f
Adding a new keyboard - Slothie60 (#24931)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2026-02-10 00:36:35 -08:00
QMK Bot
85d4736930 Merge remote-tracking branch 'origin/master' into develop 2026-02-10 08:22:58 +00:00
Sebastiaan Swinkels
a7f524f264
Added MK Point65 keyboards and keymaps (#25392) 2026-02-10 00:20:34 -08:00
Joel Challis
98f05c0136
Allow keymap.json to disable config flags (#25502) 2026-02-10 16:11:02 +08:00
Joel Challis
5dd5d4dd60
Correctly resolve keyboard alias during 'qmk new-keymap' (#25570) 2026-02-10 16:10:12 +08:00
QMK Bot
cf4e526063 Merge remote-tracking branch 'origin/master' into develop 2026-02-10 07:52:13 +00:00
Thanh Son Tran
8a6c081c4a
[Keyboard] Add support Tyson88 (#25699)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Trần Thanh Sơn <son.tt1@teko.vn>
2026-02-09 23:51:34 -08:00
QMK Bot
005b778164 Merge remote-tracking branch 'origin/master' into develop 2026-02-09 01:00:12 +00:00
Joel Challis
b6d46cdc47
Allow json keymaps to include a user provided keymap.h (#25987) 2026-02-09 08:59:34 +08:00
QMK Bot
efafbacb49 Merge remote-tracking branch 'origin/master' into develop 2026-02-06 07:15:00 +00:00
Nate Eagleson
6729379041
Fix typo in ergodox-ez's readme (#25985)
Fix typo in readme.md
2026-02-06 15:14:23 +08:00
QMK Bot
02b49f2949 Merge remote-tracking branch 'origin/master' into develop 2026-01-25 00:44:31 +00:00
Drashna Jaelre
38815db760
Fixup tominabox1 le chiffre default keymap (#25966)
* Fixup tominabox1 le chiffre default keymap

* Apply suggestions from code review

Co-authored-by: Jack Sangdahl <jack@pngu.org>

---------

Co-authored-by: Jack Sangdahl <jack@pngu.org>
2026-01-25 08:43:55 +08:00
QMK Bot
b00bdd0354 Merge remote-tracking branch 'origin/master' into develop 2026-01-20 08:49:29 +00:00
Joel Challis
863b308519
Fix avrdude version check logic (#25957) 2026-01-20 08:48:51 +00:00
QMK Bot
b2b8e54b23 Merge remote-tracking branch 'origin/master' into develop 2026-01-15 00:48:14 +00:00
Nick Brassel
127c664647
Backport GitHub Copilot instructions. (#25953) 2026-01-15 11:47:35 +11:00
フィルターペーパー
87a4c6ab25
Copilot instructions for pull requests (#25857)
Co-authored-by: Nick Brassel <nick@tzarc.org>
2026-01-15 09:19:17 +11:00
QMK Bot
c72581474e Merge remote-tracking branch 'origin/master' into develop 2026-01-13 05:49:36 +00:00
Joel Challis
7d66c11f37
Lint default dynamic keymap layer count (#25948) 2026-01-13 16:48:59 +11:00
Joel Challis
adbd077b15
Minor alignment of CLI formatting commands (#25946) 2026-01-11 20:37:34 +00:00
QMK Bot
e5d1cf0105 Merge remote-tracking branch 'origin/master' into develop 2026-01-11 18:18:09 +00:00
Joel Challis
e391793f73
Remove binary symbols from keymaps (#25947) 2026-01-11 18:15:14 +00:00
QMK Bot
bfc1b2b1cf Merge remote-tracking branch 'origin/master' into develop 2026-01-11 17:48:00 +00:00
Álvaro A. Volpato
70c36c6c97
First support for KKC Wily (#25852) 2026-01-11 09:47:23 -08:00
Ryan
fb27ce6bb2
Add missing labels to DD keycode definitions (#25503)
* Add missing labels to DD keycode definitions

* Use subscript numbers for MIDI note labels to avoid confusion with eg. F-keys

* Somehow missed these
2026-01-11 09:47:15 +08:00
Pablo Martínez
fe1c3fc835
[Bugfix] WS2812 indexing in split boards (#25407)
* initial

* oops

* Update quantum/rgb_matrix/rgb_matrix.c

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>

---------

Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2026-01-11 09:00:36 +08:00
Joel Challis
f8d65460c2
Report permission issues in qmk doctor (#25931)
Report permission issues in 'qmk doctor'
2026-01-10 08:23:43 +08:00
QMK Bot
4ba8da2ebb Merge remote-tracking branch 'origin/master' into develop 2026-01-10 00:01:52 +00:00
Thanh Son Tran
56a2e332e1
Update tyson60 pid (#25935)
* Update support S6xty5

* Delete chconf.h

* Update manufacturer, community layout for hhkb

* Update layout

* fix row index

* Update tyson60s

* Update community layout and layout name

* Update remove rgb test mode

* Update capslock led

* Apply suggestions from code review

Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>

* Remove deprecated s6xty5

* Update tyson60 product id

---------

Co-authored-by: Trần Thanh Sơn <son.tt1@teko.vn>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
2026-01-10 08:01:15 +08:00
ms-eevee
df93bfb750
Fixes for is31fl3729 LED matrix driver off-by-one errors (#25902)
Co-authored-by: Evelyn Holloway <dev@evelynonline.ca>
2026-01-09 15:32:55 -08:00
QMK Bot
2b6ed67db4 Merge remote-tracking branch 'origin/master' into develop 2026-01-09 19:51:00 +00:00
dependabot[bot]
e31384babf
Bump JamesIves/github-pages-deploy-action from 4.7.6 to 4.8.0 (#25943)
Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.7.6 to 4.8.0.
- [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases)
- [Commits](https://github.com/jamesives/github-pages-deploy-action/compare/v4.7.6...v4.8.0)

---
updated-dependencies:
- dependency-name: JamesIves/github-pages-deploy-action
  dependency-version: 4.8.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-01-09 19:50:23 +00:00
QMK Bot
536a0a78b4 Merge remote-tracking branch 'origin/master' into develop 2026-01-08 05:37:18 +00:00
Joel Challis
a0b15d08bc
Short term fix for avr-libc@2.3.0 (#25938) 2026-01-08 16:36:40 +11:00
ijouw
e1c41f1b08
Match Key override index type to bounds type to prevent overflow (#25939)
Use uint16_t to store key override index

Co-authored-by: simon <ijouwy@gmail.com>
2026-01-08 08:41:46 +08:00
QMK Bot
f749cf9940 Merge remote-tracking branch 'origin/master' into develop 2026-01-07 21:08:42 +00:00
Stefan Gluszek
3d591a2000
Update fatotesa keyboard config. (#25811) 2026-01-07 21:08:05 +00:00
Joel Challis
259320ca27
Lint out-of-bounds bootmagic config (#25899)
* Lint OOB bootmagic config

* lint
2026-01-07 18:37:51 +08:00
QMK Bot
85b79cc578 Merge remote-tracking branch 'origin/master' into develop 2026-01-07 10:24:53 +00:00
Joel Challis
1e683923e1
Handle broken symlinks in qmk doctor udev checks (#25934)
Handle broken symlinks in 'qmk doctor' udev checks
2026-01-07 18:24:16 +08:00
QMK Bot
743c8a229f Merge remote-tracking branch 'origin/master' into develop 2026-01-03 23:01:29 +00:00
Pascal Getreuer
3194862502
docs/tap_hold.md fixes: Note that Chordal Hold supports multiple same-side mods and fix heading for Speculative Hold. (#25924)
* Note Chordal Hold supports multiple same-side mods.

* Fix "Speculative Hold" heading from H3 -> H2.
2026-01-04 07:00:50 +08:00
QMK Bot
c5795dd8d7 Merge remote-tracking branch 'origin/master' into develop 2026-01-03 20:32:57 +00:00
Ed Flanagan
8c035c2116
Fix small typo in WS2812 driver doc (#25928)
`ws812` -> `ws2812`
2026-01-03 20:18:41 +00:00
QMK Bot
e159fbefc5 Merge remote-tracking branch 'origin/master' into develop 2026-01-03 19:46:07 +00:00
nullptr
91a9f9e492
Fix RGB Matrix Typing Heatmap overflow (#25915) 2026-01-03 19:45:29 +00:00
QMK Bot
3dc83cd244 Merge remote-tracking branch 'origin/master' into develop 2026-01-03 13:55:57 +00:00
Jack Sangdahl
ddeaa26fef
Add .env, .envrc to gitignore (#25904) 2026-01-03 13:55:17 +00:00
QMK Bot
1051fae08d Merge remote-tracking branch 'origin/master' into develop 2026-01-03 13:53:49 +00:00
Aymeric Wibo
f3a16ef21d
Fix typos in Aleblazer Zodiark readme (#25925) 2026-01-03 13:53:13 +00:00
QMK Bot
0d08ebb70a Merge remote-tracking branch 'origin/master' into develop 2026-01-01 12:19:53 +00:00
QMK Bot
99b5b9ab7f
[CI] Regenerate Files (#25920)
Regenerate Files
2026-01-01 12:19:14 +00:00
QMK Bot
389ec6df82 Merge remote-tracking branch 'origin/master' into develop 2026-01-01 08:38:02 +00:00
Piervit
6a5610a8be
Fix functions layer_debug and default_layer_debug (#25913)
Co-authored-by: Joel Challis <git@zvecr.com>
2026-01-01 00:37:25 -08:00
QMK Bot
4f451a76f2 Merge remote-tracking branch 'origin/master' into develop 2025-12-25 00:25:27 +00:00
Joel Challis
acbeec29da
Reduce frequency of automatic workflow run approval (#25896) 2025-12-25 00:24:50 +00:00
QMK Bot
e05516d817 Merge remote-tracking branch 'origin/master' into develop 2025-12-23 00:01:39 +00:00
Danny
7e35cdda8a
Add FoldKB Rev. 2.1 with added underglow RGB LEDs (#25885) 2025-12-23 00:00:57 +00:00
Joel Challis
ae05baf08b
Fix out-of-bounds bootmagic config (#25898) 2025-12-22 16:09:49 +00:00
Joel Challis
c1161a7a32
Refactor core use of deprecated isLeftHand (#25888) 2025-12-21 20:52:55 +00:00
Joel Challis
f82d4d8680
Refactor keyboard/keymap use of deprecated isLeftHand (#25891) 2025-12-21 20:52:48 +00:00
QMK Bot
d420bcad33 Merge remote-tracking branch 'origin/master' into develop 2025-12-21 04:08:20 +00:00
Joel Challis
dba60e2e65
Re-fix building of XAP keymaps on master/develop (#25892) 2025-12-21 15:07:40 +11:00
QMK Bot
7f9c8429e4 Merge remote-tracking branch 'origin/master' into develop 2025-12-20 20:34:36 +00:00
Joel Challis
c68281b353
Handle building of XAP keymaps on master/develop (#25848) 2025-12-21 07:33:58 +11:00
Joshua Diamond
41c2a7b070
Include userspace version (QMK_USERSPACE_VERSION) in version.h (#25882)
* Include userspace version in version.h

* Update lib/python/qmk/cli/generate/version_h.py

Co-authored-by: Joel Challis <git@zvecr.com>

* Update lib/python/qmk/cli/generate/version_h.py

Co-authored-by: Joel Challis <git@zvecr.com>

* Update lib/python/qmk/cli/generate/version_h.py

Co-authored-by: Joel Challis <git@zvecr.com>

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2025-12-18 22:23:51 -05:00
QMK Bot
bc8218371e Merge remote-tracking branch 'origin/master' into develop 2025-12-19 02:27:38 +00:00
Joel Challis
84d44e6188
Update bootstrap_testing.yml 2025-12-19 02:26:58 +00:00
QMK Bot
27c2960320 Merge remote-tracking branch 'origin/master' into develop 2025-12-19 02:24:07 +00:00
Joel Challis
54e8fad959
Ignore merge commits on bootstrap testing PRs (#25884) 2025-12-19 02:23:29 +00:00
QMK Bot
42a7969d4a Merge remote-tracking branch 'origin/master' into develop 2025-12-15 00:21:42 +00:00
Joel Challis
2c847b0350
Consistently install branch specific dependencies in CI (#25874) 2025-12-15 00:21:06 +00:00
QMK Bot
13f3f189b4 Merge remote-tracking branch 'origin/master' into develop 2025-12-12 21:17:32 +00:00
dependabot[bot]
e1c869b8da
Bump actions/download-artifact from 6 to 7 (#25873)
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-12 21:16:52 +00:00
QMK Bot
63a1d506a0 Merge remote-tracking branch 'origin/master' into develop 2025-12-12 20:11:55 +00:00
dependabot[bot]
9e0118172f
Bump actions/upload-artifact from 5 to 6 (#25872)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 5 to 6.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-12 20:11:19 +00:00
QMK Bot
ca8105eac0 Merge remote-tracking branch 'origin/master' into develop 2025-12-12 18:31:29 +00:00
Joel Challis
4f9582da26
Install branch specific dependencies as part of bootstrap testing (#25871) 2025-12-12 18:30:46 +00:00
QMK Bot
f39fc08338 Merge remote-tracking branch 'origin/master' into develop 2025-12-12 18:19:07 +00:00
Joshua Diamond
2e68ddc826
Fix broken compilation when OS_DETECTION_DEBUG_ENABLE is defined (#25869)
Fix include in os_detection (broken in https://github.com/qmk/qmk_firmware/pull/24356)
2025-12-12 18:17:42 +00:00
QMK Bot
1be7cde61f Merge remote-tracking branch 'origin/master' into develop 2025-12-10 19:12:54 +00:00
dependabot[bot]
c1fedab457
Bump peter-evans/create-pull-request from 7 to 8 (#25868)
Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 7 to 8.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](https://github.com/peter-evans/create-pull-request/compare/v7...v8)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-10 19:12:17 +00:00
QMK Bot
6585a244fb Merge remote-tracking branch 'origin/master' into develop 2025-12-10 19:12:03 +00:00
dependabot[bot]
2929448605
Bump JamesIves/github-pages-deploy-action from 4.7.5 to 4.7.6 (#25867)
Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.7.5 to 4.7.6.
- [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases)
- [Commits](https://github.com/jamesives/github-pages-deploy-action/compare/v4.7.5...v4.7.6)

---
updated-dependencies:
- dependency-name: JamesIves/github-pages-deploy-action
  dependency-version: 4.7.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-10 19:11:25 +00:00
QMK Bot
e37a611977 Merge remote-tracking branch 'origin/master' into develop 2025-12-09 19:16:43 +00:00
dependabot[bot]
b39661de96
Bump JamesIves/github-pages-deploy-action from 4.7.4 to 4.7.5 (#25865)
Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.7.4 to 4.7.5.
- [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases)
- [Commits](https://github.com/jamesives/github-pages-deploy-action/compare/v4.7.4...v4.7.5)

---
updated-dependencies:
- dependency-name: JamesIves/github-pages-deploy-action
  dependency-version: 4.7.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-09 19:16:07 +00:00
QMK Bot
a5d7e04c66 Merge remote-tracking branch 'origin/master' into develop 2025-12-09 19:16:05 +00:00
dependabot[bot]
ff75bce86a
Bump actions/github-script from 6 to 8 (#25866)
Bumps [actions/github-script](https://github.com/actions/github-script) from 6 to 8.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](https://github.com/actions/github-script/compare/v6...v8)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-09 19:15:23 +00:00
Jack Sangdahl
6faca4d663
[Keyboard] Guard encoder behaviour on projectcain/vault* (#25864)
Initial
2025-12-09 11:55:21 +01:00
QMK Bot
34c2e99fb3 Merge remote-tracking branch 'origin/master' into develop 2025-12-09 04:16:18 +00:00
Sắn
0881e0867b
Add support for Kami65 PCB (#24604)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-12-08 20:06:24 -08:00
QMK Bot
064d8e9b62 Merge remote-tracking branch 'origin/master' into develop 2025-12-09 03:44:09 +00:00
Philip
e6e66a9f2e
Update dactyl_manuform 5x8 keyboard.json (#24778) 2025-12-08 19:33:02 -08:00
lental
e2d19eda57
Add queue.len() keyboard (#24823)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-12-08 19:30:39 -08:00
Joel Challis
10faca0b85
Move shutdown delay to audio feature (#25859) 2025-12-08 19:14:46 -08:00
Joel Challis
c1b8b3dc6a
Revert test commit 2025-12-09 00:22:31 +00:00
QMK Bot
89cf023d89 Merge remote-tracking branch 'origin/master' into develop 2025-12-09 00:22:02 +00:00
Joel Challis
73a6496516
Trigger develop docs rebuild on push (#25863) 2025-12-09 00:21:25 +00:00
QMK Bot
b68cc43094 Merge remote-tracking branch 'origin/master' into develop 2025-12-08 22:56:39 +00:00
Joel Challis
c8f6e6a936
Revert "Trigger develop docs rebuild on push" (#25862)
Revert "Trigger develop docs rebuild on push (#25860)"

This reverts commit a86322e4a7.
2025-12-08 22:55:58 +00:00
Joel Challis
2b61ca078d
Test commit 2025-12-08 22:44:07 +00:00
QMK Bot
d3d025c337 Merge remote-tracking branch 'origin/master' into develop 2025-12-08 22:32:33 +00:00
Joel Challis
a86322e4a7
Trigger develop docs rebuild on push (#25860) 2025-12-08 22:26:14 +00:00
ploopyco
505e5c7033
Add new mouse "Ploopy Nano 2 Trackball" (#25762) 2025-12-08 14:24:42 -08:00
Diff-fusion
d7c7421784
Fix flash wear leveling sector calculation (#24776) 2025-12-08 21:58:04 +00:00
QMK Bot
b08704f078 Merge remote-tracking branch 'origin/master' into develop 2025-12-08 20:33:07 +00:00
Jon Colverson
107812ceef
[Keyboard] Add PicoFX (#25704) 2025-12-08 20:31:24 +00:00
QMK Bot
1f4110d742 Merge remote-tracking branch 'origin/master' into develop 2025-12-08 20:25:58 +00:00
Fabian Felix Selbach
de8f05b4c3
[Keyboard] Add support for Alpha FS (#25756) 2025-12-08 20:21:12 +00:00
Joel Challis
57b284dfa9
Refactor Makefile logic for locating keymaps (#25808) 2025-12-08 19:55:06 +00:00
Joel Challis
5b94990c5a
Remove redundant URLs from .json (#25856) 2025-12-08 12:11:21 +00:00
QMK Bot
debba50c33 Merge remote-tracking branch 'origin/master' into develop 2025-12-05 22:26:25 +00:00
psych3r
08e5fcfdf4
Fix USER_PATH resolution on case-insensitive filesystems (#25853)
When QMK_USERSPACE is empty, the wildcard check in build_keyboard.mk
incorrectly matches user home directories on case-insensitive filesystems
(macOS/Windows), causing USER_PATH to resolve to an absolute path instead
of a relative path.

This only affects users whose username matches their user directory name
(e.g., username 'psycher' with home '/Users/psycher' and QMK user dir
'users/psycher').

Fix by checking if QMK_USERSPACE is non-empty before performing the
wildcard check.
2025-12-05 22:25:48 +00:00
Joel Challis
511f1ed9de
Remove unused qmk.keymap.write_file/qmk.keymap.write_json (#25854) 2025-12-04 23:31:52 +00:00
QMK Bot
a71a34eb52 Merge remote-tracking branch 'origin/master' into develop 2025-12-04 20:43:10 +00:00
Ivan Gromov
1322922c42
Add kt356 Mini (#25781)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-12-04 12:42:53 -08:00
Ivan Gromov
16dde871d7
Add kt60HS-T v3 (#25822) 2025-12-04 12:42:33 -08:00
QMK Bot
655883a965 Merge remote-tracking branch 'origin/master' into develop 2025-12-04 12:17:04 +00:00
Jacek Królikowski
d39015a401
[DOCS] Add keycodes to info.json docs. More precise matrix masking info (#25801) 2025-12-04 12:15:43 +00:00
QMK Bot
a201bf9398 Merge remote-tracking branch 'origin/master' into develop 2025-12-04 12:15:14 +00:00
sigman
bf0b88c423
Adapt MIUNI32 keyboard for VIA configurator (#25803) 2025-12-04 12:14:37 +00:00
QMK Bot
c2eeeba2e9 Merge remote-tracking branch 'origin/master' into develop 2025-12-04 12:13:57 +00:00
tyler
d4f04fe850
Simplify docs for Key Overrides config (#25787) 2025-12-04 12:13:20 +00:00
zvecr
a4320e4890 Branch point for 2026q1 Breaking Change. 2025-12-01 22:48:34 +00:00
zvecr
b315b707e6 Merge branch 'develop' 2025-12-01 22:07:33 +00:00
zvecr
e10429baae Merge point for 2025q4 breaking changes. 2025-12-01 22:03:23 +00:00
Joel Challis
0e6b73c9ff
2025q4 develop changelog (#25845) 2025-12-01 21:47:16 +00:00
QMK Bot
d45b967cf2 Merge remote-tracking branch 'origin/master' into develop 2025-12-01 01:46:53 +00:00
Joel Challis
e2bf515df4
Fix python format warnings (#25841) 2025-12-01 12:17:13 +11:00
Joel Challis
2cac8b587f
Remove macos-13 runner from bootstrap testing (#25843) 2025-12-01 12:16:25 +11:00
QMK Bot
d383e93526 Merge remote-tracking branch 'origin/master' into develop 2025-12-01 01:16:10 +00:00
Joel Challis
83b42ea9dc
Update Bootstrap testing triggers (#25842) 2025-12-01 12:15:31 +11:00
QMK Bot
43bbb5e99a
[CI] Format code according to conventions (#25828)
Format code according to conventions
2025-11-30 20:46:22 +00:00
QMK Bot
ee60542bd6 Merge remote-tracking branch 'origin/master' into develop 2025-11-30 19:25:52 +00:00
QMK Bot
6ed61c65dd
[CI] Format code according to conventions (#25827)
Format code according to conventions
2025-11-30 19:25:13 +00:00
Joel Challis
b5dfb2bd1e
Partially skip generating community modules when none enabled (#25819) 2025-11-28 08:29:46 +11:00
QMK Bot
ee44cbdedb Merge remote-tracking branch 'origin/master' into develop 2025-11-27 19:47:31 +00:00
dependabot[bot]
330a8597f8
Bump actions/checkout from 4 to 6 (#25829) 2025-11-28 06:46:53 +11:00
QMK Bot
9acd127cc1 Merge remote-tracking branch 'origin/master' into develop 2025-11-27 13:37:29 +00:00
Nick Brassel
9c2ca00074
QMK CLI Environment bootstrapper (#25038)
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Pascal Getreuer <getreuer@google.com>
2025-11-28 00:36:49 +11:00
QMK Bot
9ab8e4cd5a Merge remote-tracking branch 'origin/master' into develop 2025-11-25 10:07:38 +00:00
Danny
594558ec7b
Add Demod LM Rev. 1 (#25793) 2025-11-25 10:07:16 +00:00
andrew morton
5e1b1f5023
Add support for Coffee Break Keyboards' Coffeevan (#25805) 2025-11-25 10:07:01 +00:00
QMK Bot
bbccd8f9cc Merge remote-tracking branch 'origin/master' into develop 2025-11-25 01:32:43 +00:00
Nathan Sunday
cc567c917b
[Keyboard] Add Keenome Keys' "The Grid v2" (#25813)
* Add 'the_grid_v2' to QMK

* Per documentation, formatted keyboard.json and add license to keymap.c

* Update keyboards/keenome_keys/the_grid_v2/keyboard.json

Co-authored-by: Jack Sangdahl <jack@pngu.org>

* Create readme.md for The Grid v2 keyboard

Added detailed readme for The Grid v2 keyboard including setup and bootloader instructions.

* Revise readme for The Grid v2 keyboard

Updated readme with specific hardware details.

---------

Co-authored-by: Jack Sangdahl <jack@pngu.org>
2025-11-24 18:32:03 -07:00
Stephen Ostermiller
1a954e8da5
Reduce tap dance memory usage, move state out of data (#25415)
* Use less tap dance memory.

Use dynamically allocated sparse array for tap dance state, dynamically allocate tap dance state when needed and free it when the tap dance is done.

* new approach

* Use null, check for null

* Reformat with docker

* Use uint8 with idx rather than uint16 with keycode in state

* fix accidental change

* reformat

* Add null check

* add documentation tip suggested by tzarc

* Only allow tap dance state allocation on key down, not on key up

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>

* Only allow tap dance allocation on key down, not on key up

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>

* add user action required section

---------

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
2025-11-23 22:32:36 +11:00
QMK Bot
c7e17538ee
[CI] Format code according to conventions (#25820) 2025-11-23 22:28:34 +11:00
Julian Schuler
b321789d7b
Fix single key combos activating only once (#25198)
Co-authored-by: Julian Schuler <julianschuler@users.noreply.github.com>
2025-11-23 22:25:59 +11:00
Pascal Getreuer
4015c40ba4
[Bug][Core] Fix Speculative Hold to enable also right-handed RSFT, RCTL by default. (#25797) 2025-11-23 22:24:02 +11:00
Joel Challis
53de903fb8
Better defaulting of {RGB,LED}_MATRIX_DEFAULT_FLAGS (#25785) 2025-11-23 22:21:55 +11:00
Xelus22
fd65390496
[core] add BCD versions of QMK Version (#25804)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-11-23 22:21:13 +11:00
Joel Challis
28a11ff6f7
Fix preference of output file for 'qmk generate-autocorrect-data' (#25818) 2025-11-23 05:02:32 +00:00
Jack Sangdahl
1a7f544e0d
[CLI] Lint error on missing keyboard readme (#25814) 2025-11-22 06:57:58 +00:00
Joel Challis
3e0b22af68
Fix community layout keymap discovery (#25802) 2025-11-22 04:30:27 +00:00
QMK Bot
7edb4d2ed8 Merge remote-tracking branch 'origin/master' into develop 2025-11-21 02:13:50 +00:00
dependabot[bot]
81cc69c2dd
Bump actions/checkout from 5 to 6 (#25807)
Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-21 02:13:14 +00:00
QMK Bot
93274019a9 Merge remote-tracking branch 'origin/master' into develop 2025-11-19 03:51:29 +00:00
andrew morton
0fde9c9cac
[Keyboard] Add Coffee Break Keyboards Acai (#25796)
* Add support for Coffee Break Keyboards Acai

* Apply suggestions from code review

Co-authored-by: Jack Sangdahl <jack@pngu.org>

* Ran qmk format-json

* Misssed one of @waffle87's suggestions

* Misssed another of @waffle87's suggestions

* Try hosting on imgur.com

* Remove empty layers, add boot to layer 2

* Enhance the default keymap

* Use correct keycodes for RGB

---------

Co-authored-by: Jack Sangdahl <jack@pngu.org>
2025-11-18 20:50:47 -07:00
QMK Bot
b708a43730 Merge remote-tracking branch 'origin/master' into develop 2025-11-19 03:46:07 +00:00
Joel Challis
5bb7476400
Short term fix for skip_converter KeyError in 'qmk userspace-add' (#25798) 2025-11-19 03:45:29 +00:00
Joel Challis
8eebc613cf
Merge upstream uf2conv changes (#25786) 2025-11-17 02:24:23 +00:00
QMK Bot
a2adc92066 Merge remote-tracking branch 'origin/master' into develop 2025-11-17 02:12:13 +00:00
yiancar
6242c09f7d
Hyper7 v4 (#25728) 2025-11-17 02:10:59 +00:00
QMK Bot
224ea2eb18 Merge remote-tracking branch 'origin/master' into develop 2025-11-17 02:09:46 +00:00
Ivan Gromov
eb5703d12e
Add imi60-HS (#25773) 2025-11-17 02:09:09 +00:00
QMK Bot
921c0039f4 Merge remote-tracking branch 'origin/master' into develop 2025-11-17 02:07:35 +00:00
Joel Challis
bb2ca21647
Fix detection of hid bootloader flashing tool (#25790) 2025-11-17 02:06:59 +00:00
ploopyco
1a4af3adf9
Add PixArt PAW-3222 mouse sensor driver (#25763) 2025-11-12 09:02:52 +11:00
フィルターペーパー
99b1dc84da
Fix Magic GUI masking logic (#25780) 2025-11-12 09:02:08 +11:00
Joel Challis
98504424b1
Align use of keymap level _kb callbacks (#25774) 2025-11-12 09:00:28 +11:00
Joel Challis
8ec3de0f92
Add return code to qmk userspace-doctor (#25775) 2025-11-12 08:59:06 +11:00
Stefan Kerkmann
c68e4dec10
[Core] suspend: suppress wake up keypress (#23389)
* suspend: suppress wake up keypress

Waking the host from suspend is done by pressing any key on the
keyboard, the regular key codes assigned to the keys are not important
and must not be sent - otherwise they usually end up in password prompts
as ghost characters that have to be deleted again. This commit adds
suppression for all keys pressed at the time of wake up. Once a key is
released it functions as a regular key again.

Signed-off-by: Stefan Kerkmann <karlk90@pm.me>

* suspend: update wake up matrix after wake up delay

If USB_SUSPEND_WAKEUP_DELAY is set, the keyboard sleeps during wake up -
which can be up to multiple seconds. To handle key presses and releases
in that time frame we have to handle the following cases:

1. Key not pressed before suspend, and not pressed after wakeup → do
   nothing (normal case).
2. Key not pressed before suspend, but pressed after wakeup → set the
   wakeup_matrix bit to 1 (so that the press and release events would be
   suppressed).
3. Key pressed before suspend, but not pressed after wakeup → do nothing
   (the release event will be generated on the first matrix_task() call
   after the wakeup).
4. Key pressed before suspend, and still pressed after wakeup → do
   nothing (the release event will be generated some time later).

Signed-off-by: Stefan Kerkmann <karlk90@pm.me>
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>

* keyboards: anavi: macropad8: disable snake and rgb_test effects

...to shrink the binary size.
2025-11-11 23:35:03 +11:00
Chaser Huang
1ddcf57382
[Feature Improvement]add option to keep layer state when recording dynamic macros (#24418)
* feat: add option to keep layer state when recording dynamic macros

* Better option macro name and lint changes
2025-11-11 23:30:42 +11:00
QMK Bot
e06d79e9c6 Merge remote-tracking branch 'origin/master' into develop 2025-11-11 12:22:27 +00:00
QMK Bot
019cba746d Merge remote-tracking branch 'origin/master' into develop 2025-11-11 12:21:26 +00:00
Drashna Jaelre
28eeb92f8e
Add I2C Transmit and Receive function (#25637)
* feat: adds a transmit and receive i2c method

* fix: address the i2c transmit and receive length on u16

* Add AVR/LUFA implementation

Didn't add a progmem version, since that would only apply to receive.
Figured it wasn't worth it, but can add.

* Rearrange order of functions

* Add docs

* Fix doc gen error

* Fix lint issues

* fix more lint issues
2025-11-11 23:02:35 +11:00
Pascal Getreuer
efc5d63383
[Core] Speculative Hold option for mod-taps: hold mods instantly while unsettled. (#25572) 2025-11-11 22:27:12 +11:00
QMK Bot
2af9aac61c Merge remote-tracking branch 'origin/master' into develop 2025-11-08 21:02:36 +00:00
QMK Bot
fb6d7762b9 Merge remote-tracking branch 'origin/master' into develop 2025-11-08 20:49:51 +00:00
Joel Challis
6e35013bc2
Generate CUSTOM_MATRIX = lite without matrix_pins.custom (#25453) 2025-11-08 20:48:48 +00:00
QMK Bot
cf05c7d1e4 Merge remote-tracking branch 'origin/master' into develop 2025-11-08 18:44:13 +00:00
QMK Bot
4b393a1ff5 Merge remote-tracking branch 'origin/master' into develop 2025-11-06 23:43:35 +00:00
Joel Challis
01952bf39a
Implement minimal connection update logic (#25334) 2025-11-06 23:34:23 +00:00
フィルターペーパー
1a991ffd24
Guard remapping logic with MAGIC_ENABLE (#25537)
* Only perform key and mod remapping in keycode_config() and mod_config() when MAGIC_ENABLE is defined.
* If not set, these functions now return the original keycode or modifier unchanged.
* Reduces firmware size, and unnecessary code when MAGIC_ENABLE is not enabled.
* Removed space saving suggestion with magic functions from squeezing AVR documentation
2025-11-06 23:03:28 +00:00
Joel Challis
01d81b9550
Rework converter docs (#18314) 2025-11-06 18:36:07 +00:00
QMK Bot
a00177d172 Merge remote-tracking branch 'origin/master' into develop 2025-11-04 23:06:14 +00:00
QMK Bot
b905c246b5 Merge remote-tracking branch 'origin/master' into develop 2025-11-04 07:07:30 +00:00
Alin Marin Elena
547d75145b
add SteelSeries prime, a stripped down prime+ (#24719) 2025-11-04 14:45:08 +11:00
QMK Bot
f1ec600fac Merge remote-tracking branch 'origin/master' into develop 2025-11-04 00:12:57 +00:00
Pablo Jiménez Mateo
c67e4c2cae
Add classic48 keyboard (#25492)
Co-authored-by: Pablo Jimenez Mateo <pablojimenezmateo@gmail.com>
2025-11-01 22:55:16 -07:00
Tvrd Rad Keyboards
5ba424ca17
Add TRKeyboard TRK2 keyboard (#25754)
Co-authored-by: Jack Sangdahl <jack@pngu.org>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-11-01 22:53:04 -07:00
QMK Bot
e7012f4d9e Merge remote-tracking branch 'origin/master' into develop 2025-11-02 00:07:22 +00:00
Nimish Gåtam
8c93a33cd3
making flowtap timer public so it can be used easily with combos (#25731) 2025-11-01 23:17:50 +00:00
QMK Bot
6aade0ecdc Merge remote-tracking branch 'origin/master' into develop 2025-10-30 20:17:21 +00:00
QMK Bot
ce43c98b65 Merge remote-tracking branch 'origin/master' into develop 2025-10-30 20:06:27 +00:00
Nick Brassel
acd7ad37e6
Update ChibiOS-Contrib. (#25751) 2025-10-28 23:32:31 +11:00
Aleks
cbd55b7890
Restrict mouse timer activation to movement keycodes (#25716)
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2025-10-27 15:11:57 +11:00
QMK Bot
dadbec4d46 Merge remote-tracking branch 'origin/master' into develop 2025-10-27 01:19:48 +00:00
Filios92
cb3149b7f2
Fix RGB matrix not syncing and turning off properly on timeout (#25467) 2025-10-26 16:47:04 -07:00
QMK Bot
64c84e64c7 Merge remote-tracking branch 'origin/master' into develop 2025-10-23 10:45:10 +00:00
QMK Bot
a05306d153 Merge remote-tracking branch 'origin/master' into develop 2025-10-23 00:56:13 +00:00
QMK Bot
946d651f57 Merge remote-tracking branch 'origin/master' into develop 2025-10-22 15:20:28 +00:00
QMK Bot
7ea7930b8c Merge remote-tracking branch 'origin/master' into develop 2025-10-21 09:58:58 +00:00
QMK Bot
e91938088a Merge remote-tracking branch 'origin/master' into develop 2025-10-20 01:51:25 +00:00
フィルターペーパー
81df543086
Debounce: Deprecate num_rows parameter (#25632) 2025-10-19 03:14:37 +01:00
Boudewijn van Groos
4f21beb715
Fix drv haptics docs by using the correct function name (#25733) 2025-10-18 22:31:52 +01:00
QMK Bot
18051f1723 Merge remote-tracking branch 'origin/master' into develop 2025-10-18 10:18:38 +00:00
QMK Bot
3eb8d3bea3 Merge remote-tracking branch 'origin/master' into develop 2025-10-14 06:36:00 +00:00
Joel Challis
f4068dbfb0
Update STM32F446 default HSE to 8MHz (#25717) 2025-10-13 06:40:45 +01:00
Marek Schmitt
08405df150
Add new macropad Sharkropad (#24961) 2025-10-11 05:45:17 +01:00
QMK Bot
3c751f217a Merge remote-tracking branch 'origin/master' into develop 2025-10-10 22:18:03 +00:00
Jack Sangdahl
9f1a7380ab
Fixup kprepublic/bm60hsrgb/rev2 (#25644)
* Fixup kprepublic/bm60hsrgb/rev2

- Remove RGBLight configuration and throw error if RGBLight & RGB Matrix
  are enabled together - the WS2812 driver cannot be used for RGBLight
  as it is being used by this keyboard's custom RGB Matrix driver
- Migrate RGB Matrix configuration to DD
- Migrate default keymap to JSON
- Use short SPDX license headers

* Fix OOB coordinate
2025-10-08 08:01:26 -06:00
Jack Sangdahl
7dca4e8bda
Fixup kprepublic/bm60hsrgb_iso/rev2 (#25648)
Fixup kprepublic/bm60hsrgb_iso/rev2

- Remove RGBLight configuration and throw error if RGBLight & RGB Matrix
  are enabled together - the WS2812 driver cannot be used for RGBLight
  as it is being used by this keyboard's custom RGB Matrix driver
- Migrate RGB Matrix configuration to DD
- Migrate default keymap to JSON
- Use short SPDX license headers
2025-10-08 08:01:08 -06:00
Jack Sangdahl
0aae222ab6
Fixup kprepublic/bm60hsrgb_poker/rev2 (#25649)
Fixup kprepublic/bm60hsrgb/rev2

- Remove RGBLight configuration and throw error if RGBLight & RGB Matrix
  are enabled together - the WS2812 driver cannot be used for RGBLight
  as it is being used by this keyboard's custom RGB Matrix driver
- Migrate RGB Matrix configuration to DD
- Migrate default keymap to JSON
- Use short SPDX license headers
2025-10-08 08:00:50 -06:00
QMK Bot
475cbd24cf Merge remote-tracking branch 'origin/master' into develop 2025-10-08 03:42:22 +00:00
QMK Bot
81a3249e2c Merge remote-tracking branch 'origin/master' into develop 2025-10-08 02:16:35 +00:00
Pablo Martínez
0550830909
[QP] Minor cleanup and support for RGB888 surface (#25706)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-10-07 19:10:38 -07:00
QMK Bot
8f86f9794e Merge remote-tracking branch 'origin/master' into develop 2025-10-08 01:16:37 +00:00
QMK Bot
e7d861aea7 Merge remote-tracking branch 'origin/master' into develop 2025-10-07 05:21:16 +00:00
Martin W.
02cf2b56fd
Add Royal Kludge RK61 (#25694) 2025-10-06 17:46:41 +01:00
QMK Bot
5d26dcefa0 Merge remote-tracking branch 'origin/master' into develop 2025-10-06 16:45:06 +00:00
Aidan Smith
c7ed9038d7
E7-V2 Implementation (#25594) 2025-10-06 17:38:27 +01:00
QMK Bot
7a69c714b4 Merge remote-tracking branch 'origin/master' into develop 2025-10-06 16:30:46 +00:00
QMK Bot
074c49ee1c Merge remote-tracking branch 'origin/master' into develop 2025-10-06 16:28:07 +00:00
Pascal Hansjosten
466e0856f5
add durgod venus iso support (#25526) 2025-10-06 17:26:16 +01:00
QMK Bot
60cf3c22f7 Merge remote-tracking branch 'origin/master' into develop 2025-10-06 14:31:39 +00:00
Jack Sangdahl
05355bc49d
Fixup rgbkb/pan (#25678)
Tidy up rgbkb/pan

- Migrate g_led_config to DD and fix coordinates
- Remove RGBLight configuration
- Migrate keymaps to JSON
- Move keymap OLED code to keyboard level
- Remove cutom layout selection logic (post_rules.mk)
- Use short SPDX license headers
2025-10-05 21:06:55 -06:00
QMK Bot
74ac4120db Merge remote-tracking branch 'origin/master' into develop 2025-10-05 23:56:24 +00:00
QMK Bot
9a77ad69e6 Merge remote-tracking branch 'origin/master' into develop 2025-10-05 20:50:42 +00:00
QMK Bot
187119ed7f Merge remote-tracking branch 'origin/master' into develop 2025-10-05 20:46:50 +00:00
James Young
fecfc0f7da
atreus: restore intended matrix implementations (#24082)
* `atreus`: restore intended matrix implementations

PR 24010 inadvertently changed the switch matrix for the
`atreus/astar_mirrored` keyboard in removing the `PCBDOWN` configuration
option, and also made PCB up and down implementations available for all
Atreus variants, which is not intended usage.

This commit restores the intended behaviour, and makes all the keymaps
which are currently present agnostic to hardware variant.
2025-10-05 01:47:45 +01:00
Jack Sangdahl
36fd2437b0
Migrate g_led_config to DD (0-9, A) (#25558) 2025-09-30 17:09:31 +01:00
Pablo Martínez
bbd6e8ab34
[Feature] Implement mod_t packed struct (#25168) 2025-09-30 15:52:43 +01:00
QMK Bot
24bc4aef03 Merge remote-tracking branch 'origin/master' into develop 2025-09-29 22:55:23 +00:00
QMK Bot
532fb2f960 Merge remote-tracking branch 'origin/master' into develop 2025-09-29 19:34:39 +00:00
Joel Challis
6f93a86e6e
Add LED/RGB Matrix flags API docs (#25673) 2025-09-29 20:27:07 +01:00
Joel Challis
0a4c1caf20
Add DD {LED,RGB}_MATRIX_DEFAULT_FLAGS support (#25671) 2025-09-29 20:26:47 +01:00
Joel Challis
883465d9fb
Add generic handling to cycle LED/RGB Matrix flags (#24649) 2025-09-22 00:01:23 +01:00
Ryan
115bf771a8
Custom oled fonts cleanup (#25665) 2025-09-21 21:40:30 +10:00
silvinor
a4b112b1ef
[keyboard] Binepad KnobX1 - refactor x1_layer_led function as weak (#25668)
refactor `x1_layer_led` function as weak
2025-09-19 21:37:18 -06:00
QMK Bot
d1b0397d2f Merge remote-tracking branch 'origin/master' into develop 2025-09-19 02:41:39 +00:00
Joel Challis
46231df62d
Tidy Keebio keyboards (#25653) 2025-09-12 20:00:03 +01:00
Joel Challis
b6310b5a15
Remove encoder resolution where duplicating defaults (#25654) 2025-09-12 16:56:06 +01:00
Joel Challis
d34cade5ab
Generate default encoder resolution for sparse config (#25247) 2025-09-12 13:21:49 +01:00
Joel Challis
cf58a8733d
Add DIP Switch map support to keymap.json (#25431) 2025-09-12 10:23:23 +01:00
Joel Challis
3320e98ccf
Migrate eeconfig_init_kb implementations to config (#25422) 2025-09-12 10:23:16 +01:00
Joel Challis
319da7bfdb
Refactor 40percentclub/ut47 (#25571) 2025-09-12 08:13:12 +01:00
Joel Challis
4a4e4aa083
Remove idobao *_DISABLE_UNDERGLOW behaviour (#25638) 2025-09-12 08:12:48 +01:00
Jack Sangdahl
74b0f054c1
Migrate g_led_config to DD (YZ) (#25650) 2025-09-11 18:34:10 +01:00
QMK Bot
6eee1940e8 Merge remote-tracking branch 'origin/master' into develop 2025-09-11 10:14:38 +00:00
QMK Bot
626cf94653 Merge remote-tracking branch 'origin/master' into develop 2025-09-11 10:04:55 +00:00
QMK Bot
494a691f4c Merge remote-tracking branch 'origin/master' into develop 2025-09-11 08:42:59 +00:00
Christian C. Berclaz
f8d677af88
Add D60B tsangan pcb (#25245)
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-09-11 01:19:10 -07:00
QMK Bot
461a1afe57 Merge remote-tracking branch 'origin/master' into develop 2025-09-11 08:17:01 +00:00
QMK Bot
d4fb67fd5b Merge remote-tracking branch 'origin/master' into develop 2025-09-11 08:16:20 +00:00
QMK Bot
3cd8dd6b25 Merge remote-tracking branch 'origin/master' into develop 2025-09-11 00:45:15 +00:00
Jack Sangdahl
a4d10e9f64
Refactor 40percentclub/gherkin (#25608) 2025-09-10 16:33:38 -07:00
Jack Sangdahl
286947b6fa
Refactor 0xcb/splaytoraid (#25609) 2025-09-10 16:33:12 -07:00
Jack Sangdahl
f12902eb16
Refactor 1upkeyboards/sweet16v2 (#25610) 2025-09-10 16:32:48 -07:00
QMK Bot
0351b598f9 Merge remote-tracking branch 'origin/master' into develop 2025-09-10 12:29:59 +00:00
QMK Bot
c113250c4e Merge remote-tracking branch 'origin/master' into develop 2025-09-10 08:53:02 +00:00
フィルターペーパー
633479ced5
Restructure Pixel Rain interval code (#25516)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-09-10 01:41:29 -07:00
Jack Sangdahl
a91de72246
Migrate g_led_config to DD (K7) (#25616) 2025-09-10 09:14:04 +01:00
QMK Bot
50edd425f7 Merge remote-tracking branch 'origin/master' into develop 2025-09-10 08:12:23 +00:00
QMK Bot
514175848e Merge remote-tracking branch 'origin/master' into develop 2025-09-10 01:45:28 +00:00
QMK Bot
7caef16edd Merge remote-tracking branch 'origin/master' into develop 2025-09-10 01:44:04 +00:00
QMK Bot
ff8db0449e Merge remote-tracking branch 'origin/master' into develop 2025-09-09 21:51:51 +00:00
QMK Bot
7772f47f04 Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:42:16 +00:00
QMK Bot
ab61d9cb51 Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:35:52 +00:00
QMK Bot
649bbdeaba Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:34:48 +00:00
Ryan
eda39f4356
Update default OLED font (#25565) 2025-09-09 17:34:33 +01:00
QMK Bot
c3ba5de928 Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:28:48 +00:00
QMK Bot
592ee1b57f Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:27:53 +00:00
Jack Sangdahl
db9b295aa7
Migrate g_led_config to DD (L) (#25617) 2025-09-09 11:50:36 +01:00
Jack Sangdahl
3934a7f3c8
Migrate g_led_config to DD (I) (#25600) 2025-09-09 10:18:16 +01:00
Jack Sangdahl
ed2de21603
Migrate g_led_config to DD (M1) (#25618) 2025-09-09 10:10:34 +01:00
Jack Sangdahl
04978d490a
Migrate g_led_config to DD (M2) (#25619) 2025-09-09 10:09:38 +01:00
Jack Sangdahl
7186a63172
Migrate g_led_config to DD (M3) (#25620) 2025-09-09 10:09:14 +01:00
Jack Sangdahl
ff1900190c
Migrate g_led_config to DD (NO) (#25621) 2025-09-09 10:08:42 +01:00
Jack Sangdahl
2818085d3f
Migrate g_led_config to DD (P) (#25622) 2025-09-09 10:08:20 +01:00
Jack Sangdahl
d17671cd23
Migrate g_led_config to DD (QR) (#25623) 2025-09-09 10:07:47 +01:00
Jack Sangdahl
8f22831f01
Migrate g_led_config to DD (S) (#25624) 2025-09-09 10:07:06 +01:00
Jack Sangdahl
6c96bb5a5a
Migrate g_led_config to DD (TUW) (#25625) 2025-09-09 10:06:12 +01:00
Jack Sangdahl
177ff71d0c
Migrate g_led_config to DD (H) (#25599) 2025-09-09 10:04:40 +01:00
Jack Sangdahl
c1b428bb4e
Migrate g_led_config to DD (JK1) (#25601) 2025-09-09 10:03:52 +01:00
Jack Sangdahl
0828fc4b6f
Migrate g_led_config to DD (K2) (#25602) 2025-09-09 10:03:13 +01:00
Jack Sangdahl
1e8de37aa0
Migrate g_led_config to DD (K3) (#25603) 2025-09-09 10:02:29 +01:00
Jack Sangdahl
9cd3080e22
Migrate g_led_config to DD (K4) (#25605) 2025-09-09 10:02:15 +01:00
Jack Sangdahl
ceefde5ec8
Migrate g_led_config to DD (K5) (#25606) 2025-09-09 10:02:01 +01:00
Jack Sangdahl
3a29cdbd7d
Migrate g_led_config to DD (K6) (#25607) 2025-09-09 10:01:17 +01:00
Jack Sangdahl
2d5cb23503
Migrate g_led_config to DD (G) (#25598) 2025-09-09 10:00:32 +01:00
Jack Sangdahl
6aa85699a5
Migrate g_led_config to DD (E, F) (#25561) 2025-09-09 09:59:42 +01:00
Jack Sangdahl
330d195f9a
Migrate g_led_config to DD (D) (#25560) 2025-09-09 09:58:45 +01:00
Jack Sangdahl
4b1b83f42f
Migrate g_led_config to DD (B, C) (#25559) 2025-09-09 09:58:29 +01:00
QMK Bot
f749dedb0d Merge remote-tracking branch 'origin/master' into develop 2025-09-08 06:57:41 +00:00
QMK Bot
e01313e7d0 Merge remote-tracking branch 'origin/master' into develop 2025-09-07 17:25:52 +00:00
フィルターペーパー
4bd5c033c3
Refactor debounce algorithm with static allocation (#25515)
* Refactor debounce counters with direct indexing

* Refactor code to use array indexing for debounce_counters
* Use global MATRIX_ROW_SHIFTER macro

* Refactor debounce algorithm with static allocation

* Converted arrays to static allocation
* Standardised use of MATRIX_ROWS_PER_HAND for array sizing
* Added Doxygen comments for primary debounce functions
* Removed debounce_free()

* Rewrite sym_defer_pr

* Modernise code using sym_defer_pk as template
* Format consistency with other current algorithms

* Use shorter SPDX-License-Identifier

* Remove ChibiOS core memory manager guard
* Keep type definition within DEBOUNCE guard

* Add change log

* Minor optimisation refactor

* Pre-calculate row_offset in per-key matrix loops
* Add inline compiler hints
* Improve readability with blank lines

* Limit elapsed time to the maximum debounce value

* Apply suggestions from code review

Declare counters with "DEBOUNCE_ELAPSED"

Co-authored-by: Joel Challis <git@zvecr.com>

* Update change log to new breaking change date

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2025-09-07 13:34:05 +01:00
QMK Bot
5830b1b5e3 Merge remote-tracking branch 'origin/master' into develop 2025-09-07 12:09:44 +00:00
Ryan
bcc546aa3f
Update USBaspLoader ISP instructions (#25590) 2025-09-07 13:05:34 +01:00
Joel Challis
19527e8399
Remove duplication of RP2040 config defaults (#25563) 2025-09-06 14:48:07 -07:00
フィルターペーパー
d8ce8cd204
Simplify hue calculation in raindrops animation (#25587) 2025-09-06 14:43:01 -07:00
フィルターペーパー
248d7c1d6d
Simplify tap_code16_delay (#25595)
* Replaced for-loop with single wait_ms(delay) call
* Improve code consistency with tap_code_delay
2025-09-06 10:04:42 +01:00
Nick Brassel
9455c6adec
Branch point for 2025q4 breaking changes 2025-09-06 17:57:39 +10:00
Nick Brassel
6619ea4441
Merge branch 'master' into develop 2025-09-06 17:57:11 +10:00
3108 changed files with 56214 additions and 25709 deletions

243
.github/copilot-instructions.md vendored Normal file
View file

@ -0,0 +1,243 @@
---
applyTo: "keyboards/**"
excludeAgent:
- "coding-agent"
---
# GitHub Copilot Instructions for QMK Pull Request Review
This document provides automated review guidance based on the [QMK PR Checklist](https://docs.qmk.fm/pr_checklist) and it is intended only for use by GitHub Copilot code-review agent during pull request reviews.
> **Scope**: This review applies **only to changes within the `keyboards/` folder**. Changes outside `keyboards/` (e.g., core code, quantum, platforms, drivers) must be flagged and deferred to a QMK Collaborator — do not review them.
## General PR Requirements
### Branch and Submission Standards
- **Source Branch Policy**: Verify PR is NOT submitted from submitter's own `master` branch
- Flag if submitter is using their own `master` branch as source
- Suggest using feature branches instead for cleaner fork management
- **Target Branch Policy**:
- **New keyboard additions** → `master` branch (new folders under `keyboards/`)
- **All other changes** → `develop` branch:
- Keyboard updates, refactors, or moves
- Core code changes
- Data-driven configuration migrations
- Any modifications to existing keyboards
- **PR Scope**: PRs should contain the smallest set of modifications for a single change
- Flag PRs that modify multiple keyboards simultaneously
- Suggest splitting large PRs into focused, incremental changes
- **Merge Conflicts**: Check for unresolved merge conflicts
### File Naming and Structure
- **Lowercase Requirement**: All new directories and filenames must be lowercase
- Exception: Upstream sources with original uppercase (LUFA, ChibiOS)
- Exception: Core files with valid justification
- **Reject**: Board designer preference for uppercase is NOT valid justification
### License Headers
- **Required**: Valid license headers on all `*.c` and `*.h` files
- **Recommended**: GPL2/GPL3 for consistency
- **Format**: Check for proper GPL2+ header or SPDX identifier
```c
// Copyright 2024 Your Name (@yourgithub)
// SPDX-License-Identifier: GPL-2.0-or-later
```
- **Exception**: Simple assignment-only `rules.mk` files don't need headers
- **Flag**: Missing or ambiguous license headers (blocks merge)
---
## Keymap PR Reviews
**Scope**: These rules apply to files within `keyboards/*/keymaps/*` subdirectories.
### Note on Non-Default Keymaps
- Any keymap folder named something other than `default` (e.g., `default_clueboard`, `via`) is a non-default keymap
- **Do not review the content** of non-default keymaps — flag their presence and note that a QMK Collaborator must review them
### Keymap Code Standards
- **Includes**: `#include QMK_KEYBOARD_H` preferred over specific board files
- **Enums**: Suggest using layer enums instead of `#define`s for layers (soft suggestion only)
- **Custom Keycodes**: First entry must be `QK_USER`
- **VIA**: Keymaps should NOT enable VIA
- VIA keymaps belong in [VIA QMK Userspace](https://github.com/the-via/qmk_userspace_via)
---
## Keyboard PR Reviews
**Scope**: These rules apply to keyboard-level files in `keyboards/*` directories, excluding files within the `keymaps/` subdirectories. This includes:
- `info.json` or `keyboard.json` (keyboard root or variant level)
- `readme.md` (keyboard level)
- `rules.mk` (keyboard level)
- `config.h` (keyboard level, not keymap level)
- `<keyboard>.c` and `<keyboard>.h` files
- Hardware configuration files (`halconf.h`, `mcuconf.h`, `chconf.h`)
### Branch Targeting
- **New Keyboards**: Target `master` branch
- New additions to `keyboards/` folder submit to `master`
- **Keyboard Moves**: Must target `develop` branch
- Check `data/mappings/keyboard_aliases.hjson` is updated for moves
- **Keyboard Updates/Refactors**: Must target `develop` to reduce merge conflicts
- **Data Driven Migration**: Must target `develop`
### info.json and keyboard.json Requirements
- **Schema Validation**: Verify that `info.json` and `keyboard.json` files are valid JSON (no syntax errors, no trailing commas, properly closed brackets)
- **Mandatory Elements**:
- `url` field is present and begins with `http://` or `https://`
- `maintainer` field is present and non-empty
- `usb.vid` and `usb.pid` fields are present and match the `0x` hexadecimal format (e.g. `"vid": "0x1234"`, `"pid": "0xFEED"`)
- `usb.device_version` field is present
- Each key entry in every `layout` array must include a `"matrix"` property (e.g. `{"label": "L01", "matrix": [0, 0], "x": 0, "y": 0}`)
- Microcontroller and bootloader specified
- Diode direction (if not using direct pins)
- **Layout Naming**:
- Single layout: Must be named `LAYOUT` or match `LAYOUT_*` pattern
- Multiple layouts: Must include `LAYOUT_all` plus at least one alternate name
### readme.md Requirements
- **Template**: Must follow [official template](https://github.com/qmk/qmk_firmware/blob/master/data/templates/keyboard/readme.md)
- **Flash Command**: Present with `:flash` at end
- **Hardware Link**: Valid availability link (unless handwired)
- Private groupbuys acceptable
- Open-source should link to files
- **Reset Instructions**: Bootloader reset instructions must be present (non-empty)
- **Images**: A keyboard image is preferred but not mandatory
- If present, images must not be hosted in the repository
- If an imgur URL is used, it must link directly to the image (i.e. `https://i.imgur.com/<id>.<ext>`), not the preview page (i.e. not `https://imgur.com/<id>`)
### rules.mk Standards
- **Removed Items**:
- Size comments like `(-/+size)`
### config.h Standards (Keyboard Level)
- **Prohibited**:
- `#define DESCRIPTION`
- Comment blocks explaining features
- Commented-out unused defines
- `#include "config_common.h"`
- **No Vial**: Vial-related files/changes not accepted
### Keyboard Implementation Files
#### `<keyboard>.c`
- **Advanced Code Flag**: ⚠️ If a `<keyboard>.c` file is present in the PR, flag it as possible advanced code requiring QMK Collaborator review
#### `<keyboard>.h`
- **Include**: `#include "quantum.h"` at top
- **Layout Macros**: If `LAYOUT` macros are present, suggest moving them to `info.json` or `keyboard.json`
### Default Keymap Standards
**Scope**: These rules specifically apply to files within `keyboards/*/keymaps/default/` directories.
- **Pristine Requirement**: Bare minimum clean slate
- ⚠️ If `keymap.c` contains anything beyond the `keymaps[]` array, or if the `default` keymap folder contains additional `.c` or `.h` files, flag this as possible advanced code requiring QMK Collaborator review
- **Removed Examples**: Delete `QMKBEST`/`QMKURL` macros
- **Tri Layer**: Use Tri Layer feature instead of manual `layer_on/off()` + `update_tri_layer()`
- **Encoder Map**: Use encoder map feature, `encoder_update_user()` may not be present
- **No VIA**: Default keymap should not enable VIA
### Prohibited Files
- **No VIA JSON**: Belongs in [VIA Keyboard Repo](https://github.com/the-via/keyboards)
- **No KLE JSON**: Not used within QMK
- **Single Keyboard Per PR**: A PR must not modify more than one `keyboards/<folder>/` directory
- Flag PRs that touch multiple top-level keyboard folders (e.g., both `keyboards/mykeyboard1/` and `keyboards/mykeyboard2/`) — each keyboard must be a separate PR
- **No Cross-Keyboard Sources**: Don't include files from other keyboard vendors
- Exception: Core files (e.g., `drivers/sensors/pmw3360.c`)
- Use of vendor-specific code (e.g., `wilba_tech/wt_main.c`) only when keyboard exists in the same enclosing vendor folder (e.g. a `wilba_tech` keyboard)
---
## Review Response Templates
### For source master branch usage:
```
⚠️ This PR appears to be submitted from your own `master` branch. For future PRs, we recommend using feature branches instead of committing to your `master`. This makes it easier to keep your fork updated and manage multiple PRs.
See: [Best Practices: Your Fork's Master](https://docs.qmk.fm/newbs_git_using_your_master_branch)
```
### For incorrect target branch:
```
❌ This PR targets the wrong branch:
- **New keyboard additions** should target `master`
- **Keyboard updates/refactors/moves** should target `develop`
Please change the target branch accordingly.
```
### For missing license headers:
```
❌ Missing GPL-compatible license headers on the following files:
- [list files]
Please add GPL2+ headers (GPL2/GPL3 recommended). Example:
\`\`\`c
// Copyright 2024 Your Name (@yourgithub)
// SPDX-License-Identifier: GPL-2.0-or-later
\`\`\`
```
### For non-lowercase filenames:
```
❌ The following files/directories must be lowercase:
- [list files]
Exception: Only valid if from upstream sources (LUFA, ChibiOS) or justified by core consistency.
```
### For config.h violations:
```
⚠️ Found prohibited config.h elements:
- [list specific issues: `#define DESCRIPTION`, `#include "config_common.h"`, comment blocks, commented-out defines]
Please remove these and refer to [Data Driven Configuration](https://docs.qmk.fm/data_driven_config).
```
### For info.json or keyboard.json issues:
```
⚠️ info.json or keyboard.json needs attention:
- [list missing mandatory fields]
- Please run: \`qmk format-json -i path/to/info.json\` (or keyboard.json)
- Validate with: \`qmk lint -kb <keyboard_name>\`
```
### For non-pristine default keymap:
```
⚠️ Default keymap requires collaborator review:
The default `keymap.c` contains code beyond the `keymaps[]` array. The following was detected:
- [describe: extra functions/definitions in keymap.c, or additional .c/.h files in the default keymap folder]
A QMK Collaborator must review this before merging.
```
### For non-default keymaps:
```
⚠️ Non-default keymap detected: `keyboards/[path]/keymaps/[name]/`
This keymap requires a QMK Collaborator to review its content. No automated review of its code was performed.
```
### For `<keyboard>.c` detected:
```
⚠️ `<keyboard>.c` file detected: `keyboards/[path]/[keyboard].c`
This file may contain advanced hardware configuration. A QMK Collaborator must review this before merging.
```
---
## Constraints and Conduct
- **Scope**: Only review changes within the `keyboards/` folder. Flag any changes outside `keyboards/` and defer to a QMK Collaborator without reviewing them.
- Focus reviews on **objective checklist items** that can be automatically verified
- Flag **definite violations** with ❌
- Suggest improvements for **recommendations** with ⚠️
- **Provide specific file/line references** when flagging issues
- **Link to relevant QMK documentation** for each issue
- **Prioritize blocking issues** (license, merge conflicts, branch policy)
- **Be constructive**: Suggest fixes, not just problems
- **Do not review non-default keymaps** — flag their presence and defer to a QMK Collaborator
- **Do not review `<keyboard>.c` content in detail** — flag its presence and defer to a QMK Collaborator
This is meant as a **first-pass review** to catch common issues before human review. Complex architectural decisions, code quality, and subjective assessments still require human QMK Collaborator review.

View file

@ -25,7 +25,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
fetch-depth: 1
persist-credentials: false

View file

@ -4,7 +4,7 @@ permissions: {}
on:
schedule:
- cron: "*/5 * * * *"
- cron: "*/30 * * * *"
jobs:
automatic_approve:

View file

@ -28,7 +28,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
fetch-depth: 0

289
.github/workflows/bootstrap_testing.yml vendored Normal file
View file

@ -0,0 +1,289 @@
name: Bootstrap Script Testing
on:
push:
branches: [master, develop, xap]
paths:
- 'util/env-bootstrap.sh'
- '.github/workflows/bootstrap_testing.yml'
pull_request:
paths:
- 'util/env-bootstrap.sh'
- '.github/workflows/bootstrap_testing.yml'
workflow_dispatch:
permissions:
contents: read
jobs:
prep:
runs-on: ubuntu-latest
outputs:
any_changed: ${{ steps.file_changes.outputs.any_changed }}
steps:
- name: Get changed files
id: file_changes
if: ${{ github.event_name == 'pull_request' }}
uses: tj-actions/changed-files@v47
with:
use_rest_api: true
files: |
util/env-bootstrap.sh
.github/workflows/bootstrap_testing.yml
bootstrap-test-linux:
name: Bootstrap (Linux)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
distribution:
# Ubuntu/Debian based
- debian:11
- debian:12
- debian:13
- ubuntu:22.04
- ubuntu:24.04
- ubuntu:26.04
# RHEL/CentOS/Fedora based
- fedora:42
- fedora:43
- fedora:44
- rockylinux:8
- rockylinux:9
- rockylinux/rockylinux:10
- almalinux:8
- almalinux:9
- almalinux:10
# OpenSUSE based (we skip Tumbleweed as it has issues with package mirrors regularly being out of date)
- opensuse/leap:latest
# Gentoo-based
- gentoo/stage3:latest
# Arch based
- archlinux:latest
- cachyos/cachyos:latest
- manjarolinux/base:latest
container:
image: ${{ matrix.distribution }}
options: --privileged
steps:
- name: Install base dependencies
run: |
# Attempt to run the package installation up to 10 times to mitigate transient network issues
for n in $(seq 1 10); do
{
echo "Attempt #$n of 10 to install base dependencies:"
case "${{ matrix.distribution }}" in
*ubuntu*|*debian*)
apt-get update
apt-get install -y sudo git passwd
;;
*fedora*|*rockylinux*|*almalinux*)
dnf install -y sudo git passwd findutils # findutils=xargs
;;
*suse*)
zypper --non-interactive refresh
zypper --non-interactive install sudo git shadow findutils tar # findutils=xargs
;;
*gentoo*)
emerge-webrsync
emerge --noreplace --ask=n sudo dev-vcs/git shadow findutils # findutils=xargs
;;
*archlinux*|*cachyos*|*manjaro*)
pacman -Syu --noconfirm
pacman -S --noconfirm sudo git
;;
esac
} && break || sleep 10
done
# Fix PAM configuration for sudo in containers
# Fix /etc/shadow permissions - common issue in container environments
chmod 640 /etc/shadow || chmod 400 /etc/shadow || true
# Disable problematic PAM modules that commonly fail in RHEL-like containers
sed -i 's/^session.*pam_systemd.so/#&/' /etc/pam.d/sudo || true
sed -i 's/^session.*pam_loginuid.so/#&/' /etc/pam.d/sudo || true
# Ensure proper sudoers configuration
echo 'Defaults !requiretty' >> /etc/sudoers
echo 'Defaults secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"' >> /etc/sudoers
- name: Checkout repository
uses: actions/checkout@v7
with:
fetch-depth: 1
submodules: recursive
path: qmk_firmware
- name: Create test user
run: |
# Create a test user for the bootstrap script
useradd -m -s /bin/bash -U testuser
echo 'testuser:testpassword' | chpasswd || true
# Configure passwordless sudo
echo "root ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers # some distros complain about root not being in sudoers
echo "testuser ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
# Test sudo functionality
sudo -u testuser whoami || echo "Sudo test failed, but continuing..."
- name: Move QMK repository to test user home
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git -C qmk_firmware remote add upstream https://github.com/qmk/qmk_firmware.git
# Move the QMK repository to the test user's home directory
mv qmk_firmware /home/testuser/qmk_firmware
chown -R testuser:testuser /home/testuser/qmk_firmware
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Ensure the bootstrap script can access sudo
sudo -u testuser --preserve-env=GITHUB_TOKEN bash -c "
export CONFIRM=1
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
cd /home/testuser
bash /home/testuser/qmk_firmware/util/env-bootstrap.sh
"
- name: Install dependencies
run: |
sudo -u testuser bash -c "
/home/testuser/.local/share/uv/tools/qmk/bin/python -m pip install -r /home/testuser/qmk_firmware/requirements.txt
"
- name: Test QMK CLI
run: |
sudo -u testuser bash -c "
export PATH=/home/testuser/.local/bin:\$PATH
cd /home/testuser
qmk setup -y -H /home/testuser/qmk_firmware # setup implies doctor, no need to run it separately
cd /home/testuser/qmk_firmware
qmk mass-compile -j $(nproc) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset -p || touch .failed # Compile a bunch of different platforms
"
cd /home/testuser/qmk_firmware
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1
bootstrap-test-macos:
name: Bootstrap (macOS)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
strategy:
fail-fast: false
matrix:
os:
- macos-14 # Apple Silicon ARM64
- macos-15 # Apple Silicon ARM64
- macos-15-intel # Intel x64
- macos-26 # Apple Silicon ARM64
runs-on: ${{ matrix.os }}
steps:
- name: Checkout repository
uses: actions/checkout@v7
with:
fetch-depth: 1
submodules: recursive
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git remote add upstream https://github.com/qmk/qmk_firmware.git
# Run the bootstrap script
export CONFIRM=1
sh ./util/env-bootstrap.sh
- name: Install dependencies
run: |
$HOME/.local/share/uv/tools/qmk/bin/python -m pip install -r requirements.txt
- name: Test QMK CLI
run: |
# Add QMK CLI to PATH (bootstrap script installs it to ~/.local/bin on macOS)
export PATH="$HOME/.local/bin:$PATH"
qmk setup -y -H . # setup implies doctor, no need to run it separately
qmk mass-compile -j $(sysctl -n hw.ncpu) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset || touch .failed # Compile a bunch of different platforms
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1
bootstrap-test-windows:
name: Bootstrap (Windows)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
strategy:
fail-fast: false
matrix:
msys-variant:
- mingw64
- clang64
- ucrt64
runs-on: windows-latest
defaults:
run:
shell: msys2 {0}
steps:
- name: Install MSYS2
uses: msys2/setup-msys2@v2
with:
msystem: ${{ matrix.msys-variant }}
pacboy: >-
git:
- name: Checkout repository
uses: actions/checkout@v7
with:
fetch-depth: 1
submodules: recursive
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git remote add upstream https://github.com/qmk/qmk_firmware.git
# Run the bootstrap script
export CONFIRM=1
sh ./util/env-bootstrap.sh
- name: Install dependencies
run: |
/opt/uv/tools/qmk/Scripts/python -m pip install -r requirements.txt
- name: Test QMK CLI
run: |
# Add QMK CLI to PATH (bootstrap script installs it to /opt/uv/tools/bin on Windows MSYS2)
export PATH="/opt/uv/tools/bin:$PATH"
qmk setup -y -H . # setup implies doctor, no need to run it separately
qmk mass-compile -j $(nproc) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset || touch .failed # Compile a bunch of different platforms
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1

View file

@ -32,29 +32,36 @@ jobs:
container: ghcr.io/qmk/qmk_cli
outputs:
keymaps: ${{ steps.generate_slice_length.outputs.keymaps }}
slice_length: ${{ steps.generate_slice_length.outputs.slice_length }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v7
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Determine concurrency
id: generate_slice_length
shell: 'bash {0}'
run: |
target_count=$( {
qmk find -km default 2>/dev/null
qmk find -km xap 2>/dev/null
} | sort | uniq | wc -l)
targets=()
target_count=0
for target in "default" "xap"; do
count=$(qmk find -km $target 2>/dev/null | wc -l)
if [ $count -gt 0 ]; then
target_count=$(($target_count + $count))
targets+=($target)
fi
done
keymaps=$(jq -c -n '$ARGS.positional' --args "${targets[@]}")
slice_length=$((target_count / ($CONCURRENT_JOBS - 1))) # Err on the side of caution
echo "keymaps=$keymaps" >> $GITHUB_OUTPUT
echo "slice_length=$slice_length" >> $GITHUB_OUTPUT
build_targets:
@ -63,7 +70,7 @@ jobs:
strategy:
fail-fast: false
matrix:
keymap: [default, xap]
keymap: ${{ fromJson(needs.determine_concurrency.outputs.keymaps) }}
uses: ./.github/workflows/ci_build_major_branch_keymap.yml
with:
branch: ${{ inputs.branch || github.ref_name }}
@ -82,12 +89,12 @@ jobs:
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v7
with:
fetch-depth: 0
- name: Download firmwares
uses: actions/download-artifact@v6
uses: actions/download-artifact@v8
with:
pattern: firmware-*
path: .
@ -125,14 +132,7 @@ jobs:
SOURCE_DIR: .
DEST_DIR: ${{ inputs.branch || github.ref_name }}/latest
- name: Check if failure marker file exists
id: check_failure_marker
uses: andstor/file-existence-action@v3
with:
files: ./.failed
- name: Fail build if needed
if: steps.check_failure_marker.outputs.files_exists == 'true'
run: |
# Exit with failure if the compilation stage failed
exit 1
[ ! -e .failed ] || exit 1

View file

@ -27,30 +27,29 @@ jobs:
targets: ${{ steps.generate_targets.outputs.targets }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v7
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Generate build targets
shell: 'bash {0}'
id: generate_targets
run: |
{ # Intentionally use `shuf` here so that we share manufacturers across all build groups -- some have a lot of ARM-based boards which inherently take longer
counter=0
echo -n '{'
qmk find -km ${{ inputs.keymap }} 2>/dev/null | sort | uniq | shuf | xargs -L${{ inputs.slice_length }} | while IFS=$'\n' read target ; do
qmk find -km ${{ inputs.keymap }} 2>/dev/null | sort | uniq | shuf --random-source=<(openssl enc -aes-256-ctr -pass pass:qmk -nosalt </dev/zero 2>/dev/null) | xargs -L${{ inputs.slice_length }} | while IFS=$'\n' read target ; do
if [ $counter -gt 0 ]; then
echo -n ','
fi
counter=$((counter+1))
printf "\"group %02d\":{" $counter
printf "\"group-%02d\":{" $counter
echo -n '"targets":"'
echo $target | tr ' ' '\n' | sort | uniq | xargs echo -n
echo -n '"}'
@ -62,7 +61,7 @@ jobs:
echo "targets=$(jq -c 'keys' targets.json)" >> $GITHUB_OUTPUT
- name: Upload targets json
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v7
with:
name: targets-${{ inputs.keymap }}
path: targets.json
@ -74,45 +73,76 @@ jobs:
container: ghcr.io/qmk/qmk_cli
continue-on-error: true
env:
CCACHE_CONFIGPATH: ~/.cache
strategy:
matrix:
target: ${{ fromJson(needs.generate_targets.outputs.targets) }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v7
with:
submodules: recursive
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Get target definitions
uses: actions/download-artifact@v6
uses: actions/download-artifact@v8
with:
name: targets-${{ inputs.keymap }}
path: .
- name: Deploy submodules
run: |
qmk git-submodule -f
- name: Dump targets
run: |
jq -r '.["${{ matrix.target }}"].targets' targets.json | tr ' ' '\n' | sort
- name: Restore Cache
id: cache
uses: actions/cache/restore@v6
with:
path: ${{ env.CCACHE_CONFIGPATH }}
key: compile-${{ inputs.keymap }}-${{ matrix.target }}
- name: Build targets
continue-on-error: true
run: |
export NCPUS=$(( $(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || getconf _NPROCESSORS_ONLN 2>/dev/null) -1 ))
qmk mass-compile -t -j $NCPUS -e DUMP_CI_METADATA=yes $(jq -r '.["${{ matrix.target }}"].targets' targets.json) || touch .failed
targets=$(jq -r '.["${{ matrix.target }}"].targets' targets.json | tr ' ' '\n' | sort)
if [ -z "${targets}" ]; then
echo "Zero build targets detected"
exit 0
fi
qmk mass-compile -t -j $(nproc) -e DUMP_CI_METADATA=yes -e USE_CCACHE=yes $targets || touch .failed
- name: Dump ccache stats
run: |
ccache -s
# Delete the old cache on hit to emulate a cache update. See https://github.com/actions/cache/issues/342.
- name: Delete old cache
env:
GH_TOKEN: ${{ github.token }}
if: steps.cache.outputs.cache-hit
run: |
count=$(gh cache list --ref ${{ github.ref }} --key ${{ steps.cache.outputs.cache-primary-key }} --json id | jq length)
if [ $count -gt 0 ]; then
gh cache delete --ref ${{ github.ref }} ${{ steps.cache.outputs.cache-primary-key }}
fi
- name: Save Cache
uses: actions/cache/save@v6
with:
path: ${{ env.CCACHE_CONFIGPATH }}
key: compile-${{ inputs.keymap }}-${{ matrix.target }}
- name: Upload binaries
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v7
with:
name: firmware-${{ inputs.keymap }}-${{ matrix.target }}
if-no-files-found: ignore
@ -136,17 +166,17 @@ jobs:
steps:
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v7
- name: Download firmwares
uses: actions/download-artifact@v6
uses: actions/download-artifact@v8
with:
pattern: firmware-${{ inputs.keymap }}-*
path: .
merge-multiple: true
- name: Upload all firmwares
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v7
with:
name: firmware-${{ inputs.keymap }}
if-no-files-found: ignore
@ -165,7 +195,7 @@ jobs:
truncate --size='<960K' $GITHUB_STEP_SUMMARY || true
- name: Delete temporary build artifacts
uses: geekyeggo/delete-artifact@v5
uses: geekyeggo/delete-artifact@v6
with:
name: |
firmware-${{ inputs.keymap }}-*

View file

@ -24,11 +24,12 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
submodules: recursive
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run tests
run: qmk pytest

34
.github/workflows/develop_docs.yml vendored Normal file
View file

@ -0,0 +1,34 @@
name: Generate Develop Docs
permissions:
contents: write
on:
push:
branches:
- develop
paths:
- 'builddefs/docsgen/**'
- 'tmk_core/**'
- 'quantum/**'
- 'platforms/**'
- 'docs/**'
- '.github/workflows/docs.yml'
jobs:
generate:
runs-on: ubuntu-latest
steps:
- name: Deploy Develop
if: ${{ github.repository == 'qmk/qmk_firmware' }}
uses: actions/github-script@v9
with:
github-token: ${{ secrets.QMK_BOT_TOKEN }}
script: |
const result = await github.rest.actions.createWorkflowDispatch({
owner: 'qmk',
repo: 'qmk_docs_devel',
workflow_id: 'develop.yml',
ref: 'main',
})

View file

@ -15,7 +15,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
token: ${{ secrets.QMK_BOT_TOKEN }}
fetch-depth: 0

View file

@ -30,14 +30,15 @@ jobs:
container: ghcr.io/qmk/qmk_cli
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
fetch-depth: 1
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Install nvm
run: |
apt-get update && apt-get install -y rsync doxygen
# install nvm
touch $HOME/.bashrc
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
@ -56,7 +57,7 @@ jobs:
- name: Deploy
if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
uses: JamesIves/github-pages-deploy-action@v4.7.4
uses: JamesIves/github-pages-deploy-action@v4.8.0
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages

View file

@ -21,7 +21,7 @@ jobs:
- riot
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
token: ${{ secrets.QMK_BOT_TOKEN }}
fetch-depth: 0

View file

@ -26,7 +26,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
fetch-depth: 0

View file

@ -19,7 +19,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
fetch-depth: 0
@ -47,7 +47,7 @@ jobs:
git config user.email 'hello@qmk.fm'
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
uses: peter-evans/create-pull-request@v8
if: ${{ github.repository == 'qmk/qmk_firmware'}}
with:
token: ${{ secrets.QMK_BOT_TOKEN }}

View file

@ -18,7 +18,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
fetch-depth: 0
@ -31,7 +31,7 @@ jobs:
with:
use_rest_api: true
- name: Print info
- name: Print git info
run: |
git rev-parse --short HEAD
echo ${{ github.event.pull_request.base.sha }}
@ -57,7 +57,7 @@ jobs:
if [[ $KEYMAP_ONLY -gt 0 ]]; then
echo "linting ${KB}"
qmk lint --keyboard ${KB} && qmk info -l --keyboard ${KB}
qmk lint --strict --keyboard ${KB} && qmk info -l --keyboard ${KB}
exit_code=$(($exit_code + $?))
fi
done
@ -78,10 +78,21 @@ jobs:
fi
exit $exit_code
- name: Verify keyboard aliases
- name: Reset git repo
if: always()
shell: 'bash {0}'
run: |
git reset --hard
git clean -xfd
- name: Verify keyboard targets
if: always()
shell: 'bash {0}'
run: |
qmk ci-validate-keyboard-targets
- name: Verify keyboard aliases
if: always()
shell: 'bash {0}'
run: |
qmk ci-validate-aliases

View file

@ -8,6 +8,9 @@ on:
paths:
- 'data/constants/**'
- 'lib/python/**'
- 'quantum/rgblight/rgblight_breathe_table.h'
- 'quantum/keycodes.h'
- 'quantum/keymap_extras/**'
jobs:
regen:
@ -19,7 +22,10 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v7
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run qmk generators
run: |

View file

@ -19,7 +19,10 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v7
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run qmk generators
run: |
@ -34,7 +37,7 @@ jobs:
git config user.email 'hello@qmk.fm'
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
uses: peter-evans/create-pull-request@v8
if: ${{ github.repository == 'qmk/qmk_firmware'}}
with:
token: ${{ secrets.QMK_BOT_TOKEN }}

View file

@ -11,6 +11,7 @@ on:
pull_request:
paths:
- 'builddefs/**'
- '!builddefs/docsgen/**'
- 'quantum/**'
- 'platforms/**'
- 'tmk_core/**'
@ -26,10 +27,12 @@ jobs:
container: ghcr.io/qmk/qmk_cli
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v7
with:
submodules: recursive
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run tests
run: qmk test-c
run: qmk test-c -j $(nproc)

2
.gitignore vendored
View file

@ -65,6 +65,8 @@ cmake-build-debug
CMakeLists.txt
*.pdf
*.zip
.env
.envrc
# Let these ones be user specific, since we have so many different configurations
*.code-workspace

View file

@ -1,4 +1,4 @@
ifndef VERBOSE
ifneq ($(VERBOSE),true)
.SILENT:
endif
@ -38,14 +38,17 @@ $(info QMK Firmware $(QMK_VERSION))
endif
endif
# Try to determine userspace from qmk config, if set.
ifeq ($(QMK_USERSPACE),)
QMK_USERSPACE = $(shell qmk config -ro user.overlay_dir | cut -d= -f2 | sed -e 's@^None$$@@g')
endif
# Determine which qmk cli to use
QMK_BIN := qmk
# Try to determine userspace from qmk config, if set. Handle direct query on qmk_cli>=1.1.7
# falling back to legacy method of only supporting user.overlay_dir config
# sort is used to buffer 'qmk env' output and avoid BrokenPipeError errors
export override QMK_USERSPACE := $(shell \
$(QMK_BIN) env | sort | grep -q QMK_USERSPACE \
&& $(QMK_BIN) env QMK_USERSPACE \
|| $(QMK_BIN) config -ro user.overlay_dir | cut -d= -f2 | sed -e 's@^None$$@@g')
# avoid 'Entering|Leaving directory' messages
MAKEFLAGS += --no-print-directory
@ -115,7 +118,7 @@ endef
TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
# As TRY_TO_MATCH_RULE_FROM_LIST_HELPER, but with additional
# resolution of keyboard_aliases.hjson for provided rule
# resolution of keyboard_aliases.hjson for provided rule
define TRY_TO_MATCH_RULE_FROM_LIST_HELPER_KB
# Split on ":", padding with empty strings to avoid indexing issues
TOKEN1:=$$(shell python3 -c "import sys; print((sys.argv[1].split(':',1)+[''])[0])" $$(RULE))
@ -190,41 +193,9 @@ endef
# Parses a rule in the format <keymap>:<target>
# the keyboard is already known when entering this function
define PARSE_KEYBOARD
# If we want to compile the default subproject, then we need to
# include the correct makefile to determine the actual name of it
CURRENT_KB := $1
# 5/4/3/2/1
KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
KEYBOARD_FOLDER_PATH_3 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_2)))
KEYBOARD_FOLDER_PATH_4 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_3)))
KEYBOARD_FOLDER_PATH_5 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_4)))
KEYMAPS :=
# get a list of all keymaps
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/keymaps/*/.)))
ifneq ($(QMK_USERSPACE),)
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/keymaps/*/.)))
endif
KEYBOARD_LAYOUTS := $(shell $(QMK_BIN) list-layouts --keyboard $1)
LAYOUT_KEYMAPS :=
$$(foreach LAYOUT,$$(KEYBOARD_LAYOUTS),$$(eval LAYOUT_KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/layouts/*/$$(LAYOUT)/*/.)))))
ifneq ($(QMK_USERSPACE),)
$$(foreach LAYOUT,$$(KEYBOARD_LAYOUTS),$$(eval LAYOUT_KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/layouts/$$(LAYOUT)/*/.)))))
endif
KEYMAPS := $$(sort $$(KEYMAPS) $$(LAYOUT_KEYMAPS))
KEYMAPS := $(shell $(QMK_BIN) list-keymaps --keyboard $1)
# if the rule after removing the start of it is empty (we haven't specified a kemap or target)
# compile all the keymaps
@ -329,6 +300,7 @@ endef
define BUILD_TEST
TEST_PATH := $1
TEST_NAME := $$(notdir $$(TEST_PATH))
TEST_ID := $$(patsubst ./tests/%,%,$$(TEST_PATH))
TEST_FULL_NAME := $$(subst /,_,$$(patsubst $$(ROOT_DIR)tests/%,%,$$(TEST_PATH)))
MAKE_TARGET := $2
COMMAND := $1
@ -342,7 +314,7 @@ define BUILD_TEST
TEST_MSG := $$(MSG_TEST)
$$(TEST_FULL_NAME)_COMMAND := \
printf "$$(TEST_MSG)\n"; \
$$(TEST_EXECUTABLE); \
$$(TEST_EXECUTABLE) --gtest_color=$$(COLOR); \
if [ $$$$? -gt 0 ]; \
then error_occurred=1; \
fi; \
@ -480,16 +452,17 @@ distclean_userspace: clean
endif
# Extra targets for formatting and/or pytest, running within the qmk/qmk_cli container to match GHA.
CONTAINER_PREAMBLE := export HOME="/tmp"; export PATH="/tmp/.local/bin:\$$PATH"; python3 -m pip install --upgrade pip; python3 -m pip install -r requirements-dev.txt
.PHONY: format-core
format-core:
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk format-c --core-only -a && qmk format-python -a"
RUNTIME=docker ./util/docker_cmd.sh qmk format-c --core-only -a
RUNTIME=docker ./util/docker_cmd.sh qmk format-python -a
.PHONY: pytest
pytest:
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk pytest"
RUNTIME=docker ./util/docker_cmd.sh qmk pytest
.PHONY: format-and-pytest
format-and-pytest:
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk format-c --core-only -a && qmk format-python -a && qmk pytest"
RUNTIME=docker ./util/docker_cmd.sh qmk format-c --core-only -a
RUNTIME=docker ./util/docker_cmd.sh qmk format-python -a
RUNTIME=docker ./util/docker_cmd.sh qmk pytest

View file

@ -1,36 +0,0 @@
# Look for a json keymap file
ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_5)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_5)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_4)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_3)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_2)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_1)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_1)
endif
ifneq ($(QMK_USERSPACE),)
ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
endif
endif

View file

@ -4,7 +4,7 @@
# responsible for determining which folder is being used and doing the
# corresponding environment setup.
ifndef VERBOSE
ifneq ($(VERBOSE),true)
.SILENT:
endif
@ -138,75 +138,12 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/keyboard.json
endif
MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
# Pull in rules from DD keyboard config
INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --output $(INTERMEDIATE_OUTPUT)/src/info_rules.mk)
include $(INFO_RULES_MK)
# Check for keymap.json first, so we can regenerate keymap.c
include $(BUILDDEFS_PATH)/build_json.mk
# Pull in keymap level rules.mk
ifeq ("$(wildcard $(KEYMAP_PATH))", "")
# Look through the possible keymap folders until we find a matching keymap.c
ifneq ($(QMK_USERSPACE),)
ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
endif
endif
ifeq ($(KEYMAP_PATH),)
ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_1)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_1)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_2)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_2)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_3)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_3)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_4)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_4)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_5)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_5)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
else ifneq ($(LAYOUTS),)
# If we haven't found a keymap yet fall back to community layouts
include $(BUILDDEFS_PATH)/build_layout.mk
else ifeq ("$(wildcard $(KEYMAP_JSON_PATH))", "") # Not finding keymap.c is fine if we found a keymap.json
$(call CATASTROPHIC_ERROR,Invalid keymap,Could not find keymap)
# this state should never be reached
endif
endif
endif
include $(BUILDDEFS_PATH)/locate_keymap.mk
-include $(KEYMAP_PATH)/rules.mk
# Have we found a keymap.json?
ifneq ("$(wildcard $(KEYMAP_JSON))", "")
@ -217,16 +154,9 @@ ifneq ("$(wildcard $(KEYMAP_JSON))", "")
OPT_DEFS += -DOTHER_KEYMAP_C=\"$(OTHER_KEYMAP_C)\"
endif
KEYMAP_PATH := $(KEYMAP_JSON_PATH)
KEYMAP_C := $(INTERMEDIATE_OUTPUT)/src/keymap.c
KEYMAP_H := $(INTERMEDIATE_OUTPUT)/src/config.h
ifeq ($(OTHER_KEYMAP_C),)
# Load the keymap-level rules.mk if exists (and we havent already loaded it for keymap.c)
-include $(KEYMAP_PATH)/rules.mk
endif
# Load any rules.mk content from keymap.json
INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/rules.mk $(KEYMAP_JSON))
include $(INFO_RULES_MK)
@ -255,6 +185,13 @@ endif
COMMUNITY_RULES_MK = $(shell $(QMK_BIN) generate-community-modules-rules-mk -kb $(KEYBOARD) --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/community_rules.mk $(KEYMAP_JSON))
include $(COMMUNITY_RULES_MK)
ifneq ($(COMMUNITY_MODULES),)
$(INTERMEDIATE_OUTPUT)/src/community_post_config.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-community-post-config-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_post_config.h $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/community_modules.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-community-modules-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(KEYMAP_JSON))
@ -285,9 +222,17 @@ $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc: $(KEYMAP_JSON) $(DD
$(eval CMD=$(QMK_BIN) generate-rgb-matrix-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/split_transaction_id_community_modules.inc: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-split-transaction-id-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/split_transaction_id_community_modules.inc $(KEYMAP_JSON))
@$(BUILD_CMD)
COMMUNITY_POST_CONFIG_H = $(INTERMEDIATE_OUTPUT)/src/community_post_config.h
SRC += $(INTERMEDIATE_OUTPUT)/src/community_modules.c
generated-files: $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(INTERMEDIATE_OUTPUT)/src/community_modules.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc
generated-files: $(INTERMEDIATE_OUTPUT)/src/community_post_config.h $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(INTERMEDIATE_OUTPUT)/src/community_modules.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc $(INTERMEDIATE_OUTPUT)/src/split_transaction_id_community_modules.inc
endif
include $(BUILDDEFS_PATH)/converters.mk
@ -427,6 +372,10 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
endif
ifneq ($(COMMUNITY_POST_CONFIG_H),)
POST_CONFIG_H += $(COMMUNITY_POST_CONFIG_H)
endif
CONFIG_H += $(INTERMEDIATE_OUTPUT)/src/info_config.h
KEYBOARD_SRC += $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c
@ -470,8 +419,10 @@ ifneq ($(wildcard $(QMK_USERSPACE)),)
endif
# If the equivalent users directory exists in userspace, use that in preference to anything currently in the main repo
ifneq ($(wildcard $(QMK_USERSPACE)/$(USER_PATH)),)
USER_PATH := $(QMK_USERSPACE)/$(USER_PATH)
ifneq ($(QMK_USERSPACE),)
ifneq ($(wildcard $(QMK_USERSPACE)/$(USER_PATH)),)
USER_PATH := $(QMK_USERSPACE)/$(USER_PATH)
endif
endif
# Pull in user level rules.mk

View file

@ -1,36 +0,0 @@
LAYOUTS_PATH := layouts
LAYOUTS_REPOS := $(patsubst %/,%,$(sort $(dir $(wildcard $(LAYOUTS_PATH)/*/))))
ifneq ($(QMK_USERSPACE),)
LAYOUTS_REPOS += $(patsubst %/,%,$(QMK_USERSPACE)/$(LAYOUTS_PATH))
endif
define SEARCH_LAYOUTS_REPO
LAYOUT_KEYMAP_PATH := $$(LAYOUTS_REPO)/$$(LAYOUT)/$$(KEYMAP)
LAYOUT_KEYMAP_JSON := $$(LAYOUT_KEYMAP_PATH)/keymap.json
LAYOUT_KEYMAP_C := $$(LAYOUT_KEYMAP_PATH)/keymap.c
ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_JSON))","")
-include $$(LAYOUT_KEYMAP_PATH)/rules.mk
KEYMAP_JSON := $$(LAYOUT_KEYMAP_JSON)
KEYMAP_PATH := $$(LAYOUT_KEYMAP_PATH)
else ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_C))","")
-include $$(LAYOUT_KEYMAP_PATH)/rules.mk
KEYMAP_C := $$(LAYOUT_KEYMAP_C)
KEYMAP_PATH := $$(LAYOUT_KEYMAP_PATH)
endif
endef
define SEARCH_LAYOUTS
$$(foreach LAYOUTS_REPO,$$(LAYOUTS_REPOS),$$(eval $$(call SEARCH_LAYOUTS_REPO)))
endef
ifneq ($(FORCE_LAYOUT),)
ifneq (,$(findstring $(FORCE_LAYOUT),$(LAYOUTS)))
$(info Forcing layout: $(FORCE_LAYOUT))
LAYOUTS := $(FORCE_LAYOUT)
else
$(call CATASTROPHIC_ERROR,Invalid layout,Forced layout does not exist)
endif
endif
$(foreach LAYOUT,$(LAYOUTS),$(eval $(call SEARCH_LAYOUTS)))

View file

@ -1,4 +1,4 @@
ifndef VERBOSE
ifneq ($(VERBOSE),true)
.SILENT:
endif

View file

@ -98,6 +98,7 @@ endif
VALID_STENO_PROTOCOL_TYPES := geminipr txbolt all
STENO_PROTOCOL ?= all
ifeq ($(strip $(STENO_ENABLE)), yes)
ifeq ($(filter $(STENO_PROTOCOL),$(VALID_STENO_PROTOCOL_TYPES)),)
$(call CATASTROPHIC_ERROR,Invalid STENO_PROTOCOL,STENO_PROTOCOL="$(STENO_PROTOCOL)" is not a valid stenography protocol)
@ -125,7 +126,7 @@ ifeq ($(strip $(MOUSEKEY_ENABLE)), yes)
MOUSE_ENABLE := yes
endif
VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick azoteq_iqs5xx cirque_pinnacle_i2c cirque_pinnacle_spi paw3204 pmw3320 pmw3360 pmw3389 pimoroni_trackball custom
VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick azoteq_iqs5xx cirque_pinnacle_i2c cirque_pinnacle_spi paw3204 paw3222 pmw3320 pmw3325 pmw3360 pmw3389 pimoroni_trackball custom
ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
ifeq ($(filter $(POINTING_DEVICE_DRIVER),$(VALID_POINTING_DEVICE_DRIVER_TYPES)),)
$(call CATASTROPHIC_ERROR,Invalid POINTING_DEVICE_DRIVER,POINTING_DEVICE_DRIVER="$(POINTING_DEVICE_DRIVER)" is not a valid pointing device type)
@ -157,6 +158,10 @@ ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
SRC += drivers/sensors/cirque_pinnacle.c
SRC += drivers/sensors/cirque_pinnacle_gestures.c
SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_gestures.c
else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), paw3222)
SPI_DRIVER_REQUIRED = yes
else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), pmw3325)
SPI_DRIVER_REQUIRED = yes
else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), pimoroni_trackball)
I2C_DRIVER_REQUIRED = yes
else ifneq ($(filter $(strip $(POINTING_DEVICE_DRIVER)),pmw3360 pmw3389),)

View file

@ -50,15 +50,19 @@ ifeq ($(strip $(DEBUG_ENABLE)),yes)
CFLAGS += -ggdb3
CXXFLAGS += -ggdb3
ASFLAGS += -ggdb3
# Create a map file when debugging
LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
endif
# Create a map file to see what was compiled and where, unless disabled
# (e.g. test builds, which use the host linker — Apple's ld does not accept
# -Map=/--cref).
ifneq ($(strip $(CREATE_MAP)), no)
LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
endif
#---------------- C Compiler Options ----------------
ifeq ($(strip $(LTO_ENABLE)), yes)
CDEFS += -flto
CDEFS += -flto=auto
CDEFS += -DLTO_ENABLE
endif
@ -66,12 +70,14 @@ CFLAGS += $(CDEFS)
CFLAGS += -O$(OPT)
# add color
ifeq ($(COLOR),true)
ifeq ("$(shell echo "int main(){}" | $(CC) -fdiagnostics-color -x c - -o /dev/null 2>&1)", "")
CFLAGS+= -fdiagnostics-color
endif
CFLAGS+= -fdiagnostics-color=always
else
CFLAGS+= -fdiagnostics-color=never
endif
CFLAGS += -Wall
CFLAGS += -Wstrict-prototypes
CFLAGS += $(call cc-option,-Wunused-but-set-variable=1,-Wunused-but-set-variable)
CFLAGS += $(call cc-option,-Wunused-but-set-parameter=1,-Wunused-but-set-parameter)
ifneq ($(strip $(ALLOW_WARNINGS)), yes)
CFLAGS += -Werror
endif
@ -89,7 +95,8 @@ CXXFLAGS += -O$(OPT)
CXXFLAGS += -w
CXXFLAGS += -Wall
CXXFLAGS += -Wundef
CXXFLAGS += $(call cc-option,-Wunused-but-set-variable=1,-Wunused-but-set-variable)
CXXFLAGS += $(call cc-option,-Wunused-but-set-parameter=1,-Wunused-but-set-parameter)
ifneq ($(strip $(ALLOW_WARNINGS)), yes)
CXXFLAGS += -Werror
endif

View file

@ -1,10 +1,8 @@
{
"license": "GPL-2.0-or-later",
"devDependencies": {
"vite": "^5.4.21",
"vitepress": "^1.1.0",
"vitepress-plugin-tabs": "^0.5.0",
"vue": "^3.4.24"
"vitepress": "^1.6.4",
"vitepress-plugin-tabs": "^0.8.0"
},
"scripts": {
"docs:dev": "vitepress dev --host 0.0.0.0",

File diff suppressed because it is too large Load diff

View file

@ -45,6 +45,7 @@ GENERIC_FEATURES = \
MOUSEKEY \
MUSIC \
OS_DETECTION \
PLOVER_HID \
PROGRAMMABLE_BUTTON \
REPEAT_KEY \
SECURE \

View file

@ -0,0 +1,64 @@
MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_1)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_2)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_3)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_4)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_5)
ifneq ($(QMK_USERSPACE),)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
endif
define SEARCH_POTENTIAL_LOCATION
POTENTIAL_DIR := $1
ifeq ("$$(wildcard $$(KEYMAP_PATH))", "")
POTENTIAL_KEYMAP_JSON := $$(POTENTIAL_DIR)/keymap.json
POTENTIAL_KEYMAP_C := $$(POTENTIAL_DIR)/keymap.c
ifneq ("$$(wildcard $$(POTENTIAL_KEYMAP_JSON))","")
KEYMAP_JSON := $$(POTENTIAL_KEYMAP_JSON)
KEYMAP_PATH := $$(POTENTIAL_DIR)
endif
ifneq ("$$(wildcard $$(POTENTIAL_KEYMAP_C))","")
KEYMAP_C := $$(POTENTIAL_KEYMAP_C)
KEYMAP_PATH := $$(POTENTIAL_DIR)
endif
endif
endef
$(foreach KM_DIR,$(POTENTIAL_KEYMAP_PATHS),$(eval $(call SEARCH_POTENTIAL_LOCATION, $(KM_DIR))))
LAYOUTS_PATH := layouts
LAYOUTS_REPOS := $(patsubst %/,%,$(sort $(dir $(wildcard $(LAYOUTS_PATH)/*/))))
ifneq ($(QMK_USERSPACE),)
LAYOUTS_REPOS += $(patsubst %/,%,$(QMK_USERSPACE)/$(LAYOUTS_PATH))
endif
define SEARCH_LAYOUTS
$$(foreach LAYOUTS_REPO,$$(LAYOUTS_REPOS),$$(eval $$(call SEARCH_POTENTIAL_LOCATION,$$(LAYOUTS_REPO)/$$(LAYOUT)/$$(KEYMAP))))
endef
ifneq ($(FORCE_LAYOUT),)
ifneq (,$(findstring $(FORCE_LAYOUT),$(LAYOUTS)))
$(info Forcing layout: $(FORCE_LAYOUT))
LAYOUTS := $(FORCE_LAYOUT)
else
$(call CATASTROPHIC_ERROR,Invalid layout,Forced layout does not exist)
endif
endif
$(foreach LAYOUT,$(LAYOUTS),$(eval $(call SEARCH_LAYOUTS)))
ifeq ("$$(wildcard $$(KEYMAP_PATH))", "")
$(call CATASTROPHIC_ERROR,Invalid keymap,Could not find keymap)
# this state should never be reached
endif

View file

@ -77,13 +77,13 @@ define GENERATE_MSG_MAKE_KB
endef
MSG_MAKE_KB = $(eval $(call GENERATE_MSG_MAKE_KB))$(MSG_MAKE_KB_ACTUAL)
define GENERATE_MSG_MAKE_TEST
MSG_MAKE_TEST_ACTUAL := Making test $(BOLD)$(TEST_NAME)$(NO_COLOR)
MSG_MAKE_TEST_ACTUAL := Making test $(BOLD)$(TEST_ID)$(NO_COLOR)
ifneq ($$(MAKE_TARGET),)
MSG_MAKE_TEST_ACTUAL += with target $(BOLD)$$(MAKE_TARGET)$(NO_COLOR)
endif
endef
MSG_MAKE_TEST = $(eval $(call GENERATE_MSG_MAKE_TEST))$(MSG_MAKE_TEST_ACTUAL)
MSG_TEST = Testing $(BOLD)$(TEST_NAME)$(NO_COLOR)
MSG_TEST = Testing $(BOLD)$(TEST_ID)$(NO_COLOR)
define GENERATE_MSG_AVAILABLE_KEYMAPS
MSG_AVAILABLE_KEYMAPS_ACTUAL := Available keymaps for $(BOLD)$$(CURRENT_KB)$(NO_COLOR):
endef

View file

@ -63,6 +63,7 @@ OTHER_OPTION_NAMES = \
LCD_BACKLIGHT_ENABLE \
MACROS_ENABLED \
PS2_ENABLE \
PLOVER_HID_ENABLE \
PS2_MOUSE_ENABLE \
PS2_DRIVER \
RAW_ENABLE \

View file

@ -4,7 +4,7 @@
# $(2) = option to use if $(1) is not supported
# $(3) = additional arguments to pass to the compiler during the test, but aren't contained in the output
cc-option = $(shell \
if { echo 'int main(){return 0;}' | $(CC) $(1) $(3) -o /dev/null -x c /dev/null >/dev/null 2>&1; }; \
if { echo 'int main(){return 0;}' | $(CC) $(1) $(3) -Wl,--unresolved-symbols=ignore-all -o /dev/null -x c /dev/null >/dev/null 2>&1; }; \
then echo "$(1)"; else echo "$(2)"; fi)
# Helper to pass comma character to make functions (use with `$(,)` to pass in `$(call ...)` arguments)

View file

@ -3,6 +3,7 @@
"0x7480": {
"group": "audio",
"key": "QK_AUDIO_ON",
"label": "Audio On",
"aliases": [
"AU_ON"
]
@ -10,6 +11,7 @@
"0x7481": {
"group": "audio",
"key": "QK_AUDIO_OFF",
"label": "Audio Off",
"aliases": [
"AU_OFF"
]
@ -17,6 +19,7 @@
"0x7482": {
"group": "audio",
"key": "QK_AUDIO_TOGGLE",
"label": "Toggle Audio",
"aliases": [
"AU_TOGG"
]
@ -25,6 +28,7 @@
"0x748A": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_TOGGLE",
"label": "Toggle Audio Clicky",
"aliases": [
"CK_TOGG"
]
@ -32,6 +36,7 @@
"0x748B": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_ON",
"label": "Audio Clicky On",
"aliases": [
"CK_ON"
]
@ -39,6 +44,7 @@
"0x748C": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_OFF",
"label": "Audio Clicky Off",
"aliases": [
"CK_OFF"
]
@ -46,6 +52,7 @@
"0x748D": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_UP",
"label": "Audio Clicky Up",
"aliases": [
"CK_UP"
]
@ -53,6 +60,7 @@
"0x748E": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_DOWN",
"label": "Audio Clicky Down",
"aliases": [
"CK_DOWN"
]
@ -60,6 +68,7 @@
"0x748F": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_RESET",
"label": "Audio Clicky Reset",
"aliases": [
"CK_RST"
]
@ -68,6 +77,7 @@
"0x7490": {
"group": "audio",
"key": "QK_MUSIC_ON",
"label": "Music On",
"aliases": [
"MU_ON"
]
@ -75,6 +85,7 @@
"0x7491": {
"group": "audio",
"key": "QK_MUSIC_OFF",
"label": "Music Off",
"aliases": [
"MU_OFF"
]
@ -82,6 +93,7 @@
"0x7492": {
"group": "audio",
"key": "QK_MUSIC_TOGGLE",
"label": "Toggle Music",
"aliases": [
"MU_TOGG"
]
@ -89,6 +101,7 @@
"0x7493": {
"group": "audio",
"key": "QK_MUSIC_MODE_NEXT",
"label": "Music Next",
"aliases": [
"MU_NEXT"
]
@ -97,6 +110,7 @@
"0x7494": {
"group": "audio",
"key": "QK_AUDIO_VOICE_NEXT",
"label": "Audio Voice Next",
"aliases": [
"AU_NEXT"
]
@ -104,6 +118,7 @@
"0x7495": {
"group": "audio",
"key": "QK_AUDIO_VOICE_PREVIOUS",
"label": "Audio Voice Previous",
"aliases": [
"AU_PREV"
]

View file

@ -3,7 +3,7 @@
"0x0000": {
"group": "internal",
"key": "KC_NO",
"label": "",
"label": "N/A",
"aliases": [
"XXXXXXX"
]
@ -11,7 +11,7 @@
"0x0001": {
"group": "internal",
"key": "KC_TRANSPARENT",
"label": "",
"label": "Transparent",
"aliases": [
"_______",
"KC_TRNS"
@ -634,7 +634,7 @@
"0x0065": {
"group": "basic",
"key": "KC_APPLICATION",
"label": "Application",
"label": "App",
"aliases": [
"KC_APP"
]
@ -642,7 +642,7 @@
"0x0066": {
"group": "basic",
"key": "KC_KB_POWER",
"label": "Application"
"label": "Power"
},
"0x0067": {
"group": "basic",
@ -1068,7 +1068,7 @@
"0x00A5": {
"group": "system",
"key": "KC_SYSTEM_POWER",
"label": "System Power Down",
"label": "Power",
"aliases": [
"KC_PWR"
]
@ -1076,7 +1076,7 @@
"0x00A6": {
"group": "system",
"key": "KC_SYSTEM_SLEEP",
"label": "System Sleep",
"label": "Sleep",
"aliases": [
"KC_SLEP"
]
@ -1084,7 +1084,7 @@
"0x00A7": {
"group": "system",
"key": "KC_SYSTEM_WAKE",
"label": "System Wake",
"label": "Wake",
"aliases": [
"KC_WAKE"
]
@ -1140,7 +1140,7 @@
"0x00AE": {
"group": "media",
"key": "KC_MEDIA_PLAY_PAUSE",
"label": "Play/Pause Track",
"label": "Play/Pause",
"aliases": [
"KC_MPLY"
]
@ -1148,7 +1148,7 @@
"0x00AF": {
"group": "media",
"key": "KC_MEDIA_SELECT",
"label": "Launch Player",
"label": "Media",
"aliases": [
"KC_MSEL"
]
@ -1164,12 +1164,12 @@
"0x00B1": {
"group": "media",
"key": "KC_MAIL",
"label": "Launch Mail"
"label": "Mail",
},
"0x00B2": {
"group": "media",
"key": "KC_CALCULATOR",
"label": "Launch Calculator",
"label": "Calculator",
"aliases": [
"KC_CALC"
]
@ -1177,7 +1177,7 @@
"0x00B3": {
"group": "media",
"key": "KC_MY_COMPUTER",
"label": "Launch My Computer",
"label": "My Computer",
"aliases": [
"KC_MYCM"
]
@ -1185,7 +1185,7 @@
"0x00B4": {
"group": "media",
"key": "KC_WWW_SEARCH",
"label": "Browser Search",
"label": "Search",
"aliases": [
"KC_WSCH"
]
@ -1193,7 +1193,7 @@
"0x00B5": {
"group": "media",
"key": "KC_WWW_HOME",
"label": "Browser Home",
"label": "Home",
"aliases": [
"KC_WHOM"
]
@ -1201,7 +1201,7 @@
"0x00B6": {
"group": "media",
"key": "KC_WWW_BACK",
"label": "Browser Back",
"label": "Back",
"aliases": [
"KC_WBAK"
]
@ -1209,7 +1209,7 @@
"0x00B7": {
"group": "media",
"key": "KC_WWW_FORWARD",
"label": "Browser Forward",
"label": "Forward",
"aliases": [
"KC_WFWD"
]
@ -1217,7 +1217,7 @@
"0x00B8": {
"group": "media",
"key": "KC_WWW_STOP",
"label": "Browser Stop",
"label": "Stop",
"aliases": [
"KC_WSTP"
]
@ -1225,7 +1225,7 @@
"0x00B9": {
"group": "media",
"key": "KC_WWW_REFRESH",
"label": "Browser Refresh",
"label": "Refresh",
"aliases": [
"KC_WREF"
]
@ -1233,7 +1233,7 @@
"0x00BA": {
"group": "media",
"key": "KC_WWW_FAVORITES",
"label": "Browser Favorites",
"label": "Favorites",
"aliases": [
"KC_WFAV"
]
@ -1241,7 +1241,7 @@
"0x00BB": {
"group": "media",
"key": "KC_MEDIA_FAST_FORWARD",
"label": "Next Track",
"label": "Fast Forward",
"aliases": [
"KC_MFFD"
]
@ -1249,7 +1249,7 @@
"0x00BC": {
"group": "media",
"key": "KC_MEDIA_REWIND",
"label": "Previous Track",
"label": "Rewind",
"aliases": [
"KC_MRWD"
]
@ -1273,7 +1273,7 @@
"0x00BF": {
"group": "media",
"key": "KC_CONTROL_PANEL",
"label": "Open Control Panel",
"label": "Control Panel",
"aliases": [
"KC_CPNL"
]
@ -1281,7 +1281,7 @@
"0x00C0": {
"group": "media",
"key": "KC_ASSISTANT",
"label": "Launch Assistant",
"label": "Assistant",
"aliases": [
"KC_ASST"
]

View file

@ -3,6 +3,7 @@
"0x7400": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_0",
"label": "Button 0",
"aliases": [
"JS_0"
]
@ -10,6 +11,7 @@
"0x7401": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_1",
"label": "Button 1",
"aliases": [
"JS_1"
]
@ -17,6 +19,7 @@
"0x7402": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_2",
"label": "Button 2",
"aliases": [
"JS_2"
]
@ -24,6 +27,7 @@
"0x7403": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_3",
"label": "Button 3",
"aliases": [
"JS_3"
]
@ -31,6 +35,7 @@
"0x7404": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_4",
"label": "Button 4",
"aliases": [
"JS_4"
]
@ -38,6 +43,7 @@
"0x7405": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_5",
"label": "Button 5",
"aliases": [
"JS_5"
]
@ -45,6 +51,7 @@
"0x7406": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_6",
"label": "Button 6",
"aliases": [
"JS_6"
]
@ -52,6 +59,7 @@
"0x7407": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_7",
"label": "Button 7",
"aliases": [
"JS_7"
]
@ -59,6 +67,7 @@
"0x7408": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_8",
"label": "Button 8",
"aliases": [
"JS_8"
]
@ -66,6 +75,7 @@
"0x7409": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_9",
"label": "Button 9",
"aliases": [
"JS_9"
]
@ -73,6 +83,7 @@
"0x740A": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_10",
"label": "Button 10",
"aliases": [
"JS_10"
]
@ -80,6 +91,7 @@
"0x740B": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_11",
"label": "Button 11",
"aliases": [
"JS_11"
]
@ -87,6 +99,7 @@
"0x740C": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_12",
"label": "Button 12",
"aliases": [
"JS_12"
]
@ -94,6 +107,7 @@
"0x740D": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_13",
"label": "Button 13",
"aliases": [
"JS_13"
]
@ -101,6 +115,7 @@
"0x740E": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_14",
"label": "Button 14",
"aliases": [
"JS_14"
]
@ -108,6 +123,7 @@
"0x740F": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_15",
"label": "Button 15",
"aliases": [
"JS_15"
]
@ -115,6 +131,7 @@
"0x7410": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_16",
"label": "Button 16",
"aliases": [
"JS_16"
]
@ -122,6 +139,7 @@
"0x7411": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_17",
"label": "Button 17",
"aliases": [
"JS_17"
]
@ -129,6 +147,7 @@
"0x7412": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_18",
"label": "Button 18",
"aliases": [
"JS_18"
]
@ -136,6 +155,7 @@
"0x7413": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_19",
"label": "Button 19",
"aliases": [
"JS_19"
]
@ -143,6 +163,7 @@
"0x7414": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_20",
"label": "Button 20",
"aliases": [
"JS_20"
]
@ -150,6 +171,7 @@
"0x7415": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_21",
"label": "Button 21",
"aliases": [
"JS_21"
]
@ -157,6 +179,7 @@
"0x7416": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_22",
"label": "Button 22",
"aliases": [
"JS_22"
]
@ -164,6 +187,7 @@
"0x7417": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_23",
"label": "Button 23",
"aliases": [
"JS_23"
]
@ -171,6 +195,7 @@
"0x7418": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_24",
"label": "Button 24",
"aliases": [
"JS_24"
]
@ -178,6 +203,7 @@
"0x7419": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_25",
"label": "Button 25",
"aliases": [
"JS_25"
]
@ -185,6 +211,7 @@
"0x741A": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_26",
"label": "Button 26",
"aliases": [
"JS_26"
]
@ -192,6 +219,7 @@
"0x741B": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_27",
"label": "Button 27",
"aliases": [
"JS_27"
]
@ -199,6 +227,7 @@
"0x741C": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_28",
"label": "Button 28",
"aliases": [
"JS_28"
]
@ -206,6 +235,7 @@
"0x741D": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_29",
"label": "Button 29",
"aliases": [
"JS_29"
]
@ -213,6 +243,7 @@
"0x741E": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_30",
"label": "Button 30",
"aliases": [
"JS_30"
]
@ -220,6 +251,7 @@
"0x741F": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_31",
"label": "Button 31",
"aliases": [
"JS_31"
]

View file

@ -3,6 +3,7 @@
"0x7800": {
"group": "backlight",
"key": "QK_BACKLIGHT_ON",
"label": "Backlight On",
"aliases": [
"BL_ON"
]
@ -10,6 +11,7 @@
"0x7801": {
"group": "backlight",
"key": "QK_BACKLIGHT_OFF",
"label": "Backlight Off",
"aliases": [
"BL_OFF"
]
@ -17,6 +19,7 @@
"0x7802": {
"group": "backlight",
"key": "QK_BACKLIGHT_TOGGLE",
"label": "Toggle Backlight",
"aliases": [
"BL_TOGG"
]
@ -24,6 +27,7 @@
"0x7803": {
"group": "backlight",
"key": "QK_BACKLIGHT_DOWN",
"label": "Backlight Down",
"aliases": [
"BL_DOWN"
]
@ -31,6 +35,7 @@
"0x7804": {
"group": "backlight",
"key": "QK_BACKLIGHT_UP",
"label": "Backlight Up",
"aliases": [
"BL_UP"
]
@ -38,6 +43,7 @@
"0x7805": {
"group": "backlight",
"key": "QK_BACKLIGHT_STEP",
"label": "Backlight Step",
"aliases": [
"BL_STEP"
]
@ -45,6 +51,7 @@
"0x7806": {
"group": "backlight",
"key": "QK_BACKLIGHT_TOGGLE_BREATHING",
"label": "Toggle Breathing",
"aliases": [
"BL_BRTG"
]

View file

@ -1,9 +1,9 @@
{
"keycodes": {
"0x7700": {
"group": "macro",
"key": "QK_MACRO_0",
"label": "Macro 0",
"aliases": [
"MC_0"
]
@ -11,6 +11,7 @@
"0x7701": {
"group": "macro",
"key": "QK_MACRO_1",
"label": "Macro 1",
"aliases": [
"MC_1"
]
@ -18,6 +19,7 @@
"0x7702": {
"group": "macro",
"key": "QK_MACRO_2",
"label": "Macro 2",
"aliases": [
"MC_2"
]
@ -25,6 +27,7 @@
"0x7703": {
"group": "macro",
"key": "QK_MACRO_3",
"label": "Macro 3",
"aliases": [
"MC_3"
]
@ -32,6 +35,7 @@
"0x7704": {
"group": "macro",
"key": "QK_MACRO_4",
"label": "Macro 4",
"aliases": [
"MC_4"
]
@ -39,6 +43,7 @@
"0x7705": {
"group": "macro",
"key": "QK_MACRO_5",
"label": "Macro 5",
"aliases": [
"MC_5"
]
@ -46,6 +51,7 @@
"0x7706": {
"group": "macro",
"key": "QK_MACRO_6",
"label": "Macro 6",
"aliases": [
"MC_6"
]
@ -53,6 +59,7 @@
"0x7707": {
"group": "macro",
"key": "QK_MACRO_7",
"label": "Macro 7",
"aliases": [
"MC_7"
]
@ -60,6 +67,7 @@
"0x7708": {
"group": "macro",
"key": "QK_MACRO_8",
"label": "Macro 8",
"aliases": [
"MC_8"
]
@ -67,6 +75,7 @@
"0x7709": {
"group": "macro",
"key": "QK_MACRO_9",
"label": "Macro 9",
"aliases": [
"MC_9"
]
@ -74,6 +83,7 @@
"0x770A": {
"group": "macro",
"key": "QK_MACRO_10",
"label": "Macro 10",
"aliases": [
"MC_10"
]
@ -81,6 +91,7 @@
"0x770B": {
"group": "macro",
"key": "QK_MACRO_11",
"label": "Macro 11",
"aliases": [
"MC_11"
]
@ -88,6 +99,7 @@
"0x770C": {
"group": "macro",
"key": "QK_MACRO_12",
"label": "Macro 12",
"aliases": [
"MC_12"
]
@ -95,6 +107,7 @@
"0x770D": {
"group": "macro",
"key": "QK_MACRO_13",
"label": "Macro 13",
"aliases": [
"MC_13"
]
@ -102,6 +115,7 @@
"0x770E": {
"group": "macro",
"key": "QK_MACRO_14",
"label": "Macro 14",
"aliases": [
"MC_14"
]
@ -109,6 +123,7 @@
"0x770F": {
"group": "macro",
"key": "QK_MACRO_15",
"label": "Macro 15",
"aliases": [
"MC_15"
]
@ -116,6 +131,7 @@
"0x7710": {
"group": "macro",
"key": "QK_MACRO_16",
"label": "Macro 16",
"aliases": [
"MC_16"
]
@ -123,6 +139,7 @@
"0x7711": {
"group": "macro",
"key": "QK_MACRO_17",
"label": "Macro 17",
"aliases": [
"MC_17"
]
@ -130,6 +147,7 @@
"0x7712": {
"group": "macro",
"key": "QK_MACRO_18",
"label": "Macro 18",
"aliases": [
"MC_18"
]
@ -137,6 +155,7 @@
"0x7713": {
"group": "macro",
"key": "QK_MACRO_19",
"label": "Macro 19",
"aliases": [
"MC_19"
]
@ -144,6 +163,7 @@
"0x7714": {
"group": "macro",
"key": "QK_MACRO_20",
"label": "Macro 20",
"aliases": [
"MC_20"
]
@ -151,6 +171,7 @@
"0x7715": {
"group": "macro",
"key": "QK_MACRO_21",
"label": "Macro 21",
"aliases": [
"MC_21"
]
@ -158,6 +179,7 @@
"0x7716": {
"group": "macro",
"key": "QK_MACRO_22",
"label": "Macro 22",
"aliases": [
"MC_22"
]
@ -165,6 +187,7 @@
"0x7717": {
"group": "macro",
"key": "QK_MACRO_23",
"label": "Macro 23",
"aliases": [
"MC_23"
]
@ -172,6 +195,7 @@
"0x7718": {
"group": "macro",
"key": "QK_MACRO_24",
"label": "Macro 24",
"aliases": [
"MC_24"
]
@ -179,6 +203,7 @@
"0x7719": {
"group": "macro",
"key": "QK_MACRO_25",
"label": "Macro 25",
"aliases": [
"MC_25"
]
@ -186,6 +211,7 @@
"0x771A": {
"group": "macro",
"key": "QK_MACRO_26",
"label": "Macro 26",
"aliases": [
"MC_26"
]
@ -193,6 +219,7 @@
"0x771B": {
"group": "macro",
"key": "QK_MACRO_27",
"label": "Macro 27",
"aliases": [
"MC_27"
]
@ -200,6 +227,7 @@
"0x771C": {
"group": "macro",
"key": "QK_MACRO_28",
"label": "Macro 28",
"aliases": [
"MC_28"
]
@ -207,6 +235,7 @@
"0x771D": {
"group": "macro",
"key": "QK_MACRO_29",
"label": "Macro 29",
"aliases": [
"MC_29"
]
@ -214,6 +243,7 @@
"0x771E": {
"group": "macro",
"key": "QK_MACRO_30",
"label": "Macro 30",
"aliases": [
"MC_30"
]
@ -221,6 +251,7 @@
"0x771F": {
"group": "macro",
"key": "QK_MACRO_31",
"label": "Macro 31",
"aliases": [
"MC_31"
]

View file

@ -3,6 +3,7 @@
"0x7440": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_1",
"label": "Button 1",
"aliases": [
"PB_1"
]
@ -10,6 +11,7 @@
"0x7441": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_2",
"label": "Button 2",
"aliases": [
"PB_2"
]
@ -17,6 +19,7 @@
"0x7442": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_3",
"label": "Button 3",
"aliases": [
"PB_3"
]
@ -24,6 +27,7 @@
"0x7443": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_4",
"label": "Button 4",
"aliases": [
"PB_4"
]
@ -31,6 +35,7 @@
"0x7444": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_5",
"label": "Button 5",
"aliases": [
"PB_5"
]
@ -38,6 +43,7 @@
"0x7445": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_6",
"label": "Button 6",
"aliases": [
"PB_6"
]
@ -45,6 +51,7 @@
"0x7446": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_7",
"label": "Button 7",
"aliases": [
"PB_7"
]
@ -52,6 +59,7 @@
"0x7447": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_8",
"label": "Button 8",
"aliases": [
"PB_8"
]
@ -59,6 +67,7 @@
"0x7448": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_9",
"label": "Button 9",
"aliases": [
"PB_9"
]
@ -66,6 +75,7 @@
"0x7449": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_10",
"label": "Button 10",
"aliases": [
"PB_10"
]
@ -73,6 +83,7 @@
"0x744A": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_11",
"label": "Button 11",
"aliases": [
"PB_11"
]
@ -80,6 +91,7 @@
"0x744B": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_12",
"label": "Button 12",
"aliases": [
"PB_12"
]
@ -87,6 +99,7 @@
"0x744C": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_13",
"label": "Button 13",
"aliases": [
"PB_13"
]
@ -94,6 +107,7 @@
"0x744D": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_14",
"label": "Button 14",
"aliases": [
"PB_14"
]
@ -101,6 +115,7 @@
"0x744E": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_15",
"label": "Button 15",
"aliases": [
"PB_15"
]
@ -108,6 +123,7 @@
"0x744F": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_16",
"label": "Button 16",
"aliases": [
"PB_16"
]
@ -115,6 +131,7 @@
"0x7450": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_17",
"label": "Button 17",
"aliases": [
"PB_17"
]
@ -122,6 +139,7 @@
"0x7451": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_18",
"label": "Button 18",
"aliases": [
"PB_18"
]
@ -129,6 +147,7 @@
"0x7452": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_19",
"label": "Button 19",
"aliases": [
"PB_19"
]
@ -136,6 +155,7 @@
"0x7453": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_20",
"label": "Button 20",
"aliases": [
"PB_20"
]
@ -143,6 +163,7 @@
"0x7454": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_21",
"label": "Button 21",
"aliases": [
"PB_21"
]
@ -150,6 +171,7 @@
"0x7455": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_22",
"label": "Button 22",
"aliases": [
"PB_22"
]
@ -157,6 +179,7 @@
"0x7456": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_23",
"label": "Button 23",
"aliases": [
"PB_23"
]
@ -164,6 +187,7 @@
"0x7457": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_24",
"label": "Button 24",
"aliases": [
"PB_24"
]
@ -171,6 +195,7 @@
"0x7458": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_25",
"label": "Button 25",
"aliases": [
"PB_25"
]
@ -178,6 +203,7 @@
"0x7459": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_26",
"label": "Button 26",
"aliases": [
"PB_26"
]
@ -185,6 +211,7 @@
"0x745A": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_27",
"label": "Button 27",
"aliases": [
"PB_27"
]
@ -192,6 +219,7 @@
"0x745B": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_28",
"label": "Button 28",
"aliases": [
"PB_28"
]
@ -199,6 +227,7 @@
"0x745C": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_29",
"label": "Button 29",
"aliases": [
"PB_29"
]
@ -206,6 +235,7 @@
"0x745D": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_30",
"label": "Button 30",
"aliases": [
"PB_30"
]
@ -213,6 +243,7 @@
"0x745E": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_31",
"label": "Button 31",
"aliases": [
"PB_31"
]
@ -220,6 +251,7 @@
"0x745F": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_32",
"label": "Button 32",
"aliases": [
"PB_32"
]

View file

@ -3,6 +3,7 @@
"0x7C00": {
"group": "quantum",
"key": "QK_BOOTLOADER",
"label": "Bootloader",
"aliases": [
"QK_BOOT"
]
@ -10,6 +11,7 @@
"0x7C01": {
"group": "quantum",
"key": "QK_REBOOT",
"label": "Reboot",
"aliases": [
"QK_RBT"
]
@ -17,6 +19,7 @@
"0x7C02": {
"group": "quantum",
"key": "QK_DEBUG_TOGGLE",
"label": "Toggle Debug",
"aliases": [
"DB_TOGG"
]
@ -24,18 +27,21 @@
"0x7C03": {
"group": "quantum",
"key": "QK_CLEAR_EEPROM",
"label": "Clear EEPROM",
"aliases": [
"EE_CLR"
]
},
"0x7C04": {
"group": "quantum",
"key": "QK_MAKE"
"key": "QK_MAKE",
"label": "Make"
},
"0x7C10": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_DOWN",
"label": "Auto Shift Down",
"aliases": [
"AS_DOWN"
]
@ -43,6 +49,7 @@
"0x7C11": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_UP",
"label": "Auto Shift Up",
"aliases": [
"AS_UP"
]
@ -50,6 +57,7 @@
"0x7C12": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_REPORT",
"label": "Auto Shift Report",
"aliases": [
"AS_RPT"
]
@ -57,6 +65,7 @@
"0x7C13": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_ON",
"label": "Auto Shift On",
"aliases": [
"AS_ON"
]
@ -64,6 +73,7 @@
"0x7C14": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_OFF",
"label": "Auto Shift Off",
"aliases": [
"AS_OFF"
]
@ -71,6 +81,7 @@
"0x7C15": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_TOGGLE",
"label": "Toggle Auto Shift",
"aliases": [
"AS_TOGG"
]
@ -79,6 +90,7 @@
"0x7C16": {
"group": "quantum",
"key": "QK_GRAVE_ESCAPE",
"label": "Grave Esc",
"aliases": [
"QK_GESC"
]
@ -95,6 +107,7 @@
"0x7C18": {
"group": "quantum",
"key": "QK_SPACE_CADET_LEFT_CTRL_PARENTHESIS_OPEN",
"label": "LCtl/(",
"aliases": [
"SC_LCPO"
]
@ -102,6 +115,7 @@
"0x7C19": {
"group": "quantum",
"key": "QK_SPACE_CADET_RIGHT_CTRL_PARENTHESIS_CLOSE",
"label": "RCtl/)",
"aliases": [
"SC_RCPC"
]
@ -109,6 +123,7 @@
"0x7C1A": {
"group": "quantum",
"key": "QK_SPACE_CADET_LEFT_SHIFT_PARENTHESIS_OPEN",
"label": "LSft/)",
"aliases": [
"SC_LSPO"
]
@ -116,6 +131,7 @@
"0x7C1B": {
"group": "quantum",
"key": "QK_SPACE_CADET_RIGHT_SHIFT_PARENTHESIS_CLOSE",
"label": "RSft/)",
"aliases": [
"SC_RSPC"
]
@ -123,6 +139,7 @@
"0x7C1C": {
"group": "quantum",
"key": "QK_SPACE_CADET_LEFT_ALT_PARENTHESIS_OPEN",
"label": "LAlt/(",
"aliases": [
"SC_LAPO"
]
@ -130,6 +147,7 @@
"0x7C1D": {
"group": "quantum",
"key": "QK_SPACE_CADET_RIGHT_ALT_PARENTHESIS_CLOSE",
"label": "RAlt/)",
"aliases": [
"SC_RAPC"
]
@ -137,6 +155,7 @@
"0x7C1E": {
"group": "quantum",
"key": "QK_SPACE_CADET_RIGHT_SHIFT_ENTER",
"label": "RSft/Ent",
"aliases": [
"SC_SENT"
]
@ -167,6 +186,7 @@
"0x7C30": {
"group": "quantum",
"key": "QK_UNICODE_MODE_NEXT",
"label": "Unicode Mode Next",
"aliases": [
"UC_NEXT"
]
@ -174,6 +194,7 @@
"0x7C31": {
"group": "quantum",
"key": "QK_UNICODE_MODE_PREVIOUS",
"label": "Unicode Mode Previous",
"aliases": [
"UC_PREV"
]
@ -181,6 +202,7 @@
"0x7C32": {
"group": "quantum",
"key": "QK_UNICODE_MODE_MACOS",
"label": "Unicode Mode macOS",
"aliases": [
"UC_MAC"
]
@ -188,6 +210,7 @@
"0x7C33": {
"group": "quantum",
"key": "QK_UNICODE_MODE_LINUX",
"label": "Unicode Mode Linux",
"aliases": [
"UC_LINX"
]
@ -195,6 +218,7 @@
"0x7C34": {
"group": "quantum",
"key": "QK_UNICODE_MODE_WINDOWS",
"label": "Unicode Mode Windows",
"aliases": [
"UC_WIN"
]
@ -202,6 +226,7 @@
"0x7C35": {
"group": "quantum",
"key": "QK_UNICODE_MODE_BSD",
"label": "Unicode Mode BSD",
"aliases": [
"UC_BSD"
]
@ -209,6 +234,7 @@
"0x7C36": {
"group": "quantum",
"key": "QK_UNICODE_MODE_WINCOMPOSE",
"label": "Unicode Mode WinCompose",
"aliases": [
"UC_WINC"
]
@ -216,6 +242,7 @@
"0x7C37": {
"group": "quantum",
"key": "QK_UNICODE_MODE_EMACS",
"label": "Unicode Mode emacs",
"aliases": [
"UC_EMAC"
]
@ -224,6 +251,7 @@
"0x7C40": {
"group": "quantum",
"key": "QK_HAPTIC_ON",
"label": "Haptic On",
"aliases": [
"HF_ON"
]
@ -231,6 +259,7 @@
"0x7C41": {
"group": "quantum",
"key": "QK_HAPTIC_OFF",
"label": "Haptic Off",
"aliases": [
"HF_OFF"
]
@ -238,6 +267,7 @@
"0x7C42": {
"group": "quantum",
"key": "QK_HAPTIC_TOGGLE",
"label": "Toggle Haptic",
"aliases": [
"HF_TOGG"
]
@ -245,6 +275,7 @@
"0x7C43": {
"group": "quantum",
"key": "QK_HAPTIC_RESET",
"label": "Haptic Reset",
"aliases": [
"HF_RST"
]
@ -252,6 +283,7 @@
"0x7C44": {
"group": "quantum",
"key": "QK_HAPTIC_FEEDBACK_TOGGLE",
"label": "Toggle Haptic Feedback",
"aliases": [
"HF_FDBK"
]
@ -259,6 +291,7 @@
"0x7C45": {
"group": "quantum",
"key": "QK_HAPTIC_BUZZ_TOGGLE",
"label": "Toggle Haptic Buzz",
"aliases": [
"HF_BUZZ"
]
@ -266,6 +299,7 @@
"0x7C46": {
"group": "quantum",
"key": "QK_HAPTIC_MODE_NEXT",
"label": "Haptic Mode Next",
"aliases": [
"HF_NEXT"
]
@ -273,6 +307,7 @@
"0x7C47": {
"group": "quantum",
"key": "QK_HAPTIC_MODE_PREVIOUS",
"label": "Haptic Mode Previous",
"aliases": [
"HF_PREV"
]
@ -280,6 +315,7 @@
"0x7C48": {
"group": "quantum",
"key": "QK_HAPTIC_CONTINUOUS_TOGGLE",
"label": "Toggle Haptic Continuous",
"aliases": [
"HF_CONT"
]
@ -287,6 +323,7 @@
"0x7C49": {
"group": "quantum",
"key": "QK_HAPTIC_CONTINUOUS_UP",
"label": "Haptic Continuous Up",
"aliases": [
"HF_CONU"
]
@ -294,6 +331,7 @@
"0x7C4A": {
"group": "quantum",
"key": "QK_HAPTIC_CONTINUOUS_DOWN",
"label": "Haptic Continuous Down",
"aliases": [
"HF_COND"
]
@ -301,6 +339,7 @@
"0x7C4B": {
"group": "quantum",
"key": "QK_HAPTIC_DWELL_UP",
"label": "Haptic Dwell Up",
"aliases": [
"HF_DWLU"
]
@ -308,6 +347,7 @@
"0x7C4C": {
"group": "quantum",
"key": "QK_HAPTIC_DWELL_DOWN",
"label": "Haptic Dwell Down",
"aliases": [
"HF_DWLD"
]
@ -316,6 +356,7 @@
"0x7C50": {
"group": "quantum",
"key": "QK_COMBO_ON",
"label": "Combo On",
"aliases": [
"CM_ON"
]
@ -323,6 +364,7 @@
"0x7C51": {
"group": "quantum",
"key": "QK_COMBO_OFF",
"label": "Combo Off",
"aliases": [
"CM_OFF"
]
@ -330,6 +372,7 @@
"0x7C52": {
"group": "quantum",
"key": "QK_COMBO_TOGGLE",
"label": "Toggle Combo",
"aliases": [
"CM_TOGG"
]
@ -338,6 +381,7 @@
"0x7C53": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_RECORD_START_1",
"label": "Dynamic Macro Record 1",
"aliases": [
"DM_REC1"
]
@ -345,6 +389,7 @@
"0x7C54": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_RECORD_START_2",
"label": "Dynamic Macro Record 2",
"aliases": [
"DM_REC2"
]
@ -352,6 +397,7 @@
"0x7C55": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_RECORD_STOP",
"label": "Dynamic Macro Stop Recording",
"aliases": [
"DM_RSTP"
]
@ -359,6 +405,7 @@
"0x7C56": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_PLAY_1",
"label": "Dynamic Macro Play 1",
"aliases": [
"DM_PLY1"
]
@ -366,6 +413,7 @@
"0x7C57": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_PLAY_2",
"label": "Dynamic Macro Play 2",
"aliases": [
"DM_PLY2"
]
@ -374,6 +422,7 @@
"0x7C58": {
"group": "quantum",
"key": "QK_LEADER",
"label": "Leader",
"aliases": [
"QK_LEAD"
]
@ -381,12 +430,14 @@
"0x7C59": {
"group": "quantum",
"key": "QK_LOCK"
"key": "QK_LOCK",
"label": "Lock"
},
"0x7C5A": {
"group": "quantum",
"key": "QK_ONE_SHOT_ON",
"label": "One Shot On",
"aliases": [
"OS_ON"
]
@ -394,6 +445,7 @@
"0x7C5B": {
"group": "quantum",
"key": "QK_ONE_SHOT_OFF",
"label": "One Shot Off",
"aliases": [
"OS_OFF"
]
@ -401,6 +453,7 @@
"0x7C5C": {
"group": "quantum",
"key": "QK_ONE_SHOT_TOGGLE",
"label": "Toggle One Shot",
"aliases": [
"OS_TOGG"
]
@ -409,6 +462,7 @@
"0x7C5D": {
"group": "quantum",
"key": "QK_KEY_OVERRIDE_TOGGLE",
"label": "Toggle Key Overrides",
"aliases": [
"KO_TOGG"
]
@ -416,6 +470,7 @@
"0x7C5E": {
"group": "quantum",
"key": "QK_KEY_OVERRIDE_ON",
"label": "Key Overrides On",
"aliases": [
"KO_ON"
]
@ -423,6 +478,7 @@
"0x7C5F": {
"group": "quantum",
"key": "QK_KEY_OVERRIDE_OFF",
"label": "Key Overrides Off",
"aliases": [
"KO_OFF"
]
@ -431,6 +487,7 @@
"0x7C60": {
"group": "quantum",
"key": "QK_SECURE_LOCK",
"label": "Lock",
"aliases": [
"SE_LOCK"
]
@ -438,6 +495,7 @@
"0x7C61": {
"group": "quantum",
"key": "QK_SECURE_UNLOCK",
"label": "Unlock",
"aliases": [
"SE_UNLK"
]
@ -445,6 +503,7 @@
"0x7C62": {
"group": "quantum",
"key": "QK_SECURE_TOGGLE",
"label": "Toggle Lock",
"aliases": [
"SE_TOGG"
]
@ -452,6 +511,7 @@
"0x7C63": {
"group": "quantum",
"key": "QK_SECURE_REQUEST",
"label": "Request Unlock",
"aliases": [
"SE_REQ"
]
@ -460,6 +520,7 @@
"0x7C70": {
"group": "quantum",
"key": "QK_DYNAMIC_TAPPING_TERM_PRINT",
"label": "Print Dynamic Tapping Term",
"aliases": [
"DT_PRNT"
]
@ -467,6 +528,7 @@
"0x7C71": {
"group": "quantum",
"key": "QK_DYNAMIC_TAPPING_TERM_UP",
"label": "Dynamic Tapping Term Up",
"aliases": [
"DT_UP"
]
@ -474,6 +536,7 @@
"0x7C72": {
"group": "quantum",
"key": "QK_DYNAMIC_TAPPING_TERM_DOWN",
"label": "Dynamic Tapping Term Down",
"aliases": [
"DT_DOWN"
]
@ -482,6 +545,7 @@
"0x7C73": {
"group": "quantum",
"key": "QK_CAPS_WORD_TOGGLE",
"label": "Toggle Caps Word",
"aliases": [
"CW_TOGG"
]
@ -490,6 +554,7 @@
"0x7C74": {
"group": "quantum",
"key": "QK_AUTOCORRECT_ON",
"label": "Autocorrect On",
"aliases": [
"AC_ON"
]
@ -497,6 +562,7 @@
"0x7C75": {
"group": "quantum",
"key": "QK_AUTOCORRECT_OFF",
"label": "Autocorrect Off",
"aliases": [
"AC_OFF"
]
@ -504,6 +570,7 @@
"0x7C76": {
"group": "quantum",
"key": "QK_AUTOCORRECT_TOGGLE",
"label": "Toggle Autocorrect",
"aliases": [
"AC_TOGG"
]

View file

@ -3,7 +3,7 @@
"0x00C1": {
"group": "media",
"key": "KC_MISSION_CONTROL",
"label": "Open Mission Control",
"label": "Mission Control",
"aliases": [
"KC_MCTL"
]
@ -11,7 +11,7 @@
"0x00C2": {
"group": "media",
"key": "KC_LAUNCHPAD",
"label": "Open Launchpad",
"label": "Launchpad",
"aliases": [
"KC_LPAD"
]

View file

@ -2,131 +2,163 @@
"keycodes": {
"0x7E00": {
"group": "kb",
"key": "QK_KB_0"
"key": "QK_KB_0",
"label": "Keyboard 0"
},
"0x7E01": {
"group": "kb",
"key": "QK_KB_1"
"key": "QK_KB_1",
"label": "Keyboard 1"
},
"0x7E02": {
"group": "kb",
"key": "QK_KB_2"
"key": "QK_KB_2",
"label": "Keyboard 2"
},
"0x7E03": {
"group": "kb",
"key": "QK_KB_3"
"key": "QK_KB_3",
"label": "Keyboard 3"
},
"0x7E04": {
"group": "kb",
"key": "QK_KB_4"
"key": "QK_KB_4",
"label": "Keyboard 4"
},
"0x7E05": {
"group": "kb",
"key": "QK_KB_5"
"key": "QK_KB_5",
"label": "Keyboard 5"
},
"0x7E06": {
"group": "kb",
"key": "QK_KB_6"
"key": "QK_KB_6",
"label": "Keyboard 6"
},
"0x7E07": {
"group": "kb",
"key": "QK_KB_7"
"key": "QK_KB_7",
"label": "Keyboard 7"
},
"0x7E08": {
"group": "kb",
"key": "QK_KB_8"
"key": "QK_KB_8",
"label": "Keyboard 8"
},
"0x7E09": {
"group": "kb",
"key": "QK_KB_9"
"key": "QK_KB_9",
"label": "Keyboard 9"
},
"0x7E0A": {
"group": "kb",
"key": "QK_KB_10"
"key": "QK_KB_10",
"label": "Keyboard 10"
},
"0x7E0B": {
"group": "kb",
"key": "QK_KB_11"
"key": "QK_KB_11",
"label": "Keyboard 11"
},
"0x7E0C": {
"group": "kb",
"key": "QK_KB_12"
"key": "QK_KB_12",
"label": "Keyboard 12"
},
"0x7E0D": {
"group": "kb",
"key": "QK_KB_13"
"key": "QK_KB_13",
"label": "Keyboard 13"
},
"0x7E0E": {
"group": "kb",
"key": "QK_KB_14"
"key": "QK_KB_14",
"label": "Keyboard 14"
},
"0x7E0F": {
"group": "kb",
"key": "QK_KB_15"
"key": "QK_KB_15",
"label": "Keyboard 15"
},
"0x7E10": {
"group": "kb",
"key": "QK_KB_16"
"key": "QK_KB_16",
"label": "Keyboard 16"
},
"0x7E11": {
"group": "kb",
"key": "QK_KB_17"
"key": "QK_KB_17",
"label": "Keyboard 17"
},
"0x7E12": {
"group": "kb",
"key": "QK_KB_18"
"key": "QK_KB_18",
"label": "Keyboard 18"
},
"0x7E13": {
"group": "kb",
"key": "QK_KB_19"
"key": "QK_KB_19",
"label": "Keyboard 19"
},
"0x7E14": {
"group": "kb",
"key": "QK_KB_20"
"key": "QK_KB_20",
"label": "Keyboard 20"
},
"0x7E15": {
"group": "kb",
"key": "QK_KB_21"
"key": "QK_KB_21",
"label": "Keyboard 21"
},
"0x7E16": {
"group": "kb",
"key": "QK_KB_22"
"key": "QK_KB_22",
"label": "Keyboard 22"
},
"0x7E17": {
"group": "kb",
"key": "QK_KB_23"
"key": "QK_KB_23",
"label": "Keyboard 23"
},
"0x7E18": {
"group": "kb",
"key": "QK_KB_24"
"key": "QK_KB_24",
"label": "Keyboard 24"
},
"0x7E19": {
"group": "kb",
"key": "QK_KB_25"
"key": "QK_KB_25",
"label": "Keyboard 25"
},
"0x7E1A": {
"group": "kb",
"key": "QK_KB_26"
"key": "QK_KB_26",
"label": "Keyboard 26"
},
"0x7E1B": {
"group": "kb",
"key": "QK_KB_27"
"key": "QK_KB_27",
"label": "Keyboard 27"
},
"0x7E1C": {
"group": "kb",
"key": "QK_KB_28"
"key": "QK_KB_28",
"label": "Keyboard 28"
},
"0x7E1D": {
"group": "kb",
"key": "QK_KB_29"
"key": "QK_KB_29",
"label": "Keyboard 29"
},
"0x7E1E": {
"group": "kb",
"key": "QK_KB_30"
"key": "QK_KB_30",
"label": "Keyboard 30"
},
"0x7E1F": {
"group": "kb",
"key": "QK_KB_31"
"key": "QK_KB_31",
"label": "Keyboard 31"
}
}
}

View file

@ -5,6 +5,7 @@
"0x7000": {
"group": "magic",
"key": "QK_MAGIC_SWAP_CONTROL_CAPS_LOCK",
"label": "Swap LCtl⇄Caps",
"aliases": [
"CL_SWAP"
]
@ -12,6 +13,7 @@
"0x7001": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_CONTROL_CAPS_LOCK",
"label": "Unswap LCtl⇄Caps",
"aliases": [
"CL_NORM"
]
@ -19,6 +21,7 @@
"0x7002": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_CONTROL_CAPS_LOCK",
"label": "Toggle LCtl⇄Caps",
"aliases": [
"CL_TOGG"
]
@ -26,6 +29,7 @@
"0x7003": {
"group": "magic",
"key": "QK_MAGIC_CAPS_LOCK_AS_CONTROL_OFF",
"label": "Caps≠LCtl",
"aliases": [
"CL_CAPS"
]
@ -33,6 +37,7 @@
"0x7004": {
"group": "magic",
"key": "QK_MAGIC_CAPS_LOCK_AS_CONTROL_ON",
"label": "Caps=LCtl",
"aliases": [
"CL_CTRL"
]
@ -40,6 +45,7 @@
"0x7005": {
"group": "magic",
"key": "QK_MAGIC_SWAP_LALT_LGUI",
"label": "Swap LAlt⇄LGUI",
"aliases": [
"AG_LSWP"
]
@ -47,6 +53,7 @@
"0x7006": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_LALT_LGUI",
"label": "Unswap LAlt⇄LGUI",
"aliases": [
"AG_LNRM"
]
@ -54,6 +61,7 @@
"0x7007": {
"group": "magic",
"key": "QK_MAGIC_SWAP_RALT_RGUI",
"label": "Swap RAlt⇄RGUI",
"aliases": [
"AG_RSWP"
]
@ -61,6 +69,7 @@
"0x7008": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_RALT_RGUI",
"label": "Unswap RAlt⇄RGUI",
"aliases": [
"AG_RNRM"
]
@ -68,6 +77,7 @@
"0x7009": {
"group": "magic",
"key": "QK_MAGIC_GUI_ON",
"label": "GUI On",
"aliases": [
"GU_ON"
]
@ -75,6 +85,7 @@
"0x700A": {
"group": "magic",
"key": "QK_MAGIC_GUI_OFF",
"label": "GUI Off",
"aliases": [
"GU_OFF"
]
@ -82,6 +93,7 @@
"0x700B": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_GUI",
"label": "Toggle GUI",
"aliases": [
"GU_TOGG"
]
@ -89,6 +101,7 @@
"0x700C": {
"group": "magic",
"key": "QK_MAGIC_SWAP_GRAVE_ESC",
"label": "Swap `⇄Esc",
"aliases": [
"GE_SWAP"
]
@ -96,6 +109,7 @@
"0x700D": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_GRAVE_ESC",
"label": "Unswap `⇄Esc",
"aliases": [
"GE_NORM"
]
@ -103,6 +117,7 @@
"0x700E": {
"group": "magic",
"key": "QK_MAGIC_SWAP_BACKSLASH_BACKSPACE",
"label": "Swap \\⇄Bspc",
"aliases": [
"BS_SWAP"
]
@ -110,6 +125,7 @@
"0x700F": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_BACKSLASH_BACKSPACE",
"label": "Unswap \\⇄Bspc",
"aliases": [
"BS_NORM"
]
@ -117,6 +133,7 @@
"0x7010": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_BACKSLASH_BACKSPACE",
"label": "Toggle \\⇄Bspc",
"aliases": [
"BS_TOGG"
]
@ -124,6 +141,7 @@
"0x7011": {
"group": "magic",
"key": "QK_MAGIC_NKRO_ON",
"label": "NKRO On",
"aliases": [
"NK_ON"
]
@ -131,6 +149,7 @@
"0x7012": {
"group": "magic",
"key": "QK_MAGIC_NKRO_OFF",
"label": "NKRO Off",
"aliases": [
"NK_OFF"
]
@ -138,6 +157,7 @@
"0x7013": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_NKRO",
"label": "Toggle NKRO",
"aliases": [
"NK_TOGG"
]
@ -145,6 +165,7 @@
"0x7014": {
"group": "magic",
"key": "QK_MAGIC_SWAP_ALT_GUI",
"label": "Swap Alt⇄GUI",
"aliases": [
"AG_SWAP"
]
@ -152,6 +173,7 @@
"0x7015": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_ALT_GUI",
"label": "Unswap Alt⇄GUI",
"aliases": [
"AG_NORM"
]
@ -159,6 +181,7 @@
"0x7016": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_ALT_GUI",
"label": "Toggle Alt⇄GUI",
"aliases": [
"AG_TOGG"
]
@ -166,6 +189,7 @@
"0x7017": {
"group": "magic",
"key": "QK_MAGIC_SWAP_LCTL_LGUI",
"label": "Swap LCtl⇄LGUI",
"aliases": [
"CG_LSWP"
]
@ -173,6 +197,7 @@
"0x7018": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_LCTL_LGUI",
"label": "Unswap LCtl⇄LGUI",
"aliases": [
"CG_LNRM"
]
@ -180,6 +205,7 @@
"0x7019": {
"group": "magic",
"key": "QK_MAGIC_SWAP_RCTL_RGUI",
"label": "Swap RCtl⇄RGUI",
"aliases": [
"CG_RSWP"
]
@ -187,6 +213,7 @@
"0x701A": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_RCTL_RGUI",
"label": "Unswap RCtl⇄RGUI",
"aliases": [
"CG_RNRM"
]
@ -194,6 +221,7 @@
"0x701B": {
"group": "magic",
"key": "QK_MAGIC_SWAP_CTL_GUI",
"label": "Swap Ctl⇄GUI",
"aliases": [
"CG_SWAP"
]
@ -201,6 +229,7 @@
"0x701C": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_CTL_GUI",
"label": "Unswap Ctl⇄GUI",
"aliases": [
"CG_NORM"
]
@ -208,6 +237,7 @@
"0x701D": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_CTL_GUI",
"label": "Toggle Ctl⇄GUI",
"aliases": [
"CG_TOGG"
]
@ -215,6 +245,7 @@
"0x701E": {
"group": "magic",
"key": "QK_MAGIC_EE_HANDS_LEFT",
"label": "EE Hands Left",
"aliases": [
"EH_LEFT"
]
@ -222,6 +253,7 @@
"0x701F": {
"group": "magic",
"key": "QK_MAGIC_EE_HANDS_RIGHT",
"label": "EE Hands Right",
"aliases": [
"EH_RGHT"
]
@ -229,6 +261,7 @@
"0x7020": {
"group": "magic",
"key": "QK_MAGIC_SWAP_ESCAPE_CAPS_LOCK",
"label": "Swap Esc⇄Caps",
"aliases": [
"EC_SWAP"
]
@ -236,6 +269,7 @@
"0x7021": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_ESCAPE_CAPS_LOCK",
"label": "Unswap Esc⇄Caps",
"aliases": [
"EC_NORM"
]
@ -243,6 +277,7 @@
"0x7022": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_ESCAPE_CAPS_LOCK",
"label": "Toggle Esc⇄Caps",
"aliases": [
"EC_TOGG"
]

File diff suppressed because it is too large Load diff

View file

@ -3,6 +3,7 @@
"0x7C77": {
"group": "quantum",
"key": "QK_TRI_LAYER_LOWER",
"label": "Lower",
"aliases": [
"TL_LOWR"
]
@ -10,6 +11,7 @@
"0x7C78": {
"group": "quantum",
"key": "QK_TRI_LAYER_UPPER",
"label": "Upper",
"aliases": [
"TL_UPPR"
]

View file

@ -5,6 +5,7 @@
"0x7200": {
"group": "sequencer",
"key": "QK_SEQUENCER_ON",
"label": "Sequencer On",
"aliases": [
"SQ_ON"
]
@ -12,6 +13,7 @@
"0x7201": {
"group": "sequencer",
"key": "QK_SEQUENCER_OFF",
"label": "Sequencer Off",
"aliases": [
"SQ_OFF"
]
@ -19,6 +21,7 @@
"0x7202": {
"group": "sequencer",
"key": "QK_SEQUENCER_TOGGLE",
"label": "Toggle Sequencer",
"aliases": [
"SQ_TOGG"
]
@ -26,6 +29,7 @@
"0x7203": {
"group": "sequencer",
"key": "QK_SEQUENCER_TEMPO_DOWN",
"label": "Tempo Down",
"aliases": [
"SQ_TMPD"
]
@ -33,6 +37,7 @@
"0x7204": {
"group": "sequencer",
"key": "QK_SEQUENCER_TEMPO_UP",
"label": "Tempo Up",
"aliases": [
"SQ_TMPU"
]
@ -40,6 +45,7 @@
"0x7205": {
"group": "sequencer",
"key": "QK_SEQUENCER_RESOLUTION_DOWN",
"label": "Resolution Down",
"aliases": [
"SQ_RESD"
]
@ -47,6 +53,7 @@
"0x7206": {
"group": "sequencer",
"key": "QK_SEQUENCER_RESOLUTION_UP",
"label": "Resolution Up",
"aliases": [
"SQ_RESU"
]
@ -54,6 +61,7 @@
"0x7207": {
"group": "sequencer",
"key": "QK_SEQUENCER_STEPS_ALL",
"label": "All Steps",
"aliases": [
"SQ_SALL"
]
@ -61,6 +69,7 @@
"0x7208": {
"group": "sequencer",
"key": "QK_SEQUENCER_STEPS_CLEAR",
"label": "Clear Steps",
"aliases": [
"SQ_SCLR"
]

View file

@ -3,6 +3,7 @@
"0x56F0": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_TOGGLE",
"label": "Toggle Swap Hands",
"aliases": [
"SH_TOGG"
]
@ -10,6 +11,7 @@
"0x56F1": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_TAP_TOGGLE",
"label": "Swap Hands Tap Toggle",
"aliases": [
"SH_TT"
]
@ -17,6 +19,7 @@
"0x56F2": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_MOMENTARY_ON",
"label": "Swap Hands Momentary On",
"aliases": [
"SH_MON"
]
@ -24,6 +27,7 @@
"0x56F3": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_MOMENTARY_OFF",
"label": "Swap Hands Momentary Off",
"aliases": [
"SH_MOFF"
]
@ -31,6 +35,7 @@
"0x56F4": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_OFF",
"label": "Unswap Hands",
"aliases": [
"SH_OFF"
]
@ -38,6 +43,7 @@
"0x56F5": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_ON",
"label": "Swap Hands",
"aliases": [
"SH_ON"
]
@ -45,6 +51,7 @@
"0x56F6": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_ONE_SHOT",
"label": "Swap Hands One Shot",
"aliases": [
"SH_OS"
]

View file

@ -2,131 +2,163 @@
"keycodes": {
"0x7E40": {
"group": "user",
"key": "QK_USER_0"
"key": "QK_USER_0",
"label": "User 0"
},
"0x7E41": {
"group": "user",
"key": "QK_USER_1"
"key": "QK_USER_1",
"label": "User 1"
},
"0x7E42": {
"group": "user",
"key": "QK_USER_2"
"key": "QK_USER_2",
"label": "User 2"
},
"0x7E43": {
"group": "user",
"key": "QK_USER_3"
"key": "QK_USER_3",
"label": "User 3"
},
"0x7E44": {
"group": "user",
"key": "QK_USER_4"
"key": "QK_USER_4",
"label": "User 4"
},
"0x7E45": {
"group": "user",
"key": "QK_USER_5"
"key": "QK_USER_5",
"label": "User 5"
},
"0x7E46": {
"group": "user",
"key": "QK_USER_6"
"key": "QK_USER_6",
"label": "User 6"
},
"0x7E47": {
"group": "user",
"key": "QK_USER_7"
"key": "QK_USER_7",
"label": "User 7"
},
"0x7E48": {
"group": "user",
"key": "QK_USER_8"
"key": "QK_USER_8",
"label": "User 8"
},
"0x7E49": {
"group": "user",
"key": "QK_USER_9"
"key": "QK_USER_9",
"label": "User 9"
},
"0x7E4A": {
"group": "user",
"key": "QK_USER_10"
"key": "QK_USER_10",
"label": "User 10"
},
"0x7E4B": {
"group": "user",
"key": "QK_USER_11"
"key": "QK_USER_11",
"label": "User 11"
},
"0x7E4C": {
"group": "user",
"key": "QK_USER_12"
"key": "QK_USER_12",
"label": "User 12"
},
"0x7E4D": {
"group": "user",
"key": "QK_USER_13"
"key": "QK_USER_13",
"label": "User 13"
},
"0x7E4E": {
"group": "user",
"key": "QK_USER_14"
"key": "QK_USER_14",
"label": "User 14"
},
"0x7E4F": {
"group": "user",
"key": "QK_USER_15"
"key": "QK_USER_15",
"label": "User 15"
},
"0x7E50": {
"group": "user",
"key": "QK_USER_16"
"key": "QK_USER_16",
"label": "User 16"
},
"0x7E51": {
"group": "user",
"key": "QK_USER_17"
"key": "QK_USER_17",
"label": "User 17"
},
"0x7E52": {
"group": "user",
"key": "QK_USER_18"
"key": "QK_USER_18",
"label": "User 18"
},
"0x7E53": {
"group": "user",
"key": "QK_USER_19"
"key": "QK_USER_19",
"label": "User 19"
},
"0x7E54": {
"group": "user",
"key": "QK_USER_20"
"key": "QK_USER_20",
"label": "User 20"
},
"0x7E55": {
"group": "user",
"key": "QK_USER_21"
"key": "QK_USER_21",
"label": "User 21"
},
"0x7E56": {
"group": "user",
"key": "QK_USER_22"
"key": "QK_USER_22",
"label": "User 22"
},
"0x7E57": {
"group": "user",
"key": "QK_USER_23"
"key": "QK_USER_23",
"label": "User 23"
},
"0x7E58": {
"group": "user",
"key": "QK_USER_24"
"key": "QK_USER_24",
"label": "User 24"
},
"0x7E59": {
"group": "user",
"key": "QK_USER_25"
"key": "QK_USER_25",
"label": "User 25"
},
"0x7E5A": {
"group": "user",
"key": "QK_USER_26"
"key": "QK_USER_26",
"label": "User 26"
},
"0x7E5B": {
"group": "user",
"key": "QK_USER_27"
"key": "QK_USER_27",
"label": "User 27"
},
"0x7E5C": {
"group": "user",
"key": "QK_USER_28"
"key": "QK_USER_28",
"label": "User 28"
},
"0x7E5D": {
"group": "user",
"key": "QK_USER_29"
"key": "QK_USER_29",
"label": "User 29"
},
"0x7E5E": {
"group": "user",
"key": "QK_USER_30"
"key": "QK_USER_30",
"label": "User 30"
},
"0x7E5F": {
"group": "user",
"key": "QK_USER_31"
"key": "QK_USER_31",
"label": "User 31"
}
}
}

View file

@ -3,6 +3,7 @@
"0x7C79": {
"group": "quantum",
"key": "QK_REPEAT_KEY",
"label": "Repeat",
"aliases": [
"QK_REP"
]
@ -10,6 +11,7 @@
"0x7C7A": {
"group": "quantum",
"key": "QK_ALT_REPEAT_KEY",
"label": "Repeat Alternate",
"aliases": [
"QK_AREP"
]

View file

@ -3,6 +3,7 @@
"0x7810": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_ON",
"label": "LED Matrix On",
"aliases": [
"LM_ON"
]
@ -10,6 +11,7 @@
"0x7811": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_OFF",
"label": "LED Matrix Off",
"aliases": [
"LM_OFF"
]
@ -17,6 +19,7 @@
"0x7812": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_TOGGLE",
"label": "Toggle LED Matrix",
"aliases": [
"LM_TOGG"
]
@ -24,6 +27,7 @@
"0x7813": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_MODE_NEXT",
"label": "LED Matrix Next",
"aliases": [
"LM_NEXT"
]
@ -31,6 +35,7 @@
"0x7814": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_MODE_PREVIOUS",
"label": "LED Matrix Previous",
"aliases": [
"LM_PREV"
]
@ -38,6 +43,7 @@
"0x7815": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_BRIGHTNESS_UP",
"label": "LED Matrix Brightness Up",
"aliases": [
"LM_BRIU"
]
@ -45,6 +51,7 @@
"0x7816": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_BRIGHTNESS_DOWN",
"label": "LED Matrix Brightness Down",
"aliases": [
"LM_BRID"
]
@ -52,6 +59,7 @@
"0x7817": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_SPEED_UP",
"label": "LED Matrix Speed Up",
"aliases": [
"LM_SPDU"
]
@ -59,6 +67,7 @@
"0x7818": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_SPEED_DOWN",
"label": "LED Matrix Speed Down",
"aliases": [
"LM_SPDD"
]
@ -67,6 +76,7 @@
"0x7820": {
"group": "underglow",
"key": "QK_UNDERGLOW_TOGGLE",
"label": "Toggle RGB Underglow",
"aliases": [
"UG_TOGG"
]
@ -74,6 +84,7 @@
"0x7821": {
"group": "underglow",
"key": "QK_UNDERGLOW_MODE_NEXT",
"label": "RGB Underglow Next",
"aliases": [
"!reset!",
"UG_NEXT"
@ -82,6 +93,7 @@
"0x7822": {
"group": "underglow",
"key": "QK_UNDERGLOW_MODE_PREVIOUS",
"label": "RGB Underglow Previous",
"aliases": [
"!reset!",
"UG_PREV"
@ -90,6 +102,7 @@
"0x7823": {
"group": "underglow",
"key": "QK_UNDERGLOW_HUE_UP",
"label": "RGB Underglow Hue Up",
"aliases": [
"UG_HUEU"
]
@ -97,6 +110,7 @@
"0x7824": {
"group": "underglow",
"key": "QK_UNDERGLOW_HUE_DOWN",
"label": "RGB Underglow Hue Down",
"aliases": [
"UG_HUED"
]
@ -104,6 +118,7 @@
"0x7825": {
"group": "underglow",
"key": "QK_UNDERGLOW_SATURATION_UP",
"label": "RGB Underglow Saturation Up",
"aliases": [
"UG_SATU"
]
@ -111,6 +126,7 @@
"0x7826": {
"group": "underglow",
"key": "QK_UNDERGLOW_SATURATION_DOWN",
"label": "RGB Underglow Saturation Down",
"aliases": [
"UG_SATD"
]
@ -118,6 +134,7 @@
"0x7827": {
"group": "underglow",
"key": "QK_UNDERGLOW_VALUE_UP",
"label": "RGB Underglow Value Up",
"aliases": [
"UG_VALU"
]
@ -125,6 +142,7 @@
"0x7828": {
"group": "underglow",
"key": "QK_UNDERGLOW_VALUE_DOWN",
"label": "RGB Underglow Value Down",
"aliases": [
"UG_VALD"
]
@ -132,6 +150,7 @@
"0x7829": {
"group": "underglow",
"key": "QK_UNDERGLOW_SPEED_UP",
"label": "RGB Underglow Speed Up",
"aliases": [
"UG_SPDU"
]
@ -139,6 +158,7 @@
"0x782A": {
"group": "underglow",
"key": "QK_UNDERGLOW_SPEED_DOWN",
"label": "RGB Underglow Speed Down",
"aliases": [
"UG_SPDD"
]
@ -147,6 +167,7 @@
"0x7840": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_ON",
"label": "RGB Matrix On",
"aliases": [
"RM_ON"
]
@ -154,6 +175,7 @@
"0x7841": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_OFF",
"label": "RGB Matrix Off"
"aliases": [
"RM_OFF"
]
@ -161,6 +183,7 @@
"0x7842": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_TOGGLE",
"label": "Toggle RGB Matrix",
"aliases": [
"RM_TOGG"
]
@ -168,6 +191,7 @@
"0x7843": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_MODE_NEXT",
"label": "RGB Matrix Next",
"aliases": [
"RM_NEXT"
]
@ -175,6 +199,7 @@
"0x7844": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_MODE_PREVIOUS",
"label": "RGB Matrix Previous",
"aliases": [
"RM_PREV"
]
@ -182,6 +207,7 @@
"0x7845": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_HUE_UP",
"label": "RGB Matrix Hue Up",
"aliases": [
"RM_HUEU"
]
@ -189,6 +215,7 @@
"0x7846": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_HUE_DOWN",
"label": "RGB Matrix Hue Down",
"aliases": [
"RM_HUED"
]
@ -196,6 +223,7 @@
"0x7847": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_SATURATION_UP",
"label": "RGB Matrix Saturation Up",
"aliases": [
"RM_SATU"
]
@ -203,6 +231,7 @@
"0x7848": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_SATURATION_DOWN",
"label": "RGB Matrix Saturation Down",
"aliases": [
"RM_SATD"
]
@ -210,6 +239,7 @@
"0x7849": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_VALUE_UP",
"label": "RGB Matrix Value Up",
"aliases": [
"RM_VALU"
]
@ -217,6 +247,7 @@
"0x784A": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_VALUE_DOWN",
"label": "RGB Matrix Value Down",
"aliases": [
"RM_VALD"
]
@ -224,6 +255,7 @@
"0x784B": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_SPEED_UP",
"label": "RGB Matrix Speed Up",
"aliases": [
"RM_SPDU"
]
@ -231,6 +263,7 @@
"0x784C": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_SPEED_DOWN",
"label": "RGB Matrix Speed Down",
"aliases": [
"RM_SPDD"
]

View file

@ -3,7 +3,7 @@
"0x00CD": {
"group": "mouse",
"key": "QK_MOUSE_CURSOR_UP",
"label": "Mouse cursor up",
"label": "Mouse Up",
"aliases": [
"!reset!",
"MS_UP"
@ -12,7 +12,7 @@
"0x00CE": {
"group": "mouse",
"key": "QK_MOUSE_CURSOR_DOWN",
"label": "Mouse cursor down",
"label": "Mouse Down",
"aliases": [
"!reset!",
"MS_DOWN"
@ -21,7 +21,7 @@
"0x00CF": {
"group": "mouse",
"key": "QK_MOUSE_CURSOR_LEFT",
"label": "Mouse cursor left",
"label": "Mouse Left",
"aliases": [
"!reset!",
"MS_LEFT"
@ -30,7 +30,7 @@
"0x00D0": {
"group": "mouse",
"key": "QK_MOUSE_CURSOR_RIGHT",
"label": "Mouse cursor right",
"label": "Mouse Right",
"aliases": [
"!reset!",
"MS_RGHT"
@ -39,7 +39,7 @@
"0x00D1": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_1",
"label": "Mouse button 1",
"label": "Mouse Button 1",
"aliases": [
"!reset!",
"MS_BTN1"
@ -48,7 +48,7 @@
"0x00D2": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_2",
"label": "Mouse button 2",
"label": "Mouse Button 2",
"aliases": [
"!reset!",
"MS_BTN2"
@ -57,7 +57,7 @@
"0x00D3": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_3",
"label": "Mouse button 3",
"label": "Mouse Button 3",
"aliases": [
"!reset!",
"MS_BTN3"
@ -66,7 +66,7 @@
"0x00D4": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_4",
"label": "Mouse button 4",
"label": "Mouse Button 4",
"aliases": [
"!reset!",
"MS_BTN4"
@ -75,7 +75,7 @@
"0x00D5": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_5",
"label": "Mouse button 5",
"label": "Mouse Button 5",
"aliases": [
"!reset!",
"MS_BTN5"
@ -84,7 +84,7 @@
"0x00D6": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_6",
"label": "Mouse button 6",
"label": "Mouse Button 6",
"aliases": [
"!reset!",
"MS_BTN6"
@ -93,7 +93,7 @@
"0x00D7": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_7",
"label": "Mouse button 7",
"label": "Mouse Button 7",
"aliases": [
"!reset!",
"MS_BTN7"
@ -102,7 +102,7 @@
"0x00D8": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_8",
"label": "Mouse button 8",
"label": "Mouse Button 8",
"aliases": [
"!reset!",
"MS_BTN8"
@ -111,7 +111,7 @@
"0x00D9": {
"group": "mouse",
"key": "QK_MOUSE_WHEEL_UP",
"label": "Mouse wheel up",
"label": "Mouse Wheel Up",
"aliases": [
"!reset!",
"MS_WHLU"
@ -120,7 +120,7 @@
"0x00DA": {
"group": "mouse",
"key": "QK_MOUSE_WHEEL_DOWN",
"label": "Mouse wheel down",
"label": "Mouse Wheel Down",
"aliases": [
"!reset!",
"MS_WHLD"
@ -129,7 +129,7 @@
"0x00DB": {
"group": "mouse",
"key": "QK_MOUSE_WHEEL_LEFT",
"label": "Mouse wheel left",
"label": "Mouse Wheel Left",
"aliases": [
"!reset!",
"MS_WHLL"
@ -138,7 +138,7 @@
"0x00DC": {
"group": "mouse",
"key": "QK_MOUSE_WHEEL_RIGHT",
"label": "Mouse wheel right",
"label": "Mouse Wheel Right",
"aliases": [
"!reset!",
"MS_WHLR"
@ -147,7 +147,7 @@
"0x00DD": {
"group": "mouse",
"key": "QK_MOUSE_ACCELERATION_0",
"label": "Set mouse acceleration to 0",
"label": "Acceleration 0",
"aliases": [
"!reset!",
"MS_ACL0"
@ -156,7 +156,7 @@
"0x00DE": {
"group": "mouse",
"key": "QK_MOUSE_ACCELERATION_1",
"label": "Set mouse acceleration to 1",
"label": "Acceleration 1",
"aliases": [
"!reset!",
"MS_ACL1"
@ -165,7 +165,7 @@
"0x00DF": {
"group": "mouse",
"key": "QK_MOUSE_ACCELERATION_2",
"label": "Set mouse acceleration to 2",
"label": "Acceleration 2",
"aliases": [
"!reset!",
"MS_ACL2"

View file

@ -8,6 +8,7 @@
"0x7780": {
"group": "connection",
"key": "QK_OUTPUT_AUTO",
"label": "Output Auto",
"aliases": [
"OU_AUTO"
]
@ -15,6 +16,7 @@
"0x7781": {
"group": "connection",
"key": "QK_OUTPUT_NEXT",
"label": "Next Output",
"aliases": [
"OU_NEXT"
]
@ -22,6 +24,7 @@
"0x7782": {
"group": "connection",
"key": "QK_OUTPUT_PREV",
"label": "Previous Output",
"aliases": [
"OU_PREV"
]
@ -29,6 +32,7 @@
"0x7783": {
"group": "connection",
"key": "QK_OUTPUT_NONE",
"label": "None",
"aliases": [
"OU_NONE"
]
@ -36,6 +40,7 @@
"0x7784": {
"group": "connection",
"key": "QK_OUTPUT_USB",
"label": "USB",
"aliases": [
"OU_USB"
]
@ -43,6 +48,7 @@
"0x7785": {
"group": "connection",
"key": "QK_OUTPUT_2P4GHZ",
"label": "2.4GHz",
"aliases": [
"OU_2P4G"
]
@ -50,6 +56,7 @@
"0x7786": {
"group": "connection",
"key": "QK_OUTPUT_BLUETOOTH",
"label": "Bluetooth",
"aliases": [
"OU_BT"
]
@ -58,6 +65,7 @@
"0x7790": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE_NEXT",
"label": "Bluetooth Profile Next",
"aliases": [
"BT_NEXT"
]
@ -65,6 +73,7 @@
"0x7791": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE_PREV",
"label": "Bluetooth Profile Previous",
"aliases": [
"BT_PREV"
]
@ -72,6 +81,7 @@
"0x7792": {
"group": "connection",
"key": "QK_BLUETOOTH_UNPAIR",
"label": "Unpair",
"aliases": [
"BT_UNPR"
]
@ -79,6 +89,7 @@
"0x7793": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE1",
"label": "Bluetooth Profile 1",
"aliases": [
"BT_PRF1"
]
@ -86,6 +97,7 @@
"0x7794": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE2",
"label": "Bluetooth Profile 2",
"aliases": [
"BT_PRF2"
]
@ -93,6 +105,7 @@
"0x7795": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE3",
"label": "Bluetooth Profile 3",
"aliases": [
"BT_PRF3"
]
@ -100,6 +113,7 @@
"0x7796": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE4",
"label": "Bluetooth Profile 4",
"aliases": [
"BT_PRF4"
]
@ -107,6 +121,7 @@
"0x7797": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE5",
"label": "Bluetooth Profile 5",
"aliases": [
"BT_PRF5"
]

View file

@ -6,6 +6,7 @@
"0x7C7B": {
"group": "quantum",
"key": "QK_LAYER_LOCK",
"label": "Layer Lock",
"aliases": [
"QK_LLCK"
]

View file

@ -0,0 +1,37 @@
{
"keycodes": {
"0x7819": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_FLAG_NEXT",
"label": "LED Matrix Flag Next",
"aliases": [
"LM_FLGN"
]
},
"0x781A": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_FLAG_PREVIOUS",
"label": "LED Matrix Flag Previous",
"aliases": [
"LM_FLGP"
]
},
"0x784D": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_FLAG_NEXT",
"label": "RGB Matrix Flag Next",
"aliases": [
"RM_FLGN"
]
},
"0x784E": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_FLAG_PREVIOUS",
"label": "RGB Matrix Flag Previous",
"aliases": [
"RM_FLGP"
]
}
}
}

View file

@ -0,0 +1,265 @@
{
"ranges": {
"0x5A40/0x003F": {
"define": "QK_PLOVER_HID"
}
},
"keycodes": {
"0x5A40": {
"group": "plover_hid",
"key": "PLV_S1"
},
"0x5A41": {
"group": "plover_hid",
"key": "PLV_TL"
},
"0x5A42": {
"group": "plover_hid",
"key": "PLV_KL"
},
"0x5A43": {
"group": "plover_hid",
"key": "PLV_PL"
},
"0x5A44": {
"group": "plover_hid",
"key": "PLV_WL"
},
"0x5A45": {
"group": "plover_hid",
"key": "PLV_HL"
},
"0x5A46": {
"group": "plover_hid",
"key": "PLV_RL"
},
"0x5A47": {
"group": "plover_hid",
"key": "PLV_A"
},
"0x5A48": {
"group": "plover_hid",
"key": "PLV_O"
},
"0x5A49": {
"group": "plover_hid",
"key": "PLV_ST1"
},
"0x5A4A": {
"group": "plover_hid",
"key": "PLV_E"
},
"0x5A4B": {
"group": "plover_hid",
"key": "PLV_U"
},
"0x5A4C": {
"group": "plover_hid",
"key": "PLV_FR"
},
"0x5A4D": {
"group": "plover_hid",
"key": "PLV_RR"
},
"0x5A4E": {
"group": "plover_hid",
"key": "PLV_PR"
},
"0x5A4F": {
"group": "plover_hid",
"key": "PLV_BR"
},
"0x5A50": {
"group": "plover_hid",
"key": "PLV_LR"
},
"0x5A51": {
"group": "plover_hid",
"key": "PLV_GR"
},
"0x5A52": {
"group": "plover_hid",
"key": "PLV_TR"
},
"0x5A53": {
"group": "plover_hid",
"key": "PLV_SR"
},
"0x5A54": {
"group": "plover_hid",
"key": "PLV_DR"
},
"0x5A55": {
"group": "plover_hid",
"key": "PLV_ZR"
},
"0x5A56": {
"group": "plover_hid",
"key": "PLV_N1"
},
"0x5A57": {
"group": "plover_hid",
"key": "PLV_S2"
},
"0x5A58": {
"group": "plover_hid",
"key": "PLV_ST2"
},
"0x5A59": {
"group": "plover_hid",
"key": "PLV_ST3"
},
"0x5A5A": {
"group": "plover_hid",
"key": "PLV_ST4"
},
"0x5A5B": {
"group": "plover_hid",
"key": "PLV_N2"
},
"0x5A5C": {
"group": "plover_hid",
"key": "PLV_N3"
},
"0x5A5D": {
"group": "plover_hid",
"key": "PLV_N4"
},
"0x5A5E": {
"group": "plover_hid",
"key": "PLV_N5"
},
"0x5A5F": {
"group": "plover_hid",
"key": "PLV_N6"
},
"0x5A60": {
"group": "plover_hid",
"key": "PLV_N7"
},
"0x5A61": {
"group": "plover_hid",
"key": "PLV_N8"
},
"0x5A62": {
"group": "plover_hid",
"key": "PLV_N9"
},
"0x5A63": {
"group": "plover_hid",
"key": "PLV_NA"
},
"0x5A64": {
"group": "plover_hid",
"key": "PLV_NB"
},
"0x5A65": {
"group": "plover_hid",
"key": "PLV_NC"
},
"0x5A66": {
"group": "plover_hid",
"key": "PLV_X1"
},
"0x5A67": {
"group": "plover_hid",
"key": "PLV_X2"
},
"0x5A68": {
"group": "plover_hid",
"key": "PLV_X3"
},
"0x5A69": {
"group": "plover_hid",
"key": "PLV_X4"
},
"0x5A6A": {
"group": "plover_hid",
"key": "PLV_X5"
},
"0x5A6B": {
"group": "plover_hid",
"key": "PLV_X6"
},
"0x5A6C": {
"group": "plover_hid",
"key": "PLV_X7"
},
"0x5A6D": {
"group": "plover_hid",
"key": "PLV_X8"
},
"0x5A6E": {
"group": "plover_hid",
"key": "PLV_X9"
},
"0x5A6F": {
"group": "plover_hid",
"key": "PLV_X10"
},
"0x5A70": {
"group": "plover_hid",
"key": "PLV_X11"
},
"0x5A71": {
"group": "plover_hid",
"key": "PLV_X12"
},
"0x5A72": {
"group": "plover_hid",
"key": "PLV_X13"
},
"0x5A73": {
"group": "plover_hid",
"key": "PLV_X14"
},
"0x5A74": {
"group": "plover_hid",
"key": "PLV_X15"
},
"0x5A75": {
"group": "plover_hid",
"key": "PLV_X16"
},
"0x5A76": {
"group": "plover_hid",
"key": "PLV_X17"
},
"0x5A77": {
"group": "plover_hid",
"key": "PLV_X18"
},
"0x5A78": {
"group": "plover_hid",
"key": "PLV_X19"
},
"0x5A79": {
"group": "plover_hid",
"key": "PLV_X20"
},
"0x5A7A": {
"group": "plover_hid",
"key": "PLV_X21"
},
"0x5A7B": {
"group": "plover_hid",
"key": "PLV_X22"
},
"0x5A7C": {
"group": "plover_hid",
"key": "PLV_X23"
},
"0x5A7D": {
"group": "plover_hid",
"key": "PLV_X24"
},
"0x5A7E": {
"group": "plover_hid",
"key": "PLV_X25"
},
"0x5A7F": {
"group": "plover_hid",
"key": "PLV_X26"
}
}
}

View file

@ -0,0 +1,3 @@
{
// This version exists to signify addition of split data sync support.
}

View file

@ -0,0 +1,3 @@
{
// This version exists to signify addition of eeconfig support.
}

View file

@ -19,6 +19,8 @@
// Audio
"AUDIO_DEFAULT_ON": {"info_key": "audio.default.on", "value_type": "bool"},
"AUDIO_DEFAULT_CLICKY_ON": {"info_key": "audio.default.clicky", "value_type": "bool"},
"AUDIO_PIN": {"info_key": "audio.pins.0"},
"AUDIO_PIN_ALT": {"info_key": "audio.pins.1"},
"AUDIO_POWER_CONTROL_PIN": {"info_key": "audio.power_control.pin"},
"AUDIO_POWER_CONTROL_PIN_ON_STATE": {"info_key": "audio.power_control.on_state", "value_type": "int" },
"AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "flag"},
@ -98,6 +100,7 @@
// LED Matrix
"LED_MATRIX_CENTER": {"info_key": "led_matrix.center_point", "value_type": "array.int"},
"LED_MATRIX_FLAG_STEPS": {"info_key": "led_matrix.flag_steps", "value_type": "array.int"},
"LED_MATRIX_KEYRELEASES": {"info_key": "led_matrix.react_on_keyup", "value_type": "flag"},
"LED_MATRIX_LED_FLUSH_LIMIT": {"info_key": "led_matrix.led_flush_limit", "value_type": "int"},
"LED_MATRIX_LED_PROCESS_LIMIT": {"info_key": "led_matrix.led_process_limit", "value_type": "int", "to_json": false},
@ -111,6 +114,7 @@
"LED_MATRIX_DEFAULT_ON": {"info_key": "led_matrix.default.on", "value_type": "bool"},
"LED_MATRIX_DEFAULT_VAL": {"info_key": "led_matrix.default.val", "value_type": "int"},
"LED_MATRIX_DEFAULT_SPD": {"info_key": "led_matrix.default.speed", "value_type": "int"},
"LED_MATRIX_DEFAULT_FLAGS": {"info_key": "led_matrix.default.flags", "value_type": "int"},
// Locking Switch
"LOCKING_SUPPORT_ENABLE": {"info_key": "qmk.locking.enabled", "value_type": "flag"},
@ -147,6 +151,7 @@
// RGB Matrix
"RGB_MATRIX_CENTER": {"info_key": "rgb_matrix.center_point", "value_type": "array.int"},
"RGB_MATRIX_FLAG_STEPS": {"info_key": "rgb_matrix.flag_steps", "value_type": "array.int"},
"RGB_MATRIX_HUE_STEP": {"info_key": "rgb_matrix.hue_steps", "value_type": "int"},
"RGB_MATRIX_KEYRELEASES": {"info_key": "rgb_matrix.react_on_keyup", "value_type": "flag"},
"RGB_MATRIX_LED_FLUSH_LIMIT": {"info_key": "rgb_matrix.led_flush_limit", "value_type": "int"},
@ -164,6 +169,7 @@
"RGB_MATRIX_DEFAULT_SAT": {"info_key": "rgb_matrix.default.sat", "value_type": "int"},
"RGB_MATRIX_DEFAULT_VAL": {"info_key": "rgb_matrix.default.val", "value_type": "int"},
"RGB_MATRIX_DEFAULT_SPD": {"info_key": "rgb_matrix.default.speed", "value_type": "int"},
"RGB_MATRIX_DEFAULT_FLAGS": {"info_key": "rgb_matrix.default.flags", "value_type": "int"},
// RGBLight
"RGBLED_SPLIT": {"info_key": "rgblight.split_count", "value_type": "array.int"},
@ -192,7 +198,7 @@
// Split Keyboard
"SOFT_SERIAL_PIN": {"info_key": "split.serial.pin"},
"SELECT_SOFT_SERIAL_SPEED": {"info_key": "split.serial.speed"},
"SELECT_SOFT_SERIAL_SPEED": {"info_key": "split.serial.speed", "value_type": "int"},
"SPLIT_HAND_MATRIX_GRID": {"info_key": "split.handedness.matrix_grid", "value_type": "array", "to_c": false},
"SPLIT_HAND_PIN": {"info_key": "split.handedness.pin"},
"SPLIT_USB_DETECT": {"info_key": "split.usb_detect.enabled", "value_type": "flag"},
@ -220,6 +226,9 @@
"PERMISSIVE_HOLD_PER_KEY": {"info_key": "tapping.permissive_hold_per_key", "value_type": "flag"},
"RETRO_TAPPING": {"info_key": "tapping.retro", "value_type": "flag"},
"RETRO_TAPPING_PER_KEY": {"info_key": "tapping.retro_per_key", "value_type": "flag"},
"SPECULATIVE_HOLD": {"info_key": "tapping.speculative_hold", "value_type": "flag"},
"SPECULATIVE_HOLD_FLOW_TERM": {"info_key": "tapping.speculative_hold_flow_term", "value_type": "int"},
"SPECULATIVE_HOLD_ONE_KEY": {"info_key": "tapping.speculative_hold_one_key", "value_type": "flag"},
"TAP_CODE_DELAY": {"info_key": "qmk.tap_keycode_delay", "value_type": "int"},
"TAP_HOLD_CAPS_DELAY": {"info_key": "qmk.tap_capslock_delay", "value_type": "int"},
"TAPPING_TERM": {"info_key": "tapping.term", "value_type": "int"},
@ -264,9 +273,9 @@
"PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false, "value_type": "str", "deprecated": true, "replace_with": "`keyboard_name` in info.json"},
"PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.pid` in info.json"},
"VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.vid` in info.json"},
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag", "deprecated": true, "replace_with": "`host.default.nkro` in info.json"},
// Items we want flagged in lint
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag", "invalid": true, "replace_with": "`host.default.nkro` in info.json"},
"VIAL_KEYBOARD_UID": {"info_key": "_invalid.vial_uid", "invalid": true},
"VIAL_UNLOCK_COMBO_COLS": {"info_key": "_invalid.vial_unlock_cols", "invalid": true},
"VIAL_UNLOCK_COMBO_ROWS": {"info_key": "_invalid.vial_unlock_rows", "invalid": true}

View file

@ -11,6 +11,9 @@
"on_state": 1
},
"debounce": 5,
"dynamic_keymap": {
"layer_count": 4
},
"features": {
"command": false,
"console": false
@ -23,7 +26,8 @@
"animation": "solid",
"on": true,
"val": 255,
"speed": 128
"speed": 128,
"flags": 255
},
"led_flush_limit": 16,
"max_brightness": 255,
@ -53,7 +57,8 @@
"hue": 0,
"sat": 255,
"val": 255,
"speed": 128
"speed": 128,
"flags": 255
},
"hue_steps": 8,
"led_flush_limit": 16,

View file

@ -1620,8 +1620,11 @@
"0_sixty": {
"target": "0_sixty/base"
},
"0xcb/splaytoraid": {
"target": "0xcb/splaytoraid/rp2040_ce"
"0xcb/splaytoraid/32u4": {
"target": "0xcb/splaytoraid"
},
"0xcb/splaytoraid/rp2040_ce": {
"target": "0xcb/splaytoraid"
},
"1upkeyboards/pi40": {
"target": "1upkeyboards/pi40/mit_v1_0"
@ -1632,12 +1635,24 @@
"1upkeyboards/sweet16": {
"target": "1upkeyboards/sweet16/v1"
},
"1upkeyboards/sweet16v2/kb2040": {
"target": "1upkeyboards/sweet16v2"
},
"1upkeyboards/sweet16v2/pro_micro": {
"target": "1upkeyboards/sweet16v2"
},
"25keys/aleth42": {
"target": "25keys/aleth42/rev1"
},
"25keys/zinc": {
"target": "25keys/zinc/rev1"
},
"40percentclub/gherkin/kb2040": {
"target": "40percentclub/gherkin"
},
"40percentclub/gherkin/pro_micro": {
"target": "40percentclub/gherkin"
},
"40percentclub/i75": {
"target": "40percentclub/i75/promicro"
},
@ -1726,7 +1741,10 @@
"target": "ducky/one2mini/1861st"
},
"ducky/one2sf": {
"target": "ducky/one2sf/1967st"
"target": "ducky/one2sf/1967st/ansi"
},
"ducky/one2sf/1967st": {
"target": "ducky/one2sf/1967st/ansi"
},
"dumbpad": {
"target": "dumbpad/v0x"
@ -1735,7 +1753,7 @@
"target": "durgod/dgk6x/galaxy"
},
"durgod/venus": {
"target": "durgod/dgk6x/venus"
"target": "durgod/dgk6x/venus_ansi"
},
"dztech/tofu/ii": {
"target": "dztech/tofu/ii/v1"

View file

@ -46,7 +46,8 @@
"manufacturer": {"$ref": "./definitions.jsonschema#/text_identifier"},
"url": {
"type": "string",
"format": "uri"
"format": "uri",
"minLength": 1
},
"development_board": {
"type": "string",
@ -333,6 +334,17 @@
}
}
},
"dynamic_keymap": {
"type": "object",
"properties": {
"eeprom_max_addr": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"layer_count": {
"type": "integer",
"minimum": 1,
"maximum": 32
}
}
},
"eeprom": {
"properties": {
"driver": {"type": "string"},
@ -543,7 +555,8 @@
"on": {"type": "boolean"},
"animation": {"type": "string"},
"val": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
"speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"flags": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
}
},
"driver": {
@ -571,6 +584,11 @@
"maxItems": 2,
"items": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
},
"flag_steps": {
"type": "array",
"minItems": 1,
"items": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
},
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"val_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
@ -626,7 +644,8 @@
"hue": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"sat": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"val": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
"speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"flags": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
}
},
"driver": {
@ -656,6 +675,11 @@
"maxItems": 2,
"items": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
},
"flag_steps": {
"type": "array",
"minItems": 1,
"items": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
},
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"hue_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
@ -969,6 +993,7 @@
"type": "object",
"properties": {
"chordal_hold": {"type": "boolean"},
"flow_tap_term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"force_hold": {"type": "boolean"},
"force_hold_per_key": {"type": "boolean"},
"ignore_mod_tap_interrupt": {"type": "boolean"},
@ -978,6 +1003,9 @@
"permissive_hold_per_key": {"type": "boolean"},
"retro": {"type": "boolean"},
"retro_per_key": {"type": "boolean"},
"speculative_hold": {"type": "boolean"},
"speculative_hold_flow_term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"speculative_hold_one_key": {"type": "boolean"},
"term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"term_per_key": {"type": "boolean"},
"toggle": {"$ref": "./definitions.jsonschema#/unsigned_int"}

View file

@ -35,6 +35,17 @@
}
}
},
"dip_switches": {
"type": "array",
"items": {
"type": "object",
"required": ["on", "off"],
"properties": {
"on": {"type": "string"},
"off": {"type": "string"}
}
}
},
"macros": {
"type": "array",
"items": {

190
docs/ChangeLog/20251130.md Normal file
View file

@ -0,0 +1,190 @@
# QMK Breaking Changes - 2025 Nov 30 Changelog
## Notable Features {#notable-features}
### Speculative Hold option for mod-taps: hold mods instantly while unsettled [#25572](https://github.com/qmk/qmk_firmware/pull/25572)
Speculative Hold makes mod-tap keys more responsive by applying the modifier instantly on keydown, before the tap-hold decision is made. This is especially useful for actions like Shift+click and Ctrl+scroll wheel with an external mouse, which can feel laggy with standard mod-taps.
The firmware holds the modifier speculatively. Once the key's behavior is settled:
* If held, the modifier remains active as expected until the key is released.
* If tapped, the speculative modifier is canceled just before the tapping keycode is sent.
Speculative Hold applies the modifier early but does not change the underlying tap-hold decision logic. Speculative Hold is compatible to use in combination with any other tap-hold options.
see the [Speculative Hold](../tap_hold#speculative-hold) documentation for more information.
## Changes Requiring User Action
### Updated Keyboard Codebases
| Old Keyboard Name | New Keyboard Name |
|----------------------------------|-------------------------|
| 0xcb/splaytoraid/32u4 | 0xcb/splaytoraid |
| 0xcb/splaytoraid/rp2040_ce | 0xcb/splaytoraid |
| 1upkeyboards/sweet16v2/kb2040 | 1upkeyboards/sweet16v2 |
| 1upkeyboards/sweet16v2/pro_micro | 1upkeyboards/sweet16v2 |
| 40percentclub/gherkin/kb2040 | 40percentclub/gherkin |
| 40percentclub/gherkin/pro_micro | 40percentclub/gherkin |
| durgod/dgk6x/venus | durgod/dgk6x/venus_ansi |
### Reduce tap dance memory usage, move state out of data [#25415](https://github.com/qmk/qmk_firmware/pull/25415)
The tap dance state has been separated from the action structure. Custom tap dance functions now receive the state as a separate parameter instead of accessing it through `action->state`.
If your keymap uses custom tap dance functions that access the tap dance state, you need to update your code.
* You can't use `action->state`. Instead you need to call `tap_dance_state_t *tap_dance_get_state(uint8_t tap_dance_idx)` to get the state.
* You now get a pointer to the state, so use `->` notation rather than `.` notation to get fields from it.
### Before:
```c
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
tap_dance_action_t *action;
switch (keycode) {
case TD(CT_CLN):
action = tap_dance_get(QK_TAP_DANCE_GET_INDEX(keycode));
if (!record->event.pressed && action->state.count && !action->state.finished) {
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;
tap_code16(tap_hold->tap);
}
}
return true;
}
```
### After:
```c
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
tap_dance_action_t *action;
tap_dance_state_t* state;
switch (keycode) {
case TD(CT_CLN):
action = tap_dance_get(QK_TAP_DANCE_GET_INDEX(keycode));
state = tap_dance_get_state(QK_TAP_DANCE_GET_INDEX(keycode));
if (!record->event.pressed && state != NULL && state->count && !state->finished) {
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;
tap_code16(tap_hold->tap);
}
}
return true;
}
```
## Deprecation Notices
In line with the [notice period](../support_deprecation_policy#how-much-advance-notice-will-be-given), deprecation notices for larger items are listed here.
### Remove override of QK_{LED,RGB}_MATRIX_TOGGLE keycode [#25672](https://github.com/qmk/qmk_firmware/pull/25672)
[#24649](https://github.com/qmk/qmk_firmware/pull/24649) implemented genetic behavior, including keycodes, to cycle flags.
Any overriding of existing keycodes that duplicate this behavior will be removed to ensure consistency with core functionality.
## Full changelist
Core:
* suspend: suppress wake up keypress ([#23389](https://github.com/qmk/qmk_firmware/pull/23389))
* [Feature Improvement]add option to keep layer state when recording dynamic macros ([#24418](https://github.com/qmk/qmk_firmware/pull/24418))
* Add generic handling to cycle LED/RGB Matrix flags ([#24649](https://github.com/qmk/qmk_firmware/pull/24649))
* Implement `mod_t` packed struct ([#25168](https://github.com/qmk/qmk_firmware/pull/25168))
* Implement minimal connection update logic ([#25334](https://github.com/qmk/qmk_firmware/pull/25334))
* Reduce tap dance memory usage, move state out of data ([#25415](https://github.com/qmk/qmk_firmware/pull/25415))
* Refactor debounce algorithm with static allocation ([#25515](https://github.com/qmk/qmk_firmware/pull/25515))
* Restructure Pixel Rain interval code ([#25516](https://github.com/qmk/qmk_firmware/pull/25516))
* Guard remapping logic with MAGIC_ENABLE ([#25537](https://github.com/qmk/qmk_firmware/pull/25537))
* Update default OLED font ([#25565](https://github.com/qmk/qmk_firmware/pull/25565))
* Speculative Hold option for mod-taps: hold mods instantly while unsettled. ([#25572](https://github.com/qmk/qmk_firmware/pull/25572))
* Simplify hue calculation in raindrops animation ([#25587](https://github.com/qmk/qmk_firmware/pull/25587))
* Simplify tap_code16_delay ([#25595](https://github.com/qmk/qmk_firmware/pull/25595))
* Debounce: Deprecate num_rows parameter ([#25632](https://github.com/qmk/qmk_firmware/pull/25632))
* Add I2C Transmit and Receive function ([#25637](https://github.com/qmk/qmk_firmware/pull/25637))
* [QP] Minor cleanup and support for RGB888 surface ([#25706](https://github.com/qmk/qmk_firmware/pull/25706))
* Restrict mouse timer activation to movement keycodes ([#25716](https://github.com/qmk/qmk_firmware/pull/25716))
* Update STM32F446 default HSE to 8MHz ([#25717](https://github.com/qmk/qmk_firmware/pull/25717))
* making flowtap timer public so it can be used easily with combos ([#25731](https://github.com/qmk/qmk_firmware/pull/25731))
* Add PixArt PAW-3222 mouse sensor driver ([#25763](https://github.com/qmk/qmk_firmware/pull/25763))
* Merge upstream uf2conv changes ([#25786](https://github.com/qmk/qmk_firmware/pull/25786))
* Partially skip generating community modules when none enabled ([#25819](https://github.com/qmk/qmk_firmware/pull/25819))
CLI:
* Generate default encoder resolution for sparse config ([#25247](https://github.com/qmk/qmk_firmware/pull/25247))
* Add DIP Switch map support to keymap.json ([#25431](https://github.com/qmk/qmk_firmware/pull/25431))
* Add return code to `qmk userspace-doctor` ([#25775](https://github.com/qmk/qmk_firmware/pull/25775))
* Better defaulting of `{RGB,LED}_MATRIX_DEFAULT_FLAGS` ([#25785](https://github.com/qmk/qmk_firmware/pull/25785))
* add BCD versions of QMK Version ([#25804](https://github.com/qmk/qmk_firmware/pull/25804))
* Lint error on missing keyboard readme ([#25814](https://github.com/qmk/qmk_firmware/pull/25814))
Submodule updates:
* Update ChibiOS-Contrib. ([#25751](https://github.com/qmk/qmk_firmware/pull/25751))
Keyboards:
* `atreus`: restore intended matrix implementations ([#24082](https://github.com/qmk/qmk_firmware/pull/24082))
* add SteelSeries prime, a stripped down prime+ ([#24719](https://github.com/qmk/qmk_firmware/pull/24719))
* Add new macropad Sharkropad ([#24961](https://github.com/qmk/qmk_firmware/pull/24961))
* Addition of the D60B tsangan pcb ([#25245](https://github.com/qmk/qmk_firmware/pull/25245))
* Migrate `eeconfig_init_kb` implementations to config ([#25422](https://github.com/qmk/qmk_firmware/pull/25422))
* Generate `CUSTOM_MATRIX = lite` without `matrix_pins.custom` ([#25453](https://github.com/qmk/qmk_firmware/pull/25453))
* Add classic48 keyboard ([#25492](https://github.com/qmk/qmk_firmware/pull/25492))
* add durgod venus iso support ([#25526](https://github.com/qmk/qmk_firmware/pull/25526))
* Migrate `g_led_config` to DD (0-9, A) ([#25558](https://github.com/qmk/qmk_firmware/pull/25558))
* Migrate `g_led_config` to DD (B, C) ([#25559](https://github.com/qmk/qmk_firmware/pull/25559))
* Migrate `g_led_config` to DD (D) ([#25560](https://github.com/qmk/qmk_firmware/pull/25560))
* Migrate `g_led_config` to DD (E, F) ([#25561](https://github.com/qmk/qmk_firmware/pull/25561))
* Remove duplication of RP2040 config defaults ([#25563](https://github.com/qmk/qmk_firmware/pull/25563))
* Refactor 40percentclub/ut47 ([#25571](https://github.com/qmk/qmk_firmware/pull/25571))
* E7-V2 Implementation ([#25594](https://github.com/qmk/qmk_firmware/pull/25594))
* Migrate `g_led_config` to DD (G) ([#25598](https://github.com/qmk/qmk_firmware/pull/25598))
* Migrate `g_led_config` to DD (H) ([#25599](https://github.com/qmk/qmk_firmware/pull/25599))
* Migrate `g_led_config` to DD (I) ([#25600](https://github.com/qmk/qmk_firmware/pull/25600))
* Migrate `g_led_config` to DD (JK1) ([#25601](https://github.com/qmk/qmk_firmware/pull/25601))
* Migrate `g_led_config` to DD (K2) ([#25602](https://github.com/qmk/qmk_firmware/pull/25602))
* Migrate `g_led_config` to DD (K3) ([#25603](https://github.com/qmk/qmk_firmware/pull/25603))
* Migrate `g_led_config` to DD (K4) ([#25605](https://github.com/qmk/qmk_firmware/pull/25605))
* Migrate `g_led_config` to DD (K5) ([#25606](https://github.com/qmk/qmk_firmware/pull/25606))
* Migrate `g_led_config` to DD (K6) ([#25607](https://github.com/qmk/qmk_firmware/pull/25607))
* Refactor `40percentclub/gherkin` ([#25608](https://github.com/qmk/qmk_firmware/pull/25608))
* Refactor `0xcb/splaytoraid` ([#25609](https://github.com/qmk/qmk_firmware/pull/25609))
* Refactor `1upkeyboards/sweet16v2` ([#25610](https://github.com/qmk/qmk_firmware/pull/25610))
* Migrate `g_led_config` to DD (K7) ([#25616](https://github.com/qmk/qmk_firmware/pull/25616))
* Migrate `g_led_config` to DD (L) ([#25617](https://github.com/qmk/qmk_firmware/pull/25617))
* Migrate `g_led_config` to DD (M1) ([#25618](https://github.com/qmk/qmk_firmware/pull/25618))
* Migrate `g_led_config` to DD (M2) ([#25619](https://github.com/qmk/qmk_firmware/pull/25619))
* Migrate `g_led_config` to DD (M3) ([#25620](https://github.com/qmk/qmk_firmware/pull/25620))
* Migrate `g_led_config` to DD (NO) ([#25621](https://github.com/qmk/qmk_firmware/pull/25621))
* Migrate `g_led_config` to DD (P) ([#25622](https://github.com/qmk/qmk_firmware/pull/25622))
* Migrate `g_led_config` to DD (QR) ([#25623](https://github.com/qmk/qmk_firmware/pull/25623))
* Migrate `g_led_config` to DD (S) ([#25624](https://github.com/qmk/qmk_firmware/pull/25624))
* Migrate `g_led_config` to DD (TUW) ([#25625](https://github.com/qmk/qmk_firmware/pull/25625))
* Remove idobao *_DISABLE_UNDERGLOW behaviour ([#25638](https://github.com/qmk/qmk_firmware/pull/25638))
* Migrate `g_led_config` to DD (YZ) ([#25650](https://github.com/qmk/qmk_firmware/pull/25650))
* Tidy Keebio keyboards ([#25653](https://github.com/qmk/qmk_firmware/pull/25653))
* Remove encoder resolution where duplicating defaults ([#25654](https://github.com/qmk/qmk_firmware/pull/25654))
* Custom oled fonts cleanup ([#25665](https://github.com/qmk/qmk_firmware/pull/25665))
* Binepad KnobX1 - refactor `x1_layer_led` function as weak ([#25668](https://github.com/qmk/qmk_firmware/pull/25668))
* Add DD {LED,RGB}_MATRIX_DEFAULT_FLAGS support ([#25671](https://github.com/qmk/qmk_firmware/pull/25671))
* keyboards: Add Royal Kludge RK61 ([#25694](https://github.com/qmk/qmk_firmware/pull/25694))
* Add TRKeyboard TRK2 keyboard ([#25754](https://github.com/qmk/qmk_firmware/pull/25754))
Keyboard fixes:
* Fixup `kprepublic/bm60hsrgb/rev2` ([#25644](https://github.com/qmk/qmk_firmware/pull/25644))
* Fixup `kprepublic/bm60hsrgb_iso/rev2` ([#25648](https://github.com/qmk/qmk_firmware/pull/25648))
* Fixup `kprepublic/bm60hsrgb_poker/rev2` ([#25649](https://github.com/qmk/qmk_firmware/pull/25649))
* Fixup `rgbkb/pan` ([#25678](https://github.com/qmk/qmk_firmware/pull/25678))
* Align use of keymap level `_kb` callbacks ([#25774](https://github.com/qmk/qmk_firmware/pull/25774))
Others:
* Rework converter docs ([#18314](https://github.com/qmk/qmk_firmware/pull/18314))
* Update USBaspLoader ISP instructions ([#25590](https://github.com/qmk/qmk_firmware/pull/25590))
* Add LED/RGB Matrix flags API docs ([#25673](https://github.com/qmk/qmk_firmware/pull/25673))
Bugs:
* Fix single key combos activating only once ([#25198](https://github.com/qmk/qmk_firmware/pull/25198))
* Fix RGB matrix not syncing and turning off properly on timeout ([#25467](https://github.com/qmk/qmk_firmware/pull/25467))
* Fix drv haptics docs by using the correct function name ([#25733](https://github.com/qmk/qmk_firmware/pull/25733))
* Fix Magic GUI masking logic ([#25780](https://github.com/qmk/qmk_firmware/pull/25780))
* Fix Speculative Hold to enable also right-handed RSFT, RCTL by default. ([#25797](https://github.com/qmk/qmk_firmware/pull/25797))
* Fix community layout keymap discovery ([#25802](https://github.com/qmk/qmk_firmware/pull/25802))
* Fix preference of output file for 'qmk generate-autocorrect-data' ([#25818](https://github.com/qmk/qmk_firmware/pull/25818))

View file

@ -0,0 +1,75 @@
# QMK Breaking Changes - 2026 Feb 22 Changelog
## Deprecation Notices
### Removal of deprecated GPIO defines ([#26028](https://github.com/qmk/qmk_firmware/pull/26028))
QMK has long used Arduino-style GPIO naming conventions. This has been confusing for users, as over time they've had new variations added, as well as users mistakenly thinking that QMK supports the rest of the Arduino ecosystem.
The decision was made to rename the GPIO manipulation functions with ones matching QMK Firmware's code styling.
Previous backwards compatibility has now been removed. see the [GPIO Control](../drivers/gpio#macros) documentation for more information.
### Removal of deprecated isLeftHand ([25897](https://github.com/qmk/qmk_firmware/pull/25897))
Users should migrate to `is_keyboard_left()` found in `split_util.h` instead. For example:
```diff
oled_rotation_t oled_init_user(oled_rotation_t rotation) {
- return isLeftHand ? OLED_ROTATION_180 : OLED_ROTATION_0;
+ return is_keyboard_left() ? OLED_ROTATION_180 : OLED_ROTATION_0;
}
```
The deprecated variable `isLeftHand` will be removed in a future breaking changes cycle.
## Full changelist
Core:
* Refactor Makefile logic for locating keymaps ([#25808](https://github.com/qmk/qmk_firmware/pull/25808))
* Move shutdown delay to audio feature ([#25859](https://github.com/qmk/qmk_firmware/pull/25859))
* Refactor core use of deprecated `isLeftHand` ([#25888](https://github.com/qmk/qmk_firmware/pull/25888))
* Allow custom data sync for community modules ([#25955](https://github.com/qmk/qmk_firmware/pull/25955))
* Remove an unreachable break statement ([#26006](https://github.com/qmk/qmk_firmware/pull/26006))
* Remove duplicate host.h ([#26007](https://github.com/qmk/qmk_firmware/pull/26007))
* Remove redundant EEPROM update ([#26008](https://github.com/qmk/qmk_firmware/pull/26008))
* Remove redundant unsigned comparison in apa102_set_brightness ([#26010](https://github.com/qmk/qmk_firmware/pull/26010))
* Remove unused headers ([#26011](https://github.com/qmk/qmk_firmware/pull/26011))
* Return INVALID_DEFERRED_TOKEN on allocation failure ([#26012](https://github.com/qmk/qmk_firmware/pull/26012))
* Remove deprecated GPIO defines ([#26028](https://github.com/qmk/qmk_firmware/pull/26028))
CLI:
* Enforce EOL when formatting files ([#24989](https://github.com/qmk/qmk_firmware/pull/24989))
* Allow keymap.json to disable config flags ([#25502](https://github.com/qmk/qmk_firmware/pull/25502))
* Remove unused `qmk.keymap.write_file`/`qmk.keymap.write_json` ([#25854](https://github.com/qmk/qmk_firmware/pull/25854))
* Include userspace version (QMK_USERSPACE_VERSION) in version.h ([#25882](https://github.com/qmk/qmk_firmware/pull/25882))
* Lint out-of-bounds bootmagic config ([#25899](https://github.com/qmk/qmk_firmware/pull/25899))
* Report permission issues in `qmk doctor` ([#25931](https://github.com/qmk/qmk_firmware/pull/25931))
* Minor alignment of CLI formatting commands ([#25946](https://github.com/qmk/qmk_firmware/pull/25946))
* Update lint to validate keymap names ([#25969](https://github.com/qmk/qmk_firmware/pull/25969))
* Add 'none of the above' to `new-keyboard` dev board prompt ([#25998](https://github.com/qmk/qmk_firmware/pull/25998))
* Remove `config_h_features` from generated `info.json` ([#26024](https://github.com/qmk/qmk_firmware/pull/26024))
* Promote duplication of defaults check to error ([#26025](https://github.com/qmk/qmk_firmware/pull/26025))
Keyboards:
* Add Soldered Macro Pad ([#25834](https://github.com/qmk/qmk_firmware/pull/25834))
* Remove redundant URLs from `.json` ([#25856](https://github.com/qmk/qmk_firmware/pull/25856))
* Guard encoder behaviour on `projectcain/vault*` ([#25864](https://github.com/qmk/qmk_firmware/pull/25864))
* Refactor keyboard/keymap use of deprecated `isLeftHand` ([#25891](https://github.com/qmk/qmk_firmware/pull/25891))
* Remove some unnecessary matrix externs ([#25975](https://github.com/qmk/qmk_firmware/pull/25975))
* Migrate ROW_SHIFTER to core MATRIX_ROW_SHIFTER ([#25977](https://github.com/qmk/qmk_firmware/pull/25977))
Keyboard fixes:
* Fix out-of-bounds bootmagic config ([#25898](https://github.com/qmk/qmk_firmware/pull/25898))
* Fix incorrect `matrix_scan_custom` implementations ([#25999](https://github.com/qmk/qmk_firmware/pull/25999))
Others:
* Add missing labels to DD keycode definitions ([#25503](https://github.com/qmk/qmk_firmware/pull/25503))
* Copilot instructions for pull requests ([#25857](https://github.com/qmk/qmk_firmware/pull/25857))
Bugs:
* Fix flash wear leveling sector calculation ([#24776](https://github.com/qmk/qmk_firmware/pull/24776))
* [Bugfix] WS2812 indexing in split boards ([#25407](https://github.com/qmk/qmk_firmware/pull/25407))
* Correctly resolve keyboard alias during 'qmk new-keymap' ([#25570](https://github.com/qmk/qmk_firmware/pull/25570))
* Fixes for is31fl3729 LED matrix driver off-by-one errors ([#25902](https://github.com/qmk/qmk_firmware/pull/25902))
* Match Key override index type to bounds type to prevent overflow ([#25939](https://github.com/qmk/qmk_firmware/pull/25939))

122
docs/ChangeLog/20260531.md Normal file
View file

@ -0,0 +1,122 @@
# QMK Breaking Changes - 2026 May 31 Changelog
## Notable Changes {#notable-changes}
## Deprecation Notices
In line with the [notice period](../support_deprecation_policy#how-much-advance-notice-will-be-given), deprecation notices for larger items are listed here.
### Removal of deprecated isLeftHand ([25897](https://github.com/qmk/qmk_firmware/pull/25897))
Users must migrate to `is_keyboard_left()` found in `split_util.h` instead. For example:
```diff
oled_rotation_t oled_init_user(oled_rotation_t rotation) {
- return isLeftHand ? OLED_ROTATION_180 : OLED_ROTATION_0;
+ return is_keyboard_left() ? OLED_ROTATION_180 : OLED_ROTATION_0;
}
```
### Removal of `usb.force_nkro`/`FORCE_NKRO` ([#25262](https://github.com/qmk/qmk_firmware/pull/25262))
Unpicking the assumption that only USB can do NKRO, forcing of NKRO on every boot has been deprecated. As this setting persists, it produces unnecessary user confusion when the various NKRO keycodes (for example `NK_TOGG`) do not behave as expected.
The new defaults can be configured in the following ways:
:::::tabs
==== keyboard.json
```json [keyboard.json]
{
"host": { // [!code focus]
"default": { // [!code focus]
"nkro": true // [!code focus]
} // [!code focus]
} // [!code focus]
}
```
==== keymap.json
```json [keymap.json]
{
"config": {
"host": { // [!code focus]
"default": { // [!code focus]
"nkro": true // [!code focus]
} // [!code focus]
} // [!code focus]
}
}
```
==== config.h
```c [config.h]
#pragma once
#define NKRO_DEFAULT_ON true // [!code focus]
```
:::::
## Full changelist
Core:
* Remove deprecated `isLeftHand` ([#25897](https://github.com/qmk/qmk_firmware/pull/25897))
* Either output Unicode or insert in Leader sequence ([#25940](https://github.com/qmk/qmk_firmware/pull/25940))
* Add resolution information to digitizer ([#25958](https://github.com/qmk/qmk_firmware/pull/25958))
* Always generate .map files. ([#25961](https://github.com/qmk/qmk_firmware/pull/25961))
* Add an `mcu_reset` impl for the kiibohd bootloader. ([#25963](https://github.com/qmk/qmk_firmware/pull/25963))
* VIA v13 ([#26001](https://github.com/qmk/qmk_firmware/pull/26001))
* Added PixArt PMW-3325 mouse sensor driver ([#26065](https://github.com/qmk/qmk_firmware/pull/26065))
* Update WL backing store from 16 to 32-bit for AT32 ([#26066](https://github.com/qmk/qmk_firmware/pull/26066))
* Refactor Pixel Fractal effect ([#26071](https://github.com/qmk/qmk_firmware/pull/26071))
* Minor combo code optimisation ([#26073](https://github.com/qmk/qmk_firmware/pull/26073))
* Options to constrain Speculative Hold: `SPECULATIVE_HOLD_ONE_KEY` and `SPECULATIVE_HOLD_FLOW_TERM`. ([#26099](https://github.com/qmk/qmk_firmware/pull/26099))
* Add includes for std::setw ([#26153](https://github.com/qmk/qmk_firmware/pull/26153))
* Bind gtest colour to QMKs 'COLOR' variable ([#26159](https://github.com/qmk/qmk_firmware/pull/26159))
* Print correct test names ([#26160](https://github.com/qmk/qmk_firmware/pull/26160))
* Ignore Uninteresting test warnings during test teardown ([#26161](https://github.com/qmk/qmk_firmware/pull/26161))
* Remove FORCE_NKRO ([#26206](https://github.com/qmk/qmk_firmware/pull/26206))
CLI:
* Update lint to check all keymaps within the repo ([#25970](https://github.com/qmk/qmk_firmware/pull/25970))
* Fail when a duplicate module name is detected ([#26238](https://github.com/qmk/qmk_firmware/pull/26238))
Submodule updates:
* Update ChibiOS, ChibiOS-Contrib. ([#25730](https://github.com/qmk/qmk_firmware/pull/25730))
* Revert "Update ChibiOS, ChibiOS-Contrib." ([#26074](https://github.com/qmk/qmk_firmware/pull/26074))
* ChibiOS, ChibiOS-Contrib updates (redux) ([#26079](https://github.com/qmk/qmk_firmware/pull/26079))
* Bump googletest to v1.16.0 ([#26154](https://github.com/qmk/qmk_firmware/pull/26154))
Keyboards:
* Require "url" field to not be empty ([#25152](https://github.com/qmk/qmk_firmware/pull/25152))
* Add nomis/rpi_pico_25x1 macropad ([#25346](https://github.com/qmk/qmk_firmware/pull/25346))
* Remove override of QK_{LED,RGB}_MATRIX_TOGGLE keycode ([#25672](https://github.com/qmk/qmk_firmware/pull/25672))
* Add reverse layout to SouthPad v2 ([#25707](https://github.com/qmk/qmk_firmware/pull/25707))
* Adding Handwired Bouvet Macropad ([#26040](https://github.com/qmk/qmk_firmware/pull/26040))
* Remove blockader user keymap ([#26075](https://github.com/qmk/qmk_firmware/pull/26075))
* Remove deprecated audio pin defines ([#26111](https://github.com/qmk/qmk_firmware/pull/26111))
* Remove `OLED_DISPLAY_128X32` config ([#26190](https://github.com/qmk/qmk_firmware/pull/26190))
* Migrate SPLIT_OLED_ENABLE ([#26194](https://github.com/qmk/qmk_firmware/pull/26194))
* Add API version assertion for split_data_sync module ([#26237](https://github.com/qmk/qmk_firmware/pull/26237))
Others:
* Bump vitepress to 1.6.4 ([#26067](https://github.com/qmk/qmk_firmware/pull/26067))
* Add usage clarifications to docs/features/unicode.md ([#26156](https://github.com/qmk/qmk_firmware/pull/26156))
Bugs:
* Fix `USER_PRINT` stripping out `uprintf` ([#25919](https://github.com/qmk/qmk_firmware/pull/25919))
* Fix possible repeat key infinite recursion ([#25926](https://github.com/qmk/qmk_firmware/pull/25926))
* Fix `cc-option` on arm-none-eabi-gcc ([#26114](https://github.com/qmk/qmk_firmware/pull/26114))
* Fix color diagnostics for arm-none-eabi-gcc ([#26115](https://github.com/qmk/qmk_firmware/pull/26115))
* Mask out active mods when unregistering after retro tapping ([#26127](https://github.com/qmk/qmk_firmware/pull/26127))
* fix `make test:all` failures seen on macOS Tahoe ([#26136](https://github.com/qmk/qmk_firmware/pull/26136))
* Add workaround for undefined reference to weak function under mingw ([#26167](https://github.com/qmk/qmk_firmware/pull/26167))
* fix(ws2812-pwm): allow WS2812_PWM_TICK_FREQUENCY override ([#26186](https://github.com/qmk/qmk_firmware/pull/26186))
* Clip mouse report values to the logical range from the USB descriptor. ([#26195](https://github.com/qmk/qmk_firmware/pull/26195))
* Align Mouse USB descriptor ([#26230](https://github.com/qmk/qmk_firmware/pull/26230))

View file

@ -214,7 +214,7 @@
{ "text": "My Pull Request Was Flagged", "link": "/breaking_changes_instructions" },
{
"text": "Most Recent ChangeLog",
"link": "/ChangeLog/20250831"
"link": "/ChangeLog/20260531"
},
{ "text": "Past Breaking Changes", "link": "/breaking_changes_history" },
{ "text": "Deprecation Policy", "link": "/support_deprecation_policy" }

View file

@ -10,25 +10,25 @@ Practically, this means QMK merges the `develop` branch into the `master` branch
## What has been included in past Breaking Changes?
* [2025 Aug 31](ChangeLog/20250831)
* [2025 May 25](ChangeLog/20250525)
* [2025 Feb 23](ChangeLog/20250223)
* [2026 May 31](ChangeLog/20260531)
* [2026 Feb 22](ChangeLog/20260222)
* [2025 Nov 30](ChangeLog/20251130)
* [Older Breaking Changes](breaking_changes_history)
## When is the next Breaking Change?
The next Breaking Change is scheduled for November 30, 2025.
The next Breaking Change is scheduled for Aug 30, 2026.
### Important Dates
* 2025 Aug 31 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
* 2025 Nov 2 - `develop` closed to new PRs.
* 2025 Nov 2 - Call for testers.
* 2025 Nov 16 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
* 2025 Nov 23 - `develop` is locked, only critical bugfix PRs merged.
* 2025 Nov 28 - `master` is locked, no PRs merged.
* 2025 Nov 30 - Merge `develop` to `master`.
* 2025 Nov 30 - `master` is unlocked. PRs can be merged again.
* 2025 May 31 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
* 2026 Aug 2 - `develop` closed to new PRs.
* 2026 Aug 2 - Call for testers.
* 2026 Aug 16 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
* 2026 Aug 23 - `develop` is locked, only critical bugfix PRs merged.
* 2026 Aug 28 - `master` is locked, no PRs merged.
* 2026 Aug 30 - Merge `develop` to `master`.
* 2026 Aug 30 - `master` is unlocked. PRs can be merged again.
## What changes will be included?

View file

@ -2,6 +2,9 @@
This page links to all previous changelogs from the QMK Breaking Changes process.
* [2026 May 31](ChangeLog/20260531) - version 0.33.0
* [2026 Feb 22](ChangeLog/20260222) - version 0.32.0
* [2025 Nov 30](ChangeLog/20251130) - version 0.31.0
* [2025 Aug 31](ChangeLog/20250831) - version 0.30.0
* [2025 May 25](ChangeLog/20250525) - version 0.29.0
* [2025 Feb 23](ChangeLog/20250223) - version 0.28.0

View file

@ -4,47 +4,18 @@
The QMK CLI (command line interface) makes building and working with QMK keyboards easier. We have provided a number of commands to simplify and streamline tasks such as obtaining and compiling the QMK firmware, creating keymaps, and more.
### Requirements {#requirements}
### Installation {#installation}
QMK requires Python 3.9 or greater. We try to keep the number of requirements small but you will also need to install the packages listed in [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt). These are installed automatically when you install the QMK CLI.
### Install Using Homebrew (macOS, some Linux) {#install-using-homebrew}
If you have installed [Homebrew](https://brew.sh) you can tap and install QMK:
The recommended way to install the QMK CLI and all necessary dependencies (toolchains, flashing utilities, udev rules on Linux) is to use the bootstrapper script:
```
brew install qmk/qmk/qmk
export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
curl -fsSL https://install.qmk.fm | sh
```
### Install Using uv {#install-using-uv}
If you have installed [uv](https://docs.astral.sh/uv/), the QMK CLI can be installed and managed as a uv tool:
For more options, run:
```
uv tool install qmk
export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
curl -fsSL https://install.qmk.fm | sh -s -- --help
```
This installation can be updated via `uv tool upgrade qmk`. See [Upgrading tools](https://docs.astral.sh/uv/guides/tools/#upgrading-tools) for more information.
### Install Using pip {#install-using-easy_install-or-pip}
If your system is not listed above you can install QMK manually. First ensure that you have Python 3.9 (or later) installed and have installed pip. Then install QMK with this command:
```
python3 -m pip install qmk
export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
```
### Packaging For Other Operating Systems {#packaging-for-other-operating-systems}
We are looking for people to create and maintain a `qmk` package for more operating systems. If you would like to create a package for your OS please follow these guidelines:
* Follow best practices for your OS when they conflict with these guidelines
* Document why in a comment when you do deviate
* Install using a virtualenv
* Instruct the user to set the environment variable `QMK_HOME` to have the firmware source checked out somewhere other than `~/qmk_firmware`.
For detailed setup instructions, see [Setting Up Your QMK Environment](newbs_getting_started#set-up-your-environment).

View file

@ -12,11 +12,11 @@ If you intend to maintain keyboards and/or contribute to QMK, you can enable the
`qmk config user.developer=True`
This will allow you to see all available subcommands.
**Note:** You will have to install additional requirements:
```
python3 -m pip install -r requirements-dev.txt
```
This will allow you to see all available subcommands.
::: tip
If you installed QMK using the bootstrapper (`curl -fsSL https://install.qmk.fm | sh`), the development requirements are already installed.
:::
# Subcommands

View file

@ -74,24 +74,6 @@ This is a C header file that is one of the first things included, and will persi
* pins mapped to rows and columns, from left to right. Defines a matrix where each switch is connected to a separate pin and ground.
* `#define AUDIO_VOICES`
* turns on the alternate audio voices (to cycle through)
* `#define C4_AUDIO`
* enables audio on pin C4
* Deprecated. Use `#define AUDIO_PIN C4`
* `#define C5_AUDIO`
* enables audio on pin C5
* Deprecated. Use `#define AUDIO_PIN C5`
* `#define C6_AUDIO`
* enables audio on pin C6
* Deprecated. Use `#define AUDIO_PIN C6`
* `#define B5_AUDIO`
* enables audio on pin B5 (duophony is enabled if one of B pins is enabled along with one of C pins)
* Deprecated. Use `#define AUDIO_PIN B5`, or use `#define AUDIO_PIN_ALT B5` if a `C` pin is enabled with `AUDIO_PIN`
* `#define B6_AUDIO`
* enables audio on pin B6 (duophony is enabled if one of B pins is enabled along with one of C pins)
* Deprecated. Use `#define AUDIO_PIN B6`, or use `#define AUDIO_PIN_ALT B6` if a `C` pin is enabled with `AUDIO_PIN`
* `#define B7_AUDIO`
* enables audio on pin B7 (duophony is enabled if one of B pins is enabled along with one of C pins)
* Deprecated. Use `#define AUDIO_PIN B7`, or use `#define AUDIO_PIN_ALT B7` if a `C` pin is enabled with `AUDIO_PIN`
* `#define BACKLIGHT_PIN B7`
* pin of the backlight
* `#define BACKLIGHT_LEVELS 3`
@ -358,6 +340,10 @@ There are a few different ways to set handedness for split keyboards (listed in
* `#define SPLIT_TRANSACTION_IDS_USER .....`
* Allows for custom data sync with the slave when using the QMK-provided split transport. See [custom data sync between sides](features/split_keyboard#custom-data-sync) for more information.
* `#define SYSTEM_CONTROL_USAGE_MINIMUM 0x0081`
* `#define SYSTEM_CONTROL_USAGE_MAXIMUM 0x008F`
* Sets the usage range reported by the System Control collection that `EXTRAKEY_ENABLE` adds. The default range covers the System Control usages QMK can send and stops below the Generic Desktop D-pad usages (`0x90` and up). Raising the maximum into that range makes some hosts detect the keyboard as a gamepad, so only widen it if you need the extra usages and know your host handles them. The minimum must not be greater than the maximum.
# The `rules.mk` File
This is a [make](https://www.gnu.org/software/make/manual/make.html) file that is included by the top-level `Makefile`. It is used to set some information about the MCU that we will be compiling for as well as enabling and disabling certain features.

View file

@ -74,7 +74,7 @@ void matrix_init(void) {
// TODO: initialize hardware and global matrix state here
// Unless hardware debouncing - Init the configured debounce routine
debounce_init(MATRIX_ROWS);
debounce_init();
// This *must* be called for correct keyboard behavior
matrix_init_kb();
@ -86,7 +86,7 @@ uint8_t matrix_scan(void) {
// TODO: add matrix scanning routine here
// Unless hardware debouncing - use the configured debounce routine
changed = debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
changed = debounce(raw_matrix, matrix, changed);
// This *must* be called for correct keyboard behavior
matrix_scan_kb();

View file

@ -14,6 +14,10 @@ Example:
This page covers my super cool feature. You can use this feature to make coffee, squeeze fresh oj, and have an egg mcmuffin and hashbrowns delivered from your local macca's by drone.
```
# Paragraphs
Do not use hard line breaks within the raw Markdown for each paragraph. These are optional in Markdown, and have no effect on the rendered output. This means each raw paragraph will be a single long line in your editor (best viewed with line wrapping enabled).
# Headings
Your page should generally have multiple "H1" headings. Only H1 and H2 headings will included in the Table of Contents, so plan them out appropriately. Excess width should be avoided in H1 and H2 headings to prevent the Table of Contents from getting too wide.

View file

@ -4,7 +4,7 @@ QMK presents itself to the host as a regular HID keyboard device, and as such re
There are two notable exceptions: the Caterina bootloader, usually seen on Pro Micros, and the HalfKay bootloader shipped with PJRC Teensys, appear as a serial port and a generic HID device respectively, and so do not require a driver.
We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have set up the development environment with MSYS2, the `qmk_install.sh` script will have already installed the drivers for you.
We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have set up the development environment with MSYS2, the QMK CLI installation script will have already installed the drivers for you.
## Installation

View file

@ -221,6 +221,31 @@ Receive multiple bytes from the selected I2C device.
---
### `i2c_status_t i2c_transmit_and_receive(uint8_t address, const uint8_t* tx_data, uint16_t tx_length, uint8_t* rx_data, uint16_t rx_length, uint16_t timeout)` {#api-i2c-transmit-and-receive}
Send and receive multiple bytes from the selected I2C device.
#### Arguments {#api-i2c-transmit-and-receive-arguments}
- `uint8_t address`
The 7-bit I2C address of the device.
- `const uint8_t* tx_data`
A pointer to the data to transmit.
- `uint16_t tx_length`
The number of bytes to write. Take care not to overrun the length of `tx_data`.
- `uint8_t* rx_data`
A pointer to a buffer to read into.
- `uint16_t rx_length`
The number of bytes to read. Take care not to overrun the length of `data`.
- `uint16_t timeout`
The time in milliseconds to wait for a response from the target device.
#### Return Value {#api-i2c-transmit-and-receive-return}
`I2C_STATUS_TIMEOUT` if the timeout period elapses, `I2C_STATUS_ERROR` if some other error occurs, otherwise `I2C_STATUS_SUCCESS`.
---
### `i2c_status_t i2c_write_register(uint8_t devaddr, uint8_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register}
Write to a register with an 8-bit address on the I2C device.

View file

@ -292,7 +292,7 @@ Set the color of a single LED. This function does not immediately update the LED
---
### `void ws812_set_color_all(uint8_t red, uint8_t green, uint8_t blue)` {#api-ws2812-set-color-all}
### `void ws2812_set_color_all(uint8_t red, uint8_t green, uint8_t blue)` {#api-ws2812-set-color-all}
Set the color of all LEDs.

View file

@ -19,13 +19,10 @@ Note that running `make` with `sudo` is generally ***not*** a good idea, and you
### Linux `udev` Rules {#linux-udev-rules}
On Linux, you'll need proper privileges to communicate with the bootloader device. You can either use `sudo` when flashing firmware (not recommended), or place [this file](https://github.com/qmk/qmk_firmware/tree/master/util/udev/50-qmk.rules) into `/etc/udev/rules.d/`.
Once added, run the following:
On Linux, you'll need proper privileges to communicate with the bootloader device. You can either use `sudo` when flashing firmware (not recommended), or install the udev rules from the [qmk_udev](https://github.com/qmk/qmk_udev) repository by running:
```
sudo udevadm control --reload-rules
sudo udevadm trigger
util/install_udev.sh
```
**Note:** With older versions of ModemManager (< 1.12), filtering only works when not in strict mode. The following commands can update that setting:
@ -44,7 +41,7 @@ Pro Micro (Atmega32u4), make sure to include `CONFIG_USB_ACM=y`. Other devices m
Issues encountered when flashing keyboards on Windows are most often due to having the wrong drivers installed for the bootloader, or none at all.
Re-running the QMK installation script (`./util/qmk_install.sh` from the `qmk_firmware` directory in MSYS2 or WSL) or reinstalling the QMK Toolbox may fix the issue. Alternatively, you can download and run the [`qmk_driver_installer`](https://github.com/qmk/qmk_driver_installer) package manually.
Re-running the QMK installation script (`curl -fsSL https://install.qmk.fm | sh`) or reinstalling the QMK Toolbox may fix the issue. Alternatively, you can download and run the [`qmk_driver_installer`](https://github.com/qmk/qmk_driver_installer) package manually.
If that doesn't work, then you may need to download and run Zadig. See [Bootloader Driver Installation with Zadig](driver_installation_zadig) for more detailed information.

View file

@ -2,8 +2,22 @@
This page documents the automated process for converting keyboards to use drop-in replacement controllers. This process is designed to be easy to use and can be completed in a few simple steps.
You can generate the firmware by appending `-e CONVERT_TO=<target>` to your compile/flash command. For example:
```sh
qmk flash -c -kb keebio/bdn9/rev1 -km default -e CONVERT_TO=proton_c
```
You can also configure this within your [keymap](#keymap) to accomplish the same thing.
::: tip
If you get build errors, you will need to convert the keyboard's code to be [compatible](#keyboard-req) with the converter feature, or provide additional [keymap](#keymap-add) configuration.
:::
## Supported Converters
Each converter category is broken down by its declared `pin compatibility`. This ensures that only valid combinations are attempted.
The following converters are available at this time:
| From | To |
@ -28,86 +42,56 @@ The following converters are available at this time:
| `elite_c` | `helios` |
| `elite_c` | `liatris` |
## Configuration
## Overview
Configuring a converter to use can be done by adding one of the following lines to your keymaps's configuration:
Each converter category is broken down by its declared `pin compatibility`. This ensures that only valid combinations are attempted. You can generate the firmware by appending `-e CONVERT_TO=<target>` to your compile/flash command. For example:
:::::tabs
```sh
qmk flash -c -kb keebio/bdn9/rev1 -km default -e CONVERT_TO=proton_c
==== keymap.json
```json [keymap.json]
{
"version": 1,
"keyboard": "keebio/bdn9/rev1",
"keymap": "keebio_bdn9_rev1_layout_2025-05-20",
"converter": "proton_c", // [!code focus]
"layout": "LAYOUT",
}
```
You can also add the same `CONVERT_TO=<target>` to your keymap's `rules.mk`, which will accomplish the same thing.
::: tip
If you get errors about `PORTB/DDRB`, etc not being defined, you'll need to convert the keyboard's code to use the [GPIO Controls](drivers/gpio) that will work for both ARM and AVR. This shouldn't affect the AVR builds at all.
:::
### Conditional Configuration
Once a converter is enabled, it exposes the `CONVERT_TO_<target_uppercase>` flag that you can use in your code with `#ifdef`s, For example:
```c
#ifdef CONVERT_TO_PROTON_C
// Proton C code
#else
// Pro Micro code
#endif
```
### Pin Compatibility
To ensure compatibility, provide validation, and enable future workflows, a keyboard should declare its `pin compatibility`. For legacy reasons, this is currently assumed to be `promicro`. The following pin compatibility interfaces are currently defined:
| Pin Compatibility | Notes |
|-------------------|-----------------------------------|
| `promicro` | Includes RX/TX LEDs |
| `elite_c` | Includes bottom row pins, no LEDs |
To declare the base for conversions, add this line to your keyboard's `rules.mk`:
==== rules.mk
```makefile
PIN_COMPATIBLE = elite_c
CONVERT_TO = proton_c
```
## Pro Micro
:::::
If a board currently supported in QMK uses a [Pro Micro](https://www.sparkfun.com/products/12640) (or compatible board), the supported alternative controllers are:
::: tip
If you get build errors, you will need to convert the keyboard's code to be [compatible](#keyboard-req) with the converter feature, or provide additional [keymap](#keymap-add) configuration.
:::
| Device | Target |
|------------------------------------------------------------------------------------------|-------------------|
| [Proton C](https://qmk.fm/proton-c/) | `proton_c` |
| [Adafruit KB2040](https://learn.adafruit.com/adafruit-kb2040) | `kb2040` |
| [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288) | `sparkfun_pm2040` |
| [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622) | `blok` |
| [Bit-C PRO](https://nullbits.co/bit-c-pro) | `bit_c_pro` |
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` |
| [customMK Bonsai C4](https://shop.custommk.com/products/bonsai-c4-microcontroller-board) | `bonsai_c4` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` |
| [Liatris](https://splitkb.com/products/liatris) | `liatris` |
| [Imera](https://splitkb.com/products/imera) | `imera` |
| [Michi](https://github.com/ci-bus/michi-promicro-rp2040) | `michi` |
| [Svlinky](https://github.com/sadekbaroudi/svlinky) | `svlinky` |
## Pro Micro Converters
Converter summary:
If a board currently supported by QMK uses a [Pro Micro](https://www.sparkfun.com/products/12640) (or compatible board), the supported alternative controllers are:
| Target | Argument | `rules.mk` | Condition |
|-------------------|---------------------------------|------------------------------|-------------------------------------|
| `proton_c` | `-e CONVERT_TO=proton_c` | `CONVERT_TO=proton_c` | `#ifdef CONVERT_TO_PROTON_C` |
| `kb2040` | `-e CONVERT_TO=kb2040` | `CONVERT_TO=kb2040` | `#ifdef CONVERT_TO_KB2040` |
| `sparkfun_pm2040` | `-e CONVERT_TO=sparkfun_pm2040` | `CONVERT_TO=sparkfun_pm2040` | `#ifdef CONVERT_TO_SPARKFUN_PM2040` |
| `blok` | `-e CONVERT_TO=blok` | `CONVERT_TO=blok` | `#ifdef CONVERT_TO_BLOK` |
| `bit_c_pro` | `-e CONVERT_TO=bit_c_pro` | `CONVERT_TO=bit_c_pro` | `#ifdef CONVERT_TO_BIT_C_PRO` |
| `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| `bonsai_c4` | `-e CONVERT_TO=bonsai_c4` | `CONVERT_TO=bonsai_c4` | `#ifdef CONVERT_TO_BONSAI_C4` |
| `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |
| `liatris` | `-e CONVERT_TO=liatris` | `CONVERT_TO=liatris` | `#ifdef CONVERT_TO_LIATRIS` |
| `imera` | `-e CONVERT_TO=imera` | `CONVERT_TO=imera` | `#ifdef CONVERT_TO_IMERA` |
| `michi` | `-e CONVERT_TO=michi` | `CONVERT_TO=michi` | `#ifdef CONVERT_TO_MICHI` |
| `svlinky` | `-e CONVERT_TO=svlinky` | `CONVERT_TO=svlinky` | `#ifdef CONVERT_TO_SVLINKY` |
| Device | Target | CLI Argument | `rules.mk` | Condition |
|------------------------------------------------------------------------------------------|-------------------|---------------------------------|------------------------------|-------------------------------------|
| [Proton C](https://qmk.fm/proton-c/) | `proton_c` | `-e CONVERT_TO=proton_c` | `CONVERT_TO=proton_c` | `#ifdef CONVERT_TO_PROTON_C` |
| [Adafruit KB2040](https://learn.adafruit.com/adafruit-kb2040) | `kb2040` | `-e CONVERT_TO=kb2040` | `CONVERT_TO=kb2040` | `#ifdef CONVERT_TO_KB2040` |
| [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288) | `sparkfun_pm2040` | `-e CONVERT_TO=sparkfun_pm2040` | `CONVERT_TO=sparkfun_pm2040` | `#ifdef CONVERT_TO_SPARKFUN_PM2040` |
| [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622) | `blok` | `-e CONVERT_TO=blok` | `CONVERT_TO=blok` | `#ifdef CONVERT_TO_BLOK` |
| [Bit-C PRO](https://nullbits.co/bit-c-pro) | `bit_c_pro` | `-e CONVERT_TO=bit_c_pro` | `CONVERT_TO=bit_c_pro` | `#ifdef CONVERT_TO_BIT_C_PRO` |
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| [customMK Bonsai C4](https://shop.custommk.com/products/bonsai-c4-microcontroller-board) | `bonsai_c4` | `-e CONVERT_TO=bonsai_c4` | `CONVERT_TO=bonsai_c4` | `#ifdef CONVERT_TO_BONSAI_C4` |
| [RP2040 Community Edition](#rp2040_ce) | `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |
| [Liatris](https://splitkb.com/products/liatris) | `liatris` | `-e CONVERT_TO=liatris` | `CONVERT_TO=liatris` | `#ifdef CONVERT_TO_LIATRIS` |
| [Imera](https://splitkb.com/products/imera) | `imera` | `-e CONVERT_TO=imera` | `CONVERT_TO=imera` | `#ifdef CONVERT_TO_IMERA` |
| [Michi](https://github.com/ci-bus/michi-promicro-rp2040) | `michi` | `-e CONVERT_TO=michi` | `CONVERT_TO=michi` | `#ifdef CONVERT_TO_MICHI` |
| [Svlinky](https://github.com/sadekbaroudi/svlinky) | `svlinky` | `-e CONVERT_TO=svlinky` | `CONVERT_TO=svlinky` | `#ifdef CONVERT_TO_SVLINKY` |
### Proton C {#proton_c}
@ -119,26 +103,26 @@ The Proton C only has one on-board LED (C13), and by default, the TXLED (D5) is
The following defaults are based on what has been implemented for STM32 boards.
| Feature | Notes |
|----------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [Audio](features/audio) | Enabled |
| [RGB Lighting](features/rgblight) | Disabled |
| Feature | Notes |
|--------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| [Audio](features/audio) | Enabled |
| [RGB Lighting](features/rgblight) | Disabled |
| [Backlight](features/backlight) | Forces [task driven PWM](features/backlight#software-pwm-driver) until ARM can provide automatic configuration |
| USB Host (e.g. USB-USB converter) | Not supported (USB host code is AVR specific and is not currently supported on ARM) |
| [Split keyboards](features/split_keyboard) | Partial - heavily dependent on enabled features |
| USB Host (e.g. USB-USB converter) | Not supported (USB host code is AVR specific and is not currently supported on ARM) |
| [Split keyboards](features/split_keyboard) | Partial - heavily dependent on enabled features |
### Adafruit KB2040 {#kb2040}
The following defaults are based on what has been implemented for [RP2040](platformdev_rp2040) boards.
| Feature | Notes |
|----------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [RGB Lighting](features/rgblight) | Enabled via `PIO` vendor driver |
| Feature | Notes |
|--------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| [RGB Lighting](features/rgblight) | Enabled via `PIO` vendor driver |
| [Backlight](features/backlight) | Forces [task driven PWM](features/backlight#software-pwm-driver) until ARM can provide automatic configuration |
| USB Host (e.g. USB-USB converter) | Not supported (USB host code is AVR specific and is not currently supported on ARM) |
| [Split keyboards](features/split_keyboard) | Partial via `PIO` vendor driver - heavily dependent on enabled features |
| USB Host (e.g. USB-USB converter) | Not supported (USB host code is AVR specific and is not currently supported on ARM) |
| [Split keyboards](features/split_keyboard) | Partial via `PIO` vendor driver - heavily dependent on enabled features |
### SparkFun Pro Micro - RP2040, Blok, Bit-C PRO and Michi {#sparkfun_pm2040 }
### SparkFun Pro Micro - RP2040, Blok, Bit-C PRO and Michi {#sparkfun_pm2040}
Feature set is identical to [Adafruit KB2040](#kb2040).
@ -177,31 +161,193 @@ Feature set is identical to [Adafruit KB2040](#kb2040). VBUS detection is enable
Feature set is a pro micro equivalent of the [RP2040 Community Edition](#rp2040_ce), except that two of the analog GPIO have been replaced with digital only GPIO. These two were moved to the FPC connector to support the [VIK specification](https://github.com/sadekbaroudi/vik). This means that if you are expecting analog support on all 4 pins as provided on a RP2040 Community Edition pinout, you will not have that. Please see the [Svlinky github page](https://github.com/sadekbaroudi/svlinky) for more details.
## Elite-C
## Elite-C Converters
If a board currently supported in QMK uses an [Elite-C](https://keeb.io/products/elite-c-low-profile-version-usb-c-pro-micro-replacement-atmega32u4), the supported alternative controllers are:
If a board currently supported by QMK uses an [Elite-C](https://keeb.io/products/elite-c-low-profile-version-usb-c-pro-micro-replacement-atmega32u4), the supported alternative controllers are:
| Device | Target |
|----------------------------------------------------------------------------------|-------------------|
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` |
| [Liatris](https://splitkb.com/products/liatris) | `liatris` |
| Device | Target | CLI Argument | `rules.mk` | Condition |
|----------------------------------------------------------------------------------|-------------|---------------------------|------------------------|-------------------------------|
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| [RP2040 Community Edition](#rp2040_ce_elite) | `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |
| [Liatris](https://splitkb.com/products/liatris) | `liatris` | `-e CONVERT_TO=liatris` | `CONVERT_TO=liatris` | `#ifdef CONVERT_TO_LIATRIS` |
Converter summary:
| Target | Argument | `rules.mk` | Condition |
|-------------------|---------------------------------|------------------------------|-------------------------------------|
| `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |
| `liatris` | `-e CONVERT_TO=liatris` | `CONVERT_TO=liatris` | `#ifdef CONVERT_TO_LIATRIS` |
### STeMCell {#stemcell}_elite
### STeMCell {#stemcell_elite}
Identical to [Pro Micro - STeMCell](#stemcell) with support for the additional bottom row of pins.
### RP2040 Community Edition {#rp2040_ce_elite}
Identical to [Pro Micro - RP2040 Community Edition](#rp2040_ce) with support for the additional bottom row of pins.
## Advanced Topics
### Keyboard Configuration
To configure a keyboard to allow the converter feature, add the following line to your keyboard's `.json` configuration:
```json [keyboard.json]
{
"maintainer": "QMK",
"development_board": "promicro", // [!code focus]
"diode_direction": "COL2ROW",
}
```
See the [pin compatibility](#pin_compatible) for more information.
#### Additional Requirements {#keyboard-req}
Keyboards must use the platform agnostic abstractions provided by QMK. This includes:
* Use of [GPIO Controls](drivers/gpio).
### Additional Keymap Configuration {#keymap-add}
While effort has been made to make converters as compatible as possible, sometimes additional platform specific configuration is required.
For example, enabling hardware peripherals by adding a keymap level `mcuconf.h` with something like the following:
```c
#pragma once
#include_next <mcuconf.h>
#undef RP_SIO_USE_UART0
#define RP_SIO_USE_UART0 TRUE
```
You can find details on how to configure drivers on their respective pages.
Alternatively, you may have to disable incompatible features. For example:
:::::tabs
==== keymap.json
```json [keymap.json]
{
"version": 1,
"keyboard": "keebio/bdn9/rev1",
"keymap": "keebio_bdn9_rev1_layout_2025-05-20",
"converter": "proton_c",
"config": { // [!code focus]
"features": { // [!code focus]
"audio": false // [!code focus]
}
}
"layout": "LAYOUT",
}
```
==== rules.mk
```makefile
AUDIO_ENABLE = no
```
:::::
### Conditional Configuration
Once a converter is enabled, it exposes the `CONVERT_TO_<target_uppercase>` flag that you can use in your code with `#ifdef`s, For example:
```c
#ifdef CONVERT_TO_PROTON_C
// Proton C code
#else
// Pro Micro code
#endif
```
### Pin Compatibility {#pin_compatible}
To ensure compatibility, provide validation, and power future workflows, a keyboard should declare its `pin compatibility`. This ensures that only valid combinations are attempted.
::: tip Note
This will already be configured for you if are using the `promicro` development board preset.
:::
To declare the base interface for conversions, add the following line to your keyboard's configuration:
```json [keyboard.json]
{
"maintainer": "QMK",
"development_board": "elite_c", // [!code focus]
"pin_compatible": "elite_c", // [!code focus]
"diode_direction": "COL2ROW",
}
```
The above example, configures a keyboard for a default of `elite_c` while allowing any of the `elite_c` converter targets.
The framework then allows mapping of pins from `<PIN_COMPATIBLE>` to converter `<target>`.
::: warning
Mapped pins should adhere strictly to the defined interface, any extras present on the hardware should be ignored.
:::
#### Available Pin Compatibility
:::::tabs
==== promicro
![promicro](/pin_compatible_promicro.svg)
<!-- ```svgbob
pins
.-------------. LEDs
| | _|_ _|_
D3 -+-O | \ /B0 \ /D5
D2 -+-O | -+- -+-
| | | |
| |
D1 -+-O O-+- F4
D0 -+-O O-+- F5
D4 -+-O O-+- F6
C6 -+-O O-+- F7
D7 -+-O O-+- B1
E6 -+-O O-+- B3
B4 -+-O O-+- B2
B5 -+-O O-+- B6
| |
'---+-+-+-+-+---'
``` -->
::: info Notes:
Includes LEDs - these may be mapped to unused/unavailable pins when not present.
:::
==== elite_c
![elite_c](/pin_compatible_elite_c.svg)
<!-- ```svgbob
pins
.-------------.
| |
D3 -+-O |
D2 -+-O |
| |
| |
D1 -+-O O-+- F4
D0 -+-O O-+- F5
D4 -+-O O-+- F6
C6 -+-O O-+- F7
D7 -+-O O-+- B1
E6 -+-O O-+- B3
B4 -+-O O-+- B2
B5 -+-O O O O O O O-+- B6
| | | | | | |
'---+-+-+-+-+---'
+ + + + +
B D C F F
7 5 7 1 0
``` -->
::: info Notes:
Includes bottom row pins, no LEDs.
:::
:::::

View file

@ -1,14 +1,20 @@
# Persistent Configuration (EEPROM)
This allows you to configure persistent settings for your keyboard. These settings are stored in the EEPROM of your controller, and are retained even after power loss. The settings can be read with `eeconfig_read_kb` and `eeconfig_read_user`, and can be written to using `eeconfig_update_kb` and `eeconfig_update_user`. This is useful for features that you want to be able to toggle (like toggling rgb layer indication). Additionally, you can use `eeconfig_init_kb` and `eeconfig_init_user` to set the default values for the EEPROM.
The complicated part here, is that there are a bunch of ways that you can store and access data via EEPROM, and there is no "correct" way to do this. However, you only have a DWORD (4 bytes) for each function.
This allows you to configure persistent settings for your keyboard. These settings are stored in the EEPROM of your controller, and are retained even after power loss.
Keep in mind that EEPROM has a limited number of writes. While this is very high, it's not the only thing writing to the EEPROM, and if you write too often, you can potentially drastically shorten the life of your MCU.
* If you don't understand the example, then you may want to avoid using this feature, as it is rather complicated.
::: tip
If you don't understand the examples, then you may want to avoid using this feature, as it is rather complicated.
:::
## Example Implementation
## Basic
The settings can be read with `eeconfig_read_kb` and `eeconfig_read_user`, and can be written to using `eeconfig_update_kb` and `eeconfig_update_user`. This is useful for features that you want to be able to toggle (like toggling rgb layer indication). Additionally, you can use `eeconfig_init_kb` and `eeconfig_init_user` to set the default values for the EEPROM.
The complicated part here, is that there are a bunch of ways that you can store and access data via EEPROM, and there is no "correct" way to do this. However, you only have a DWORD (4 bytes) for each function.
### Example Implementation
This is an example of how to add settings, and read and write it. We're using the user keymap for the example here. This is a complex function, and has a lot going on. In fact, it uses a lot of the above functions to work!
@ -126,9 +132,126 @@ void eeconfig_init_user(void) { // EEPROM is getting reset!
And you're done. The RGB layer indication will only work if you want it to. And it will be saved, even after unplugging the board. And if you use any of the RGB codes, it will disable the layer indication, so that it stays on the mode and color that you set it to.
## 'EECONFIG' Function Documentation
### Basic API
* Keyboard/Revision: `void eeconfig_init_kb(void)`, `uint32_t eeconfig_read_kb(void)` and `void eeconfig_update_kb(uint32_t val)`
* Keymap: `void eeconfig_init_user(void)`, `uint32_t eeconfig_read_user(void)` and `void eeconfig_update_user(uint32_t val)`
The `val` is the value of the data that you want to write to EEPROM. And the `eeconfig_read_*` function return a 32 bit (DWORD) value from the EEPROM.
## Datablock {#datablock}
An extended form exists that allows larger blocks of data to be allocated.
::: info
When using datablock, the [basic API](#eeconfig-function-documentation) is unavailable.
:::
:::::tabs
==== keyboard
In `config.h`, define the size required, and optionally a version number:
| Define | Default | Description |
|------------------------------|---------------------------|------------------------------------------------------------------|
| `EECONFIG_KB_DATA_SIZE` | `0` | Size in bytes for the persistent block of data |
| `EECONFIG_KB_DATA_VERSION` | `EECONFIG_KB_DATA_SIZE` | Version number that can be incremented to invalidate stored data |
Which exposes the following API:
```c
bool eeconfig_is_kb_datablock_valid(void);
uint32_t eeconfig_read_kb_datablock(void *data, uint32_t offset, uint32_t length) __attribute__((nonnull));
uint32_t eeconfig_update_kb_datablock(const void *data, uint32_t offset, uint32_t length) __attribute__((nonnull));
void eeconfig_init_kb_datablock(void);
# define eeconfig_read_kb_datablock_field(__object, __field) eeconfig_read_kb_datablock(&(__object.__field), offsetof(typeof(__object), __field), sizeof(__object.__field))
# define eeconfig_update_kb_datablock_field(__object, __field) eeconfig_update_kb_datablock(&(__object.__field), offsetof(typeof(__object), __field), sizeof(__object.__field))
```
==== keymap
In `config.h`, define the size required, and optionally a version number:
| Define | Default | Description |
|------------------------------|---------------------------|------------------------------------------------------------------|
| `EECONFIG_USER_DATA_SIZE` | `0` | Size in bytes for the persistent block of data |
| `EECONFIG_USER_DATA_VERSION` | `EECONFIG_USER_DATA_SIZE` | Version number that can be incremented to invalidate stored data |
Which exposes the following API:
```c
bool eeconfig_is_user_datablock_valid(void);
uint32_t eeconfig_read_user_datablock(void *data, uint32_t offset, uint32_t length) __attribute__((nonnull));
uint32_t eeconfig_update_user_datablock(const void *data, uint32_t offset, uint32_t length) __attribute__((nonnull));
void eeconfig_init_user_datablock(void);
# define eeconfig_read_user_datablock_field(__object, __field) eeconfig_read_user_datablock(&(__object.__field), offsetof(typeof(__object), __field), sizeof(__object.__field))
# define eeconfig_update_user_datablock_field(__object, __field) eeconfig_update_user_datablock(&(__object.__field), offsetof(typeof(__object), __field), sizeof(__object.__field))
```
:::::
### Examples
#### Basic
This is an example of how to add settings, and read and write it. We're using the user keymap for the example here.
In your `config.h` add:
```c
#define EECONFIG_USER_DATA_SIZE 8
```
In your keymap.c file, add:
```c
#include "debug.h"
#include "timer.h"
#include "eeconfig.h"
typedef struct my_config_t {
uint64_t data;
} my_config_t;
static my_config_t config;
void keyboard_post_init_user(void) {
eeconfig_read_user_datablock(&config, 0, sizeof(my_config_t));
}
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
if (!record->event.pressed) {
config.data += 1;
eeconfig_update_user_datablock(&config, 0, sizeof(my_config_t));
}
return true;
}
void housekeeping_task_user(void) {
static uint32_t last_sync = 0;
if (timer_elapsed32(last_sync) > 1000) {
last_sync = timer_read32();
dprintf("Config: %ld\n", config.data);
}
}
```
#### Default Values
Extending the above example, a default value for the datablock can be configured as follows:
```c
void eeconfig_init_user_datablock(void) {
my_config_t default_config = {
.data = 42,
};
eeconfig_update_user_datablock(&default_config, 0, sizeof(my_config_t));
}
```
::: tip
For large datablocks, you might need to manually update in chunks to avoid memory issues.
:::

View file

@ -16,7 +16,8 @@ These functions allow you to activate layers in various ways. Note that layers a
* `OSL(layer)` - momentarily activates *layer* until the next key is pressed. See [One Shot Keys](one_shot_keys) for details and additional functionality.
* `TG(layer)` - toggles *layer*, activating it if it's inactive and vice versa
* `TO(layer)` - activates *layer* and de-activates all other layers (except your default layer). This function is special, because instead of just adding/removing one layer to your active layer stack, it will completely replace your current active layers, uniquely allowing you to replace higher layers with a lower one. This is activated on keydown (as soon as the key is pressed).
* `TT(layer)` - Layer Tap-Toggle. If you hold the key down, *layer* is activated, and then is de-activated when you let go (like `MO`). If you repeatedly tap it, the layer will be toggled on or off (like `TG`). It needs 5 taps by default, but you can change this by defining `TAPPING_TOGGLE` -- for example, `#define TAPPING_TOGGLE 2` to toggle on just two taps.
* `TT(layer)` - Layer Tap-Toggle. If you hold the key down, *layer* is activated, and then is de-activated when you let go (like `MO`). If you repeatedly tap it, the layer will be toggled on or off (like `TG`). It needs 5 taps by default, but you can change this by defining `TAPPING_TOGGLE` -- for example, `#define TAPPING_TOGGLE 2` to toggle on just two taps.
* Note: toggling behavior requires that [Quick Tap](tap_hold#quick-tap-term) is enabled (`QUICK_TAP_TERM` not set to `0`), or if `QUICK_TAP_TERM_PER_KEY` is defined, that `get_quick_tap_term()` returns a non-zero value for the `TT` key.
See also the [Layer Lock key](features/layer_lock), which locks the highest
active layer until pressed again.
@ -51,7 +52,7 @@ Sometimes you need more than one base layer. For example, if you want to switch
### Advanced Users {#advanced-users}
Once you have a good feel for how layers work and what you can do, you can get more creative. The rules listed in the beginner section will help you be successful by avoiding some of the tricker details but they can be constraining, especially for ultra-compact keyboard users. Understanding how layers work will allow you to use them in more advanced ways.
Once you have a good feel for how layers work and what you can do, you can get more creative. The rules listed in the beginner section will help you be successful by avoiding some of the trickier details but they can be constraining, especially for ultra-compact keyboard users. Understanding how layers work will allow you to use them in more advanced ways.
Layers stack on top of each other in numerical order. When determining what a keypress does, QMK scans the layers from the top down, stopping when it reaches the first active layer that is not set to `KC_TRNS`. As a result if you activate a layer that is numerically lower than your current layer, and your current layer (or another layer that is active and higher than your target layer) has something other than `KC_TRNS`, that is the key that will be sent, not the key on the layer you just activated. This is the cause of most people's "why doesn't my layer get switched" problem.

View file

@ -95,6 +95,10 @@ The use of `features` matches the definition normally provided within `keyboard.
The `keycodes` array allows a module to provide new keycodes (as well as corresponding aliases) to a keymap.
### `config.h`
This file will be automatically added to the build as if it were present in the keyboard or keymap.
### `rules.mk` / `post_rules.mk`
These two files follows standard QMK build system logic, allowing for `Makefile`-style customisation as if it were present in the keyboard or keymap.
@ -131,24 +135,45 @@ This file defines LED matrix effects in the same form as used with `led_matrix_k
This file defines RGB matrix effects in the same form as used with `rgb_matrix_kb.inc` and `rgb_matrix_user.inc` (see [Custom RGB Matrix Effects](rgb_matrix#custom-rgb-matrix-effects)). Effect mode names are prepended with `RGB_MATRIX_COMMUNITY_MODULE_`.
### Additional Customization
#### Split Keyboard Data Sync
Defines follow the convention, `SPLIT_TRANSACTION_IDS_MODULE_<MODULE>` (see [Custom data sync](split_keyboard#custom-data-sync)).
#### Persistent Configuration
Defines follow the convention, `EECONFIG_MODULE_<MODULE>_DATA_SIZE` and `EECONFIG_MODULE_<MODULE>_DATA_VERSION` (see [Custom Persistent Configuration](../feature_eeprom#datablock)).
When configured, the following APIs are available:
| API Format | Example (`hello_world` module) | API Version |
|--------------------------------------------|-----------------------------------------------|-------------|
| `eeconfig_is_<module>_datablock_valid` | `eeconfig_is_hello_world_datablock_valid` | `1.1.3` |
| `eeconfig_read_<module>_datablock` | `eeconfig_read_hello_world_datablock` | `1.1.3` |
| `eeconfig_update_<module>_datablock` | `eeconfig_update_hello_world_datablock` | `1.1.3` |
| `eeconfig_init_<module>_datablock` | `eeconfig_init_hello_world_datablock` | `1.1.3` |
| `eeconfig_read_<module>_datablock_field` | `eeconfig_read_hello_world_datablock_field` | `1.1.3` |
| `eeconfig_update_<module>_datablock_field` | `eeconfig_update_hello_world_datablock_field` | `1.1.3` |
### Compatible APIs
Community Modules may provide specializations for the following APIs:
| Base API | API Format | Example (`hello_world` module) | API Version |
|----------------------------------|-------------------------------------------|---------------------------------------------|-------------|
| `keyboard_pre_init` | `keyboard_pre_init_<module>` | `keyboard_pre_init_hello_world` | `0.1.0` |
| `keyboard_post_init` | `keyboard_post_init_<module>` | `keyboard_post_init_hello_world` | `0.1.0` |
| `pre_process_record` | `pre_process_record_<module>` | `pre_process_record_hello_world` | `0.1.0` |
| `process_record` | `process_record_<module>` | `process_record_hello_world` | `0.1.0` |
| `post_process_record` | `post_process_record_<module>` | `post_process_record_hello_world` | `0.1.0` |
| `housekeeping_task` | `housekeeping_task_<module>` | `housekeeping_task_hello_world` | `1.0.0` |
| `suspend_power_down` | `suspend_power_down_<module>` | `suspend_power_down_hello_world` | `1.0.0` |
| `suspend_wakeup_init` | `suspend_wakeup_init_<module>` | `suspend_wakeup_init_hello_world` | `1.0.0` |
| `shutdown` | `shutdown_<module>` | `shutdown_hello_world` | `1.0.0` |
| `process_detected_host_os` | `process_detected_host_os_<module>` | `process_detected_host_os_hello_world` | `1.0.0` |
| `default_layer_state_set` | `default_layer_state_set_<module>` | `default_layer_state_set_hello_world` | `1.1.0` |
| `layer_state_set` | `layer_state_set_<module>` | `layer_state_set_hello_world` | `1.1.0` |
| Base API | API Format | Example (`hello_world` module) | API Version |
|----------------------------------|-------------------------------------------|----------------------------------------------|-------------|
| `keyboard_pre_init` | `keyboard_pre_init_<module>` | `keyboard_pre_init_hello_world` | `0.1.0` |
| `keyboard_post_init` | `keyboard_post_init_<module>` | `keyboard_post_init_hello_world` | `0.1.0` |
| `pre_process_record` | `pre_process_record_<module>` | `pre_process_record_hello_world` | `0.1.0` |
| `process_record` | `process_record_<module>` | `process_record_hello_world` | `0.1.0` |
| `post_process_record` | `post_process_record_<module>` | `post_process_record_hello_world` | `0.1.0` |
| `housekeeping_task` | `housekeeping_task_<module>` | `housekeeping_task_hello_world` | `1.0.0` |
| `suspend_power_down` | `suspend_power_down_<module>` | `suspend_power_down_hello_world` | `1.0.0` |
| `suspend_wakeup_init` | `suspend_wakeup_init_<module>` | `suspend_wakeup_init_hello_world` | `1.0.0` |
| `shutdown` | `shutdown_<module>` | `shutdown_hello_world` | `1.0.0` |
| `process_detected_host_os` | `process_detected_host_os_<module>` | `process_detected_host_os_hello_world` | `1.0.0` |
| `default_layer_state_set` | `default_layer_state_set_<module>` | `default_layer_state_set_hello_world` | `1.1.0` |
| `layer_state_set` | `layer_state_set_<module>` | `layer_state_set_hello_world` | `1.1.0` |
| `led_matrix_indicators` | `led_matrix_indicators_<module>` | `led_matrix_indicators_hello_world` | `1.1.0` |
| `led_matrix_indicators_advanced` | `led_matrix_indicators_advanced_<module>` | `led_matrix_indicators_advanced_hello_world` | `1.1.0` |
| `rgb_matrix_indicators` | `rgb_matrix_indicators_<module>` | `rgb_matrix_indicators_hello_world` | `1.1.0` |
@ -156,7 +181,6 @@ Community Modules may provide specializations for the following APIs:
| `pointing_device_init` | `pointing_device_init_<module>` | `pointing_device_init_hello_world` | `1.1.0` |
| `pointing_device_task` | `pointing_device_task_<module>` | `pointing_device_task_hello_world` | `1.1.0` |
::: info
An unspecified API is disregarded if a Community Module does not provide a specialization for it.
:::

View file

@ -32,12 +32,13 @@ For the details about the internals of the dynamic macros, please read the comme
There are a number of options added that should allow some additional degree of customization
|Define |Default |Description |
|----------------------------|----------------|-----------------------------------------------------------------------------------------------------------------|
|`DYNAMIC_MACRO_SIZE` |128 |Sets the amount of memory that Dynamic Macros can use. This is a limited resource, dependent on the controller. |
|`DYNAMIC_MACRO_USER_CALL` |*Not defined* |Defining this falls back to using the user `keymap.c` file to trigger the macro behavior. |
|`DYNAMIC_MACRO_NO_NESTING` |*Not Defined* |Defining this disables the ability to call a macro from another macro (nested macros). |
|`DYNAMIC_MACRO_DELAY` |*Not Defined* |Sets the waiting time (ms unit) when sending each key. |
|Define |Default |Description |
|------------------------------------------|----------------|-----------------------------------------------------------------------------------------------------------------|
|`DYNAMIC_MACRO_SIZE` |128 |Sets the amount of memory that Dynamic Macros can use. This is a limited resource, dependent on the controller. |
|`DYNAMIC_MACRO_USER_CALL` |*Not defined* |Defining this falls back to using the user `keymap.c` file to trigger the macro behavior. |
|`DYNAMIC_MACRO_NO_NESTING` |*Not Defined* |Defining this disables the ability to call a macro from another macro (nested macros). |
|`DYNAMIC_MACRO_DELAY` |*Not Defined* |Sets the waiting time (ms unit) when sending each key. |
|`DYNAMIC_MACRO_KEEP_ORIGINAL_LAYER_STATE` |*Not Defined* |Defining this keeps the layer state when starting to record a macro |
If the LEDs start blinking during the recording with each keypress, it means there is no more space for the macro in the macro buffer. To fit the macro in, either make the other macro shorter (they share the same buffer) or increase the buffer size by adding the `DYNAMIC_MACRO_SIZE` define in your `config.h` (default value: 128; please read the comments for it in the header).

View file

@ -121,7 +121,7 @@ Linear resonant actuators (LRA, also know as a linear vibrator) works different
#### DRV2605L waveform library
DRV2605L comes with preloaded library of various waveform sequences that can be called and played. If writing a macro, these waveforms can be played using `DRV_pulse(*sequence name or number*)`
DRV2605L comes with preloaded library of various waveform sequences that can be called and played. If writing a macro, these waveforms can be played using `drv2605l_pulse(*sequence name or number*)` after adding `#include "drv2605l.h"`.
List of waveform sequences from the datasheet:

View file

@ -14,7 +14,7 @@ You can use key overrides in a similar way to momentary layer/fn keys to activat
To enable this feature, you need to add `KEY_OVERRIDE_ENABLE = yes` to your `rules.mk`.
Then, in your `keymap.c` file, you'll need to define the array `key_overrides`, which defines all key overrides to be used. Each override is a value of type `key_override_t`. The array `key_overrides`contains pointers to `key_override_t` values (`const key_override_t **`).
Then, in your `keymap.c` file, you'll need to define the `key_overrides` config. See below for more details.
## Creating Key Overrides {#creating-key-overrides}
@ -47,6 +47,17 @@ const key_override_t *key_overrides[] = {
};
```
This second example inverts or swaps semicolon and colon on ANSI and many other layouts. That means pressing the key alone sends `shift` + `semicolon` giving `colon` (`S(KP_SCLN)` aka `KC_COLN`), but when pressing the key with shift, the shift modifier is suppressed (see `suppressed_mods` below), sending only `semicolon` (`KC_SCLN`):
```c
const key_override_t semicolon_colon_key_override = ko_make_basic(MOD_MASK_SHIFT, KC_COLN, KC_SCLN);
// This globally defines all key overrides to be used
const key_override_t *key_overrides[] = {
&semicolon_colon_key_override
};
```
## Intermediate Difficulty Examples {#intermediate-difficulty-examples}
### Media Controls & Screen Brightness {#media-controls-amp-screen-brightness}

View file

@ -88,6 +88,8 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{
|`QK_LED_MATRIX_BRIGHTNESS_DOWN`|`LM_BRID`|Decrease the brightness level |
|`QK_LED_MATRIX_SPEED_UP` |`LM_SPDU`|Increase the animation speed |
|`QK_LED_MATRIX_SPEED_DOWN` |`LM_SPDD`|Decrease the animation speed |
|`QK_LED_MATRIX_FLAG_NEXT` |`LM_FLGN`|Cycle through flags |
|`QK_LED_MATRIX_FLAG_PREVIOUS` |`LM_FLGP`|Cycle through flags in reverse |
## LED Matrix Effects {#led-matrix-effects}
@ -253,6 +255,7 @@ const char* effect_name = led_matrix_get_mode_name(led_matrix_get_mode());
#define LED_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set
#define LED_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
#define LED_MATRIX_FLAG_STEPS { LED_FLAG_ALL, LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER, LED_FLAG_NONE } // Sets the flags which can be cycled through.
```
## EEPROM storage {#eeprom-storage}
@ -505,6 +508,62 @@ The current effect speed, from 0 to 255.
---
### `void led_matrix_set_flags(led_flags_t flags)` {#api-led-matrix-set-flags}
Set the global effect flags.
#### Arguments {#api-led-matrix-set-flags-arguments}
- `led_flags_t flags`
The [flags](#flags) value to set.
---
### `void led_matrix_set_flags_noeeprom(led_flags_t flags)` {#api-led-matrix-set-flags-noeeprom}
Set the global effect flags. New state is not written to EEPROM.
#### Arguments {#api-led-matrix-set-flags-noeeprom-arguments}
- `led_flags_t flags`
The [flags](#flags) value to set.
---
### `void led_matrix_flags_step(void)` {#api-led-matrix-flags-step}
Move to the next flag combination.
---
### `void led_matrix_flags_step_noeeprom(void)` {#api-led-matrix-flags-step-noeeprom}
Move to the next flag combination. New state is not written to EEPROM.
---
### `void led_matrix_flags_step_reverse(void)` {#api-led-matrix-flags-step-reverse}
Move to the previous flag combination.
---
### `void led_matrix_flags_step_reverse_noeeprom(void)` {#api-led-matrix-flags-step-reverse-noeeprom}
Move to the previous flag combination. New state is not written to EEPROM.
---
### `uint8_t led_matrix_get_flags(void)` {#api-led-matrix-get-flags}
Get the current global effect flags.
#### Return Value {#api-led-matrix-get-flags-return}
The current effect [flags](#flags).
---
### `void led_matrix_reload_from_eeprom(void)` {#api-led-matrix-reload-from-eeprom}
Reload the effect configuration (enabled, mode and brightness) from EEPROM.

View file

@ -77,6 +77,7 @@ Tips:
* For smoother cursor movements, lower the value of `MOUSEKEY_INTERVAL`. If the refresh rate of your display is 60Hz, you could set it to `16` (1/60). As this raises the cursor speed significantly, you may want to lower `MOUSEKEY_MAX_SPEED`.
* Setting `MOUSEKEY_TIME_TO_MAX` or `MOUSEKEY_WHEEL_TIME_TO_MAX` to `0` will disable acceleration for the cursor or scrolling respectively. This way you can make one of them constant while keeping the other accelerated, which is not possible in constant speed mode.
* Setting `MOUSEKEY_WHEEL_INTERVAL` too low will make scrolling too fast. Setting it too high will make scrolling too slow when the wheel key is held down.
* `MS_ACL0`, `MS_ACL1` and `MS_ACL2` change the cursor and scroll speed to 1/4, 1/2, and the maximum speed, respectively.
Cursor acceleration uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).

View file

@ -136,12 +136,19 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
print_stored_setups();
}
return false;
default:
return true; // Process all other keycodes normally
}
}
```
Then please open an issue on Github with this information and tell what OS was not detected correctly and if you have any intermediate devices between keyboard and your computer.
Add both `STORE_SETUPS` and `PRINT_SETUPS` to your keyboard's keymap. Connect the keyboard to the device where the OS was not recognised, and press the `STORE_SETUPS` key to capture and store the fingerprint. On your development computer, run one of the suggested [console debugging tools](/faq_debug#debugging-tools), connect the keyboard, and press the `PRINT_SETUPS` key. The console should display multiple lines of data from the most recent `STORE_SETUPS` run.
Open an issue on GitHub and paste the console output into the issue. Also tell us which OS (including the version, if possible) was not detected correctly and whether any intermediate devices, such as a USB hub, were used between the keyboard and the target device.
::: tip
If `STORE_SETUPS` has not been used previously, `PRINT_SETUPS` will report whatever values are already present in the controller's EEPROM. These may appear as random numbers.
:::
## Credits

View file

@ -267,6 +267,23 @@ The paw 3204 sensor uses a serial type protocol for communication, and requires
The CPI range is 400-1600, with supported values of (400, 500, 600, 800, 1000, 1200 and 1600). Defaults to 1000 CPI.
### PAW-3222 Sensor
To use the PAW-3222 sensor, add this to your `rules.mk`:
```make
POINTING_DEVICE_DRIVER = paw3222
```
The following pins must be defined in `config.h`:
| Setting (`config.h`) | Description | Default |
| --------------------- | ------------------------------------------------------------------ | ---------------------------- |
| `PAW3222_CS_PIN` | (Required) The pin connected to the chip select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |
| `PAW3222_SPI_DIVISOR` | (Required) The SPI clock divisor. This is dependent on your MCU. | _not defined_ |
The CPI range is up to 4,000. Defaults to 1,000 CPI.
### Pimoroni Trackball
To use the Pimoroni Trackball module, add this to your `rules.mk`:
@ -303,6 +320,23 @@ The PMW3320 sensor uses a serial type protocol for communication, and requires a
The CPI range is 500-3500, in increments of 250. Defaults to 1000 CPI.
### PMW-3325 Sensor
To use the PMW-3325 sensor, add this to your `rules.mk`:
```make
POINTING_DEVICE_DRIVER = pmw3325
```
The following pins must be defined in `config.h`:
| Setting (`config.h`) | Description | Default |
| --------------------- | ------------------------------------------------------------------ | ---------------------------- |
| `PMW3325_CS_PIN` | (Required) The pin connected to the chip select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |
| `PMW3325_SPI_DIVISOR` | (Required) The SPI clock divisor. This is dependent on your MCU. | _not defined_ |
The CPI range is 100-5000, in increments of 100. Defaults to 2000 CPI.
### PMW 3360 and PMW 3389 Sensor
This drivers supports both the PMW 3360 and PMW 3389 sensor as well as multiple sensors of the same type _per_ controller, so 2 can be attached at the same side for split keyboards (or unsplit keyboards).

View file

@ -166,7 +166,7 @@ In your keyboard config.h:
The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU.
There are strict requirements for pin ordering but any pair of GPIO pins can be used. The GPIO used for clock must be directly after data, see the included info.json snippet for an example of correct order.
The GPIOs used for clock and data must be consecutive (in either order).
You may optionally switch the PIO peripheral used with the following define in config.h:
```c

View file

@ -96,6 +96,8 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{
|`QK_RGB_MATRIX_VALUE_DOWN` |`RM_VALD`|Decrease the brightness level |
|`QK_RGB_MATRIX_SPEED_UP` |`RM_SPDU`|Increase the animation speed |
|`QK_RGB_MATRIX_SPEED_DOWN` |`RM_SPDD`|Decrease the animation speed |
|`QK_RGB_MATRIX_FLAG_NEXT` |`RM_FLGN`|Cycle through flags |
|`QK_RGB_MATRIX_FLAG_PREVIOUS` |`RM_FLGP`|Cycle through flags in reverse |
## RGB Matrix Effects {#rgb-matrix-effects}
@ -409,6 +411,7 @@ const char* effect_name = rgb_matrix_get_mode_name(rgb_matrix_get_mode());
#define RGB_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
#define RGB_TRIGGER_ON_KEYDOWN // Triggers RGB keypress events on key down. This makes RGB control feel more responsive. This may cause RGB to not function properly on some boards
#define RGB_MATRIX_FLAG_STEPS { LED_FLAG_ALL, LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER, LED_FLAG_UNDERGLOW, LED_FLAG_NONE } // Sets the flags which can be cycled through.
```
## EEPROM storage {#eeprom-storage}
@ -852,6 +855,62 @@ The current effect speed, from 0 to 255.
---
### `void rgb_matrix_set_flags(led_flags_t flags)` {#api-rgb-matrix-set-flags}
Set the global effect flags.
#### Arguments {#api-rgb-matrix-set-flags-arguments}
- `led_flags_t flags`
The [flags](#flags) value to set.
---
### `void rgb_matrix_set_flags_noeeprom(led_flags_t flags)` {#api-rgb-matrix-set-flags-noeeprom}
Set the global effect flags. New state is not written to EEPROM.
#### Arguments {#api-rgb-matrix-set-flags-noeeprom-arguments}
- `led_flags_t flags`
The [flags](#flags) value to set.
---
### `void rgb_matrix_flags_step(void)` {#api-rgb-matrix-flags-step}
Move to the next flag combination.
---
### `void rgb_matrix_flags_step_noeeprom(void)` {#api-rgb-matrix-flags-step-noeeprom}
Move to the next flag combination. New state is not written to EEPROM.
---
### `void rgb_matrix_flags_step_reverse(void)` {#api-rgb-matrix-flags-step-reverse}
Move to the previous flag combination.
---
### `void rgb_matrix_flags_step_reverse_noeeprom(void)` {#api-rgb-matrix-flags-step-reverse-noeeprom}
Move to the previous flag combination. New state is not written to EEPROM.
---
### `uint8_t rgb_matrix_get_flags(void)` {#api-rgb-matrix-get-flags}
Get the current global effect flags.
#### Return Value {#api-rgb-matrix-get-flags-return}
The current effect [flags](#flags).
---
### `void rgb_matrix_sethsv(uint8_t h, uint8_t s, uint8_t v)` {#api-rgb-matrix-sethsv}
Set the global effect hue, saturation, and value (brightness).

View file

@ -6,11 +6,12 @@ The [Open Steno Project](https://www.openstenoproject.org/) has built an open-so
## Steno Support in QMK
There are three ways that QMK keyboards can support steno, with varying degrees of configuration required:
There are four ways that QMK keyboards can support steno, with varying degrees of configuration required:
1. Plover with [Arpeggiation](https://plover.wiki/index.php/Glossary#Arpeggiate) requires no changes to any keyboard and is supported by QMK as well as any other QWERTY keyboard.
2. Plover with [NKRO](https://plover.wiki/index.php/Using_a_standard_keyboard_with_Plover#NKRO). If your keyboard supports NKRO in hardware and you have NKRO enabled as a USB endpoint, you can chord with the keyboard. Many devices will arrive stock like this and will require no changes.
3. Steno Machine Protocols. This requires the most configuration, but this has the advantage of allowing you to use your keyboard keys normally (either on another layer or another piece of hardware) without enabling and disabling your steno software.
4. Plover HID Protocol. This is a custom HID protocol that Plover can understand, but does not require a COM port. It is robust to device disconnects and saves an interface over the COM-based alternatives.
## Plover with QWERTY Keyboard {#plover-with-qwerty-keyboard}
@ -92,6 +93,22 @@ Examples of steno strokes and the associated packet:
- `WAZ` = `10000000 00000010 00100000 00000000 00000000 00000001`
- `PHAPBGS` = `10000000 00000101 00100000 00000000 01101010 00000000`
## Plover HID Protocol {#plover-hid-protocol}
This mode operates independently of the other Steno "official" machine protocols. Like any other mouse or keyboard, it uses the USB HID protocol to communicate with Plover by sending an 8 byte (64 bit) packet representing a bitfield for all the possible keys on a steno machine plus a number of additional general purpose keys for custom use. This protocol is only understood by Plover as of [5.1.0](https://github.com/opensteno/plover/releases/tag/v5.1.0).
Add
```make
PLOVER_HID_ENABLE = yes
```
to your `rules.mk` file. This does **not** require `STENO_ENABLE` to be set.
All of the possible keycodes are defined with the `PLV_` prefix and are available without any additional includes.
More details can be found here: https://github.com/dnaq/plover-machine-hid
### Switching protocols on the fly {#switching-protocols-on-the-fly}
If you wish to switch the serial protocol used to transfer the steno chords without having to recompile your keyboard firmware every time, you can press the `QK_STENO_BOLT` and `QK_STENO_GEMINI` keycodes in order to switch protocols on the fly.

View file

@ -40,6 +40,10 @@ Similar to the first option, the second and third option are good for simple lay
For more complicated cases, like blink the LEDs, fiddle with the backlighting, and so on, use the fourth or fifth option. Examples of each are listed below.
::: tip
If too many tap dances are active at the same time, later ones won't have any effect. You need to increase `TAP_DANCE_MAX_SIMULTANEOUS` by adding `#define TAP_DANCE_MAX_SIMULTANEOUS 5` (or higher) to your keymap's `config.h` file if you expect that users may hold down many tap dance keys simultaneously. By default, only 3 tap dance keys can be used together at the same time.
:::
## Implementation Details {#implementation}
Well, that's the bulk of it! You should now be able to work through the examples below, and to develop your own Tap Dance functionality. But if you want a deeper understanding of what's going on behind the scenes, then read on for the explanation of how it all works!
@ -209,11 +213,13 @@ tap_dance_action_t tap_dance_actions[] = {
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
tap_dance_action_t *action;
tap_dance_state_t* state;
switch (keycode) {
case TD(CT_CLN): // list all tap dance keycodes with tap-hold configurations
action = &tap_dance_actions[QK_TAP_DANCE_GET_INDEX(keycode)];
if (!record->event.pressed && action->state.count && !action->state.finished) {
case TD(CT_CLN):
action = tap_dance_get(QK_TAP_DANCE_GET_INDEX(keycode));
state = tap_dance_get_state(QK_TAP_DANCE_GET_INDEX(keycode));
if (!record->event.pressed && state != NULL && state->count && !state->finished) {
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;
tap_code16(tap_hold->tap);
}
@ -369,6 +375,10 @@ In this configuration "hold" takes place **after** tap dance timeout. To achieve
Tap dance can be used to emulate `MT()` and `LT()` behavior when the tapped code is not a basic keycode. This is useful to send tapped keycodes that normally require `Shift`, such as parentheses or curly braces—or other modified keycodes, such as `Control + X`.
::: tip
For simply sending a non-basic keycode on tap while functioning as a modifier or layer switch on hold, a simpler (and often superior) alternative is to use a Mod-Tap or Layer-Tap key and intercept its tap function in `process_record_user()`. This avoids the complexity of Tap Dance, and allows the key to benefit from advanced Tap-Hold options. See [Intercepting Mod-Taps](../mod_tap#intercepting-mod-taps) for details.
:::
Below your layers and custom keycodes, add the following:
```c

View file

@ -8,9 +8,9 @@ There are some limitations to this feature. Because there is no "standard" metho
## Usage {#usage}
The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See below for more details.
The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See [below](#input-subsystems) for more details.
Add the following to your keymap's `rules.mk`:
To start, add the following to your keymap's `rules.mk`:
```make
UNICODE_COMMON = yes
@ -18,22 +18,25 @@ UNICODE_COMMON = yes
## Basic Configuration {#basic-configuration}
Add the following to your `config.h`:
The following options can be set or overridden in your `config.h`:
|Define |Default |Description |
|------------------------|------------------|--------------------------------------------------------------------------------|
|`UNICODE_KEY_MAC` |`KC_LEFT_ALT` |The key to hold when beginning a Unicode sequence with the macOS input mode |
|`UNICODE_KEY_LNX` |`LCTL(LSFT(KC_U))`|The key to tap when beginning a Unicode sequence with the Linux input mode |
|`UNICODE_KEY_WINC` |`KC_RIGHT_ALT` |The key to hold when beginning a Unicode sequence with the WinCompose input mode|
|`UNICODE_SELECTED_MODES`|`-1` |A comma separated list of input modes for cycling through |
|`UNICODE_SELECTED_MODES`|*n/a* |A comma separated list of input modes for cycling through |
|`UNICODE_CYCLE_PERSIST` |`true` |Whether to persist the current Unicode input mode to EEPROM |
|`UNICODE_TYPE_DELAY` |`10` |The amount of time to wait, in milliseconds, between Unicode sequence keystrokes|
The default values work well for most use cases, so users usually only need to define `UNICODE_SELECTED_MODES` to set their desired input modes.
However, if you plan on switching input modes manually (see [keycodes](#keycodes) below) and don't plan on cycling through them, this definition can be omitted.
### Audio Feedback {#audio-feedback}
If you have the [Audio](audio) feature enabled on your board, you can configure it to play sounds when the input mode is changed.
Add the following to your `config.h`:
Add one or more of the following definitions to your `config.h`:
|Define |Default|Description |
|-------------------|-------|-----------------------------------------------------------|

View file

@ -217,8 +217,8 @@ To generate this bootloader, use the `bootloader` target, eg. `make planck/rev4:
Compatible flashers:
* TBD
* Currently, you need to either use the [Python script](https://github.com/qmk/lufa/tree/master/Bootloaders/HID/HostLoaderApp_python), or compile [`hid_bootloader_cli`](https://github.com/qmk/lufa/tree/master/Bootloaders/HID/HostLoaderApp), from the LUFA repo. Homebrew may (will) have support for this directly (via `brew install qmk/qmk/hid_bootloader_cli`).
* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI)
* [hid_bootloader_cli](https://github.com/qmk/lufa/tree/master/Bootloaders/HID/HostLoaderApp) / `:qmk-hid` target in QMK (recommended command line)
Flashing sequence:

View file

@ -91,7 +91,7 @@ Enables your LED to breath while your computer is sleeping. Timer1 is being used
`NKRO_ENABLE`
This allows the keyboard to tell the host OS that up to 248 keys are held down at once (default without NKRO is 6). NKRO is off by default, even if `NKRO_ENABLE` is set. NKRO can be forced by adding `#define FORCE_NKRO` to your config.h or by binding `MAGIC_TOGGLE_NKRO` to a key and then hitting the key.
This allows the keyboard to tell the host OS that up to 248 keys are held down at once (default without NKRO is 6). NKRO is off by default, even if `NKRO_ENABLE` is set. NKRO can be toggled by binding `NK_TOGG` to a key and then hitting the key.
`BACKLIGHT_ENABLE`

View file

@ -220,14 +220,18 @@ This bootloader is primarily for keyboards originally designed for the PS2AVRGB
USBaspLoader is a bootloader based on V-USB that emulates a hardware USBasp device. It runs on ATmega32A and ATmega328P MCUs.
Precompiled `.hex` files are generally not available, but you can compile it yourself by setting up the QMK environment and following Coseyfannitutti's guide for the appropriate MCU:
Precompiled `.hex` files are generally not available, but you can compile it yourself by setting up the QMK environment and cloning the appropriate branch of Coseyfannitutti's USBaspLoader fork:
|MCU |Low |High |Extended|USB ID |
|-------------------------------------------------------------------------------------|------|------|--------|-----------|
|[ATmega32A](https://github.com/coseyfannitutti/discipline/tree/master/doc/bootloader)|`0x1F`|`0xC0`|*n/a* |`16C0:05DC`|
|[ATmega328P](https://github.com/coseyfannitutti/discipad/tree/master/doc/bootloader) |`0xD7`|`0xD0`|`0x04` |`16C0:05DC`|
|MCU |Low |High |Extended|USB ID |
|-----------------------------------------------------------------------------|------|------|--------|-----------|
|[ATmega32A](https://github.com/coseyfannitutti/USBaspLoader/tree/atmega32a) |`0x1F`|`0xC0`|*n/a* |`16C0:05DC`|
|[ATmega328P](https://github.com/coseyfannitutti/USBaspLoader/tree/atmega328p)|`0xD7`|`0xD0`|`0x04` |`16C0:05DC`|
Note that some boards may have their own specialized build of this bootloader in a separate repository. This will usually be linked to in the board's readme.
From there, simply `cd` to the `firmware/` directory and run `make`, which should produce a file called `main.hex`.
:::tip
Some boards may have their own specialized build of this bootloader in a separate repository. This will usually be linked to in the board's readme.
:::
## Flashing the Bootloader

View file

@ -433,6 +433,8 @@ See also: [LED Matrix](features/led_matrix)
|`QK_LED_MATRIX_BRIGHTNESS_DOWN`|`LM_BRID`|Decrease the brightness level |
|`QK_LED_MATRIX_SPEED_UP` |`LM_SPDU`|Increase the animation speed |
|`QK_LED_MATRIX_SPEED_DOWN` |`LM_SPDD`|Decrease the animation speed |
|`QK_LED_MATRIX_FLAG_NEXT` |`LM_FLGN`|Cycle through flags |
|`QK_LED_MATRIX_FLAG_PREVIOUS` |`LM_FLGP`|Cycle through flags in reverse |
## Magic Keycodes {#magic-keycodes}
@ -783,6 +785,8 @@ See also: [RGB Matrix](features/rgb_matrix)
|`QK_RGB_MATRIX_VALUE_DOWN` |`RM_VALD`|Decrease the brightness level |
|`QK_RGB_MATRIX_SPEED_UP` |`RM_SPDU`|Increase the animation speed |
|`QK_RGB_MATRIX_SPEED_DOWN` |`RM_SPDD`|Decrease the animation speed |
|`QK_RGB_MATRIX_FLAG_NEXT` |`RM_FLGN`|Cycle through flags |
|`QK_RGB_MATRIX_FLAG_PREVIOUS` |`RM_FLGP`|Cycle through flags in reverse |
## US ANSI Shifted Symbols {#us-ansi-shifted-symbols}

View file

@ -33,11 +33,13 @@ If you own a board from one of the following vendors already, consider asking th
| iLovBee | Official 30-day copyright source code request issued Sep 11 2024 due to deception on PR, no response received. Ambiguity on PRs -- marketing says wireless, PR author said wired-only, then included wireless code anyway. Seemingly intentionally deceptive. |
| KiiBOOM | Seems to use the same OEM as Epomaker, same problems. |
| kprepublic | Makes no attempt to release source code, all boards in QMK are reverse-engineered, created, and supported by the community. New board variants magically appear without telling customers they're incompatible with existing QMK versions, in some cases bricking boards or requiring ISP flashing. |
| Lofree | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
| Luminkey | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
| Meletrix | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
| mmd / Smartmmd / i-game.tech | Ambiguity on PRs -- marketing says wireless, PR author said wired-only, then included wireless code anyway. Seemingly intentionally deceptive. |
| MyKeyClub | Community-supported JRIS75, vendor was contacted by community members and refused to cooperate. |
| owlab | Selling wired based on QMK without sources, just `via.json` provided. Ambiguous as to whether or not wireless firmware is based on QMK, given that their configuration tool looks very similar to VIA. |
| PMO Lab | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
| pressplayid | Selling wired and tri-mode boards based on QMK without sources, just `via.json` provided |
| qwertykeys | Selling wired and tri-mode boards based on QMK without sources, just `via.json` provided. |
| Redragon | Selling tri-mode boards based on QMK without sources, attempted upstreaming crippled firmware without wireless. |

Some files were not shown because too many files have changed in this diff Show more