Merge tag '0.17.5'

* tag '0.17.5': (117 commits) MSYS2 install: use MinGW python-qmk package (qmk#17302) My ErgoDox Keymap (finally perfected, I think) (qmk#17208) Add BigBoy macro pad (qmk#16962) [Keyboard] Add Support to Ducky One2 SF (qmk#17260) add rotary encoder support for Quark^2 (qmk#17470) [Keyboard]KPrepublic bm80v2 Keyboard ANSI support (qmk#17192) add crkbd/keymaps/bermeo (qmk#17320) [keyboard] annepro2 Add support for sticky keys (qmk#17359) Cleanup post-qmk#17314. (qmk#17536) [keymap] Add tiny text, full width characters to Ergodone->Vega (qmk#17427) Added 3 new keyboards (qmk#17314) feat(keymap): add keebio/iris/rev6/radlinskii keymap (qmk#17216) Allow for RGB actions to take place on Keydown instead of Keyup (qmk#16886) Add note about qmk doctor in newbs_flashing.md (qmk#15688) [Keyboard] New IDOBAO ID63 (a.k.a. Denwir D60) (qmk#17144) Added VIA support for Drop CTRL (qmk#17336) Add keymaps for muralis and kuru (qmk#17337) Swift65 Hotswap Support (qmk#16987) Add Jpe230 Preonic Keymap (qmk#17331) Add personal YMDK Split64 keymap (qmk#16980) ...
tim-bennett83 · Jul 21, 2022 · 24c1665 · 24c1665
2 parents f9fdb98 + 25033d5
commit 24c1665
Show file tree

Hide file tree

Showing 886 changed files with 37,369 additions and 5,269 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
diff --git a/.github/stale.yml b/.github/stale.yml
diff --git a/.github/workflows/api.yml b/.github/workflows/api.yml
@@ -18,7 +18,7 @@ jobs:
     if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 1
         persist-credentials: false

diff --git a/.github/workflows/auto_tag.yml b/.github/workflows/auto_tag.yml
@@ -22,12 +22,12 @@ jobs:
     if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
 
     - name: Bump version and push tag
-      uses: anothrNick/github-tag-action@1.26.0
+      uses: anothrNick/github-tag-action@1.39.0
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         DEFAULT_BUMP: 'patch'
diff --git a/.github/workflows/cli.yml b/.github/workflows/cli.yml
@@ -18,7 +18,7 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         submodules: recursive
     - name: Install dependencies

diff --git a/.github/workflows/develop_api.yml b/.github/workflows/develop_api.yml
@@ -18,7 +18,7 @@ jobs:
     if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 1
         persist-credentials: false

diff --git a/.github/workflows/develop_update.yml b/.github/workflows/develop_update.yml
@@ -12,7 +12,7 @@ jobs:
     if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         token: ${{ secrets.QMK_BOT_TOKEN }}
         fetch-depth: 0

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -20,7 +20,7 @@ jobs:
     if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 1
 
@@ -34,7 +34,7 @@ jobs:
         qmk --verbose generate-docs
 
     - name: Deploy
-      uses: JamesIves/github-pages-deploy-action@3.7.1
+      uses: JamesIves/github-pages-deploy-action@v4.3.4
       with:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         BASE_BRANCH: master

diff --git a/.github/workflows/feature_branch_update.yml b/.github/workflows/feature_branch_update.yml
@@ -17,7 +17,7 @@ jobs:
         - xap
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         token: ${{ secrets.QMK_BOT_TOKEN }}
         fetch-depth: 0

diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -19,7 +19,7 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
 

diff --git a/.github/workflows/format_push.yml b/.github/workflows/format_push.yml
@@ -13,7 +13,7 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
 
@@ -37,7 +37,7 @@ jobs:
         git config user.email 'hello@qmk.fm'
 
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v3
+      uses: peter-evans/create-pull-request@v4
       if: ${{ github.repository == 'qmk/qmk_firmware'}}
       with:
         token: ${{ secrets.QMK_BOT_TOKEN }}

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -12,7 +12,7 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
 

diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -16,8 +16,6 @@ jobs:
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
-          debug-only: true
-
           remove-stale-when-updated: true
           exempt-draft-pr: true
           ascending: true
@@ -26,7 +24,7 @@ jobs:
           stale-issue-label: stale
           days-before-issue-stale: 90
           days-before-issue-close: 30
-          exempt-issue-labels: awaiting review,breaking_change,in progress,on hold
+          exempt-issue-labels: bug,in progress,on hold,discussion,to do
 
           stale-issue-message: >
             This issue has been automatically marked as stale because it has not had activity in the
@@ -45,7 +43,7 @@ jobs:
           stale-pr-label: stale
           days-before-pr-stale: 45
           days-before-pr-close: 30
-          exempt-pr-labels: bug,in progress,on hold,discussion,to do
+          exempt-pr-labels: bug,awaiting review,breaking_change,in progress,on hold
 
           stale-pr-message: >
             Thank you for your contribution!
@@ -54,8 +52,8 @@ jobs:
             activity in the last 45 days. It will be closed in 30 days if no further activity occurs.
             Please feel free to give a status update now, or re-open when it's ready.
 
-            For maintainers: Please label with `awaiting review`, `breaking_change`, `in progress`, or `on hold` to prevent
-            the issue from being re-flagged.
+            For maintainers: Please label with `bug`, `awaiting review`, `breaking_change`, `in progress`, or `on hold`
+            to prevent the issue from being re-flagged.
 
           close-pr-message: >
             Thank you for your contribution!

diff --git a/.github/workflows/unit_test.yml b/.github/workflows/unit_test.yml
@@ -23,7 +23,7 @@ jobs:
     container: qmkfm/qmk_cli
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         submodules: recursive
     - name: Install dependencies

diff --git a/.gitignore b/.gitignore
@@ -67,10 +67,12 @@ CMakeLists.txt
 .vscode/temp.sql
 tags
 
-# Ignore image files
+# Ignore image/font files
 *.gif
 *.jpg
 *.png
+*.ttf
+*.otf
 
 # Things Travis sees
 /.vs

diff --git a/docs/cli_tab_complete.md b/docs/cli_tab_complete.md
@@ -14,6 +14,10 @@ Add this to the end of your `.profile` or `.bashrc`:
 
 If you put `qmk_firmware` into another location you will need to adjust this path.
 
+Zsh users will need to load `bashcompinit`. The following can be added to `~/.zshrc` file:
+
+    autoload -Uz bashcompinit && bashcompinit
+
 ### System Wide Symlink
 
 If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script:

diff --git a/docs/compatible_microcontrollers.md b/docs/compatible_microcontrollers.md
@@ -2,6 +2,8 @@
 
 QMK runs on any USB-capable AVR or ARM microcontroller with enough flash space - generally 32kB+ for AVR, and 64kB+ for ARM. With significant disabling of features, QMK may *just* squeeze into 16kB AVR MCUs.
 
+Features within QMK may or may not be compatible with every microcontroller.
+
 ## Atmel AVR
 
 The following use [LUFA](https://www.fourwalledcubicle.com/LUFA.php) as the USB stack:

diff --git a/docs/feature_midi.md b/docs/feature_midi.md
@@ -10,6 +10,10 @@ MIDI_ENABLE = yes
 
 There are two MIDI systems in QMK: basic and advanced. With basic MIDI you will only be able to send Note On and Note Off messages using the note keycodes, meaning that keycodes like `MI_OCTU` and `MI_OCTD` will not work. Advanced MIDI allows you to do things like octave shifts, channel changes, velocity changes, modulation, and more.
 
+### Caveats
+
+MIDI requires 2 USB endpoints and as such may not work on some hardware such as V-USB controllers.
+
 ### Basic MIDI
 
 To enable basic MIDI, add the following to your `config.h`:

diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
@@ -777,6 +777,7 @@ These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master
 #define RGB_MATRIX_DISABLE_KEYCODES // disables control of rgb matrix by keycodes (must use code functions to control the feature)
 #define RGB_MATRIX_SPLIT { X, Y } 	// (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
                               		// If RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
+#define RGB_TRIGGER_ON_KEYDOWN      // Triggers RGB keypress events on key down. This makes RGB control feel more responsive. This may cause RGB to not function properly on some boards
 ```
 
 ## EEPROM storage :id=eeprom-storage

diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
@@ -10,6 +10,8 @@ For this, we will mostly be talking about the generic implementation used by the
 
 !> ARM split supports most QMK subsystems when using the 'serial' and 'serial_usart' drivers. I2C slave is currently unsupported.
 
+!> Both sides must use the same MCU family, for eg two Pro Micro-compatible controllers or two Blackpills. Currently, mixing AVR and ARM is not possible as ARM vs AVR uses different method for serial communication, and are not compatible. Moreover Blackpill's uses 3.3v logic, and atmega32u4 uses 5v logic.
+
 ## Compatibility Overview
 
 | Transport                    | AVR                | ARM                |

diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md
@@ -108,6 +108,8 @@ However, this does rely on the bootloader being set by the keyboard. If this inf
 
 In this case, you'll have to fall back on specifying the bootloader. See the [Flashing Firmware](flashing.md) Guide for more details.
 
+!> If your bootloader is not detected by `qmk flash`, try running `qmk doctor` for suggestions on how to fix common problems.
+
 ## Test It Out!
 
 Congrats! Your custom firmware has been programmed to your keyboard and you're ready to test it out!

diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
@@ -36,21 +36,15 @@ Alternatively, if you'd like to manually install MSYS2, the following section wi
 
 #### Prerequisites
 
-You will need to install MSYS2, Git and Python. Follow the installation instructions on https://www.msys2.org.
-
-Once MSYS2 is installed, close any open MSYS terminals and open a new MinGW 64-bit terminal.
+You will need to install [MSYS2](https://www.msys2.org). Once installed, close any open MSYS terminals (purple icon) and open a new MinGW 64-bit terminal (blue icon) from the Start Menu.
 
 !> **NOTE:** The MinGW 64-bit terminal is *not* the same as the MSYS terminal that opens when installation is completed. Your prompt should say "MINGW64" in purple text, rather than "MSYS". See [this page](https://www.msys2.org/wiki/MSYS2-introduction/#subsystems) for more information on the differences.
 
-Then run the following command:
-
-    pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-toolchain mingw-w64-x86_64-python3-pip mingw-w64-x86_64-python-pillow
-
 #### Installation
 
 Install the QMK CLI by running:
 
-    python3 -m pip install qmk
+    pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-python-qmk
 
 </details>
 

diff --git a/docs/ref_functions.md b/docs/ref_functions.md
@@ -87,9 +87,13 @@ To configure the default layer sounds, you would want to define this in your `co
 
 ## Resetting the keyboard
 
-There is the `RESET` quantum keycode that you can use. But if you want to reset the board as part of a macro, rather than hitting a key separately, you can do that.
+There is the `QK_REBOOT` or `QK_RBT` quantum keycode that you can use. But if you want to reset the board as part of a macro, rather than hitting a key separately, you can do that.
 
-And to do so, add `reset_keyboard()` to your function or macro, and this will reset to bootloader.
+And to do so, add `soft_reset_keyboard()` to your function or macro.
+
+## Reset to bootloader
+
+To reset to the bootloader use `QK_BOOTLOADER` or `QK_BOOT` keycode or `reset_keyboard()` function.
 
 ## Wiping the EEPROM (Persistent Storage)