Compare commits

..

694 Commits

Author SHA1 Message Date
Alex Havermale
fc55fcff3d Add haverworks/theseus75 keyboard (#25457)
Co-authored-by: Moritz <moritz.plattner@gmx.net>
2025-09-10 08:28:24 -04:00
diegorodriguezv
b4bdf3f1d5 Update data_driven_config.md (#25612) 2025-09-10 01:52:25 -07:00
Joel Challis
c4ccbf06e1 Fix silakka54 layout (#25643) 2025-09-10 09:11:46 +01:00
diegorodriguezv
24c05ff1c7 Correct link in porting_your_keyboard_to_qmk.md (#25635)
Fixed anchor
2025-09-09 19:44:47 -06:00
diegorodriguezv
65e1afe0af Correct link in faq_general.md (#25640)
Updated the link to the QMK trademark page.
2025-09-09 19:43:28 -06:00
François Magimel
09ab67c044 docs: fix misspellings (#25555)
* docs: fix misspellings

* docs: do line breaks with HTML instead of spaces

To remove trailing spaces and to avoid breaking things, line breaks can
be done with the HTML br tag.
2025-09-09 14:51:13 -07:00
dependabot[bot]
7be4540b46 Bump actions/checkout from 4 to 5 (#25554)
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [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/v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  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-09-09 17:40:53 +01:00
Nick Brassel
f6f627d07f Print build failures with qmk mass-compile and qmk userspace-compile if requested (-p/--print-failures) (#25518) 2025-09-09 17:35:01 +01:00
Sam Mohr
4fc14c2712 [Keyboard] Add the Clog (#23009) 2025-09-09 17:32:59 +01:00
ec515f2164 Add handwired/planck keyboard (#25506) 2025-09-09 17:28:12 +01:00
1e067bd4dd Add 5x6_split/rev1 keyboard (#25507) 2025-09-09 17:27:15 +01:00
Danny
fa37d958b4 Add Nyquist LM (#25583) 2025-09-08 07:57:07 +01:00
takashicompany
20e7906c80 Add new keyboard "Palmbrain" (#25377)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: jack <0x6a73@protonmail.com>
2025-09-07 10:25:17 -07:00
dependabot[bot]
e42877d007 Bump actions/labeler from 5 to 6 (#25604)
Bumps [actions/labeler](https://github.com/actions/labeler) from 5 to 6.
- [Release notes](https://github.com/actions/labeler/releases)
- [Commits](https://github.com/actions/labeler/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/labeler
  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-09-07 13:08:17 +01:00
Nick Brassel
0188038bc0 Merge branch 'develop' 2025-09-06 17:55:23 +10:00
Nick Brassel
2a4b9f79fd Merge point for 2025q3 breaking changes. 2025-09-06 17:54:54 +10:00
Joel Challis
b43ec9d65a 2025q3 develop changelog (#25597) 2025-09-06 07:07:20 +10:00
Lung Sin
df8bb7ce24 Add cachyos as pattern when installing dependencies (#25580)
chore: add cachyos as pattern when installing dependencies
2025-08-25 07:47:28 +10:00
Jack Sangdahl
7110708d0f Refactor tweetydabird/lotus58 (#25547)
- Update aliases accordingly
- Remove unnecessary elite_c revision; an alternate bootloader or
  development board can easily be set by a user. The PCB is not
  dependant on an Elite-C pin compatible microcontroller
- Remove unnecessary nanoboot revision; any user going to the trouble of
  using this bootloader will have no trouble manually setting the size
  of their bootloader
- Move the promicro revision to be the "standard" for this keyboard
- Remove unnecessary rp2040_ce revision; the converter feature should be
  used here instead
2025-08-17 17:50:59 +01:00
Joel Challis
b834819a35 Swap spleeb to default GENERIC_PROMICRO_RP2040 board files (#25564) 2025-08-17 17:47:46 +01:00
Joel Challis
cc696a2ae8 Refactor battery driver (#25550) 2025-08-17 01:14:48 +01:00
dsanderling
f29d8117bf Fix boardsource/unicorne RGB Matrix Coordinates (#25556)
please see https://github.com/qmk/qmk_firmware/issues/23224
2025-08-16 09:04:37 -06:00
Joel Challis
d2ec940da5 Remove overriding of DF() within keyboards (#25541) 2025-08-15 19:32:54 +01:00
Joel Challis
da2c6a41d8 Remove converter assumption that everything is a promicro (#20330) 2025-08-15 09:13:13 +01:00
Jack Sangdahl
a3ecbc53f6 Refactor bastardkb/charybdis/4x6 (#25494)
* Refactor bastardkb/charybdis/4x6

- Update keyboard aliases accordingly
- Migrate various configuration to data-driven
- Use short SPDX license headers
- Remove configuration that trends towards user-specific (CRC Table)
- Migrate common configuration upwards
- Migrate keymap to JSON
- Remove likely unneeded v1 revision per #23811
- Remove revisions splinky_2, splinky_3, and stemcell where a converter
  should be used
- Rename v2/elitec -> elitec. Specifically named elitec, as this board
  requires pin compatibility with an Elite-C (bottom 5 pins)

* Add aliases

* Replace unecessarily removed split hand pin configuration

* Revert "Replace unecessarily removed split hand pin configuration"

This reverts commit 0b98d1bc140a4b18c16d2b524cc8731f016372b1.

After second thought, it is not necessary to configure this by default,
as any user who wishes to set handedness by pin and is using an Elite-C
pin compatible development board will need to manually set the pin
anyway, which likely means referencing the readme.md file, which also
contains the necessary SPLIT_HAND_PIN_LOW_IS_LEFT configuration.
2025-08-10 11:44:49 +02:00
Jack Sangdahl
2695344241 Refactor bastardkb/charybdis/3x6 (#25493)
* Refactor bastardkb/charybdis/3x6

- Update keyboard aliases accordingly
- Migrate various configuration to data-driven
- Use short SPDX license headers
- Remove configuration that trends towards user-specific (CRC Table)
- Migrate common configuration upwards
- Migrate keymap to JSON
- Remove likely unneeded v1 revision per #23810
- Remove revisions splinky_2, splinky_3, and stemcell where a converter
  should be used
- Rename v2/elitec -> elitec. Specifically named elitec, as this board
  requires pin compatibility with an Elite-C (bottom 5 pins)

* Correct keyboard name in keymap

* Replace unecessarily removed split hand pin configuration

* Revert "Replace unecessarily removed split hand pin configuration"

This reverts commit 737cb635fa8de29bdf0f4ae54cf51b7a4715c7f3.

After second thought, it is not necessary to configure this by default,
as any user who wishes to set handedness by pin and is using an Elite-C
pin compatible development board will need to manually set the pin
anyway, which likely means referencing the readme.md file, which also
contains the necessary SPLIT_HAND_PIN_LOW_IS_LEFT configuration.
2025-08-10 11:39:12 +02:00
Jack Sangdahl
00ca362826 Migrate helix common configuration (#25433)
* Initial tidying up of top level helix/ directory

Align readme.md with template & provide more detailed PCB information
Remove unused rules.mk
Add common config.h file
Update glcdfont.c with formatting and license header

* Further migrations after PRs merged

Move shared configuration to top level info.json and config.h
More descriptive hardware compatibility

* Add changelog

* Align configuration between PCBs

- Migrate beta & pico to use RGB Matrix
- Move previously RGB Matrix-dependent OLED code in rev3/rev3.c to top level
- Remove reundant OLED code in beta/beta.c
- Remove RGBLight references

* Update changelog with RGB Matrix configuration
2025-08-10 00:27:13 +02:00
Joel Challis
9dcf2a11b2 Refactor inland/kb83 (#25542)
Update keyboard to match current standards:
* Move LED config to DD
* Revert back to core behaviour for keycodes
* Remove vendor code
* Configure dip switch map
* Align readme
2025-08-09 23:18:21 +01:00
Jack Sangdahl
12dc6d1ac8 Fix serial speed DD configuration & migrate keyboards (#25546)
* Fix serial speed DD configuration

- Fixes incorrect SOFT_SERIAL_SPEED mapping
- Renames key split.soft_serial_speed -> split.serial.speed
- Migrates keyoards that configure this, and remove configuration from keyboards that do not differ from the default behaviour
- Add deprecation notice and migration support
2025-08-09 23:14:40 +01:00
QMK Bot
6c2e58eb4d Merge remote-tracking branch 'origin/master' into develop 2025-08-06 20:15:41 +00:00
dependabot[bot]
1a58fce043 Bump actions/download-artifact from 4 to 5 (#25545)
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 4 to 5.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: '5'
  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-08-06 21:15:03 +01:00
QMK Bot
96ee4c21a3 Merge remote-tracking branch 'origin/master' into develop 2025-08-03 03:01:47 +00:00
Joel Challis
ae07dee941 Improve 'new-keymap' error handling when default keymap is missing (#25536) 2025-08-03 04:01:13 +01:00
QMK Bot
efce9bc9b5 Merge remote-tracking branch 'origin/master' into develop 2025-08-01 13:27:05 +00:00
Nick Brassel
d575bf7ddc Add proprietary libraries policy page. (#25532) 2025-08-01 23:26:30 +10:00
Joel Challis
7a939ec218 Remove some encoder resolution that duplicate defaults (#25517) 2025-07-28 20:40:11 +01:00
フィルターペーパー
542440eac5 Add MATRIX_ROWS_PER_HAND definition (#25513) 2025-07-25 10:04:12 +10:00
QMK Bot
717b6b8f13 Merge remote-tracking branch 'origin/master' into develop 2025-07-23 12:09:23 +00:00
Joel Challis
36c3f4deba [docs] Align more keyboard placeholders (#25510) 2025-07-23 13:08:48 +01:00
QMK Bot
a954b568ea Merge remote-tracking branch 'origin/master' into develop 2025-07-23 03:34:12 +00:00
Joel Challis
74d64c7f43 [docs] Align keyboard and keymap placeholders (#25509) 2025-07-23 04:33:37 +01:00
Jack Sangdahl
65cce9105d Refactor helix/rev3_{4,5}rows (#25430)
* Refactor helix/rev3_{4,5}rows

rev3_4rows and rev3_5rows are identical, except for the extra row users
can snap off of their PCBs.

- Add alias for rev3_4rows
- Migrates legacy defines and configuration to keyboard.json
- Tidy's keymap and migrates to JSON
- Removes RGB Light configuration, enables RGB Matrix
- Removes DIP switch configuration, as they do not appear to be present
  on PCBs
- Adds an alternate 4 row layout for snappable PCB
- Tidy's up OLED code
- Enables standard features (bootmagic, extrakey, etc.)

* Alias for rev3_5rows -> rev3

* Add product URL

* Replace mistakenly removed DIP switch configuration

* Remove rebase artifact
2025-07-19 23:23:28 -06:00
Bailey
43853b337b [Keyboard] Rename ll3macorn -> ll3ma (#25498)
* rebrand for Ll3ma

* rebrand for Ll3ma

* Update keyboard_aliases.hjson

* Update keyboard_aliases.hjson

* Update keyboard_aliases.hjson

* Update keyboard_aliases.hjson

* Update keyboard_aliases.hjson

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

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2025-07-17 11:49:52 -06:00
QMK Bot
8474aee2fe Merge remote-tracking branch 'origin/master' into develop 2025-07-17 17:09:37 +00:00
Brandon
7098252252 Add null65ansi keyboard (#25464) 2025-07-17 18:09:17 +01:00
Brandon
16ffaa6482 Add null65iso keyboard (#25465) 2025-07-17 18:09:01 +01:00
Joel Challis
865c29f4de Ensure keyboard aliases do not point to themselves (#25500) 2025-07-17 13:36:04 +01:00
Joel Challis
507c948ed8 Allow qmk flash <filename> to flash AT32 boards (#25497) 2025-07-16 14:56:29 +01:00
Joel Challis
f0b04b2a3a Only userspace should be searched for keyboard aliases when locating keymaps (#25477) 2025-07-14 14:47:21 +01:00
Joel Challis
20555f9a33 Relocate AUDIO_INIT_DELAY implementation (#25491) 2025-07-14 13:53:57 +01:00
Jack Sangdahl
56ad3a5f43 Refactor bastardkb/charybdis/3x5 (#25488)
* Refactor bastardkb/charybdis/3x5

- Migrate various configuration to data-driven
- Use short SPDX license headers
- Remove configuration that trends towards user-specific (CRC Table)
- Migrate common configuration upwards
- Migrate keymap to JSON
- Remove likely unneeded v1 revision per #23638
- Remove revisions splinky_2, splinky_3, and stemcell where a converter
  should be used
- Rename v2/elitec -> elitec. Specifically named elitec, as this board
  requires pin compatibility with an Elite-C (bottom 5 pins)

* Aliases
2025-07-13 21:26:04 -06:00
Jack Sangdahl
5ef94415aa Configure SPI for QMK_PM2040 board (#25481) 2025-07-13 17:00:10 +01:00
Jack Sangdahl
d67e94fb1b Configure SPI for STEMCELL board (#25486) 2025-07-13 16:59:59 +01:00
Jack Sangdahl
f797d4f49d Configure SPI for QMK_BLOK board (#25487) 2025-07-13 16:59:44 +01:00
フィルターペーパー
ad4233d078 Clamp reactive offset value (#25489)
* Avoids underflow of the unsigned 8-bit
2025-07-13 16:38:32 +01:00
QMK Bot
2c34b480fc Merge remote-tracking branch 'origin/master' into develop 2025-07-13 01:39:07 +00:00
Jack Sangdahl
86badb394e Enable correct SPI peripheral dilemma/3x5_2/assembled (#25479)
Initial
2025-07-12 19:38:32 -06:00
QMK Bot
e295937e54 Merge remote-tracking branch 'origin/master' into develop 2025-07-12 15:57:06 +00:00
Joel Challis
c7a24a441f Add zip to .gitignore (#25483) 2025-07-12 16:56:32 +01:00
QMK Bot
a08ee4a737 Merge remote-tracking branch 'origin/master' into develop 2025-07-12 03:29:56 +00:00
Jon Henry Fernandez
9e757bc2ec [Keyboard] Add togkey/pad_pocket (#25470)
* Initial Source for Pad Pocket

* Added Tap Dance and Combo Configurations

* Updated LED Count

* Updated read me

* Updated Readme

* -Removed config.h file
- Added tap dance and combos to keymap level
- Removed tap dance and combos from keyboard.json
- Fixed conflict with submodules

* Fixed Formatting
2025-07-11 21:29:16 -06:00
obosob
5ef7919022 Give mouse report to pointing_device_task_user first in ploopyco devices (#25475) 2025-07-11 15:55:21 -07:00
Ryan
6b38dc17cd Remove deprecated RGB_ and Mouse keycodes (#25444)
* Remove deprecated `RGB_` and Mouse keycodes

* Update old mouse keycodes, 0-9/A-M

* Update old mouse keycodes, N-Z & layouts

* Missed some stuff
2025-07-11 11:05:41 -06:00
Joel Challis
71b88b333d Fix pytest/has_community default keymap location (#25471) 2025-07-11 18:03:17 +01:00
QMK Bot
108a2fceca Merge remote-tracking branch 'origin/master' into develop 2025-07-11 16:52:32 +00:00
TweyHugs
c3773d9c35 [Keyboard] Add cloud_macro (#24904)
* Added cloud_macro to keyboards folder

* Update readme.md

* Update readme.md

* Update readme.md

* Add files via upload

* Update keyboards/cloud_macro/keyboard.json

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

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

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

* Update keyboards/cloud_macro/keyboard.json

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

* Update keyboards/cloud_macro/keyboard.json

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

* Update readme.md

* Update keyboards/cloud_macro/readme.md

Co-authored-by: Thanh Son Tran <62438883+trnthsn@users.noreply.github.com>

* Update keyboards/cloud_macro/keyboard.json

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

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

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

* Update keyboards/cloud_macro/readme.md

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

* Update readme.md

* Update readme.md

reverting description to KB2040

---------

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Thanh Son Tran <62438883+trnthsn@users.noreply.github.com>
Co-authored-by: jack <jack@pngu.org>
2025-07-11 10:51:45 -06:00
jack
e1b42d5252 Refactor bastardkb/dilemma/3x5_2 (#25462)
* Refactor bastardkb/dilemma/3x5_2

- Rename splinky -> promicro as the DIY PCB supports a Pro Micro
  compatible development board
    - Update keyboard aliases accordingly
- Migrated shared configuration to top level 3x5_2 directory
- Migrate keymap to JSON
- Migrate miscellaneous configuration to JSON
- Remove configuration that trends towards user-specific (CRC Table)
- Use short SPDX license headers
- Tidy up readme and make note of differences between PCBs

In short, the only difference between these two revisions (assembled vs.
promicro) is SPI vs. I2C (respectively) is used for the Cirque Trackpad.

* Migrate promicro configuration to AVR

The code in dilemma.c that reinitialises the ADC capable pins on RP2040
as digital inputs is not needed. Per section RP2040-E6 (p.630) of RP2040
datasheet, it appears digital inputs are *not* disabled, and this should
be handled internally anyway in matrix initialisation
2025-07-10 12:42:36 +01:00
QMK Bot
558fee16e4 Merge remote-tracking branch 'origin/master' into develop 2025-07-10 11:02:47 +00:00
Andrew Cooney
87e5df1b9e Changes to the Stenography documentation page. (#25426) 2025-07-10 12:02:08 +01:00
Joel Challis
4b295009ae Migrate usb.force_nkro to host.default.nkro (#25468) 2025-07-10 10:41:58 +01:00
Joel Challis
3d61139567 Miscellaneous fixes for lint warnings (#25469) 2025-07-09 21:54:43 +02:00
jack
15e7c8f37a Refactor bastardkb/skeletyl (#25456)
* Refactor bastardkb/skeletyl

- Update keyboard aliases accordingly
- Migrate keymap to JSON
- skeletyl/blackpill
  - Migrate common configuration to keyboard level
  - Remove unnecessary or user-specific configuration
  - Migrate some configuration to data-driven
  - Use short SPDX license headers
  - Remove unnecessary rules.mk file
  - Formatting pass on keyboard.json
- skeletyl/v1
  - Remove likely unneeded version, per qmk#23812
- skeletyl/v2
  - Remove splinky_2 revision, per qmk#23812
  - Remove splinky_3, stemcell revisions; converter feature should
    be used here
- Rename skeletyl/v2/elitec -> skeletyl/promicro, as a converter can
  be used for any pin-compatible microcontrollers

* Update keyboards/bastardkb/skeletyl/keymaps/default/keymap.json

Co-authored-by: Ryan <fauxpark@gmail.com>

---------

Co-authored-by: Ryan <fauxpark@gmail.com>
2025-07-08 14:23:05 -06:00
jack
8d29bd07c2 Refactor bastardkb/scylla (#25459)
* Refactor bastardkb/scylla

- Update keyboard aliases accordingly
- Migrate keymap to JSON and better represent physical layout
- scylla/blackpill
  - Migrate common configuration to keyboard level
  - Remove unnecessary or user-specific configuration
  - Migrate some configuration to data-driven
  - Use short SPDX license headers
  - Remove unnecessary rules.mk file
  - Formatting pass on keyboard.json
- scylla/v1
  - Remove likely unneeded version, per qmk#23814
- scylla/v2
  - Remove splinky_2 revision, per qmk#23814
  - Remove splinky_3, stemcell revisions; converter feature should
    be used here
- Rename scylla/v2/elitec -> scylla/promicro, as a converter can
  be used for any pin-compatible microcontrollers

* Small keymap fix
2025-07-08 14:08:49 -06:00
QMK Bot
75b899d87d Merge remote-tracking branch 'origin/master' into develop 2025-07-08 19:18:09 +00:00
jack
c3b3f09702 [Docs] Tidy up keyboard guidelines (#25461)
* Initial

* Grammar
2025-07-08 13:17:33 -06:00
QMK Bot
56650d7a2b Merge remote-tracking branch 'origin/master' into develop 2025-07-08 06:04:25 +00:00
JhaKob
8a47896263 [Keyboard] Add Monsgeek M2 (#25387)
* Adding Monsgeek M2 keyboard

* Update readme.md

* Switch tab -> space

* Addressing PR comments.
- Removing values that are set to defaults
- Updating readme verbiage
- Using host nkro instead of usb force_nkro
2025-07-08 00:03:12 -06:00
QMK Bot
0f182ef674 Merge remote-tracking branch 'origin/master' into develop 2025-07-08 06:00:24 +00:00
ASHIJA
f1b2449ce5 [Keyboard] Add Slimorta (#25348)
* Add Slimorta

* Update readme.md

* Apply suggestions from code review for #25348

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

---------

Co-authored-by: jack <jack@pngu.org>
2025-07-08 00:00:20 -06:00
Cipulot
a26dbbfe96 [Keyboard] Add MX65X (#25214)
* Addition of MX65X

* Folder separation

* Fix

* Update readme

* Update keymap.c

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

* Update keymap.c

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

* Update keymap.c

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

* Update keymap.c

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

* Update keymap.c

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

* Update info.json

---------

Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-07-07 23:59:45 -06:00
adophoxia
bf28a303c6 Keychron C3 Pro c3_pro.c corrections (#25049)
* Update `c3_pro.c`

* Redo layer switching logic; will default back to 0 if EEPROM reset

* Update keyboards/keychron/c3_pro/c3_pro.c

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

* Re-re-did layer switching logic

* Update GPIO control functions

* Apply suggestions from code review

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

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2025-07-07 23:52:55 -06:00
QMK Bot
e814bb9453 Merge remote-tracking branch 'origin/master' into develop 2025-07-08 05:50:19 +00:00
Ning
2916c3f098 [Keyboard] Update ning_tinyboard_tb16rgb diode direction (#25379)
* Update ning_tinyboard_tb16rgb diode_direction

* enable LTO
add rules.mk and enable RGB_MATRIX_CUSTOM_USER
add
add rgb_matrix_user.inc

* remove files
2025-07-07 23:49:44 -06:00
QMK Bot
8644965c81 Merge remote-tracking branch 'origin/master' into develop 2025-07-07 19:24:27 +00:00
srk24
0524a6d848 [keyboard]Graystudio BD60 Support (#25337) 2025-07-07 20:23:46 +01:00
ClownFish
e19991ec46 [Keyboard] Add CSTC40 rev3 (#25285)
* refactor cstc40, add rev3 fxtwink variant

* cleanup readmes

* readme nitpick

* add cstc40 aliases

* format-json

* add communty_layouts per code review

* touch copied legacy files for newline

* fix LED flags

* update readme files per code review
2025-07-07 13:14:12 -06:00
QMK Bot
e4e5bca6bc Merge remote-tracking branch 'origin/master' into develop 2025-07-07 19:12:45 +00:00
Ryan
8ff7b1de11 [docs] WS2812: rewrite Open Drain section (#25454) 2025-07-07 13:12:11 -06:00
Joel Challis
7827f9fbe3 Compilation fixes for -fno-common (#25436) 2025-07-07 16:15:50 +01:00
Joel Challis
d9f2d8d241 Convert novelkeys/nk65 to use RGB Matrix (#25450) 2025-07-07 16:15:37 +01:00
jack
058919923a Fixup bastardkb/tbkmini keymap's build target (#25458) 2025-07-07 15:50:07 +01:00
Joel Challis
d151b1bef5 Convert moon to lite custom matrix (#25452) 2025-07-07 15:10:51 +01:00
Ryan
baf0060761 Deprecate some nonstandard mod & mod-tap keycode aliases (#25437) 2025-07-06 20:30:47 +10:00
jack
036745e853 Refactor helix/rev2 (#25429)
* Refactor helix/rev2

- Rename rev2 -> beta & update keyboard aliases accordingly
- Removes redundant back, base, sc, under, & qmk_conf revisions
- Removes unnecessary keymaps
- Migrates legacy defines and configuration to keyboard.json
- Tidy's keymap and migrates to JSON
- Fixes RGB configuration to illuminate 32 LEDs per half
- Adds an alternate 4 row layout for snappable PCB
- Tidy's up OLED code
- Enables standard features (bootmagic, extrakey, etc.)
2025-07-06 09:52:24 +01:00
QMK Bot
b99e2f7230 Merge remote-tracking branch 'origin/master' into develop 2025-07-06 07:39:46 +00:00
snappykey
9c965bb62e Add Snappy Pad v.1 (#25419) 2025-07-06 08:39:10 +01:00
QMK Bot
e68389a11e Merge remote-tracking branch 'origin/master' into develop 2025-07-06 06:58:28 +00:00
Ryan
ba63bac661 Add short aliases for OSM() (#25443) 2025-07-06 16:57:51 +10:00
jack
0842f54a27 Refactor bastardkb/tbkmini (#25438) 2025-07-05 23:50:37 -07:00
フィルターペーパー
584ad807cc Refactor Starlight Smooth matrix effect (#25442) 2025-07-05 23:44:44 -07:00
jack
e92f1fb220 Refactor helix/pico (#25428)
Refactor helix/pico

- Updates keyboard aliases accordingly
- Removes redundant back, base, sc, under, & qmk_conf revisions
- Migrates legacy defines and configuration to keyboard.json
- Tidy's keymap and migrates to JSON
- Fixes RGB configuration to illuminate 25 LEDs per half
- Enables standard features (bootmagic, extrakey, etc.)
2025-07-06 07:42:42 +01:00
QMK Bot
67c97da654 Merge remote-tracking branch 'origin/master' into develop 2025-07-06 06:21:29 +00:00
Copilot
90b5c17034 Fix SPI bus lock issue in spi_start_extended when using mutual exclusion (#25447) 2025-07-06 07:20:48 +01:00
Thanh Son Tran
0b33318a24 [Update] E8ghtyNeo caps indicator (#25009) 2025-07-06 07:00:39 +01:00
QMK Bot
a9a2b699cd Merge remote-tracking branch 'origin/master' into develop 2025-07-06 05:59:55 +00:00
SneakboxKB
da7811f82a Add lilBAE support (#25259) 2025-07-06 06:59:20 +01:00
QMK Bot
49a4ec538d Merge remote-tracking branch 'origin/master' into develop 2025-07-04 19:10:00 +00:00
Joel Challis
9e103614f8 Fix invalid layer API usage in RGB Matrix docs (#25449) 2025-07-04 20:09:27 +01:00
Joel Challis
711b109246 Mitigate VIA keylogger security issues (#25414)
Co-authored-by: Nick Brassel <nick@tzarc.org>
2025-06-29 02:29:33 +01:00
Joel Challis
6347d18a2d Configure boards to use development_board - ABC (#25417) 2025-06-28 22:34:59 +01:00
Joel Challis
d7b09ad560 Configure boards to use development_board - K (#25421) 2025-06-28 22:34:50 +01:00
QMK Bot
52e2af7753 Merge remote-tracking branch 'origin/master' into develop 2025-06-28 16:30:30 +00:00
Jon Henry Fernandez
177e461d90 [Keyboard] Add togkey pad & pad_plus (#25217)
* Initial Commit for Adding TogKey Pad and TogKey Pad Plus to QMK

* Added TogKey Pad default Keymap

* Changed Pins for Encoder

* added images to read me

* Updated Read Me Pictures Links

* Applied Suggested Changes and Formatting to keyboard.json

* Applied suggested keycodes to keymap.c for togkey pad

* Updated Hardware Availability Links in Readme

* Set development board instead of seperate bootloader and processor.

* Added pad_plus.c for oled. Added config.h for pad_plus.
Applied Suggested Changes.

* - Moved oled arrays outside of oled_task function.
- Removed white spaces from pad_plus keymaps.
- Made suggested changes to oled_task function.

* Updated with Changes
- Updated pad json. Removed extra features, remvoed rgb test from rgb animations.
- Updated pad_plus functions
- Updated Pad Plus Config file

* Readded display defintion.

* Corrected OLED resolution definition.

* Applied Suggested Changes
- Updated Copyright Information
- Updated Layout Names
- Updated TogKey Pad Layout

* Applied Suggested Changes
- Removed move layer function.
- Repolaced with "TO" keycodes
- Updated OLED images

* Fixed Layout name in keyboard.json for togkey pad

* - Updated Readme for both pad and pad plus.
- Updated Oled pictures for pad plus.

* - Added bootmagic and extrakey features to togkey pad keyboard.json.
2025-06-28 10:29:57 -06:00
QMK Bot
fef7932e55 Merge remote-tracking branch 'origin/master' into develop 2025-06-28 03:21:48 +00:00
Pascal Getreuer
b42191a2dd [Docs] Fix typo in Chordal Hold example JSON, comma to colon. (#25424) 2025-06-28 13:21:12 +10:00
Joel Challis
48a421bb10 Fix keebio/quefrency/rev1:default60 (#25423) 2025-06-28 03:57:32 +01:00
QMK Bot
f09f3643ad Merge remote-tracking branch 'origin/master' into develop 2025-06-28 02:44:58 +00:00
Ryan
36636205dd Clean up mod & mod-tap shortcuts (#25399) 2025-06-28 12:44:24 +10:00
Grigory Avdyushin
5b0039aae6 Update franky36 VID/PID (#25160)
* Update franky36 pid and vid

* Update keyboard.json
2025-06-27 14:31:09 -06:00
QMK Bot
18f5a04eaa Merge remote-tracking branch 'origin/master' into develop 2025-06-27 20:23:44 +00:00
Peter Cock
89e39b9858 [Docs] Link to awesome-qmk userspaces repository (#25357)
* Fix link - users folder now empty on default branch

* Point at drashna/qmk_userspace repo

* Link to awesome-qmk instead
2025-06-27 14:23:05 -06:00
QMK Bot
3db5ffcfb7 Merge remote-tracking branch 'origin/master' into develop 2025-06-27 20:02:24 +00:00
Thanh Son Tran
4ae2b4f371 [Keyboard] Add support S6xty Tsangan (#24898)
* 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 support S6xty Tsangan

* Update pinout config

* Update render

* Update default animation

* Update layout

* Update keymap keycode

* Update hardware supported

* Update keyboard.json

* Update layout s6xty tsangan

* Update led indicator for s6xtyfs

* Apply suggestions from code review

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

---------

Co-authored-by: Trần Thanh Sơn <son.tt1@teko.vn>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
2025-06-27 14:00:50 -06:00
QMK Bot
0dee127b29 Merge remote-tracking branch 'origin/master' into develop 2025-06-27 19:13:34 +00:00
Andrew Litt
6e55870a82 inland/kb83: Remove unnecessary EEPROM write (#25401)
There's no reason to save the base layer to EEPROM when the base layer
is set based on DIP switch.
2025-06-27 13:11:43 -06:00
Less/Rikki
21ca1eb7ae refactor(mercutio): layouts & reformatting (#25408) 2025-06-27 13:04:52 -06:00
Joel Challis
a1a5869ef8 Add MATRIX_MASKED DD config (#25383) 2025-06-27 08:17:45 +01:00
Joel Challis
bc5c5e3251 Align sleep_led logic (#25395) 2025-06-27 08:17:28 +01:00
QMK Bot
f39e08e2ba Merge remote-tracking branch 'origin/master' into develop 2025-06-27 05:49:59 +00:00
Joel Challis
e15d9ca4b3 Update link to AW20216S datasheet (#25416) 2025-06-27 06:49:26 +01:00
QMK Bot
eeac23464b Merge remote-tracking branch 'origin/master' into develop 2025-06-26 07:20:17 +00:00
timovp
5354ec5791 fix order of code in tapdance example3 (#25410) 2025-06-26 08:19:42 +01:00
QMK Bot
35785a6c49 Merge remote-tracking branch 'origin/master' into develop 2025-06-26 06:38:50 +00:00
Dave Alvarado
235d18f360 Update readme.md to clarify Lily Pad V2 support (#25405) 2025-06-25 23:38:15 -07:00
QMK Bot
ea5ef746e2 Merge remote-tracking branch 'origin/master' into develop 2025-06-23 22:02:32 +00:00
Andrew Litt
de5fd5d4e2 Orient side LEDs on GMMK2 65% ANSI to match the rest of the matrix (#25402)
Orient side LEDs on GMMK2 65% to match the rest of the matrix

On GMMK2 P65 ANSI, the side LEDs were mapped to the wrong sides
of the keyboard resulting in effects not being consistent with
the key surface. This was most jarring in effects like pinwheel
where the pattern involves the side LEDs and there is a distinctly
different flow on the left and right halves of the board.

This PR swaps the side LEDs in the map so that they are correctly
oriented. Applied to both ANSI and ISO variants.
2025-06-23 16:01:56 -06:00
QMK Bot
8c8f4b3c06 Merge remote-tracking branch 'origin/master' into develop 2025-06-23 09:19:23 +00:00
Andrew Litt
f5b02fbc11 Fix inverted encoder on Inland KB83 (#25400) 2025-06-23 10:18:48 +01:00
QMK Bot
55e1acec07 Merge remote-tracking branch 'origin/master' into develop 2025-06-22 07:12:29 +00:00
Ryan
611460c9db ymdk/id75: fix keymap (#25396) 2025-06-22 17:11:53 +10:00
QMK Bot
584e390703 Merge remote-tracking branch 'origin/master' into develop 2025-06-22 02:34:26 +00:00
Ryan
1ac255fd1c [docs] Change GUI key references to "Meta" -> "Super" (#25394) 2025-06-22 12:33:53 +10:00
QMK Bot
2c152c3425 Merge remote-tracking branch 'origin/master' into develop 2025-06-21 11:32:22 +00:00
YodaDistro
664c0bc4c3 Add YodaDistro Macropad (#25174)
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
2025-06-21 12:31:49 +01:00
QMK Bot
8a06238054 Merge remote-tracking branch 'origin/master' into develop 2025-06-19 21:25:05 +00:00
ClownFish
6626084cb8 fix incorrect damapad layout macros (#25364) 2025-06-19 22:24:37 +01:00
Marius
bb27c69675 Applied usb detection fixes from Squalius-cephalus (#25380)
Co-authored-by: Dr. Marius Feilhauer <software@feilhauer.de>
2025-06-19 22:23:53 +01:00
QMK Bot
25d7ac9ecc Merge remote-tracking branch 'origin/master' into develop 2025-06-19 21:16:27 +00:00
Christoffer Larsen
03a53e29af Fix Enter key matrix coordinates for smk65/revf ISO layout (#25373) 2025-06-19 22:15:54 +01:00
QMK Bot
681d6a29e6 Merge remote-tracking branch 'origin/master' into develop 2025-06-18 09:45:23 +00:00
Xelus22
096696d86d [Bug] Fix usb_endpoint_interface_lut multiple def compile err (#25378) 2025-06-18 10:44:49 +01:00
Joel Challis
d044a6bcc2 Configure boards to use development_board - DE (#25369) 2025-06-17 04:23:33 +01:00
Joel Challis
091eac1fce Configure boards to use development_board - FGHIJ (#25370) 2025-06-17 04:23:22 +01:00
QMK Bot
02bed7e5a5 Merge remote-tracking branch 'origin/master' into develop 2025-06-15 01:56:45 +00:00
Nick Brassel
7f9ceef3dd More compiledb fixes. (#25355) 2025-06-15 11:56:10 +10:00
Dasky
7919848324 Add core handling for pointing device failures. (#25315) 2025-06-14 13:55:35 +01:00
QMK Bot
a4436b32df Merge remote-tracking branch 'origin/master' into develop 2025-06-14 03:12:31 +00:00
luroc
7ecdb57414 [Docs] Fix example code on key_overrides.md (#25367)
The description of the code snippet says right alt, but the snippet itself contained the right control keycode
2025-06-13 21:11:58 -06:00
QMK Bot
0f9c1c57b4 Merge remote-tracking branch 'origin/master' into develop 2025-06-12 23:40:58 +00:00
Álvaro A. Volpato
dcdd037276 Add support for Protagonist PCBs (#22918) 2025-06-13 00:40:25 +01:00
QMK Bot
e725cdbc4b Merge remote-tracking branch 'origin/master' into develop 2025-06-12 12:43:50 +00:00
ClownFish
8ae01715d6 fix winry25tc lightsout keymap (#25353) 2025-06-12 13:43:15 +01:00
QMK Bot
9ef5dcd113 Merge remote-tracking branch 'origin/master' into develop 2025-06-12 12:31:42 +00:00
oxnh
f4aa8ae845 Add keyboard Lily58 Koca (#24847)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2025-06-12 13:31:05 +01:00
QMK Bot
ef6e9a5312 Merge remote-tracking branch 'origin/master' into develop 2025-06-11 04:30:11 +00:00
Nick Brassel
0516cf5ed8 Specify language standard when generating compilation database. (#25354) 2025-06-11 14:29:37 +10:00
Joel Challis
5bdeb7dad1 Migrate remaining DEFAULT_FOLDER to keyboard aliases (#25291) 2025-06-10 22:20:34 +01:00
ClownFish
8347a6688f update winry25 VID and PID (#25351) 2025-06-10 21:21:00 +01:00
QMK Bot
3ce196ff52 Merge remote-tracking branch 'origin/master' into develop 2025-06-09 18:36:25 +00:00
Pablo Martínez
802a199bbd [Bugfix] User eeconfig utility macros (#25350) 2025-06-09 19:35:48 +01:00
Joel Challis
0326355edc Remove DEFAULT_FOLDER handling (#23281) 2025-06-09 05:08:56 +01:00
QMK Bot
94f1aade5c Merge remote-tracking branch 'origin/master' into develop 2025-06-09 01:44:08 +00:00
VeyPatch
1a54ecf246 [Keyboard] Add splitkb.com's Halcyon Corne rev2 (#25143)
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2025-06-09 02:43:31 +01:00
QMK Bot
fe54121cfa Merge remote-tracking branch 'origin/master' into develop 2025-06-08 17:25:36 +00:00
VeyPatch
319844407c [Keyboard] Add splitkb.com's Halcyon Ferris rev1 (#25145)
Co-authored-by: Thomas Baart <support@splitkb.com>
2025-06-08 18:24:54 +01:00
QMK Bot
77b2742863 Merge remote-tracking branch 'origin/master' into develop 2025-06-08 17:05:32 +00:00
VeyPatch
e57226d9a2 [Keyboard] Add splitkb.com's Halcyon Lily58 rev2 (#25144) 2025-06-08 18:04:56 +01:00
Joel Challis
021c3cc125 Configure boards to use development_board - LM (#25341) 2025-06-07 22:17:38 +01:00
Joel Challis
0b3a54f9f2 maple_computing/launchpad - Remove broken default_rgb keymap (#25342) 2025-06-07 16:50:54 +01:00
Nick Brassel
7808f8f56b Add {rgb|led}_matrix_get_mode_name(). (#25344) 2025-06-07 22:56:58 +10:00
QMK Bot
e3c8c23d91 Merge remote-tracking branch 'origin/master' into develop 2025-06-07 04:09:31 +00:00
Nick Brassel
1646000c9b [tzarc/djinn] Include community modules in RGB naming. (#25343) 2025-06-07 14:08:56 +10:00
Joel Challis
b4cabc3cf7 Configure boards to use development_board - NO (#25338) 2025-06-07 01:31:42 +01:00
spacehangover
e8e3c7addb Added Encoder support for Soyuz (#25279) 2025-06-07 01:31:08 +01:00
QMK Bot
608ce78778 Merge remote-tracking branch 'origin/master' into develop 2025-06-05 23:03:27 +00:00
bytetinkerer
824ad46e5d add kinesis/kint32 (#25013)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-06-06 00:02:38 +01:00
QMK Bot
977433443a Merge remote-tracking branch 'origin/master' into develop 2025-06-05 15:30:32 +00:00
Nick Brassel
0d477bf570 More Yunzii notes regarding refusal to provide sources. (#25335) 2025-06-05 16:29:53 +01:00
QMK Bot
5bf8248dd3 Merge remote-tracking branch 'origin/master' into develop 2025-06-04 12:44:39 +00:00
obosob
2e3664d2c0 Add CrossDIY to license_violations.md (#25324)
Co-authored-by: jack <jack@pngu.org>
2025-06-04 22:42:57 +10:00
Joel Challis
fad44ae10c [Docs] Fix PS/2 Driver headers (#25332) 2025-06-04 22:41:37 +10:00
Joel Challis
7b36727ed1 Remove process_action_kb callback (#25331) 2025-06-04 22:37:40 +10:00
Joel Challis
f096e5a3f3 Relocate remaining process_record_quantum keycodes (#25328) 2025-06-03 23:44:46 +01:00
QMK Bot
53c6fa5de7 Merge remote-tracking branch 'origin/master' into develop 2025-06-03 12:04:35 +00:00
Dasky
8525ab03de Fix dynamic keymap static assert (#25327) 2025-06-03 13:03:59 +01:00
Joel Challis
97168180cf Configure boards to use development_board - R (#25316) 2025-06-02 19:24:29 +01:00
Joel Challis
57374489da Configure boards to use development_board - P (#25317) 2025-06-02 19:24:23 +01:00
Stephen Ostermiller
1d145c7511 Fix quantum.c keycode handling (#25322) 2025-06-02 19:24:02 +01:00
QMK Bot
820202cd53 Merge remote-tracking branch 'origin/master' into develop 2025-05-28 06:06:21 +00:00
Joel Challis
faf77f1651 Fix typo in Battery Driver docs (#25312)
* Fix typo in Battery Driver docs

* Update battery.md
2025-05-28 16:05:44 +10:00
QMK Bot
4c773971a7 Merge remote-tracking branch 'origin/master' into develop 2025-05-28 00:47:37 +00:00
Idkau
2b8aeed02b Fix Sofle OLED layer indication code (#25311)
Fixed oled raise/lower layer order and added adjust layer text to oled display
2025-05-27 18:47:00 -06:00
QMK Bot
9e8e9af485 Merge remote-tracking branch 'origin/master' into develop 2025-05-27 22:24:59 +00:00
Sergey Radionov
9e2d8999bf Fix reference to wrong layer when LM used with right modifiers (#25303) 2025-05-27 23:24:20 +01:00
QMK Bot
4f60946513 Merge remote-tracking branch 'origin/master' into develop 2025-05-27 17:08:00 +00:00
dependabot[bot]
c8a39b69a0 Bump vite from 5.4.18 to 5.4.19 in /builddefs/docsgen (#25306)
Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 5.4.18 to 5.4.19.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v5.4.19/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v5.4.19/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-version: 5.4.19
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-27 18:07:22 +01:00
QMK Bot
ac9318c78f Merge remote-tracking branch 'origin/master' into develop 2025-05-27 13:23:36 +00:00
Dasky
41b1bb4aef Fix dynamic keymap macro only sending first. (#25309) 2025-05-27 14:22:55 +01:00
Nick Brassel
76cf8dff93 Branch point for 2025-05-25 Breaking Change 2025-05-26 21:43:45 +10:00
Nick Brassel
75a037d2f0 Merge remote-tracking branch 'upstream/develop' 2025-05-26 21:41:49 +10:00
Joel Challis
3703699757 2025 Q2 changelog (#25297)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
2025-05-26 21:04:52 +10:00
Joel Challis
c97a798af7 Configure boards to use development_board - T (#25294) 2025-05-24 21:20:16 +01:00
Joel Challis
dd871d0105 Configure boards to use development_board - S (#25293) 2025-05-24 21:19:52 +01:00
Joel Challis
ba5c707327 salicylic_acid3/getta25 - Fix oled keymap (#25295) 2025-05-24 19:04:01 +01:00
Joel Challis
8b7c351e56 [Docs] Fix tap_hold code blocks (#25298) 2025-05-24 19:00:22 +01:00
Joel Challis
196285c59c Configure boards to use development_board - UVWXYZ (#25288) 2025-05-23 01:27:00 +01:00
Stefan Kerkmann
f3b974f216 [Fix] lib8tion: enable fixed scale8 and blend functions (#25272)
lib8tion: enable fixed scale8 and blend functions

These FastLED derived lib8tion functions have been fixed and enabled by
default in FastLED. QMK just never set these defines, there is no reason
to keep the buggy implementation. It is assumed that nobody relied on
the buggy behavior.
2025-05-22 22:52:45 +01:00
Joel Challis
243c21568a Configure boards to use development_board - 0-9 (#25287) 2025-05-22 20:49:22 +01:00
Pablo Martínez
955809bd5a Add compiler_support.h (#25274) 2025-05-22 23:31:15 +10:00
Nick Brassel
fa24b0fcce Remove outdated nix support due to bit-rot. (#25280) 2025-05-21 07:17:58 +10:00
Stefan Kerkmann
4f0a0f32f2 [Chore] use {rgblight,rgb_matrix}_hsv_to_rgb overrides (#25271) 2025-05-20 19:23:20 +01:00
ivan
24895c46f3 Move rookiebwoy to ivndbt (#25142) 2025-05-19 22:15:19 +01:00
QMK Bot
190e0eff23 Merge remote-tracking branch 'origin/master' into develop 2025-05-19 20:53:40 +00:00
ClownFish
28720c4d34 add doio/kb03 (#24815)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-05-19 13:53:02 -07:00
Nick Brassel
919e2a4f5c Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
Stefan Kerkmann
f686ad9e63 [Core] STM32G0x1 support (#24301) 2025-05-19 15:51:28 +10:00
Nick Brassel
a4ef1ae736 gcc15 AVR compilation fixes (#25238) 2025-05-19 09:22:31 +10:00
Florent Linguenheld
81355045cc Chew folders (#24785) 2025-05-18 18:53:00 +01:00
QMK Bot
bcd06f03a5 Merge remote-tracking branch 'origin/master' into develop 2025-05-18 15:43:21 +00:00
Joel Challis
02517bd806 Update PR checklist notes on custom matrix (#25240) 2025-05-18 16:42:43 +01:00
QMK Bot
6b25bfb0ff Merge remote-tracking branch 'origin/master' into develop 2025-05-18 15:29:20 +00:00
Joel Challis
0f948fe039 Add Waveshare RP2040-Keyboard-3 support (#25269) 2025-05-18 16:28:42 +01:00
QMK Bot
fffa553c25 Merge remote-tracking branch 'origin/master' into develop 2025-05-18 03:29:00 +00:00
Infos
e73b3c08a0 Add Zeropad (#24737)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-05-17 20:28:24 -07:00
Joel Challis
fa35be5135 Resolve miscellaneous keyboard lint warnings (#25268) 2025-05-16 17:35:17 +01:00
Joel Challis
0b6a460b7f Remove duplicate of SPI default config from keyboards (#25266) 2025-05-16 17:35:05 +01:00
QMK Bot
15e45b1d4b Merge remote-tracking branch 'origin/master' into develop 2025-05-16 16:09:52 +00:00
Danny
40d0de39b7 Add BDN9 Rev. 3 (#25261) 2025-05-16 12:08:51 -04:00
Joel Challis
05ff5443b1 Deprecate usb.force_nkro/FORCE_NKRO (#25262) 2025-05-14 22:02:43 +10:00
QMK Bot
e553cf7214 Merge remote-tracking branch 'origin/master' into develop 2025-05-14 12:01:11 +00:00
Joel Challis
cd95294a25 Remove more USB only branches from NKRO handling (#25263) 2025-05-14 22:01:08 +10:00
Joel Challis
8c108efb0d dlip/haritev2 - Post merge fixes (#25264) 2025-05-14 22:00:33 +10:00
QMK Bot
b4f0314b35 Merge remote-tracking branch 'origin/master' into develop 2025-05-14 10:13:34 +00:00
Dane Lipscombe
59c3612590 Add Harite v2 keyboard (#24975) 2025-05-14 11:12:59 +01:00
QMK Bot
55e4a1c7dc Merge remote-tracking branch 'origin/master' into develop 2025-05-14 03:23:53 +00:00
Wasteland Fluttershy
e0b037c2cd Fixes the numlock indicator for Magic Force MF17 numpad (#25260) 2025-05-13 20:23:16 -07:00
Matti Hiljanen
070dea4a9c Fix OS_DETECTION_KEYBOARD_RESET (#25015)
Co-authored-by: Nick Brassel <nick@tzarc.org>
2025-05-12 12:15:40 +10:00
Pascal Getreuer
f4171412a6 Enable community modules to define LED matrix and RGB matrix effects. (#25187)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-05-12 09:30:19 +10:00
art-was-here
7f42a5bc03 [New Feature/Core] New RGB Matrix Animation "Starlight Smooth" (#25203) 2025-05-12 08:50:36 +10:00
Joel Challis
3e7ce54902 Fix Wear Leveling compilation (#25254) 2025-05-12 08:39:38 +10:00
Joel Challis
88c094908b Add raw_hid support to host driver (#25255) 2025-05-12 08:38:48 +10:00
QMK Bot
c045c3e00c Merge remote-tracking branch 'origin/master' into develop 2025-05-11 05:58:16 +00:00
cyxae
6b1a376aee [Keyboard] Add Jason Hazel’s Bad Wings v2 (#25252)
Co-authored-by: Florent Allard <florent.allard@savoirfairelinux.com>
2025-05-10 22:57:40 -07:00
HorrorTroll
02525f683e Allow LVGL onekey keymap to be able compile for other board (#25005) 2025-05-10 19:26:50 +01:00
Drashna Jaelre
5a57d2115b [Docs] Fix typos introduced by PR #25050 (#25250)
It isn't a drashna PR if there aren't some typos in it somewhere.
2025-05-09 07:18:30 +10:00
Joel Challis
660d248549 Add debounce to duplicated defaults check (#25246) 2025-05-08 01:12:58 +01:00
QMK Bot
1bc3494494 Merge remote-tracking branch 'origin/master' into develop 2025-05-07 17:38:45 +00:00
muge
33a12ca0b6 CXT Studio 12E3: Fix encoder resolutions not applying (#25242)
* add resolution to encoders so they apply

* Tweak default keymap

* replace KC_UNDO with C(KC_Z) as well
2025-05-07 11:38:10 -06:00
QMK Bot
084ed078d6 Merge remote-tracking branch 'origin/master' into develop 2025-05-07 14:42:14 +00:00
Nathan Cain
32204095e5 Docs update for installing qmk with uv (#24995) 2025-05-07 15:41:37 +01:00
QMK Bot
b76bf29d25 Merge remote-tracking branch 'origin/master' into develop 2025-05-07 14:39:04 +00:00
VeyPatch
396fb4dde7 Fix Aurora sweep default keymap configuration (#25148) 2025-05-07 15:38:29 +01:00
QMK Bot
4836fcf831 Merge remote-tracking branch 'origin/master' into develop 2025-05-07 07:09:37 +00:00
dabstractor
1becbaefbe Fixed print statement after enabling 32-bit layers (#25027) 2025-05-07 00:09:01 -07:00
QMK Bot
e3c613c79c Merge remote-tracking branch 'origin/master' into develop 2025-05-06 06:23:47 +00:00
Duncan Sutherland
04fbcdc68d Layout corrections: Zed60 (#25003) 2025-05-05 23:23:10 -07:00
Drashna Jaelre
55909141ef [Keyboard] Update Tractyl Manuform and add F405 (weact) variant (#24764) 2025-05-05 23:19:38 -07:00
QMK Bot
cd6e065f6e Merge remote-tracking branch 'origin/master' into develop 2025-05-06 06:04:11 +00:00
Silvino R.
bb2b7ce7e4 [Keyboard] Add Binepad KnobX1 (#25222)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-05-05 23:03:30 -07:00
QMK Bot
2fbc222bb0 Merge remote-tracking branch 'origin/master' into develop 2025-05-06 05:56:06 +00:00
yiancar
a1469abc8d Keycult 60 (#25213)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: jack <jack@pngu.org>
2025-05-05 22:55:31 -07:00
Joel Challis
ab1332bb6c Remove force disable of NKRO when Bluetooth enabled (#25201) 2025-05-06 06:47:44 +01:00
Nick Brassel
ac991405d0 Deprecate qmk generate-compilation-database. (#25237) 2025-05-06 09:52:41 +10:00
Joel Challis
842c840145 Bind Bluetooth driver to host_driver_t (#25199) 2025-05-05 04:05:04 +01:00
Joel Challis
614b631ee2 Ensure qmk_userspace_paths maintains detected order (#25204) 2025-05-05 03:43:14 +01:00
Joel Challis
5611a40064 Add battery changed callbacks (#25207) 2025-05-05 03:28:33 +01:00
QMK Bot
11c8b2841e Merge remote-tracking branch 'origin/master' into develop 2025-05-05 01:46:48 +00:00
Silvino R.
0c0d038a40 [Keyboard] Add Binepad KN01 (#25224)
* Add Binepad NeoKnob KN01

* post @waffle87 recommendations
2025-05-04 19:46:11 -06:00
Joel Challis
5f31d5cc80 Resolve alias for qmk new-keymap keyboard prompts (#25210) 2025-05-05 11:14:40 +10:00
Joel Challis
dbe30a1b6f Generate versions to keycode headers (#25219) 2025-05-05 10:44:08 +10:00
QMK Bot
a992e32bd5 Merge remote-tracking branch 'origin/master' into develop 2025-05-05 00:23:26 +00:00
Joel Challis
cf5ce64b1b Workaround for resolving keyboard alias for config file values (#25228) 2025-05-05 10:22:51 +10:00
Drashna Jaelre
12caf0be4e Add additional hooks for Community modules (#25050) 2025-05-05 10:21:47 +10:00
Nick Brassel
bb9dd05c6a [Bug] Minimise force-included files (#25194) 2025-05-05 10:07:53 +10:00
QMK Bot
59f607b963 Merge remote-tracking branch 'origin/master' into develop 2025-05-02 01:53:11 +00:00
Christopher Hoage
60ac859852 Fix Spleeb compile when pointing device is enabled (#25016) 2025-05-01 18:52:36 -07:00
Joel Challis
4fb3cf0712 Remove redundant keyboard headers (#25208) 2025-05-01 15:02:17 +01:00
QMK Bot
e98c41c02f Merge remote-tracking branch 'origin/master' into develop 2025-04-30 18:09:14 +00:00
takashicompany
45091b0473 [Keyboard] Add Gravity-45(#25206)
* add gravity-45

* readme.md

* fix readme

* Update keyboards/green_keys/gravity_45/keyboard.json

Co-authored-by: jack <0x6a73@protonmail.com>

* run qmk format-json -i keyboards/green_keys/gravity_45/keyboard.json

* add url

* Update keyboards/green_keys/gravity_45/keyboard.json

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

* Update keyboard.json

* Update keyboard.json

* Update keyboards/green_keys/gravity_45/keyboard.json

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

---------

Co-authored-by: jack <0x6a73@protonmail.com>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-04-30 12:08:37 -06:00
Joel Challis
3cf328c644 amptrics/0422 - Prevent OOB in update_leds_for_layer (#25209) 2025-04-28 14:37:50 -07:00
Pascal Getreuer
c26449e64f [Core] Enhance Flow Tap to work better for rolls over multiple tap-hold keys. (#25200)
* Flow Tap revision for rolling press.

* Remove debugging cruft.

* Formatting fix.
2025-04-28 09:52:20 +02:00
zvecr
7fa65aa877 Merge remote-tracking branch 'origin/master' into develop 2025-04-28 07:24:00 +01:00
vchowl
4e2191ce20 Amptrics 0420 keyboard addition (#24744)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2025-04-27 23:08:13 -07:00
josephawilliamsiv
3de04e0386 Add Umbra keyboard (#24569)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-04-27 23:02:30 -07:00
Cipulot
2e648d7e48 Addition of OK-1 (#24646)
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-04-27 22:55:51 -07:00
hen-des
1fd0139b91 Added new keyboard epssp75 (#24756)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-04-27 22:28:22 -07:00
mizma
3478ae5795 [Keyboard] mzmkb/slimdash/rev1 (#24804)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2025-04-27 22:26:47 -07:00
VeyPatch
01354fffb4 [Keyboard] Add splitkb.com's Halcyon Elora rev2 (#24790)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-04-27 22:25:09 -07:00
Jeremy Cook
92c4f0095d Add jcpm2 (JC Pro Macro 2) (#24816)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-04-27 21:03:50 -07:00
LucasMateijsen
ac8b914a11 Add handwired 4x14 LuMaWing keyboard (#24885) 2025-04-27 20:58:47 -07:00
Matheus Marques
de598ac8f0 [Keymap] Sofle RGB - fixed stuck on numpad layer and layout comments (#24942) 2025-04-27 11:42:11 -07:00
QMK Bot
142952cac8 Merge remote-tracking branch 'origin/master' into develop 2025-04-27 18:19:53 +00:00
takashicompany
a07360e0f1 Add new keyboard MirageiX (#25054)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: jack <0x6a73@protonmail.com>
2025-04-27 11:19:19 -07:00
QMK Bot
1fc7066713 Merge remote-tracking branch 'origin/master' into develop 2025-04-26 00:40:58 +00:00
Michał Kopeć
ca425971d5 keyboards/annepro2/ld: Add per-variant linker scripts (#24999)
C18 has an MCU with 16K SRAM, up from C15's 8K.

Split the linker script into C15 and C18 variants to make use of the
larger RAM capacity of C18.
2025-04-26 01:40:17 +01:00
QMK Bot
dffa59dca5 Merge remote-tracking branch 'origin/master' into develop 2025-04-26 00:32:07 +00:00
Aidan Gauland
3319474c5c Add Lemokey X0 keyboard (#24994) 2025-04-26 01:31:25 +01:00
QMK Bot
802e2f54c6 Merge remote-tracking branch 'origin/master' into develop 2025-04-26 00:29:24 +00:00
Álvaro A. Volpato
12d70ab1a4 First TypeK support (#22876) 2025-04-26 01:28:49 +01:00
Joel Beckmeyer
4ae24004b7 modelh: add prerequisites for via support (#24932) 2025-04-24 13:04:30 -07:00
Joel Challis
8244659b44 Extend lint checks to reject duplication of defaults (#25149) 2025-04-24 05:39:56 +01:00
Joel Challis
0bd02952ea Remove "command":false from keyboards (#25193) 2025-04-24 10:28:13 +10:00
jack
5ea7283159 Fix boardsource/beiwagon RGB Matrix coordinates (#25018) 2025-04-23 04:06:17 +01:00
QMK Bot
acedfc3fcb Merge remote-tracking branch 'origin/master' into develop 2025-04-23 02:26:26 +00:00
dependabot[bot]
e5466df800 Bump vite from 5.4.15 to 5.4.18 in /builddefs/docsgen (#25192)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-04-23 12:25:47 +10:00
Joel Challis
ce1801aeda Align new-keyboard template to current standards (#25191) 2025-04-23 12:14:11 +10:00
Joel Challis
11cb5cf347 Remove more duplication of defaults (#25189) 2025-04-23 12:11:28 +10:00
QMK Bot
24d896ca06 Merge remote-tracking branch 'origin/master' into develop 2025-04-23 02:10:54 +00:00
Joel Challis
da2e897f55 Update 'qmk generate-api' to only publish pure DD keymaps (#24782) 2025-04-23 12:10:14 +10:00
Joel Challis
07684bcc99 Remove "console":false from keyboards (#25190) 2025-04-23 12:09:56 +10:00
QMK Bot
847bef3177 Merge remote-tracking branch 'origin/master' into develop 2025-04-23 02:03:39 +00:00
Joel Challis
c6a93b5a56 Bump rlespinasse/github-slug-action from 3 to 5 (#25021) 2025-04-23 12:03:02 +10:00
Joel Challis
8cd71917ce Avoid duplication in generated community modules rules.mk (#25135) 2025-04-23 10:27:47 +10:00
eynsai
7a2cd0fa96 High resolution scrolling (without feature report parsing) (#24423)
* hires scrolling without feature report parsing

* fix valid range for exponent

* fix incorrect minimum exponent value documentation
2025-04-23 00:04:31 +02:00
Joel Challis
83818d1d6f Prompt for converter when creating new keymap (#25116) 2025-04-22 17:59:16 +01:00
Joel Challis
960c4969a5 Remove empty url fields (#25181) 2025-04-22 17:59:00 +01:00
Pascal Getreuer
73e2ef486a [Bug][Core] Fix for Flow Tap: fix handling of distinct taps and timer updates. (#25175)
* Flow Tap bug fix.

As reported by @amarz45 and @mwpardue, there is a bug where if two
tap-hold keys are pressed in distinct taps back to back, then Flow Tap
is not applied on the second tap-hold key, but it should be.

In a related bug reported by @NikGovorov, if a tap-hold key is held
followed by a tap of a tap-hold key, then Flow Tap updates its timer on
the release of the held tap-hold key, but it should be ignored.

The problem common to both these bugs is that I incorrectly assumed
`tapping_key` is cleared to noevent once it is released, when actually
`tapping_key` is still maintained for `TAPPING_TERM` ms after release
(for Quick Tap). This commit fixes that. Thanks to @amarz45, @mwpardue,
and @NikGovorov for reporting!

Details:

* Logic for converting the current tap-hold event to a tap is extracted
  to `flow_tap_key_if_within_term()`, which is now invoked also in the
  post-release "interfered with other tap key" case. This fixes the
  distinct taps bug.

* The Flow Tap timer is now updated at the beginning of each call to
  `process_record()`, provided that there is no unsettled tap-hold key
  at that time and that the record is not for a mod or layer switch key.
  By moving this update logic to `process_record()`, it is conceptually
  simpler and more robust.

* Unit tests extended to cover the reported scenarios.

* Fix formatting.

* Revision to fix @NikGovorov's scenario.

The issue is that when another key is pressed while a layer-tap hasn't
been settled yet, the `prev_keycode` remembers the keycode from before
the layer switched. This can then enable Flow Tap for the following key
when it shouldn't, or vice versa.

Thanks to @NikGovorov for reporting!

This commit revises Flow Tap in the following ways:

* The previous key and timer are both updated from `process_record()`.
  This is slightly later in the sequence of processing than before, and
  by this point, a just-settled layer-tap should have taken effect so
  that the keycode from the correct layer is remembered.

* The Flow Tap previous key and timer are updated now also on key
  release events, except for releases of modifiers and held layer
  switches.

* The Flow Tap previous key and timer are now updated together, for
  simplicity. This makes the logic easier to think about.

* A few additional unit tests, including @NikGovorov's scenario as
  "layer_tap_ignored_with_disabled_key_complex."
2025-04-22 09:59:49 +02:00
Joel Challis
b5f8f4d6a2 Align ChibiOS USB_WAIT_FOR_ENUMERATION implementation (#25184) 2025-04-22 14:31:42 +10:00
QMK Bot
0c4124c1c0 Merge remote-tracking branch 'origin/master' into develop 2025-04-22 04:15:10 +00:00
Nick Brassel
9f04023d35 Decrease firmware size for anavi/macropad8. (#25185)
Preparation for bootstrapper.
2025-04-22 14:14:28 +10:00
QMK Bot
43e3831df9 Merge remote-tracking branch 'origin/master' into develop 2025-04-21 23:56:44 +00:00
CJ Pais
ebfa3cdd5c Add handwired/footy (#25151)
Co-authored-by: jack <jack@pngu.org>
2025-04-21 16:56:10 -07:00
Joel Challis
c7cb7ba976 Implement connection keycode logic (#25176) 2025-04-21 22:27:56 +01:00
Joel Challis
ec324af22e Add lint warning for empty url (#25182) 2025-04-21 20:07:05 +01:00
Eric Molitor
2c54ff3e63 Update develop branch to Pico SDK 1.5.1 (#25178) 2025-04-21 15:05:22 +01:00
QMK Bot
402b5ba6d7 Merge remote-tracking branch 'origin/master' into develop 2025-04-21 14:03:22 +00:00
Nick Brassel
53f1f3b6d7 Fix for .clangd. (#25180) 2025-04-22 00:02:47 +10:00
QMK Bot
b779c5f567 Merge remote-tracking branch 'origin/master' into develop 2025-04-20 09:42:05 +00:00
Jan Bláha
a1cb822861 DOCS: qmk-hid missing in bootloaders list? (#25177) 2025-04-20 19:41:30 +10:00
Nick Brassel
a4aabea511 Fixup eeconfig lighting reset. (#25166) 2025-04-19 23:10:33 +01:00
QMK Bot
c8763c9fdb Merge remote-tracking branch 'origin/master' into develop 2025-04-19 22:10:27 +00:00
Joel Challis
edf34315af Fix 'Would you like to clone the submodules?' prompt under msys (#24958) 2025-04-20 08:09:54 +10:00
Joel Challis
ce8b8414d9 Remove bluefruit_le_read_battery_voltage function (#25129) 2025-04-19 22:52:25 +01:00
Less/Rikki
7e68cfc6fa [keyboard] ymdk/id75/rp2040 (#25157)
Co-authored-by: tao heihei <>
2025-04-19 13:11:08 -07:00
Nick Brassel
5c39722ab9 Allow for disabling EEPROM subsystem entirely. (#25173) 2025-04-19 20:20:00 +01:00
Pascal Getreuer
ea85ace4a9 Ignore the Layer Lock key in Repeat Key and Caps Word. (#25171) 2025-04-19 11:57:00 -07:00
Joel Challis
88453acc6a Remove duplication of RGBLight defaults (#25169) 2025-04-19 11:56:45 -07:00
QMK Bot
988d81581d Merge remote-tracking branch 'origin/master' into develop 2025-04-18 09:05:59 +00:00
lsh4711
800bc78d26 Fix missing and extra commas in JSON schema (#25057) 2025-04-18 19:05:25 +10:00
Joel Challis
b43fc33be3 Remove duplication of RGB Matrix defaults (#25146)
* Remove duplication of RGB Matrix defaults

* Remove more duplication of defaults

* fix
2025-04-17 20:59:59 -06:00
QMK Bot
d33aa82c51 Merge remote-tracking branch 'origin/master' into develop 2025-04-17 18:51:15 +00:00
JamesWilson1996
576325e2f4 [Keyboard] Add voidhhkb-hotswap (#25007)
* Added files for voidhhkb-hotswap

* Updated keyboard name to resolve build errors

* Implement suggestions from PR. Use 60_hhkb community layout.

* Update keyboards/void/voidhhkb_hotswap/readme.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Apply suggestions from code review

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

---------

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: jack <jack@pngu.org>
2025-04-17 12:50:41 -06:00
QMK Bot
642c169bc3 Merge remote-tracking branch 'origin/master' into develop 2025-04-17 16:24:18 +00:00
ClownFish
7641359240 [Docs] Unify lighting step descriptions (#25167)
unify lighting step descriptions and defaults across docs
2025-04-17 10:23:16 -06:00
QMK Bot
944a206d1f Merge remote-tracking branch 'origin/master' into develop 2025-04-17 02:41:54 +00:00
Nick Brassel
e83b709169 [Keyboard] Kobold r1 (#25161)
* Kobold r1

* Apply suggestions from code review

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

* `board_init` => `early_hardware_init_post`.

---------

Co-authored-by: jack <jack@pngu.org>
2025-04-16 20:41:20 -06:00
QMK Bot
00f07ec343 Merge remote-tracking branch 'origin/master' into develop 2025-04-14 17:28:26 +00:00
Daniel Reisch
80612c8ec0 Added Keyboard LumPy27 (#24967)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-04-14 10:27:52 -07:00
jack
32b9d33bbb Remove Sofle rgb_default keymap & tidy readme's (#25010) 2025-04-14 09:58:14 -07:00
QMK Bot
9208fb5adb Merge remote-tracking branch 'origin/master' into develop 2025-04-14 16:54:03 +00:00
Andrew Kannan
af141d1a5c Add Link keyboard (#25058)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-04-14 09:52:51 -07:00
Pascal Getreuer
8d8dcb089e [Core] Flow Tap tap-hold option to disable HRMs during fast typing (#25125)
aka Global Quick Tap, Require Prior Idle
2025-04-14 09:46:24 -07:00
Stefan Kerkmann
a7bf8e64a5 [chore]: move and rename mouse/scroll min/max defines (#25141)
* protocol: move {XY/HV}_REPORT_{MIN,MAX} into report.h

..to allow easier re-use in other code implementations.

* protocol: rename {XY/HV}_REPORT_{MIN/MAX} to MOUSE_REPORT_{XY/HV}_{MIN/MAX}

..to avoid naming collisions.
2025-04-13 18:36:13 +02:00
QMK Bot
d0611b0468 Merge remote-tracking branch 'origin/master' into develop 2025-04-13 16:25:00 +00:00
suikagiken
1388daa0cc [Keyboard] Add suika83opti (#24991) 2025-04-13 10:20:42 -06:00
Sylvain Huguet
d99eb01ee4 Update shuguet/shu89 (#24780)
* Update keyboard.json

Update mod keys location in RGB layout.

* Update keyboard.json

* Update keyboards/shuguet/shu89/keyboard.json

Co-authored-by: Ryan <fauxpark@gmail.com>

---------

Co-authored-by: Ryan <fauxpark@gmail.com>
2025-04-13 10:19:12 -06:00
Olivier Mehani
e17878ad15 kradoindustries_promenade: add LAYOUT_1x2u (#25090) 2025-04-13 10:14:34 -06:00
Christian C. Berclaz
ba72094b69 New standard layout for Savage65 (65_ansi_blocker_tsangan_split_bs) (#24690)
* Added a default firmware and layout for the WindStudio Wind X R1
keyboard.

* Wind X R1: cleaned-up the folders to make clear that this firmware is
for the release 1 of this keyboard.

* Delete keyboards/windstudio/wind_x/R1 directory

Removing the uppercase R1 folder

* feat(cannonkeys/savage65): Added layout to keyboard.json
- Added the layout LAYOUT_65_ansi_blocker_tsangan_split_bs to the
  community layouts.
2025-04-13 10:11:18 -06:00
QMK Bot
0d7d75d3d5 Merge remote-tracking branch 'origin/master' into develop 2025-04-11 16:26:48 +00:00
Luis Garcia
daf6968947 fix: Fix startup sound for Preonic (#25132) (#25133)
Add `AUDIO_INIT_DELAY ` to config.h to resolve
2025-04-11 17:26:13 +01:00
Joel Challis
e27dd0f26f Exclude external userspace from lint checking (#24680) 2025-04-11 22:19:02 +10:00
QMK Bot
6624671a60 Merge remote-tracking branch 'origin/master' into develop 2025-04-11 05:26:44 +00:00
Luis Garcia
f549b30760 chore: Allow disabling underglow on Work Louder devices (#25123) (#25120)
* Allow disabling Underglow on Work Louder devices

Allows disabling Underglow on Work Louder devices by using `RGBLIGHT_ENABLE = no` on rules.mk

* Update keyboards/work_louder/rgb_functions.c

Suggested by @zvecr on review.

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

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2025-04-10 23:26:11 -06:00
Nick Brassel
6b8670fe8f Cater for use of __errno_r() in ChibiOS syscalls.c with newer picolibc revisions (#25121) 2025-04-10 01:43:25 +01:00
QMK Bot
dc26e99dd5 Merge remote-tracking branch 'origin/master' into develop 2025-04-09 14:29:06 +00:00
Nick Brassel
a0f40d9410 Include math.h where necessary. (#25122) 2025-04-09 15:28:30 +01:00
QMK Bot
4dc846f21c Merge remote-tracking branch 'origin/master' into develop 2025-04-09 00:15:49 +00:00
Nick Brassel
575abc48a3 More Windows->Unix style path fixes. (#25119) 2025-04-09 10:15:14 +10:00
QMK Bot
4643681888 Merge remote-tracking branch 'origin/master' into develop 2025-04-08 22:13:51 +00:00
Andrew Kannan
0ec96ddd52 Add Vida to QMK (#24225)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
2025-04-09 08:13:16 +10:00
QMK Bot
35019fe136 Merge remote-tracking branch 'origin/master' into develop 2025-04-08 02:36:21 +00:00
Joel Challis
2645751ce1 Add warning when deprecated 'promicro_rp2040' is used (#25112) 2025-04-08 12:35:43 +10:00
QMK Bot
f35f4ee933 Merge remote-tracking branch 'origin/master' into develop 2025-04-08 02:31:52 +00:00
Joel Challis
ca84b57042 Remove direct docs.qmk.fm links from docs (#25113) 2025-04-08 12:31:17 +10:00
Joel Challis
06610c3da6 Remove CTPC/CONVERT_TO_PROTON_C options (#25111) 2025-04-08 01:55:49 +01:00
QMK Bot
ca635876ce Merge remote-tracking branch 'origin/master' into develop 2025-04-07 17:03:39 +00:00
sudo pacman -Syu
5f222a3e02 Fix coban pad9a wrong layout in keyboard.json (#25100) 2025-04-07 11:03:05 -06:00
QMK Bot
bca0aca8c5 Merge remote-tracking branch 'origin/master' into develop 2025-04-07 06:30:11 +00:00
Ivan Gromov
f94c8fd766 [Keyboard] Add Ortho Slayer (#25099)
* Add Ortho Slayer

* Update keyboards/keyten/ortho_slayer/keymaps/default/keymap.c

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

* Update keyboards/keyten/ortho_slayer/readme.md

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

---------

Co-authored-by: jack <jack@pngu.org>
2025-04-07 00:29:37 -06:00
QMK Bot
73ec19f0cb Merge remote-tracking branch 'origin/master' into develop 2025-04-07 04:03:57 +00:00
nonameCCC
a7ac6e4e68 [Keyboard] Add PHDesign PH60/Multi Keyboard PCB (#25086)
* Add PH60/Multi Support

* Add PCB PIcture for README

* Remove MO(_FN2)

* README Typo Fix

* Layout and README Adjustment

* Add README for PHDesign Main Folder

* Keymap Improvement

* Update README.md
2025-04-06 22:03:24 -06:00
QMK Bot
0da4c26d9c Merge remote-tracking branch 'origin/master' into develop 2025-04-06 18:03:03 +00:00
Dam Vu Duy
9e775b8e9d Add Coban Pad 12A (#25039)
Co-authored-by: jack <jack@pngu.org>
2025-04-06 10:56:19 -07:00
Pham Duc Minh
30c0036db1 Refactor Deemen17 Works DE60 (#25088) 2025-04-06 10:53:13 -07:00
QMK Bot
4d3726050e Merge remote-tracking branch 'origin/master' into develop 2025-04-05 21:22:08 +00:00
Joel Challis
625d62efdf Fix 'qmk lint -kb' argument handling (#25093) 2025-04-06 07:21:04 +10:00
Ivan Gromov
0f1dcc0592 Add kt60HS-T v2 PCB (#25080)
* Add kt60HS-Tv2

* Update keyboards/keyten/kt60hs_t/readme.md

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

* Update keyboards/keyten/kt60hs_t/v1/readme.md

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

* Update keyboards/keyten/kt60hs_t/v2/keyboard.json

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

* Update keyboards/keyten/kt60hs_t/v2/readme.md

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

* Update keyboards/keyten/kt60hs_t/info.json

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

* Change of structure

* Moving the keyboard

* Update data/mappings/keyboard_aliases.hjson

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

* Update keyboards/keyten/kt60hs_t/v1/keyboard.json

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

* Update keyboards/keyten/kt60hs_t/v2/keyboard.json

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

---------

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
2025-04-03 12:51:25 -06:00
Pascal Getreuer
da166d4d8b Add "license" field to Community Module JSON schema. (#25085)
Add "license" field to community module schema.
2025-04-01 16:06:42 +11:00
QMK Bot
3cd2924985 Merge remote-tracking branch 'origin/master' into develop 2025-03-30 00:18:16 +00:00
henrikosorensen
bc42a7ea89 At101ish (#25072)
* Dell AT101 replacement pcb support

* Update keyboards/at101ish/readme.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* remove empty src clause in makefile

* feature: Update at101ish to qmk v0.28

* feature: Add osdetecting keymap variant.

* refactor: Move at101ish keyboard to handwired folder.

* fix: Adjust at101ish readme-

* fix: review changes.

* chore: Remove unneeded feature.

---------

Co-authored-by: fauxpark <fauxpark@gmail.com>
2025-03-29 18:17:38 -06:00
QMK Bot
7adb4dc6fb Merge remote-tracking branch 'origin/master' into develop 2025-03-29 13:20:13 +00:00
Nick Brassel
49d13595f6 Fix lockups on AVR with qmk/hello_world module (#25074)
Fix lockups on AVR.
2025-03-30 00:19:38 +11:00
QMK Bot
a8fb9e1462 Merge remote-tracking branch 'origin/master' into develop 2025-03-29 02:48:02 +00:00
フィルターペーパー
d0cfb938ef Module documentation typo correction (#25073) 2025-03-28 20:47:26 -06:00
QMK Bot
0682cf9242 Merge remote-tracking branch 'origin/master' into develop 2025-03-28 13:38:59 +00:00
Ben Green
94a9099c38 Update onekey example for nucleo f446re (#25067)
* use accessible pins for nucleo f446re onekey example

* remove pin collision with matrix in keyboard.json

* use accessible pins for LED

* remove pin collision with matrix

* Update readme.md to reflect pin changes
2025-03-29 00:38:24 +11:00
QMK Bot
cbe48b67df Merge remote-tracking branch 'origin/master' into develop 2025-03-28 10:04:33 +00:00
lsh4711
5a6595357d Fix path typo related RP2040 (#25069)
Fix path typo
2025-03-28 21:03:59 +11:00
QMK Bot
d61798169d Merge remote-tracking branch 'origin/master' into develop 2025-03-28 09:19:41 +00:00
Geoffrey Frogeye
25fb4a498a Allow AnnePro2 to reboot (#24886)
Without this, the QK_REBOOT key did nothing.
2025-03-28 20:19:07 +11:00
QMK Bot
b9e4d22765 Merge remote-tracking branch 'origin/master' into develop 2025-03-28 08:56:42 +00:00
dependabot[bot]
6f3b494a4d Bump vite from 5.4.12 to 5.4.15 in /builddefs/docsgen (#25065)
Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 5.4.12 to 5.4.15.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v5.4.15/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v5.4.15/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-03-28 08:56:08 +00:00
QMK Bot
bc110b1533 Merge remote-tracking branch 'origin/master' into develop 2025-03-28 08:28:10 +00:00
Hyphen-ated
d4120b1def Add "Large Lad" keyboard (#24727)
Co-authored-by: jack <jack@pngu.org>
2025-03-28 01:27:54 -07:00
Sắn
ce9713c47d Add support for Starry FRL (#24626)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2025-03-28 01:27:36 -07:00
QMK Bot
183b093698 Merge remote-tracking branch 'origin/master' into develop 2025-03-28 06:26:12 +00:00
Erik Peyronson
64fe4aff31 Add handwired/erikpeyronson/erkbd (#25030)
Co-authored-by: Erik Peyronson <erik.peyronson@gmail.com>
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-03-27 23:25:39 -07:00
yiancar
a02ed6a36d Update keymap for keycult 1800 (#25070)
Update keymap

Co-authored-by: yiancar <yiancar@gmail.com>
2025-03-27 17:25:46 -06:00
QMK Bot
c130b08f8e Merge remote-tracking branch 'origin/master' into develop 2025-03-26 19:24:00 +00:00
Joel Challis
a3c39bde0e Create tags when lib/python changes (#25064)
Create tags when lib/python changes
2025-03-27 06:23:28 +11:00
Nick Brassel
1a6a9a7c77 [Modules] Provide access to current path in rules.mk. (#25061) 2025-03-26 10:30:45 +00:00
jack
86c22a15ab Fix outdated GPIO control function usage (#25060) 2025-03-26 07:51:56 +00:00
QMK Bot
558b074c93 Merge remote-tracking branch 'origin/master' into develop 2025-03-23 05:17:37 +00:00
Grigory Avdyushin
ce2f7d86be Franky36 handwired keyboard (#25029) 2025-03-22 22:17:05 -07:00
jack
2d37e80ac9 Migrate remaining split.soft_serial_pin to split.serial.pin (#25046)
* Migrate keyboards/bastardkb

* Migrate keyboards/handwired

* Migrate keyboards/helix

* Fix duplicate serial key
2025-03-22 09:58:33 -06:00
QMK Bot
38825610a5 Merge remote-tracking branch 'origin/master' into develop 2025-03-21 18:01:05 +00:00
Dasky
6a947fa534 Add Mechboards Crkbd (#24993) 2025-03-21 18:00:28 +00:00
Nick Brassel
2b00b846dc Non-volatile memory data repository pattern (#24356)
* First batch of eeconfig conversions.

* Offset and length for datablocks.

* `via`, `dynamic_keymap`.

* Fix filename.

* Commentary.

* wilba leds

* satisfaction75

* satisfaction75

* more keyboard whack-a-mole

* satisfaction75

* omnikeyish

* more whack-a-mole

* `generic_features.mk` to automatically pick up nvm repositories

* thievery

* deferred variable resolve

* whitespace

* convert api to structs/unions

* convert api to structs/unions

* convert api to structs/unions

* fixups

* code-side docs

* code size fix

* rollback

* nvm_xxxxx_erase

* Updated location of eeconfig magic numbers so non-EEPROM nvm drivers can use them too.

* Fixup build.

* Fixup compilation error with encoders.

* Build fixes.

* Add `via_ci` keymap to onekey to exercise VIA bindings (and thus dynamic keymap et.al.), fixup compilation errors based on preprocessor+sizeof.

* Build failure rectification.
2025-03-21 23:38:34 +11:00
Stefan Kerkmann
c9d62ddc78 [Core] use keycode_string in unit tests (#25042)
* tests: use keycode_string feature

With a proper keycode to string implementation in qmk there is no need
to use the unit tests only implementation anymore.

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

* tests: remove keycode_util feature

This feature is no longer used as we switched the tests to the
keycode string implementation.

Signed-off-by: Stefan Kerkmann <karlk90@pm.me>
2025-03-21 08:47:22 +01:00
QMK Bot
d603fb0913 Merge remote-tracking branch 'origin/master' into develop 2025-03-20 22:34:52 +00:00
plodah
f4dfa218ff fix swapped encoder pins on ploopy thumb rev1_001 (#25044)
fix swapped pins on ploopy thumb rev1_001 encoder
2025-03-20 15:34:14 -07:00
QMK Bot
b84ab51343 Merge remote-tracking branch 'origin/master' into develop 2025-03-20 22:22:52 +00:00
uv777bk
f6dbb56a10 Update Lighting Mode Animations on Monsgeek M5 (#24981)
Update keyboard.json
2025-03-21 09:22:43 +11:00
Max Rumpf
894b9c458d Enable mouse key feature and disable leader key on Maxr1998/Phoebe (#24982)
* Enable mousekey support on Maxr1998/Phoebe

* Add GPLv2 license header
2025-03-21 09:22:02 +11:00
QMK Bot
ad20f8287a Merge remote-tracking branch 'origin/master' into develop 2025-03-20 22:21:55 +00:00
Icy Avocado
9f44488bb1 Add directpins 21 keys pico (#24919)
* Add directpins 21 keys pico
- https://learn.adafruit.com/diy-pico-mechanical-keyboard-with-fritzing-circuitpython/21-key-pico-keyboard

* Rename from 21keys to pico_pad

* Add pico_pad readme

* Update bootloader instruction

---------

Co-authored-by: Dai <dai@ovacoda.com>
2025-03-21 09:21:18 +11:00
QMK Bot
0be239b45c Merge remote-tracking branch 'origin/master' into develop 2025-03-20 22:13:25 +00:00
Drashna Jaelre
a958276a76 Add Super Alt-Tab macro example as module (#24970)
* Add Super Alt-Tab macro example as module

* Make module more configurable

* remove unneeded comments

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

* Update modules/qmk/super_alt_tab/super_alt_tab.c

Co-authored-by: Nick Brassel <nick@tzarc.org>

---------

Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Nick Brassel <nick@tzarc.org>
2025-03-21 09:12:46 +11:00
QMK Bot
54dbde68e1 Merge remote-tracking branch 'origin/master' into develop 2025-03-20 22:01:02 +00:00
Akshay Atam
7fd12c2b98 Ducky one2mini ansi tsangan layout (#24909)
* Added ANSI Tsangan keymap for Ducky One2 Mini

* Updated keyboard.json to support ANSI Tsangan layout for Ducky One2 Mini
2025-03-21 09:00:01 +11:00
QMK Bot
add459f0ac Merge remote-tracking branch 'origin/master' into develop 2025-03-20 21:55:29 +00:00
mikiya418
3a8c76fae5 Develop 5keys (#24555)
* [Keyboard]Add 5keys

* Add files via upload

* Delete 5keys.json

* Add files via upload

* Delete 5keys_default.hex

* Add keyboard 5keys

* Add Copylight

* Update keyboards/5keys/keyboard.json

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

* Update keyboards/5keys/keyboard.json

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

* Update readme.md

---------

Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-03-21 08:54:54 +11:00
Ramon Imbao
ea238d5a8a Add the plywrks ply8x hotswap variant. (#23558)
* Add hotswap variant

* Update RGB matrix

* Move files around to target develop

* Revert rules.mk for keyboards/jaykeeb/joker/rules.mk

* Update keyboards/plywrks/ply8x/hotswap/keyboard.json

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

* Apply suggestions from code review

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

* Add missing community layouts

* Delete keyboards/plywrks/ply8x/rules.mk

* Update missing keys in RGB matrix

* Add missing key in RGB matrix for hotswap ver

* Remove via keymaps

* Add keyboard alias for plywrks/ply8x to plywrks/ply8x/solder

* Fix typo

* Fix another typo

---------

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
2025-03-21 08:53:27 +11:00
Duncan Sutherland
14ef6c9830 Add Community Layout support to daskeyboard4 (#23884)
add ansi CL
2025-03-21 08:44:59 +11:00
Duncan Sutherland
96882c6a67 Correct json for Fullsize JIS Community Layouts (#23660)
initial commit
2025-03-21 08:44:19 +11:00
QMK Bot
fd1d4d71aa Merge remote-tracking branch 'origin/master' into develop 2025-03-20 21:36:32 +00:00
Anthony Abruzzini
c5232ba699 Fix typo in docs: split_keyboard.md SPLIT_USB_DETECT ("theres's -> "there's") (#24984)
* Fix typo "theres's"

* Update docs/features/split_keyboard.md

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

---------

Co-authored-by: jack <jack@pngu.org>
2025-03-21 08:35:58 +11:00
QMK Bot
61479c4bf2 Merge remote-tracking branch 'origin/master' into develop 2025-03-20 05:07:29 +00:00
Andrew Kannan
e7c5695a0c Minor keymap fix on Cerberus HS (#25043) 2025-03-20 05:06:54 +00:00
Joel Challis
f820a186d4 Align to latest CLI dependencies (#24553)
* Align to latest CLI dependencies

* Update docs
2025-03-20 14:04:10 +11:00
Pascal Getreuer
3484f0a0df [Core] get_keycode_string(): function to format keycodes as strings, for more readable debug logging. (#24787)
* keycode_string(): Format keycodes as strings.

This adds the `keycode_string()` function described in
https://getreuer.info/posts/keyboards/keycode-string/index.html
as a core feature.

* Fix formatting.

* keycode_string review revisions.

* Rename keycode_string() -> get_keycode_string() for consistency with
  existing string utils like get_u8_str().

* Revise custom keycode names with separate _user and _kb tables.

* Correct indent in builddefs/generic_features.mk.

Co-authored-by: Ryan <fauxpark@gmail.com>

* Add KC_NUHS, KC_NUBS, and KC_CAPS.

* Fix linking error with custom names.

* Attempt at simplifying interface.

* Formatting fix.

* Several fixes and revisions.

* Don't use PSTR in KEYCODE_STRING_NAME, since this fails to build on
  AVR. Store custom names in RAM.
* Revise the internal table of common keycode names to use its own
  storage representation, still in PROGMEM, and now more efficiently
  stored flat in 8 bytes per entry.
* Support Swap Hands keycodes and a few other keycodes.

* Revert "Formatting fix."

This reverts commit 2a2771068c.

* Revert "Attempt at simplifying interface."

This reverts commit 8eaf67de76.

* Simplify custom names API by sigprof's suggestion.

* Support more keycodes.

* Add QK_LOCK keycode.
* Add Secure keycodes.
* Add Joystick keycodes.
* Add Programmable Button keycodes.
* Add macro MC_ keycodes.
* For remaining keys in known code ranges, stringify them as
  "QK_<feature>+<number>". For instance, "QK_MIDI+7".

* Bug fix and a few improvements.

* Fix missing right-hand bit when displaying 5-bit mods numerically.
* Support KC_HYPR, KC_MEH, HYPR_T(kc), MEH_T(kc).
* Exclude one-shot keycodes when NO_ACTION_ONESHOT is defined.

---------

Co-authored-by: Ryan <fauxpark@gmail.com>
2025-03-19 20:45:56 +01:00
QMK Bot
40a446a0ec Merge remote-tracking branch 'origin/master' into develop 2025-03-19 16:34:27 +00:00
Wilson Pika Choo
46829663aa [Keyboard] Change uzu42 usb.vid (#25014)
change generic vendor code
2025-03-19 10:33:53 -06:00
QMK Bot
d6850bab3f Merge remote-tracking branch 'origin/master' into develop 2025-03-19 01:46:02 +00:00
Nick Brassel
386a5019a8 Fixup MSYS + unix-style paths in Community Modules. (#25012)
Fixup MSYS + unix-style paths.
2025-03-19 12:45:28 +11:00
QMK Bot
80b16f688c Merge remote-tracking branch 'origin/master' into develop 2025-03-18 15:49:02 +00:00
Nick Brassel
271efeb8bc Latest batch of license violations. (#25031) 2025-03-18 15:48:27 +00:00
QMK Bot
40fafad6bc Merge remote-tracking branch 'origin/master' into develop 2025-03-17 19:07:56 +00:00
Nick Brassel
95223aa872 Latest batch of license violations as per #24085. (#25023)
* Latest batch of license violations as per #24085.

* No links.
2025-03-18 06:07:24 +11:00
QMK Bot
e6dcdf2d65 Merge remote-tracking branch 'origin/master' into develop 2025-03-16 08:45:02 +00:00
Joel Challis
c6446aeaf9 Bump tj-actions/changed-files from 45 to 46 (#25020) 2025-03-16 08:44:31 +00:00
QMK Bot
4f257711e0 Merge remote-tracking branch 'origin/master' into develop 2025-03-13 21:05:09 +00:00
André Cruz
65aef7be95 [Keyboard] Add Sofle Choc Prog from keebart (#24974) 2025-03-13 14:04:32 -07:00
QMK Bot
27b115151f Merge remote-tracking branch 'origin/master' into develop 2025-03-13 21:01:31 +00:00
Joel Challis
8ae5d34c0d keyten/kt60_mu - Add missing header guard (#25011) 2025-03-14 08:00:58 +11:00
QMK Bot
fab39d49e6 Merge remote-tracking branch 'origin/master' into develop 2025-03-13 19:21:29 +00:00
Ivan Gromov
25af20bef4 [Keyboard] Add kt60-MU PCB (#24797)
* Add kt60-MU

* Adding some license headers

* Update keyboards/keyten/kt60_mu/keyboard.json

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

* Update keyboards/keyten/kt60_mu/keyboard.json

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

* Update keyboard.json

* Update keyboard.json

* Update keyboards/keyten/kt60_mu/keyboard.json

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

* Update keyboards/keyten/kt60_mu/keyboard.json

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

---------

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
2025-03-13 13:20:56 -06:00
QMK Bot
3306d78bbd Merge remote-tracking branch 'origin/master' into develop 2025-03-11 09:43:13 +00:00
Dasky
84f9b6dd3e Add Mechboards Sofle (#25004)
* add sofle

* fix readme
2025-03-11 02:42:33 -07:00
Duncan Sutherland
808c4d4e38 add 75_(ansi|iso) Community Layouts to mechlovin/olly/octagon (#22459)
* expand mechlovin/olly/octagon

* Update info.json

* Rename info.json to keyboard.json

* correct matrix position for key

* remove VIA
2025-03-10 00:48:35 -07:00
Joel Challis
67934546ea Only configure STM32_HSECLK within board.h (#25001) 2025-03-09 23:41:24 +00:00
Joel Challis
21c1fd5e5b Require 'x'/'y' properties for LED/RGB Matrix layout (#24997) 2025-03-09 23:40:59 +00:00
Matthijs Muller
30daeaf09f Add Icebreaker keyboard (#24723)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-03-09 00:51:29 -08:00
QMK Bot
21f7c915df Merge remote-tracking branch 'origin/master' into develop 2025-03-09 07:59:37 +00:00
Christian C. Berclaz
a70288bc4a New standard layout for Mechlovin' Zed60 (60_tsangan_hhkb) (#24801)
* Added a default firmware and layout for the WindStudio Wind X R1
keyboard.

* Wind X R1: cleaned-up the folders to make clear that this firmware is
for the release 1 of this keyboard.

* Delete keyboards/windstudio/wind_x/R1 directory

Removing the uppercase R1 folder

* feat(mechlovin/zed60): Added the missing standard 60_tsangan_hhkb

* style(mechlovin/zed60): Ran qmk format-json -i on keyboard.json
2025-03-08 23:59:02 -08:00
QMK Bot
7cc18f2b11 Merge remote-tracking branch 'origin/master' into develop 2025-03-06 23:17:53 +00:00
Joel Challis
6e1d3d6d07 Add EOL to non-keyboard files (#24990) 2025-03-06 23:17:51 +00:00
Joel Challis
3c6a691126 keychron/c*_pro_v2: Migrate DIP_SWITCH_PINS (#24978) 2025-03-06 23:17:21 +00:00
QMK Bot
12f9f34fc8 Merge remote-tracking branch 'origin/master' into develop 2025-03-04 23:40:42 +00:00
Joel Challis
0302171fac Remove invalid RGB Matrix effects (#24977) 2025-03-04 23:40:28 +00:00
Joel Challis
fcfe0e8a95 Fix xelus/valor/rev3 compilation (#24976) 2025-03-04 23:40:08 +00:00
QMK Bot
4d3a9ce13a Merge remote-tracking branch 'origin/master' into develop 2025-03-03 19:23:41 +00:00
dnlnm
f0a5db96c8 Add keyboard Cloak (#24858)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-03-03 11:22:37 -08:00
QMK Bot
a0a999976f Merge remote-tracking branch 'origin/master' into develop 2025-03-03 19:22:27 +00:00
takashicompany
c2979e309f Add new keyboard "Palmslave" (#24814)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-03-03 11:21:47 -08:00
QMK Bot
40f08b47ae Merge remote-tracking branch 'origin/master' into develop 2025-03-03 19:19:08 +00:00
Armand du Parc Locmaria
b2ee1612fa Fix Lily58 Lite Rev3 reversed columns (#24968) 2025-03-03 11:18:33 -08:00
QMK Bot
a052adb659 Merge remote-tracking branch 'origin/master' into develop 2025-03-03 05:34:50 +00:00
floookay
cc09f17111 add keyboard: zwerg (#24918)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-03-02 21:34:16 -08:00
QMK Bot
3968f5b370 Merge remote-tracking branch 'origin/master' into develop 2025-03-03 03:32:59 +00:00
yiancar
a585bd08a3 Keycult Zero (#24927)
* Initial Commit for Keycult Zero

* Update keyboards/keycult/keycult_zero/keycult_zero.c

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

* Update keyboards/keycult/keycult_zero/rules.mk

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

---------

Co-authored-by: yiancar <yiancar@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-03-02 19:32:25 -08:00
QMK Bot
c46cefa898 Merge remote-tracking branch 'origin/master' into develop 2025-03-02 21:33:36 +00:00
leah-splitkb
cb6e1c1af5 Add splitkb.com's Elora (#22557)
* Add splitkb's Elora

* WIP

* Make requested changes

* fix missing call to keyboard init user for elora

* sync vial_qmk with qmk

* Add fixes

* Add encoder quadrature and update files

* Update Readme

* Implement changes

* Remove encoder driver from keyboard.json

* make requested changed

* Implement changes and remove myriad_task as it wasn't actually doing anything.

* Remove myriad.h from matrix.c

* Simplify OLED code debug

* Update RGB keycodes (qmk#24484)

* remove rules.mk (qmk#23281)

* Add matrix state sync

---------

Co-authored-by: NapOli1084 <10320176+NapOli1084@users.noreply.github.com>
Co-authored-by: harveysch <126267034+harvey-splitkb@users.noreply.github.com>
Co-authored-by: harvey <harvey@splitkb.com>
Co-authored-by: VeyPatch <126267034+VeyPatch@users.noreply.github.com>
2025-03-02 14:33:03 -07:00
QMK Bot
d0153368b8 Merge remote-tracking branch 'origin/master' into develop 2025-03-02 21:05:06 +00:00
Xelus22
563eb6fdc9 [Keyboard] Valor Rev3 (#22581)
* initial valor

* update

* fixup and move to info.json

* clean up keymap

* code review from lesshonor

* Update keyboards/xelus/valor/rev3/readme.md

Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>

* Update readme.md

* Update keyboards/xelus/valor/rev3/rev3.c

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

* Update rev3.c

* Remove custom rev3.c

* remove via keymap

* remove empty rules.mk

* Update keyboards/xelus/valor/rev3/keymaps/default/keymap.c

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

---------

Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Xelus22 <>
Co-authored-by: jack <jack@pngu.org>
2025-03-02 14:04:33 -07:00
QMK Bot
a076412b2b Merge remote-tracking branch 'origin/master' into develop 2025-03-02 01:00:30 +00:00
adophoxia
6c10839e33 Add Keychron C2 Pro V2 (#24900)
Same changes as for C1 Pro V2
2025-03-01 17:57:15 -07:00
QMK Bot
37c581690c Merge remote-tracking branch 'origin/master' into develop 2025-03-02 00:49:36 +00:00
adophoxia
abea50c26e Add Keychron C1 Pro V2 (#24899)
* Add C1 Pro V2

* Remove default values for f401xC generic board definition

* Update clang and copyright years

* Add version description
2025-03-01 17:48:59 -07:00
QMK Bot
ac70b81d3f Merge remote-tracking branch 'origin/master' into develop 2025-03-01 22:24:49 +00:00
blindassassin111
acec6904d8 Adding support for the VKR 94 (#24883)
* Adding support for the VKR 94

* Update keyboards/viktus/vkr94/keyboard.json

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

* Delete keyboards/viktus/vkr94/config.h

* Delete keyboards/viktus/vkr94/rules.mk

* Update readme.md

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2025-03-01 15:24:15 -07:00
QMK Bot
107f9a4cb3 Merge remote-tracking branch 'origin/master' into develop 2025-03-01 21:50:43 +00:00
suikagiken
655bf4008a Add keyboard suika15tone (#24947)
* Add keyboard suika15tone

* Update keyboards/suikagiken/suika15tone/keyboard.json

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

---------

Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-03-01 14:50:10 -07:00
QMK Bot
2f69eb5f8f Merge remote-tracking branch 'origin/master' into develop 2025-03-01 21:27:15 +00:00
era
516fa90f99 Add Chickpad (#24895)
* Add ChickPad

Add ChickPad

* Add Chickpad

Add Chickpad

* Add PCB image

Add PCB image

* Update keyboards/era/sirind/chickpad/keyboard.json

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

* Update keyboards/era/sirind/chickpad/config.h

Co-authored-by: jack <0x6a73@protonmail.com>

* Update keyboards/era/sirind/chickpad/keymaps/default/keymap.c

Co-authored-by: jack <0x6a73@protonmail.com>

* Update keyboards/era/sirind/chickpad/readme.md

Co-authored-by: jack <0x6a73@protonmail.com>

---------

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: jack <jack@pngu.org>
2025-03-01 14:25:26 -07:00
QMK Bot
5151abc298 Merge remote-tracking branch 'origin/master' into develop 2025-03-01 21:02:04 +00:00
Eric Banker
0419cd2eed [Docs] Fix example code in quantum_painter.md (#24897)
https://github.com/qmk/qmk_firmware/issues/24896
2025-03-01 14:01:30 -07:00
QMK Bot
cbfbd173d3 Merge remote-tracking branch 'origin/master' into develop 2025-03-01 21:00:36 +00:00
telybelly
a3a3af1184 Add Janky No.9 (#24910)
* Add Janky No.9

Add Janky No.9

* Update readme.md

* Update keyboard.json

updated as per waffle87 suggestions, and run qmk format-json

* Apply suggestions from code review

updated as per suggestions from zvecr

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

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2025-03-01 13:59:52 -07:00
QMK Bot
8606e78920 Merge remote-tracking branch 'origin/master' into develop 2025-03-01 20:48:45 +00:00
arcmags
88d1f61f10 Add tkl_f13_ansi_tsangan community layout to novelkeys/nk87* (#24730)
* missing LAYOUTS added to novelkeys/nk87*/rules.mk

* Revert "missing LAYOUTS added to novelkeys/nk87*/rules.mk"

This reverts commit 43917bfc36.

* missing community layouts added to novelkeys/nk87*/keyboard.json
2025-03-01 13:48:11 -07:00
QMK Bot
665a12b50e Merge remote-tracking branch 'origin/master' into develop 2025-03-01 20:47:51 +00:00
Danny
e0e96c2a75 Add Handwired Cherry Protype (#24806)
* Add handwired Cherry Protype

* Fix instructions

* Replace tabs with spaces

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

* Update keyboards/handwired/protype/keyboard.json

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

---------

Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-03-01 13:47:16 -07:00
QMK Bot
53e61900fe Merge remote-tracking branch 'origin/master' into develop 2025-02-28 19:08:29 +00:00
Dasky
a4d86a63f2 Add Mechboards Lily58 variant and common code. (#24937)
* Add lily58 and common code

* Apply suggestions from code review

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

* Apply suggestions from code review

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

---------

Co-authored-by: jack <jack@pngu.org>
2025-02-28 11:07:51 -08:00
Pablo Martínez
e62352e606 [Cleanup] Handling of optional *.mk files (#24952)
replace check + `include` with `-include`
2025-02-28 17:39:43 +00:00
Joel Challis
6ee806f376 Implement battery level interface (#24666)
Co-authored-by: Nick Brassel <nick@tzarc.org>
2025-02-28 16:46:14 +11:00
Nick Brassel
312f42945d Branch point for 2025q2 breaking change. 2025-02-28 09:26:13 +11:00
Nick Brassel
40b9dada5c Merge remote-tracking branch 'upstream/master' into develop 2025-02-28 09:24:51 +11:00
Nick Brassel
a63fd7f01c Merge remote-tracking branch 'upstream/develop' 2025-02-28 09:23:04 +11:00
Nick Brassel
cdb865cf60 Merge point for 2025q1 breaking change. 2025-02-28 09:20:58 +11:00
Joel Challis
c4aaab5fa3 2025q1 develop changelog (#24949)
Co-authored-by: Nick Brassel <nick@tzarc.org>
2025-02-28 09:14:32 +11:00
Nick Brassel
1efc82403b Community modules (#24848) 2025-02-26 22:25:41 +11:00
Joel Beckmeyer
63b095212b fix EEPROM driver for STM32L0/1 cat.1 devices (#24928) 2025-02-26 22:25:01 +11:00
Joel Challis
63daf94ee6 Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson (#24938) 2025-02-22 01:48:42 +00:00
ploopyco
50967dbe7e Updates to Ploopy Classic, Mouse, and Thumb for RP2040 hardware upgrade (#24880)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-02-21 00:01:29 -08:00
QMK Bot
2f27b3dc78 Merge remote-tracking branch 'origin/master' into develop 2025-02-20 14:07:54 +00:00
dependabot[bot]
6d0e5728aa Bump JamesIves/github-pages-deploy-action from 4.7.2 to 4.7.3 (#24933)
Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.7.2 to 4.7.3.
- [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases)
- [Commits](https://github.com/jamesives/github-pages-deploy-action/compare/v4.7.2...v4.7.3)

---
updated-dependencies:
- dependency-name: JamesIves/github-pages-deploy-action
  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-02-20 14:07:18 +00:00
QMK Bot
c592e10590 Merge remote-tracking branch 'origin/master' into develop 2025-02-18 16:05:34 +00:00
Juno Nguyen
a5c77b5c45 Fix startup sound for Planck (#24893) 2025-02-18 08:04:57 -08:00
Steve Storck
c00b0c5bc9 Created SH1107 driver for quantum painter (#24724)
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
2025-02-17 08:41:07 +11:00
Joel Challis
164b7331c3 Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson (#24915) 2025-02-17 08:39:29 +11:00
Nizhegorodtsev Vyacheslav Sergeyevich
132efa9076 Update for 'A-JAZZ AKC084' ('A-JAZZ AKP846') (#24868)
Fix indicators, image, bootloader instructions and default keymap for 'A-JAZZ AKC084'
2025-02-16 16:32:50 +00:00
HorrorTroll
d035f02c08 Patch up issue for inverted complementary output on Backlight (#24794)
Change complementary output to active high, when backlight on state is 1
2025-02-16 15:07:17 +00:00
QMK Bot
47e66c8a24 Merge remote-tracking branch 'origin/master' into develop 2025-02-16 10:24:35 +00:00
Nick Brassel
ad2c0f3565 Add more stale exemption labels. (#24922) 2025-02-16 21:24:01 +11:00
Joel Challis
110cc0923b Reject readme dummy content (#24913) 2025-02-16 10:22:57 +00:00
John
b69bf4b885 Retro Tapping Re-Write; Key Roll Fix (#23641) 2025-02-16 20:50:42 +11:00
DavidSannier
3ab2b3b6e2 Chaining OSL and MO (#23065) 2025-02-16 20:48:40 +11:00
QMK Bot
8ca303168e Merge remote-tracking branch 'origin/master' into develop 2025-02-15 04:56:34 +00:00
wmatex
5e88647879 Fix installation of clang in gentoo install script (#24917)
fix: sys-devel/clang was renamed to llvm-core/clang

see: 1f9f1999cd
2025-02-15 15:56:00 +11:00
Joel Challis
8400fad3d8 Remove readme dummy content (#24912) 2025-02-13 07:03:55 +00:00
Joel Challis
37e234252e Extend lint to reject 'blank' files (#23994) 2025-02-12 17:16:27 +00:00
QMK Bot
14c7164b01 Merge remote-tracking branch 'origin/master' into develop 2025-02-08 12:18:11 +00:00
Joel Challis
2699e2f7c8 Avoid WindowsPath errors for 'qmk format-text' (#24905) 2025-02-08 12:17:35 +00:00
Drashna Jaelre
7fe168a8ed [Keyboard] Move Ergodox STM32 to handwired folder (#24903)
* [Keyboard] Move Erogdox STM32 to handwired folder

To minimize confusion with ZSA's ergodox EZ ST (stm32f303) and because this is basically a one-off board

* Don't forget mapping

* Fix readme
2025-02-07 19:10:45 +11:00
Ryan
273d8d6a1a qmk docs: restore --port and --browser arguments (#24623)
* `qmk docs`: restore `--port` and `--browser` arguments

* Make docs command args always a list
2025-02-01 21:19:30 +11:00
QMK Bot
ff09b921f1 Merge remote-tracking branch 'origin/master' into develop 2025-01-29 19:30:22 +00:00
adophoxia
fa98117a3e Add Keychron C3 Pro (Red & RGB) (#24874)
* Add Keychron C3 Pro variants

* Update to upstream standards

* Apply suggestions from code review

Co-authored-by: jack <0x6a73@protonmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>

* Reformatted `keyboard.json` for `red`/`rgb` and `c3_pro.c`

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/keychron/c3_pro/ansi/red/config.h

Co-authored-by: Daniel <1767914+iamdanielv@users.noreply.github.com>

* Apply suggestions from code review

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

* Add C Pro V2 variants

* remove boards by accident

---------

Co-authored-by: jack <0x6a73@protonmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Daniel <1767914+iamdanielv@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-01-29 12:28:58 -07:00
QMK Bot
ae01f1b63e Merge remote-tracking branch 'origin/master' into develop 2025-01-29 19:28:06 +00:00
Joel Challis
0c14fc3a21 Resolve keyboard_aliases when processing keyboard make targets (#24834) 2025-01-30 06:22:05 +11:00
QMK Bot
db68fd88bd Merge remote-tracking branch 'origin/master' into develop 2025-01-29 19:21:51 +00:00
Joel Challis
7073ba3dbb Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson (#24845) 2025-01-30 06:21:09 +11:00
Nick Brassel
d7fb12164a Invoke process_record_via after _user/_kb have a chance to handle it. (#24879) 2025-01-30 06:18:07 +11:00
QMK Bot
cfcb8488ed Merge remote-tracking branch 'origin/master' into develop 2025-01-29 19:18:02 +00:00
Pascal Getreuer
9d799aff97 [Bug][Core] Fix for Chordal Hold: stuck mods when mod-taps are pressed in a stuttered sequence. (#24878) 2025-01-30 06:17:54 +11:00
Joy Lee
08dcc8856f Add more layout for skiller_sgk50_s4 (#24784)
* Add more layout for skiller_sgk50_s4

* Update skiller_sgk50_s4 default keymap

* update keymap.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keymap.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboard.json

* Update keyboard.json

* Update keyboard.json

* Update keyboard.json

---------

Co-authored-by: wb <wb@westberrytech.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2025-01-28 20:09:12 -07:00
muge
8afa3f2f08 Add CXT Studio 12E3 keyboard (#24749)
Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-01-28 18:18:41 -08:00
Joel Challis
c7904502e5 handwired/xealous - Remove DEFAULT_FOLDER (#24877) 2025-01-28 05:58:21 +00:00
Pascal Getreuer
544ddde113 [Core] Add Chordal Hold, an "opposite hands rule" tap-hold option similar to Achordion, Bilateral Combinations. (#24560)
* Chordal Hold: restrict what chords settle as hold

* Chordal Hold: docs and further improvements

* Fix formatting.

* Doc rewording and minor edit.

* Support Chordal Hold of multiple tap-hold keys.

* Fix formatting.

* Simplification and additional test.

* Fix formatting.

* Tighten tests.

* Add test two_mod_taps_same_hand_hold_til_timeout.

* Revise handing of pairs of tap-hold keys.

* Generate a default chordal_hold_layout.

* Document chordal_hold_handedness().

* Add license notice to new and branched files in PR.

* Add `tapping.chordal_hold` property for info.json.

* Update docs/reference_info_json.md

* Revise "hand" jsonschema.

* Chordal Hold: Improved layout handedness heuristic.

This commit improves the heuristic used in generate-keyboard-c for
inferring key handedness from keyboard.json geometry data.

Heuristic summary:

1. If the layout is symmetric (e.g. most split keyboards), guess the
   handedness based on the sign of (x - layout_x_midpoint).

2. Otherwise, if the layout has a key of >=6u width, it is probably the
   spacebar. Form a dividing line through the spacebar, nearly vertical
   but with a slight angle to follow typical row stagger.

3. Otherwise, assume handedness based on the widest horizontal
   separation.

I have tested this strategy on a couple dozen keyboards and found it to
work reliably.

* Use Optional instead of `| None`.

* Refactor to avoid lambdas.

* Remove trailing comma in chordal_hold_layout.

* Minor docs edits.

* Revise to allow combining multiple same-hand mods.

This commit revises Chordal Hold as described in discussion in
https://github.com/qmk/qmk_firmware/pull/24560#discussion_r1894655238

1. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓, RCTL_T(KC_A)↑" before the tapping
   term, RCTL_T(KC_A) is settled as tapped.
2. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓, RSFT_T(KC_C)↑", both RCTL_T(KC_A)
   and RSFT_T(KC_C) are settled as tapped.
3. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓, KC_U↓" (all keys on the same side),
   both RCTL_T(KC_A) and RSFT_T(KC_C) are settled as tapped.
4. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓, LSFT_T(KC_T)↓", with the third key
   on the other side, we allow Permissive Hold or Hold On Other Keypress
   to decide how/when to settle the keys.
5. In "RCTL_T(KC_A)↓, RSFT_T(KC_C)↓" held until the tapping term, the
   keys are settled as held.

1–3 provide same-hand roll protection. 4–5 are for combining multiple
same-hand modifiers.

I've updated the unit tests and have been running it on my keyboard, for
a few hours so far, and all seems good. I really like this scheme. It
allows combining same-side mods, yet it also has roll protection on
streaks. For me, this feels like Achordion, but clearly better streak
handling and improved responsiveness.

* Fix formatting.

* Add a couple tests with LT keys.

* Remove stale use of CHORDAL_HOLD_LAYOUT.

* Fix misspelling lastest -> latest

* Handling tweak for LTs and tests.

* Fix formatting.

* More tests with LT keys.

* Fix formatting.
2025-01-27 12:32:23 +01:00
Ryan
ee63d39058 Unify spi_master headers (#24857)
* Move default config to .c file

* Explicitly define PAL modes for boards with custom init

* Unify spi_master headers
2025-01-26 22:37:37 +01:00
QMK Bot
0747f887d6 Merge remote-tracking branch 'origin/master' into develop 2025-01-26 16:25:49 +00:00
Ryan
ef29a46c87 Unify i2c_master headers (#24846)
* Unify i2c_master headers

* More documentation improvements

* Reorganise PAL mode defaults
2025-01-26 13:48:46 +01:00
Ryan
291d154d7b Unify UART headers (#24855)
* Remove deprecated defines

* Move default config to .c files

* Unify UART headers

* Clean up docs

* Reorganise PAL mode defaults
2025-01-26 13:46:46 +01:00
QMK Bot
e4f736e685 Merge remote-tracking branch 'origin/master' into develop 2025-01-25 17:07:02 +00:00
QMK Bot
a2353df422 Merge remote-tracking branch 'origin/master' into develop 2025-01-25 15:59:13 +00:00
Ryan
a6e931400e Relocate base WS2812 code (#24850) 2025-01-25 17:38:12 +11:00
QMK Bot
2dd2d4eb81 Merge remote-tracking branch 'origin/master' into develop 2025-01-25 03:12:14 +00:00
QMK Bot
d908501478 Merge remote-tracking branch 'origin/master' into develop 2025-01-24 17:34:15 +00:00
QMK Bot
acb2f34c5c Merge remote-tracking branch 'origin/master' into develop 2025-01-21 00:01:34 +00:00
Ryan
68130cc8a5 ferris/0_1: update I2C API usage (#24839) 2025-01-20 22:53:46 +00:00
Ryan
a98070f212 [Docs] Correct I2C API reference (#24840) 2025-01-20 22:53:35 +00:00
Joel Challis
207dc01d49 rgbkb/pan - Remove invalid build target (#24844) 2025-01-20 22:47:42 +00:00
Joel Challis
1a30e2b32b Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson (#24835) 2025-01-20 22:26:25 +00:00
Nick Brassel
7431401116 Fix up CI with DEFAULT_FOLDER. (#24842) 2025-01-20 21:54:41 +00:00
QMK Bot
df8cdde782 Merge remote-tracking branch 'origin/master' into develop 2025-01-20 21:33:27 +00:00
Nick Brassel
a6a0dc8039 Consolidate send_string implementations. (#24817) 2025-01-21 08:24:39 +11:00
Ryan
47575d4af1 LED drivers: remove deprecated defines (#24837) 2025-01-20 15:30:19 +00:00
Joel Challis
5c33ff8be4 Remove DEFAULT_FOLDER where keyboard aliases already exists (#24838) 2025-01-20 15:24:14 +00:00
Joel Challis
7a0dbe36f3 Formally deprecate DEFAULT_FOLDER (#24836) 2025-01-20 04:55:01 +00:00
Joel Challis
d30cd87556 Update via2json layout macro searching (#24640) 2025-01-20 03:45:47 +00:00
Ryan
58aea4b479 i2c_master: remove deprecated functions (#24832) 2025-01-19 23:24:28 +00:00
Joel Challis
cedd49c59b Consolidate timer_elapsed implementations (#24830) 2025-01-19 17:07:11 +00:00
QMK Bot
a62f9a2ffd Merge remote-tracking branch 'origin/master' into develop 2025-01-18 17:53:08 +00:00
QMK Bot
ca737d4496 Merge remote-tracking branch 'origin/master' into develop 2025-01-18 06:19:51 +00:00
QMK Bot
92e660833f Merge remote-tracking branch 'origin/master' into develop 2025-01-18 04:02:51 +00:00
QMK Bot
1174d16b5a Merge remote-tracking branch 'origin/master' into develop 2025-01-15 19:36:54 +00:00
HorrorTroll
7f1c236c75 Bugfix and update for AT32F415 (#24807) 2025-01-13 21:20:36 -08:00
QMK Bot
eb29f8befc Merge remote-tracking branch 'origin/master' into develop 2025-01-13 00:40:15 +00:00
Dasky
62e98327d2 Azoteq - improve I2C behaviour while polling. (#24611)
Co-authored-by: Stefan Kerkmann <karlk90@pm.me>
2025-01-10 17:29:58 -08:00
QMK Bot
15bfe6240c Merge remote-tracking branch 'origin/master' into develop 2025-01-10 21:00:08 +00:00
Joel Challis
f9430e530b Ensure qmk flash rejects invalid files for uf2 compatible bootloaders (#24802)
Ensure 'qmk flash' rejects invalid files for uf2 compatible bootloaders
2025-01-10 16:21:07 +00:00
QMK Bot
9332439d5c Merge remote-tracking branch 'origin/master' into develop 2025-01-10 15:04:53 +00:00
Nick Brassel
9d2b416fe1 Update ChibiOS-Contrib. (#24803) 2025-01-09 17:53:44 +11:00
QMK Bot
e28799d790 Merge remote-tracking branch 'origin/master' into develop 2025-01-08 16:51:30 +00:00
HorrorTroll
c1565bebce Patch up issue when compile with APA102 driver (#24800) 2025-01-08 08:51:28 -08:00
QMK Bot
8247f9e114 Merge remote-tracking branch 'origin/master' into develop 2025-01-08 03:13:29 +00:00
QMK Bot
1cc42e8c6e Merge remote-tracking branch 'origin/master' into develop 2025-01-06 21:49:38 +00:00
Ryan
a336c04a6a macOS install: remove bad ARM toolchains (#24637) 2025-01-06 13:19:45 +11:00
Clocks
9339e3c35d Add watchdog service to RGBKB Sol 3 (#24786)
Due to power demands, the Sol 3 might get initially ignored or something by the attached device.

The solution is the enable watchdog, which would have the keyboard repoll the system to connect again.

I have been using watchdog for awhile, but given that the RGBKB developer never progressed #24279,
 I made this to add in the essential feature.
2025-01-05 21:46:58 +01:00
QMK Bot
5eb60827d5 Merge remote-tracking branch 'origin/master' into develop 2025-01-04 11:09:00 +00:00
QMK Bot
a25df1ab7a Merge remote-tracking branch 'origin/master' into develop 2025-01-04 08:42:05 +00:00
QMK Bot
28700b0a23 Merge remote-tracking branch 'origin/master' into develop 2025-01-04 00:24:15 +00:00
QMK Bot
e6a08dbc64 Merge remote-tracking branch 'origin/master' into develop 2025-01-03 20:33:57 +00:00
QMK Bot
69f4d2a086 Merge remote-tracking branch 'origin/master' into develop 2025-01-03 06:19:17 +00:00
Juho T.
43800d7934 Add Silakka54 keyboard (#24757)
* Added new keyboard Silakka54

* Update keyboards/silakka54/config.h

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

* Update keyboards/silakka54/keyboard.json

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

* Delete keyboards/silakka54/rules.mk

* Update keyboards/silakka54/keyboard.json

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

* Update keyboards/silakka54/config.h

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

* Update readme.md

Fixed small typo, "inpired" to "inspired"

---------

Co-authored-by: jack <jack@pngu.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-01-02 13:07:38 +01:00
QMK Bot
69faa4ff1a Merge remote-tracking branch 'origin/master' into develop 2025-01-02 11:54:10 +00:00
QMK Bot
b01db68476 Merge remote-tracking branch 'origin/master' into develop 2025-01-02 11:45:59 +00:00
フィルターペーパー
c23e64f551 Refactor Hue Breathing matrix effect with runner (#24525) 2025-01-02 02:23:41 -08:00
Will Spooner
b603094995 Add leader_add_user callback (#24266) 2025-01-01 23:12:58 -08:00
フィルターペーパー
e016b9b4c5 Update Raindrops effect to respect LED range limits (#24531) 2025-01-01 23:11:28 -08:00
David Hoelscher
c53d02d511 Ensure timer_read() is safe to call from interrupt handlers on ARM (#24529) 2025-01-01 23:11:10 -08:00
フィルターペーパー
cf975e2bfa Update Starlight matrix effects (#24521) 2025-01-01 23:10:34 -08:00
David Hoelscher
8157b37438 always return audio pin to 0 on ARM (#24503) 2025-01-01 23:10:07 -08:00
QMK Bot
d5a0424987 [CI] Regenerate Files (#24772)
Regenerate Files
2025-01-01 02:22:28 +00:00
QMK Bot
1e6eb5e35c Merge remote-tracking branch 'origin/master' into develop 2025-01-01 02:09:51 +00:00
QMK Bot
4d182ec117 Merge remote-tracking branch 'origin/master' into develop 2025-01-01 01:59:15 +00:00
QMK Bot
08c1c045f9 Merge remote-tracking branch 'origin/master' into develop 2024-12-31 12:36:59 +00:00
QMK Bot
efcd6187d1 Merge remote-tracking branch 'origin/master' into develop 2024-12-30 21:45:28 +00:00
QMK Bot
92534d8e3d Merge remote-tracking branch 'origin/master' into develop 2024-12-27 19:43:49 +00:00
QMK Bot
4d3d8887e7 Merge remote-tracking branch 'origin/master' into develop 2024-12-27 19:25:25 +00:00
muge
93de533580 Move cxt_studio keyboard to own folder (#24748) 2024-12-26 08:58:26 +00:00
QMK Bot
fc4d9c63fb Merge remote-tracking branch 'origin/master' into develop 2024-12-25 02:58:06 +00:00
QMK Bot
8037c7332c Merge remote-tracking branch 'origin/master' into develop 2024-12-24 18:26:40 +00:00
QMK Bot
1741901281 Merge remote-tracking branch 'origin/master' into develop 2024-12-24 18:06:18 +00:00
j-hap
38eb643a82 Add keymap-extras for EurKEY layout (#24241)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Stefan Kerkmann <karlk90@pm.me>
2024-12-23 23:23:51 -08:00
QMK Bot
b78bf7ec43 Merge remote-tracking branch 'origin/master' into develop 2024-12-24 07:23:00 +00:00
QMK Bot
a09f9bbb41 Merge remote-tracking branch 'origin/master' into develop 2024-12-24 07:14:13 +00:00
QMK Bot
c65dd3ba50 Merge remote-tracking branch 'origin/master' into develop 2024-12-24 07:13:28 +00:00
QMK Bot
d3585110a3 Merge remote-tracking branch 'origin/master' into develop 2024-12-24 06:27:16 +00:00
QMK Bot
1ed3878d15 Merge remote-tracking branch 'origin/master' into develop 2024-12-24 06:26:11 +00:00
Less/Rikki
b4ece24c7d move ymdk/id75 to revision (#24590) 2024-12-22 13:03:03 -08:00
QMK Bot
5c1c4874d7 Merge remote-tracking branch 'origin/master' into develop 2024-12-22 20:23:46 +00:00
Feags
32ea7025fb [Keyboard] Promenade fixes (#24705)
(Missing keys in matrix, other minor changes to keymap)

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: jack <0x6a73@protonmail.com>
2024-12-22 11:58:57 -08:00
QMK Bot
5f0ffd2704 Merge remote-tracking branch 'origin/master' into develop 2024-12-22 19:57:59 +00:00
QMK Bot
24e2466de3 Merge remote-tracking branch 'origin/master' into develop 2024-12-22 05:15:34 +00:00
QMK Bot
2c6a37021c Merge remote-tracking branch 'origin/master' into develop 2024-12-18 18:17:00 +00:00
QMK Bot
10cdcbd057 Merge remote-tracking branch 'origin/master' into develop 2024-12-18 05:02:42 +00:00
boessu
d3c9dff9d2 small refactoring of TIMER_DIFF (#24678)
A small refactoring of the defines TIMER_DIFF_8, TIMER_DIFF_16, TIMER_DIFF_32, TIMER_DIFF_RAW.
Removing obsolete TIMER_DIFF helper.
Discussion: https://github.com/qmk/qmk_firmware/issues/24652
2024-12-16 10:27:42 +01:00
Ryan
0f3993b9a3 default_keyboard.h generation tweaks (#24715) 2024-12-15 19:06:05 +00:00
Stefan Kerkmann
8e6bfbfdc2 [Core] chibios: usb_main: remove OTG sof workaround (#24259)
chibios: usb_main: remove OTG sof workaround

With the update of ChibiOS and ChibiOS-Contrib containing fixes for the
OTGv1 LLD the workaround is not necessarry anymore.

Signed-off-by: Stefan Kerkmann <karlk90@pm.me>
2024-12-15 18:42:43 +01:00
Nick Brassel
be6ff3af2b Update ChibiOS stable_21.11.x. (#24714) 2024-12-15 23:44:12 +11:00
QMK Bot
cb7608b9e2 Merge remote-tracking branch 'origin/master' into develop 2024-12-15 04:00:50 +00:00
QMK Bot
31631537d5 Merge remote-tracking branch 'origin/master' into develop 2024-12-14 23:16:27 +00:00
QMK Bot
77fb523fa5 Merge remote-tracking branch 'origin/master' into develop 2024-12-14 17:19:42 +00:00
QMK Bot
ad9efdaf0e Merge remote-tracking branch 'origin/master' into develop 2024-12-13 09:43:19 +00:00
フィルターペーパー
e1351b4f4b Subscript alef correction (#24707)
Output for U+0656 is AltGr + V
2024-12-12 11:01:50 -07:00
QMK Bot
76ac62c326 Merge remote-tracking branch 'origin/master' into develop 2024-12-12 17:59:41 +00:00
QMK Bot
56f4ba366e Merge remote-tracking branch 'origin/master' into develop 2024-12-11 20:30:14 +00:00
jack
0228806ae8 Change new-keymap keymap name prompt (#24701) 2024-12-11 12:28:30 -08:00
QMK Bot
1b5ae7aa71 Merge remote-tracking branch 'origin/master' into develop 2024-12-09 06:34:19 +00:00
QMK Bot
c7c91700b8 Merge remote-tracking branch 'origin/master' into develop 2024-12-09 06:32:41 +00:00
QMK Bot
af53c13d53 Merge remote-tracking branch 'origin/master' into develop 2024-12-09 06:22:24 +00:00
QMK Bot
86f8694580 Merge remote-tracking branch 'origin/master' into develop 2024-12-09 05:44:45 +00:00
QMK Bot
a683f10bff Merge remote-tracking branch 'origin/master' into develop 2024-12-09 03:30:58 +00:00
Joel Challis
68f67e23aa skyloong/gk61: Remove overriding of core keycode behaviour (#24655) 2024-12-08 06:35:12 -08:00
QMK Bot
001e190935 Merge remote-tracking branch 'origin/master' into develop 2024-12-08 06:06:35 +00:00
QMK Bot
e3000fabb7 Merge remote-tracking branch 'origin/master' into develop 2024-12-06 22:06:14 +00:00
QMK Bot
98291bc281 Merge remote-tracking branch 'origin/master' into develop 2024-12-06 05:44:06 +00:00
QMK Bot
55ea94832c Merge remote-tracking branch 'origin/master' into develop 2024-12-05 18:59:00 +00:00
QMK Bot
f4dc0c33cc Merge remote-tracking branch 'origin/master' into develop 2024-12-05 18:18:59 +00:00
QMK Bot
daf4746da7 Merge remote-tracking branch 'origin/master' into develop 2024-12-04 17:19:20 +00:00
QMK Bot
e64adcef7e Merge remote-tracking branch 'origin/master' into develop 2024-12-04 17:08:07 +00:00
QMK Bot
6992401770 Merge remote-tracking branch 'origin/master' into develop 2024-12-04 16:58:38 +00:00
QMK Bot
3d3f14044a Merge remote-tracking branch 'origin/master' into develop 2024-12-04 16:55:49 +00:00
QMK Bot
094933f002 Merge remote-tracking branch 'origin/master' into develop 2024-12-04 16:52:23 +00:00
QMK Bot
25da6bc359 Merge remote-tracking branch 'origin/master' into develop 2024-12-04 16:37:37 +00:00
QMK Bot
b6192ef8a0 Merge remote-tracking branch 'origin/master' into develop 2024-12-03 23:10:02 +00:00
QMK Bot
176aa00abb Merge remote-tracking branch 'origin/master' into develop 2024-12-03 22:48:59 +00:00
QMK Bot
fefb4180aa Merge remote-tracking branch 'origin/master' into develop 2024-12-03 22:40:41 +00:00
QMK Bot
0196298b10 Merge remote-tracking branch 'origin/master' into develop 2024-12-03 19:31:52 +00:00
QMK Bot
d44fe48a55 Merge remote-tracking branch 'origin/master' into develop 2024-12-03 18:36:17 +00:00
QMK Bot
6f2c032459 Merge remote-tracking branch 'origin/master' into develop 2024-12-03 07:47:37 +00:00
QMK Bot
2d5d3ac959 Merge remote-tracking branch 'origin/master' into develop 2024-12-03 07:35:59 +00:00
QMK Bot
7858f84366 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 21:26:44 +00:00
QMK Bot
384e42cb23 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 17:10:39 +00:00
QMK Bot
22849a59d4 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 16:49:47 +00:00
QMK Bot
750a3f1e60 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 16:49:00 +00:00
QMK Bot
777ae4fb8d Merge remote-tracking branch 'origin/master' into develop 2024-12-02 15:37:41 +00:00
QMK Bot
97870b27a1 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 15:33:45 +00:00
QMK Bot
0c176f6123 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 15:24:25 +00:00
QMK Bot
b3a1dc0658 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 15:07:28 +00:00
QMK Bot
2bfc0e07d1 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 14:58:10 +00:00
Drashna Jaelre
b599c78548 Fix Quantum Painter compiliation issues with heavy optimization (#24667) 2024-12-02 16:58:18 +11:00
QMK Bot
fa96609e0b Merge remote-tracking branch 'origin/master' into develop 2024-12-02 04:12:12 +00:00
QMK Bot
1d5de078c7 Merge remote-tracking branch 'origin/master' into develop 2024-12-02 04:01:40 +00:00
QMK Bot
aa9e48dae2 Merge remote-tracking branch 'origin/master' into develop 2024-12-01 19:25:16 +00:00
Nick Brassel
df9bf9efa1 Update ChibiOS to latest stable branch. (#24651) 2024-11-30 22:51:41 +11:00
QMK Bot
5b827356bb Merge remote-tracking branch 'origin/master' into develop 2024-11-30 05:31:16 +00:00
QMK Bot
0ae7639f6c Merge remote-tracking branch 'origin/master' into develop 2024-11-30 05:30:38 +00:00
Joel Challis
50491c44ca moky/moky88: Remove use of deprecated defines (#24656) 2024-11-29 13:51:16 -08:00
QMK Bot
653d1a5e37 Merge remote-tracking branch 'origin/master' into develop 2024-11-28 19:46:32 +00:00
Nick Brassel
b0ac5bcf91 Branch point for 2025q1 breaking change 2024-11-27 21:31:31 +11:00
Nick Brassel
f8ba76a771 Merge branch 'master' into develop 2024-11-27 21:30:59 +11:00
5245 changed files with 63422 additions and 30624 deletions

33
.clangd
View File

@@ -1,4 +1,33 @@
CompileFlags:
Add: [-Wno-unknown-attributes, -Wno-maybe-uninitialized, -Wno-unknown-warning-option]
Remove: [-W*, -mmcu=*, -mcpu=*, -mfpu=*, -mfloat-abi=*, -mno-unaligned-access, -mno-thumb-interwork, -mcall-prologues]
Add:
[
-Wno-unknown-attributes,
-Wno-maybe-uninitialized,
-Wno-unknown-warning-option,
-Wno-pointer-to-int-cast,
-Wno-int-to-void-pointer-cast,
-DPROGMEM=,
]
Remove:
[
-W*,
-mmcu=*,
-mcpu=*,
-mfpu=*,
-mfloat-abi=*,
-mno-unaligned-access,
-mno-thumb-interwork,
-mcall-prologues,
-D__has_include*,
-mlra,
]
Compiler: clang
Diagnostics:
UnusedIncludes: None
Suppress:
[
asm_invalid_output_constraint,
asm_invalid_input_constraint,
invalid_asm_value_for_constraint,
anyx86_interrupt_attribute,
]

4
.github/labeler.yml vendored
View File

@@ -54,3 +54,7 @@ dd:
- data/constants/**
- data/mappings/**
- data/schemas/**
community_module:
- changed-files:
- any-glob-to-any-file:
- modules/**

View File

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

View File

@@ -15,6 +15,7 @@ on:
- quantum/**/*
- tests/**/*
- tmk_core/**/*
- lib/python/**/*
- util/**/*
- Makefile
- '*.mk'
@@ -27,7 +28,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
fetch-depth: 0

View File

@@ -45,7 +45,7 @@ jobs:
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Determine concurrency
id: generate_slice_length
@@ -83,12 +83,12 @@ jobs:
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v4
uses: actions/checkout@v5
with:
fetch-depth: 0
- name: Download firmwares
uses: actions/download-artifact@v4
uses: actions/download-artifact@v5
with:
pattern: firmware-*
path: .

View File

@@ -37,7 +37,7 @@ jobs:
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Generate build targets
id: generate_targets
@@ -89,10 +89,10 @@ jobs:
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Get target definitions
uses: actions/download-artifact@v4
uses: actions/download-artifact@v5
with:
name: targets-${{ inputs.keymap }}
path: .
@@ -136,10 +136,10 @@ jobs:
steps:
- name: Checkout QMK Firmware
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Download firmwares
uses: actions/download-artifact@v4
uses: actions/download-artifact@v5
with:
pattern: firmware-${{ inputs.keymap }}-*
path: .

View File

@@ -24,7 +24,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
submodules: recursive

View File

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

View File

@@ -30,7 +30,7 @@ jobs:
container: ghcr.io/qmk/qmk_cli
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
fetch-depth: 1
@@ -56,7 +56,7 @@ jobs:
- name: Deploy
if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
uses: JamesIves/github-pages-deploy-action@v4.7.2
uses: JamesIves/github-pages-deploy-action@v4.7.3
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages

View File

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

View File

@@ -10,6 +10,7 @@ on:
- 'lib/arm_atsam/**'
- 'lib/lib8tion/**'
- 'lib/python/**'
- 'modules/**'
- 'platforms/**'
- 'quantum/**'
- 'tests/**'
@@ -25,7 +26,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
fetch-depth: 0
@@ -35,7 +36,7 @@ jobs:
- name: Get changed files
id: file_changes
uses: tj-actions/changed-files@v45
uses: tj-actions/changed-files@v46
with:
use_rest_api: true

View File

@@ -19,7 +19,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
fetch-depth: 0
@@ -39,7 +39,7 @@ jobs:
qmk format-text -a
git diff
- uses: rlespinasse/github-slug-action@v3.x
- uses: rlespinasse/github-slug-action@v5
- name: Become QMK Bot
run: |

View File

@@ -10,4 +10,4 @@ jobs:
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@v5
- uses: actions/labeler@v6

View File

@@ -18,7 +18,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
fetch-depth: 0
@@ -27,7 +27,7 @@ jobs:
- name: Get changed files
id: file_changes
uses: tj-actions/changed-files@v45
uses: tj-actions/changed-files@v46
with:
use_rest_api: true

View File

@@ -19,7 +19,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v4
- uses: actions/checkout@v5
- name: Run qmk generators
run: |

View File

@@ -19,14 +19,14 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v4
- uses: actions/checkout@v5
- name: Run qmk generators
run: |
util/regen.sh
git diff
- uses: rlespinasse/github-slug-action@v3.x
- uses: rlespinasse/github-slug-action@v5
- name: Become QMK Bot
run: |

View File

@@ -45,7 +45,7 @@ jobs:
stale-pr-label: stale
days-before-pr-stale: 45
days-before-pr-close: 30
exempt-pr-labels: bug,awaiting review,breaking_change,in progress,on hold
exempt-pr-labels: bug,awaiting review,breaking_change,in progress,on hold,needs-core-wireless,crippled-firmware
stale-pr-message: >
Thank you for your contribution!

View File

@@ -26,7 +26,7 @@ jobs:
container: ghcr.io/qmk/qmk_cli
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
submodules: recursive
- name: Install dependencies

1
.gitignore vendored
View File

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

27
.vscode/settings.json vendored
View File

@@ -10,6 +10,13 @@
"**/*.uf2": true
},
"files.associations": {
// QMK Filetypes
"keyboard.json": "jsonc",
"info.json": "jsonc",
"keymap.json": "jsonc",
"qmk.json": "jsonc",
"qmk_module.json": "jsonc",
// Standard filetypes
"*.h": "c",
"*.c": "c",
"*.inc": "c",
@@ -28,7 +35,23 @@
"[json]": {
"editor.formatOnSave": false
},
"clangd.arguments": [
"--header-insertion=never"
"clangd.arguments": ["--header-insertion=never"],
"json.schemas": [
{
"fileMatch": ["qmk.json"],
"url": "./data/schemas/user_repo_v1_1.jsonschema"
},
{
"fileMatch": ["qmk_module.json"],
"url": "./data/schemas/community_module.jsonschema"
},
{
"fileMatch": ["keyboard.json", "info.json"],
"url": "./data/schemas/keyboard.jsonschema"
},
{
"fileMatch": ["keymap.json"],
"url": "./data/schemas/keymap.jsonschema"
}
]
}

View File

@@ -59,6 +59,7 @@ ifeq ($(ROOT_DIR),)
endif
include paths.mk
include $(BUILDDEFS_PATH)/support.mk
TEST_OUTPUT_DIR := $(BUILD_DIR)/test
ERROR_FILE := $(BUILD_DIR)/error_occurred
@@ -113,6 +114,29 @@ endef
# Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
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
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))
TOKENr:=$$(shell python3 -c "import sys; print((sys.argv[1].split(':',1)+[''])[1])" $$(RULE))
TOKEN1:=$$(shell $(QMK_BIN) resolve-alias --allow-unknown $$(TOKEN1))
FOUNDx:=$$(shell echo $1 | tr " " "\n" | grep -Fx $$(TOKEN1))
ifneq ($$(FOUNDx),)
RULE := $$(TOKENr)
RULE_FOUND := true
MATCHED_ITEM := $$(TOKEN1)
else
RULE_FOUND := false
MATCHED_ITEM :=
endif
endef
# Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST_KB
TRY_TO_MATCH_RULE_FROM_LIST_KB = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER_KB,$1))$(RULE_FOUND)
define ALL_IN_LIST_LOOP
OLD_RULE$1 := $$(RULE)
$$(eval $$(call $1,$$(ITEM$1)))
@@ -138,7 +162,7 @@ define PARSE_RULE
$$(eval $$(call PARSE_TEST))
# If the rule starts with the name of a known keyboard, then continue
# the parsing from PARSE_KEYBOARD
else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(shell $(QMK_BIN) list-keyboards --no-resolve-defaults)),true)
else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST_KB,$$(shell $(QMK_BIN) list-keyboards)),true)
KEYBOARD_RULE=$$(MATCHED_ITEM)
$$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
else
@@ -170,17 +194,6 @@ define PARSE_KEYBOARD
# include the correct makefile to determine the actual name of it
CURRENT_KB := $1
# KEYBOARD_FOLDERS := $$(subst /, , $(CURRENT_KB))
DEFAULT_FOLDER := $$(CURRENT_KB)
# We assume that every rules.mk will contain the full default value
$$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/rules.mk)
ifneq ($$(DEFAULT_FOLDER),$$(CURRENT_KB))
$$(eval include $(ROOT_DIR)/keyboards/$$(DEFAULT_FOLDER)/rules.mk)
endif
CURRENT_KB := $$(DEFAULT_FOLDER)
# 5/4/3/2/1
KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
@@ -242,7 +255,7 @@ endef
# if we are going to compile all keyboards, match the rest of the rule
# for each of them
define PARSE_ALL_KEYBOARDS
$$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell $(QMK_BIN) list-keyboards --no-resolve-defaults)))
$$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell $(QMK_BIN) list-keyboards)))
endef
# Prints a list of all known keymaps for the given keyboard
@@ -434,7 +447,7 @@ git-submodules: git-submodule
.PHONY: list-keyboards
list-keyboards:
$(QMK_BIN) list-keyboards --no-resolve-defaults | tr '\n' ' '
$(QMK_BIN) list-keyboards | tr '\n' ' '
.PHONY: list-tests
list-tests:
@@ -442,7 +455,7 @@ list-tests:
.PHONY: generate-keyboards-file
generate-keyboards-file:
$(QMK_BIN) list-keyboards --no-resolve-defaults
$(QMK_BIN) list-keyboards
.PHONY: clean
clean:

View File

@@ -25,8 +25,6 @@ $(TEST_OUTPUT)_SRC := \
tests/test_common/test_driver.cpp \
tests/test_common/keyboard_report_util.cpp \
tests/test_common/mouse_report_util.cpp \
tests/test_common/keycode_util.cpp \
tests/test_common/keycode_table.cpp \
tests/test_common/test_fixture.cpp \
tests/test_common/test_keymap_key.cpp \
tests/test_common/test_logger.cpp \

View File

@@ -11,6 +11,7 @@ endif
.DEFAULT_GOAL := all
include paths.mk
include $(BUILDDEFS_PATH)/support.mk
include $(BUILDDEFS_PATH)/message.mk
# Helper to add defines with a 'QMK_' prefix
@@ -97,20 +98,44 @@ endif
# Pull in rules.mk files from all our subfolders
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/rules.mk)","")
include $(KEYBOARD_PATH_5)/rules.mk
-include $(KEYBOARD_PATH_5)/rules.mk
-include $(KEYBOARD_PATH_4)/rules.mk
-include $(KEYBOARD_PATH_3)/rules.mk
-include $(KEYBOARD_PATH_2)/rules.mk
-include $(KEYBOARD_PATH_1)/rules.mk
# Create dependencies on DD keyboard config - structure validated elsewhere
DD_CONFIG_FILES :=
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/rules.mk)","")
include $(KEYBOARD_PATH_4)/rules.mk
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/rules.mk)","")
include $(KEYBOARD_PATH_3)/rules.mk
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/rules.mk)","")
include $(KEYBOARD_PATH_2)/rules.mk
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/rules.mk)","")
include $(KEYBOARD_PATH_1)/rules.mk
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/keyboard.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/keyboard.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/keyboard.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/keyboard.json
endif
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)
@@ -207,17 +232,17 @@ ifneq ("$(wildcard $(KEYMAP_JSON))", "")
include $(INFO_RULES_MK)
# Add rules to generate the keymap files - indentation here is important
$(INTERMEDIATE_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
$(INTERMEDIATE_OUTPUT)/src/keymap.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/config.h: $(KEYMAP_JSON)
$(INTERMEDIATE_OUTPUT)/src/config.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-config-h --quiet --output $(KEYMAP_H) $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/keymap.h: $(KEYMAP_JSON)
$(INTERMEDIATE_OUTPUT)/src/keymap.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-keymap-h --quiet --output $(INTERMEDIATE_OUTPUT)/src/keymap.h $(KEYMAP_JSON))
@$(BUILD_CMD)
@@ -226,6 +251,44 @@ generated-files: $(INTERMEDIATE_OUTPUT)/src/config.h $(INTERMEDIATE_OUTPUT)/src/
endif
# Community modules
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)
$(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))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/community_modules.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-community-modules-c -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules.c $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-community-modules-introspection-c -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-community-modules-introspection-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-led-matrix-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(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)
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
include $(BUILDDEFS_PATH)/converters.mk
# Generate the board's version.h file.
@@ -315,6 +378,14 @@ endif
# Find all of the config.h files and add them to our CONFIG_H define.
CONFIG_H :=
define config_h_community_module_appender
ifneq ("$(wildcard $(1)/config.h)","")
CONFIG_H += $(1)/config.h
endif
endef
$(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call config_h_community_module_appender,$(module))))
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
CONFIG_H += $(KEYBOARD_PATH_5)/config.h
endif
@@ -332,6 +403,14 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_1)/config.h)","")
endif
POST_CONFIG_H :=
define post_config_h_community_module_appender
ifneq ("$(wildcard $(1)/post_config.h)","")
POST_CONFIG_H += $(1)/post_config.h
endif
endef
$(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call post_config_h_community_module_appender,$(module))))
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_config.h)","")
POST_CONFIG_H += $(KEYBOARD_PATH_1)/post_config.h
endif
@@ -348,40 +427,6 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
endif
# Create dependencies on DD keyboard config - structure validated elsewhere
DD_CONFIG_FILES :=
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/info.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/info.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/keyboard.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/keyboard.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/keyboard.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/keyboard.json
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/keyboard.json
endif
CONFIG_H += $(INTERMEDIATE_OUTPUT)/src/info_config.h
KEYBOARD_SRC += $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c
@@ -446,21 +491,18 @@ ifneq ("$(CONVERTER)","")
endif
# Pull in post_rules.mk files from all our subfolders
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_rules.mk)","")
include $(KEYBOARD_PATH_1)/post_rules.mk
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/post_rules.mk)","")
include $(KEYBOARD_PATH_2)/post_rules.mk
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/post_rules.mk)","")
include $(KEYBOARD_PATH_3)/post_rules.mk
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/post_rules.mk)","")
include $(KEYBOARD_PATH_4)/post_rules.mk
endif
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_rules.mk)","")
include $(KEYBOARD_PATH_5)/post_rules.mk
endif
-include $(KEYBOARD_PATH_1)/post_rules.mk
-include $(KEYBOARD_PATH_2)/post_rules.mk
-include $(KEYBOARD_PATH_3)/post_rules.mk
-include $(KEYBOARD_PATH_4)/post_rules.mk
-include $(KEYBOARD_PATH_5)/post_rules.mk
define post_rules_mk_community_module_includer
ifneq ("$(wildcard $(1)/post_rules.mk)","")
include $(1)/post_rules.mk
endif
endef
$(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call post_rules_mk_community_module_includer,$(module))))
ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
CONFIG_H += $(KEYMAP_PATH)/config.h

View File

@@ -7,6 +7,7 @@ endif
OPT = g
include paths.mk
include $(BUILDDEFS_PATH)/support.mk
include $(BUILDDEFS_PATH)/message.mk
TARGET=test/$(TEST_OUTPUT)
@@ -61,6 +62,7 @@ include $(BUILDDEFS_PATH)/common_features.mk
include $(BUILDDEFS_PATH)/generic_features.mk
include $(PLATFORM_PATH)/common.mk
include $(TMK_PATH)/protocol.mk
include $(QUANTUM_PATH)/battery/tests/rules.mk
include $(QUANTUM_PATH)/debounce/tests/rules.mk
include $(QUANTUM_PATH)/encoder/tests/rules.mk
include $(QUANTUM_PATH)/os_detection/tests/rules.mk

View File

@@ -29,6 +29,10 @@ QUANTUM_SRC += \
$(QUANTUM_DIR)/logging/debug.c \
$(QUANTUM_DIR)/logging/sendchar.c \
$(QUANTUM_DIR)/process_keycode/process_default_layer.c \
$(QUANTUM_DIR)/process_keycode/process_oneshot.c \
$(QUANTUM_DIR)/process_keycode/process_quantum.c \
include $(QUANTUM_DIR)/nvm/rules.mk
VPATH += $(QUANTUM_DIR)/logging
# Fall back to lib/printf if there is no platform provided print
@@ -169,9 +173,10 @@ endif
VALID_EEPROM_DRIVER_TYPES := vendor custom transient i2c spi wear_leveling legacy_stm32_flash
EEPROM_DRIVER ?= vendor
ifeq ($(filter $(EEPROM_DRIVER),$(VALID_EEPROM_DRIVER_TYPES)),)
ifneq ($(strip $(EEPROM_DRIVER)),none)
ifeq ($(filter $(EEPROM_DRIVER),$(VALID_EEPROM_DRIVER_TYPES)),)
$(call CATASTROPHIC_ERROR,Invalid EEPROM_DRIVER,EEPROM_DRIVER="$(EEPROM_DRIVER)" is not a valid EEPROM driver)
else
else
OPT_DEFS += -DEEPROM_ENABLE
COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/eeprom
COMMON_VPATH += $(DRIVER_PATH)/eeprom
@@ -216,7 +221,7 @@ else
COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
COMMON_VPATH += $(DRIVER_PATH)/flash
SRC += eeprom_driver.c eeprom_legacy_emulated_flash.c legacy_flash_ops.c
else ifneq ($(filter $(MCU_SERIES),STM32F1xx STM32F3xx STM32F4xx STM32L4xx STM32G4xx WB32F3G71xx WB32FQ95xx AT32F415 GD32VF103),)
else ifneq ($(filter $(MCU_SERIES),STM32F1xx STM32F3xx STM32F4xx STM32L4xx STM32G0xx STM32G4xx WB32F3G71xx WB32FQ95xx AT32F415 GD32VF103),)
# Wear-leveling EEPROM implementation, backed by MCU flash
OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
SRC += eeprom_driver.c eeprom_wear_leveling.c
@@ -245,6 +250,7 @@ else
SRC += eeprom.c
endif
endif
endif
endif
VALID_WEAR_LEVELING_DRIVER_TYPES := custom embedded_flash spi_flash rp2040_flash legacy
@@ -263,18 +269,14 @@ ifneq ($(strip $(WEAR_LEVELING_DRIVER)),none)
ifeq ($(strip $(WEAR_LEVELING_DRIVER)), embedded_flash)
OPT_DEFS += -DHAL_USE_EFL
SRC += wear_leveling_efl.c
POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling/wear_leveling_efl_config.h
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), spi_flash)
FLASH_DRIVER := spi
SRC += wear_leveling_flash_spi.c
POST_CONFIG_H += $(DRIVER_PATH)/wear_leveling/wear_leveling_flash_spi_config.h
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), rp2040_flash)
SRC += wear_leveling_rp2040_flash.c
POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_PATH)/wear_leveling/wear_leveling_rp2040_flash_config.h
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), legacy)
COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
SRC += legacy_flash_ops.c wear_leveling_legacy.c
POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling/wear_leveling_legacy_config.h
endif
endif
endif
@@ -633,6 +635,18 @@ ifeq ($(strip $(VIA_ENABLE)), yes)
RAW_ENABLE := yes
BOOTMAGIC_ENABLE := yes
TRI_LAYER_ENABLE := yes
ifeq ($(strip $(VIA_INSECURE)), yes)
OPT_DEFS += -DVIA_INSECURE
endif
endif
ifeq ($(strip $(RAW_ENABLE)), yes)
OPT_DEFS += -DRAW_ENABLE
SRC += raw_hid.c
endif
ifeq ($(strip $(DYNAMIC_KEYMAP_ENABLE)), yes)
SEND_STRING_ENABLE := yes
endif
VALID_CUSTOM_MATRIX_TYPES:= yes lite no
@@ -713,6 +727,7 @@ ifeq ($(strip $(LIB8TION_ENABLE)), yes)
# ATmegaxxU2 does not have hardware MUL instruction - lib8tion must be told to use software multiplication routines
OPT_DEFS += -DLIB8_ATTINY
endif
OPT_DEFS += -DFASTLED_SCALE8_FIXED=1 -DFASTLED_BLEND_FIXED=1
SRC += $(LIB_PATH)/lib8tion/lib8tion.c
endif
@@ -884,19 +899,19 @@ ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
OPT_DEFS += -DBLUETOOTH_ENABLE
OPT_DEFS += -DBLUETOOTH_$(strip $(shell echo $(BLUETOOTH_DRIVER) | tr '[:lower:]' '[:upper:]'))
NO_USB_STARTUP_CHECK := yes
CONNECTION_ENABLE := yes
COMMON_VPATH += $(DRIVER_PATH)/bluetooth
SRC += outputselect.c process_connection.c
SRC += $(DRIVER_PATH)/bluetooth/bluetooth.c
ifeq ($(strip $(BLUETOOTH_DRIVER)), bluefruit_le)
SPI_DRIVER_REQUIRED = yes
ANALOG_DRIVER_REQUIRED = yes
SRC += $(DRIVER_PATH)/bluetooth/bluetooth.c
SRC += $(DRIVER_PATH)/bluetooth/bluetooth_drivers.c
SRC += $(DRIVER_PATH)/bluetooth/bluefruit_le.cpp
endif
ifeq ($(strip $(BLUETOOTH_DRIVER)), rn42)
UART_DRIVER_REQUIRED = yes
SRC += $(DRIVER_PATH)/bluetooth/bluetooth.c
SRC += $(DRIVER_PATH)/bluetooth/bluetooth_drivers.c
SRC += $(DRIVER_PATH)/bluetooth/rn42.c
endif
endif
@@ -930,6 +945,32 @@ ifeq ($(strip $(DIP_SWITCH_ENABLE)), yes)
endif
endif
ifeq ($(strip $(BATTERY_ENABLE)), yes)
BATTERY_DRIVER_REQUIRED := yes
endif
VALID_BATTERY_DRIVER_TYPES := adc custom vendor
BATTERY_DRIVER ?= none
ifeq ($(strip $(BATTERY_DRIVER_REQUIRED)), yes)
ifeq ($(filter $(BATTERY_DRIVER),$(VALID_BATTERY_DRIVER_TYPES)),)
$(call CATASTROPHIC_ERROR,Invalid BATTERY_DRIVER,BATTERY_DRIVER="$(BATTERY_DRIVER)" is not a valid battery driver)
endif
OPT_DEFS += -DBATTERY_DRIVER_$(strip $(shell echo $(BATTERY_DRIVER) | tr '[:lower:]' '[:upper:]'))
COMMON_VPATH += $(DRIVER_PATH)/battery
ifneq ($(strip $(BATTERY_DRIVER)), custom)
SRC += battery_$(strip $(BATTERY_DRIVER)).c
endif
# add extra deps
ifeq ($(strip $(BATTERY_DRIVER)), adc)
ANALOG_DRIVER_REQUIRED = yes
endif
endif
VALID_WS2812_DRIVER_TYPES := bitbang custom i2c pwm spi vendor
WS2812_DRIVER ?= bitbang
@@ -940,6 +981,8 @@ ifeq ($(strip $(WS2812_DRIVER_REQUIRED)), yes)
OPT_DEFS += -DWS2812_$(strip $(shell echo $(WS2812_DRIVER) | tr '[:lower:]' '[:upper:]'))
COMMON_VPATH += $(DRIVER_PATH)/led
SRC += ws2812.c ws2812_$(strip $(WS2812_DRIVER)).c
ifeq ($(strip $(PLATFORM)), CHIBIOS)

View File

@@ -168,7 +168,7 @@ MOVE_DEP = mv -f $(patsubst %.o,%.td,$@) $(patsubst %.o,%.d,$@)
# For a ChibiOS build, ensure that the board files have the hook overrides injected
define BOARDSRC_INJECT_HOOKS
$(INTERMEDIATE_OUTPUT)/$(patsubst %.c,%.o,$(patsubst ./%,%,$1)): INIT_HOOK_CFLAGS += -include $(TOP_DIR)/tmk_core/protocol/chibios/init_hooks.h
$(INTERMEDIATE_OUTPUT)/$(patsubst %.c,%.o,$(patsubst ./%,%,$1)): FILE_SPECIFIC_CFLAGS += -include $(TOP_DIR)/tmk_core/protocol/chibios/init_hooks.h
endef
$(foreach LOBJ, $(BOARDSRC), $(eval $(call BOARDSRC_INJECT_HOOKS,$(LOBJ))))
@@ -289,10 +289,10 @@ $1/%.o : %.c $1/%.d $1/cflags.txt $1/compiler.txt | $(BEGIN)
ifneq ($$(VERBOSE_C_INCLUDE),)
$$(if $$(filter $$(notdir $$(VERBOSE_C_INCLUDE)),$$(notdir $$<)),$$(eval CC_EXEC += -H))
endif
$$(eval CMD := $$(CC_EXEC) -c $$($1_CFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
$$(eval CMD := $$(CC_EXEC) -c $$($1_CFLAGS) $$(FILE_SPECIFIC_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
@$$(BUILD_CMD)
ifneq ($$(DUMP_C_MACROS),)
$$(eval CMD := $$(CC) -E -dM $$($1_CFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$<)
$$(eval CMD := $$(CC) -E -dM $$($1_CFLAGS) $$(FILE_SPECIFIC_CFLAGS) $$(GENDEPFLAGS) $$<)
@$$(if $$(filter $$(notdir $$(DUMP_C_MACROS)),$$(notdir $$<)),$$(BUILD_CMD))
endif
@@ -300,13 +300,13 @@ $1/%.o : %.c $1/%.d $1/cflags.txt $1/compiler.txt | $(BEGIN)
$1/%.o : %.cpp $1/%.d $1/cxxflags.txt $1/compiler.txt | $(BEGIN)
@mkdir -p $$(@D)
@$$(SILENT) || printf "$$(MSG_COMPILING_CXX) $$<" | $$(AWK_CMD)
$$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
$$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(FILE_SPECIFIC_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
@$$(BUILD_CMD)
$1/%.o : %.cc $1/%.d $1/cxxflags.txt $1/compiler.txt | $(BEGIN)
@mkdir -p $$(@D)
@$$(SILENT) || printf "$$(MSG_COMPILING_CXX) $$<" | $$(AWK_CMD)
$$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
$$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(FILE_SPECIFIC_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
@$$(BUILD_CMD)
# Assemble: create object files from assembler source files.

View File

@@ -1,15 +1,3 @@
# Note for new boards -- CTPC and CONVERT_TO_PROTON_C are deprecated terms
# and should not be replicated for new boards. These will be removed from
# documentation as well as existing keymaps in due course.
ifneq ($(findstring yes, $(CTPC)$(CONVERT_TO_PROTON_C)),)
$(call CATASTROPHIC_ERROR,The `CONVERT_TO_PROTON_C` and `CTPC` options are now deprecated. `CONVERT_TO=proton_c` should be used instead.)
endif
ifneq (,$(filter $(MCU),atmega32u4))
# TODO: opt in rather than assume everything uses a pro micro
PIN_COMPATIBLE ?= promicro
endif
# Remove whitespace from any rule.mk provided vars
# - env cannot be overwritten but cannot have whitespace anyway
CONVERT_TO:=$(strip $(CONVERT_TO))

View File

@@ -1,7 +1,7 @@
{
"license": "GPL-2.0-or-later",
"devDependencies": {
"vite": "^5.4.12",
"vite": "^5.4.19",
"vitepress": "^1.1.0",
"vitepress-plugin-tabs": "^0.5.0",
"vue": "^3.4.24"

View File

@@ -766,10 +766,10 @@ tabbable@^6.2.0:
resolved "https://registry.yarnpkg.com/tabbable/-/tabbable-6.2.0.tgz#732fb62bc0175cfcec257330be187dcfba1f3b97"
integrity sha512-Cat63mxsVJlzYvN51JmVXIgNoUokrIaT2zLclCXjRd8boZ0004U4KCs/sToJ75C6sdlByWxpYnb5Boif1VSFew==
vite@^5.2.9, vite@^5.4.12:
version "5.4.12"
resolved "https://registry.yarnpkg.com/vite/-/vite-5.4.12.tgz#627d12ff06de3942557dfe8632fd712a12a072c7"
integrity sha512-KwUaKB27TvWwDJr1GjjWthLMATbGEbeWYZIbGZ5qFIsgPP3vWzLu4cVooqhm5/Z2SPDUMjyPVjTztm5tYKwQxA==
vite@^5.2.9, vite@^5.4.19:
version "5.4.19"
resolved "https://registry.yarnpkg.com/vite/-/vite-5.4.19.tgz#20efd060410044b3ed555049418a5e7d1998f959"
integrity sha512-qO3aKv3HoQC8QKiNSTuUM1l9o/XX3+c+VTgLHbJWHZGeTPVAg2XwazI9UWzoxjIJCGCV2zU60uqMzjeLZuULqA==
dependencies:
esbuild "^0.21.3"
postcss "^8.4.43"

View File

@@ -21,10 +21,12 @@ SPACE_CADET_ENABLE ?= yes
GENERIC_FEATURES = \
AUTO_SHIFT \
AUTOCORRECT \
BATTERY \
BOOTMAGIC \
CAPS_WORD \
COMBO \
COMMAND \
CONNECTION \
CRC \
DEFERRED_EXEC \
DIGITIZER \
@@ -34,6 +36,7 @@ GENERIC_FEATURES = \
DYNAMIC_TAPPING_TERM \
GRAVE_ESC \
HAPTIC \
KEYCODE_STRING \
KEY_LOCK \
KEY_OVERRIDE \
LAYER_LOCK \
@@ -60,6 +63,7 @@ define HANDLE_GENERIC_FEATURE
SRC += $$(wildcard $$(QUANTUM_DIR)/process_keycode/process_$2.c)
SRC += $$(wildcard $$(QUANTUM_DIR)/$2/$2.c)
SRC += $$(wildcard $$(QUANTUM_DIR)/$2.c)
SRC += $$(wildcard $$(QUANTUM_DIR)/nvm/$$(NVM_DRIVER_LOWER)/nvm_$2.c)
VPATH += $$(wildcard $$(QUANTUM_DIR)/$2/)
OPT_DEFS += -D$1_ENABLE
endef

11
builddefs/support.mk Normal file
View File

@@ -0,0 +1,11 @@
# Helper to determine if a compiler option is supported
# Args:
# $(1) = option to test, if successful will be output
# $(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; }; \
then echo "$(1)"; else echo "$(2)"; fi)
# Helper to pass comma character to make functions (use with `$(,)` to pass in `$(call ...)` arguments)
, := ,

View File

@@ -1,6 +1,7 @@
TEST_LIST = $(sort $(patsubst %/test.mk,%, $(shell find $(ROOT_DIR)tests -type f -name test.mk)))
FULL_TESTS := $(notdir $(TEST_LIST))
include $(QUANTUM_PATH)/battery/tests/testlist.mk
include $(QUANTUM_PATH)/debounce/tests/testlist.mk
include $(QUANTUM_PATH)/encoder/tests/testlist.mk
include $(QUANTUM_PATH)/os_detection/tests/testlist.mk

View File

@@ -0,0 +1,596 @@
{
"aliases": {
/*
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
* │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ │
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
* │ │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ \ │
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
* │ │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ │
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
* │ │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ │
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
* │ │ │ │ │ │ │ │ │
* └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
*/
"KC_GRV": {
"key": "EU_GRV",
"label": "`",
}
"KC_1": {
"key": "EU_1",
"label": "1",
}
"KC_2": {
"key": "EU_2",
"label": "2",
}
"KC_3": {
"key": "EU_3",
"label": "3",
}
"KC_4": {
"key": "EU_4",
"label": "4",
}
"KC_5": {
"key": "EU_5",
"label": "5",
}
"KC_6": {
"key": "EU_6",
"label": "6",
}
"KC_7": {
"key": "EU_7",
"label": "7",
}
"KC_8": {
"key": "EU_8",
"label": "8",
}
"KC_9": {
"key": "EU_9",
"label": "9",
}
"KC_0": {
"key": "EU_0",
"label": "0",
}
"KC_MINS": {
"key": "EU_MINS",
"label": "-",
}
"KC_EQL": {
"key": "EU_EQL",
"label": "=",
}
"KC_Q": {
"key": "EU_Q",
"label": "Q",
}
"KC_W": {
"key": "EU_W",
"label": "W",
}
"KC_E": {
"key": "EU_E",
"label": "E",
}
"KC_R": {
"key": "EU_R",
"label": "R",
}
"KC_T": {
"key": "EU_T",
"label": "T",
}
"KC_Y": {
"key": "EU_Y",
"label": "Y",
}
"KC_U": {
"key": "EU_U",
"label": "U",
}
"KC_I": {
"key": "EU_I",
"label": "I",
}
"KC_O": {
"key": "EU_O",
"label": "O",
}
"KC_P": {
"key": "EU_P",
"label": "P",
}
"KC_LBRC": {
"key": "EU_LBRC",
"label": "[",
}
"KC_RBRC": {
"key": "EU_RBRC",
"label": "]",
}
"KC_BSLS": {
"key": "EU_BSLS",
"label": "\\",
}
"KC_A": {
"key": "EU_A",
"label": "A",
}
"KC_S": {
"key": "EU_S",
"label": "S",
}
"KC_D": {
"key": "EU_D",
"label": "D",
}
"KC_F": {
"key": "EU_F",
"label": "F",
}
"KC_G": {
"key": "EU_G",
"label": "G",
}
"KC_H": {
"key": "EU_H",
"label": "H",
}
"KC_J": {
"key": "EU_J",
"label": "J",
}
"KC_K": {
"key": "EU_K",
"label": "K",
}
"KC_L": {
"key": "EU_L",
"label": "L",
}
"KC_SCLN": {
"key": "EU_SCLN",
"label": ";",
}
"KC_QUOT": {
"key": "EU_QUOT",
"label": "'",
}
"KC_Z": {
"key": "EU_Z",
"label": "Z",
}
"KC_X": {
"key": "EU_X",
"label": "X",
}
"KC_C": {
"key": "EU_C",
"label": "C",
}
"KC_V": {
"key": "EU_V",
"label": "V",
}
"KC_B": {
"key": "EU_B",
"label": "B",
}
"KC_N": {
"key": "EU_N",
"label": "N",
}
"KC_M": {
"key": "EU_M",
"label": "M",
}
"KC_COMM": {
"key": "EU_COMM",
"label": ",",
}
"KC_DOT": {
"key": "EU_DOT",
"label": ".",
}
"KC_SLSH": {
"key": "EU_SLSH",
"label": "/",
}
/* Shifted symbols
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
* │ ~ │ ! │ @ │ # │ $ │ % │ ^ │ & │ * │ ( │ ) │ _ │ + │ │
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
* │ │ │ │ │ │ │ │ │ │ │ │ { │ } │ | │
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
* │ │ │ │ │ │ │ │ │ │ │ : │ " │ │
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
* │ │ │ │ │ │ │ │ │ < │ > │ ? │ │
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
* │ │ │ │ │ │ │ │ │
* └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
*/
"S(EU_GRV)": {
"key": "EU_TILD",
"label": "~",
}
"S(EU_1)": {
"key": "EU_EXLM",
"label": "!",
}
"S(EU_2)": {
"key": "EU_AT",
"label": "@",
}
"S(EU_3)": {
"key": "EU_HASH",
"label": "#",
}
"S(EU_4)": {
"key": "EU_DLR",
"label": "$",
}
"S(EU_5)": {
"key": "EU_PERC",
"label": "%",
}
"S(EU_6)": {
"key": "EU_CIRC",
"label": "^",
}
"S(EU_7)": {
"key": "EU_AMPR",
"label": "&",
}
"S(EU_8)": {
"key": "EU_ASTR",
"label": "*",
}
"S(EU_9)": {
"key": "EU_LPRN",
"label": "(",
}
"S(EU_0)": {
"key": "EU_RPRN",
"label": ")",
}
"S(EU_MINS)": {
"key": "EU_UNDS",
"label": "_",
}
"S(EU_EQL)": {
"key": "EU_PLUS",
"label": "+",
}
"S(EU_LBRC)": {
"key": "EU_LCBR",
"label": "{",
}
"S(EU_RBRC)": {
"key": "EU_RCBR",
"label": "}",
}
"S(EU_BSLS)": {
"key": "EU_PIPE",
"label": "|",
}
"S(EU_SCLN)": {
"key": "EU_COLN",
"label": ":",
}
"S(EU_QUOT)": {
"key": "EU_DQUO",
"label": "\"",
}
"S(EU_COMM)": {
"key": "EU_LABK",
"label": "<",
}
"S(EU_DOT)": {
"key": "EU_RABK",
"label": ">",
}
"S(EU_SLSH)": {
"key": "EU_QUES",
"label": "?",
}
/* AltGr symbols
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
* │ ` │ ¡ │ ª │ º │ £ │ € │ ^ │ ˚ │ „ │ “ │ ” │ × │ │
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
* │ │ æ │ å │ ë │ ý │ þ │ ÿ │ ü │ ï │ ö │ œ │ « │ » │ ¬ │
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
* │ │ ä │ ß │ ð │ è │ é │ ù │ ú │ ij │ ø │ ° │ ´ │ │
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
* │ │ à │ á │ ç │ ì │ í │ ñ │ μ │ ò │ ó │ ¿ │ │
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
* │ │ │ │ │ │ │ │ │
* └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
*/
"ALGR(EU_GRV)": {
"key": "EU_DGRV",
"label": "` (dead)",
}
"ALGR(EU_1)": {
"key": "EU_IEXL",
"label": "¡",
}
"ALGR(EU_2)": {
"key": "EU_FORD",
"label": "ª",
}
"ALGR(EU_3)": {
"key": "EU_MORD",
"label": "º",
}
"ALGR(EU_4)": {
"key": "EU_PND",
"label": "£",
}
"ALGR(EU_5)": {
"key": "EU_EURO",
"label": "€",
}
"ALGR(EU_6)": {
"key": "EU_DCIR",
"label": "^ (dead)",
}
"ALGR(EU_7)": {
"key": "EU_RNGA",
"label": "˚ (dead)",
}
"ALGR(EU_8)": {
"key": "EU_DLQU",
"label": "„",
}
"ALGR(EU_9)": {
"key": "EU_LDQU",
"label": "“",
}
"ALGR(EU_0)": {
"key": "EU_RDQU",
"label": "”",
}
"ALGR(EU_MINS)": {
"key": "EU_NDSH",
"label": "",
}
"ALGR(EU_EQL)": {
"key": "EU_MUL",
"label": "×",
}
"ALGR(EU_Q)": {
"key": "EU_AE",
"label": "æ",
}
"ALGR(EU_W)": {
"key": "EU_ARNG",
"label": "Å",
}
"ALGR(EU_E)": {
"key": "EU_EDIA",
"label": "Ë",
}
"ALGR(EU_R)": {
"key": "EU_YACU",
"label": "Ý",
}
"ALGR(EU_T)": {
"key": "EU_THRN",
"label": "Þ",
}
"ALGR(EU_Y)": {
"key": "EU_YDIA",
"label": "Ÿ",
}
"ALGR(EU_U)": {
"key": "EU_UDIA",
"label": "Ü",
}
"ALGR(EU_I)": {
"key": "EU_IDIA",
"label": "Ï",
}
"ALGR(EU_O)": {
"key": "EU_ODIA",
"label": "Ö",
}
"ALGR(EU_P)": {
"key": "EU_OE",
"label": "Œ",
}
"ALGR(EU_LBRC)": {
"key": "EU_LDAQ",
"label": "«",
}
"ALGR(EU_RBRC)": {
"key": "EU_RDAQ",
"label": "»",
}
"ALGR(EU_BSLS)": {
"key": "EU_NOT",
"label": "¬",
}
"ALGR(EU_A)": {
"key": "EU_ADIA",
"label": "Ä",
}
"ALGR(EU_S)": {
"key": "EU_SS",
"label": "ß",
}
"ALGR(EU_D)": {
"key": "EU_ETH",
"label": "Ð",
}
"ALGR(EU_F)": {
"key": "EU_EGRV",
"label": "È",
}
"ALGR(EU_G)": {
"key": "EU_EACU",
"label": "É",
}
"ALGR(EU_H)": {
"key": "EU_UGRV",
"label": "Ù",
}
"ALGR(EU_J)": {
"key": "EU_UACU",
"label": "Ú",
}
"ALGR(EU_K)": {
"key": "EU_IJ",
"label": "IJ",
}
"ALGR(EU_L)": {
"key": "EU_OSTR",
"label": "Ø",
}
"ALGR(EU_SCLN)": {
"key": "EU_DEG",
"label": "°",
}
"ALGR(EU_QUOT)": {
"key": "EU_ACUT",
"label": "´ (dead)",
}
"ALGR(EU_Z)": {
"key": "EU_AGRV",
"label": "À",
}
"ALGR(EU_X)": {
"key": "EU_AACU",
"label": "Á",
}
"ALGR(EU_C)": {
"key": "EU_CCED",
"label": "Ç",
}
"ALGR(EU_V)": {
"key": "EU_IGRV",
"label": "Ì",
}
"ALGR(EU_B)": {
"key": "EU_IACU",
"label": "Í",
}
"ALGR(EU_N)": {
"key": "EU_NTIL",
"label": "Ñ",
}
"ALGR(EU_M)": {
"key": "EU_DGRK",
"label": "μ (dead Greek key)",
}
"ALGR(EU_COMM)": {
"key": "EU_OGRV",
"label": "Ò",
}
"ALGR(EU_DOT)": {
"key": "EU_OACU",
"label": "Ó",
}
"ALGR(EU_SLSH)": {
"key": "EU_IQUE",
"label": "¿",
}
/* Shift+AltGr symbols
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
* │ ~ │ ¹ │ ² │ ³ │ ¥ │ ¢ │ ˇ │ ¯ │ │ — │ ÷ │ │
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
* │ │ │ │ │ │ │ │ │ │ │ │ │ ¦ │
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
* │ │ │ § │ │ │ │ │ │ │ │ · │ ¨ │ │
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
* │ │ │ │ │ │ │ │ │ │ │ … │ │
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
* │ │ │ │ │ │ │ │ │
* └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
*/
"ALGR(EU_TILD)": {
"key": "EU_DTIL",
"label": "~ (dead)",
}
"S(ALGR(EU_1))": {
"key": "EU_SUP1",
"label": "¹",
}
"S(ALGR(EU_2))": {
"key": "EU_SUP2",
"label": "²",
}
"S(ALGR(EU_3))": {
"key": "EU_SUP3",
"label": "³",
}
"ALGR(EU_DLR)": {
"key": "EU_YEN",
"label": "¥",
}
"S(EU_EURO)": {
"key": "EU_CENT",
"label": "¢",
}
"S(EU_DCIR)": {
"key": "EU_CARN",
"label": "ˇ (dead)",
}
"S(ALGR(EU_7))": {
"key": "EU_MACR",
"label": "¯ (dead)",
}
"S(EU_DLQU)": {
"key": "EU_SLQU",
"label": "",
}
"S(EU_LDQU)": {
"key": "EU_LSQU",
"label": "",
}
"S(EU_RDQU)": {
"key": "EU_RSQU",
"label": "",
}
"S(EU_NDSH)": {
"key": "EU_MDSH",
"label": "—",
}
"S(EU_MUL)": {
"key": "EU_DIV",
"label": "÷",
}
"S(EU_LDAQ)": {
"key": "EU_LSAQ",
"label": "",
}
"S(EU_RDAQ)": {
"key": "EU_RSAQ",
"label": "",
}
"S(ALGR(EU_BSLS))": {
"key": "EU_BRKP",
"label": "¦",
}
"S(ALGR(EU_S))": {
"key": "EU_SECT",
"label": "§",
}
"S(ALGR(EU_SCLN))": {
"key": "EU_MDDT",
"label": "·",
}
"ALGR(EU_DQUO)": {
"key": "EU_DIAE",
"label": "¨ (dead)",
}
"ALGR(EU_QUES)": {
"key": "EU_ELLP",
"label": "…",
}
}
}

View File

@@ -527,7 +527,7 @@
"key": "FA_PIPE",
"label": "|",
}
"ALGR(FA_RA)": {
"ALGR(FA_RE)": {
"key": "FA_SUBA",
"label": "ٖ",
}

View File

@@ -0,0 +1,7 @@
{
"ranges": {
"0x77C0/0x003F": {
"define": "QK_COMMUNITY_MODULE"
}
}
}

View File

@@ -0,0 +1,25 @@
{
keyboard_pre_init: {
ret_type: void
args: void
}
keyboard_post_init: {
ret_type: void
args: void
}
pre_process_record: {
ret_type: bool
args: uint16_t keycode, keyrecord_t *record
call_params: keycode, record
}
process_record: {
ret_type: bool
args: uint16_t keycode, keyrecord_t *record
call_params: keycode, record
}
post_process_record: {
ret_type: void
args: uint16_t keycode, keyrecord_t *record
call_params: keycode, record
}
}

View File

@@ -0,0 +1,26 @@
{
housekeeping_task: {
ret_type: void
args: void
}
suspend_power_down: {
ret_type: void
args: void
}
suspend_wakeup_init: {
ret_type: void
args: void
}
shutdown: {
ret_type: bool
args: bool jump_to_bootloader
call_params: jump_to_bootloader
}
process_detected_host_os: {
ret_type: bool
args: os_variant_t os
call_params: os
guard: defined(OS_DETECTION_ENABLE)
header: os_detection.h
}
}

View File

@@ -0,0 +1,55 @@
{
pointing_device_init: {
ret_type: void
args: void
guard: defined(POINTING_DEVICE_ENABLE)
}
pointing_device_task: {
ret_type: report_mouse_t
args: report_mouse_t mouse_report
call_params: mouse_report
guard: defined(POINTING_DEVICE_ENABLE)
header: report.h
}
rgb_matrix_indicators: {
ret_type: bool
args: void
guard: defined(RGB_MATRIX_ENABLE)
header: rgb_matrix.h
}
rgb_matrix_indicators_advanced: {
ret_type: bool
args: uint8_t led_min, uint8_t led_max
call_params: led_min, led_max
guard: defined(RGB_MATRIX_ENABLE)
header: rgb_matrix.h
}
led_matrix_indicators: {
ret_type: bool
args: void
guard: defined(LED_MATRIX_ENABLE)
header: led_matrix.h
}
led_matrix_indicators_advanced: {
ret_type: bool
args: uint8_t led_min, uint8_t led_max
call_params: led_min, led_max
guard: defined(LED_MATRIX_ENABLE)
header: led_matrix.h
}
default_layer_state_set: {
ret_type: layer_state_t
args: layer_state_t state
call_params: state
guard: !defined(NO_ACTION_LAYER)
header: action_layer.h
}
layer_state_set: {
ret_type: layer_state_t
args: layer_state_t state
call_params: state
guard: !defined(NO_ACTION_LAYER)
header: action_layer.h
}
}

View File

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

View File

@@ -43,6 +43,14 @@
"BOOTMAGIC_ROW": {"info_key": "bootmagic.matrix.0", "value_type": "int"},
"BOOTMAGIC_ROW_RIGHT": {"info_key": "split.bootmagic.matrix.0", "value_type": "int"},
// Battery
"BATTERY_SAMPLE_INTERVAL": {"info_key": "battery.sample_interval", "value_type": "int"},
"BATTERY_ADC_PIN": {"info_key": "battery.adc.pin"},
"BATTERY_ADC_REF_VOLTAGE_MV": {"info_key": "battery.adc.reference_voltage", "value_type": "int"},
"BATTERY_ADC_VOLTAGE_DIVIDER_R1": {"info_key": "battery.adc.divider_r1", "value_type": "int"},
"BATTERY_ADC_VOLTAGE_DIVIDER_R2": {"info_key": "battery.adc.divider_r2", "value_type": "int"},
"BATTERY_ADC_RESOLUTION": {"info_key": "battery.adc.resolution", "value_type": "int"},
// Caps Word
"BOTH_SHIFTS_TURNS_ON_CAPS_WORD": {"info_key": "caps_word.both_shifts_turns_on", "value_type": "flag"},
"CAPS_WORD_IDLE_TIMEOUT": {"info_key": "caps_word.idle_timeout", "value_type": "int"},
@@ -64,6 +72,9 @@
"WEAR_LEVELING_BACKING_SIZE": {"info_key": "eeprom.wear_leveling.backing_size", "value_type": "int", "to_json": false},
"WEAR_LEVELING_LOGICAL_SIZE": {"info_key": "eeprom.wear_leveling.logical_size", "value_type": "int", "to_json": false},
// host
"NKRO_DEFAULT_ON": {"info_key": "host.default.nkro", "value_type": "bool"},
// Layer locking
"LAYER_LOCK_IDLE_TIMEOUT": {"info_key": "layer_lock.timeout", "value_type": "int"},
@@ -117,6 +128,7 @@
"MATRIX_HAS_GHOST": {"info_key": "matrix_pins.ghost", "value_type": "flag"},
"MATRIX_INPUT_PRESSED_STATE": {"info_key": "matrix_pins.input_pressed_state", "value_type": "int"},
"MATRIX_IO_DELAY": {"info_key": "matrix_pins.io_delay", "value_type": "int"},
"MATRIX_MASKED": {"info_key": "matrix_pins.masked", "value_type": "flag"},
// Mouse Keys
"MOUSEKEY_DELAY": {"info_key": "mousekey.delay", "value_type": "int"},
@@ -180,7 +192,7 @@
// Split Keyboard
"SOFT_SERIAL_PIN": {"info_key": "split.serial.pin"},
"SOFT_SERIAL_SPEED": {"info_key": "split.soft_serial_speed"},
"SELECT_SOFT_SERIAL_SPEED": {"info_key": "split.serial.speed"},
"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"},
@@ -200,6 +212,8 @@
"SPLIT_WPM_ENABLE": {"info_key": "split.transport.sync.wpm", "value_type": "flag"},
// Tapping
"CHORDAL_HOLD": {"info_key": "tapping.chordal_hold", "value_type": "flag"},
"FLOW_TAP_TERM": {"info_key": "tapping.flow_tap_term", "value_type": "int"},
"HOLD_ON_OTHER_KEY_PRESS": {"info_key": "tapping.hold_on_other_key_press", "value_type": "flag"},
"HOLD_ON_OTHER_KEY_PRESS_PER_KEY": {"info_key": "tapping.hold_on_other_key_press_per_key", "value_type": "flag"},
"PERMISSIVE_HOLD": {"info_key": "tapping.permissive_hold", "value_type": "flag"},
@@ -213,7 +227,6 @@
"TAPPING_TOGGLE": {"info_key": "tapping.toggle", "value_type": "int"},
// USB
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag"},
"USB_MAX_POWER_CONSUMPTION": {"info_key": "usb.max_power", "value_type": "int"},
"USB_POLLING_INTERVAL_MS": {"info_key": "usb.polling_interval", "value_type": "int"},
"USB_SUSPEND_WAKEUP_DELAY": {"info_key": "usb.suspend_wakeup_delay", "value_type": "int"},
@@ -251,6 +264,7 @@
"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
"VIAL_KEYBOARD_UID": {"info_key": "_invalid.vial_uid", "invalid": true},

View File

@@ -0,0 +1,74 @@
{
"bootmagic": {
"matrix": [0, 0]
},
"backlight": {
"default": {
"on": true
},
"breathing_period": 6,
"levels": 3,
"on_state": 1
},
"debounce": 5,
"features": {
"command": false,
"console": false
},
"indicators": {
"on_state": 1
},
"led_matrix": {
"default": {
"animation": "solid",
"on": true,
"val": 255,
"speed": 128
},
"led_flush_limit": 16,
"max_brightness": 255,
"sleep": false,
"speed_steps": 16,
"val_steps": 16
},
"rgblight": {
"default": {
"animation": "static_light",
"on": true,
"hue": 0,
"sat": 255,
"val": 255,
"speed": 0
},
"brightness_steps": 17,
"hue_steps": 8,
"max_brightness": 255,
"saturation_steps": 17,
"sleep": false
},
"rgb_matrix": {
"default": {
"animation": "cycle_left_right",
"on": true,
"hue": 0,
"sat": 255,
"val": 255,
"speed": 128
},
"hue_steps": 8,
"led_flush_limit": 16,
"max_brightness": 255,
"sat_steps": 16,
"sleep": false,
"speed_steps": 16,
"val_steps": 16
},
"split": {
"serial": {
"driver": "bitbang"
}
},
"ws2812": {
"driver": "bitbang"
}
}

View File

@@ -13,6 +13,7 @@
"AUDIO_DRIVER": {"info_key": "audio.driver"},
"BACKLIGHT_DRIVER": {"info_key": "backlight.driver"},
"BATTERY_DRIVER": {"info_key": "battery.driver"},
"BLUETOOTH_DRIVER": {"info_key": "bluetooth.driver"},
"BOARD": {"info_key": "board"},
"BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false},
@@ -53,7 +54,8 @@
"WS2812_DRIVER": {"info_key": "ws2812.driver"},
// Items we want flagged in lint
"CTPC": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
"CONVERT_TO_PROTON_C": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
"CTPC": {"info_key": "_invalid.ctpc", "invalid": true, "replace_with": "CONVERT_TO=proton_c"},
"CONVERT_TO_PROTON_C": {"info_key": "_invalid.ctpc", "invalid": true, "replace_with": "CONVERT_TO=proton_c"},
"DEFAULT_FOLDER": {"info_key": "_invalid.default_folder", "invalid": true},
"VIAL_ENABLE": {"info_key": "_invalid.vial", "invalid": true}
}

View File

@@ -68,6 +68,81 @@
"bakeneko80": {
"target": "kkatano/bakeneko80"
},
"bastardkb/charybdis/3x5/v2/elitec": {
"target": "bastardkb/charybdis/3x5/elitec"
},
"bastardkb/charybdis/3x5/v2/splinky_2": {
"target": "bastardkb/charybdis/3x5/elitec"
},
"bastardkb/charybdis/3x5/v2/splinky_3": {
"target": "bastardkb/charybdis/3x5/elitec"
},
"bastardkb/charybdis/3x5/v2/stemcell": {
"target": "bastardkb/charybdis/3x5/elitec"
},
"bastardkb/charybdis/3x6/v2/elitec": {
"target": "bastardkb/charybdis/3x6/elitec"
},
"bastardkb/charybdis/3x6/v2/splinky_2": {
"target": "bastardkb/charybdis/3x6/elitec"
},
"bastardkb/charybdis/3x6/v2/splinky_3": {
"target": "bastardkb/charybdis/3x6/elitec"
},
"bastardkb/charybdis/3x6/v2/stemcell": {
"target": "bastardkb/charybdis/3x6/elitec"
},
"bastardkb/charybdis/4x6/v2/elitec": {
"target": "bastardkb/charybdis/4x6/elitec"
},
"bastardkb/charybdis/4x6/v2/splinky_2": {
"target": "bastardkb/charybdis/4x6/elitec"
},
"bastardkb/charybdis/4x6/v2/splinky_3": {
"target": "bastardkb/charybdis/4x6/elitec"
},
"bastardkb/charybdis/4x6/v2/stemcell": {
"target": "bastardkb/charybdis/4x6/elitec"
},
"bastardkb/dilemma/3x5_2/splinky": {
"target": "bastardkb/dilemma/3x5_2/promicro"
},
"bastardkb/scylla/v2/elitec": {
"target": "bastardkb/scylla/promicro"
},
"bastardkb/scylla/v2/splinky_2": {
"target": "bastardkb/scylla/promicro"
},
"bastardkb/scylla/v2/splinky_3": {
"target": "bastardkb/scylla/promicro"
},
"bastardkb/scylla/v2/stemcell": {
"target": "bastardkb/scylla/promicro"
},
"bastardkb/skeletyl/v2/elitec": {
"target": "bastardkb/skeletyl/promicro"
},
"bastardkb/skeletyl/v2/splinky_2": {
"target": "bastardkb/skeletyl/promicro"
},
"bastardkb/skeletyl/v2/splinky_3": {
"target": "bastardkb/skeletyl/promicro"
},
"bastardkb/skeletyl/v2/stemcell": {
"target": "bastardkb/skeletyl/promicro"
},
"bastardkb/tbkmini/v2/elitec": {
"target": "bastardkb/tbkmini/promicro"
},
"bastardkb/tbkmini/v2/splinky_2": {
"target": "bastardkb/tbkmini/promicro"
},
"bastardkb/tbkmini/v2/splinky_3": {
"target": "bastardkb/tbkmini/promicro"
},
"bastardkb/tbkmini/v2/stemcell": {
"target": "bastardkb/tbkmini/promicro"
},
"bear_face": {
"target": "bear_face/v1"
},
@@ -140,9 +215,15 @@
"custommk/genesis": {
"target": "custommk/genesis/rev1"
},
"cxt_studio":{
"target":"cxt_studio/12e4"
},
"daisy": {
"target": "ktec/daisy"
},
"deemen17/de60": {
"target": "deemen17/de60/r1"
},
"dp3000": {
"target": "dp3000/rev1"
},
@@ -194,6 +275,9 @@
"ergodone": {
"target": "ktec/ergodone"
},
"ergodox_stm32": {
"target": "handwired/ergodox_stm32"
},
"ergoinu": {
"target": "dm9records/ergoinu"
},
@@ -248,44 +332,11 @@
"handwired/jscotto/scottostarter": {
"target": "handwired/scottokeebs/scottostarter"
},
"helix/pico/sc/back": {
"target": "helix/pico/sc"
"helix": {
"target": "helix/beta"
},
"helix/pico/sc/under": {
"target": "helix/pico/sc"
},
"helix/rev2/back/oled": {
"target": "helix/rev2/back"
},
"helix/rev2/oled": {
"target": "helix/rev2"
},
"helix/rev2/oled/back": {
"target": "helix/rev2/back"
},
"helix/rev2/oled/under": {
"target": "helix/rev2/under"
},
"helix/rev2/sc/back": {
"target": "helix/rev2/sc"
},
"helix/rev2/sc/oled": {
"target": "helix/rev2/sc"
},
"helix/rev2/sc/oledback": {
"target": "helix/rev2/sc"
},
"helix/rev2/sc/oledunder": {
"target": "helix/rev2/sc"
},
"helix/rev2/sc/under": {
"target": "helix/rev2/sc"
},
"helix/rev2/under": {
"target": "helix/rev2/sc"
},
"helix/rev2/under/oled": {
"target": "helix/rev2/under"
"helix/rev2": {
"target": "helix/beta"
},
"honeycomb": {
"target": "keyhive/honeycomb"
@@ -341,6 +392,9 @@
"keycapsss/plaid_pad": {
"target": "keycapsss/plaid_pad/rev1"
},
"keyten/kt60hs_t": {
"target": "keyten/kt60hs_t/v1"
},
"kira75": {
"target": "kira/kira75"
},
@@ -395,6 +449,9 @@
"lfkeyboards/smk65": {
"target": "lfkeyboards/smk65/revb"
},
"ll3macorn/bongopad": {
"target": "ll3ma/bongopad"
},
"m3v3van": {
"target": "matthewdias/m3n3van"
},
@@ -575,6 +632,9 @@
"ploopyco/trackball": {
"target": "ploopyco/trackball/rev1_005"
},
"plywrks/ply8x": {
"target": "plywrks/ply8x/solder"
},
"polilla": {
"target": "polilla/rev1"
},
@@ -1027,7 +1087,7 @@
"target": "kprepublic/bm68hsrgb/rev1"
},
"late9/rev1": {
"target": "rookiebwoy/late9/rev1"
"target": "ivndbt/late9/rev1"
},
"latin17rgb": {
"target": "latincompass/latin17rgb"
@@ -1192,7 +1252,7 @@
"target": "spaceholdings/nebula68b"
},
"neopad/rev1": {
"target": "rookiebwoy/neopad/rev1"
"target": "ivndbt/neopad/rev1"
},
"niu_mini": {
"target": "kbdfans/niu_mini"
@@ -1515,6 +1575,9 @@
"ymd96": {
"target": "ymdk/ymd96"
},
"ymdk/id75": {
"target": "ymdk/id75/f103"
},
"ymdk_np21": {
"target": "ymdk/np21"
},
@@ -1552,5 +1615,757 @@
},
"dnworks/9973": {
"target": "dnworks/tkl87"
},
// DEFAULT_FOLDER removed during 2025 Q1 cycle
"0_sixty": {
"target": "0_sixty/base"
},
"0xcb/splaytoraid": {
"target": "0xcb/splaytoraid/rp2040_ce"
},
"1upkeyboards/pi40": {
"target": "1upkeyboards/pi40/mit_v1_0"
},
"1upkeyboards/pi50": {
"target": "1upkeyboards/pi50/grid"
},
"1upkeyboards/sweet16": {
"target": "1upkeyboards/sweet16/v1"
},
"25keys/aleth42": {
"target": "25keys/aleth42/rev1"
},
"25keys/zinc": {
"target": "25keys/zinc/rev1"
},
"40percentclub/i75": {
"target": "40percentclub/i75/promicro"
},
"40percentclub/polyandry": {
"target": "40percentclub/polyandry/promicro"
},
"8pack": {
"target": "8pack/rev12"
},
"adkb96": {
"target": "adkb96/rev1"
},
"adm42": {
"target": "adm42/rev4"
},
"aeboards/satellite": {
"target": "aeboards/satellite/rev1"
},
"atreus": {
"target": "atreus/astar"
},
"atreyu": {
"target": "atreyu/rev1"
},
"biacco42/ergo42": {
"target": "biacco42/ergo42/rev1"
},
"binepad/bn009": {
"target": "binepad/bn009/r2"
},
"binepad/bnr1": {
"target": "binepad/bnr1/v2"
},
"boston_meetup": {
"target": "boston_meetup/2019"
},
"bpiphany/frosty_flake": {
"target": "bpiphany/frosty_flake/20140521"
},
"buzzard": {
"target": "buzzard/rev1"
},
"cannonkeys/db60": {
"target": "cannonkeys/db60/rev2"
},
"clickety_split/leeloo": {
"target": "clickety_split/leeloo/rev3"
},
"converter/palm_usb": {
"target": "converter/palm_usb/stowaway"
},
"crkbd": {
"target": "crkbd/rev1"
},
"dailycraft/bat43": {
"target": "dailycraft/bat43/rev2"
},
"dailycraft/claw44": {
"target": "dailycraft/claw44/rev1"
},
"dailycraft/sandbox": {
"target": "dailycraft/sandbox/rev2"
},
"dailycraft/wings42": {
"target": "dailycraft/wings42/rev2"
},
"delikeeb/vanana": {
"target": "delikeeb/vanana/rev2"
},
"delikeeb/waaffle/rev3": {
"target": "delikeeb/waaffle/rev3/pro_micro"
},
"deltasplit75": {
"target": "deltasplit75/v2"
},
"drhigsby/ogurec": {
"target": "drhigsby/ogurec/left_pm"
},
"duck/octagon": {
"target": "duck/octagon/v2"
},
"duck/orion": {
"target": "duck/orion/v3"
},
"ducky/one2mini": {
"target": "ducky/one2mini/1861st"
},
"ducky/one2sf": {
"target": "ducky/one2sf/1967st"
},
"dumbpad": {
"target": "dumbpad/v0x"
},
"durgod/galaxy": {
"target": "durgod/dgk6x/galaxy"
},
"durgod/venus": {
"target": "durgod/dgk6x/venus"
},
"dztech/tofu/ii": {
"target": "dztech/tofu/ii/v1"
},
"dztech/tofu/jr": {
"target": "dztech/tofu/jr/v1"
},
"eco": {
"target": "eco/rev2"
},
"ergoslab": {
"target": "ergoslab/rev1"
},
"ergotravel": {
"target": "ergotravel/rev1"
},
"evyd13/atom47": {
"target": "evyd13/atom47/rev4"
},
"fortitude60": {
"target": "fortitude60/rev1"
},
"fruitykeeb/fruitbar/r1": {
"target": "fruitykeeb/fruitbar/r1/promicro"
},
"ghs/jem": {
"target": "ghs/jem/soldered"
},
"hadron": {
"target": "hadron/ver2"
},
"handwired/bento": {
"target": "handwired/bento/rev1"
},
"handwired/dactyl_manuform/6x6": {
"target": "handwired/dactyl_manuform/6x6/promicro"
},
"handwired/meck_tkl": {
"target": "handwired/meck_tkl/blackpill_f401"
},
"handwired/ms_sculpt_mobile": {
"target": "handwired/ms_sculpt_mobile/teensy2pp"
},
"handwired/onekey": {
"target": "handwired/onekey/promicro"
},
"handwired/pill60": {
"target": "handwired/pill60/bluepill"
},
"handwired/postageboard": {
"target": "handwired/postageboard/mini"
},
"handwired/qc60": {
"target": "handwired/qc60/proto"
},
"handwired/sono1": {
"target": "handwired/sono1/t2pp"
},
"handwired/splittest": {
"target": "handwired/splittest/promicro"
},
"handwired/stef9998/split_5x7": {
"target": "handwired/stef9998/split_5x7/rev1"
},
"handwired/symmetric70_proto/promicro": {
"target": "handwired/symmetric70_proto/promicro/base"
},
"handwired/symmetric70_proto/proton_c": {
"target": "handwired/symmetric70_proto/proton_c/base"
},
"handwired/unk": {
"target": "handwired/unk/rev1"
},
"handwired/xealous": {
"target": "handwired/xealous/rev1"
},
"hillside/46": {
"target": "hillside/46/0_1"
},
"hhkb/ansi": {
"target": "hhkb/ansi/32u4"
},
"hillside/48": {
"target": "hillside/48/0_1"
},
"hillside/52": {
"target": "hillside/52/0_1"
},
"ibnuda/squiggle": {
"target": "ibnuda/squiggle/rev1"
},
"idobao/id80/v1": {
"target": "idobao/id80/v2/ansi"
},
"idobao/id80/v3": {
"target": "idobao/id80/v3/ansi"
},
"inett_studio/sq80": {
"target": "inett_studio/sq80/hotswap_layout_i"
},
"input_club/infinity60": {
"target": "input_club/infinity60/led"
},
"jacky_studio/bear_65": {
"target": "jacky_studio/bear_65/rev1"
},
"jacky_studio/piggy60/rev1": {
"target": "jacky_studio/piggy60/rev1/solder"
},
"jadookb/jkb65": {
"target": "jadookb/jkb65/r1"
},
"jian": {
"target": "jian/rev2"
},
"jiran": {
"target": "jiran/rev1"
},
"jorne": {
"target": "jorne/rev1"
},
"junco": {
"target": "junco/rev1"
},
"kakunpc/angel17": {
"target": "kakunpc/angel17/rev1"
},
"kakunpc/angel64": {
"target": "kakunpc/angel64/rev1"
},
"kakunpc/business_card": {
"target": "kakunpc/business_card/beta"
},
"kakunpc/suihankey": {
"target": "kakunpc/suihankey/rev1"
},
"kakunpc/suihankey/split": {
"target": "kakunpc/suihankey/split/rev1"
},
"kapcave/paladinpad": {
"target": "kapcave/paladinpad/rev2"
},
"kapl": {
"target": "kapl/rev1"
},
"kbdfans/d45": {
"target": "kbdfans/d45/v2"
},
"kbdfans/kbd75": {
"target": "kbdfans/kbd75/rev1"
},
"keebio/bdn9": {
"target": "keebio/bdn9/rev1"
},
"keebio/convolution": {
"target": "keebio/convolution/rev1"
},
"keebio/foldkb": {
"target": "keebio/foldkb/rev1"
},
"keebio/kbo5000": {
"target": "keebio/kbo5000/rev1"
},
"keebio/levinson": {
"target": "keebio/levinson/rev2"
},
"keebio/quefrency": {
"target": "keebio/quefrency/rev1"
},
"keebio/rorschach": {
"target": "keebio/rorschach/rev1"
},
"keebio/sinc": {
"target": "keebio/sinc/rev1"
},
"keebio/viterbi": {
"target": "keebio/viterbi/rev2"
},
"keycapsss/kimiko": {
"target": "keycapsss/kimiko/rev2"
},
"keyhive/navi10": {
"target": "keyhive/navi10/rev3"
},
"keyhive/uno": {
"target": "keyhive/uno/rev1"
},
"kin80": {
"target": "kin80/blackpill401"
},
"kprepublic/cstc40/daughterboard": {
"target": "kprepublic/cstc40/rev1"
},
"kprepublic/cstc40/single_pcb": {
"target": "kprepublic/cstc40/rev2"
},
"kumaokobo/kudox_full": {
"target": "kumaokobo/kudox_full/rev1"
},
"kumaokobo/kudox_game": {
"target": "kumaokobo/kudox_game/rev2"
},
"kumaokobo/kudox": {
"target": "kumaokobo/kudox/rev3"
},
"kumaokobo/pico": {
"target": "kumaokobo/pico/65keys"
},
"lazydesigners/dimple": {
"target": "lazydesigners/dimple/staggered/rev1"
},
"lets_split": {
"target": "lets_split/rev2"
},
"lfkeyboards/lfk87": {
"target": "lfkeyboards/lfk78/revc"
},
"lily58": {
"target": "lily58/rev1"
},
"lime": {
"target": "lime/rev1"
},
"maple_computing/christmas_tree": {
"target": "maple_computing/christmas_tree/v2017"
},
"maple_computing/ivy": {
"target": "maple_computing/ivy/rev1"
},
"maple_computing/launchpad": {
"target": "maple_computing/launchpad/rev1"
},
"maple_computing/minidox": {
"target": "maple_computing/minidox/rev1"
},
"mariorion_v25": {
"target": "mariorion_v25/prod"
},
"marksard/rhymestone": {
"target": "marksard/rhymestone/rev1"
},
"marksard/treadstone32": {
"target": "marksard/treadstone32/rev1"
},
"marksard/treadstone48": {
"target": "marksard/treadstone48/rev1"
},
"maxipad": {
"target": "maxipad/promicro"
},
"mechkeys/mechmini": {
"target": "mechkeys/mechmini/v2"
},
"mechllama/g35": {
"target": "mechllama/g35/v2"
},
"mechlovin/adelais": {
"target": "mechlovin/adelais/standard_led/arm/rev2"
},
"mechlovin/adelais/standard_led/arm/rev4": {
"target": "mechlovin/adelais/standard_led/arm/rev4/stm32f303"
},
"mechlovin/adelais/standard_led/arm": {
"target": "mechlovin/adelais/standard_led/arm/rev2"
},
"mechlovin/adelais/standard_led/avr": {
"target": "mechlovin/adelais/standard_led/avr/rev1"
},
"mechlovin/hannah65/rev1": {
"target": "mechlovin/hannah65/rev1/haus"
},
"mechlovin/infinity87/rev1": {
"target": "mechlovin/infinity87/rev1/standard"
},
"mechlovin/infinity87": {
"target": "mechlovin/infinity87/rgb_rev1"
},
"mechlovin/mechlovin9": {
"target": "mechlovin/mechlovin9/rev1"
},
"mechlovin/olly/jf": {
"target": "mechlovin/olly/jf/rev1"
},
"mechlovin/zed1800": {
"target": "mechlovin/zed1800/saber"
},
"mechlovin/zed65/no_backlight": {
"target": "mechlovin/zed65/no_backlight/wearhaus66"
},
"mechlovin/zed65": {
"target": "mechlovin/zed65/no_backlight/wearhaus66"
},
"mechwild/bde": {
"target": "mechwild/bde/rev2"
},
"mechwild/mokulua": {
"target": "mechwild/mokulua/standard"
},
"mechwild/obe/f401": {
"target": "mechwild/obe/f401/base"
},
"mechwild/obe/f411": {
"target": "mechwild/obe/f411/base"
},
"mechwild/obe": {
"target": "mechwild/obe/f401/base"
},
"mechwild/waka60/f401": {
"target": "mechwild/waka60/f401/base"
},
"mechwild/waka60/f411": {
"target": "mechwild/waka60/f411/base"
},
"mechwild/waka60": {
"target": "mechwild/waka60/f401/base"
},
"murcielago": {
"target": "murcielago/rev1"
},
"nullbitsco/scramble": {
"target": "nullbitsco/scramble/v2"
},
"omkbd/ergodash": {
"target": "omkbd/ergodash/rev1"
},
"omkbd/runner3680": {
"target": "omkbd/runner3680/5x8"
},
"orthodox": {
"target": "orthodox/rev3"
},
"peej/rosaline": {
"target": "peej/rosaline/staggered"
},
"peej/tripel": {
"target": "peej/tripel/left"
},
"peranekofactory/tone": {
"target": "peranekofactory/tone/rev2"
},
"phase_studio/titan65": {
"target": "phase_studio/titan65/hotswap"
},
"pica40": {
"target": "pica40/rev2"
},
"pinky": {
"target": "pinky/3"
},
"ploopyco/madromys": {
"target": "ploopyco/madromys/rev1_001"
},
"ploopyco/trackball_mini": {
"target": "ploopyco/trackball_mini/rev1_001"
},
"ploopyco/trackball_nano": {
"target": "ploopyco/trackball_nano/rev1_001"
},
"ploopyco/trackball_thumb": {
"target": "ploopyco/trackball_thumb/rev1_001"
},
"primekb/meridian": {
"target": "primekb/meridian/ktr1010"
},
"primekb/prime_e": {
"target": "primekb/prime_e/std"
},
"program_yoink": {
"target": "program_yoink/staggered"
},
"projectcain/vault35": {
"target": "projectcain/vault35/atmega32u4"
},
"qpockets/space_space": {
"target": "qpockets/space_space/rev2"
},
"qwertyydox": {
"target": "qwertyydox/rev1"
},
"rate/pistachio": {
"target": "rate/pistachio/rev2"
},
"recompile_keys/choco60": {
"target": "recompile_keys/choco60/rev1"
},
"recompile_keys/nomu30": {
"target": "recompile_keys/nomu30/rev1"
},
"redox/rev1": {
"target": "redox/rev1/base"
},
"rgbkb/mun": {
"target": "rgbkb/mun/rev1"
},
"rgbkb/sol3": {
"target": "rgbkb/sol3/rev1"
},
"rgbkb/sol": {
"target": "rgbkb/sol/rev2"
},
"rgbkb/zen": {
"target": "rgbkb/zen/rev2"
},
"rgbkb/zygomorph": {
"target": "rgbkb/zygomorph/rev1"
},
"rmi_kb/herringbone": {
"target": "rmi_kb/herringbone/v1"
},
"rmi_kb/mona": {
"target": "rmi_kb/mona/v1_1"
},
"rmi_kb/tkl_ff": {
"target": "rmi_kb/tkl_ff/v1"
},
"rmi_kb/wete": {
"target": "rmi_kb/wete/v2"
},
"rookiebwoy/late9": {
"target": "ivndbt/late9/rev1"
},
"rookiebwoy/neopad": {
"target": "ivndbt/neopad/rev1"
},
"ivndbt/late9": {
"target": "ivndbt/late9/rev1"
},
"ivndbt/neopad": {
"target": "ivndbt/neopad/rev1"
},
"rura66": {
"target": "rura66/rev1"
},
"salicylic_acid3/7skb": {
"target": "salicylic_acid3/7skb/rev1"
},
"salicylic_acid3/getta25": {
"target": "salicylic_acid3/getta25/rev1"
},
"salicylic_acid3/jisplit89": {
"target": "salicylic_acid3/jisplit89/rev1"
},
"salicylic_acid3/naked48": {
"target": "salicylic_acid3/naked48/rev1"
},
"salicylic_acid3/naked60": {
"target": "salicylic_acid3/naked60/rev1"
},
"salicylic_acid3/naked64": {
"target": "salicylic_acid3/naked64/rev1"
},
"salicylic_acid3/setta21": {
"target": "salicylic_acid3/setta21/rev1"
},
"sawnsprojects/okayu": {
"target": "sawnsprojects/okayu/stm32f072"
},
"smoll/lefty": {
"target": "smoll/lefty/rev2"
},
"sofle": {
"target": "sofle/rev1"
},
"spaceholdings/nebula68b": {
"target": "spaceholdings/nebula68b/solder"
},
"spacetime": {
"target": "spacetime/rev1"
},
"splitkb/aurora/corne": {
"target": "splitkb/aurora/corne/rev1"
},
"splitkb/aurora/helix": {
"target": "splitkb/aurora/helix/rev1"
},
"splitkb/aurora/lily58": {
"target": "splitkb/aurora/lily58/rev1"
},
"splitkb/aurora/sofle_v2": {
"target": "splitkb/aurora/sofle_v2/rev1"
},
"splitkb/aurora/sweep": {
"target": "splitkb/aurora/sweep/rev1"
},
"splitkb/kyria": {
"target": "splitkb/kyria/rev3"
},
"splitkb/kyria/rev1": {
"target": "splitkb/kyria/rev1/base"
},
"splitkb/kyria/rev2": {
"target": "splitkb/kyria/rev2/base"
},
"splitty": {
"target": "splitty/rev1"
},
"studiokestra/galatea": {
"target": "studiokestra/galatea/rev1"
},
"takashiski/hecomi": {
"target": "takashiski/hecomi/alpha"
},
"takashiski/namecard2x4": {
"target": "takashiski/namecard2x4/rev2"
},
"teleport/native": {
"target": "teleport/native/iso"
},
"themadnoodle/noodlepad": {
"target": "themadnoodle/noodlepad/v1"
},
"tkw/grandiceps": {
"target": "tkw/grandiceps/rev1"
},
"tominabox1/le_chiffre": {
"target": "tominabox1/le_chiffre/rev1"
},
"tominabox1/littlefoot_lx": {
"target": "tominabox1/littlefoot_lx/rev1"
},
"tominabox1/underscore33": {
"target": "tominabox1/underscore33/rev1"
},
"trnthsn/e8ghty": {
"target": "trnthsn/e8ghty/stm32f103"
},
"trnthsn/s6xty5neor2": {
"target": "trnthsn/s6xty5neor2/stm32f103"
},
"tweetydabird/lotus58/elite_c": {
"target": "tweetydabird/lotus58"
},
"tweetydabird/lotus58/nanoboot": {
"target": "tweetydabird/lotus58"
},
"tweetydabird/lotus58/promicro": {
"target": "tweetydabird/lotus58"
},
"tweetydabird/lotus58/rp2040_ce": {
"target": "tweetydabird/lotus58"
},
"unison": {
"target": "unison/v04"
},
"uzu42": {
"target": "uzu42/rev1"
},
"vitamins_included": {
"target": "vitamins_included/rev2"
},
"westm/westm68": {
"target": "westm/westm68/rev2"
},
"westm/westm9": {
"target": "westm/westm9/rev2"
},
"woodkeys/meira": {
"target": "woodkeys/meira/promicro"
},
"work_louder/loop": {
"target": "work_louder/loop/rev3"
},
"work_louder/work_board": {
"target": "work_louder/work_board/rev3"
},
"yanghu/unicorne": {
"target": "yanghu/unicorne/f411"
},
"yosino58": {
"target": "yosino58/rev1"
},
"ymdk/yd60mq": {
"target": "ymdk/yd60mq/12led"
},
"yushakobo/navpad/10": {
"target": "yushakobo/navpad/10/rev1"
},
"yynmt/acperience12": {
"target": "yynmt/acperience12/rev1"
},
"zsa/planck_ez": {
"target": "zsa/planck_ez/base"
},
// DEFAULT_FOLDER removed during 2025 Q3 cycle
"cannonkeys/satisfaction75": {
"target": "cannonkeys/satisfaction75/rev1"
},
"converter/adb_usb": {
"target": "converter/adb_usb/rev1"
},
"converter/sun_usb": {
"target": "converter/sun_usb/type5"
},
"converter/usb_usb": {
"target": "converter/usb_usb/hasu"
},
"durgod/dgk6x": {
"target": "durgod/dgk6x/hades_ansi"
},
"ergodox_ez": {
"target": "ergodox_ez/base"
},
"ferris/0_2": {
"target": "ferris/0_2/base"
},
"handwired/dygma/raise": {
"target": "handwired/dygma/raise/ansi"
},
"helix/rev3_4rows": {
"target": "helix/rev3"
},
"helix/rev3_5rows": {
"target": "helix/rev3"
},
"ibm/model_m/mschwingen": {
"target": "ibm/model_m/mschwingen/led_wired"
},
"mechwild/sugarglider": {
"target": "mechwild/sugarglider/wide_oled/f401"
},
"mechwild/sugarglider/wide_oled": {
"target": "mechwild/sugarglider/wide_oled/f401"
},
"novelkeys/nk65": {
"target": "novelkeys/nk65/v1"
},
"novelkeys/nk65/base": {
"target": "novelkeys/nk65/v1"
},
"sirius/uni660/rev2": {
"target": "sirius/uni660/rev2/ansi"
}
}

View File

@@ -1,7 +1,7 @@
{
"$id": "qmk.api.keyboard.v1",
"allOf": [
{"$ref": "qmk.keyboard.v1"},
{"$ref": "./keyboard.jsonschema#"},
{
"properties": {
"keymaps": {
@@ -10,8 +10,8 @@
"url": {"type": "string"}
}
},
"parse_errors": {"$ref": "qmk.definitions.v1#/string_array"},
"parse_warnings": {"$ref": "qmk.definitions.v1#/string_array"},
"parse_errors": {"$ref": "./definitions.jsonschema#/string_array"},
"parse_warnings": {"$ref": "./definitions.jsonschema#/string_array"},
"processor_type": {"type": "string"},
"protocol": {"type": "string"},
"keyboard_folder": {"type": "string"},

View File

@@ -0,0 +1,18 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"$id": "qmk.community_module.v1",
"title": "Community Module Information",
"type": "object",
"required": ["module_name", "maintainer"],
"properties": {
"module_name": {"$ref": "./definitions.jsonschema#/text_identifier"},
"maintainer": {"$ref": "./definitions.jsonschema#/text_identifier"},
"license": {"type": "string"},
"url": {
"type": "string",
"format": "uri"
},
"keycodes": {"$ref": "./definitions.jsonschema#/keycode_decl_array"},
"features": {"$ref": "./keyboard.jsonschema#/definitions/features_config"}
}
}

View File

@@ -17,9 +17,9 @@
"additionalProperties": false,
"required": ["pin_a", "pin_b"],
"properties": {
"pin_a": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"pin_b": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"resolution": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"pin_a": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"pin_b": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"resolution": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
}
}
@@ -28,17 +28,22 @@
"dip_switch_config": {
"type": "object",
"properties": {
"pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
"pins": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
}
},
"features_config": {
"$ref": "./definitions.jsonschema#/boolean_array",
"propertyNames": {"$ref": "./definitions.jsonschema#/snake_case"},
"not": {"required": ["lto"]}
}
},
"type": "object",
"not": {"required": ["vendorId", "productId"]}, // reject via keys...
"properties": {
"keyboard_name": {"$ref": "qmk.definitions.v1#/text_identifier"},
"keyboard_folder": {"$ref": "qmk.definitions.v1#/keyboard"},
"maintainer": {"$ref": "qmk.definitions.v1#/text_identifier"},
"manufacturer": {"$ref": "qmk.definitions.v1#/text_identifier"},
"keyboard_name": {"$ref": "./definitions.jsonschema#/text_identifier"},
"keyboard_folder": {"$ref": "./definitions.jsonschema#/keyboard"},
"maintainer": {"$ref": "./definitions.jsonschema#/text_identifier"},
"manufacturer": {"$ref": "./definitions.jsonschema#/text_identifier"},
"url": {
"type": "string",
"format": "uri"
@@ -79,6 +84,7 @@
"STM32F407",
"STM32F411",
"STM32F446",
"STM32G0B1",
"STM32G431",
"STM32G474",
"STM32H723",
@@ -113,8 +119,8 @@
"type": "object",
"additionalProperties": false,
"properties": {
"data_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"clock_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"data_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"clock_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"default_brightness": {
"type": "integer",
"minimum": 0,
@@ -139,13 +145,13 @@
"enum": ["dac_additive", "dac_basic", "pwm_software", "pwm_hardware"]
},
"macro_beep": {"type": "boolean"},
"pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
"pins": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
"power_control": {
"type": "object",
"additionalProperties": false,
"properties": {
"on_state": {"$ref": "qmk.definitions.v1#/bit"},
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"}
"on_state": {"$ref": "./definitions.jsonschema#/bit"},
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"}
}
},
"voices": {"type": "boolean"}
@@ -165,23 +171,45 @@
"properties": {
"on": {"type": "boolean"},
"breathing": {"type": "boolean"},
"brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
"brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
}
},
"breathing": {"type": "boolean"},
"breathing_period": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"breathing_period": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"levels": {
"type": "integer",
"minimum": 1,
"maximum": 31
},
"max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
"on_state": {"$ref": "qmk.definitions.v1#/bit"},
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"pins": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
"on_state": {"$ref": "./definitions.jsonschema#/bit"},
"as_caps_lock": {"type": "boolean"}
}
},
"battery": {
"type": "object",
"additionalProperties": false,
"properties": {
"driver": {
"type": "string",
"enum": ["adc", "custom", "vendor"]
},
"adc": {
"type": "object",
"additionalProperties": false,
"properties": {
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"reference_voltage": {"type": "integer"},
"divider_r1": {"type": "integer"},
"divider_r2": {"type": "integer"},
"resolution": {"type": "integer"}
}
},
"sample_interval": {"type": "integer"}
}
},
"bluetooth": {
"type": "object",
"additionalProperties": false,
@@ -263,7 +291,7 @@
"type": "string",
"enum": ["COL2ROW", "ROW2COL"]
},
"debounce": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"debounce": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"caps_word": {
"type": "object",
"additionalProperties": false,
@@ -271,20 +299,20 @@
"enabled": {"type": "boolean"},
"both_shifts_turns_on": {"type": "boolean"},
"double_tap_shift_turns_on": {"type": "boolean"},
"idle_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"idle_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"invert_on_shift": {"type": "boolean"}
}
},
"combo": {
"type": "object",
"properties": {
"count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"term": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"count": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"term": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
},
"community_layouts": {
"type": "array",
"items": {"$ref": "qmk.definitions.v1#/filename"}
"items": {"$ref": "./definitions.jsonschema#/filename"}
},
"dip_switch": {
"$ref": "#/definitions/dip_switch_config",
@@ -314,10 +342,10 @@
"properties": {
"driver": {
"type": "string",
"enum": ["custom", "embedded_flash", "legacy", "rp2040_flash", "spi_flash"]
"enum": ["none", "custom", "embedded_flash", "legacy", "rp2040_flash", "spi_flash"]
},
"backing_size": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"logical_size": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"backing_size": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"logical_size": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
}
}
@@ -328,20 +356,16 @@
"enabled": {"type": "boolean"}
}
},
"features": {
"$ref": "qmk.definitions.v1#/boolean_array",
"propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
"not": {"required": ["lto"]}
},
"features": { "$ref": "#/definitions/features_config" },
"indicators": {
"type": "object",
"properties": {
"caps_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"num_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"scroll_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"compose": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"kana": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"on_state": {"$ref": "qmk.definitions.v1#/bit"}
"caps_lock": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"num_lock": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"scroll_lock": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"compose": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"kana": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"on_state": {"$ref": "./definitions.jsonschema#/bit"}
}
},
"joystick": {
@@ -349,20 +373,20 @@
"properties": {
"enabled": {"type": "boolean"},
"driver": {"type": "string"},
"button_count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"axis_resolution": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"button_count": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"axis_resolution": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"axes": {
"type": "object",
"propertyNames": {"enum": ["x", "y", "z", "rx", "ry", "rz"]}
"propertyNames": {"enum": ["x", "y", "z", "rx", "ry", "rz"]},
"additionalProperties": {
"oneOf": [
{
"type": "object",
"properties": {
"input_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"low": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"rest": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"high": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"input_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"low": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"rest": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"high": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
},
{
@@ -374,20 +398,20 @@
}
}
},
"keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
"keycodes": {"$ref": "./definitions.jsonschema#/keycode_decl_array"},
"layer_lock": {
"type": "object",
"properties": {
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
},
"layout_aliases": {
"type": "object",
"additionalProperties": {"$ref": "qmk.definitions.v1#/layout_macro"}
"additionalProperties": {"$ref": "./definitions.jsonschema#/layout_macro"}
},
"layouts": {
"type": "object",
"propertyNames": {"$ref": "qmk.definitions.v1#/layout_macro"},
"propertyNames": {"$ref": "./definitions.jsonschema#/layout_macro"},
"additionalProperties": {
"type": "object",
"additionalProperties": false,
@@ -402,7 +426,7 @@
"additionalProperties": false,
"required": ["x", "y"],
"properties": {
"encoder": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"encoder": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"label": {
"type": "string",
"pattern": "^[^\\n]*$"
@@ -416,13 +440,17 @@
"minimum": 0
}
},
"r": {"$ref": "qmk.definitions.v1#/signed_decimal"},
"rx": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
"ry": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
"h": {"$ref": "qmk.definitions.v1#/key_unit"},
"w": {"$ref": "qmk.definitions.v1#/key_unit"},
"x": {"$ref": "qmk.definitions.v1#/key_unit"},
"y": {"$ref": "qmk.definitions.v1#/key_unit"}
"r": {"$ref": "./definitions.jsonschema#/signed_decimal"},
"rx": {"$ref": "./definitions.jsonschema#/unsigned_decimal"},
"ry": {"$ref": "./definitions.jsonschema#/unsigned_decimal"},
"h": {"$ref": "./definitions.jsonschema#/key_unit"},
"w": {"$ref": "./definitions.jsonschema#/key_unit"},
"x": {"$ref": "./definitions.jsonschema#/key_unit"},
"y": {"$ref": "./definitions.jsonschema#/key_unit"},
"hand": {
"type": "string",
"enum": ["L", "R", "*"]
}
}
}
}
@@ -438,12 +466,24 @@
}
}
},
"host": {
"type": "object",
"properties": {
"default": {
"type": "object",
"additionalProperties": false,
"properties": {
"nkro": {"type": "boolean"}
}
}
}
},
"leader_key": {
"type": "object",
"properties": {
"timing": {"type": "boolean"},
"strict_processing": {"type": "boolean"},
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
},
"matrix_pins": {
@@ -453,32 +493,39 @@
"custom": {"type": "boolean"},
"custom_lite": {"type": "boolean"},
"ghost": {"type": "boolean"},
"input_pressed_state": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"io_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"input_pressed_state": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"io_delay": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"masked": {"type": "boolean"},
"direct": {
"type": "array",
"items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
"items": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
},
"cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
"rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
"cols": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
"rows": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
}
},
"modules": {
"type": "array",
"items": {
"type": "string"
}
},
"mouse_key": {
"type": "object",
"properties": {
"enabled": {"type": "boolean"},
"delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"max_speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"time_to_max": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"wheel_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
"delay": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"interval": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"max_speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"time_to_max": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"wheel_delay": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
}
},
"oneshot": {
"type": "object",
"properties": {
"tap_toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"tap_toggle": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
},
"led_matrix": {
@@ -486,7 +533,7 @@
"properties": {
"animations": {
"type": "object",
"propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
"propertyNames": {"$ref": "./definitions.jsonschema#/snake_case"},
"additionalProperties": {"type": "boolean"}
},
"default": {
@@ -495,8 +542,8 @@
"properties": {
"on": {"type": "boolean"},
"animation": {"type": "string"},
"val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
"val": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
}
},
"driver": {
@@ -522,27 +569,28 @@
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
"items": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
},
"max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"val_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"speed_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"led_flush_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"led_process_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"val_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"speed_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"led_flush_limit": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"led_process_limit": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"react_on_keyup": {"type": "boolean"},
"sleep": {"type": "boolean"},
"split_count": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"items": {"$ref": "./definitions.jsonschema#/unsigned_int"}
},
"layout": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["x", "y"],
"properties": {
"matrix": {
"type": "array",
@@ -553,9 +601,9 @@
"minimum": 0
}
},
"x": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"y": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
"x": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"y": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"flags": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
}
}
}
@@ -566,7 +614,7 @@
"properties": {
"animations": {
"type": "object",
"propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
"propertyNames": {"$ref": "./definitions.jsonschema#/snake_case"},
"additionalProperties": {"type": "boolean"}
},
"default": {
@@ -575,10 +623,10 @@
"properties": {
"on": {"type": "boolean"},
"animation": {"type": "string"},
"hue": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"sat": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"speed": {"$ref": "qmk.definitions.v1#/unsigned_int_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"}
}
},
"driver": {
@@ -606,29 +654,30 @@
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
"items": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
},
"max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"sat_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"val_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"speed_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"led_flush_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"led_process_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"hue_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"sat_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"val_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"speed_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"led_flush_limit": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"led_process_limit": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"react_on_keyup": {"type": "boolean"},
"sleep": {"type": "boolean"},
"split_count": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"items": {"$ref": "./definitions.jsonschema#/unsigned_int"}
},
"layout": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["x", "y"],
"properties": {
"matrix": {
"type": "array",
@@ -639,9 +688,9 @@
"minimum": 0
}
},
"x": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"y": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
"x": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"y": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"flags": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
}
}
}
@@ -653,27 +702,27 @@
"properties": {
"animations": {
"type": "object",
"propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
"propertyNames": {"$ref": "./definitions.jsonschema#/snake_case"},
"additionalProperties": {"type": "boolean"}
},
"brightness_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"brightness_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"default": {
"type": "object",
"additionalProperties": false,
"properties": {
"on": {"type": "boolean"},
"animation": {"type": "string"},
"hue": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"sat": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"speed": {"$ref": "qmk.definitions.v1#/unsigned_int_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"}
}
},
"driver": {
"type": "string",
"enum": ["apa102", "custom", "ws2812"]
},
"hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"hue_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"layers": {
"type": "object",
"additionalProperties": false,
@@ -688,29 +737,29 @@
"override_rgb": {"type": "boolean"}
}
},
"led_count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"led_count": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"led_map": {
"type": "array",
"minItems": 2,
"items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"items": {"$ref": "./definitions.jsonschema#/unsigned_int"}
},
"max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"pin": {
"$ref": "qmk.definitions.v1#/mcu_pin",
"$ref": "./definitions.jsonschema#/mcu_pin",
"$comment": "Deprecated: use ws2812.pin instead"
},
"rgbw": {
"type": "boolean",
"$comment": "Deprecated: use ws2812.rgbw instead"
},
"saturation_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"saturation_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"sleep": {"type": "boolean"},
"split": {"type": "boolean"},
"split_count": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"items": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
}
},
@@ -719,8 +768,8 @@
"additionalProperties": false,
"properties": {
"enabled": {"type": "boolean"},
"unlock_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"idle_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"unlock_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"idle_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"unlock_sequence": {
"type": "array",
"minItems": 1,
@@ -754,8 +803,8 @@
"properties": {
"enabled": {"type": "boolean"},
"mouse_enabled": {"type": "boolean"},
"clock_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"data_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"clock_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"data_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"driver": {
"type": "string",
"enum": ["busywait", "interrupt", "usart", "vendor"]
@@ -792,11 +841,11 @@
"properties": {
"direct": {
"type": "array",
"items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
"items": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
},
"cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
"rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
"unused": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
"cols": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
"rows": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
"unused": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
}
}
}
@@ -823,22 +872,21 @@
"type": "object",
"additionalProperties": false,
"properties": {
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"matrix_grid": {
"$ref": "qmk.definitions.v1#/mcu_pin_array",
"$ref": "./definitions.jsonschema#/mcu_pin_array",
"minItems": 2,
"maxItems": 2
}
}
},
"soft_serial_pin": {
"$ref": "qmk.definitions.v1#/mcu_pin",
"$ref": "./definitions.jsonschema#/mcu_pin",
"$comment": "Deprecated: use split.serial.pin instead"
},
"soft_serial_speed": {
"type": "integer",
"minimum": 0,
"maximum": 5
"$comment": "Deprecated: use split.serial.speed instead"
},
"serial": {
"type": "object",
@@ -848,7 +896,12 @@
"type": "string",
"enum": ["bitbang", "usart", "vendor"]
},
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"}
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"speed": {
"type": "integer",
"minimum": 0,
"maximum": 5
}
}
},
"transport": {
@@ -876,7 +929,7 @@
}
},
"watchdog": {"type": "boolean"},
"watchdog_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"watchdog_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"sync_matrix_state": {
"type": "boolean",
"$comment": "Deprecated: use sync.matrix_state instead"
@@ -892,8 +945,8 @@
"additionalProperties": false,
"properties": {
"enabled": {"type": "boolean"},
"polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"polling_interval": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
},
"main": {
@@ -903,7 +956,7 @@
},
"matrix_grid": {
"type": "array",
"items": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"items": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"$comment": "Deprecated: use split.handedness.matrix_grid instead"
}
}
@@ -915,6 +968,7 @@
"tapping": {
"type": "object",
"properties": {
"chordal_hold": {"type": "boolean"},
"force_hold": {"type": "boolean"},
"force_hold_per_key": {"type": "boolean"},
"ignore_mod_tap_interrupt": {"type": "boolean"},
@@ -924,9 +978,9 @@
"permissive_hold_per_key": {"type": "boolean"},
"retro": {"type": "boolean"},
"retro_per_key": {"type": "boolean"},
"term": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"term_per_key": {"type": "boolean"},
"toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"toggle": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
},
"usb": {
@@ -934,16 +988,20 @@
"additionalProperties": false,
"properties": {
"device_ver": {
"$ref": "qmk.definitions.v1#/hex_number_4d",
"$ref": "./definitions.jsonschema#/hex_number_4d",
"$comment": "Deprecated: use device_version instead"
},
"device_version": {"$ref": "qmk.definitions.v1#/bcd_version"},
"force_nkro": {"type": "boolean"},
"pid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
"vid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
"max_power": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"device_version": {"$ref": "./definitions.jsonschema#/bcd_version"},
"force_nkro": {
"type": "boolean",
"$comment": "Deprecated: use host.default.nkro instead"
},
"pid": {"$ref": "./definitions.jsonschema#/hex_number_4d"},
"vid": {"$ref": "./definitions.jsonschema#/hex_number_4d"},
"max_power": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"no_startup_check": {"type": "boolean"},
"polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"polling_interval": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"shared_endpoint": {
"type": "object",
"additionalProperties": false,
@@ -952,7 +1010,7 @@
"mouse": {"type": "boolean"}
}
},
"suspend_wakeup_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"suspend_wakeup_delay": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"wait_for_enumeration": {"type": "boolean"}
}
},
@@ -960,9 +1018,9 @@
"type": "object",
"additionalProperties": false,
"properties": {
"keys_per_scan": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
"tap_keycode_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"tap_capslock_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"keys_per_scan": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
"tap_keycode_delay": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"tap_capslock_delay": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"locking": {
"type": "object",
"additionalProperties": false,
@@ -977,10 +1035,10 @@
"type": "object",
"additionalProperties": false,
"properties": {
"esc_output": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"esc_input": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"led": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"speaker": {"$ref": "qmk.definitions.v1#/mcu_pin"}
"esc_output": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"esc_input": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"led": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"speaker": {"$ref": "./definitions.jsonschema#/mcu_pin"}
}
},
"ws2812": {
@@ -991,10 +1049,10 @@
"type": "string",
"enum": ["bitbang", "custom", "i2c", "pwm", "spi", "vendor"]
},
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
"rgbw": {"type": "boolean"},
"i2c_address": {"$ref": "qmk.definitions.v1#/hex_number_2d"},
"i2c_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
"i2c_address": {"$ref": "./definitions.jsonschema#/hex_number_2d"},
"i2c_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
}
}
}

View File

@@ -30,10 +30,10 @@
"keycodes": {
"type": "object",
"propertyNames": {
"$ref": "qmk.definitions.v1#/hex_number_4d"
"$ref": "./definitions.jsonschema#/hex_number_4d"
},
"additionalProperties": {
"type": "object", // use 'qmk.definitions.v1#/keycode_decl' when problem keycodes are removed
"type": "object", // use './definitions.jsonschema#/keycode_decl' when problem keycodes are removed
"required": [
"key"
],

View File

@@ -10,10 +10,10 @@
"minLength": 1,
"pattern": "^[a-z][0-9a-z_]*$"
},
"host_language": {"$ref": "qmk.definitions.v1#/text_identifier"},
"keyboard": {"$ref": "qmk.definitions.v1#/text_identifier"},
"keymap": {"$ref": "qmk.definitions.v1#/text_identifier"},
"layout": {"$ref": "qmk.definitions.v1#/layout_macro"},
"host_language": {"$ref": "./definitions.jsonschema#/text_identifier"},
"keyboard": {"$ref": "./definitions.jsonschema#/text_identifier"},
"keymap": {"$ref": "./definitions.jsonschema#/text_identifier"},
"layout": {"$ref": "./definitions.jsonschema#/layout_macro"},
"layers": {
"type": "array",
"items": {
@@ -55,11 +55,11 @@
"keycodes": {
"type": "array",
"items": {
"$ref": "qmk.definitions.v1#/text_identifier"
"$ref": "./definitions.jsonschema#/text_identifier"
}
},
"duration": {
"$ref": "qmk.definitions.v1#/unsigned_int"
"$ref": "./definitions.jsonschema#/unsigned_int"
}
}
}
@@ -67,10 +67,16 @@
}
}
},
"keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
"config": {"$ref": "qmk.keyboard.v1"},
"keycodes": {"$ref": "./definitions.jsonschema#/keycode_decl_array"},
"config": {"$ref": "./keyboard.jsonschema#"},
"notes": {
"type": "string"
},
"modules": {
"type": "array",
"items": {
"type": "string"
}
}
}
}

View File

@@ -8,7 +8,7 @@
],
"properties": {
"userspace_version": {
"type": "string",
},
"type": "string"
}
}
}

View File

@@ -6,10 +6,10 @@
"definitions": {
"build_target": {
"oneOf": [
{"$ref": "qmk.definitions.v1#/keyboard_keymap_tuple"},
{"$ref": "qmk.definitions.v1#/json_file_path"}
{"$ref": "./definitions.jsonschema#/keyboard_keymap_tuple"},
{"$ref": "./definitions.jsonschema#/json_file_path"}
]
},
}
},
"required": [
"userspace_version",

View File

@@ -6,11 +6,11 @@
"definitions": {
"build_target": {
"oneOf": [
{"$ref": "qmk.definitions.v1#/keyboard_keymap_tuple"},
{"$ref": "qmk.definitions.v1#/keyboard_keymap_env"},
{"$ref": "qmk.definitions.v1#/json_file_path"}
{"$ref": "./definitions.jsonschema#/keyboard_keymap_tuple"},
{"$ref": "./definitions.jsonschema#/keyboard_keymap_env"},
{"$ref": "./definitions.jsonschema#/json_file_path"}
]
},
}
},
"required": [
"userspace_version",

View File

@@ -14,8 +14,6 @@
},
"features": {
"bootmagic": true,
"command": false,
"console": false,
"extrakey": true,
"mousekey": true,
"nkro": true

View File

@@ -36,7 +36,7 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch
## Encoder flip
* Flips the encoder direction so that `clockwise == true` is for actually turning the knob clockwise
* Adds `ENCODER_DIRECTION_FLIP` define, so that reversing the expected dirction is simple for users.
* Adds `ENCODER_DIRECTION_FLIP` define, so that reversing the expected direction is simple for users.
* Cleans up documentation page for encoders

View File

@@ -38,7 +38,7 @@ After the next breaking change you will not be able to build if `bin/qmk hello`
[#8269](https://github.com/qmk/qmk_firmware/pull/8269)
- Provides debug functionality on ChibiOS/ARM that is more compliant than previous integrations.
- Less maintenence, fewer QMK customisations, and allows QMK to sidestep previous compile and runtime issues.
- Less maintenance, fewer QMK customisations, and allows QMK to sidestep previous compile and runtime issues.
- A `make git-submodule` may be required after pulling the latest QMK Firmware code to update to the new dependency.
### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup
@@ -51,8 +51,10 @@ After the next breaking change you will not be able to build if `bin/qmk hello`
The `RGB_DISABLE_AFTER_TIMEOUT` definition is now deprecated, and has been superseded by `RGB_DISABLE_TIMEOUT`. To use the new definition, rename `RGB_DISABLE_AFTER_TIMEOUT` to `RGB_DISABLE_TIMEOUT` in your `config.h` file, and multiply the value set by 1200.
Before: `#define RGB_DISABLE_AFTER_TIMEOUT 100`
After: `#define RGB_DISABLE_TIMEOUT 120000`
```diff
-#define RGB_DISABLE_AFTER_TIMEOUT 100
+#define RGB_DISABLE_TIMEOUT 120000
```
### Switch to qmk forks for everything

View File

@@ -12,7 +12,7 @@ Added support for MK66F18 (Teensy 3.6) microcontroller.
### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) {#new-command-qmk-console}
A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages.
A new `qmk console` command has been added for attaching to your keyboard's console. It operates similarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages.
### Improved command: qmk config {#improve-command-qmk-config}

135
docs/ChangeLog/20250223.md Normal file
View File

@@ -0,0 +1,135 @@
# QMK Breaking Changes - 2025 February 23 Changelog
## Notable Features
### Community Modules ([#24848](https://github.com/qmk/qmk_firmware/pull/24848))
Community Modules are a feature within QMK which allows code to be implemented by third parties, making it available for other people to import into their own builds.
These modules can provide implementations which override or enhance normal QMK processing; initialization, key processing, suspend, and shutdown are some of the provided hooks which modules may currently implement.
See the [Community Modules documentation](../features/community_modules) for more information, including the full list of available hooks.
First-class support for [External Userspace](../newbs_external_userspace) is included out of the box, so there's even more reason to take the plunge and convert your keymap builds to a userspace repository!
::: tip
An example with a new keycode and some debugging information in the QMK repository [lives here](https://github.com/qmk/qmk_firmware/tree/master/modules/qmk/hello_world), and a community module port of [getreuer's SOCD Cleaner](https://getreuer.info/posts/keyboards/socd-cleaner/) can be found in [tzarc's modules repo](https://github.com/tzarc/qmk_modules).
:::
### Chordal Hold ([#24560](https://github.com/qmk/qmk_firmware/pull/24560))
Chordal Hold implements, by default, an "opposite hands" rule. Suppose a tap-hold key is pressed and then, before the tapping term, another key is pressed. With Chordal Hold, the tap-hold key is settled as tapped if the two keys are on the same hand.
Chordal Hold may be useful to avoid accidental modifier activation with mod-taps, particularly in rolled keypresses when using home row mods.
See the [Chordal Hold documentation](../tap_hold#chordal-hold) for more information.
## Changes Requiring User Action
### Updated Keyboard Codebases
| Old Keyboard Name | New Keyboard Name |
|-------------------------|-----------------------------|
| cxt_studio | cxt_studio/12e4 |
| ergodox_stm32 | handwired/ergodox_stm32 |
| ploopyco/mouse | ploopyco/mouse/rev1_002 |
| ploopyco/trackball/rev1 | ploopyco/trackball/rev1_004 |
| ymdk/id75 | ymdk/id75/f103 |
## 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.
### DEFAULT_FOLDER removal ([#24836](https://github.com/qmk/qmk_firmware/pull/24836))
`DEFAULT_FOLDER` was originally introduced to work around limitations within the build system.
Parent folders containing common configuration would create invalid build targets.
With the introduction of [`keyboard.json`](./20240526#keyboard-json) as a configuration file, the build system now has a consistent method to detect build targets.
The `DEFAULT_FOLDER` functionality is now redundant and the intent is for `rules.mk` to become pure configuration.
Backwards compatibility of build targets has been maintained where possible.
## Full changelist
Core:
* Chaining OSL and MO ([#23065](https://github.com/qmk/qmk_firmware/pull/23065))
* Add extra keymap for EurKEY layout ([#24241](https://github.com/qmk/qmk_firmware/pull/24241))
* Add leader_add_user callback ([#24266](https://github.com/qmk/qmk_firmware/pull/24266))
* always return audio pin to 0 on ARM ([#24503](https://github.com/qmk/qmk_firmware/pull/24503))
* Update Starlight matrix effects ([#24521](https://github.com/qmk/qmk_firmware/pull/24521))
* Refactor Hue Breathing matrix effect with runner ([#24525](https://github.com/qmk/qmk_firmware/pull/24525))
* Ensure timer_read() is safe to call from interrupt handlers on ARM ([#24529](https://github.com/qmk/qmk_firmware/pull/24529))
* Update Raindrops effect to respect LED range limits ([#24531](https://github.com/qmk/qmk_firmware/pull/24531))
* Add Chordal Hold, an "opposite hands rule" tap-hold option similar to Achordion, Bilateral Combinations. ([#24560](https://github.com/qmk/qmk_firmware/pull/24560))
* Azoteq - improve I2C behaviour while polling. ([#24611](https://github.com/qmk/qmk_firmware/pull/24611))
* macOS install: remove bad ARM toolchains ([#24637](https://github.com/qmk/qmk_firmware/pull/24637))
* small refactoring of TIMER_DIFF ([#24678](https://github.com/qmk/qmk_firmware/pull/24678))
* Subscript alef correction ([#24707](https://github.com/qmk/qmk_firmware/pull/24707))
* Created SH1107 driver for quantum painter ([#24724](https://github.com/qmk/qmk_firmware/pull/24724))
* [CI] Regenerate Files ([#24772](https://github.com/qmk/qmk_firmware/pull/24772))
* Patch up issue for inverted complementary output on Backlight ([#24794](https://github.com/qmk/qmk_firmware/pull/24794))
* Patch up issue when compile with APA102 driver ([#24800](https://github.com/qmk/qmk_firmware/pull/24800))
* Consolidate send_string implementations. ([#24817](https://github.com/qmk/qmk_firmware/pull/24817))
* Consolidate timer_elapsed implementations ([#24830](https://github.com/qmk/qmk_firmware/pull/24830))
* `i2c_master`: remove deprecated functions ([#24832](https://github.com/qmk/qmk_firmware/pull/24832))
* Resolve keyboard_aliases when processing keyboard make targets ([#24834](https://github.com/qmk/qmk_firmware/pull/24834))
* LED drivers: remove deprecated defines ([#24837](https://github.com/qmk/qmk_firmware/pull/24837))
* `ferris/0_1`: update I2C API usage ([#24839](https://github.com/qmk/qmk_firmware/pull/24839))
* Unify i2c_master headers ([#24846](https://github.com/qmk/qmk_firmware/pull/24846))
* Community modules ([#24848](https://github.com/qmk/qmk_firmware/pull/24848))
* Relocate base WS2812 code ([#24850](https://github.com/qmk/qmk_firmware/pull/24850))
* Unify UART headers ([#24855](https://github.com/qmk/qmk_firmware/pull/24855))
* Unify spi_master headers ([#24857](https://github.com/qmk/qmk_firmware/pull/24857))
* Invoke `process_record_via` after `_user`/`_kb` have a chance to handle it. ([#24879](https://github.com/qmk/qmk_firmware/pull/24879))
CLI:
* Extend lint to reject 'blank' files ([#23994](https://github.com/qmk/qmk_firmware/pull/23994))
* `qmk docs`: restore `--port` and `--browser` arguments ([#24623](https://github.com/qmk/qmk_firmware/pull/24623))
* Update via2json layout macro searching ([#24640](https://github.com/qmk/qmk_firmware/pull/24640))
* Change `new-keymap` keymap name prompt ([#24701](https://github.com/qmk/qmk_firmware/pull/24701))
* default_keyboard.h generation tweaks ([#24715](https://github.com/qmk/qmk_firmware/pull/24715))
* Ensure `qmk flash` rejects invalid files for uf2 compatible bootloaders ([#24802](https://github.com/qmk/qmk_firmware/pull/24802))
* Reject readme dummy content ([#24913](https://github.com/qmk/qmk_firmware/pull/24913))
Submodule updates:
* chibios: usb_main: remove OTG sof workaround ([#24259](https://github.com/qmk/qmk_firmware/pull/24259))
* Update ChibiOS to latest stable branch. ([#24651](https://github.com/qmk/qmk_firmware/pull/24651))
* Update ChibiOS `stable_21.11.x`. ([#24714](https://github.com/qmk/qmk_firmware/pull/24714))
* Update ChibiOS-Contrib. ([#24803](https://github.com/qmk/qmk_firmware/pull/24803))
Keyboards:
* refactor: move ymdk/id75 to revision ([#24590](https://github.com/qmk/qmk_firmware/pull/24590))
* skyloong/gk61: Remove overriding of core keycode behaviour ([#24655](https://github.com/qmk/qmk_firmware/pull/24655))
* moky/moky88: Remove use of deprecated defines ([#24656](https://github.com/qmk/qmk_firmware/pull/24656))
* Updating Promenade keyboard (Missing keys in matrix, other minor changes to keymap) ([#24705](https://github.com/qmk/qmk_firmware/pull/24705))
* Moving cxt_studio keyboard to own folder ([#24748](https://github.com/qmk/qmk_firmware/pull/24748))
* Add CXT Studio 12E3 keyboard ([#24749](https://github.com/qmk/qmk_firmware/pull/24749))
* Add Silakka54 keyboard ([#24757](https://github.com/qmk/qmk_firmware/pull/24757))
* Add more layout for skiller_sgk50_s4 ([#24784](https://github.com/qmk/qmk_firmware/pull/24784))
* Add watchdog service to RGBKB Sol 3 ([#24786](https://github.com/qmk/qmk_firmware/pull/24786))
* Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson ([#24835](https://github.com/qmk/qmk_firmware/pull/24835))
* Remove DEFAULT_FOLDER where keyboard aliases already exists ([#24838](https://github.com/qmk/qmk_firmware/pull/24838))
* Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson ([#24845](https://github.com/qmk/qmk_firmware/pull/24845))
* Update for 'A-JAZZ AKC084' ('A-JAZZ AKP846') ([#24868](https://github.com/qmk/qmk_firmware/pull/24868))
* handwired/xealous - Remove DEFAULT_FOLDER ([#24877](https://github.com/qmk/qmk_firmware/pull/24877))
* Updates to Ploopy Classic, Mouse, and Thumb for RP2040 hardware upgrade ([#24880](https://github.com/qmk/qmk_firmware/pull/24880))
* Move Ergodox STM32 to handwired folder ([#24903](https://github.com/qmk/qmk_firmware/pull/24903))
* Remove readme dummy content ([#24912](https://github.com/qmk/qmk_firmware/pull/24912))
* Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson ([#24915](https://github.com/qmk/qmk_firmware/pull/24915))
* Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson ([#24938](https://github.com/qmk/qmk_firmware/pull/24938))
Keyboard fixes:
* Fix up CI with `DEFAULT_FOLDER`. ([#24842](https://github.com/qmk/qmk_firmware/pull/24842))
* rgbkb/pan - Remove invalid build target ([#24844](https://github.com/qmk/qmk_firmware/pull/24844))
Others:
* Formally deprecate DEFAULT_FOLDER ([#24836](https://github.com/qmk/qmk_firmware/pull/24836))
* Correct I2C API reference ([#24840](https://github.com/qmk/qmk_firmware/pull/24840))
Bugs:
* Retro Tapping Re-Write; Key Roll Fix ([#23641](https://github.com/qmk/qmk_firmware/pull/23641))
* Fix Quantum Painter compiliation issues with heavy optimization ([#24667](https://github.com/qmk/qmk_firmware/pull/24667))
* Bugfix and update for AT32F415 ([#24807](https://github.com/qmk/qmk_firmware/pull/24807))
* Fix for Chordal Hold: stuck mods when mod-taps are pressed in a stuttered sequence. ([#24878](https://github.com/qmk/qmk_firmware/pull/24878))
* fix EEPROM driver for STM32L0/1 cat.1 devices ([#24928](https://github.com/qmk/qmk_firmware/pull/24928))

299
docs/ChangeLog/20250525.md Normal file
View File

@@ -0,0 +1,299 @@
# QMK Breaking Changes - 2025 May 25 Changelog
## Notable Features
### Flow Tap ([#25125](https://github.com/qmk/qmk_firmware/pull/25125))
Adds Flow Tap as a core tap-hold option to disable HRMs during fast typing, aka Global Quick Tap, Require Prior Idle.
Flow Tap modifies mod-tap MT and layer-tap LT keys such that when pressed within a short timeout of the preceding key, the tapping behavior is triggered. It basically disables the hold behavior during fast typing, creating a "flow of taps." It also helps to reduce the input lag of tap-hold keys during fast typing, since the tapped behavior is sent immediately.
See the [Flow Tap documentation](../tap_hold#flow-tap) for more information.
### Community Modules `1.1.1` ([#25050](https://github.com/qmk/qmk_firmware/pull/25050), [#25187](https://github.com/qmk/qmk_firmware/pull/25187))
Version `1.1.1` introduces support for module defined RGB matrix effects and indicator callbacks, as well as pointing and layer state callbacks.
See the [Community Modules documentation](../features/community_modules) for more information, including the full list of available hooks.
## Changes Requiring User Action
### Updated Keyboard Codebases
| Old Keyboard Name | New Keyboard Name |
|------------------------|----------------------|
| chew | chew/split |
| deemen17/de60fs | deemen17/de60/r1 |
| keyten/kt60hs_t | keyten/kt60hs_t/v1 |
| plywrks/ply8x | plywrks/ply8x/solder |
| rookiebwoy/late9/rev1 | ivndbt/late9/rev1 |
| rookiebwoy/neopad/rev1 | ivndbt/neopad/rev1 |
## 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.
### Deprecation of `qmk generate-compilation-database` ([#25237](https://github.com/qmk/qmk_firmware/pull/25237))
This command has been deprecated as it cannot take into account configurables such as [converters](/feature_converters) or environment variables normally specified on the command line; please use the `--compiledb` flag with `qmk compile` instead.
### Deprecation 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]
```
:::::
The deprecated options will be removed in a future breaking changes cycle.
### `CTPC`/`CONVERT_TO_PROTON_C` removal ([#25111](https://github.com/qmk/qmk_firmware/pull/25111))
Deprecated build options `CTPC` and `CONVERT_TO_PROTON_C` have been removed. Users should of these should migrate to `CONVERT_TO=proton_c`.
see the [Converters Feature](../feature_converters) documentation for more information.
### `DEFAULT_FOLDER` removal ([#23281](https://github.com/qmk/qmk_firmware/pull/23281))
`DEFAULT_FOLDER` was originally introduced to work around limitations within the build system.
Parent folders containing common configuration would create invalid build targets.
With the introduction of [`keyboard.json`](./20240526#keyboard-json) as a configuration file, the build system now has a consistent method to detect build targets.
The `DEFAULT_FOLDER` functionality is now redundant and the intent is for `rules.mk` to become pure configuration.
Backwards compatibility of build targets has been maintained where possible.
### Converter `Pin Compatible` updates ([#20330](https://github.com/qmk/qmk_firmware/pull/20330))
Converter support will be further limited to only function if a keyboard declares that is is compatible.
This can be configured in the following ways:
:::::tabs
==== keyboard.json
```json [keyboard.json]
{
"development_board": "promicro", // [!code focus]
}
```
==== rules.mk
```make [rules.mk]
PIN_COMPATIBLE = promicro
```
:::::
see the [Converters Feature](../feature_converters) documentation for more information.
### Deprecation of `encoder_update_{kb|user}`
These callbacks are now considered end-of-life and will be removed over the next breaking changes cycle, ending August 2025. PRs containing these callbacks will be asked to change to use [encoder mapping](/features/encoders#encoder-map).
`ENCODER_MAP_ENABLE` will subsequently be changed to "default-on" when encoders are enabled, and future breaking changes cycles will remove this flag entirely.
To migrate usage of `encoder_update_user` to encoder map you'll need to handle all of the following changes in your `keymap.c`:
:::::tabs
=== 1. Add keycode definitions
Define new keycodes:
```c
enum {
MY_ENCODER_LEFT = QK_USER, // [!code focus]
MY_ENCODER_RIGHT, // [!code focus]
};
```
=== 2. Add encoder mapping
Add the keycodes to a new encoder map (optionally with transparent layers above, if you want identical functionality of layer-independence):
```c
#if defined(ENCODER_MAP_ENABLE)
const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
[0] = { ENCODER_CCW_CW(MY_ENCODER_LEFT, MY_ENCODER_RIGHT) }, // [!code focus]
[1] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }, // [!code focus]
[2] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }, // [!code focus]
[3] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }, // [!code focus]
};
#endif
```
=== 3. Add keycode processing
Handle the new keycodes within `process_record_user`, much like any other keycode in your keymap:
```c
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {
case MY_ENCODER_LEFT: // [!code focus]
if (record->event.pressed) { // [!code focus]
// Add the same code you had in your `encoder_update_user` for the left-rotation code // [!code focus]
} // [!code focus]
return false; // Skip all further processing of this keycode // [!code focus]
case MY_ENCODER_RIGHT: // [!code focus]
if (record->event.pressed) { // [!code focus]
// Add the same code you had in your `encoder_update_user` for the right-rotation code // [!code focus]
} // [!code focus]
return false; // Skip all further processing of this keycode // [!code focus]
}
}
```
=== 4. Remove old code
Remove your implementation of `encoder_update_user` from your `keymap.c`.
::::::
If your board has multiple encoders, each encoder will need its own pair of keycodes defined as per above.
## Full changelist
Core:
* Non-volatile memory data repository pattern ([#24356](https://github.com/qmk/qmk_firmware/pull/24356))
* High resolution scrolling (without feature report parsing) ([#24423](https://github.com/qmk/qmk_firmware/pull/24423))
* Implement battery level interface ([#24666](https://github.com/qmk/qmk_firmware/pull/24666))
* get_keycode_string(): function to format keycodes as strings, for more readable debug logging. ([#24787](https://github.com/qmk/qmk_firmware/pull/24787))
* [Cleanup] Handling of optional `*.mk` files ([#24952](https://github.com/qmk/qmk_firmware/pull/24952))
* Add EOL to non-keyboard files ([#24990](https://github.com/qmk/qmk_firmware/pull/24990))
* use `keycode_string` in unit tests ([#25042](https://github.com/qmk/qmk_firmware/pull/25042))
* Add additional hooks for Community modules ([#25050](https://github.com/qmk/qmk_firmware/pull/25050))
* Remove `CTPC`/`CONVERT_TO_PROTON_C` options ([#25111](https://github.com/qmk/qmk_firmware/pull/25111))
* Flow Tap tap-hold option to disable HRMs during fast typing (aka Global Quick Tap, Require Prior Idle). ([#25125](https://github.com/qmk/qmk_firmware/pull/25125))
* Remove `bluefruit_le_read_battery_voltage` function ([#25129](https://github.com/qmk/qmk_firmware/pull/25129))
* Avoid duplication in generated community modules `rules.mk` ([#25135](https://github.com/qmk/qmk_firmware/pull/25135))
* [chore]: move and rename mouse/scroll min/max defines ([#25141](https://github.com/qmk/qmk_firmware/pull/25141))
* Ignore the Layer Lock key in Repeat Key and Caps Word. ([#25171](https://github.com/qmk/qmk_firmware/pull/25171))
* Allow for disabling EEPROM subsystem entirely. ([#25173](https://github.com/qmk/qmk_firmware/pull/25173))
* Implement connection keycode logic ([#25176](https://github.com/qmk/qmk_firmware/pull/25176))
* Align ChibiOS `USB_WAIT_FOR_ENUMERATION` implementation ([#25184](https://github.com/qmk/qmk_firmware/pull/25184))
* Enable community modules to define LED matrix and RGB matrix effects. ([#25187](https://github.com/qmk/qmk_firmware/pull/25187))
* Bind Bluetooth driver to `host_driver_t` ([#25199](https://github.com/qmk/qmk_firmware/pull/25199))
* Enhance Flow Tap to work better for rolls over multiple tap-hold keys. ([#25200](https://github.com/qmk/qmk_firmware/pull/25200))
* Remove force disable of NKRO when Bluetooth enabled ([#25201](https://github.com/qmk/qmk_firmware/pull/25201))
* [New Feature/Core] New RGB Matrix Animation "Starlight Smooth" ([#25203](https://github.com/qmk/qmk_firmware/pull/25203))
* Add battery changed callbacks ([#25207](https://github.com/qmk/qmk_firmware/pull/25207))
* Generate versions to keycode headers ([#25219](https://github.com/qmk/qmk_firmware/pull/25219))
* Add raw_hid support to host driver ([#25255](https://github.com/qmk/qmk_firmware/pull/25255))
* Deprecate `usb.force_nkro`/`FORCE_NKRO` ([#25262](https://github.com/qmk/qmk_firmware/pull/25262))
* [Chore] use {rgblight,rgb_matrix}_hsv_to_rgb overrides ([#25271](https://github.com/qmk/qmk_firmware/pull/25271))
* Remove outdated `nix` support due to bit-rot. ([#25280](https://github.com/qmk/qmk_firmware/pull/25280))
CLI:
* Align to latest CLI dependencies ([#24553](https://github.com/qmk/qmk_firmware/pull/24553))
* Exclude external userspace from lint checking ([#24680](https://github.com/qmk/qmk_firmware/pull/24680))
* [Modules] Provide access to current path in `rules.mk`. ([#25061](https://github.com/qmk/qmk_firmware/pull/25061))
* Add "license" field to Community Module JSON schema. ([#25085](https://github.com/qmk/qmk_firmware/pull/25085))
* Prompt for converter when creating new keymap ([#25116](https://github.com/qmk/qmk_firmware/pull/25116))
* Extend lint checks to reject duplication of defaults ([#25149](https://github.com/qmk/qmk_firmware/pull/25149))
* Add lint warning for empty url ([#25182](https://github.com/qmk/qmk_firmware/pull/25182))
* Deprecate `qmk generate-compilation-database`. ([#25237](https://github.com/qmk/qmk_firmware/pull/25237))
* Use relative paths for schemas, instead of $id. Enables VScode validation. ([#25251](https://github.com/qmk/qmk_firmware/pull/25251))
Submodule updates:
* STM32G0x1 support ([#24301](https://github.com/qmk/qmk_firmware/pull/24301))
* Update develop branch to Pico SDK 1.5.1 ([#25178](https://github.com/qmk/qmk_firmware/pull/25178))
* Add `compiler_support.h` ([#25274](https://github.com/qmk/qmk_firmware/pull/25274))
Keyboards:
* add 75_(ansi|iso) Community Layouts to mechlovin/olly/octagon ([#22459](https://github.com/qmk/qmk_firmware/pull/22459))
* Add the plywrks ply8x hotswap variant. ([#23558](https://github.com/qmk/qmk_firmware/pull/23558))
* Add Community Layout support to daskeyboard4 ([#23884](https://github.com/qmk/qmk_firmware/pull/23884))
* New standard layout for Savage65 (65_ansi_blocker_tsangan_split_bs) ([#24690](https://github.com/qmk/qmk_firmware/pull/24690))
* Add Icebreaker keyboard ([#24723](https://github.com/qmk/qmk_firmware/pull/24723))
* Update Tractyl Manuform and add F405 (weact) variant ([#24764](https://github.com/qmk/qmk_firmware/pull/24764))
* Chew folders ([#24785](https://github.com/qmk/qmk_firmware/pull/24785))
* modelh: add prerequisites for via support ([#24932](https://github.com/qmk/qmk_firmware/pull/24932))
* Only configure `STM32_HSECLK` within `board.h` ([#25001](https://github.com/qmk/qmk_firmware/pull/25001))
* Allow LVGL onekey keymap to be able compile for other board ([#25005](https://github.com/qmk/qmk_firmware/pull/25005))
* Remove Sofle `rgb_default` keymap & tidy readme's ([#25010](https://github.com/qmk/qmk_firmware/pull/25010))
* Migrate remaining `split.soft_serial_pin` to `split.serial.pin` ([#25046](https://github.com/qmk/qmk_firmware/pull/25046))
* Update keymap for keycult 1800 ([#25070](https://github.com/qmk/qmk_firmware/pull/25070))
* Add kt60HS-T v2 PCB ([#25080](https://github.com/qmk/qmk_firmware/pull/25080))
* Refactor Deemen17 Works DE60 ([#25088](https://github.com/qmk/qmk_firmware/pull/25088))
* Rookiebwoy to ivndbt ([#25142](https://github.com/qmk/qmk_firmware/pull/25142))
* Remove duplication of RGB Matrix defaults ([#25146](https://github.com/qmk/qmk_firmware/pull/25146))
* ymdk/id75/rp2040 ([#25157](https://github.com/qmk/qmk_firmware/pull/25157))
* Remove duplication of RGBLight defaults ([#25169](https://github.com/qmk/qmk_firmware/pull/25169))
* Remove empty `url` fields ([#25181](https://github.com/qmk/qmk_firmware/pull/25181))
* Remove more duplication of defaults ([#25189](https://github.com/qmk/qmk_firmware/pull/25189))
* Remove `"console":false` from keyboards ([#25190](https://github.com/qmk/qmk_firmware/pull/25190))
* Remove `"command":false` from keyboards ([#25193](https://github.com/qmk/qmk_firmware/pull/25193))
* Remove redundant keyboard headers ([#25208](https://github.com/qmk/qmk_firmware/pull/25208))
* Add debounce to duplicated defaults check ([#25246](https://github.com/qmk/qmk_firmware/pull/25246))
* Remove duplicate of SPI default config from keyboards ([#25266](https://github.com/qmk/qmk_firmware/pull/25266))
* Resolve miscellaneous keyboard lint warnings ([#25268](https://github.com/qmk/qmk_firmware/pull/25268))
* Configure boards to use development_board - 0-9 ([#25287](https://github.com/qmk/qmk_firmware/pull/25287))
* Configure boards to use development_board - UVWXYZ ([#25288](https://github.com/qmk/qmk_firmware/pull/25288))
* Configure boards to use development_board - S ([#25293](https://github.com/qmk/qmk_firmware/pull/25293))
* Configure boards to use development_board - T ([#25294](https://github.com/qmk/qmk_firmware/pull/25294))
Keyboard fixes:
* Fix `boardsource/beiwagon` RGB Matrix coordinates ([#25018](https://github.com/qmk/qmk_firmware/pull/25018))
* amptrics/0422 - Prevent OOB in `update_leds_for_layer` ([#25209](https://github.com/qmk/qmk_firmware/pull/25209))
* salicylic_acid3/getta25 - Fix oled keymap ([#25295](https://github.com/qmk/qmk_firmware/pull/25295))
Others:
* Require 'x'/'y' properties for LED/RGB Matrix layout ([#24997](https://github.com/qmk/qmk_firmware/pull/24997))
* Align `new-keyboard` template to current standards ([#25191](https://github.com/qmk/qmk_firmware/pull/25191))
Bugs:
* Fix OS_DETECTION_KEYBOARD_RESET ([#25015](https://github.com/qmk/qmk_firmware/pull/25015))
* Fix outdated GPIO control function usage ([#25060](https://github.com/qmk/qmk_firmware/pull/25060))
* Cater for use of `__errno_r()` in ChibiOS syscalls.c with newer picolibc revisions ([#25121](https://github.com/qmk/qmk_firmware/pull/25121))
* Fixup eeconfig lighting reset. ([#25166](https://github.com/qmk/qmk_firmware/pull/25166))
* Fix for Flow Tap: fix handling of distinct taps and timer updates. ([#25175](https://github.com/qmk/qmk_firmware/pull/25175))
* Minimise force-included files ([#25194](https://github.com/qmk/qmk_firmware/pull/25194))
* Ensure `qmk_userspace_paths` maintains detected order ([#25204](https://github.com/qmk/qmk_firmware/pull/25204))
* Resolve alias for `qmk new-keymap` keyboard prompts ([#25210](https://github.com/qmk/qmk_firmware/pull/25210))
* gcc15 AVR compilation fixes ([#25238](https://github.com/qmk/qmk_firmware/pull/25238))
* Fix typos introduced by PR #25050 ([#25250](https://github.com/qmk/qmk_firmware/pull/25250))
* Fix Wear Leveling compilation ([#25254](https://github.com/qmk/qmk_firmware/pull/25254))
* Remove more USB only branches from NKRO handling ([#25263](https://github.com/qmk/qmk_firmware/pull/25263))
* [Fix] lib8tion: enable fixed scale8 and blend functions ([#25272](https://github.com/qmk/qmk_firmware/pull/25272))
* Fix tap_hold code blocks ([#25298](https://github.com/qmk/qmk_firmware/pull/25298))

181
docs/ChangeLog/20250831.md Normal file
View File

@@ -0,0 +1,181 @@
# QMK Breaking Changes - 2025 Aug 31 Changelog
## Changes Requiring User Action
### Updated Keyboard Codebases
| Old Keyboard Name | New Keyboard Name |
|--------------------------------------|----------------------------------|
| bastardkb/charybdis/3x5/v2/elitec | bastardkb/charybdis/3x5/elitec |
| bastardkb/charybdis/3x5/v2/splinky_2 | bastardkb/charybdis/3x5/elitec |
| bastardkb/charybdis/3x5/v2/splinky_3 | bastardkb/charybdis/3x5/elitec |
| bastardkb/charybdis/3x5/v2/stemcell | bastardkb/charybdis/3x5/elitec |
| bastardkb/charybdis/3x6/v2/elitec | bastardkb/charybdis/3x6/elitec |
| bastardkb/charybdis/3x6/v2/splinky_2 | bastardkb/charybdis/3x6/elitec |
| bastardkb/charybdis/3x6/v2/splinky_3 | bastardkb/charybdis/3x6/elitec |
| bastardkb/charybdis/3x6/v2/stemcell | bastardkb/charybdis/3x6/elitec |
| bastardkb/charybdis/4x6/v2/elitec | bastardkb/charybdis/4x6/elitec |
| bastardkb/charybdis/4x6/v2/splinky_2 | bastardkb/charybdis/4x6/elitec |
| bastardkb/charybdis/4x6/v2/splinky_3 | bastardkb/charybdis/4x6/elitec |
| bastardkb/charybdis/4x6/v2/stemcell | bastardkb/charybdis/4x6/elitec |
| bastardkb/dilemma/3x5_2/splinky | bastardkb/dilemma/3x5_2/promicro |
| bastardkb/scylla/v2/elitec | bastardkb/scylla/promicro |
| bastardkb/scylla/v2/splinky_2 | bastardkb/scylla/promicro |
| bastardkb/scylla/v2/splinky_3 | bastardkb/scylla/promicro |
| bastardkb/scylla/v2/stemcell | bastardkb/scylla/promicro |
| bastardkb/skeletyl/v2/elitec | bastardkb/skeletyl/promicro |
| bastardkb/skeletyl/v2/splinky_2 | bastardkb/skeletyl/promicro |
| bastardkb/skeletyl/v2/splinky_3 | bastardkb/skeletyl/promicro |
| bastardkb/skeletyl/v2/stemcell | bastardkb/skeletyl/promicro |
| bastardkb/tbkmini/v2/elitec | bastardkb/tbkmini/promicro |
| bastardkb/tbkmini/v2/splinky_2 | bastardkb/tbkmini/promicro |
| bastardkb/tbkmini/v2/splinky_3 | bastardkb/tbkmini/promicro |
| bastardkb/tbkmini/v2/stemcell | bastardkb/tbkmini/promicro |
| helix/rev2 | helix/beta |
| helix/rev3_4rows | helix/rev3 |
| helix/rev3_5rows | helix/rev3 |
| kprepublic/cstc40/daughterboard | kprepublic/cstc40/rev1 |
| kprepublic/cstc40/single_pcb | kprepublic/cstc40/rev2 |
| ll3macorn/bongopad | ll3ma/bongopad |
| novelkeys/nk65/base | novelkeys/nk65/v1 |
| tweetydabird/lotus58/elite_c | tweetydabird/lotus58 |
| tweetydabird/lotus58/nanoboot | tweetydabird/lotus58 |
| tweetydabird/lotus58/promicro | tweetydabird/lotus58 |
| tweetydabird/lotus58/rp2040_ce | tweetydabird/lotus58 |
### Mitigate VIA keylogger security issues [#25414](https://github.com/qmk/qmk_firmware/pull/25414)
VIA's keyboard matrix testing functionality, which allows users to identify active key presses, has been identified as a potential security concern by community members and security researchers. This feature has been demonstrated to enable unauthorized keystroke capture, with documented examples showing how malicious scripts could exploit this capability to create keyloggers. A recent security assessment revealed that user credentials could be compromised by exploiting the matrix testing function combined with VIA's keycode assignment queries. In this attack scenario, a script could remain active during a locked session and capture password input when users authenticate upon return.
The QMK team notified the VIA team of this security vulnerability on May 17, 2022, and made multiple subsequent attempts to coordinate a mitigation strategy. Despite repeated outreach, the VIA team has provided no acknowledgment or response to these security concerns. Given the severity of the potential security implications and the lack of engagement from the VIA team, the QMK team has unilaterally implemented a security enhancement that modifies the keyboard matrix testing functionality to prevent the reporting of key press events. This change prioritizes user security and data protection over potential feature compatibility concerns within VIA.
## 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.
### `DEFAULT_FOLDER` removal ([#23281](https://github.com/qmk/qmk_firmware/pull/23281))
`DEFAULT_FOLDER` was originally introduced to work around limitations within the build system.
Parent folders containing common configuration would create invalid build targets.
With the introduction of [`keyboard.json`](./20240526#keyboard-json) as a configuration file, the build system now has a consistent method to detect build targets.
The `DEFAULT_FOLDER` functionality is now removed with the intent that `rules.mk` is now pure configuration.
Backwards compatibility of build targets has been maintained where possible.
### Converter `Pin Compatible` updates ([#20330](https://github.com/qmk/qmk_firmware/pull/20330))
Converter support has been further limited to only function if a keyboard declares that it is compatible.
This can be configured in the following ways:
:::::tabs
==== keyboard.json
```json [keyboard.json]
{
"development_board": "promicro", // [!code focus]
}
```
==== rules.mk
```make [rules.mk]
PIN_COMPATIBLE = promicro
```
:::::
see the [Converters Feature](../feature_converters) documentation for more information.
### Removal of deprecated RGB and Mouse keycodes ([#25444](https://github.com/qmk/qmk_firmware/pull/25444))
Backwards compatibility of deprecated RGB and Mouse keycodes has been removed.
See the following documentation for the list of currently supported keycodes:
* [RGB Lighting](../features/rgblight#keycodes)
* [RGB Matrix](../features/rgb_matrix#keycodes)
* [Mouse keys](../features/mouse_keys#mapping-mouse-actions)
## Full changelist
Core:
* Remove converter assumption that everything is a promicro ([#20330](https://github.com/qmk/qmk_firmware/pull/20330))
* Remove `DEFAULT_FOLDER` handling ([#23281](https://github.com/qmk/qmk_firmware/pull/23281))
* Add core handling for pointing device failures. ([#25315](https://github.com/qmk/qmk_firmware/pull/25315))
* Relocate remaining `process_record_quantum` keycodes ([#25328](https://github.com/qmk/qmk_firmware/pull/25328))
* Remove `process_action_kb` callback ([#25331](https://github.com/qmk/qmk_firmware/pull/25331))
* Add `{rgb|led}_matrix_get_mode_name()`. ([#25344](https://github.com/qmk/qmk_firmware/pull/25344))
* Align sleep_led logic ([#25395](https://github.com/qmk/qmk_firmware/pull/25395))
* Mitigate VIA keylogger security issues ([#25414](https://github.com/qmk/qmk_firmware/pull/25414))
* Deprecate some nonstandard mod & mod-tap keycode aliases ([#25437](https://github.com/qmk/qmk_firmware/pull/25437))
* Refactor Starlight Smooth matrix effect ([#25442](https://github.com/qmk/qmk_firmware/pull/25442))
* Remove deprecated `RGB_` and Mouse keycodes ([#25444](https://github.com/qmk/qmk_firmware/pull/25444))
* Configure SPI for `QMK_PM2040` board ([#25481](https://github.com/qmk/qmk_firmware/pull/25481))
* Configure SPI for `STEMCELL` board ([#25486](https://github.com/qmk/qmk_firmware/pull/25486))
* Configure SPI for `QMK_BLOK` board ([#25487](https://github.com/qmk/qmk_firmware/pull/25487))
* Clamp reactive offset value ([#25489](https://github.com/qmk/qmk_firmware/pull/25489))
* Relocate `AUDIO_INIT_DELAY` implementation ([#25491](https://github.com/qmk/qmk_firmware/pull/25491))
* Add MATRIX_ROWS_PER_HAND definition ([#25513](https://github.com/qmk/qmk_firmware/pull/25513))
* Refactor battery driver ([#25550](https://github.com/qmk/qmk_firmware/pull/25550))
* Add cachyos as pattern when installing dependencies ([#25580](https://github.com/qmk/qmk_firmware/pull/25580))
CLI:
* Add MATRIX_MASKED DD config ([#25383](https://github.com/qmk/qmk_firmware/pull/25383))
* Ensure keyboard aliases do not point to themselves ([#25500](https://github.com/qmk/qmk_firmware/pull/25500))
Keyboards:
* [Update] E8ghtyNeo caps indicator ([#25009](https://github.com/qmk/qmk_firmware/pull/25009))
* Keychron C3 Pro `c3_pro.c` corrections ([#25049](https://github.com/qmk/qmk_firmware/pull/25049))
* Update franky36 pid and vid ([#25160](https://github.com/qmk/qmk_firmware/pull/25160))
* Added Encoder support for Soyuz ([#25279](https://github.com/qmk/qmk_firmware/pull/25279))
* CSTC40 rev3 (FXTWINK) ([#25285](https://github.com/qmk/qmk_firmware/pull/25285))
* Migrate remaining `DEFAULT_FOLDER` to keyboard aliases ([#25291](https://github.com/qmk/qmk_firmware/pull/25291))
* Configure boards to use development_board - R ([#25316](https://github.com/qmk/qmk_firmware/pull/25316))
* Configure boards to use development_board - P ([#25317](https://github.com/qmk/qmk_firmware/pull/25317))
* Configure boards to use development_board - NO ([#25338](https://github.com/qmk/qmk_firmware/pull/25338))
* Configure boards to use development_board - LM ([#25341](https://github.com/qmk/qmk_firmware/pull/25341))
* maple_computing/launchpad - Remove broken `default_rgb` keymap ([#25342](https://github.com/qmk/qmk_firmware/pull/25342))
* update winry25 VID and PID ([#25351](https://github.com/qmk/qmk_firmware/pull/25351))
* Configure boards to use development_board - DE ([#25369](https://github.com/qmk/qmk_firmware/pull/25369))
* Configure boards to use development_board - FGHIJ ([#25370](https://github.com/qmk/qmk_firmware/pull/25370))
* refactor(mercutio): layouts & reformatting ([#25408](https://github.com/qmk/qmk_firmware/pull/25408))
* Configure boards to use development_board - ABC ([#25417](https://github.com/qmk/qmk_firmware/pull/25417))
* Configure boards to use development_board - K ([#25421](https://github.com/qmk/qmk_firmware/pull/25421))
* Refactor `helix/pico` ([#25428](https://github.com/qmk/qmk_firmware/pull/25428))
* Refactor `helix/rev2` ([#25429](https://github.com/qmk/qmk_firmware/pull/25429))
* Refactor `helix/rev3_{4,5}rows` ([#25430](https://github.com/qmk/qmk_firmware/pull/25430))
* Migrate `helix` common configuration ([#25433](https://github.com/qmk/qmk_firmware/pull/25433))
* Refactor `bastardkb/tbkmini` ([#25438](https://github.com/qmk/qmk_firmware/pull/25438))
* Convert `novelkeys/nk65` to use RGB Matrix ([#25450](https://github.com/qmk/qmk_firmware/pull/25450))
* Convert moon to lite custom matrix ([#25452](https://github.com/qmk/qmk_firmware/pull/25452))
* Refactor `bastardkb/skeletyl` ([#25456](https://github.com/qmk/qmk_firmware/pull/25456))
* Refactor `bastardkb/scylla` ([#25459](https://github.com/qmk/qmk_firmware/pull/25459))
* Refactor `bastardkb/dilemma/3x5_2` ([#25462](https://github.com/qmk/qmk_firmware/pull/25462))
* Migrate `usb.force_nkro` to `host.default.nkro` ([#25468](https://github.com/qmk/qmk_firmware/pull/25468))
* Give mouse report to pointing_device_task_user first in ploopyco devices ([#25475](https://github.com/qmk/qmk_firmware/pull/25475))
* Refactor `bastardkb/charybdis/3x5` ([#25488](https://github.com/qmk/qmk_firmware/pull/25488))
* Refactor `bastardkb/charybdis/3x6` ([#25493](https://github.com/qmk/qmk_firmware/pull/25493))
* Refactor `bastardkb/charybdis/4x6` ([#25494](https://github.com/qmk/qmk_firmware/pull/25494))
* Rebrand For Ll3ma Keyboards ([#25498](https://github.com/qmk/qmk_firmware/pull/25498))
* Remove some encoder resolution that duplicate defaults ([#25517](https://github.com/qmk/qmk_firmware/pull/25517))
* Remove overriding of `DF()` within keyboards ([#25541](https://github.com/qmk/qmk_firmware/pull/25541))
* Refactor inland/kb83 ([#25542](https://github.com/qmk/qmk_firmware/pull/25542))
* Refactor `tweetydabird/lotus58` ([#25547](https://github.com/qmk/qmk_firmware/pull/25547))
* Swap spleeb to default GENERIC_PROMICRO_RP2040 board files ([#25564](https://github.com/qmk/qmk_firmware/pull/25564))
Keyboard fixes:
* Fix `keebio/quefrency/rev1:default60` ([#25423](https://github.com/qmk/qmk_firmware/pull/25423))
* Fixup `bastardkb/tbkmini` keymap's build target ([#25458](https://github.com/qmk/qmk_firmware/pull/25458))
* Miscellaneous fixes for lint warnings ([#25469](https://github.com/qmk/qmk_firmware/pull/25469))
* Fix pytest/has_community default keymap location ([#25471](https://github.com/qmk/qmk_firmware/pull/25471))
* Fix serial speed DD configuration & migrate keyboards ([#25546](https://github.com/qmk/qmk_firmware/pull/25546))
* Update rgb x coordinate of rightmost column ([#25556](https://github.com/qmk/qmk_firmware/pull/25556))
Bugs:
* Fix buggy switch statement in quantum.c ([#25322](https://github.com/qmk/qmk_firmware/pull/25322))
* Compilation fixes for `-fno-common` ([#25436](https://github.com/qmk/qmk_firmware/pull/25436))
* Only userspace should be searched for keyboard aliases when locating keymaps ([#25477](https://github.com/qmk/qmk_firmware/pull/25477))
* Allow `qmk flash <filename>` to flash AT32 boards ([#25497](https://github.com/qmk/qmk_firmware/pull/25497))

View File

@@ -21,8 +21,14 @@
{ "text": "Debugging QMK", "link": "/faq_debug" },
{ "text": "Keymap FAQ", "link": "/faq_keymap" },
{ "text": "Squeezing Space from AVR", "link": "/squeezing_avr" },
{ "text": "Glossary", "link": "/reference_glossary" },
{ "text": "License Violations", "link": "/license_violations" }
{ "text": "Glossary", "link": "/reference_glossary" }
]
},
{
"text": "Licensing",
"items": [
{ "text": "License Violations", "link": "/license_violations" },
{ "text": "Proprietary Libraries", "link": "/proprietary_libs" }
]
},
{
@@ -60,6 +66,7 @@
"items": [
{ "text": "Customizing Functionality", "link": "/custom_quantum_functions" },
{ "text": "Driver Installation with Zadig", "link": "/driver_installation_zadig" },
{ "text": "Community Modules", "link": "/features/community_modules" },
{ "text": "Keymap Overview", "link": "/keymap" },
{
"text": "Development Environments",
@@ -168,6 +175,7 @@
]
},
{ "text": "Audio", "link": "/features/audio" },
{ "text": "Battery", "link": "/features/battery" },
{ "text": "Bootmagic", "link": "/features/bootmagic" },
{ "text": "Converters", "link": "/feature_converters" },
{ "text": "Custom Matrix", "link": "/custom_matrix" },
@@ -206,7 +214,7 @@
{ "text": "My Pull Request Was Flagged", "link": "/breaking_changes_instructions" },
{
"text": "Most Recent ChangeLog",
"link": "/ChangeLog/20241124"
"link": "/ChangeLog/20250831"
},
{ "text": "Past Breaking Changes", "link": "/breaking_changes_history" },
{ "text": "Deprecation Policy", "link": "/support_deprecation_policy" }
@@ -226,6 +234,7 @@
{ "text": "ADC Driver", "link": "/drivers/adc" },
{ "text": "APA102 Driver", "link": "/drivers/apa102" },
{ "text": "Audio Driver", "link": "/drivers/audio" },
{ "text": "Battery Driver", "link": "/drivers/battery" },
{ "text": "EEPROM Driver", "link": "/drivers/eeprom" },
{ "text": "Flash Driver", "link": "/drivers/flash" },
{ "text": "I2C Driver", "link": "/drivers/i2c" },

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?
* [2024 Nov 24](ChangeLog/20241124)
* [2024 Aug 25](ChangeLog/20240825)
* [2024 May 26](ChangeLog/20240526)
* [2025 Aug 31](ChangeLog/20250831)
* [2025 May 25](ChangeLog/20250525)
* [2025 Feb 23](ChangeLog/20250223)
* [Older Breaking Changes](breaking_changes_history)
## When is the next Breaking Change?
The next Breaking Change is scheduled for February 23, 2025.
The next Breaking Change is scheduled for November 30, 2025.
### Important Dates
* 2024 Nov 24 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
* 2025 Jan 26 - `develop` closed to new PRs.
* 2025 Jan 26 - Call for testers.
* 2025 Feb 9 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
* 2025 Feb 16 - `develop` is locked, only critical bugfix PRs merged.
* 2024 Nov 21 - `master` is locked, no PRs merged.
* 2025 Feb 23 - Merge `develop` to `master`.
* 2025 Feb 23 - `master` is unlocked. PRs can be merged again.
* 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.
## What changes will be included?

View File

@@ -2,6 +2,9 @@
This page links to all previous changelogs from the QMK Breaking Changes process.
* [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
* [2024 Nov 24](ChangeLog/20241124) - version 0.27.0
* [2024 Aug 25](ChangeLog/20240825) - version 0.26.0
* [2024 May 26](ChangeLog/20240526) - version 0.25.0

View File

@@ -6,7 +6,7 @@ The QMK CLI (command line interface) makes building and working with QMK keyboar
### Requirements {#requirements}
QMK requires Python 3.7 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.
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}
@@ -18,9 +18,21 @@ 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
```
### 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:
```
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
```
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.7 (or later) installed and have installed pip. Then install QMK with this command:
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

View File

@@ -17,12 +17,12 @@ qmk compile [-c] <configuratorExport.json>
**Usage for Keymaps**:
```
qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] -kb <keyboard_name> -km <keymap_name>
qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] [--compiledb] -kb <keyboard> -km <keymap>
```
**Usage in Keyboard Directory**:
Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap_name>`
Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap>`
```
qmk compile
```
@@ -30,7 +30,7 @@ qmk compile
**Usage for building all keyboards that support a specific keymap**:
```
qmk compile -kb all -km <keymap_name>
qmk compile -kb all -km <keymap>
```
**Example**:
@@ -62,7 +62,7 @@ $ qmk compile
Must be under `qmk_firmware/layouts/`, and in a keymap folder.
```
qmk compile -kb <keyboard_name>
qmk compile -kb <keyboard>
```
**Example**:
@@ -77,11 +77,30 @@ $ qmk compile -kb dz60
It is possible to speed up compilation by adding the `-j`/`--parallel` flag.
```
qmk compile -j <num_jobs> -kb <keyboard_name>
qmk compile -j <num_jobs> -kb <keyboard>
```
The `num_jobs` argument determines the maximum number of jobs that can be used. Setting it to zero will enable parallel compilation without limiting the maximum number of jobs.
```
qmk compile -j 0 -kb <keyboard_name>
qmk compile -j 0 -kb <keyboard>
```
**Compilation Database**:
Creates a `compile_commands.json` file.
Does your IDE/editor use a language server but doesn't _quite_ find all the necessary include files? Do you hate red squigglies? Do you wish your editor could figure out `#include QMK_KEYBOARD_H`? You might need a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)! Compiling using this argument can create this for you.
**Example:**
```
$ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak
$ qmk compile --compiledb
Ψ Making clean
Ψ Gathering build instructions from make ........
Ψ Found 63 compile commands
Ψ Writing build database to /Users/you/src/qmk_firmware/compile_commands.json
Ψ Compiling keymap with make ........
... build log continues ...
```
## `qmk flash`
@@ -101,7 +120,7 @@ qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configurat
**Usage for Keymaps**:
```
qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]
qmk flash -kb <keyboard> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]
```
**Usage for pre-compiled firmwares**:
@@ -612,14 +631,15 @@ This command compiles all the External Userspace build targets.
**Usage**:
```
qmk userspace-compile [-h] [-e ENV] [-n] [-c] [-j PARALLEL] [-t]
qmk userspace-compile [-h] [-e ENV] [-p] [-n] [-c] [-j PARALLEL] [-t]
options:
-h, --help show this help message and exit
-e ENV, --env ENV Set a variable to be passed to make. May be passed multiple times.
-e, --env ENV Set a variable to be passed to make. May be passed multiple times.
-p, --print-failures Print failed builds.
-n, --dry-run Don't actually build, just show the commands to be run.
-c, --clean Remove object files before compiling.
-j PARALLEL, --parallel PARALLEL
-j, --parallel PARALLEL
Set the number of parallel make jobs; 0 means unlimited.
-t, --no-temp Remove temporary files during build.
```
@@ -694,52 +714,28 @@ qmk format-c
qmk format-c -b branch_name
```
## `qmk generate-compilation-database`
**Usage**:
```
qmk generate-compilation-database [-kb KEYBOARD] [-km KEYMAP]
```
Creates a `compile_commands.json` file.
Does your IDE/editor use a language server but doesn't _quite_ find all the necessary include files? Do you hate red squigglies? Do you wish your editor could figure out `#include QMK_KEYBOARD_H`? You might need a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)! The qmk tool can build this for you.
This command needs to know which keyboard and keymap to build. It uses the same configuration options as the `qmk compile` command: arguments, current directory, and config files.
**Example:**
```
$ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak
$ qmk generate-compilation-database
Ψ Making clean
Ψ Gathering build instructions from make -n gh60/satan:colemak
Ψ Found 50 compile commands
Ψ Writing build database to /Users/you/src/qmk_firmware/compile_commands.json
```
Now open your dev environment and live a squiggly-free life.
## `qmk docs`
This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 5173.
This command starts a local HTTP server which you can use for browsing or improving the docs, and provides live reload capability whilst editing. Default port is 8936.
Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser.
This command requires `node` and `yarn` to be installed as prerequisites, and provides live reload capability whilst editing.
Requires `node` and `yarn` to be installed as prerequisites.
**Usage**:
```
usage: qmk docs [-h]
usage: qmk docs [-h] [-b] [-p PORT]
options:
-h, --help show this help message and exit
-b, --browser Open the docs in the default browser.
-p, --port PORT Port number to use.
```
## `qmk generate-docs`
This command allows you to generate QMK documentation locally. It can be uses for general browsing or improving the docs.
Use the `-s`/`--serve` flag to also serve the static site once built. Default port is 4173.
This command generates QMK documentation for production.
Use the `-s`/`--serve` flag to also serve the static site on port 4173 once built. Note that this does not provide live reloading; use `qmk docs` instead for development purposes.
This command requires `node` and `yarn` to be installed as prerequisites, and requires the operating system to support symlinks.
@@ -882,3 +878,13 @@ Run single test:
```
qmk test-c --test basic
```
## `qmk generate-compilation-database`
**Usage**:
```
qmk generate-compilation-database [-kb KEYBOARD] [-km KEYMAP]
```
This command has been deprecated as it cannot take into account configurables such as [converters](/feature_converters) or environment variables normally specified on the command line; please use the `--compiledb` flag with `qmk compile` instead.

View File

@@ -44,7 +44,7 @@ def hello(cli):
First we import the `cli` object from `milc`. This is how we interact with the user and control the script's behavior. We use `@cli.argument()` to define a command line flag, `--name`. This also creates a configuration variable named `hello.name` (and the corresponding `user.name`) which the user can set so they don't have to specify the argument. The `cli.subcommand()` decorator designates this function as a subcommand. The name of the subcommand will be taken from the name of the function.
Once inside our function we find a typical "Hello, World!" program. We use `cli.log` to access the underlying [Logger Object](https://docs.python.org/3.7/library/logging.html#logger-objects), whose behavior is user controllable. We also access the value for name supplied by the user as `cli.config.hello.name`. The value for `cli.config.hello.name` will be determined by looking at the `--name` argument supplied by the user, if not provided it will use the value in the `qmk.ini` config file, and if neither of those is provided it will fall back to the default supplied in the `cli.argument()` decorator.
Once inside our function we find a typical "Hello, World!" program. We use `cli.log` to access the underlying [Logger Object](https://docs.python.org/3.9/library/logging.html#logger-objects), whose behavior is user controllable. We also access the value for name supplied by the user as `cli.config.hello.name`. The value for `cli.config.hello.name` will be determined by looking at the `--name` argument supplied by the user, if not provided it will use the value in the `qmk.ini` config file, and if neither of those is provided it will fall back to the default supplied in the `cli.argument()` decorator.
# User Interaction
@@ -56,13 +56,13 @@ There are two main methods for outputting text in a subcommand- `cli.log` and `c
You can use special tokens to colorize your text, to make it easier to understand the output of your program. See [Colorizing Text](#colorizing-text) below.
Both of these methods support built-in string formatting using python's [printf style string format operations](https://docs.python.org/3.7/library/stdtypes.html#old-string-formatting). You can use tokens such as `%s` and `%d` within your text strings then pass the values as arguments. See our Hello, World program above for an example.
Both of these methods support built-in string formatting using python's [printf style string format operations](https://docs.python.org/3.9/library/stdtypes.html#old-string-formatting). You can use tokens such as `%s` and `%d` within your text strings then pass the values as arguments. See our Hello, World program above for an example.
You should never use the format operator (`%`) directly, always pass values as arguments.
### Logging (`cli.log`)
The `cli.log` object gives you access to a [Logger Object](https://docs.python.org/3.7/library/logging.html#logger-objects). We have configured our log output to show the user a nice emoji for each log level (or the log level name if their terminal does not support unicode.) This way the user can tell at a glance which messages are most important when something goes wrong.
The `cli.log` object gives you access to a [Logger Object](https://docs.python.org/3.9/library/logging.html#logger-objects). We have configured our log output to show the user a nice emoji for each log level (or the log level name if their terminal does not support unicode.) This way the user can tell at a glance which messages are most important when something goes wrong.
The default log level is `INFO`. If the user runs `qmk -v <subcommand>` the default log level will be set to `DEBUG`.

View File

@@ -2,7 +2,7 @@
Most of our style follows PEP8 with some local modifications to make things less nit-picky.
* We target Python 3.7 for compatibility with all supported platforms.
* We target Python 3.9 for compatibility with all supported platforms.
* We indent using four (4) spaces (soft tabs)
* We encourage liberal use of comments
* Think of them as a story describing the feature
@@ -317,7 +317,7 @@ At the time of this writing our tests are not very comprehensive. Looking at the
## Integration Tests
Integration tests can be found in `lib/python/qmk/tests/test_cli_commands.py`. This is where CLI commands are actually run and their overall behavior is verified. We use [`subprocess`](https://docs.python.org/3.7/library/subprocess.html#module-subprocess) to launch each CLI command and a combination of checking output and returncode to determine if the right thing happened.
Integration tests can be found in `lib/python/qmk/tests/test_cli_commands.py`. This is where CLI commands are actually run and their overall behavior is verified. We use [`subprocess`](https://docs.python.org/3.9/library/subprocess.html#module-subprocess) to launch each CLI command and a combination of checking output and returncode to determine if the right thing happened.
## Unit Tests

View File

@@ -140,8 +140,6 @@ If you define these options you will enable the associated feature, which may in
* `#define ENABLE_COMPILE_KEYCODE`
* Enables the `QK_MAKE` keycode
* `#define FORCE_NKRO`
* NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
* `#define STRICT_LAYER_RELEASE`
* force a key release to be evaluated using the current layer stack instead of remembering which layer it came from (used for advanced cases)
@@ -366,8 +364,6 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i
## Build Options
* `DEFAULT_FOLDER`
* Used to specify a default folder when a keyboard has more than one sub-folder.
* `FIRMWARE_FORMAT`
* Defines which format (bin, hex) is copied to the root `qmk_firmware` folder after building.
* `SRC`
@@ -401,6 +397,7 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i
* `atmel-dfu`
* `lufa-dfu`
* `qmk-dfu`
* `qmk-hid`
* `halfkay`
* `caterina`
* `bootloadhid`

View File

@@ -106,10 +106,10 @@ enum my_keycodes {
Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder:
```
qmk docs
qmk docs -b
```
and navigating to `http://localhost:5173/`.
Which should automatically open your browser; otherwise, navigate to `http://localhost:8936/`.
## Keyboards

View File

@@ -9,12 +9,19 @@ This page does not assume any special knowledge about QMK, but reading [Understa
We have structured QMK as a hierarchy:
* Core (`_quantum`)
* Community Module (`_<module>`)
* Community Module -> Keyboard/Revision (`_<module>_kb`)
* Community Module -> Keymap (`_<module>_user`)
* Keyboard/Revision (`_kb`)
* Keymap (`_user`)
Each of the functions described below can be defined with a `_kb()` suffix or a `_user()` suffix. We intend for you to use the `_kb()` suffix at the Keyboard/Revision level, while the `_user()` suffix should be used at the Keymap level.
When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` before executing anything else- otherwise the keymap level function will never be called.
When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` at an appropriate location, otherwise the keymap level function will never be called.
Functions at the `_<module>_xxx()` level are intended to allow keyboards or keymaps to override or enhance the processing associated with a [community module](/features/community_modules).
When defining module overrides such as `process_record_<module>()`, the same pattern should be used; the module must invoke `process_record_<module>_kb()` as appropriate.
# Custom Keycodes
@@ -99,7 +106,7 @@ These are the three main initialization functions, listed in the order that they
* `keyboard_post_init_*` - Happens at the end of the firmware's startup process. This is where you'd want to put "customization" code, for the most part.
::: warning
For most people, the `keyboard_post_init_user` function is what you want to call. For instance, this is where you want to set up things for RGB Underglow.
For most people, the `keyboard_post_init_user` function is what you want to implement. For instance, this is where you want to set up things for RGB Underglow.
:::
## Keyboard Pre Initialization code
@@ -138,7 +145,7 @@ void keyboard_pre_init_user(void) {
This is called when the matrix is initialized, and after some of the hardware has been set up, but before many of the features have been initialized.
This is useful for setting up stuff that you may need elsewhere, but isn't hardware related nor is dependant on where it's started.
This is useful for setting up stuff that you may need elsewhere, but isn't hardware related nor is dependent on where it's started.
### `matrix_init_*` Function Documentation
@@ -202,7 +209,7 @@ You should use this function if you need custom matrix scanning code. It can als
This function gets called at the end of all QMK processing, before starting the next iteration. You can safely assume that QMK has dealt with the last matrix scan at the time that these functions are invoked -- layer states have been updated, USB reports have been sent, LEDs have been updated, and displays have been drawn.
Similar to `matrix_scan_*`, these are called as often as the MCU can handle. To keep your board responsive, it's suggested to do as little as possible during these function calls, potentially throtting their behaviour if you do indeed require implementing something special.
Similar to `matrix_scan_*`, these are called as often as the MCU can handle. To keep your board responsive, it's suggested to do as little as possible during these function calls, potentially throttling their behaviour if you do indeed require implementing something special.
### Example `void housekeeping_task_user(void)` implementation
@@ -239,7 +246,7 @@ void check_rgb_timeout(void) {
}
}
/* Then, call the above functions from QMK's built in post processing functions like so */
/* Runs at the end of each scan loop, check if RGB timeout has occured or not */
/* Runs at the end of each scan loop, check if RGB timeout has occurred or not */
void housekeeping_task_user(void) {
#ifdef RGBLIGHT_TIMEOUT
check_rgb_timeout();

View File

@@ -6,7 +6,7 @@ This page describes how QMK's data driven JSON configuration system works. It is
Historically QMK has been configured through a combination of two mechanisms- `rules.mk` and `config.h`. While this worked well when QMK was only a handful of keyboards we've grown to encompass nearly 4000 supported keyboards. That extrapolates out to 6000 configuration files under `keyboards/` alone! The freeform nature of these files and the unique patterns people have used to avoid duplication have made ongoing maintenance a challenge, and a large number of our keyboards follow patterns that are outdated and sometimes harder to understand.
We have also been working on bringing the power of QMK to people who aren't comformable with a CLI, and other projects such as VIA are working to make using QMK as easy as installing a program. These tools need information about how a keyboard is laid out or what pins and features are available so that users can take full advantage of QMK. We introduced `info.json` as a first step towards this. The QMK API is an effort to combine these 3 sources of information- `config.h`, `rules.mk`, and `info.json`- into a single source of truth that end-user tools can use.
We have also been working on bringing the power of QMK to people who aren't comfortable with a CLI, and other projects such as VIA are working to make using QMK as easy as installing a program. These tools need information about how a keyboard is laid out or what pins and features are available so that users can take full advantage of QMK. We introduced `info.json` as a first step towards this. The QMK API is an effort to combine these 3 sources of information- `config.h`, `rules.mk`, and `info.json`- into a single source of truth that end-user tools can use.
Now we have support for generating `rules.mk` and `config.h` values from `info.json`, allowing us to have a single source of truth. This will allow us to use automated tooling to maintain keyboards saving a lot of time and maintenance work.

View File

@@ -2,7 +2,7 @@
SPI 18x12 LED matrix driver by Awinic. Supports a maximum of four drivers, each controlling up to 216 single-color LEDs, or 72 RGB LEDs.
[AW20216S Datasheet](https://doc.awinic.com/doc/20230609wm/b6a9c70b-e1bd-495b-925f-bcbed3fc2620.pdf)
[AW20216S Datasheet](https://doc.awinic.com/doc/202412/a055779b-49c0-4d09-8f04-73029f44b72b.pdf)
## Usage {#usage}
@@ -44,7 +44,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const aw20216s_led_t PROGMEM g_aw20216s_leds[AW20216S_LED_COUNT] = {

52
docs/drivers/battery.md Normal file
View File

@@ -0,0 +1,52 @@
# Battery Driver
This driver provides support for directly sampling battery level.
## Usage
To use this driver, add the following to your `rules.mk`:
```make
BATTERY_DRIVER_REQUIRED = yes
```
::::info Note
This is already configured for you if you are using the [Battery](../features/battery) feature.
::::
## Driver Configuration {#driver-configuration}
Driver selection can be configured in `rules.mk` as `BATTERY_DRIVER`. Valid values are `adc`, `vendor`, or `custom`. See below for information on individual drivers.
### ADC Driver {#adc-driver}
The default configuration assumes the battery is connected to a ADC capable pin through a voltage divider.
```make
BATTERY_DRIVER = adc
```
The following `#define`s apply only to the `adc` driver:
|Define |Default |Description |
|---------------------------------|--------------|--------------------------------------------------------------|
|`BATTERY_ADC_PIN` |*Not defined* |The GPIO pin connected to the voltage divider. |
|`BATTERY_ADC_REF_VOLTAGE_MV` |`3300` |The ADC reverence voltage, in millivolts. |
|`BATTERY_ADC_VOLTAGE_DIVIDER_R1` |`100` |The voltage divider resistance, in kOhm. Set to 0 to disable. |
|`BATTERY_ADC_VOLTAGE_DIVIDER_R2` |`100` |The voltage divider resistance, in kOhm. Set to 0 to disable. |
|`BATTERY_ADC_RESOLUTION` |`10` |The ADC resolution configured for the ADC Driver. |
### Custom Driver {#custom-driver}
A custom driver is expected to implement the following interface:
```c
void battery_driver_init(void) {
// Perform any initialisation here
}
uint8_t battery_driver_sample_percent(void) {
// Read and return current state here
return value;
}
```

View File

@@ -16,17 +16,22 @@ You can then call the I2C API by including `i2c_master.h` in your code.
## I2C Addressing {#note-on-i2c-addresses}
All of the addresses expected by this driver should be pushed to the upper 7 bits of the address byte. Setting
the lower bit (indicating read/write) will be done by the respective functions. Almost all I2C addresses listed
on datasheets and the internet will be represented as 7 bits occupying the lower 7 bits and will need to be
shifted to the left (more significant) by one bit. This is easy to do via the bitwise shift operator `<< 1`.
I2C addresses listed on datasheets and the internet are usually represented as a 7-bit value. The eighth bit (the least significant bit) controls whether the operation is a read or a write.
You can either do this on each call to the functions below, or once in your definition of the address. For example, if your device has an address of `0x18`:
All of the address parameters expected by the driver API should therefore be pushed to the upper 7 bits of the address byte; the driver will take care of setting the read/write bit as appropriate.
This is easy to do via the bitwise left shift operator. For example, if your device has an address of `0x18` you might create a define for convenience:
```c
#define MY_I2C_ADDRESS (0x18 << 1)
```
Or, you can shift the address ahead of time:
```c
#define MY_I2C_ADDRESS 0x30
```
See https://www.robot-electronics.co.uk/i2c-tutorial for more information about I2C addressing and other technical details.
## AVR Configuration {#avr-configuration}
@@ -40,9 +45,9 @@ The following defines can be used to configure the I2C master driver:
No further setup is required - just connect the `SDA` and `SCL` pins of your I2C devices to the matching pins on the MCU:
|MCU |`SCL`|`SDA`|
|------------------|-----|-----|
|ATmega16/32U4 |`D0` |`D1` |
|AT90USB64/128 |`D0` |`D1` |
|-------------|-----|-----|
|ATmega16/32U4|`D0` |`D1` |
|AT90USB64/128|`D0` |`D1` |
|ATmega32A |`C0` |`C1` |
|ATmega328/P |`C5` |`C4` |
@@ -52,7 +57,7 @@ The ATmega16/32U2 does not possess I2C functionality, and so cannot use this dri
## ChibiOS/ARM Configuration {#arm-configuration}
You'll need to determine which pins can be used for I2C -- a an example, STM32 parts generally have multiple I2C peripherals, labeled I2C1, I2C2, I2C3 etc.
You'll need to determine which pins can be used for I2C -- as an example, STM32 parts generally have multiple I2C peripherals, labeled I2C1, I2C2, I2C3 etc.
To enable I2C, modify your board's `halconf.h` to enable I2C, then modify your board's `mcuconf.h` to enable the peripheral you've chosen:
@@ -83,15 +88,19 @@ To enable I2C, modify your board's `halconf.h` to enable I2C, then modify your b
Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303.
|`config.h` Overrride |Description |Default|
|------------------------|--------------------------------------------------------------|-------|
|`I2C_DRIVER` |I2C peripheral to use - I2C1 -> `I2CD1`, I2C2 -> `I2CD2` etc. |`I2CD1`|
|`I2C1_SCL_PIN` |The pin definition for SCL |`B6` |
|`I2C1_SCL_PAL_MODE` |The alternate function mode for SCL |`4` |
|`I2C1_SDA_PIN` |The pin definition for SDA |`B7` |
|`I2C1_SDA_PAL_MODE` |The alternate function mode for SDA |`4` |
|`config.h` Override|Description |Default|
|-------------------|-------------------------------------------------------------|-------|
|`I2C_DRIVER` |I2C peripheral to use - I2C1 -> `I2CD1`, I2C2 -> `I2CD2` etc.|`I2CD1`|
|`I2C1_SCL_PIN` |The pin to use for SCL |`B6` |
|`I2C1_SCL_PAL_MODE`|The alternate function mode for SCL |`4` |
|`I2C1_SDA_PIN` |The pin to use for SDA |`B7` |
|`I2C1_SDA_PAL_MODE`|The alternate function mode for SDA |`4` |
The following configuration values depend on the specific MCU in use.
::: tip
Currently only a single I2C peripheral is supported, therefore the `I2C1_*` defines are used for configuration regardless of the selected peripheral.
:::
The following configuration values are dependent on the ChibiOS I2C LLD, which is dictated by the microcontroller.
### I2Cv1 {#arm-configuration-i2cv1}
@@ -147,7 +156,7 @@ void i2c_init(void) {
---
### `i2c_status_t i2c_transmit(uint8_t address, uint8_t *data, uint16_t length, uint16_t timeout)` {#api-i2c-transmit}
### `i2c_status_t i2c_transmit(uint8_t address, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-transmit}
Send multiple bytes to the selected I2C device.
@@ -155,7 +164,7 @@ Send multiple bytes to the selected I2C device.
- `uint8_t address`
The 7-bit I2C address of the device.
- `uint8_t *data`
- `const uint8_t* data`
A pointer to the data to transmit.
- `uint16_t length`
The number of bytes to write. Take care not to overrun the length of `data`.
@@ -168,6 +177,29 @@ Send multiple bytes to the selected I2C device.
---
### `i2c_status_t i2c_transmit_P(uint8_t address, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-transmit-p}
Send multiple bytes from PROGMEM to the selected I2C device.
On ARM devices, this function is simply an alias for `i2c_transmit(address, data, length, timeout)`.
#### Arguments {#api-i2c-transmit-p-arguments}
- `uint8_t address`
The 7-bit I2C address of the device.
- `const uint8_t* data`
A pointer to the data to transmit.
- `uint16_t length`
The number of bytes to write. 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-p-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_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-receive}
Receive multiple bytes from the selected I2C device.
@@ -176,8 +208,8 @@ Receive multiple bytes from the selected I2C device.
- `uint8_t address`
The 7-bit I2C address of the device.
- `uint8_t *data`
A pointer to the buffer to read into.
- `uint8_t* data`
A pointer to a buffer to read into.
- `uint16_t length`
The number of bytes to read. Take care not to overrun the length of `data`.
- `uint16_t timeout`
@@ -189,9 +221,9 @@ Receive multiple bytes from the selected I2C device.
---
### `i2c_status_t i2c_write_register(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register}
### `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}
Writes to a register with an 8-bit address on the I2C device.
Write to a register with an 8-bit address on the I2C device.
#### Arguments {#api-i2c-write-register-arguments}
@@ -199,7 +231,7 @@ Writes to a register with an 8-bit address on the I2C device.
The 7-bit I2C address of the device.
- `uint8_t regaddr`
The register address to write to.
- `uint8_t *data`
- `const uint8_t* data`
A pointer to the data to transmit.
- `uint16_t length`
The number of bytes to write. Take care not to overrun the length of `data`.
@@ -212,9 +244,9 @@ Writes to a register with an 8-bit address on the I2C device.
---
### `i2c_status_t i2c_write_register16(uint8_t devaddr, uint16_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register16}
### `i2c_status_t i2c_write_register16(uint8_t devaddr, uint16_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register16}
Writes to a register with a 16-bit address (big endian) on the I2C device.
Write to a register with a 16-bit address (big endian) on the I2C device.
#### Arguments {#api-i2c-write-register16-arguments}
@@ -222,7 +254,7 @@ Writes to a register with a 16-bit address (big endian) on the I2C device.
The 7-bit I2C address of the device.
- `uint16_t regaddr`
The register address to write to.
- `uint8_t *data`
- `const uint8_t* data`
A pointer to the data to transmit.
- `uint16_t length`
The number of bytes to write. Take care not to overrun the length of `data`.
@@ -237,7 +269,7 @@ Writes to a register with a 16-bit address (big endian) on the I2C device.
### `i2c_status_t i2c_read_register(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-read-register}
Reads from a register with an 8-bit address on the I2C device.
Read from a register with an 8-bit address on the I2C device.
#### Arguments {#api-i2c-read-register-arguments}
@@ -245,6 +277,8 @@ Reads from a register with an 8-bit address on the I2C device.
The 7-bit I2C address of the device.
- `uint8_t regaddr`
The register address to read from.
- `uint8_t data`
A pointer to a buffer to read into.
- `uint16_t length`
The number of bytes to read. Take care not to overrun the length of `data`.
- `uint16_t timeout`
@@ -258,7 +292,7 @@ Reads from a register with an 8-bit address on the I2C device.
### `i2c_status_t i2c_read_register16(uint8_t devaddr, uint16_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-read-register16}
Reads from a register with a 16-bit address (big endian) on the I2C device.
Read from a register with a 16-bit address (big endian) on the I2C device.
#### Arguments {#api-i2c-read-register16-arguments}
@@ -266,6 +300,8 @@ Reads from a register with a 16-bit address (big endian) on the I2C device.
The 7-bit I2C address of the device.
- `uint16_t regaddr`
The register address to read from.
- `uint8_t* data`
A pointer to a buffer to read into.
- `uint16_t length`
The number of bytes to read. Take care not to overrun the length of `data`.
- `uint16_t timeout`
@@ -279,19 +315,19 @@ Reads from a register with a 16-bit address (big endian) on the I2C device.
### `i2c_status_t i2c_ping_address(uint8_t address, uint16_t timeout)` {#api-i2c-ping-address}
Pings the I2C bus for a specific address.
Ping the I2C bus for a specific address.
On ChibiOS a "best effort" attempt is made by reading a single byte from register 0 at the requested address. This should generally work except for I2C devices that do not not respond to a register 0 read request, which will result in a false negative result (unsucessful response to ping attempt).
On ChibiOS a "best effort" attempt is made by reading a single byte from register 0 at the given address. This should generally work except for I2C devices that do not not respond to a register 0 read request, which will result in a false negative result (unsuccessful response to ping attempt).
This function is weakly defined, meaning it can be overridden if necessary for your particular use case:
This function is weakly defined, meaning it can be overridden if necessary for your particular use case.
#### Arguments
#### Arguments {#api-i2c-ping-address-arguments}
- `uint8_t address`
The 7-bit I2C address of the device (ie. without the read/write bit - this will be set automatically).
The 7-bit I2C address of the device.
- `uint16_t timeout`
The time in milliseconds to wait for a response from the target device.
#### Return Value
#### Return Value {#api-i2c-ping-address-return}
`I2C_STATUS_TIMEOUT` if the timeout period elapses, `I2C_STATUS_ERROR` if some other error occurs, otherwise `I2C_STATUS_SUCCESS`.

View File

@@ -37,7 +37,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3218_led_t PROGMEM g_is31fl3218_leds[IS31FL3218_LED_COUNT] = {

View File

@@ -50,7 +50,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3236_led_t PROGMEM g_is31fl3236_leds[IS31FL3236_LED_COUNT] = {

View File

@@ -120,7 +120,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3729_led_t PROGMEM g_is31fl3729_leds[IS31FL3729_LED_COUNT] = {

View File

@@ -61,7 +61,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {

View File

@@ -145,7 +145,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {

View File

@@ -129,7 +129,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3736_led_t PROGMEM g_is31fl3736_leds[IS31FL3736_LED_COUNT] = {

View File

@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT] = {

View File

@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT] = {

View File

@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3742a_led_t PROGMEM g_is31fl3742a_leds[IS31FL3742A_LED_COUNT] = {

View File

@@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT] = {

View File

@@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3745_led_t PROGMEM g_is31fl3745_leds[IS31FL3745_LED_COUNT] = {

View File

@@ -132,7 +132,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT] = {

View File

@@ -63,7 +63,7 @@ SERIAL_DRIVER = bitbang
## USART Half-duplex
Targeting ARM boards based on ChibiOS, where communication is offloaded to a USART hardware device that supports Half-duplex operation. The advantages over bitbanging are fast, accurate timings and reduced CPU usage. Therefore it is advised to choose Half-duplex over Bitbang if MCU is capable of utilising Half-duplex, and Full-duplex can't be used instead (e.g. lack of available GPIO pins, or imcompatible PCB design).
Targeting ARM boards based on ChibiOS, where communication is offloaded to a USART hardware device that supports Half-duplex operation. The advantages over bitbanging are fast, accurate timings and reduced CPU usage. Therefore it is advised to choose Half-duplex over Bitbang if MCU is capable of utilising Half-duplex, and Full-duplex can't be used instead (e.g. lack of available GPIO pins, or incompatible PCB design).
### Pin configuration
@@ -307,7 +307,7 @@ This is the default time window in milliseconds in which a successful communicat
## Troubleshooting
If you're having issues withe serial communication, you can enable debug messages that will give you insights which part of the communication failed. The enable these messages add to your keyboards `config.h` file:
If you're having issues with serial communication, you can enable debug messages that will give you insights which part of the communication failed. The enable these messages add to your keyboards `config.h` file:
```c
#define SERIAL_DEBUG

View File

@@ -52,7 +52,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const snled27351_led_t PROGMEM g_snled27351_leds[SNLED27351_LED_COUNT] = {

View File

@@ -39,8 +39,6 @@ To enable SPI, modify your board's `halconf.h` to enable SPI, then modify your b
#pragma once
#define HAL_USE_SPI TRUE // [!code focus]
#define SPI_USE_WAIT TRUE // [!code focus]
#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD // [!code focus]
#include_next <halconf.h>
```
@@ -88,7 +86,7 @@ Start an SPI transaction.
#### Arguments {#api-spi-start-arguments}
- `pin_t slavePin`
The QMK pin to assert as the slave select pin, eg. `B4`.
The GPIO pin connected to the desired device's `SS` line.
- `bool lsbFirst`
Determines the endianness of the transmission. If `true`, the least significant bit of each byte is sent first.
- `uint8_t mode`
@@ -106,7 +104,7 @@ Start an SPI transaction.
#### Return Value {#api-spi-start-return}
`false` if the supplied parameters are invalid or the SPI peripheral is already in use, or `true`.
`true` if the operation was successful, otherwise `false` if the supplied parameters are invalid or the SPI peripheral is already in use.
---
@@ -131,7 +129,7 @@ Read a byte from the selected SPI device.
#### Return Value {#api-spi-read-return}
`SPI_STATUS_TIMEOUT` if the timeout period elapses, or the byte read from the device.
`SPI_STATUS_TIMEOUT` if the timeout period elapses, otherwise the byte read from the device.
---
@@ -159,7 +157,7 @@ Receive multiple bytes from the selected SPI device.
#### Arguments {#api-spi-receive-arguments}
- `uint8_t *data`
A pointer to the buffer to read into.
A pointer to a buffer to read into.
- `uint16_t length`
The number of bytes to read. Take care not to overrun the length of `data`.

View File

@@ -45,17 +45,17 @@ To enable UART, modify your board's `mcuconf.h` to enable the peripheral you've
Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303.
| `config.h` override | Description | Default Value |
| --------------------------- | --------------------------------------------------------------- | ------------- |
| `#define UART_DRIVER` | USART peripheral to use - USART1 -> `SD1`, USART2 -> `SD2` etc. | `SD1` |
| `#define UART_TX_PIN` | The pin to use for TX | `A9` |
| `#define UART_TX_PAL_MODE` | The alternate function mode for TX | `7` |
| `#define UART_RX_PIN` | The pin to use for RX | `A10` |
| `#define UART_RX_PAL_MODE` | The alternate function mode for RX | `7` |
| `#define UART_CTS_PIN` | The pin to use for CTS | `A11` |
| `#define UART_CTS_PAL_MODE` | The alternate function mode for CTS | `7` |
| `#define UART_RTS_PIN` | The pin to use for RTS | `A12` |
| `#define UART_RTS_PAL_MODE` | The alternate function mode for RTS | `7` |
|`config.h` Override|Description |Default|
|-------------------|---------------------------------------------------------------|-------|
|`UART_DRIVER` |USART peripheral to use - USART1 -> `SD1`, USART2 -> `SD2` etc.|`SD1` |
|`UART_TX_PIN` |The pin to use for TX |`A9` |
|`UART_TX_PAL_MODE` |The alternate function mode for TX |`7` |
|`UART_RX_PIN` |The pin to use for RX |`A10` |
|`UART_RX_PAL_MODE` |The alternate function mode for RX |`7` |
|`UART_CTS_PIN` |The pin to use for CTS |`A11` |
|`UART_CTS_PAL_MODE`|The alternate function mode for CTS |`7` |
|`UART_RTS_PIN` |The pin to use for RTS |`A12` |
|`UART_RTS_PAL_MODE`|The alternate function mode for RTS |`7` |
## API {#api}
@@ -111,7 +111,7 @@ Receive multiple bytes.
#### Arguments {#api-uart-receive-arguments}
- `uint8_t *data`
A pointer to the buffer to read into.
A pointer to a buffer to read into.
- `uint16_t length`
The number of bytes to read. Take care not to overrun the length of `data`.
@@ -123,4 +123,4 @@ Return whether the receive buffer contains data. Call this function to determine
#### Return Value {#api-uart-available-return}
`true` if the receive buffer length is non-zero.
`true` if there is data available to read.

View File

@@ -144,18 +144,30 @@ The following defines apply only to ARM devices:
|`WS2812_T1L`|`(WS2812_TIMING - WS2812_T1H)`|The length of a "1" bit's low phase in nanoseconds (bitbang and PIO drivers only)|
|`WS2812_T0L`|`(WS2812_TIMING - WS2812_T0H)`|The length of a "0" bit's low phase in nanoseconds (bitbang and PIO drivers only)|
### Push-Pull and Open Drain {#push-pull-open-drain}
### Logic Levels {#logic-levels}
By default, the GPIO used for data transmission is configured as a *push-pull* output, meaning the pin is effectively always driven either to VCC or to ground.
WS2812 LEDs usually operate at 5V, but some microcontrollers, particularly ARM-based ones, run on 3.3V. This can pose an issue when driving the LED chain as the logic level voltage is lower than the power supply voltage, leading to unreliable data transmission. There are two main workarounds:
For situations where the logic level voltage is lower than the power supply voltage, however, this can pose an issue. The solution is to configure the pin for *open drain* mode instead, and use a pullup resistor between the DI pin and VCC. In this mode, the MCU can only pull the GPIO *low*, or leave it floating. The pullup resistor is then responsible for pulling the line high, when the MCU is not driving the GPIO.
#### 1. Open Drain Circuit {#open-drain-circuit}
To configure the DI pin for open drain configuration, add the following to your `config.h`:
By default, `WS2812_DI_PIN` is configured as a *push-pull* output, meaning the pin is effectively always driven either to VCC or to ground; however, it can be configured in *open drain* mode instead.
In this mode, the MCU will only pull the GPIO *low*, and leaves it floating otherwise. A pullup resistor (typically around 10kΩ) between DI and 5V is then responsible for pulling the line high when the MCU is not driving the GPIO.
To use the DI pin in open drain configuration, add the following to your `config.h`:
```c
#define WS2812_EXTERNAL_PULLUP
```
::: warning
Because the GPIO is being pulled to 5V in this situation rather than VCC (3.3V), **it must be a 5V tolerant pin**. Consult your MCU's datasheet first if there are no eligible pins, you must use a level shifter instead.
:::
#### 2. Level Shifter {#level-shifter}
A level shifter IC, such as the SN74LV1T34, can be placed between the GPIO and the first LED's DI pin to convert the 3.3V logic to 5V. This requires no additional configuration in the firmware, nor a 5V tolerant GPIO, but may be more expensive and is generally less handwire-friendly.
### SPI Driver {#arm-spi-driver}
Depending on the ChibiOS board configuration, you may need to enable SPI at the keyboard level. For STM32, this would look like:

View File

@@ -77,6 +77,17 @@ KL: kc: 172, col: 2, row: 0, pressed: 1, time: 16303, int: 0, count: 0
KL: kc: 172, col: 2, row: 0, pressed: 0, time: 16411, int: 0, count: 0
```
### Which keycode is this keypress?
Keycodes are logged in the example above as numerical codes, which may be difficult to interpret. For more readable logging, add `KEYCODE_STRING_ENABLE = yes` in your `rules.mk` and use `get_keycode_string(kc)`. For example:
```c
uprintf("kc: %s\n", get_keycode_string(keycode));
```
This logs the keycode as a human-readable string like "`LT(2,KC_D)`" rather than a numerical code like "`0x4207`." See the [Keycode String](unit_testing#keycode-string) section of the Unit Testing page for more information.
### How long did it take to scan for a keypress?
When testing performance issues, it can be useful to know the frequency at which the switch matrix is being scanned. To enable logging for this scenario, add the following code to your keymaps `config.h`

View File

@@ -38,7 +38,7 @@ Awesome! Open up a Pull Request for it. We'll review the code, and merge it!
That's amazing! We would love to assist you with that!
In fact, we have a [whole page](https://qmk.fm/powered/) dedicated to adding QMK Branding to your page and keyboard. This covers pretty much everything you need (knowledge and images) to officially support QMK.
In fact, we have a [whole page](https://qmk.fm/trademark) dedicated to adding QMK Branding to your page and keyboard. This covers pretty much everything you need (knowledge and images) to officially support QMK.
If you have any questions about this, open an issue or head to [Discord](https://discord.gg/qmk).

View File

@@ -3,28 +3,39 @@
These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent.
|Key |Aliases |Description |
|----------|----------------------------------|------------------------------------------------------|
|----------|-------------------------------|-------------------------------------------------------------------------------|
|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` |
|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)` |Hold Left GUI and press `kc` |
|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` |
|`LCS(kc)` | |Hold Left Control and Left Shift and press `kc` |
|`LCA(kc)` | |Hold Left Control and Left Alt and press `kc` |
|`LCG(kc)` | |Hold Left Control and Left GUI and press `kc` |
|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` |
|`LSG(kc)` | |Hold Left Shift and Left GUI and press `kc` |
|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` |
|`LCSG(kc)`| |Hold Left Control, Left Shift and Left GUI and press `kc` |
|`LCAG(kc)`| |Hold Left Control, Left Alt and Left GUI and press `kc` |
|`LSAG(kc)`| |Hold Left Shift, Left Alt and Left GUI and press `kc` |
|`RCTL(kc)`| |Hold Right Control and press `kc` |
|`RSFT(kc)`| |Hold Right Shift and press `kc` |
|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` |
|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` |
|`LSG(kc)` |`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc` |
|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` |
|`RCA(kc)` | |Hold Right Control and Right Alt and press `kc` |
|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` |
|`RCG(kc)` | |Hold Right Control and Right GUI and press `kc` |
|`RSA(kc)` | |Hold Right Shift and Right Alt and press `kc` |
|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` |
|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` |
|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` |
|`RSA(kc)` |`SAGR(kc)` |Hold Right Shift and Right Alt (AltGr) and press `kc` |
|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` |
|`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` |
|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` |
|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc` |
|`RCSG(kc)`| |Hold Right Control, Right Shift and Right GUI and press `kc` |
|`RCAG(kc)`| |Hold Right Control, Right Alt and Right GUI and press `kc` |
|`RSAG(kc)`| |Hold Right Shift, Right Alt and Right GUI and press `kc` |
|`MEH(kc)` | |Hold Left Control, Left Shift and Left Alt and press `kc` |
|`HYPR(kc)`| |Hold Left Control, Left Shift, Left Alt and Left GUI and press `kc`<sup>1</sup>|
You can also chain them, for example `LCTL(LALT(KC_DEL))` or `C(A(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress.
<sup>1. More information on the Hyper key can be found on [this blog post by Brett Terpstra](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/).</sup>
You can also chain them, for example `LCTL(LALT(KC_DEL))`, `C(A(KC_DEL))`, or `LCA(KC_DEL)` all make a key that sends Control+Alt+Delete with a single keypress.
# Checking Modifier State {#checking-modifier-state}

View File

@@ -47,7 +47,7 @@ susceptible to noise, you must choose a debounce method that will also mitigate
* Debounce algorithms often have a 'debounce time' parameter, that specifies the maximum settling time of the switch contacts.
This time might be measured in various units:
* Cycles-based debouncing waits n cycles (scans), decreasing count by one each matrix_scan
* Timestamp-based debouncing stores the millisecond timestamp a change occurred, and does substraction to figure out time elapsed.
* Timestamp-based debouncing stores the millisecond timestamp a change occurred, and does subtraction to figure out time elapsed.
* Timestamp-based debouncing is usually superior, especially in the case of noise-resistant devices because settling times of physical
switches is specified in units of time, and should not depend on the matrix scan-rate of the keyboard.
* Cycles-based debouncing is sometimes considered inferior, because the settling time that it is able to compensate for depends on the

View File

@@ -100,7 +100,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
if (record->event.pressed) { //This disables layer indication, as it's assumed that if you're changing this ... you want that disabled
if (user_config.rgb_layer_change) { // only if this is enabled
user_config.rgb_layer_change = false; // disable it, and
eeconfig_update_user(user_config.raw); // write the setings to EEPROM
eeconfig_update_user(user_config.raw); // write the settings to EEPROM
}
}
return true; break;
@@ -109,7 +109,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
}
}
```
And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EE_CLR` keycode or [Bootmagic](features/bootmagic) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued.
And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EE_CLR` keycode or [Bootmagic](features/bootmagic) functionality. For example, if you want to set rgb layer indication by default, and save the default valued.
```c
void eeconfig_init_user(void) { // EEPROM is getting reset!

View File

@@ -25,7 +25,7 @@ active layer until pressed again.
Currently, the `layer` argument of `LT()` is limited to layers 0-15, and the `kc` argument to the [Basic Keycode set](keycodes_basic), meaning you can't use keycodes like `LCTL()`, `KC_TILD`, or anything greater than `0xFF`. This is because QMK uses 16-bit keycodes, of which 4 bits are used for the function identifier and 4 bits for the layer, leaving only 8 bits for the keycode.
For a similar reason, the `layer` argument of `LM()` is also limited to layers 0-15 and the `mod` argument must fit within 5 bits. As a consequence, although left and right modifiers are supported by `LM()`, it is impossible to mix and match left and right modifiers. Specifying at least one right-hand modifier in a combination such as `MOD_RALT|MOD_LSFT` will convert *all* the listed modifiers to their right-hand counterpart. So, using the aforementionned mod-mask will actually send <kbd>Right Alt</kbd>+<kbd>Right Shift</kbd>. Make sure to use the `MOD_xxx` constants over alternative ways of specifying modifiers when defining your layer-mod key.
For a similar reason, the `layer` argument of `LM()` is also limited to layers 0-15 and the `mod` argument must fit within 5 bits. As a consequence, although left and right modifiers are supported by `LM()`, it is impossible to mix and match left and right modifiers. Specifying at least one right-hand modifier in a combination such as `MOD_RALT|MOD_LSFT` will convert *all* the listed modifiers to their right-hand counterpart. So, using the aforementioned mod-mask will actually send <kbd>Right Alt</kbd>+<kbd>Right Shift</kbd>. Make sure to use the `MOD_xxx` constants over alternative ways of specifying modifiers when defining your layer-mod key.
| `LM(1,KC_LSFT)` | `LM(1,MOD_MASK_SHIFT)` | `LM(1,MOD_BIT(KC_LSFT))` | `LM(1,MOD_LSFT)` |
|:---------------:|:----------------------:|:------------------------:|:----------------:|
@@ -62,26 +62,26 @@ Sometimes, you might want to switch between layers in a macro or as part of a ta
There are a number of functions (and variables) related to how you can use or manipulate the layers.
|Function |Description |
|----------------------------------------------|---------------------------------------------------------------------------------------------------------|
| `layer_state_set(layer_mask)` | Directly sets the layer state (avoid unless you know what you are doing). |
| `layer_clear()` | Clears all layers (turns them all off). |
| `layer_move(layer)` | Turns specified layer on, and all other layers off. |
| `layer_on(layer)` | Turns specified layer on, leaves all other layers in existing state. |
| `layer_off(layer)` | Turns specified layer off, leaves all other layers in existing state. |
| `layer_invert(layer)` | Inverts/toggles the state of the specified layer |
| `layer_or(layer_mask)` | Turns on layers based on matching bits between specifed layer and existing layer state. |
| `layer_and(layer_mask)` | Turns on layers based on matching enabled bits between specifed layer and existing layer state. |
| `layer_xor(layer_mask)` | Turns on layers based on non-matching bits between specifed layer and existing layer state. |
| `layer_debug(layer_mask)` | Prints out the current bit mask and highest active layer to debugger console. |
| `default_layer_set(layer_mask)` | Directly sets the default layer state (avoid unless you know what you are doing). |
| `default_layer_or(layer_mask)` | Turns on layers based on matching bits between specifed layer and existing default layer state. |
| `default_layer_and(layer_mask)` | Turns on layers based on matching enabled bits between specifed layer and existing default layer state. |
| `default_layer_xor(layer_mask)` | Turns on layers based on non-matching bits between specifed layer and existing default layer state. |
| `default_layer_debug(layer_mask)` | Prints out the current bit mask and highest active default layer to debugger console. |
| [`set_single_default_layer(layer)`](ref_functions.md#setting-the-persistent-default-layer) | Sets the default layer, but does _not_ write it to persistent memory (EEPROM). |
| [`set_single_persistent_default_layer(layer)`](ref_functions.md#setting-the-persistent-default-layer) | Sets the default layer and writes it to persistent memory (EEPROM). |
| [`update_tri_layer(x, y, z)`](ref_functions.md#update_tri_layerx-y-z) | Checks if layers `x` and `y` are both on, and sets `z` based on that (on if both on, otherwise off). |
| [`update_tri_layer_state(state, x, y, z)`](ref_functions.md#update_tri_layer_statestate-x-y-z) | Does the same as `update_tri_layer(x, y, z)`, but from `layer_state_set_*` functions. |
|---------------------------------------------|--------------------------------------------------------------------------------------------------------|
|`layer_state_set(layer_mask)` |Directly sets the layer state (avoid unless you know what you are doing). |
|`layer_clear()` |Clears all layers (turns them all off). |
|`layer_move(layer)` |Turns specified layer on, and all other layers off. |
|`layer_on(layer)` |Turns specified layer on, leaves all other layers in existing state. |
|`layer_off(layer)` |Turns specified layer off, leaves all other layers in existing state. |
|`layer_invert(layer)` |Inverts/toggles the state of the specified layer |
|`layer_or(layer_mask)` |Turns on layers based on matching bits between specified layer and existing layer state. |
|`layer_and(layer_mask)` |Turns on layers based on matching enabled bits between specified layer and existing layer state. |
|`layer_xor(layer_mask)` |Turns on layers based on non-matching bits between specified layer and existing layer state. |
|`layer_debug(layer_mask)` |Prints out the current bit mask and highest active layer to debugger console. |
|`default_layer_set(layer_mask)` |Directly sets the default layer state (avoid unless you know what you are doing). |
|`default_layer_or(layer_mask)` |Turns on layers based on matching bits between specified layer and existing default layer state. |
|`default_layer_and(layer_mask)` |Turns on layers based on matching enabled bits between specified layer and existing default layer state.|
|`default_layer_xor(layer_mask)` |Turns on layers based on non-matching bits between specified layer and existing default layer state. |
|`default_layer_debug(layer_mask)` |Prints out the current bit mask and highest active default layer to debugger console. |
|[`set_single_default_layer(layer)`](ref_functions.md#setting-the-persistent-default-layer) |Sets the default layer, but does _not_ write it to persistent memory (EEPROM). |
|[`set_single_persistent_default_layer(layer)`](ref_functions.md#setting-the-persistent-default-layer)|Sets the default layer and writes it to persistent memory (EEPROM). |
|[`update_tri_layer(x, y, z)`](ref_functions.md#update_tri_layerx-y-z) |Checks if layers `x` and `y` are both on, and sets `z` based on that (on if both on, otherwise off).|
|[`update_tri_layer_state(state, x, y, z)`](ref_functions.md#update_tri_layer_statestate-x-y-z) |Does the same as `update_tri_layer(x, y, z)`, but from `layer_state_set_*` functions. |
In addition to the functions that you can call, there are a number of callback functions that get called every time the layer changes. This passes the layer state to the function, where it can be read or modified.

View File

@@ -119,7 +119,8 @@ This is ideal for when you want ensure everything compiles successfully when pre
## Examples
For a brief example, checkout [`/users/_example/`](https://github.com/qmk/qmk_firmware/tree/master/users/_example).
For a more complicated example, checkout [`/users/drashna/`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna)'s userspace.
For more complicated examples, checkout the [`awesome-qmk` collection](https://github.com/qmk/awesome-qmk).
### Customized Functions
@@ -189,7 +190,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
If you wanted to consolidate macros and other functions into your userspace for all of your keymaps, you can do that. This builds upon the [Customized Functions](#customized-functions) example above. This lets you maintain a bunch of macros that are shared between the different keyboards, and allow for keyboard specific macros, too.
First, you'd want to go through all of your `keymap.c` files and replace `process_record_user` with `process_record_keymap` instead. This way, you can still use keyboard specific codes on those boards, and use your custom "global" keycodes as well. You'll also want to replace `SAFE_RANGE` with `NEW_SAFE_RANGE` so that you wont have any overlapping keycodes
First, you'd want to go through all of your `keymap.c` files and replace `process_record_user` with `process_record_keymap` instead. This way, you can still use keyboard specific codes on those boards, and use your custom "global" keycodes as well. You'll also want to replace `SAFE_RANGE` with `NEW_SAFE_RANGE` so that you won't have any overlapping keycodes
Then add `#include "<name>.h"` to all of your keymap.c files. This allows you to use these new keycodes without having to redefine them in each keymap.

View File

@@ -73,16 +73,13 @@ Should you rather choose to generate and use your own sample-table with the DAC
### PWM (software)
if the DAC pins are unavailable (or the MCU has no usable DAC at all, like STM32F1xx); PWM can be an alternative.
If the DAC pins are unavailable (or the MCU has no usable DAC at all, like STM32F1xx); PWM can be an alternative.
Note that there is currently only one speaker/pin supported.
set in `rules.mk`:
`AUDIO_DRIVER = pwm_software` and in `config.h`:
`#define AUDIO_PIN C13` (can be any pin) to have the selected pin output a pwm signal, generated from a timer callback which toggles the pin in software.
To use this feature, set `AUDIO_DRIVER = pwm_software` in `rules.mk` and set `#define AUDIO_PIN C13` (can be any pin) in `config.h` to have the selected pin output a pwm signal, generated from a timer callback which toggles the pin in software.
#### Wiring
the usual piezo wiring: red goes to the selected AUDIO_PIN, black goes to ground.
The usual piezo wiring: red goes to the selected AUDIO_PIN, black goes to ground.
OR if you can chose to drive one piezo with two pins, for example `#define AUDIO_PIN B1`, `#define AUDIO_PIN_ALT B2` in `config.h`, with `#define AUDIO_PIN_ALT_AS_NEGATIVE` - then the red lead could go to B1, the black to B2.
@@ -178,8 +175,8 @@ These keycodes turn all of the audio functionality on and off. Turning it off m
|`AUDIO_PIN` | *Not defined* |Configures the pin that the speaker is connected to. |
|`AUDIO_PIN_ALT` | *Not defined* |Configures the pin for a second speaker or second pin connected to one speaker. |
|`AUDIO_PIN_ALT_AS_NEGATIVE` | *Not defined* |Enables support for one speaker connected to two pins. |
|`AUDIO_INIT_DELAY` | *Not defined* |Enables delay during startup song to accomidate for USB startup issues. |
|`AUDIO_ENABLE_TONE_MULTIPLEXING` | *Not defined* |Enables time splicing/multiplexing to create multiple tones simutaneously. |
|`AUDIO_INIT_DELAY` | *Not defined* |Enables delay during startup song to accommodate for USB startup issues. |
|`AUDIO_ENABLE_TONE_MULTIPLEXING` | *Not defined* |Enables time splicing/multiplexing to create multiple tones simultaneously. |
|`AUDIO_POWER_CONTROL_PIN` | *Not defined* |Enables power control code to enable or cut off power to speaker (such as with PAM8302 amp). |
|`AUDIO_POWER_CONTROL_PIN_ON_STATE`| `1` |The state of the audio power control pin when audio is "on" - `1` for high, `0` for low. |
|`STARTUP_SONG` | `STARTUP_SOUND` |Plays when the keyboard starts up (audio.c) |

55
docs/features/battery.md Normal file
View File

@@ -0,0 +1,55 @@
# Battery
This feature provides the high level abstraction for sampling battery level.
## Usage
To use this driver, add the following to your `rules.mk`:
```make
BATTERY_ENABLE = yes
```
## Basic Configuration {#basic-configuration}
Add the following to your `config.h`:
|Define |Default |Description |
|--------------------------|--------|--------------------------------------------------|
|`BATTERY_SAMPLE_INTERVAL` |`30000` |The time between battery samples in milliseconds. |
## Driver Configuration {#driver-configuration}
See the [Battery Driver](../drivers/battery) documentation for more information.
## Functions
### `uint8_t battery_get_percent(void)` {#api-battery-get-percent}
Sample battery level.
#### Return Value {#api-battery-get-percent-return}
The battery percentage, in the range 0-100.
## Callbacks
### `void battery_percent_changed_user(uint8_t level)` {#api-battery-percent-changed-user}
User hook called when battery level changed.
### Arguments {#api-battery-percent-changed-user-arguments}
- `uint8_t level`
The battery percentage, in the range 0-100.
---
### `void battery_percent_changed_kb(uint8_t level)` {#api-battery-percent-changed-kb}
Keyboard hook called when battery level changed.
### Arguments {#api-battery-percent-changed-kb-arguments}
- `uint8_t level`
The battery percentage, in the range 0-100.

View File

@@ -46,7 +46,7 @@ When [handedness](split_keyboard#setting-handedness) is predetermined via option
}
```
If you pick the top right key for the right half, it is `R05` on the top layout. Within the key matrix below, `R05` is located on row 4 columnn 4. To use that key as the right half's Bootmagic trigger, add these entries to your `config.h` file:
If you pick the top right key for the right half, it is `R05` on the top layout. Within the key matrix below, `R05` is located on row 4 column 4. To use that key as the right half's Bootmagic trigger, add these entries to your `config.h` file:
```c
#define BOOTMAGIC_ROW_RIGHT 4

View File

@@ -0,0 +1,164 @@
# Community Modules
Community Modules are a feature within QMK which allows code to be implemented by third parties, making it available for other people to import into their own builds.
These modules can provide implementations which override or enhance normal QMK processing; initialization, key processing, suspend, and shutdown are some of the provided hooks which modules may implement.
## Adding a Community Module to your build
Community Modules have first-class support for [External Userspace](/newbs_external_userspace), and QMK strongly recommends using External Userspace for hosting keymaps and Community Modules together.
Modules must live in either of two locations:
* `<QMK_USERSPACE>/modules/`
* `<QMK_FIRMWARE>/modules/`
A basic module is provided within QMK itself -- `qmk/hello_world` -- which prints out a notification over [HID console](/faq_debug) after 10 seconds, and adds a new keycode, `COMMUNITY_MODULE_HELLO` (aliased to `CM_HELO`) which types `Hello there.` to the active application when the corresponding key is pressed.
To add this module to your build, in your keymap's directory create a `keymap.json` with the following content:
```json
{
"modules": [
"qmk/hello_world"
]
}
```
If you already have a `keymap.json`, you'll need to manually merge the `modules` section into your keymap.
::: warning
Community Modules are not supported by QMK Configurator. If you wish to use Community Modules, you must build your own firmware.
:::
## Adding a Community Module to your External Userspace
Module authors are encouraged to provide a git repository on GitHub which may be imported into a user's external userspace. If a user wishes to import a module repository, they can do the following:
```sh
cd /path/to/your/external/userspace
mkdir -p modules
# Replace the following {user} and {repo} with the author's community module repository
git submodule add https://github.com/{user}/{repo}.git modules/{user}
git submodule update --init --recursive
```
This will ensure the copy of the module is made in your userspace.
Add a new entry into your `keymap.json` with the desired modules, replacing `{user}` and `{module_name}` as appropriate:
```json
{
"modules": [
"qmk/hello_world",
"{user}/{module_name}"
]
}
```
::: info
The module listed in `keymap.json` is the relative path within the `modules/` directory. So long as the module is present _somewhere_ under `modules/`, then the `keymap.json` can refer to that path.
:::
## Writing a QMK Community Module
As stated earlier, Community Module authors are strongly encouraged to provide their modules through git, allowing users to leverage submodules to import functionality.
### `qmk_module.json`
A Community Module is denoted by a `qmk_module.json` file such as the following:
```json
{
"module_name": "Hello World",
"maintainer": "QMK Maintainers",
"license": "GPL-2.0-or-later",
"features": {
"deferred_exec": true
},
"keycodes": [
{
"key": "COMMUNITY_MODULE_HELLO",
"aliases": ["CM_HELO"]
}
]
}
```
At minimum, the module must provide the `module_name` and `maintainer` fields.
The `license` field is encouraged to indicate the terms for using and sharing the module. It is recommended to use a [SPDX license identifier](https://spdx.org/licenses/) like "`Apache-2.0`" or "`GPL-2.0-or-later`" if possible.
The `url` field may specify a URL to more information about the module.
The use of `features` matches the definition normally provided within `keyboard.json` and `info.json`, allowing a module to signal to the build system that it has its own dependencies. In the example above, it enables the _deferred executor_ feature whenever the above module is used in a build.
The `keycodes` array allows a module to provide new keycodes (as well as corresponding aliases) to a 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.
### `<module>.c`
This file will be automatically added to the build if the filename matches the directory name. For example, the `qmk/hello_world` module contains a `hello_world.c` file, which is automatically added to the build.
::: info
Other files intended to be included must use the normal method of `SRC += my_file.c` inside `rules.mk`.
:::
::: tip
This file should use `ASSERT_COMMUNITY_MODULES_MIN_API_VERSION(1,0,0);` to enforce a minimum version of the API that it requires, ensuring the Community Module is built with a compatible version of QMK. The list of APIs and corresponding version is given at the bottom of this document. Note the use of commas instead of periods.
:::
### `introspection.c` / `introspection.h`
These two files hook into the keymap introspection logic -- the header is prepended before the user keymap, and the C source file is appended after the user keymap.
The header may provide definitions which are useful to the user's `keymap.c`.
The source file may provide functions which allow access to information specified in the user's `keymap.c`.
::: warning
Introspection is a relatively advanced topic within QMK, and existing patterns should be followed. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on Discord](https://discord.gg/qmk).
:::
### `led_matrix_module.inc`
This file defines LED matrix effects in the same form as used with `led_matrix_kb.inc` and `led_matrix_user.inc` (see [Custom LED Matrix Effects](led_matrix#custom-led-matrix-effects)). Effect mode names are prepended with `LED_MATRIX_COMMUNITY_MODULE_`.
### `rgb_matrix_module.inc`
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_`.
### 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` |
| `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` |
| `rgb_matrix_indicators_advanced` | `rgb_matrix_indicators_advanced_<module>` | `rgb_matrix_indicators_advanced_hello_world` | `1.1.0` |
| `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.
:::
Each API has an equivalent `_<module>_kb()` and `_<module>_user()` hook, as per the normal QMK [`_quantum`, `_kb`, and `_user` functions](/custom_quantum_functions#a-word-on-core-vs-keyboards-vs-keymap).

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