Compare commits

..

1 Commits

Author SHA1 Message Date
Nick Brassel d7b4bb06ee Update ChibiOS-Contrib. 2025-10-27 15:28:54 +11:00
2332 changed files with 7426 additions and 33885 deletions
-243
View File
@@ -1,243 +0,0 @@
---
applyTo: "keyboards/**"
excludeAgent:
- "coding-agent"
---
# GitHub Copilot Instructions for QMK Pull Request Review
This document provides automated review guidance based on the [QMK PR Checklist](https://docs.qmk.fm/pr_checklist) and it is intended only for use by GitHub Copilot code-review agent during pull request reviews.
> **Scope**: This review applies **only to changes within the `keyboards/` folder**. Changes outside `keyboards/` (e.g., core code, quantum, platforms, drivers) must be flagged and deferred to a QMK Collaborator — do not review them.
## General PR Requirements
### Branch and Submission Standards
- **Source Branch Policy**: Verify PR is NOT submitted from submitter's own `master` branch
- Flag if submitter is using their own `master` branch as source
- Suggest using feature branches instead for cleaner fork management
- **Target Branch Policy**:
- **New keyboard additions** → `master` branch (new folders under `keyboards/`)
- **All other changes** → `develop` branch:
- Keyboard updates, refactors, or moves
- Core code changes
- Data-driven configuration migrations
- Any modifications to existing keyboards
- **PR Scope**: PRs should contain the smallest set of modifications for a single change
- Flag PRs that modify multiple keyboards simultaneously
- Suggest splitting large PRs into focused, incremental changes
- **Merge Conflicts**: Check for unresolved merge conflicts
### File Naming and Structure
- **Lowercase Requirement**: All new directories and filenames must be lowercase
- Exception: Upstream sources with original uppercase (LUFA, ChibiOS)
- Exception: Core files with valid justification
- **Reject**: Board designer preference for uppercase is NOT valid justification
### License Headers
- **Required**: Valid license headers on all `*.c` and `*.h` files
- **Recommended**: GPL2/GPL3 for consistency
- **Format**: Check for proper GPL2+ header or SPDX identifier
```c
// Copyright 2024 Your Name (@yourgithub)
// SPDX-License-Identifier: GPL-2.0-or-later
```
- **Exception**: Simple assignment-only `rules.mk` files don't need headers
- **Flag**: Missing or ambiguous license headers (blocks merge)
---
## Keymap PR Reviews
**Scope**: These rules apply to files within `keyboards/*/keymaps/*` subdirectories.
### Note on Non-Default Keymaps
- Any keymap folder named something other than `default` (e.g., `default_clueboard`, `via`) is a non-default keymap
- **Do not review the content** of non-default keymaps — flag their presence and note that a QMK Collaborator must review them
### Keymap Code Standards
- **Includes**: `#include QMK_KEYBOARD_H` preferred over specific board files
- **Enums**: Suggest using layer enums instead of `#define`s for layers (soft suggestion only)
- **Custom Keycodes**: First entry must be `QK_USER`
- **VIA**: Keymaps should NOT enable VIA
- VIA keymaps belong in [VIA QMK Userspace](https://github.com/the-via/qmk_userspace_via)
---
## Keyboard PR Reviews
**Scope**: These rules apply to keyboard-level files in `keyboards/*` directories, excluding files within the `keymaps/` subdirectories. This includes:
- `info.json` or `keyboard.json` (keyboard root or variant level)
- `readme.md` (keyboard level)
- `rules.mk` (keyboard level)
- `config.h` (keyboard level, not keymap level)
- `<keyboard>.c` and `<keyboard>.h` files
- Hardware configuration files (`halconf.h`, `mcuconf.h`, `chconf.h`)
### Branch Targeting
- **New Keyboards**: Target `master` branch
- New additions to `keyboards/` folder submit to `master`
- **Keyboard Moves**: Must target `develop` branch
- Check `data/mappings/keyboard_aliases.hjson` is updated for moves
- **Keyboard Updates/Refactors**: Must target `develop` to reduce merge conflicts
- **Data Driven Migration**: Must target `develop`
### info.json and keyboard.json Requirements
- **Schema Validation**: Verify that `info.json` and `keyboard.json` files are valid JSON (no syntax errors, no trailing commas, properly closed brackets)
- **Mandatory Elements**:
- `url` field is present and begins with `http://` or `https://`
- `maintainer` field is present and non-empty
- `usb.vid` and `usb.pid` fields are present and match the `0x` hexadecimal format (e.g. `"vid": "0x1234"`, `"pid": "0xFEED"`)
- `usb.device_version` field is present
- Each key entry in every `layout` array must include a `"matrix"` property (e.g. `{"label": "L01", "matrix": [0, 0], "x": 0, "y": 0}`)
- Microcontroller and bootloader specified
- Diode direction (if not using direct pins)
- **Layout Naming**:
- Single layout: Must be named `LAYOUT` or match `LAYOUT_*` pattern
- Multiple layouts: Must include `LAYOUT_all` plus at least one alternate name
### readme.md Requirements
- **Template**: Must follow [official template](https://github.com/qmk/qmk_firmware/blob/master/data/templates/keyboard/readme.md)
- **Flash Command**: Present with `:flash` at end
- **Hardware Link**: Valid availability link (unless handwired)
- Private groupbuys acceptable
- Open-source should link to files
- **Reset Instructions**: Bootloader reset instructions must be present (non-empty)
- **Images**: A keyboard image is preferred but not mandatory
- If present, images must not be hosted in the repository
- If an imgur URL is used, it must link directly to the image (i.e. `https://i.imgur.com/<id>.<ext>`), not the preview page (i.e. not `https://imgur.com/<id>`)
### rules.mk Standards
- **Removed Items**:
- Size comments like `(-/+size)`
### config.h Standards (Keyboard Level)
- **Prohibited**:
- `#define DESCRIPTION`
- Comment blocks explaining features
- Commented-out unused defines
- `#include "config_common.h"`
- **No Vial**: Vial-related files/changes not accepted
### Keyboard Implementation Files
#### `<keyboard>.c`
- **Advanced Code Flag**: ⚠️ If a `<keyboard>.c` file is present in the PR, flag it as possible advanced code requiring QMK Collaborator review
#### `<keyboard>.h`
- **Include**: `#include "quantum.h"` at top
- **Layout Macros**: If `LAYOUT` macros are present, suggest moving them to `info.json` or `keyboard.json`
### Default Keymap Standards
**Scope**: These rules specifically apply to files within `keyboards/*/keymaps/default/` directories.
- **Pristine Requirement**: Bare minimum clean slate
- ⚠️ If `keymap.c` contains anything beyond the `keymaps[]` array, or if the `default` keymap folder contains additional `.c` or `.h` files, flag this as possible advanced code requiring QMK Collaborator review
- **Removed Examples**: Delete `QMKBEST`/`QMKURL` macros
- **Tri Layer**: Use Tri Layer feature instead of manual `layer_on/off()` + `update_tri_layer()`
- **Encoder Map**: Use encoder map feature, `encoder_update_user()` may not be present
- **No VIA**: Default keymap should not enable VIA
### Prohibited Files
- **No VIA JSON**: Belongs in [VIA Keyboard Repo](https://github.com/the-via/keyboards)
- **No KLE JSON**: Not used within QMK
- **Single Keyboard Per PR**: A PR must not modify more than one `keyboards/<folder>/` directory
- Flag PRs that touch multiple top-level keyboard folders (e.g., both `keyboards/mykeyboard1/` and `keyboards/mykeyboard2/`) — each keyboard must be a separate PR
- **No Cross-Keyboard Sources**: Don't include files from other keyboard vendors
- Exception: Core files (e.g., `drivers/sensors/pmw3360.c`)
- Use of vendor-specific code (e.g., `wilba_tech/wt_main.c`) only when keyboard exists in the same enclosing vendor folder (e.g. a `wilba_tech` keyboard)
---
## Review Response Templates
### For source master branch usage:
```
⚠️ This PR appears to be submitted from your own `master` branch. For future PRs, we recommend using feature branches instead of committing to your `master`. This makes it easier to keep your fork updated and manage multiple PRs.
See: [Best Practices: Your Fork's Master](https://docs.qmk.fm/newbs_git_using_your_master_branch)
```
### For incorrect target branch:
```
❌ This PR targets the wrong branch:
- **New keyboard additions** should target `master`
- **Keyboard updates/refactors/moves** should target `develop`
Please change the target branch accordingly.
```
### For missing license headers:
```
❌ Missing GPL-compatible license headers on the following files:
- [list files]
Please add GPL2+ headers (GPL2/GPL3 recommended). Example:
\`\`\`c
// Copyright 2024 Your Name (@yourgithub)
// SPDX-License-Identifier: GPL-2.0-or-later
\`\`\`
```
### For non-lowercase filenames:
```
❌ The following files/directories must be lowercase:
- [list files]
Exception: Only valid if from upstream sources (LUFA, ChibiOS) or justified by core consistency.
```
### For config.h violations:
```
⚠️ Found prohibited config.h elements:
- [list specific issues: `#define DESCRIPTION`, `#include "config_common.h"`, comment blocks, commented-out defines]
Please remove these and refer to [Data Driven Configuration](https://docs.qmk.fm/data_driven_config).
```
### For info.json or keyboard.json issues:
```
⚠️ info.json or keyboard.json needs attention:
- [list missing mandatory fields]
- Please run: \`qmk format-json -i path/to/info.json\` (or keyboard.json)
- Validate with: \`qmk lint -kb <keyboard_name>\`
```
### For non-pristine default keymap:
```
⚠️ Default keymap requires collaborator review:
The default `keymap.c` contains code beyond the `keymaps[]` array. The following was detected:
- [describe: extra functions/definitions in keymap.c, or additional .c/.h files in the default keymap folder]
A QMK Collaborator must review this before merging.
```
### For non-default keymaps:
```
⚠️ Non-default keymap detected: `keyboards/[path]/keymaps/[name]/`
This keymap requires a QMK Collaborator to review its content. No automated review of its code was performed.
```
### For `<keyboard>.c` detected:
```
⚠️ `<keyboard>.c` file detected: `keyboards/[path]/[keyboard].c`
This file may contain advanced hardware configuration. A QMK Collaborator must review this before merging.
```
---
## Constraints and Conduct
- **Scope**: Only review changes within the `keyboards/` folder. Flag any changes outside `keyboards/` and defer to a QMK Collaborator without reviewing them.
- Focus reviews on **objective checklist items** that can be automatically verified
- Flag **definite violations** with ❌
- Suggest improvements for **recommendations** with ⚠️
- **Provide specific file/line references** when flagging issues
- **Link to relevant QMK documentation** for each issue
- **Prioritize blocking issues** (license, merge conflicts, branch policy)
- **Be constructive**: Suggest fixes, not just problems
- **Do not review non-default keymaps** — flag their presence and defer to a QMK Collaborator
- **Do not review `<keyboard>.c` content in detail** — flag its presence and defer to a QMK Collaborator
This is meant as a **first-pass review** to catch common issues before human review. Complex architectural decisions, code quality, and subjective assessments still require human QMK Collaborator review.
+1 -1
View File
@@ -25,7 +25,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
fetch-depth: 1
persist-credentials: false
+1 -1
View File
@@ -4,7 +4,7 @@ permissions: {}
on:
schedule:
- cron: "*/30 * * * *"
- cron: "*/5 * * * *"
jobs:
automatic_approve:
+1 -1
View File
@@ -28,7 +28,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
fetch-depth: 0
-289
View File
@@ -1,289 +0,0 @@
name: Bootstrap Script Testing
on:
push:
branches: [master, develop, xap]
paths:
- 'util/env-bootstrap.sh'
- '.github/workflows/bootstrap_testing.yml'
pull_request:
paths:
- 'util/env-bootstrap.sh'
- '.github/workflows/bootstrap_testing.yml'
workflow_dispatch:
permissions:
contents: read
jobs:
prep:
runs-on: ubuntu-latest
outputs:
any_changed: ${{ steps.file_changes.outputs.any_changed }}
steps:
- name: Get changed files
id: file_changes
if: ${{ github.event_name == 'pull_request' }}
uses: tj-actions/changed-files@v47
with:
use_rest_api: true
files: |
util/env-bootstrap.sh
.github/workflows/bootstrap_testing.yml
bootstrap-test-linux:
name: Bootstrap (Linux)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
distribution:
# Ubuntu/Debian based
- debian:11
- debian:12
- debian:13
- ubuntu:22.04
- ubuntu:24.04
- ubuntu:26.04
# RHEL/CentOS/Fedora based
- fedora:42
- fedora:43
- fedora:44
- rockylinux:8
- rockylinux:9
- rockylinux/rockylinux:10
- almalinux:8
- almalinux:9
- almalinux:10
# OpenSUSE based (we skip Tumbleweed as it has issues with package mirrors regularly being out of date)
- opensuse/leap:latest
# Gentoo-based
- gentoo/stage3:latest
# Arch based
- archlinux:latest
- cachyos/cachyos:latest
- manjarolinux/base:latest
container:
image: ${{ matrix.distribution }}
options: --privileged
steps:
- name: Install base dependencies
run: |
# Attempt to run the package installation up to 10 times to mitigate transient network issues
for n in $(seq 1 10); do
{
echo "Attempt #$n of 10 to install base dependencies:"
case "${{ matrix.distribution }}" in
*ubuntu*|*debian*)
apt-get update
apt-get install -y sudo git passwd
;;
*fedora*|*rockylinux*|*almalinux*)
dnf install -y sudo git passwd findutils # findutils=xargs
;;
*suse*)
zypper --non-interactive refresh
zypper --non-interactive install sudo git shadow findutils tar # findutils=xargs
;;
*gentoo*)
emerge-webrsync
emerge --noreplace --ask=n sudo dev-vcs/git shadow findutils # findutils=xargs
;;
*archlinux*|*cachyos*|*manjaro*)
pacman -Syu --noconfirm
pacman -S --noconfirm sudo git
;;
esac
} && break || sleep 10
done
# Fix PAM configuration for sudo in containers
# Fix /etc/shadow permissions - common issue in container environments
chmod 640 /etc/shadow || chmod 400 /etc/shadow || true
# Disable problematic PAM modules that commonly fail in RHEL-like containers
sed -i 's/^session.*pam_systemd.so/#&/' /etc/pam.d/sudo || true
sed -i 's/^session.*pam_loginuid.so/#&/' /etc/pam.d/sudo || true
# Ensure proper sudoers configuration
echo 'Defaults !requiretty' >> /etc/sudoers
echo 'Defaults secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"' >> /etc/sudoers
- name: Checkout repository
uses: actions/checkout@v7
with:
fetch-depth: 1
submodules: recursive
path: qmk_firmware
- name: Create test user
run: |
# Create a test user for the bootstrap script
useradd -m -s /bin/bash -U testuser
echo 'testuser:testpassword' | chpasswd || true
# Configure passwordless sudo
echo "root ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers # some distros complain about root not being in sudoers
echo "testuser ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
# Test sudo functionality
sudo -u testuser whoami || echo "Sudo test failed, but continuing..."
- name: Move QMK repository to test user home
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git -C qmk_firmware remote add upstream https://github.com/qmk/qmk_firmware.git
# Move the QMK repository to the test user's home directory
mv qmk_firmware /home/testuser/qmk_firmware
chown -R testuser:testuser /home/testuser/qmk_firmware
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Ensure the bootstrap script can access sudo
sudo -u testuser --preserve-env=GITHUB_TOKEN bash -c "
export CONFIRM=1
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
cd /home/testuser
bash /home/testuser/qmk_firmware/util/env-bootstrap.sh
"
- name: Install dependencies
run: |
sudo -u testuser bash -c "
/home/testuser/.local/share/uv/tools/qmk/bin/python -m pip install -r /home/testuser/qmk_firmware/requirements.txt
"
- name: Test QMK CLI
run: |
sudo -u testuser bash -c "
export PATH=/home/testuser/.local/bin:\$PATH
cd /home/testuser
qmk setup -y -H /home/testuser/qmk_firmware # setup implies doctor, no need to run it separately
cd /home/testuser/qmk_firmware
qmk mass-compile -j $(nproc) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset -p || touch .failed # Compile a bunch of different platforms
"
cd /home/testuser/qmk_firmware
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1
bootstrap-test-macos:
name: Bootstrap (macOS)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
strategy:
fail-fast: false
matrix:
os:
- macos-14 # Apple Silicon ARM64
- macos-15 # Apple Silicon ARM64
- macos-15-intel # Intel x64
- macos-26 # Apple Silicon ARM64
runs-on: ${{ matrix.os }}
steps:
- name: Checkout repository
uses: actions/checkout@v7
with:
fetch-depth: 1
submodules: recursive
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git remote add upstream https://github.com/qmk/qmk_firmware.git
# Run the bootstrap script
export CONFIRM=1
sh ./util/env-bootstrap.sh
- name: Install dependencies
run: |
$HOME/.local/share/uv/tools/qmk/bin/python -m pip install -r requirements.txt
- name: Test QMK CLI
run: |
# Add QMK CLI to PATH (bootstrap script installs it to ~/.local/bin on macOS)
export PATH="$HOME/.local/bin:$PATH"
qmk setup -y -H . # setup implies doctor, no need to run it separately
qmk mass-compile -j $(sysctl -n hw.ncpu) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset || touch .failed # Compile a bunch of different platforms
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1
bootstrap-test-windows:
name: Bootstrap (Windows)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
strategy:
fail-fast: false
matrix:
msys-variant:
- mingw64
- clang64
- ucrt64
runs-on: windows-latest
defaults:
run:
shell: msys2 {0}
steps:
- name: Install MSYS2
uses: msys2/setup-msys2@v2
with:
msystem: ${{ matrix.msys-variant }}
pacboy: >-
git:
- name: Checkout repository
uses: actions/checkout@v7
with:
fetch-depth: 1
submodules: recursive
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git remote add upstream https://github.com/qmk/qmk_firmware.git
# Run the bootstrap script
export CONFIRM=1
sh ./util/env-bootstrap.sh
- name: Install dependencies
run: |
/opt/uv/tools/qmk/Scripts/python -m pip install -r requirements.txt
- name: Test QMK CLI
run: |
# Add QMK CLI to PATH (bootstrap script installs it to /opt/uv/tools/bin on Windows MSYS2)
export PATH="/opt/uv/tools/bin:$PATH"
qmk setup -y -H . # setup implies doctor, no need to run it separately
qmk mass-compile -j $(nproc) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset || touch .failed # Compile a bunch of different platforms
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1
+21 -21
View File
@@ -32,36 +32,29 @@ jobs:
container: ghcr.io/qmk/qmk_cli
outputs:
keymaps: ${{ steps.generate_slice_length.outputs.keymaps }}
slice_length: ${{ steps.generate_slice_length.outputs.slice_length }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v7
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
uses: actions/checkout@v5
- name: Determine concurrency
id: generate_slice_length
shell: 'bash {0}'
run: |
targets=()
target_count=0
for target in "default" "xap"; do
count=$(qmk find -km $target 2>/dev/null | wc -l)
if [ $count -gt 0 ]; then
target_count=$(($target_count + $count))
targets+=($target)
fi
done
keymaps=$(jq -c -n '$ARGS.positional' --args "${targets[@]}")
target_count=$( {
qmk find -km default 2>/dev/null
qmk find -km xap 2>/dev/null
} | sort | uniq | wc -l)
slice_length=$((target_count / ($CONCURRENT_JOBS - 1))) # Err on the side of caution
echo "keymaps=$keymaps" >> $GITHUB_OUTPUT
echo "slice_length=$slice_length" >> $GITHUB_OUTPUT
build_targets:
@@ -70,7 +63,7 @@ jobs:
strategy:
fail-fast: false
matrix:
keymap: ${{ fromJson(needs.determine_concurrency.outputs.keymaps) }}
keymap: [default, xap]
uses: ./.github/workflows/ci_build_major_branch_keymap.yml
with:
branch: ${{ inputs.branch || github.ref_name }}
@@ -89,12 +82,12 @@ jobs:
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v7
uses: actions/checkout@v5
with:
fetch-depth: 0
- name: Download firmwares
uses: actions/download-artifact@v8
uses: actions/download-artifact@v5
with:
pattern: firmware-*
path: .
@@ -132,7 +125,14 @@ jobs:
SOURCE_DIR: .
DEST_DIR: ${{ inputs.branch || github.ref_name }}/latest
- name: Check if failure marker file exists
id: check_failure_marker
uses: andstor/file-existence-action@v3
with:
files: ./.failed
- name: Fail build if needed
if: steps.check_failure_marker.outputs.files_exists == 'true'
run: |
# Exit with failure if the compilation stage failed
[ ! -e .failed ] || exit 1
exit 1
@@ -27,29 +27,30 @@ jobs:
targets: ${{ steps.generate_targets.outputs.targets }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v7
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
uses: actions/checkout@v5
- name: Generate build targets
shell: 'bash {0}'
id: generate_targets
run: |
{ # Intentionally use `shuf` here so that we share manufacturers across all build groups -- some have a lot of ARM-based boards which inherently take longer
counter=0
echo -n '{'
qmk find -km ${{ inputs.keymap }} 2>/dev/null | sort | uniq | shuf --random-source=<(openssl enc -aes-256-ctr -pass pass:qmk -nosalt </dev/zero 2>/dev/null) | xargs -L${{ inputs.slice_length }} | while IFS=$'\n' read target ; do
qmk find -km ${{ inputs.keymap }} 2>/dev/null | sort | uniq | shuf | xargs -L${{ inputs.slice_length }} | while IFS=$'\n' read target ; do
if [ $counter -gt 0 ]; then
echo -n ','
fi
counter=$((counter+1))
printf "\"group-%02d\":{" $counter
printf "\"group %02d\":{" $counter
echo -n '"targets":"'
echo $target | tr ' ' '\n' | sort | uniq | xargs echo -n
echo -n '"}'
@@ -61,7 +62,7 @@ jobs:
echo "targets=$(jq -c 'keys' targets.json)" >> $GITHUB_OUTPUT
- name: Upload targets json
uses: actions/upload-artifact@v7
uses: actions/upload-artifact@v4
with:
name: targets-${{ inputs.keymap }}
path: targets.json
@@ -73,76 +74,45 @@ jobs:
container: ghcr.io/qmk/qmk_cli
continue-on-error: true
env:
CCACHE_CONFIGPATH: ~/.cache
strategy:
matrix:
target: ${{ fromJson(needs.generate_targets.outputs.targets) }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v7
with:
submodules: recursive
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
uses: actions/checkout@v5
- name: Get target definitions
uses: actions/download-artifact@v8
uses: actions/download-artifact@v5
with:
name: targets-${{ inputs.keymap }}
path: .
- name: Deploy submodules
run: |
qmk git-submodule -f
- name: Dump targets
run: |
jq -r '.["${{ matrix.target }}"].targets' targets.json | tr ' ' '\n' | sort
- name: Restore Cache
id: cache
uses: actions/cache/restore@v5
with:
path: ${{ env.CCACHE_CONFIGPATH }}
key: compile-${{ inputs.keymap }}-${{ matrix.target }}
- name: Build targets
continue-on-error: true
run: |
targets=$(jq -r '.["${{ matrix.target }}"].targets' targets.json | tr ' ' '\n' | sort)
if [ -z "${targets}" ]; then
echo "Zero build targets detected"
exit 0
fi
qmk mass-compile -t -j $(nproc) -e DUMP_CI_METADATA=yes -e USE_CCACHE=yes $targets || touch .failed
- name: Dump ccache stats
run: |
ccache -s
# Delete the old cache on hit to emulate a cache update. See https://github.com/actions/cache/issues/342.
- name: Delete old cache
env:
GH_TOKEN: ${{ github.token }}
if: steps.cache.outputs.cache-hit
run: |
count=$(gh cache list --ref ${{ github.ref }} --key ${{ steps.cache.outputs.cache-primary-key }} --json id | jq length)
if [ $count -gt 0 ]; then
gh cache delete --ref ${{ github.ref }} ${{ steps.cache.outputs.cache-primary-key }}
fi
- name: Save Cache
uses: actions/cache/save@v5
with:
path: ${{ env.CCACHE_CONFIGPATH }}
key: compile-${{ inputs.keymap }}-${{ matrix.target }}
export NCPUS=$(( $(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || getconf _NPROCESSORS_ONLN 2>/dev/null) -1 ))
qmk mass-compile -t -j $NCPUS -e DUMP_CI_METADATA=yes $(jq -r '.["${{ matrix.target }}"].targets' targets.json) || touch .failed
- name: Upload binaries
uses: actions/upload-artifact@v7
uses: actions/upload-artifact@v4
with:
name: firmware-${{ inputs.keymap }}-${{ matrix.target }}
if-no-files-found: ignore
@@ -166,17 +136,17 @@ jobs:
steps:
- name: Checkout QMK Firmware
uses: actions/checkout@v7
uses: actions/checkout@v5
- name: Download firmwares
uses: actions/download-artifact@v8
uses: actions/download-artifact@v5
with:
pattern: firmware-${{ inputs.keymap }}-*
path: .
merge-multiple: true
- name: Upload all firmwares
uses: actions/upload-artifact@v7
uses: actions/upload-artifact@v4
with:
name: firmware-${{ inputs.keymap }}
if-no-files-found: ignore
@@ -195,7 +165,7 @@ jobs:
truncate --size='<960K' $GITHUB_STEP_SUMMARY || true
- name: Delete temporary build artifacts
uses: geekyeggo/delete-artifact@v6
uses: geekyeggo/delete-artifact@v5
with:
name: |
firmware-${{ inputs.keymap }}-*
+1 -2
View File
@@ -24,12 +24,11 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
submodules: recursive
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run tests
run: qmk pytest
-34
View File
@@ -1,34 +0,0 @@
name: Generate Develop Docs
permissions:
contents: write
on:
push:
branches:
- develop
paths:
- 'builddefs/docsgen/**'
- 'tmk_core/**'
- 'quantum/**'
- 'platforms/**'
- 'docs/**'
- '.github/workflows/docs.yml'
jobs:
generate:
runs-on: ubuntu-latest
steps:
- name: Deploy Develop
if: ${{ github.repository == 'qmk/qmk_firmware' }}
uses: actions/github-script@v9
with:
github-token: ${{ secrets.QMK_BOT_TOKEN }}
script: |
const result = await github.rest.actions.createWorkflowDispatch({
owner: 'qmk',
repo: 'qmk_docs_devel',
workflow_id: 'develop.yml',
ref: 'main',
})
+1 -1
View File
@@ -15,7 +15,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
token: ${{ secrets.QMK_BOT_TOKEN }}
fetch-depth: 0
+4 -5
View File
@@ -30,15 +30,14 @@ jobs:
container: ghcr.io/qmk/qmk_cli
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
fetch-depth: 1
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Install nvm
run: |
apt-get update && apt-get install -y rsync doxygen
# install nvm
touch $HOME/.bashrc
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
@@ -57,7 +56,7 @@ jobs:
- name: Deploy
if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
uses: JamesIves/github-pages-deploy-action@v4.8.0
uses: JamesIves/github-pages-deploy-action@v4.7.3
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
+1 -1
View File
@@ -21,7 +21,7 @@ jobs:
- riot
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
token: ${{ secrets.QMK_BOT_TOKEN }}
fetch-depth: 0
+1 -1
View File
@@ -26,7 +26,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
fetch-depth: 0
+2 -2
View File
@@ -19,7 +19,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
fetch-depth: 0
@@ -47,7 +47,7 @@ jobs:
git config user.email 'hello@qmk.fm'
- name: Create Pull Request
uses: peter-evans/create-pull-request@v8
uses: peter-evans/create-pull-request@v7
if: ${{ github.repository == 'qmk/qmk_firmware'}}
with:
token: ${{ secrets.QMK_BOT_TOKEN }}
+4 -15
View File
@@ -18,7 +18,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
fetch-depth: 0
@@ -31,7 +31,7 @@ jobs:
with:
use_rest_api: true
- name: Print git info
- name: Print info
run: |
git rev-parse --short HEAD
echo ${{ github.event.pull_request.base.sha }}
@@ -57,7 +57,7 @@ jobs:
if [[ $KEYMAP_ONLY -gt 0 ]]; then
echo "linting ${KB}"
qmk lint --strict --keyboard ${KB} && qmk info -l --keyboard ${KB}
qmk lint --keyboard ${KB} && qmk info -l --keyboard ${KB}
exit_code=$(($exit_code + $?))
fi
done
@@ -78,21 +78,10 @@ jobs:
fi
exit $exit_code
- name: Reset git repo
- name: Verify keyboard aliases
if: always()
shell: 'bash {0}'
run: |
git reset --hard
git clean -xfd
- name: Verify keyboard targets
if: always()
shell: 'bash {0}'
run: |
qmk ci-validate-keyboard-targets
- name: Verify keyboard aliases
if: always()
shell: 'bash {0}'
run: |
qmk ci-validate-aliases
+1 -7
View File
@@ -8,9 +8,6 @@ on:
paths:
- 'data/constants/**'
- 'lib/python/**'
- 'quantum/rgblight/rgblight_breathe_table.h'
- 'quantum/keycodes.h'
- 'quantum/keymap_extras/**'
jobs:
regen:
@@ -22,10 +19,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v7
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- uses: actions/checkout@v5
- name: Run qmk generators
run: |
+2 -5
View File
@@ -19,10 +19,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v7
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- uses: actions/checkout@v5
- name: Run qmk generators
run: |
@@ -37,7 +34,7 @@ jobs:
git config user.email 'hello@qmk.fm'
- name: Create Pull Request
uses: peter-evans/create-pull-request@v8
uses: peter-evans/create-pull-request@v7
if: ${{ github.repository == 'qmk/qmk_firmware'}}
with:
token: ${{ secrets.QMK_BOT_TOKEN }}
+2 -5
View File
@@ -11,7 +11,6 @@ on:
pull_request:
paths:
- 'builddefs/**'
- '!builddefs/docsgen/**'
- 'quantum/**'
- 'platforms/**'
- 'tmk_core/**'
@@ -27,12 +26,10 @@ jobs:
container: ghcr.io/qmk/qmk_cli
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v5
with:
submodules: recursive
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run tests
run: qmk test-c -j $(nproc)
run: qmk test-c
-7
View File
@@ -65,8 +65,6 @@ cmake-build-debug
CMakeLists.txt
*.pdf
*.zip
.env
.envrc
# Let these ones be user specific, since we have so many different configurations
*.code-workspace
@@ -97,11 +95,6 @@ tags
*.mpeg
*.ttf
*.otf
# Un-ignore limited image file formats in docs
!docs/public/**.gif
!docs/public/**.jpg
!docs/public/**.jpeg
!docs/public/**.png
# Things Travis sees
/.vs
+45 -18
View File
@@ -38,17 +38,14 @@ $(info QMK Firmware $(QMK_VERSION))
endif
endif
# Try to determine userspace from qmk config, if set.
ifeq ($(QMK_USERSPACE),)
QMK_USERSPACE = $(shell qmk config -ro user.overlay_dir | cut -d= -f2 | sed -e 's@^None$$@@g')
endif
# Determine which qmk cli to use
QMK_BIN := qmk
# Try to determine userspace from qmk config, if set. Handle direct query on qmk_cli>=1.1.7
# falling back to legacy method of only supporting user.overlay_dir config
# sort is used to buffer 'qmk env' output and avoid BrokenPipeError errors
export override QMK_USERSPACE := $(shell \
$(QMK_BIN) env | sort | grep -q QMK_USERSPACE \
&& $(QMK_BIN) env QMK_USERSPACE \
|| $(QMK_BIN) config -ro user.overlay_dir | cut -d= -f2 | sed -e 's@^None$$@@g')
# avoid 'Entering|Leaving directory' messages
MAKEFLAGS += --no-print-directory
@@ -118,7 +115,7 @@ endef
TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
# As TRY_TO_MATCH_RULE_FROM_LIST_HELPER, but with additional
# resolution of keyboard_aliases.hjson for provided rule
# resolution of keyboard_aliases.hjson for provided rule
define TRY_TO_MATCH_RULE_FROM_LIST_HELPER_KB
# Split on ":", padding with empty strings to avoid indexing issues
TOKEN1:=$$(shell python3 -c "import sys; print((sys.argv[1].split(':',1)+[''])[0])" $$(RULE))
@@ -193,9 +190,41 @@ endef
# Parses a rule in the format <keymap>:<target>
# the keyboard is already known when entering this function
define PARSE_KEYBOARD
# If we want to compile the default subproject, then we need to
# include the correct makefile to determine the actual name of it
CURRENT_KB := $1
KEYMAPS := $(shell $(QMK_BIN) list-keymaps --keyboard $1)
# 5/4/3/2/1
KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
KEYBOARD_FOLDER_PATH_3 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_2)))
KEYBOARD_FOLDER_PATH_4 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_3)))
KEYBOARD_FOLDER_PATH_5 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_4)))
KEYMAPS :=
# get a list of all keymaps
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/keymaps/*/.)))
ifneq ($(QMK_USERSPACE),)
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/keymaps/*/.)))
KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/keymaps/*/.)))
endif
KEYBOARD_LAYOUTS := $(shell $(QMK_BIN) list-layouts --keyboard $1)
LAYOUT_KEYMAPS :=
$$(foreach LAYOUT,$$(KEYBOARD_LAYOUTS),$$(eval LAYOUT_KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/layouts/*/$$(LAYOUT)/*/.)))))
ifneq ($(QMK_USERSPACE),)
$$(foreach LAYOUT,$$(KEYBOARD_LAYOUTS),$$(eval LAYOUT_KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(QMK_USERSPACE)/layouts/$$(LAYOUT)/*/.)))))
endif
KEYMAPS := $$(sort $$(KEYMAPS) $$(LAYOUT_KEYMAPS))
# if the rule after removing the start of it is empty (we haven't specified a kemap or target)
# compile all the keymaps
@@ -300,7 +329,6 @@ endef
define BUILD_TEST
TEST_PATH := $1
TEST_NAME := $$(notdir $$(TEST_PATH))
TEST_ID := $$(patsubst ./tests/%,%,$$(TEST_PATH))
TEST_FULL_NAME := $$(subst /,_,$$(patsubst $$(ROOT_DIR)tests/%,%,$$(TEST_PATH)))
MAKE_TARGET := $2
COMMAND := $1
@@ -314,7 +342,7 @@ define BUILD_TEST
TEST_MSG := $$(MSG_TEST)
$$(TEST_FULL_NAME)_COMMAND := \
printf "$$(TEST_MSG)\n"; \
$$(TEST_EXECUTABLE) --gtest_color=$$(COLOR); \
$$(TEST_EXECUTABLE); \
if [ $$$$? -gt 0 ]; \
then error_occurred=1; \
fi; \
@@ -452,17 +480,16 @@ distclean_userspace: clean
endif
# Extra targets for formatting and/or pytest, running within the qmk/qmk_cli container to match GHA.
CONTAINER_PREAMBLE := export HOME="/tmp"; export PATH="/tmp/.local/bin:\$$PATH"; python3 -m pip install --upgrade pip; python3 -m pip install -r requirements-dev.txt
.PHONY: format-core
format-core:
RUNTIME=docker ./util/docker_cmd.sh qmk format-c --core-only -a
RUNTIME=docker ./util/docker_cmd.sh qmk format-python -a
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk format-c --core-only -a && qmk format-python -a"
.PHONY: pytest
pytest:
RUNTIME=docker ./util/docker_cmd.sh qmk pytest
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk pytest"
.PHONY: format-and-pytest
format-and-pytest:
RUNTIME=docker ./util/docker_cmd.sh qmk format-c --core-only -a
RUNTIME=docker ./util/docker_cmd.sh qmk format-python -a
RUNTIME=docker ./util/docker_cmd.sh qmk pytest
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk format-c --core-only -a && qmk format-python -a && qmk pytest"
+36
View File
@@ -0,0 +1,36 @@
# Look for a json keymap file
ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_5)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_5)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_4)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_3)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_2)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.json)","")
KEYMAP_JSON := $(MAIN_KEYMAP_PATH_1)/keymap.json
KEYMAP_JSON_PATH := $(MAIN_KEYMAP_PATH_1)
endif
ifneq ($(QMK_USERSPACE),)
ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
endif
endif
+75 -26
View File
@@ -138,12 +138,75 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/keyboard.json)","")
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/keyboard.json
endif
MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
# Pull in rules from DD keyboard config
INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --output $(INTERMEDIATE_OUTPUT)/src/info_rules.mk)
include $(INFO_RULES_MK)
include $(BUILDDEFS_PATH)/locate_keymap.mk
-include $(KEYMAP_PATH)/rules.mk
# Check for keymap.json first, so we can regenerate keymap.c
include $(BUILDDEFS_PATH)/build_json.mk
# Pull in keymap level rules.mk
ifeq ("$(wildcard $(KEYMAP_PATH))", "")
# Look through the possible keymap folders until we find a matching keymap.c
ifneq ($(QMK_USERSPACE),)
ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.c)","")
-include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/rules.mk
KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.c
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
endif
endif
ifeq ($(KEYMAP_PATH),)
ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_1)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_1)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_2)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_2)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_3)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_3)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_4)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_4)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","")
-include $(MAIN_KEYMAP_PATH_5)/rules.mk
KEYMAP_C := $(MAIN_KEYMAP_PATH_5)/keymap.c
KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
else ifneq ($(LAYOUTS),)
# If we haven't found a keymap yet fall back to community layouts
include $(BUILDDEFS_PATH)/build_layout.mk
else ifeq ("$(wildcard $(KEYMAP_JSON_PATH))", "") # Not finding keymap.c is fine if we found a keymap.json
$(call CATASTROPHIC_ERROR,Invalid keymap,Could not find keymap)
# this state should never be reached
endif
endif
endif
# Have we found a keymap.json?
ifneq ("$(wildcard $(KEYMAP_JSON))", "")
@@ -154,9 +217,16 @@ ifneq ("$(wildcard $(KEYMAP_JSON))", "")
OPT_DEFS += -DOTHER_KEYMAP_C=\"$(OTHER_KEYMAP_C)\"
endif
KEYMAP_PATH := $(KEYMAP_JSON_PATH)
KEYMAP_C := $(INTERMEDIATE_OUTPUT)/src/keymap.c
KEYMAP_H := $(INTERMEDIATE_OUTPUT)/src/config.h
ifeq ($(OTHER_KEYMAP_C),)
# Load the keymap-level rules.mk if exists (and we havent already loaded it for keymap.c)
-include $(KEYMAP_PATH)/rules.mk
endif
# Load any rules.mk content from keymap.json
INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/rules.mk $(KEYMAP_JSON))
include $(INFO_RULES_MK)
@@ -185,13 +255,6 @@ endif
COMMUNITY_RULES_MK = $(shell $(QMK_BIN) generate-community-modules-rules-mk -kb $(KEYBOARD) --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/community_rules.mk $(KEYMAP_JSON))
include $(COMMUNITY_RULES_MK)
ifneq ($(COMMUNITY_MODULES),)
$(INTERMEDIATE_OUTPUT)/src/community_post_config.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-community-post-config-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_post_config.h $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/community_modules.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-community-modules-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(KEYMAP_JSON))
@@ -222,17 +285,9 @@ $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc: $(KEYMAP_JSON) $(DD
$(eval CMD=$(QMK_BIN) generate-rgb-matrix-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc $(KEYMAP_JSON))
@$(BUILD_CMD)
$(INTERMEDIATE_OUTPUT)/src/split_transaction_id_community_modules.inc: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
$(eval CMD=$(QMK_BIN) generate-split-transaction-id-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/split_transaction_id_community_modules.inc $(KEYMAP_JSON))
@$(BUILD_CMD)
COMMUNITY_POST_CONFIG_H = $(INTERMEDIATE_OUTPUT)/src/community_post_config.h
SRC += $(INTERMEDIATE_OUTPUT)/src/community_modules.c
generated-files: $(INTERMEDIATE_OUTPUT)/src/community_post_config.h $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(INTERMEDIATE_OUTPUT)/src/community_modules.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc $(INTERMEDIATE_OUTPUT)/src/split_transaction_id_community_modules.inc
endif
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
@@ -372,10 +427,6 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
endif
ifneq ($(COMMUNITY_POST_CONFIG_H),)
POST_CONFIG_H += $(COMMUNITY_POST_CONFIG_H)
endif
CONFIG_H += $(INTERMEDIATE_OUTPUT)/src/info_config.h
KEYBOARD_SRC += $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c
@@ -419,10 +470,8 @@ ifneq ($(wildcard $(QMK_USERSPACE)),)
endif
# If the equivalent users directory exists in userspace, use that in preference to anything currently in the main repo
ifneq ($(QMK_USERSPACE),)
ifneq ($(wildcard $(QMK_USERSPACE)/$(USER_PATH)),)
USER_PATH := $(QMK_USERSPACE)/$(USER_PATH)
endif
ifneq ($(wildcard $(QMK_USERSPACE)/$(USER_PATH)),)
USER_PATH := $(QMK_USERSPACE)/$(USER_PATH)
endif
# Pull in user level rules.mk
+36
View File
@@ -0,0 +1,36 @@
LAYOUTS_PATH := layouts
LAYOUTS_REPOS := $(patsubst %/,%,$(sort $(dir $(wildcard $(LAYOUTS_PATH)/*/))))
ifneq ($(QMK_USERSPACE),)
LAYOUTS_REPOS += $(patsubst %/,%,$(QMK_USERSPACE)/$(LAYOUTS_PATH))
endif
define SEARCH_LAYOUTS_REPO
LAYOUT_KEYMAP_PATH := $$(LAYOUTS_REPO)/$$(LAYOUT)/$$(KEYMAP)
LAYOUT_KEYMAP_JSON := $$(LAYOUT_KEYMAP_PATH)/keymap.json
LAYOUT_KEYMAP_C := $$(LAYOUT_KEYMAP_PATH)/keymap.c
ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_JSON))","")
-include $$(LAYOUT_KEYMAP_PATH)/rules.mk
KEYMAP_JSON := $$(LAYOUT_KEYMAP_JSON)
KEYMAP_PATH := $$(LAYOUT_KEYMAP_PATH)
else ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_C))","")
-include $$(LAYOUT_KEYMAP_PATH)/rules.mk
KEYMAP_C := $$(LAYOUT_KEYMAP_C)
KEYMAP_PATH := $$(LAYOUT_KEYMAP_PATH)
endif
endef
define SEARCH_LAYOUTS
$$(foreach LAYOUTS_REPO,$$(LAYOUTS_REPOS),$$(eval $$(call SEARCH_LAYOUTS_REPO)))
endef
ifneq ($(FORCE_LAYOUT),)
ifneq (,$(findstring $(FORCE_LAYOUT),$(LAYOUTS)))
$(info Forcing layout: $(FORCE_LAYOUT))
LAYOUTS := $(FORCE_LAYOUT)
else
$(call CATASTROPHIC_ERROR,Invalid layout,Forced layout does not exist)
endif
endif
$(foreach LAYOUT,$(LAYOUTS),$(eval $(call SEARCH_LAYOUTS)))
+1 -6
View File
@@ -98,7 +98,6 @@ endif
VALID_STENO_PROTOCOL_TYPES := geminipr txbolt all
STENO_PROTOCOL ?= all
ifeq ($(strip $(STENO_ENABLE)), yes)
ifeq ($(filter $(STENO_PROTOCOL),$(VALID_STENO_PROTOCOL_TYPES)),)
$(call CATASTROPHIC_ERROR,Invalid STENO_PROTOCOL,STENO_PROTOCOL="$(STENO_PROTOCOL)" is not a valid stenography protocol)
@@ -126,7 +125,7 @@ ifeq ($(strip $(MOUSEKEY_ENABLE)), yes)
MOUSE_ENABLE := yes
endif
VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick azoteq_iqs5xx cirque_pinnacle_i2c cirque_pinnacle_spi paw3204 paw3222 pmw3320 pmw3325 pmw3360 pmw3389 pimoroni_trackball custom
VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick azoteq_iqs5xx cirque_pinnacle_i2c cirque_pinnacle_spi paw3204 pmw3320 pmw3360 pmw3389 pimoroni_trackball custom
ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
ifeq ($(filter $(POINTING_DEVICE_DRIVER),$(VALID_POINTING_DEVICE_DRIVER_TYPES)),)
$(call CATASTROPHIC_ERROR,Invalid POINTING_DEVICE_DRIVER,POINTING_DEVICE_DRIVER="$(POINTING_DEVICE_DRIVER)" is not a valid pointing device type)
@@ -158,10 +157,6 @@ ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
SRC += drivers/sensors/cirque_pinnacle.c
SRC += drivers/sensors/cirque_pinnacle_gestures.c
SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_gestures.c
else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), paw3222)
SPI_DRIVER_REQUIRED = yes
else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), pmw3325)
SPI_DRIVER_REQUIRED = yes
else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), pimoroni_trackball)
I2C_DRIVER_REQUIRED = yes
else ifneq ($(filter $(strip $(POINTING_DEVICE_DRIVER)),pmw3360 pmw3389),)
+7 -14
View File
@@ -50,19 +50,15 @@ ifeq ($(strip $(DEBUG_ENABLE)),yes)
CFLAGS += -ggdb3
CXXFLAGS += -ggdb3
ASFLAGS += -ggdb3
# Create a map file when debugging
LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
endif
# Create a map file to see what was compiled and where, unless disabled
# (e.g. test builds, which use the host linker — Apple's ld does not accept
# -Map=/--cref).
ifneq ($(strip $(CREATE_MAP)), no)
LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
endif
#---------------- C Compiler Options ----------------
ifeq ($(strip $(LTO_ENABLE)), yes)
CDEFS += -flto=auto
CDEFS += -flto
CDEFS += -DLTO_ENABLE
endif
@@ -70,14 +66,12 @@ CFLAGS += $(CDEFS)
CFLAGS += -O$(OPT)
# add color
ifeq ($(COLOR),true)
CFLAGS+= -fdiagnostics-color=always
else
CFLAGS+= -fdiagnostics-color=never
ifeq ("$(shell echo "int main(){}" | $(CC) -fdiagnostics-color -x c - -o /dev/null 2>&1)", "")
CFLAGS+= -fdiagnostics-color
endif
endif
CFLAGS += -Wall
CFLAGS += -Wstrict-prototypes
CFLAGS += $(call cc-option,-Wunused-but-set-variable=1,-Wunused-but-set-variable)
CFLAGS += $(call cc-option,-Wunused-but-set-parameter=1,-Wunused-but-set-parameter)
ifneq ($(strip $(ALLOW_WARNINGS)), yes)
CFLAGS += -Werror
endif
@@ -95,8 +89,7 @@ CXXFLAGS += -O$(OPT)
CXXFLAGS += -w
CXXFLAGS += -Wall
CXXFLAGS += -Wundef
CXXFLAGS += $(call cc-option,-Wunused-but-set-variable=1,-Wunused-but-set-variable)
CXXFLAGS += $(call cc-option,-Wunused-but-set-parameter=1,-Wunused-but-set-parameter)
ifneq ($(strip $(ALLOW_WARNINGS)), yes)
CXXFLAGS += -Werror
endif
+4 -2
View File
@@ -1,8 +1,10 @@
{
"license": "GPL-2.0-or-later",
"devDependencies": {
"vitepress": "^1.6.4",
"vitepress-plugin-tabs": "^0.8.0"
"vite": "^5.4.21",
"vitepress": "^1.1.0",
"vitepress-plugin-tabs": "^0.5.0",
"vue": "^3.4.24"
},
"scripts": {
"docs:dev": "vitepress dev --host 0.0.0.0",
File diff suppressed because it is too large Load Diff
-1
View File
@@ -45,7 +45,6 @@ GENERIC_FEATURES = \
MOUSEKEY \
MUSIC \
OS_DETECTION \
PLOVER_HID \
PROGRAMMABLE_BUTTON \
REPEAT_KEY \
SECURE \
-64
View File
@@ -1,64 +0,0 @@
MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_1)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_2)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_3)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_4)
POTENTIAL_KEYMAP_PATHS += $(MAIN_KEYMAP_PATH_5)
ifneq ($(QMK_USERSPACE),)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
POTENTIAL_KEYMAP_PATHS += $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
endif
define SEARCH_POTENTIAL_LOCATION
POTENTIAL_DIR := $1
ifeq ("$$(wildcard $$(KEYMAP_PATH))", "")
POTENTIAL_KEYMAP_JSON := $$(POTENTIAL_DIR)/keymap.json
POTENTIAL_KEYMAP_C := $$(POTENTIAL_DIR)/keymap.c
ifneq ("$$(wildcard $$(POTENTIAL_KEYMAP_JSON))","")
KEYMAP_JSON := $$(POTENTIAL_KEYMAP_JSON)
KEYMAP_PATH := $$(POTENTIAL_DIR)
endif
ifneq ("$$(wildcard $$(POTENTIAL_KEYMAP_C))","")
KEYMAP_C := $$(POTENTIAL_KEYMAP_C)
KEYMAP_PATH := $$(POTENTIAL_DIR)
endif
endif
endef
$(foreach KM_DIR,$(POTENTIAL_KEYMAP_PATHS),$(eval $(call SEARCH_POTENTIAL_LOCATION, $(KM_DIR))))
LAYOUTS_PATH := layouts
LAYOUTS_REPOS := $(patsubst %/,%,$(sort $(dir $(wildcard $(LAYOUTS_PATH)/*/))))
ifneq ($(QMK_USERSPACE),)
LAYOUTS_REPOS += $(patsubst %/,%,$(QMK_USERSPACE)/$(LAYOUTS_PATH))
endif
define SEARCH_LAYOUTS
$$(foreach LAYOUTS_REPO,$$(LAYOUTS_REPOS),$$(eval $$(call SEARCH_POTENTIAL_LOCATION,$$(LAYOUTS_REPO)/$$(LAYOUT)/$$(KEYMAP))))
endef
ifneq ($(FORCE_LAYOUT),)
ifneq (,$(findstring $(FORCE_LAYOUT),$(LAYOUTS)))
$(info Forcing layout: $(FORCE_LAYOUT))
LAYOUTS := $(FORCE_LAYOUT)
else
$(call CATASTROPHIC_ERROR,Invalid layout,Forced layout does not exist)
endif
endif
$(foreach LAYOUT,$(LAYOUTS),$(eval $(call SEARCH_LAYOUTS)))
ifeq ("$$(wildcard $$(KEYMAP_PATH))", "")
$(call CATASTROPHIC_ERROR,Invalid keymap,Could not find keymap)
# this state should never be reached
endif
+2 -2
View File
@@ -77,13 +77,13 @@ define GENERATE_MSG_MAKE_KB
endef
MSG_MAKE_KB = $(eval $(call GENERATE_MSG_MAKE_KB))$(MSG_MAKE_KB_ACTUAL)
define GENERATE_MSG_MAKE_TEST
MSG_MAKE_TEST_ACTUAL := Making test $(BOLD)$(TEST_ID)$(NO_COLOR)
MSG_MAKE_TEST_ACTUAL := Making test $(BOLD)$(TEST_NAME)$(NO_COLOR)
ifneq ($$(MAKE_TARGET),)
MSG_MAKE_TEST_ACTUAL += with target $(BOLD)$$(MAKE_TARGET)$(NO_COLOR)
endif
endef
MSG_MAKE_TEST = $(eval $(call GENERATE_MSG_MAKE_TEST))$(MSG_MAKE_TEST_ACTUAL)
MSG_TEST = Testing $(BOLD)$(TEST_ID)$(NO_COLOR)
MSG_TEST = Testing $(BOLD)$(TEST_NAME)$(NO_COLOR)
define GENERATE_MSG_AVAILABLE_KEYMAPS
MSG_AVAILABLE_KEYMAPS_ACTUAL := Available keymaps for $(BOLD)$$(CURRENT_KB)$(NO_COLOR):
endef
-1
View File
@@ -63,7 +63,6 @@ OTHER_OPTION_NAMES = \
LCD_BACKLIGHT_ENABLE \
MACROS_ENABLED \
PS2_ENABLE \
PLOVER_HID_ENABLE \
PS2_MOUSE_ENABLE \
PS2_DRIVER \
RAW_ENABLE \
+1 -1
View File
@@ -4,7 +4,7 @@
# $(2) = option to use if $(1) is not supported
# $(3) = additional arguments to pass to the compiler during the test, but aren't contained in the output
cc-option = $(shell \
if { echo 'int main(){return 0;}' | $(CC) $(1) $(3) -Wl,--unresolved-symbols=ignore-all -o /dev/null -x c /dev/null >/dev/null 2>&1; }; \
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)
@@ -3,7 +3,6 @@
"0x7480": {
"group": "audio",
"key": "QK_AUDIO_ON",
"label": "Audio On",
"aliases": [
"AU_ON"
]
@@ -11,7 +10,6 @@
"0x7481": {
"group": "audio",
"key": "QK_AUDIO_OFF",
"label": "Audio Off",
"aliases": [
"AU_OFF"
]
@@ -19,7 +17,6 @@
"0x7482": {
"group": "audio",
"key": "QK_AUDIO_TOGGLE",
"label": "Toggle Audio",
"aliases": [
"AU_TOGG"
]
@@ -28,7 +25,6 @@
"0x748A": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_TOGGLE",
"label": "Toggle Audio Clicky",
"aliases": [
"CK_TOGG"
]
@@ -36,7 +32,6 @@
"0x748B": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_ON",
"label": "Audio Clicky On",
"aliases": [
"CK_ON"
]
@@ -44,7 +39,6 @@
"0x748C": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_OFF",
"label": "Audio Clicky Off",
"aliases": [
"CK_OFF"
]
@@ -52,7 +46,6 @@
"0x748D": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_UP",
"label": "Audio Clicky Up",
"aliases": [
"CK_UP"
]
@@ -60,7 +53,6 @@
"0x748E": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_DOWN",
"label": "Audio Clicky Down",
"aliases": [
"CK_DOWN"
]
@@ -68,7 +60,6 @@
"0x748F": {
"group": "audio",
"key": "QK_AUDIO_CLICKY_RESET",
"label": "Audio Clicky Reset",
"aliases": [
"CK_RST"
]
@@ -77,7 +68,6 @@
"0x7490": {
"group": "audio",
"key": "QK_MUSIC_ON",
"label": "Music On",
"aliases": [
"MU_ON"
]
@@ -85,7 +75,6 @@
"0x7491": {
"group": "audio",
"key": "QK_MUSIC_OFF",
"label": "Music Off",
"aliases": [
"MU_OFF"
]
@@ -93,7 +82,6 @@
"0x7492": {
"group": "audio",
"key": "QK_MUSIC_TOGGLE",
"label": "Toggle Music",
"aliases": [
"MU_TOGG"
]
@@ -101,7 +89,6 @@
"0x7493": {
"group": "audio",
"key": "QK_MUSIC_MODE_NEXT",
"label": "Music Next",
"aliases": [
"MU_NEXT"
]
@@ -110,7 +97,6 @@
"0x7494": {
"group": "audio",
"key": "QK_AUDIO_VOICE_NEXT",
"label": "Audio Voice Next",
"aliases": [
"AU_NEXT"
]
@@ -118,7 +104,6 @@
"0x7495": {
"group": "audio",
"key": "QK_AUDIO_VOICE_PREVIOUS",
"label": "Audio Voice Previous",
"aliases": [
"AU_PREV"
]
@@ -3,7 +3,7 @@
"0x0000": {
"group": "internal",
"key": "KC_NO",
"label": "N/A",
"label": "",
"aliases": [
"XXXXXXX"
]
@@ -11,7 +11,7 @@
"0x0001": {
"group": "internal",
"key": "KC_TRANSPARENT",
"label": "Transparent",
"label": "",
"aliases": [
"_______",
"KC_TRNS"
@@ -634,7 +634,7 @@
"0x0065": {
"group": "basic",
"key": "KC_APPLICATION",
"label": "App",
"label": "Application",
"aliases": [
"KC_APP"
]
@@ -642,7 +642,7 @@
"0x0066": {
"group": "basic",
"key": "KC_KB_POWER",
"label": "Power"
"label": "Application"
},
"0x0067": {
"group": "basic",
@@ -1068,7 +1068,7 @@
"0x00A5": {
"group": "system",
"key": "KC_SYSTEM_POWER",
"label": "Power",
"label": "System Power Down",
"aliases": [
"KC_PWR"
]
@@ -1076,7 +1076,7 @@
"0x00A6": {
"group": "system",
"key": "KC_SYSTEM_SLEEP",
"label": "Sleep",
"label": "System Sleep",
"aliases": [
"KC_SLEP"
]
@@ -1084,7 +1084,7 @@
"0x00A7": {
"group": "system",
"key": "KC_SYSTEM_WAKE",
"label": "Wake",
"label": "System Wake",
"aliases": [
"KC_WAKE"
]
@@ -1140,7 +1140,7 @@
"0x00AE": {
"group": "media",
"key": "KC_MEDIA_PLAY_PAUSE",
"label": "Play/Pause",
"label": "Play/Pause Track",
"aliases": [
"KC_MPLY"
]
@@ -1148,7 +1148,7 @@
"0x00AF": {
"group": "media",
"key": "KC_MEDIA_SELECT",
"label": "Media",
"label": "Launch Player",
"aliases": [
"KC_MSEL"
]
@@ -1164,12 +1164,12 @@
"0x00B1": {
"group": "media",
"key": "KC_MAIL",
"label": "Mail",
"label": "Launch Mail"
},
"0x00B2": {
"group": "media",
"key": "KC_CALCULATOR",
"label": "Calculator",
"label": "Launch Calculator",
"aliases": [
"KC_CALC"
]
@@ -1177,7 +1177,7 @@
"0x00B3": {
"group": "media",
"key": "KC_MY_COMPUTER",
"label": "My Computer",
"label": "Launch My Computer",
"aliases": [
"KC_MYCM"
]
@@ -1185,7 +1185,7 @@
"0x00B4": {
"group": "media",
"key": "KC_WWW_SEARCH",
"label": "Search",
"label": "Browser Search",
"aliases": [
"KC_WSCH"
]
@@ -1193,7 +1193,7 @@
"0x00B5": {
"group": "media",
"key": "KC_WWW_HOME",
"label": "Home",
"label": "Browser Home",
"aliases": [
"KC_WHOM"
]
@@ -1201,7 +1201,7 @@
"0x00B6": {
"group": "media",
"key": "KC_WWW_BACK",
"label": "Back",
"label": "Browser Back",
"aliases": [
"KC_WBAK"
]
@@ -1209,7 +1209,7 @@
"0x00B7": {
"group": "media",
"key": "KC_WWW_FORWARD",
"label": "Forward",
"label": "Browser Forward",
"aliases": [
"KC_WFWD"
]
@@ -1217,7 +1217,7 @@
"0x00B8": {
"group": "media",
"key": "KC_WWW_STOP",
"label": "Stop",
"label": "Browser Stop",
"aliases": [
"KC_WSTP"
]
@@ -1225,7 +1225,7 @@
"0x00B9": {
"group": "media",
"key": "KC_WWW_REFRESH",
"label": "Refresh",
"label": "Browser Refresh",
"aliases": [
"KC_WREF"
]
@@ -1233,7 +1233,7 @@
"0x00BA": {
"group": "media",
"key": "KC_WWW_FAVORITES",
"label": "Favorites",
"label": "Browser Favorites",
"aliases": [
"KC_WFAV"
]
@@ -1241,7 +1241,7 @@
"0x00BB": {
"group": "media",
"key": "KC_MEDIA_FAST_FORWARD",
"label": "Fast Forward",
"label": "Next Track",
"aliases": [
"KC_MFFD"
]
@@ -1249,7 +1249,7 @@
"0x00BC": {
"group": "media",
"key": "KC_MEDIA_REWIND",
"label": "Rewind",
"label": "Previous Track",
"aliases": [
"KC_MRWD"
]
@@ -1273,7 +1273,7 @@
"0x00BF": {
"group": "media",
"key": "KC_CONTROL_PANEL",
"label": "Control Panel",
"label": "Open Control Panel",
"aliases": [
"KC_CPNL"
]
@@ -1281,7 +1281,7 @@
"0x00C0": {
"group": "media",
"key": "KC_ASSISTANT",
"label": "Assistant",
"label": "Launch Assistant",
"aliases": [
"KC_ASST"
]
@@ -3,7 +3,6 @@
"0x7400": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_0",
"label": "Button 0",
"aliases": [
"JS_0"
]
@@ -11,7 +10,6 @@
"0x7401": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_1",
"label": "Button 1",
"aliases": [
"JS_1"
]
@@ -19,7 +17,6 @@
"0x7402": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_2",
"label": "Button 2",
"aliases": [
"JS_2"
]
@@ -27,7 +24,6 @@
"0x7403": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_3",
"label": "Button 3",
"aliases": [
"JS_3"
]
@@ -35,7 +31,6 @@
"0x7404": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_4",
"label": "Button 4",
"aliases": [
"JS_4"
]
@@ -43,7 +38,6 @@
"0x7405": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_5",
"label": "Button 5",
"aliases": [
"JS_5"
]
@@ -51,7 +45,6 @@
"0x7406": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_6",
"label": "Button 6",
"aliases": [
"JS_6"
]
@@ -59,7 +52,6 @@
"0x7407": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_7",
"label": "Button 7",
"aliases": [
"JS_7"
]
@@ -67,7 +59,6 @@
"0x7408": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_8",
"label": "Button 8",
"aliases": [
"JS_8"
]
@@ -75,7 +66,6 @@
"0x7409": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_9",
"label": "Button 9",
"aliases": [
"JS_9"
]
@@ -83,7 +73,6 @@
"0x740A": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_10",
"label": "Button 10",
"aliases": [
"JS_10"
]
@@ -91,7 +80,6 @@
"0x740B": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_11",
"label": "Button 11",
"aliases": [
"JS_11"
]
@@ -99,7 +87,6 @@
"0x740C": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_12",
"label": "Button 12",
"aliases": [
"JS_12"
]
@@ -107,7 +94,6 @@
"0x740D": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_13",
"label": "Button 13",
"aliases": [
"JS_13"
]
@@ -115,7 +101,6 @@
"0x740E": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_14",
"label": "Button 14",
"aliases": [
"JS_14"
]
@@ -123,7 +108,6 @@
"0x740F": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_15",
"label": "Button 15",
"aliases": [
"JS_15"
]
@@ -131,7 +115,6 @@
"0x7410": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_16",
"label": "Button 16",
"aliases": [
"JS_16"
]
@@ -139,7 +122,6 @@
"0x7411": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_17",
"label": "Button 17",
"aliases": [
"JS_17"
]
@@ -147,7 +129,6 @@
"0x7412": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_18",
"label": "Button 18",
"aliases": [
"JS_18"
]
@@ -155,7 +136,6 @@
"0x7413": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_19",
"label": "Button 19",
"aliases": [
"JS_19"
]
@@ -163,7 +143,6 @@
"0x7414": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_20",
"label": "Button 20",
"aliases": [
"JS_20"
]
@@ -171,7 +150,6 @@
"0x7415": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_21",
"label": "Button 21",
"aliases": [
"JS_21"
]
@@ -179,7 +157,6 @@
"0x7416": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_22",
"label": "Button 22",
"aliases": [
"JS_22"
]
@@ -187,7 +164,6 @@
"0x7417": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_23",
"label": "Button 23",
"aliases": [
"JS_23"
]
@@ -195,7 +171,6 @@
"0x7418": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_24",
"label": "Button 24",
"aliases": [
"JS_24"
]
@@ -203,7 +178,6 @@
"0x7419": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_25",
"label": "Button 25",
"aliases": [
"JS_25"
]
@@ -211,7 +185,6 @@
"0x741A": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_26",
"label": "Button 26",
"aliases": [
"JS_26"
]
@@ -219,7 +192,6 @@
"0x741B": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_27",
"label": "Button 27",
"aliases": [
"JS_27"
]
@@ -227,7 +199,6 @@
"0x741C": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_28",
"label": "Button 28",
"aliases": [
"JS_28"
]
@@ -235,7 +206,6 @@
"0x741D": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_29",
"label": "Button 29",
"aliases": [
"JS_29"
]
@@ -243,7 +213,6 @@
"0x741E": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_30",
"label": "Button 30",
"aliases": [
"JS_30"
]
@@ -251,7 +220,6 @@
"0x741F": {
"group": "joystick",
"key": "QK_JOYSTICK_BUTTON_31",
"label": "Button 31",
"aliases": [
"JS_31"
]
@@ -3,7 +3,6 @@
"0x7800": {
"group": "backlight",
"key": "QK_BACKLIGHT_ON",
"label": "Backlight On",
"aliases": [
"BL_ON"
]
@@ -11,7 +10,6 @@
"0x7801": {
"group": "backlight",
"key": "QK_BACKLIGHT_OFF",
"label": "Backlight Off",
"aliases": [
"BL_OFF"
]
@@ -19,7 +17,6 @@
"0x7802": {
"group": "backlight",
"key": "QK_BACKLIGHT_TOGGLE",
"label": "Toggle Backlight",
"aliases": [
"BL_TOGG"
]
@@ -27,7 +24,6 @@
"0x7803": {
"group": "backlight",
"key": "QK_BACKLIGHT_DOWN",
"label": "Backlight Down",
"aliases": [
"BL_DOWN"
]
@@ -35,7 +31,6 @@
"0x7804": {
"group": "backlight",
"key": "QK_BACKLIGHT_UP",
"label": "Backlight Up",
"aliases": [
"BL_UP"
]
@@ -43,7 +38,6 @@
"0x7805": {
"group": "backlight",
"key": "QK_BACKLIGHT_STEP",
"label": "Backlight Step",
"aliases": [
"BL_STEP"
]
@@ -51,7 +45,6 @@
"0x7806": {
"group": "backlight",
"key": "QK_BACKLIGHT_TOGGLE_BREATHING",
"label": "Toggle Breathing",
"aliases": [
"BL_BRTG"
]
@@ -1,9 +1,9 @@
{
"keycodes": {
"0x7700": {
"group": "macro",
"key": "QK_MACRO_0",
"label": "Macro 0",
"aliases": [
"MC_0"
]
@@ -11,7 +11,6 @@
"0x7701": {
"group": "macro",
"key": "QK_MACRO_1",
"label": "Macro 1",
"aliases": [
"MC_1"
]
@@ -19,7 +18,6 @@
"0x7702": {
"group": "macro",
"key": "QK_MACRO_2",
"label": "Macro 2",
"aliases": [
"MC_2"
]
@@ -27,7 +25,6 @@
"0x7703": {
"group": "macro",
"key": "QK_MACRO_3",
"label": "Macro 3",
"aliases": [
"MC_3"
]
@@ -35,7 +32,6 @@
"0x7704": {
"group": "macro",
"key": "QK_MACRO_4",
"label": "Macro 4",
"aliases": [
"MC_4"
]
@@ -43,7 +39,6 @@
"0x7705": {
"group": "macro",
"key": "QK_MACRO_5",
"label": "Macro 5",
"aliases": [
"MC_5"
]
@@ -51,7 +46,6 @@
"0x7706": {
"group": "macro",
"key": "QK_MACRO_6",
"label": "Macro 6",
"aliases": [
"MC_6"
]
@@ -59,7 +53,6 @@
"0x7707": {
"group": "macro",
"key": "QK_MACRO_7",
"label": "Macro 7",
"aliases": [
"MC_7"
]
@@ -67,7 +60,6 @@
"0x7708": {
"group": "macro",
"key": "QK_MACRO_8",
"label": "Macro 8",
"aliases": [
"MC_8"
]
@@ -75,7 +67,6 @@
"0x7709": {
"group": "macro",
"key": "QK_MACRO_9",
"label": "Macro 9",
"aliases": [
"MC_9"
]
@@ -83,7 +74,6 @@
"0x770A": {
"group": "macro",
"key": "QK_MACRO_10",
"label": "Macro 10",
"aliases": [
"MC_10"
]
@@ -91,7 +81,6 @@
"0x770B": {
"group": "macro",
"key": "QK_MACRO_11",
"label": "Macro 11",
"aliases": [
"MC_11"
]
@@ -99,7 +88,6 @@
"0x770C": {
"group": "macro",
"key": "QK_MACRO_12",
"label": "Macro 12",
"aliases": [
"MC_12"
]
@@ -107,7 +95,6 @@
"0x770D": {
"group": "macro",
"key": "QK_MACRO_13",
"label": "Macro 13",
"aliases": [
"MC_13"
]
@@ -115,7 +102,6 @@
"0x770E": {
"group": "macro",
"key": "QK_MACRO_14",
"label": "Macro 14",
"aliases": [
"MC_14"
]
@@ -123,7 +109,6 @@
"0x770F": {
"group": "macro",
"key": "QK_MACRO_15",
"label": "Macro 15",
"aliases": [
"MC_15"
]
@@ -131,7 +116,6 @@
"0x7710": {
"group": "macro",
"key": "QK_MACRO_16",
"label": "Macro 16",
"aliases": [
"MC_16"
]
@@ -139,7 +123,6 @@
"0x7711": {
"group": "macro",
"key": "QK_MACRO_17",
"label": "Macro 17",
"aliases": [
"MC_17"
]
@@ -147,7 +130,6 @@
"0x7712": {
"group": "macro",
"key": "QK_MACRO_18",
"label": "Macro 18",
"aliases": [
"MC_18"
]
@@ -155,7 +137,6 @@
"0x7713": {
"group": "macro",
"key": "QK_MACRO_19",
"label": "Macro 19",
"aliases": [
"MC_19"
]
@@ -163,7 +144,6 @@
"0x7714": {
"group": "macro",
"key": "QK_MACRO_20",
"label": "Macro 20",
"aliases": [
"MC_20"
]
@@ -171,7 +151,6 @@
"0x7715": {
"group": "macro",
"key": "QK_MACRO_21",
"label": "Macro 21",
"aliases": [
"MC_21"
]
@@ -179,7 +158,6 @@
"0x7716": {
"group": "macro",
"key": "QK_MACRO_22",
"label": "Macro 22",
"aliases": [
"MC_22"
]
@@ -187,7 +165,6 @@
"0x7717": {
"group": "macro",
"key": "QK_MACRO_23",
"label": "Macro 23",
"aliases": [
"MC_23"
]
@@ -195,7 +172,6 @@
"0x7718": {
"group": "macro",
"key": "QK_MACRO_24",
"label": "Macro 24",
"aliases": [
"MC_24"
]
@@ -203,7 +179,6 @@
"0x7719": {
"group": "macro",
"key": "QK_MACRO_25",
"label": "Macro 25",
"aliases": [
"MC_25"
]
@@ -211,7 +186,6 @@
"0x771A": {
"group": "macro",
"key": "QK_MACRO_26",
"label": "Macro 26",
"aliases": [
"MC_26"
]
@@ -219,7 +193,6 @@
"0x771B": {
"group": "macro",
"key": "QK_MACRO_27",
"label": "Macro 27",
"aliases": [
"MC_27"
]
@@ -227,7 +200,6 @@
"0x771C": {
"group": "macro",
"key": "QK_MACRO_28",
"label": "Macro 28",
"aliases": [
"MC_28"
]
@@ -235,7 +207,6 @@
"0x771D": {
"group": "macro",
"key": "QK_MACRO_29",
"label": "Macro 29",
"aliases": [
"MC_29"
]
@@ -243,7 +214,6 @@
"0x771E": {
"group": "macro",
"key": "QK_MACRO_30",
"label": "Macro 30",
"aliases": [
"MC_30"
]
@@ -251,7 +221,6 @@
"0x771F": {
"group": "macro",
"key": "QK_MACRO_31",
"label": "Macro 31",
"aliases": [
"MC_31"
]
@@ -3,7 +3,6 @@
"0x7440": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_1",
"label": "Button 1",
"aliases": [
"PB_1"
]
@@ -11,7 +10,6 @@
"0x7441": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_2",
"label": "Button 2",
"aliases": [
"PB_2"
]
@@ -19,7 +17,6 @@
"0x7442": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_3",
"label": "Button 3",
"aliases": [
"PB_3"
]
@@ -27,7 +24,6 @@
"0x7443": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_4",
"label": "Button 4",
"aliases": [
"PB_4"
]
@@ -35,7 +31,6 @@
"0x7444": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_5",
"label": "Button 5",
"aliases": [
"PB_5"
]
@@ -43,7 +38,6 @@
"0x7445": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_6",
"label": "Button 6",
"aliases": [
"PB_6"
]
@@ -51,7 +45,6 @@
"0x7446": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_7",
"label": "Button 7",
"aliases": [
"PB_7"
]
@@ -59,7 +52,6 @@
"0x7447": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_8",
"label": "Button 8",
"aliases": [
"PB_8"
]
@@ -67,7 +59,6 @@
"0x7448": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_9",
"label": "Button 9",
"aliases": [
"PB_9"
]
@@ -75,7 +66,6 @@
"0x7449": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_10",
"label": "Button 10",
"aliases": [
"PB_10"
]
@@ -83,7 +73,6 @@
"0x744A": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_11",
"label": "Button 11",
"aliases": [
"PB_11"
]
@@ -91,7 +80,6 @@
"0x744B": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_12",
"label": "Button 12",
"aliases": [
"PB_12"
]
@@ -99,7 +87,6 @@
"0x744C": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_13",
"label": "Button 13",
"aliases": [
"PB_13"
]
@@ -107,7 +94,6 @@
"0x744D": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_14",
"label": "Button 14",
"aliases": [
"PB_14"
]
@@ -115,7 +101,6 @@
"0x744E": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_15",
"label": "Button 15",
"aliases": [
"PB_15"
]
@@ -123,7 +108,6 @@
"0x744F": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_16",
"label": "Button 16",
"aliases": [
"PB_16"
]
@@ -131,7 +115,6 @@
"0x7450": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_17",
"label": "Button 17",
"aliases": [
"PB_17"
]
@@ -139,7 +122,6 @@
"0x7451": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_18",
"label": "Button 18",
"aliases": [
"PB_18"
]
@@ -147,7 +129,6 @@
"0x7452": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_19",
"label": "Button 19",
"aliases": [
"PB_19"
]
@@ -155,7 +136,6 @@
"0x7453": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_20",
"label": "Button 20",
"aliases": [
"PB_20"
]
@@ -163,7 +143,6 @@
"0x7454": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_21",
"label": "Button 21",
"aliases": [
"PB_21"
]
@@ -171,7 +150,6 @@
"0x7455": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_22",
"label": "Button 22",
"aliases": [
"PB_22"
]
@@ -179,7 +157,6 @@
"0x7456": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_23",
"label": "Button 23",
"aliases": [
"PB_23"
]
@@ -187,7 +164,6 @@
"0x7457": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_24",
"label": "Button 24",
"aliases": [
"PB_24"
]
@@ -195,7 +171,6 @@
"0x7458": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_25",
"label": "Button 25",
"aliases": [
"PB_25"
]
@@ -203,7 +178,6 @@
"0x7459": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_26",
"label": "Button 26",
"aliases": [
"PB_26"
]
@@ -211,7 +185,6 @@
"0x745A": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_27",
"label": "Button 27",
"aliases": [
"PB_27"
]
@@ -219,7 +192,6 @@
"0x745B": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_28",
"label": "Button 28",
"aliases": [
"PB_28"
]
@@ -227,7 +199,6 @@
"0x745C": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_29",
"label": "Button 29",
"aliases": [
"PB_29"
]
@@ -235,7 +206,6 @@
"0x745D": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_30",
"label": "Button 30",
"aliases": [
"PB_30"
]
@@ -243,7 +213,6 @@
"0x745E": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_31",
"label": "Button 31",
"aliases": [
"PB_31"
]
@@ -251,7 +220,6 @@
"0x745F": {
"group": "programmable_button",
"key": "QK_PROGRAMMABLE_BUTTON_32",
"label": "Button 32",
"aliases": [
"PB_32"
]
@@ -3,7 +3,6 @@
"0x7C00": {
"group": "quantum",
"key": "QK_BOOTLOADER",
"label": "Bootloader",
"aliases": [
"QK_BOOT"
]
@@ -11,7 +10,6 @@
"0x7C01": {
"group": "quantum",
"key": "QK_REBOOT",
"label": "Reboot",
"aliases": [
"QK_RBT"
]
@@ -19,7 +17,6 @@
"0x7C02": {
"group": "quantum",
"key": "QK_DEBUG_TOGGLE",
"label": "Toggle Debug",
"aliases": [
"DB_TOGG"
]
@@ -27,21 +24,18 @@
"0x7C03": {
"group": "quantum",
"key": "QK_CLEAR_EEPROM",
"label": "Clear EEPROM",
"aliases": [
"EE_CLR"
]
},
"0x7C04": {
"group": "quantum",
"key": "QK_MAKE",
"label": "Make"
"key": "QK_MAKE"
},
"0x7C10": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_DOWN",
"label": "Auto Shift Down",
"aliases": [
"AS_DOWN"
]
@@ -49,7 +43,6 @@
"0x7C11": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_UP",
"label": "Auto Shift Up",
"aliases": [
"AS_UP"
]
@@ -57,7 +50,6 @@
"0x7C12": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_REPORT",
"label": "Auto Shift Report",
"aliases": [
"AS_RPT"
]
@@ -65,7 +57,6 @@
"0x7C13": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_ON",
"label": "Auto Shift On",
"aliases": [
"AS_ON"
]
@@ -73,7 +64,6 @@
"0x7C14": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_OFF",
"label": "Auto Shift Off",
"aliases": [
"AS_OFF"
]
@@ -81,7 +71,6 @@
"0x7C15": {
"group": "quantum",
"key": "QK_AUTO_SHIFT_TOGGLE",
"label": "Toggle Auto Shift",
"aliases": [
"AS_TOGG"
]
@@ -90,7 +79,6 @@
"0x7C16": {
"group": "quantum",
"key": "QK_GRAVE_ESCAPE",
"label": "Grave Esc",
"aliases": [
"QK_GESC"
]
@@ -107,7 +95,6 @@
"0x7C18": {
"group": "quantum",
"key": "QK_SPACE_CADET_LEFT_CTRL_PARENTHESIS_OPEN",
"label": "LCtl/(",
"aliases": [
"SC_LCPO"
]
@@ -115,7 +102,6 @@
"0x7C19": {
"group": "quantum",
"key": "QK_SPACE_CADET_RIGHT_CTRL_PARENTHESIS_CLOSE",
"label": "RCtl/)",
"aliases": [
"SC_RCPC"
]
@@ -123,7 +109,6 @@
"0x7C1A": {
"group": "quantum",
"key": "QK_SPACE_CADET_LEFT_SHIFT_PARENTHESIS_OPEN",
"label": "LSft/)",
"aliases": [
"SC_LSPO"
]
@@ -131,7 +116,6 @@
"0x7C1B": {
"group": "quantum",
"key": "QK_SPACE_CADET_RIGHT_SHIFT_PARENTHESIS_CLOSE",
"label": "RSft/)",
"aliases": [
"SC_RSPC"
]
@@ -139,7 +123,6 @@
"0x7C1C": {
"group": "quantum",
"key": "QK_SPACE_CADET_LEFT_ALT_PARENTHESIS_OPEN",
"label": "LAlt/(",
"aliases": [
"SC_LAPO"
]
@@ -147,7 +130,6 @@
"0x7C1D": {
"group": "quantum",
"key": "QK_SPACE_CADET_RIGHT_ALT_PARENTHESIS_CLOSE",
"label": "RAlt/)",
"aliases": [
"SC_RAPC"
]
@@ -155,7 +137,6 @@
"0x7C1E": {
"group": "quantum",
"key": "QK_SPACE_CADET_RIGHT_SHIFT_ENTER",
"label": "RSft/Ent",
"aliases": [
"SC_SENT"
]
@@ -186,7 +167,6 @@
"0x7C30": {
"group": "quantum",
"key": "QK_UNICODE_MODE_NEXT",
"label": "Unicode Mode Next",
"aliases": [
"UC_NEXT"
]
@@ -194,7 +174,6 @@
"0x7C31": {
"group": "quantum",
"key": "QK_UNICODE_MODE_PREVIOUS",
"label": "Unicode Mode Previous",
"aliases": [
"UC_PREV"
]
@@ -202,7 +181,6 @@
"0x7C32": {
"group": "quantum",
"key": "QK_UNICODE_MODE_MACOS",
"label": "Unicode Mode macOS",
"aliases": [
"UC_MAC"
]
@@ -210,7 +188,6 @@
"0x7C33": {
"group": "quantum",
"key": "QK_UNICODE_MODE_LINUX",
"label": "Unicode Mode Linux",
"aliases": [
"UC_LINX"
]
@@ -218,7 +195,6 @@
"0x7C34": {
"group": "quantum",
"key": "QK_UNICODE_MODE_WINDOWS",
"label": "Unicode Mode Windows",
"aliases": [
"UC_WIN"
]
@@ -226,7 +202,6 @@
"0x7C35": {
"group": "quantum",
"key": "QK_UNICODE_MODE_BSD",
"label": "Unicode Mode BSD",
"aliases": [
"UC_BSD"
]
@@ -234,7 +209,6 @@
"0x7C36": {
"group": "quantum",
"key": "QK_UNICODE_MODE_WINCOMPOSE",
"label": "Unicode Mode WinCompose",
"aliases": [
"UC_WINC"
]
@@ -242,7 +216,6 @@
"0x7C37": {
"group": "quantum",
"key": "QK_UNICODE_MODE_EMACS",
"label": "Unicode Mode emacs",
"aliases": [
"UC_EMAC"
]
@@ -251,7 +224,6 @@
"0x7C40": {
"group": "quantum",
"key": "QK_HAPTIC_ON",
"label": "Haptic On",
"aliases": [
"HF_ON"
]
@@ -259,7 +231,6 @@
"0x7C41": {
"group": "quantum",
"key": "QK_HAPTIC_OFF",
"label": "Haptic Off",
"aliases": [
"HF_OFF"
]
@@ -267,7 +238,6 @@
"0x7C42": {
"group": "quantum",
"key": "QK_HAPTIC_TOGGLE",
"label": "Toggle Haptic",
"aliases": [
"HF_TOGG"
]
@@ -275,7 +245,6 @@
"0x7C43": {
"group": "quantum",
"key": "QK_HAPTIC_RESET",
"label": "Haptic Reset",
"aliases": [
"HF_RST"
]
@@ -283,7 +252,6 @@
"0x7C44": {
"group": "quantum",
"key": "QK_HAPTIC_FEEDBACK_TOGGLE",
"label": "Toggle Haptic Feedback",
"aliases": [
"HF_FDBK"
]
@@ -291,7 +259,6 @@
"0x7C45": {
"group": "quantum",
"key": "QK_HAPTIC_BUZZ_TOGGLE",
"label": "Toggle Haptic Buzz",
"aliases": [
"HF_BUZZ"
]
@@ -299,7 +266,6 @@
"0x7C46": {
"group": "quantum",
"key": "QK_HAPTIC_MODE_NEXT",
"label": "Haptic Mode Next",
"aliases": [
"HF_NEXT"
]
@@ -307,7 +273,6 @@
"0x7C47": {
"group": "quantum",
"key": "QK_HAPTIC_MODE_PREVIOUS",
"label": "Haptic Mode Previous",
"aliases": [
"HF_PREV"
]
@@ -315,7 +280,6 @@
"0x7C48": {
"group": "quantum",
"key": "QK_HAPTIC_CONTINUOUS_TOGGLE",
"label": "Toggle Haptic Continuous",
"aliases": [
"HF_CONT"
]
@@ -323,7 +287,6 @@
"0x7C49": {
"group": "quantum",
"key": "QK_HAPTIC_CONTINUOUS_UP",
"label": "Haptic Continuous Up",
"aliases": [
"HF_CONU"
]
@@ -331,7 +294,6 @@
"0x7C4A": {
"group": "quantum",
"key": "QK_HAPTIC_CONTINUOUS_DOWN",
"label": "Haptic Continuous Down",
"aliases": [
"HF_COND"
]
@@ -339,7 +301,6 @@
"0x7C4B": {
"group": "quantum",
"key": "QK_HAPTIC_DWELL_UP",
"label": "Haptic Dwell Up",
"aliases": [
"HF_DWLU"
]
@@ -347,7 +308,6 @@
"0x7C4C": {
"group": "quantum",
"key": "QK_HAPTIC_DWELL_DOWN",
"label": "Haptic Dwell Down",
"aliases": [
"HF_DWLD"
]
@@ -356,7 +316,6 @@
"0x7C50": {
"group": "quantum",
"key": "QK_COMBO_ON",
"label": "Combo On",
"aliases": [
"CM_ON"
]
@@ -364,7 +323,6 @@
"0x7C51": {
"group": "quantum",
"key": "QK_COMBO_OFF",
"label": "Combo Off",
"aliases": [
"CM_OFF"
]
@@ -372,7 +330,6 @@
"0x7C52": {
"group": "quantum",
"key": "QK_COMBO_TOGGLE",
"label": "Toggle Combo",
"aliases": [
"CM_TOGG"
]
@@ -381,7 +338,6 @@
"0x7C53": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_RECORD_START_1",
"label": "Dynamic Macro Record 1",
"aliases": [
"DM_REC1"
]
@@ -389,7 +345,6 @@
"0x7C54": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_RECORD_START_2",
"label": "Dynamic Macro Record 2",
"aliases": [
"DM_REC2"
]
@@ -397,7 +352,6 @@
"0x7C55": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_RECORD_STOP",
"label": "Dynamic Macro Stop Recording",
"aliases": [
"DM_RSTP"
]
@@ -405,7 +359,6 @@
"0x7C56": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_PLAY_1",
"label": "Dynamic Macro Play 1",
"aliases": [
"DM_PLY1"
]
@@ -413,7 +366,6 @@
"0x7C57": {
"group": "quantum",
"key": "QK_DYNAMIC_MACRO_PLAY_2",
"label": "Dynamic Macro Play 2",
"aliases": [
"DM_PLY2"
]
@@ -422,7 +374,6 @@
"0x7C58": {
"group": "quantum",
"key": "QK_LEADER",
"label": "Leader",
"aliases": [
"QK_LEAD"
]
@@ -430,14 +381,12 @@
"0x7C59": {
"group": "quantum",
"key": "QK_LOCK",
"label": "Lock"
"key": "QK_LOCK"
},
"0x7C5A": {
"group": "quantum",
"key": "QK_ONE_SHOT_ON",
"label": "One Shot On",
"aliases": [
"OS_ON"
]
@@ -445,7 +394,6 @@
"0x7C5B": {
"group": "quantum",
"key": "QK_ONE_SHOT_OFF",
"label": "One Shot Off",
"aliases": [
"OS_OFF"
]
@@ -453,7 +401,6 @@
"0x7C5C": {
"group": "quantum",
"key": "QK_ONE_SHOT_TOGGLE",
"label": "Toggle One Shot",
"aliases": [
"OS_TOGG"
]
@@ -462,7 +409,6 @@
"0x7C5D": {
"group": "quantum",
"key": "QK_KEY_OVERRIDE_TOGGLE",
"label": "Toggle Key Overrides",
"aliases": [
"KO_TOGG"
]
@@ -470,7 +416,6 @@
"0x7C5E": {
"group": "quantum",
"key": "QK_KEY_OVERRIDE_ON",
"label": "Key Overrides On",
"aliases": [
"KO_ON"
]
@@ -478,7 +423,6 @@
"0x7C5F": {
"group": "quantum",
"key": "QK_KEY_OVERRIDE_OFF",
"label": "Key Overrides Off",
"aliases": [
"KO_OFF"
]
@@ -487,7 +431,6 @@
"0x7C60": {
"group": "quantum",
"key": "QK_SECURE_LOCK",
"label": "Lock",
"aliases": [
"SE_LOCK"
]
@@ -495,7 +438,6 @@
"0x7C61": {
"group": "quantum",
"key": "QK_SECURE_UNLOCK",
"label": "Unlock",
"aliases": [
"SE_UNLK"
]
@@ -503,7 +445,6 @@
"0x7C62": {
"group": "quantum",
"key": "QK_SECURE_TOGGLE",
"label": "Toggle Lock",
"aliases": [
"SE_TOGG"
]
@@ -511,7 +452,6 @@
"0x7C63": {
"group": "quantum",
"key": "QK_SECURE_REQUEST",
"label": "Request Unlock",
"aliases": [
"SE_REQ"
]
@@ -520,7 +460,6 @@
"0x7C70": {
"group": "quantum",
"key": "QK_DYNAMIC_TAPPING_TERM_PRINT",
"label": "Print Dynamic Tapping Term",
"aliases": [
"DT_PRNT"
]
@@ -528,7 +467,6 @@
"0x7C71": {
"group": "quantum",
"key": "QK_DYNAMIC_TAPPING_TERM_UP",
"label": "Dynamic Tapping Term Up",
"aliases": [
"DT_UP"
]
@@ -536,7 +474,6 @@
"0x7C72": {
"group": "quantum",
"key": "QK_DYNAMIC_TAPPING_TERM_DOWN",
"label": "Dynamic Tapping Term Down",
"aliases": [
"DT_DOWN"
]
@@ -545,7 +482,6 @@
"0x7C73": {
"group": "quantum",
"key": "QK_CAPS_WORD_TOGGLE",
"label": "Toggle Caps Word",
"aliases": [
"CW_TOGG"
]
@@ -554,7 +490,6 @@
"0x7C74": {
"group": "quantum",
"key": "QK_AUTOCORRECT_ON",
"label": "Autocorrect On",
"aliases": [
"AC_ON"
]
@@ -562,7 +497,6 @@
"0x7C75": {
"group": "quantum",
"key": "QK_AUTOCORRECT_OFF",
"label": "Autocorrect Off",
"aliases": [
"AC_OFF"
]
@@ -570,7 +504,6 @@
"0x7C76": {
"group": "quantum",
"key": "QK_AUTOCORRECT_TOGGLE",
"label": "Toggle Autocorrect",
"aliases": [
"AC_TOGG"
]
@@ -3,7 +3,7 @@
"0x00C1": {
"group": "media",
"key": "KC_MISSION_CONTROL",
"label": "Mission Control",
"label": "Open Mission Control",
"aliases": [
"KC_MCTL"
]
@@ -11,7 +11,7 @@
"0x00C2": {
"group": "media",
"key": "KC_LAUNCHPAD",
"label": "Launchpad",
"label": "Open Launchpad",
"aliases": [
"KC_LPAD"
]
+32 -64
View File
@@ -2,163 +2,131 @@
"keycodes": {
"0x7E00": {
"group": "kb",
"key": "QK_KB_0",
"label": "Keyboard 0"
"key": "QK_KB_0"
},
"0x7E01": {
"group": "kb",
"key": "QK_KB_1",
"label": "Keyboard 1"
"key": "QK_KB_1"
},
"0x7E02": {
"group": "kb",
"key": "QK_KB_2",
"label": "Keyboard 2"
"key": "QK_KB_2"
},
"0x7E03": {
"group": "kb",
"key": "QK_KB_3",
"label": "Keyboard 3"
"key": "QK_KB_3"
},
"0x7E04": {
"group": "kb",
"key": "QK_KB_4",
"label": "Keyboard 4"
"key": "QK_KB_4"
},
"0x7E05": {
"group": "kb",
"key": "QK_KB_5",
"label": "Keyboard 5"
"key": "QK_KB_5"
},
"0x7E06": {
"group": "kb",
"key": "QK_KB_6",
"label": "Keyboard 6"
"key": "QK_KB_6"
},
"0x7E07": {
"group": "kb",
"key": "QK_KB_7",
"label": "Keyboard 7"
"key": "QK_KB_7"
},
"0x7E08": {
"group": "kb",
"key": "QK_KB_8",
"label": "Keyboard 8"
"key": "QK_KB_8"
},
"0x7E09": {
"group": "kb",
"key": "QK_KB_9",
"label": "Keyboard 9"
"key": "QK_KB_9"
},
"0x7E0A": {
"group": "kb",
"key": "QK_KB_10",
"label": "Keyboard 10"
"key": "QK_KB_10"
},
"0x7E0B": {
"group": "kb",
"key": "QK_KB_11",
"label": "Keyboard 11"
"key": "QK_KB_11"
},
"0x7E0C": {
"group": "kb",
"key": "QK_KB_12",
"label": "Keyboard 12"
"key": "QK_KB_12"
},
"0x7E0D": {
"group": "kb",
"key": "QK_KB_13",
"label": "Keyboard 13"
"key": "QK_KB_13"
},
"0x7E0E": {
"group": "kb",
"key": "QK_KB_14",
"label": "Keyboard 14"
"key": "QK_KB_14"
},
"0x7E0F": {
"group": "kb",
"key": "QK_KB_15",
"label": "Keyboard 15"
"key": "QK_KB_15"
},
"0x7E10": {
"group": "kb",
"key": "QK_KB_16",
"label": "Keyboard 16"
"key": "QK_KB_16"
},
"0x7E11": {
"group": "kb",
"key": "QK_KB_17",
"label": "Keyboard 17"
"key": "QK_KB_17"
},
"0x7E12": {
"group": "kb",
"key": "QK_KB_18",
"label": "Keyboard 18"
"key": "QK_KB_18"
},
"0x7E13": {
"group": "kb",
"key": "QK_KB_19",
"label": "Keyboard 19"
"key": "QK_KB_19"
},
"0x7E14": {
"group": "kb",
"key": "QK_KB_20",
"label": "Keyboard 20"
"key": "QK_KB_20"
},
"0x7E15": {
"group": "kb",
"key": "QK_KB_21",
"label": "Keyboard 21"
"key": "QK_KB_21"
},
"0x7E16": {
"group": "kb",
"key": "QK_KB_22",
"label": "Keyboard 22"
"key": "QK_KB_22"
},
"0x7E17": {
"group": "kb",
"key": "QK_KB_23",
"label": "Keyboard 23"
"key": "QK_KB_23"
},
"0x7E18": {
"group": "kb",
"key": "QK_KB_24",
"label": "Keyboard 24"
"key": "QK_KB_24"
},
"0x7E19": {
"group": "kb",
"key": "QK_KB_25",
"label": "Keyboard 25"
"key": "QK_KB_25"
},
"0x7E1A": {
"group": "kb",
"key": "QK_KB_26",
"label": "Keyboard 26"
"key": "QK_KB_26"
},
"0x7E1B": {
"group": "kb",
"key": "QK_KB_27",
"label": "Keyboard 27"
"key": "QK_KB_27"
},
"0x7E1C": {
"group": "kb",
"key": "QK_KB_28",
"label": "Keyboard 28"
"key": "QK_KB_28"
},
"0x7E1D": {
"group": "kb",
"key": "QK_KB_29",
"label": "Keyboard 29"
"key": "QK_KB_29"
},
"0x7E1E": {
"group": "kb",
"key": "QK_KB_30",
"label": "Keyboard 30"
"key": "QK_KB_30"
},
"0x7E1F": {
"group": "kb",
"key": "QK_KB_31",
"label": "Keyboard 31"
"key": "QK_KB_31"
}
}
}
@@ -5,7 +5,6 @@
"0x7000": {
"group": "magic",
"key": "QK_MAGIC_SWAP_CONTROL_CAPS_LOCK",
"label": "Swap LCtl⇄Caps",
"aliases": [
"CL_SWAP"
]
@@ -13,7 +12,6 @@
"0x7001": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_CONTROL_CAPS_LOCK",
"label": "Unswap LCtl⇄Caps",
"aliases": [
"CL_NORM"
]
@@ -21,7 +19,6 @@
"0x7002": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_CONTROL_CAPS_LOCK",
"label": "Toggle LCtl⇄Caps",
"aliases": [
"CL_TOGG"
]
@@ -29,7 +26,6 @@
"0x7003": {
"group": "magic",
"key": "QK_MAGIC_CAPS_LOCK_AS_CONTROL_OFF",
"label": "Caps≠LCtl",
"aliases": [
"CL_CAPS"
]
@@ -37,7 +33,6 @@
"0x7004": {
"group": "magic",
"key": "QK_MAGIC_CAPS_LOCK_AS_CONTROL_ON",
"label": "Caps=LCtl",
"aliases": [
"CL_CTRL"
]
@@ -45,7 +40,6 @@
"0x7005": {
"group": "magic",
"key": "QK_MAGIC_SWAP_LALT_LGUI",
"label": "Swap LAlt⇄LGUI",
"aliases": [
"AG_LSWP"
]
@@ -53,7 +47,6 @@
"0x7006": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_LALT_LGUI",
"label": "Unswap LAlt⇄LGUI",
"aliases": [
"AG_LNRM"
]
@@ -61,7 +54,6 @@
"0x7007": {
"group": "magic",
"key": "QK_MAGIC_SWAP_RALT_RGUI",
"label": "Swap RAlt⇄RGUI",
"aliases": [
"AG_RSWP"
]
@@ -69,7 +61,6 @@
"0x7008": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_RALT_RGUI",
"label": "Unswap RAlt⇄RGUI",
"aliases": [
"AG_RNRM"
]
@@ -77,7 +68,6 @@
"0x7009": {
"group": "magic",
"key": "QK_MAGIC_GUI_ON",
"label": "GUI On",
"aliases": [
"GU_ON"
]
@@ -85,7 +75,6 @@
"0x700A": {
"group": "magic",
"key": "QK_MAGIC_GUI_OFF",
"label": "GUI Off",
"aliases": [
"GU_OFF"
]
@@ -93,7 +82,6 @@
"0x700B": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_GUI",
"label": "Toggle GUI",
"aliases": [
"GU_TOGG"
]
@@ -101,7 +89,6 @@
"0x700C": {
"group": "magic",
"key": "QK_MAGIC_SWAP_GRAVE_ESC",
"label": "Swap `⇄Esc",
"aliases": [
"GE_SWAP"
]
@@ -109,7 +96,6 @@
"0x700D": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_GRAVE_ESC",
"label": "Unswap `⇄Esc",
"aliases": [
"GE_NORM"
]
@@ -117,7 +103,6 @@
"0x700E": {
"group": "magic",
"key": "QK_MAGIC_SWAP_BACKSLASH_BACKSPACE",
"label": "Swap \\⇄Bspc",
"aliases": [
"BS_SWAP"
]
@@ -125,7 +110,6 @@
"0x700F": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_BACKSLASH_BACKSPACE",
"label": "Unswap \\⇄Bspc",
"aliases": [
"BS_NORM"
]
@@ -133,7 +117,6 @@
"0x7010": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_BACKSLASH_BACKSPACE",
"label": "Toggle \\⇄Bspc",
"aliases": [
"BS_TOGG"
]
@@ -141,7 +124,6 @@
"0x7011": {
"group": "magic",
"key": "QK_MAGIC_NKRO_ON",
"label": "NKRO On",
"aliases": [
"NK_ON"
]
@@ -149,7 +131,6 @@
"0x7012": {
"group": "magic",
"key": "QK_MAGIC_NKRO_OFF",
"label": "NKRO Off",
"aliases": [
"NK_OFF"
]
@@ -157,7 +138,6 @@
"0x7013": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_NKRO",
"label": "Toggle NKRO",
"aliases": [
"NK_TOGG"
]
@@ -165,7 +145,6 @@
"0x7014": {
"group": "magic",
"key": "QK_MAGIC_SWAP_ALT_GUI",
"label": "Swap Alt⇄GUI",
"aliases": [
"AG_SWAP"
]
@@ -173,7 +152,6 @@
"0x7015": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_ALT_GUI",
"label": "Unswap Alt⇄GUI",
"aliases": [
"AG_NORM"
]
@@ -181,7 +159,6 @@
"0x7016": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_ALT_GUI",
"label": "Toggle Alt⇄GUI",
"aliases": [
"AG_TOGG"
]
@@ -189,7 +166,6 @@
"0x7017": {
"group": "magic",
"key": "QK_MAGIC_SWAP_LCTL_LGUI",
"label": "Swap LCtl⇄LGUI",
"aliases": [
"CG_LSWP"
]
@@ -197,7 +173,6 @@
"0x7018": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_LCTL_LGUI",
"label": "Unswap LCtl⇄LGUI",
"aliases": [
"CG_LNRM"
]
@@ -205,7 +180,6 @@
"0x7019": {
"group": "magic",
"key": "QK_MAGIC_SWAP_RCTL_RGUI",
"label": "Swap RCtl⇄RGUI",
"aliases": [
"CG_RSWP"
]
@@ -213,7 +187,6 @@
"0x701A": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_RCTL_RGUI",
"label": "Unswap RCtl⇄RGUI",
"aliases": [
"CG_RNRM"
]
@@ -221,7 +194,6 @@
"0x701B": {
"group": "magic",
"key": "QK_MAGIC_SWAP_CTL_GUI",
"label": "Swap Ctl⇄GUI",
"aliases": [
"CG_SWAP"
]
@@ -229,7 +201,6 @@
"0x701C": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_CTL_GUI",
"label": "Unswap Ctl⇄GUI",
"aliases": [
"CG_NORM"
]
@@ -237,7 +208,6 @@
"0x701D": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_CTL_GUI",
"label": "Toggle Ctl⇄GUI",
"aliases": [
"CG_TOGG"
]
@@ -245,7 +215,6 @@
"0x701E": {
"group": "magic",
"key": "QK_MAGIC_EE_HANDS_LEFT",
"label": "EE Hands Left",
"aliases": [
"EH_LEFT"
]
@@ -253,7 +222,6 @@
"0x701F": {
"group": "magic",
"key": "QK_MAGIC_EE_HANDS_RIGHT",
"label": "EE Hands Right",
"aliases": [
"EH_RGHT"
]
@@ -261,7 +229,6 @@
"0x7020": {
"group": "magic",
"key": "QK_MAGIC_SWAP_ESCAPE_CAPS_LOCK",
"label": "Swap Esc⇄Caps",
"aliases": [
"EC_SWAP"
]
@@ -269,7 +236,6 @@
"0x7021": {
"group": "magic",
"key": "QK_MAGIC_UNSWAP_ESCAPE_CAPS_LOCK",
"label": "Unswap Esc⇄Caps",
"aliases": [
"EC_NORM"
]
@@ -277,7 +243,6 @@
"0x7022": {
"group": "magic",
"key": "QK_MAGIC_TOGGLE_ESCAPE_CAPS_LOCK",
"label": "Toggle Esc⇄Caps",
"aliases": [
"EC_TOGG"
]
File diff suppressed because it is too large Load Diff
@@ -3,7 +3,6 @@
"0x7C77": {
"group": "quantum",
"key": "QK_TRI_LAYER_LOWER",
"label": "Lower",
"aliases": [
"TL_LOWR"
]
@@ -11,7 +10,6 @@
"0x7C78": {
"group": "quantum",
"key": "QK_TRI_LAYER_UPPER",
"label": "Upper",
"aliases": [
"TL_UPPR"
]
@@ -5,7 +5,6 @@
"0x7200": {
"group": "sequencer",
"key": "QK_SEQUENCER_ON",
"label": "Sequencer On",
"aliases": [
"SQ_ON"
]
@@ -13,7 +12,6 @@
"0x7201": {
"group": "sequencer",
"key": "QK_SEQUENCER_OFF",
"label": "Sequencer Off",
"aliases": [
"SQ_OFF"
]
@@ -21,7 +19,6 @@
"0x7202": {
"group": "sequencer",
"key": "QK_SEQUENCER_TOGGLE",
"label": "Toggle Sequencer",
"aliases": [
"SQ_TOGG"
]
@@ -29,7 +26,6 @@
"0x7203": {
"group": "sequencer",
"key": "QK_SEQUENCER_TEMPO_DOWN",
"label": "Tempo Down",
"aliases": [
"SQ_TMPD"
]
@@ -37,7 +33,6 @@
"0x7204": {
"group": "sequencer",
"key": "QK_SEQUENCER_TEMPO_UP",
"label": "Tempo Up",
"aliases": [
"SQ_TMPU"
]
@@ -45,7 +40,6 @@
"0x7205": {
"group": "sequencer",
"key": "QK_SEQUENCER_RESOLUTION_DOWN",
"label": "Resolution Down",
"aliases": [
"SQ_RESD"
]
@@ -53,7 +47,6 @@
"0x7206": {
"group": "sequencer",
"key": "QK_SEQUENCER_RESOLUTION_UP",
"label": "Resolution Up",
"aliases": [
"SQ_RESU"
]
@@ -61,7 +54,6 @@
"0x7207": {
"group": "sequencer",
"key": "QK_SEQUENCER_STEPS_ALL",
"label": "All Steps",
"aliases": [
"SQ_SALL"
]
@@ -69,7 +61,6 @@
"0x7208": {
"group": "sequencer",
"key": "QK_SEQUENCER_STEPS_CLEAR",
"label": "Clear Steps",
"aliases": [
"SQ_SCLR"
]
@@ -3,7 +3,6 @@
"0x56F0": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_TOGGLE",
"label": "Toggle Swap Hands",
"aliases": [
"SH_TOGG"
]
@@ -11,7 +10,6 @@
"0x56F1": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_TAP_TOGGLE",
"label": "Swap Hands Tap Toggle",
"aliases": [
"SH_TT"
]
@@ -19,7 +17,6 @@
"0x56F2": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_MOMENTARY_ON",
"label": "Swap Hands Momentary On",
"aliases": [
"SH_MON"
]
@@ -27,7 +24,6 @@
"0x56F3": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_MOMENTARY_OFF",
"label": "Swap Hands Momentary Off",
"aliases": [
"SH_MOFF"
]
@@ -35,7 +31,6 @@
"0x56F4": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_OFF",
"label": "Unswap Hands",
"aliases": [
"SH_OFF"
]
@@ -43,7 +38,6 @@
"0x56F5": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_ON",
"label": "Swap Hands",
"aliases": [
"SH_ON"
]
@@ -51,7 +45,6 @@
"0x56F6": {
"group": "swap_hands",
"key": "QK_SWAP_HANDS_ONE_SHOT",
"label": "Swap Hands One Shot",
"aliases": [
"SH_OS"
]
@@ -2,163 +2,131 @@
"keycodes": {
"0x7E40": {
"group": "user",
"key": "QK_USER_0",
"label": "User 0"
"key": "QK_USER_0"
},
"0x7E41": {
"group": "user",
"key": "QK_USER_1",
"label": "User 1"
"key": "QK_USER_1"
},
"0x7E42": {
"group": "user",
"key": "QK_USER_2",
"label": "User 2"
"key": "QK_USER_2"
},
"0x7E43": {
"group": "user",
"key": "QK_USER_3",
"label": "User 3"
"key": "QK_USER_3"
},
"0x7E44": {
"group": "user",
"key": "QK_USER_4",
"label": "User 4"
"key": "QK_USER_4"
},
"0x7E45": {
"group": "user",
"key": "QK_USER_5",
"label": "User 5"
"key": "QK_USER_5"
},
"0x7E46": {
"group": "user",
"key": "QK_USER_6",
"label": "User 6"
"key": "QK_USER_6"
},
"0x7E47": {
"group": "user",
"key": "QK_USER_7",
"label": "User 7"
"key": "QK_USER_7"
},
"0x7E48": {
"group": "user",
"key": "QK_USER_8",
"label": "User 8"
"key": "QK_USER_8"
},
"0x7E49": {
"group": "user",
"key": "QK_USER_9",
"label": "User 9"
"key": "QK_USER_9"
},
"0x7E4A": {
"group": "user",
"key": "QK_USER_10",
"label": "User 10"
"key": "QK_USER_10"
},
"0x7E4B": {
"group": "user",
"key": "QK_USER_11",
"label": "User 11"
"key": "QK_USER_11"
},
"0x7E4C": {
"group": "user",
"key": "QK_USER_12",
"label": "User 12"
"key": "QK_USER_12"
},
"0x7E4D": {
"group": "user",
"key": "QK_USER_13",
"label": "User 13"
"key": "QK_USER_13"
},
"0x7E4E": {
"group": "user",
"key": "QK_USER_14",
"label": "User 14"
"key": "QK_USER_14"
},
"0x7E4F": {
"group": "user",
"key": "QK_USER_15",
"label": "User 15"
"key": "QK_USER_15"
},
"0x7E50": {
"group": "user",
"key": "QK_USER_16",
"label": "User 16"
"key": "QK_USER_16"
},
"0x7E51": {
"group": "user",
"key": "QK_USER_17",
"label": "User 17"
"key": "QK_USER_17"
},
"0x7E52": {
"group": "user",
"key": "QK_USER_18",
"label": "User 18"
"key": "QK_USER_18"
},
"0x7E53": {
"group": "user",
"key": "QK_USER_19",
"label": "User 19"
"key": "QK_USER_19"
},
"0x7E54": {
"group": "user",
"key": "QK_USER_20",
"label": "User 20"
"key": "QK_USER_20"
},
"0x7E55": {
"group": "user",
"key": "QK_USER_21",
"label": "User 21"
"key": "QK_USER_21"
},
"0x7E56": {
"group": "user",
"key": "QK_USER_22",
"label": "User 22"
"key": "QK_USER_22"
},
"0x7E57": {
"group": "user",
"key": "QK_USER_23",
"label": "User 23"
"key": "QK_USER_23"
},
"0x7E58": {
"group": "user",
"key": "QK_USER_24",
"label": "User 24"
"key": "QK_USER_24"
},
"0x7E59": {
"group": "user",
"key": "QK_USER_25",
"label": "User 25"
"key": "QK_USER_25"
},
"0x7E5A": {
"group": "user",
"key": "QK_USER_26",
"label": "User 26"
"key": "QK_USER_26"
},
"0x7E5B": {
"group": "user",
"key": "QK_USER_27",
"label": "User 27"
"key": "QK_USER_27"
},
"0x7E5C": {
"group": "user",
"key": "QK_USER_28",
"label": "User 28"
"key": "QK_USER_28"
},
"0x7E5D": {
"group": "user",
"key": "QK_USER_29",
"label": "User 29"
"key": "QK_USER_29"
},
"0x7E5E": {
"group": "user",
"key": "QK_USER_30",
"label": "User 30"
"key": "QK_USER_30"
},
"0x7E5F": {
"group": "user",
"key": "QK_USER_31",
"label": "User 31"
"key": "QK_USER_31"
}
}
}
@@ -3,7 +3,6 @@
"0x7C79": {
"group": "quantum",
"key": "QK_REPEAT_KEY",
"label": "Repeat",
"aliases": [
"QK_REP"
]
@@ -11,7 +10,6 @@
"0x7C7A": {
"group": "quantum",
"key": "QK_ALT_REPEAT_KEY",
"label": "Repeat Alternate",
"aliases": [
"QK_AREP"
]
@@ -3,7 +3,6 @@
"0x7810": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_ON",
"label": "LED Matrix On",
"aliases": [
"LM_ON"
]
@@ -11,7 +10,6 @@
"0x7811": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_OFF",
"label": "LED Matrix Off",
"aliases": [
"LM_OFF"
]
@@ -19,7 +17,6 @@
"0x7812": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_TOGGLE",
"label": "Toggle LED Matrix",
"aliases": [
"LM_TOGG"
]
@@ -27,7 +24,6 @@
"0x7813": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_MODE_NEXT",
"label": "LED Matrix Next",
"aliases": [
"LM_NEXT"
]
@@ -35,7 +31,6 @@
"0x7814": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_MODE_PREVIOUS",
"label": "LED Matrix Previous",
"aliases": [
"LM_PREV"
]
@@ -43,7 +38,6 @@
"0x7815": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_BRIGHTNESS_UP",
"label": "LED Matrix Brightness Up",
"aliases": [
"LM_BRIU"
]
@@ -51,7 +45,6 @@
"0x7816": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_BRIGHTNESS_DOWN",
"label": "LED Matrix Brightness Down",
"aliases": [
"LM_BRID"
]
@@ -59,7 +52,6 @@
"0x7817": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_SPEED_UP",
"label": "LED Matrix Speed Up",
"aliases": [
"LM_SPDU"
]
@@ -67,7 +59,6 @@
"0x7818": {
"group": "led_matrix",
"key": "QK_LED_MATRIX_SPEED_DOWN",
"label": "LED Matrix Speed Down",
"aliases": [
"LM_SPDD"
]
@@ -76,7 +67,6 @@
"0x7820": {
"group": "underglow",
"key": "QK_UNDERGLOW_TOGGLE",
"label": "Toggle RGB Underglow",
"aliases": [
"UG_TOGG"
]
@@ -84,7 +74,6 @@
"0x7821": {
"group": "underglow",
"key": "QK_UNDERGLOW_MODE_NEXT",
"label": "RGB Underglow Next",
"aliases": [
"!reset!",
"UG_NEXT"
@@ -93,7 +82,6 @@
"0x7822": {
"group": "underglow",
"key": "QK_UNDERGLOW_MODE_PREVIOUS",
"label": "RGB Underglow Previous",
"aliases": [
"!reset!",
"UG_PREV"
@@ -102,7 +90,6 @@
"0x7823": {
"group": "underglow",
"key": "QK_UNDERGLOW_HUE_UP",
"label": "RGB Underglow Hue Up",
"aliases": [
"UG_HUEU"
]
@@ -110,7 +97,6 @@
"0x7824": {
"group": "underglow",
"key": "QK_UNDERGLOW_HUE_DOWN",
"label": "RGB Underglow Hue Down",
"aliases": [
"UG_HUED"
]
@@ -118,7 +104,6 @@
"0x7825": {
"group": "underglow",
"key": "QK_UNDERGLOW_SATURATION_UP",
"label": "RGB Underglow Saturation Up",
"aliases": [
"UG_SATU"
]
@@ -126,7 +111,6 @@
"0x7826": {
"group": "underglow",
"key": "QK_UNDERGLOW_SATURATION_DOWN",
"label": "RGB Underglow Saturation Down",
"aliases": [
"UG_SATD"
]
@@ -134,7 +118,6 @@
"0x7827": {
"group": "underglow",
"key": "QK_UNDERGLOW_VALUE_UP",
"label": "RGB Underglow Value Up",
"aliases": [
"UG_VALU"
]
@@ -142,7 +125,6 @@
"0x7828": {
"group": "underglow",
"key": "QK_UNDERGLOW_VALUE_DOWN",
"label": "RGB Underglow Value Down",
"aliases": [
"UG_VALD"
]
@@ -150,7 +132,6 @@
"0x7829": {
"group": "underglow",
"key": "QK_UNDERGLOW_SPEED_UP",
"label": "RGB Underglow Speed Up",
"aliases": [
"UG_SPDU"
]
@@ -158,7 +139,6 @@
"0x782A": {
"group": "underglow",
"key": "QK_UNDERGLOW_SPEED_DOWN",
"label": "RGB Underglow Speed Down",
"aliases": [
"UG_SPDD"
]
@@ -167,7 +147,6 @@
"0x7840": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_ON",
"label": "RGB Matrix On",
"aliases": [
"RM_ON"
]
@@ -175,7 +154,6 @@
"0x7841": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_OFF",
"label": "RGB Matrix Off"
"aliases": [
"RM_OFF"
]
@@ -183,7 +161,6 @@
"0x7842": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_TOGGLE",
"label": "Toggle RGB Matrix",
"aliases": [
"RM_TOGG"
]
@@ -191,7 +168,6 @@
"0x7843": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_MODE_NEXT",
"label": "RGB Matrix Next",
"aliases": [
"RM_NEXT"
]
@@ -199,7 +175,6 @@
"0x7844": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_MODE_PREVIOUS",
"label": "RGB Matrix Previous",
"aliases": [
"RM_PREV"
]
@@ -207,7 +182,6 @@
"0x7845": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_HUE_UP",
"label": "RGB Matrix Hue Up",
"aliases": [
"RM_HUEU"
]
@@ -215,7 +189,6 @@
"0x7846": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_HUE_DOWN",
"label": "RGB Matrix Hue Down",
"aliases": [
"RM_HUED"
]
@@ -223,7 +196,6 @@
"0x7847": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_SATURATION_UP",
"label": "RGB Matrix Saturation Up",
"aliases": [
"RM_SATU"
]
@@ -231,7 +203,6 @@
"0x7848": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_SATURATION_DOWN",
"label": "RGB Matrix Saturation Down",
"aliases": [
"RM_SATD"
]
@@ -239,7 +210,6 @@
"0x7849": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_VALUE_UP",
"label": "RGB Matrix Value Up",
"aliases": [
"RM_VALU"
]
@@ -247,7 +217,6 @@
"0x784A": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_VALUE_DOWN",
"label": "RGB Matrix Value Down",
"aliases": [
"RM_VALD"
]
@@ -255,7 +224,6 @@
"0x784B": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_SPEED_UP",
"label": "RGB Matrix Speed Up",
"aliases": [
"RM_SPDU"
]
@@ -263,7 +231,6 @@
"0x784C": {
"group": "rgb_matrix",
"key": "QK_RGB_MATRIX_SPEED_DOWN",
"label": "RGB Matrix Speed Down",
"aliases": [
"RM_SPDD"
]
@@ -3,7 +3,7 @@
"0x00CD": {
"group": "mouse",
"key": "QK_MOUSE_CURSOR_UP",
"label": "Mouse Up",
"label": "Mouse cursor up",
"aliases": [
"!reset!",
"MS_UP"
@@ -12,7 +12,7 @@
"0x00CE": {
"group": "mouse",
"key": "QK_MOUSE_CURSOR_DOWN",
"label": "Mouse Down",
"label": "Mouse cursor down",
"aliases": [
"!reset!",
"MS_DOWN"
@@ -21,7 +21,7 @@
"0x00CF": {
"group": "mouse",
"key": "QK_MOUSE_CURSOR_LEFT",
"label": "Mouse Left",
"label": "Mouse cursor left",
"aliases": [
"!reset!",
"MS_LEFT"
@@ -30,7 +30,7 @@
"0x00D0": {
"group": "mouse",
"key": "QK_MOUSE_CURSOR_RIGHT",
"label": "Mouse Right",
"label": "Mouse cursor right",
"aliases": [
"!reset!",
"MS_RGHT"
@@ -39,7 +39,7 @@
"0x00D1": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_1",
"label": "Mouse Button 1",
"label": "Mouse button 1",
"aliases": [
"!reset!",
"MS_BTN1"
@@ -48,7 +48,7 @@
"0x00D2": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_2",
"label": "Mouse Button 2",
"label": "Mouse button 2",
"aliases": [
"!reset!",
"MS_BTN2"
@@ -57,7 +57,7 @@
"0x00D3": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_3",
"label": "Mouse Button 3",
"label": "Mouse button 3",
"aliases": [
"!reset!",
"MS_BTN3"
@@ -66,7 +66,7 @@
"0x00D4": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_4",
"label": "Mouse Button 4",
"label": "Mouse button 4",
"aliases": [
"!reset!",
"MS_BTN4"
@@ -75,7 +75,7 @@
"0x00D5": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_5",
"label": "Mouse Button 5",
"label": "Mouse button 5",
"aliases": [
"!reset!",
"MS_BTN5"
@@ -84,7 +84,7 @@
"0x00D6": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_6",
"label": "Mouse Button 6",
"label": "Mouse button 6",
"aliases": [
"!reset!",
"MS_BTN6"
@@ -93,7 +93,7 @@
"0x00D7": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_7",
"label": "Mouse Button 7",
"label": "Mouse button 7",
"aliases": [
"!reset!",
"MS_BTN7"
@@ -102,7 +102,7 @@
"0x00D8": {
"group": "mouse",
"key": "QK_MOUSE_BUTTON_8",
"label": "Mouse Button 8",
"label": "Mouse button 8",
"aliases": [
"!reset!",
"MS_BTN8"
@@ -111,7 +111,7 @@
"0x00D9": {
"group": "mouse",
"key": "QK_MOUSE_WHEEL_UP",
"label": "Mouse Wheel Up",
"label": "Mouse wheel up",
"aliases": [
"!reset!",
"MS_WHLU"
@@ -120,7 +120,7 @@
"0x00DA": {
"group": "mouse",
"key": "QK_MOUSE_WHEEL_DOWN",
"label": "Mouse Wheel Down",
"label": "Mouse wheel down",
"aliases": [
"!reset!",
"MS_WHLD"
@@ -129,7 +129,7 @@
"0x00DB": {
"group": "mouse",
"key": "QK_MOUSE_WHEEL_LEFT",
"label": "Mouse Wheel Left",
"label": "Mouse wheel left",
"aliases": [
"!reset!",
"MS_WHLL"
@@ -138,7 +138,7 @@
"0x00DC": {
"group": "mouse",
"key": "QK_MOUSE_WHEEL_RIGHT",
"label": "Mouse Wheel Right",
"label": "Mouse wheel right",
"aliases": [
"!reset!",
"MS_WHLR"
@@ -147,7 +147,7 @@
"0x00DD": {
"group": "mouse",
"key": "QK_MOUSE_ACCELERATION_0",
"label": "Acceleration 0",
"label": "Set mouse acceleration to 0",
"aliases": [
"!reset!",
"MS_ACL0"
@@ -156,7 +156,7 @@
"0x00DE": {
"group": "mouse",
"key": "QK_MOUSE_ACCELERATION_1",
"label": "Acceleration 1",
"label": "Set mouse acceleration to 1",
"aliases": [
"!reset!",
"MS_ACL1"
@@ -165,7 +165,7 @@
"0x00DF": {
"group": "mouse",
"key": "QK_MOUSE_ACCELERATION_2",
"label": "Acceleration 2",
"label": "Set mouse acceleration to 2",
"aliases": [
"!reset!",
"MS_ACL2"
@@ -8,7 +8,6 @@
"0x7780": {
"group": "connection",
"key": "QK_OUTPUT_AUTO",
"label": "Output Auto",
"aliases": [
"OU_AUTO"
]
@@ -16,7 +15,6 @@
"0x7781": {
"group": "connection",
"key": "QK_OUTPUT_NEXT",
"label": "Next Output",
"aliases": [
"OU_NEXT"
]
@@ -24,7 +22,6 @@
"0x7782": {
"group": "connection",
"key": "QK_OUTPUT_PREV",
"label": "Previous Output",
"aliases": [
"OU_PREV"
]
@@ -32,7 +29,6 @@
"0x7783": {
"group": "connection",
"key": "QK_OUTPUT_NONE",
"label": "None",
"aliases": [
"OU_NONE"
]
@@ -40,7 +36,6 @@
"0x7784": {
"group": "connection",
"key": "QK_OUTPUT_USB",
"label": "USB",
"aliases": [
"OU_USB"
]
@@ -48,7 +43,6 @@
"0x7785": {
"group": "connection",
"key": "QK_OUTPUT_2P4GHZ",
"label": "2.4GHz",
"aliases": [
"OU_2P4G"
]
@@ -56,7 +50,6 @@
"0x7786": {
"group": "connection",
"key": "QK_OUTPUT_BLUETOOTH",
"label": "Bluetooth",
"aliases": [
"OU_BT"
]
@@ -65,7 +58,6 @@
"0x7790": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE_NEXT",
"label": "Bluetooth Profile Next",
"aliases": [
"BT_NEXT"
]
@@ -73,7 +65,6 @@
"0x7791": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE_PREV",
"label": "Bluetooth Profile Previous",
"aliases": [
"BT_PREV"
]
@@ -81,7 +72,6 @@
"0x7792": {
"group": "connection",
"key": "QK_BLUETOOTH_UNPAIR",
"label": "Unpair",
"aliases": [
"BT_UNPR"
]
@@ -89,7 +79,6 @@
"0x7793": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE1",
"label": "Bluetooth Profile 1",
"aliases": [
"BT_PRF1"
]
@@ -97,7 +86,6 @@
"0x7794": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE2",
"label": "Bluetooth Profile 2",
"aliases": [
"BT_PRF2"
]
@@ -105,7 +93,6 @@
"0x7795": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE3",
"label": "Bluetooth Profile 3",
"aliases": [
"BT_PRF3"
]
@@ -113,7 +100,6 @@
"0x7796": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE4",
"label": "Bluetooth Profile 4",
"aliases": [
"BT_PRF4"
]
@@ -121,7 +107,6 @@
"0x7797": {
"group": "connection",
"key": "QK_BLUETOOTH_PROFILE5",
"label": "Bluetooth Profile 5",
"aliases": [
"BT_PRF5"
]
@@ -6,7 +6,6 @@
"0x7C7B": {
"group": "quantum",
"key": "QK_LAYER_LOCK",
"label": "Layer Lock",
"aliases": [
"QK_LLCK"
]
@@ -1,265 +0,0 @@
{
"ranges": {
"0x5A40/0x003F": {
"define": "QK_PLOVER_HID"
}
},
"keycodes": {
"0x5A40": {
"group": "plover_hid",
"key": "PLV_S1"
},
"0x5A41": {
"group": "plover_hid",
"key": "PLV_TL"
},
"0x5A42": {
"group": "plover_hid",
"key": "PLV_KL"
},
"0x5A43": {
"group": "plover_hid",
"key": "PLV_PL"
},
"0x5A44": {
"group": "plover_hid",
"key": "PLV_WL"
},
"0x5A45": {
"group": "plover_hid",
"key": "PLV_HL"
},
"0x5A46": {
"group": "plover_hid",
"key": "PLV_RL"
},
"0x5A47": {
"group": "plover_hid",
"key": "PLV_A"
},
"0x5A48": {
"group": "plover_hid",
"key": "PLV_O"
},
"0x5A49": {
"group": "plover_hid",
"key": "PLV_ST1"
},
"0x5A4A": {
"group": "plover_hid",
"key": "PLV_E"
},
"0x5A4B": {
"group": "plover_hid",
"key": "PLV_U"
},
"0x5A4C": {
"group": "plover_hid",
"key": "PLV_FR"
},
"0x5A4D": {
"group": "plover_hid",
"key": "PLV_RR"
},
"0x5A4E": {
"group": "plover_hid",
"key": "PLV_PR"
},
"0x5A4F": {
"group": "plover_hid",
"key": "PLV_BR"
},
"0x5A50": {
"group": "plover_hid",
"key": "PLV_LR"
},
"0x5A51": {
"group": "plover_hid",
"key": "PLV_GR"
},
"0x5A52": {
"group": "plover_hid",
"key": "PLV_TR"
},
"0x5A53": {
"group": "plover_hid",
"key": "PLV_SR"
},
"0x5A54": {
"group": "plover_hid",
"key": "PLV_DR"
},
"0x5A55": {
"group": "plover_hid",
"key": "PLV_ZR"
},
"0x5A56": {
"group": "plover_hid",
"key": "PLV_N1"
},
"0x5A57": {
"group": "plover_hid",
"key": "PLV_S2"
},
"0x5A58": {
"group": "plover_hid",
"key": "PLV_ST2"
},
"0x5A59": {
"group": "plover_hid",
"key": "PLV_ST3"
},
"0x5A5A": {
"group": "plover_hid",
"key": "PLV_ST4"
},
"0x5A5B": {
"group": "plover_hid",
"key": "PLV_N2"
},
"0x5A5C": {
"group": "plover_hid",
"key": "PLV_N3"
},
"0x5A5D": {
"group": "plover_hid",
"key": "PLV_N4"
},
"0x5A5E": {
"group": "plover_hid",
"key": "PLV_N5"
},
"0x5A5F": {
"group": "plover_hid",
"key": "PLV_N6"
},
"0x5A60": {
"group": "plover_hid",
"key": "PLV_N7"
},
"0x5A61": {
"group": "plover_hid",
"key": "PLV_N8"
},
"0x5A62": {
"group": "plover_hid",
"key": "PLV_N9"
},
"0x5A63": {
"group": "plover_hid",
"key": "PLV_NA"
},
"0x5A64": {
"group": "plover_hid",
"key": "PLV_NB"
},
"0x5A65": {
"group": "plover_hid",
"key": "PLV_NC"
},
"0x5A66": {
"group": "plover_hid",
"key": "PLV_X1"
},
"0x5A67": {
"group": "plover_hid",
"key": "PLV_X2"
},
"0x5A68": {
"group": "plover_hid",
"key": "PLV_X3"
},
"0x5A69": {
"group": "plover_hid",
"key": "PLV_X4"
},
"0x5A6A": {
"group": "plover_hid",
"key": "PLV_X5"
},
"0x5A6B": {
"group": "plover_hid",
"key": "PLV_X6"
},
"0x5A6C": {
"group": "plover_hid",
"key": "PLV_X7"
},
"0x5A6D": {
"group": "plover_hid",
"key": "PLV_X8"
},
"0x5A6E": {
"group": "plover_hid",
"key": "PLV_X9"
},
"0x5A6F": {
"group": "plover_hid",
"key": "PLV_X10"
},
"0x5A70": {
"group": "plover_hid",
"key": "PLV_X11"
},
"0x5A71": {
"group": "plover_hid",
"key": "PLV_X12"
},
"0x5A72": {
"group": "plover_hid",
"key": "PLV_X13"
},
"0x5A73": {
"group": "plover_hid",
"key": "PLV_X14"
},
"0x5A74": {
"group": "plover_hid",
"key": "PLV_X15"
},
"0x5A75": {
"group": "plover_hid",
"key": "PLV_X16"
},
"0x5A76": {
"group": "plover_hid",
"key": "PLV_X17"
},
"0x5A77": {
"group": "plover_hid",
"key": "PLV_X18"
},
"0x5A78": {
"group": "plover_hid",
"key": "PLV_X19"
},
"0x5A79": {
"group": "plover_hid",
"key": "PLV_X20"
},
"0x5A7A": {
"group": "plover_hid",
"key": "PLV_X21"
},
"0x5A7B": {
"group": "plover_hid",
"key": "PLV_X22"
},
"0x5A7C": {
"group": "plover_hid",
"key": "PLV_X23"
},
"0x5A7D": {
"group": "plover_hid",
"key": "PLV_X24"
},
"0x5A7E": {
"group": "plover_hid",
"key": "PLV_X25"
},
"0x5A7F": {
"group": "plover_hid",
"key": "PLV_X26"
}
}
}
-3
View File
@@ -1,3 +0,0 @@
{
// This version exists to signify addition of split data sync support.
}
-3
View File
@@ -1,3 +0,0 @@
{
// This version exists to signify addition of eeconfig support.
}
+2 -7
View File
@@ -19,8 +19,6 @@
// Audio
"AUDIO_DEFAULT_ON": {"info_key": "audio.default.on", "value_type": "bool"},
"AUDIO_DEFAULT_CLICKY_ON": {"info_key": "audio.default.clicky", "value_type": "bool"},
"AUDIO_PIN": {"info_key": "audio.pins.0"},
"AUDIO_PIN_ALT": {"info_key": "audio.pins.1"},
"AUDIO_POWER_CONTROL_PIN": {"info_key": "audio.power_control.pin"},
"AUDIO_POWER_CONTROL_PIN_ON_STATE": {"info_key": "audio.power_control.on_state", "value_type": "int" },
"AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "flag"},
@@ -198,7 +196,7 @@
// Split Keyboard
"SOFT_SERIAL_PIN": {"info_key": "split.serial.pin"},
"SELECT_SOFT_SERIAL_SPEED": {"info_key": "split.serial.speed", "value_type": "int"},
"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"},
@@ -226,9 +224,6 @@
"PERMISSIVE_HOLD_PER_KEY": {"info_key": "tapping.permissive_hold_per_key", "value_type": "flag"},
"RETRO_TAPPING": {"info_key": "tapping.retro", "value_type": "flag"},
"RETRO_TAPPING_PER_KEY": {"info_key": "tapping.retro_per_key", "value_type": "flag"},
"SPECULATIVE_HOLD": {"info_key": "tapping.speculative_hold", "value_type": "flag"},
"SPECULATIVE_HOLD_FLOW_TERM": {"info_key": "tapping.speculative_hold_flow_term", "value_type": "int"},
"SPECULATIVE_HOLD_ONE_KEY": {"info_key": "tapping.speculative_hold_one_key", "value_type": "flag"},
"TAP_CODE_DELAY": {"info_key": "qmk.tap_keycode_delay", "value_type": "int"},
"TAP_HOLD_CAPS_DELAY": {"info_key": "qmk.tap_capslock_delay", "value_type": "int"},
"TAPPING_TERM": {"info_key": "tapping.term", "value_type": "int"},
@@ -273,9 +268,9 @@
"PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false, "value_type": "str", "deprecated": true, "replace_with": "`keyboard_name` in info.json"},
"PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.pid` in info.json"},
"VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.vid` in info.json"},
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag", "deprecated": true, "replace_with": "`host.default.nkro` in info.json"},
// Items we want flagged in lint
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag", "invalid": true, "replace_with": "`host.default.nkro` in info.json"},
"VIAL_KEYBOARD_UID": {"info_key": "_invalid.vial_uid", "invalid": true},
"VIAL_UNLOCK_COMBO_COLS": {"info_key": "_invalid.vial_unlock_cols", "invalid": true},
"VIAL_UNLOCK_COMBO_ROWS": {"info_key": "_invalid.vial_unlock_rows", "invalid": true}
-3
View File
@@ -11,9 +11,6 @@
"on_state": 1
},
"debounce": 5,
"dynamic_keymap": {
"layer_count": 4
},
"features": {
"command": false,
"console": false
+1 -17
View File
@@ -46,8 +46,7 @@
"manufacturer": {"$ref": "./definitions.jsonschema#/text_identifier"},
"url": {
"type": "string",
"format": "uri",
"minLength": 1
"format": "uri"
},
"development_board": {
"type": "string",
@@ -334,17 +333,6 @@
}
}
},
"dynamic_keymap": {
"type": "object",
"properties": {
"eeprom_max_addr": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"layer_count": {
"type": "integer",
"minimum": 1,
"maximum": 32
}
}
},
"eeprom": {
"properties": {
"driver": {"type": "string"},
@@ -993,7 +981,6 @@
"type": "object",
"properties": {
"chordal_hold": {"type": "boolean"},
"flow_tap_term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"force_hold": {"type": "boolean"},
"force_hold_per_key": {"type": "boolean"},
"ignore_mod_tap_interrupt": {"type": "boolean"},
@@ -1003,9 +990,6 @@
"permissive_hold_per_key": {"type": "boolean"},
"retro": {"type": "boolean"},
"retro_per_key": {"type": "boolean"},
"speculative_hold": {"type": "boolean"},
"speculative_hold_flow_term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"speculative_hold_one_key": {"type": "boolean"},
"term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
"term_per_key": {"type": "boolean"},
"toggle": {"$ref": "./definitions.jsonschema#/unsigned_int"}
-190
View File
@@ -1,190 +0,0 @@
# QMK Breaking Changes - 2025 Nov 30 Changelog
## Notable Features {#notable-features}
### Speculative Hold option for mod-taps: hold mods instantly while unsettled [#25572](https://github.com/qmk/qmk_firmware/pull/25572)
Speculative Hold makes mod-tap keys more responsive by applying the modifier instantly on keydown, before the tap-hold decision is made. This is especially useful for actions like Shift+click and Ctrl+scroll wheel with an external mouse, which can feel laggy with standard mod-taps.
The firmware holds the modifier speculatively. Once the key's behavior is settled:
* If held, the modifier remains active as expected until the key is released.
* If tapped, the speculative modifier is canceled just before the tapping keycode is sent.
Speculative Hold applies the modifier early but does not change the underlying tap-hold decision logic. Speculative Hold is compatible to use in combination with any other tap-hold options.
see the [Speculative Hold](../tap_hold#speculative-hold) documentation for more information.
## Changes Requiring User Action
### Updated Keyboard Codebases
| Old Keyboard Name | New Keyboard Name |
|----------------------------------|-------------------------|
| 0xcb/splaytoraid/32u4 | 0xcb/splaytoraid |
| 0xcb/splaytoraid/rp2040_ce | 0xcb/splaytoraid |
| 1upkeyboards/sweet16v2/kb2040 | 1upkeyboards/sweet16v2 |
| 1upkeyboards/sweet16v2/pro_micro | 1upkeyboards/sweet16v2 |
| 40percentclub/gherkin/kb2040 | 40percentclub/gherkin |
| 40percentclub/gherkin/pro_micro | 40percentclub/gherkin |
| durgod/dgk6x/venus | durgod/dgk6x/venus_ansi |
### Reduce tap dance memory usage, move state out of data [#25415](https://github.com/qmk/qmk_firmware/pull/25415)
The tap dance state has been separated from the action structure. Custom tap dance functions now receive the state as a separate parameter instead of accessing it through `action->state`.
If your keymap uses custom tap dance functions that access the tap dance state, you need to update your code.
* You can't use `action->state`. Instead you need to call `tap_dance_state_t *tap_dance_get_state(uint8_t tap_dance_idx)` to get the state.
* You now get a pointer to the state, so use `->` notation rather than `.` notation to get fields from it.
### Before:
```c
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
tap_dance_action_t *action;
switch (keycode) {
case TD(CT_CLN):
action = tap_dance_get(QK_TAP_DANCE_GET_INDEX(keycode));
if (!record->event.pressed && action->state.count && !action->state.finished) {
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;
tap_code16(tap_hold->tap);
}
}
return true;
}
```
### After:
```c
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
tap_dance_action_t *action;
tap_dance_state_t* state;
switch (keycode) {
case TD(CT_CLN):
action = tap_dance_get(QK_TAP_DANCE_GET_INDEX(keycode));
state = tap_dance_get_state(QK_TAP_DANCE_GET_INDEX(keycode));
if (!record->event.pressed && state != NULL && state->count && !state->finished) {
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;
tap_code16(tap_hold->tap);
}
}
return true;
}
```
## Deprecation Notices
In line with the [notice period](../support_deprecation_policy#how-much-advance-notice-will-be-given), deprecation notices for larger items are listed here.
### Remove override of QK_{LED,RGB}_MATRIX_TOGGLE keycode [#25672](https://github.com/qmk/qmk_firmware/pull/25672)
[#24649](https://github.com/qmk/qmk_firmware/pull/24649) implemented genetic behavior, including keycodes, to cycle flags.
Any overriding of existing keycodes that duplicate this behavior will be removed to ensure consistency with core functionality.
## Full changelist
Core:
* suspend: suppress wake up keypress ([#23389](https://github.com/qmk/qmk_firmware/pull/23389))
* [Feature Improvement]add option to keep layer state when recording dynamic macros ([#24418](https://github.com/qmk/qmk_firmware/pull/24418))
* Add generic handling to cycle LED/RGB Matrix flags ([#24649](https://github.com/qmk/qmk_firmware/pull/24649))
* Implement `mod_t` packed struct ([#25168](https://github.com/qmk/qmk_firmware/pull/25168))
* Implement minimal connection update logic ([#25334](https://github.com/qmk/qmk_firmware/pull/25334))
* Reduce tap dance memory usage, move state out of data ([#25415](https://github.com/qmk/qmk_firmware/pull/25415))
* Refactor debounce algorithm with static allocation ([#25515](https://github.com/qmk/qmk_firmware/pull/25515))
* Restructure Pixel Rain interval code ([#25516](https://github.com/qmk/qmk_firmware/pull/25516))
* Guard remapping logic with MAGIC_ENABLE ([#25537](https://github.com/qmk/qmk_firmware/pull/25537))
* Update default OLED font ([#25565](https://github.com/qmk/qmk_firmware/pull/25565))
* Speculative Hold option for mod-taps: hold mods instantly while unsettled. ([#25572](https://github.com/qmk/qmk_firmware/pull/25572))
* Simplify hue calculation in raindrops animation ([#25587](https://github.com/qmk/qmk_firmware/pull/25587))
* Simplify tap_code16_delay ([#25595](https://github.com/qmk/qmk_firmware/pull/25595))
* Debounce: Deprecate num_rows parameter ([#25632](https://github.com/qmk/qmk_firmware/pull/25632))
* Add I2C Transmit and Receive function ([#25637](https://github.com/qmk/qmk_firmware/pull/25637))
* [QP] Minor cleanup and support for RGB888 surface ([#25706](https://github.com/qmk/qmk_firmware/pull/25706))
* Restrict mouse timer activation to movement keycodes ([#25716](https://github.com/qmk/qmk_firmware/pull/25716))
* Update STM32F446 default HSE to 8MHz ([#25717](https://github.com/qmk/qmk_firmware/pull/25717))
* making flowtap timer public so it can be used easily with combos ([#25731](https://github.com/qmk/qmk_firmware/pull/25731))
* Add PixArt PAW-3222 mouse sensor driver ([#25763](https://github.com/qmk/qmk_firmware/pull/25763))
* Merge upstream uf2conv changes ([#25786](https://github.com/qmk/qmk_firmware/pull/25786))
* Partially skip generating community modules when none enabled ([#25819](https://github.com/qmk/qmk_firmware/pull/25819))
CLI:
* Generate default encoder resolution for sparse config ([#25247](https://github.com/qmk/qmk_firmware/pull/25247))
* Add DIP Switch map support to keymap.json ([#25431](https://github.com/qmk/qmk_firmware/pull/25431))
* Add return code to `qmk userspace-doctor` ([#25775](https://github.com/qmk/qmk_firmware/pull/25775))
* Better defaulting of `{RGB,LED}_MATRIX_DEFAULT_FLAGS` ([#25785](https://github.com/qmk/qmk_firmware/pull/25785))
* add BCD versions of QMK Version ([#25804](https://github.com/qmk/qmk_firmware/pull/25804))
* Lint error on missing keyboard readme ([#25814](https://github.com/qmk/qmk_firmware/pull/25814))
Submodule updates:
* Update ChibiOS-Contrib. ([#25751](https://github.com/qmk/qmk_firmware/pull/25751))
Keyboards:
* `atreus`: restore intended matrix implementations ([#24082](https://github.com/qmk/qmk_firmware/pull/24082))
* add SteelSeries prime, a stripped down prime+ ([#24719](https://github.com/qmk/qmk_firmware/pull/24719))
* Add new macropad Sharkropad ([#24961](https://github.com/qmk/qmk_firmware/pull/24961))
* Addition of the D60B tsangan pcb ([#25245](https://github.com/qmk/qmk_firmware/pull/25245))
* Migrate `eeconfig_init_kb` implementations to config ([#25422](https://github.com/qmk/qmk_firmware/pull/25422))
* Generate `CUSTOM_MATRIX = lite` without `matrix_pins.custom` ([#25453](https://github.com/qmk/qmk_firmware/pull/25453))
* Add classic48 keyboard ([#25492](https://github.com/qmk/qmk_firmware/pull/25492))
* add durgod venus iso support ([#25526](https://github.com/qmk/qmk_firmware/pull/25526))
* Migrate `g_led_config` to DD (0-9, A) ([#25558](https://github.com/qmk/qmk_firmware/pull/25558))
* Migrate `g_led_config` to DD (B, C) ([#25559](https://github.com/qmk/qmk_firmware/pull/25559))
* Migrate `g_led_config` to DD (D) ([#25560](https://github.com/qmk/qmk_firmware/pull/25560))
* Migrate `g_led_config` to DD (E, F) ([#25561](https://github.com/qmk/qmk_firmware/pull/25561))
* Remove duplication of RP2040 config defaults ([#25563](https://github.com/qmk/qmk_firmware/pull/25563))
* Refactor 40percentclub/ut47 ([#25571](https://github.com/qmk/qmk_firmware/pull/25571))
* E7-V2 Implementation ([#25594](https://github.com/qmk/qmk_firmware/pull/25594))
* Migrate `g_led_config` to DD (G) ([#25598](https://github.com/qmk/qmk_firmware/pull/25598))
* Migrate `g_led_config` to DD (H) ([#25599](https://github.com/qmk/qmk_firmware/pull/25599))
* Migrate `g_led_config` to DD (I) ([#25600](https://github.com/qmk/qmk_firmware/pull/25600))
* Migrate `g_led_config` to DD (JK1) ([#25601](https://github.com/qmk/qmk_firmware/pull/25601))
* Migrate `g_led_config` to DD (K2) ([#25602](https://github.com/qmk/qmk_firmware/pull/25602))
* Migrate `g_led_config` to DD (K3) ([#25603](https://github.com/qmk/qmk_firmware/pull/25603))
* Migrate `g_led_config` to DD (K4) ([#25605](https://github.com/qmk/qmk_firmware/pull/25605))
* Migrate `g_led_config` to DD (K5) ([#25606](https://github.com/qmk/qmk_firmware/pull/25606))
* Migrate `g_led_config` to DD (K6) ([#25607](https://github.com/qmk/qmk_firmware/pull/25607))
* Refactor `40percentclub/gherkin` ([#25608](https://github.com/qmk/qmk_firmware/pull/25608))
* Refactor `0xcb/splaytoraid` ([#25609](https://github.com/qmk/qmk_firmware/pull/25609))
* Refactor `1upkeyboards/sweet16v2` ([#25610](https://github.com/qmk/qmk_firmware/pull/25610))
* Migrate `g_led_config` to DD (K7) ([#25616](https://github.com/qmk/qmk_firmware/pull/25616))
* Migrate `g_led_config` to DD (L) ([#25617](https://github.com/qmk/qmk_firmware/pull/25617))
* Migrate `g_led_config` to DD (M1) ([#25618](https://github.com/qmk/qmk_firmware/pull/25618))
* Migrate `g_led_config` to DD (M2) ([#25619](https://github.com/qmk/qmk_firmware/pull/25619))
* Migrate `g_led_config` to DD (M3) ([#25620](https://github.com/qmk/qmk_firmware/pull/25620))
* Migrate `g_led_config` to DD (NO) ([#25621](https://github.com/qmk/qmk_firmware/pull/25621))
* Migrate `g_led_config` to DD (P) ([#25622](https://github.com/qmk/qmk_firmware/pull/25622))
* Migrate `g_led_config` to DD (QR) ([#25623](https://github.com/qmk/qmk_firmware/pull/25623))
* Migrate `g_led_config` to DD (S) ([#25624](https://github.com/qmk/qmk_firmware/pull/25624))
* Migrate `g_led_config` to DD (TUW) ([#25625](https://github.com/qmk/qmk_firmware/pull/25625))
* Remove idobao *_DISABLE_UNDERGLOW behaviour ([#25638](https://github.com/qmk/qmk_firmware/pull/25638))
* Migrate `g_led_config` to DD (YZ) ([#25650](https://github.com/qmk/qmk_firmware/pull/25650))
* Tidy Keebio keyboards ([#25653](https://github.com/qmk/qmk_firmware/pull/25653))
* Remove encoder resolution where duplicating defaults ([#25654](https://github.com/qmk/qmk_firmware/pull/25654))
* Custom oled fonts cleanup ([#25665](https://github.com/qmk/qmk_firmware/pull/25665))
* Binepad KnobX1 - refactor `x1_layer_led` function as weak ([#25668](https://github.com/qmk/qmk_firmware/pull/25668))
* Add DD {LED,RGB}_MATRIX_DEFAULT_FLAGS support ([#25671](https://github.com/qmk/qmk_firmware/pull/25671))
* keyboards: Add Royal Kludge RK61 ([#25694](https://github.com/qmk/qmk_firmware/pull/25694))
* Add TRKeyboard TRK2 keyboard ([#25754](https://github.com/qmk/qmk_firmware/pull/25754))
Keyboard fixes:
* Fixup `kprepublic/bm60hsrgb/rev2` ([#25644](https://github.com/qmk/qmk_firmware/pull/25644))
* Fixup `kprepublic/bm60hsrgb_iso/rev2` ([#25648](https://github.com/qmk/qmk_firmware/pull/25648))
* Fixup `kprepublic/bm60hsrgb_poker/rev2` ([#25649](https://github.com/qmk/qmk_firmware/pull/25649))
* Fixup `rgbkb/pan` ([#25678](https://github.com/qmk/qmk_firmware/pull/25678))
* Align use of keymap level `_kb` callbacks ([#25774](https://github.com/qmk/qmk_firmware/pull/25774))
Others:
* Rework converter docs ([#18314](https://github.com/qmk/qmk_firmware/pull/18314))
* Update USBaspLoader ISP instructions ([#25590](https://github.com/qmk/qmk_firmware/pull/25590))
* Add LED/RGB Matrix flags API docs ([#25673](https://github.com/qmk/qmk_firmware/pull/25673))
Bugs:
* Fix single key combos activating only once ([#25198](https://github.com/qmk/qmk_firmware/pull/25198))
* Fix RGB matrix not syncing and turning off properly on timeout ([#25467](https://github.com/qmk/qmk_firmware/pull/25467))
* Fix drv haptics docs by using the correct function name ([#25733](https://github.com/qmk/qmk_firmware/pull/25733))
* Fix Magic GUI masking logic ([#25780](https://github.com/qmk/qmk_firmware/pull/25780))
* Fix Speculative Hold to enable also right-handed RSFT, RCTL by default. ([#25797](https://github.com/qmk/qmk_firmware/pull/25797))
* Fix community layout keymap discovery ([#25802](https://github.com/qmk/qmk_firmware/pull/25802))
* Fix preference of output file for 'qmk generate-autocorrect-data' ([#25818](https://github.com/qmk/qmk_firmware/pull/25818))
+3
View File
@@ -0,0 +1,3 @@
# Refactor debounce algorithm with static allocation [#25515](https://github.com/qmk/qmk_firmware/pull/25515)
Removed dynamic memory allocation (malloc, free) from all debounce implementations for improved efficiency on embedded systems and to avoid runtime allocation overhead. Refactored state arrays to use direct indexing, simplifying code and eliminating pointer arithmetic. Standardized usage of MATRIX_ROWS_PER_HAND throughout the codebase to ensure consistent support for split keyboards.
+4
View File
@@ -0,0 +1,4 @@
# Changes Requiring User Action
## Debounce: Deprecate init and remove num_rows parameter [#25632](https://github.com/qmk/qmk_firmware/pull/25632)
With dynamic memory allocation removed from all debounce implementations ([#25515](https://github.com/qmk/qmk_firmware/pull/25515)), the `num_rows` parameter has been removed from the `debounce_init()` and `debounce()` functions. The `MATRIX_ROWS_PER_HAND` is now used by default in every implementation.
-75
View File
@@ -1,75 +0,0 @@
# QMK Breaking Changes - 2026 Feb 22 Changelog
## Deprecation Notices
### Removal of deprecated GPIO defines ([#26028](https://github.com/qmk/qmk_firmware/pull/26028))
QMK has long used Arduino-style GPIO naming conventions. This has been confusing for users, as over time they've had new variations added, as well as users mistakenly thinking that QMK supports the rest of the Arduino ecosystem.
The decision was made to rename the GPIO manipulation functions with ones matching QMK Firmware's code styling.
Previous backwards compatibility has now been removed. see the [GPIO Control](../drivers/gpio#macros) documentation for more information.
### Removal of deprecated isLeftHand ([25897](https://github.com/qmk/qmk_firmware/pull/25897))
Users should migrate to `is_keyboard_left()` found in `split_util.h` instead. For example:
```diff
oled_rotation_t oled_init_user(oled_rotation_t rotation) {
- return isLeftHand ? OLED_ROTATION_180 : OLED_ROTATION_0;
+ return is_keyboard_left() ? OLED_ROTATION_180 : OLED_ROTATION_0;
}
```
The deprecated variable `isLeftHand` will be removed in a future breaking changes cycle.
## Full changelist
Core:
* Refactor Makefile logic for locating keymaps ([#25808](https://github.com/qmk/qmk_firmware/pull/25808))
* Move shutdown delay to audio feature ([#25859](https://github.com/qmk/qmk_firmware/pull/25859))
* Refactor core use of deprecated `isLeftHand` ([#25888](https://github.com/qmk/qmk_firmware/pull/25888))
* Allow custom data sync for community modules ([#25955](https://github.com/qmk/qmk_firmware/pull/25955))
* Remove an unreachable break statement ([#26006](https://github.com/qmk/qmk_firmware/pull/26006))
* Remove duplicate host.h ([#26007](https://github.com/qmk/qmk_firmware/pull/26007))
* Remove redundant EEPROM update ([#26008](https://github.com/qmk/qmk_firmware/pull/26008))
* Remove redundant unsigned comparison in apa102_set_brightness ([#26010](https://github.com/qmk/qmk_firmware/pull/26010))
* Remove unused headers ([#26011](https://github.com/qmk/qmk_firmware/pull/26011))
* Return INVALID_DEFERRED_TOKEN on allocation failure ([#26012](https://github.com/qmk/qmk_firmware/pull/26012))
* Remove deprecated GPIO defines ([#26028](https://github.com/qmk/qmk_firmware/pull/26028))
CLI:
* Enforce EOL when formatting files ([#24989](https://github.com/qmk/qmk_firmware/pull/24989))
* Allow keymap.json to disable config flags ([#25502](https://github.com/qmk/qmk_firmware/pull/25502))
* Remove unused `qmk.keymap.write_file`/`qmk.keymap.write_json` ([#25854](https://github.com/qmk/qmk_firmware/pull/25854))
* Include userspace version (QMK_USERSPACE_VERSION) in version.h ([#25882](https://github.com/qmk/qmk_firmware/pull/25882))
* Lint out-of-bounds bootmagic config ([#25899](https://github.com/qmk/qmk_firmware/pull/25899))
* Report permission issues in `qmk doctor` ([#25931](https://github.com/qmk/qmk_firmware/pull/25931))
* Minor alignment of CLI formatting commands ([#25946](https://github.com/qmk/qmk_firmware/pull/25946))
* Update lint to validate keymap names ([#25969](https://github.com/qmk/qmk_firmware/pull/25969))
* Add 'none of the above' to `new-keyboard` dev board prompt ([#25998](https://github.com/qmk/qmk_firmware/pull/25998))
* Remove `config_h_features` from generated `info.json` ([#26024](https://github.com/qmk/qmk_firmware/pull/26024))
* Promote duplication of defaults check to error ([#26025](https://github.com/qmk/qmk_firmware/pull/26025))
Keyboards:
* Add Soldered Macro Pad ([#25834](https://github.com/qmk/qmk_firmware/pull/25834))
* Remove redundant URLs from `.json` ([#25856](https://github.com/qmk/qmk_firmware/pull/25856))
* Guard encoder behaviour on `projectcain/vault*` ([#25864](https://github.com/qmk/qmk_firmware/pull/25864))
* Refactor keyboard/keymap use of deprecated `isLeftHand` ([#25891](https://github.com/qmk/qmk_firmware/pull/25891))
* Remove some unnecessary matrix externs ([#25975](https://github.com/qmk/qmk_firmware/pull/25975))
* Migrate ROW_SHIFTER to core MATRIX_ROW_SHIFTER ([#25977](https://github.com/qmk/qmk_firmware/pull/25977))
Keyboard fixes:
* Fix out-of-bounds bootmagic config ([#25898](https://github.com/qmk/qmk_firmware/pull/25898))
* Fix incorrect `matrix_scan_custom` implementations ([#25999](https://github.com/qmk/qmk_firmware/pull/25999))
Others:
* Add missing labels to DD keycode definitions ([#25503](https://github.com/qmk/qmk_firmware/pull/25503))
* Copilot instructions for pull requests ([#25857](https://github.com/qmk/qmk_firmware/pull/25857))
Bugs:
* Fix flash wear leveling sector calculation ([#24776](https://github.com/qmk/qmk_firmware/pull/24776))
* [Bugfix] WS2812 indexing in split boards ([#25407](https://github.com/qmk/qmk_firmware/pull/25407))
* Correctly resolve keyboard alias during 'qmk new-keymap' ([#25570](https://github.com/qmk/qmk_firmware/pull/25570))
* Fixes for is31fl3729 LED matrix driver off-by-one errors ([#25902](https://github.com/qmk/qmk_firmware/pull/25902))
* Match Key override index type to bounds type to prevent overflow ([#25939](https://github.com/qmk/qmk_firmware/pull/25939))
-122
View File
@@ -1,122 +0,0 @@
# QMK Breaking Changes - 2026 May 31 Changelog
## Notable Changes {#notable-changes}
## Deprecation Notices
In line with the [notice period](../support_deprecation_policy#how-much-advance-notice-will-be-given), deprecation notices for larger items are listed here.
### Removal of deprecated isLeftHand ([25897](https://github.com/qmk/qmk_firmware/pull/25897))
Users must migrate to `is_keyboard_left()` found in `split_util.h` instead. For example:
```diff
oled_rotation_t oled_init_user(oled_rotation_t rotation) {
- return isLeftHand ? OLED_ROTATION_180 : OLED_ROTATION_0;
+ return is_keyboard_left() ? OLED_ROTATION_180 : OLED_ROTATION_0;
}
```
### Removal of `usb.force_nkro`/`FORCE_NKRO` ([#25262](https://github.com/qmk/qmk_firmware/pull/25262))
Unpicking the assumption that only USB can do NKRO, forcing of NKRO on every boot has been deprecated. As this setting persists, it produces unnecessary user confusion when the various NKRO keycodes (for example `NK_TOGG`) do not behave as expected.
The new defaults can be configured in the following ways:
:::::tabs
==== keyboard.json
```json [keyboard.json]
{
"host": { // [!code focus]
"default": { // [!code focus]
"nkro": true // [!code focus]
} // [!code focus]
} // [!code focus]
}
```
==== keymap.json
```json [keymap.json]
{
"config": {
"host": { // [!code focus]
"default": { // [!code focus]
"nkro": true // [!code focus]
} // [!code focus]
} // [!code focus]
}
}
```
==== config.h
```c [config.h]
#pragma once
#define NKRO_DEFAULT_ON true // [!code focus]
```
:::::
## Full changelist
Core:
* Remove deprecated `isLeftHand` ([#25897](https://github.com/qmk/qmk_firmware/pull/25897))
* Either output Unicode or insert in Leader sequence ([#25940](https://github.com/qmk/qmk_firmware/pull/25940))
* Add resolution information to digitizer ([#25958](https://github.com/qmk/qmk_firmware/pull/25958))
* Always generate .map files. ([#25961](https://github.com/qmk/qmk_firmware/pull/25961))
* Add an `mcu_reset` impl for the kiibohd bootloader. ([#25963](https://github.com/qmk/qmk_firmware/pull/25963))
* VIA v13 ([#26001](https://github.com/qmk/qmk_firmware/pull/26001))
* Added PixArt PMW-3325 mouse sensor driver ([#26065](https://github.com/qmk/qmk_firmware/pull/26065))
* Update WL backing store from 16 to 32-bit for AT32 ([#26066](https://github.com/qmk/qmk_firmware/pull/26066))
* Refactor Pixel Fractal effect ([#26071](https://github.com/qmk/qmk_firmware/pull/26071))
* Minor combo code optimisation ([#26073](https://github.com/qmk/qmk_firmware/pull/26073))
* Options to constrain Speculative Hold: `SPECULATIVE_HOLD_ONE_KEY` and `SPECULATIVE_HOLD_FLOW_TERM`. ([#26099](https://github.com/qmk/qmk_firmware/pull/26099))
* Add includes for std::setw ([#26153](https://github.com/qmk/qmk_firmware/pull/26153))
* Bind gtest colour to QMKs 'COLOR' variable ([#26159](https://github.com/qmk/qmk_firmware/pull/26159))
* Print correct test names ([#26160](https://github.com/qmk/qmk_firmware/pull/26160))
* Ignore Uninteresting test warnings during test teardown ([#26161](https://github.com/qmk/qmk_firmware/pull/26161))
* Remove FORCE_NKRO ([#26206](https://github.com/qmk/qmk_firmware/pull/26206))
CLI:
* Update lint to check all keymaps within the repo ([#25970](https://github.com/qmk/qmk_firmware/pull/25970))
* Fail when a duplicate module name is detected ([#26238](https://github.com/qmk/qmk_firmware/pull/26238))
Submodule updates:
* Update ChibiOS, ChibiOS-Contrib. ([#25730](https://github.com/qmk/qmk_firmware/pull/25730))
* Revert "Update ChibiOS, ChibiOS-Contrib." ([#26074](https://github.com/qmk/qmk_firmware/pull/26074))
* ChibiOS, ChibiOS-Contrib updates (redux) ([#26079](https://github.com/qmk/qmk_firmware/pull/26079))
* Bump googletest to v1.16.0 ([#26154](https://github.com/qmk/qmk_firmware/pull/26154))
Keyboards:
* Require "url" field to not be empty ([#25152](https://github.com/qmk/qmk_firmware/pull/25152))
* Add nomis/rpi_pico_25x1 macropad ([#25346](https://github.com/qmk/qmk_firmware/pull/25346))
* Remove override of QK_{LED,RGB}_MATRIX_TOGGLE keycode ([#25672](https://github.com/qmk/qmk_firmware/pull/25672))
* Add reverse layout to SouthPad v2 ([#25707](https://github.com/qmk/qmk_firmware/pull/25707))
* Adding Handwired Bouvet Macropad ([#26040](https://github.com/qmk/qmk_firmware/pull/26040))
* Remove blockader user keymap ([#26075](https://github.com/qmk/qmk_firmware/pull/26075))
* Remove deprecated audio pin defines ([#26111](https://github.com/qmk/qmk_firmware/pull/26111))
* Remove `OLED_DISPLAY_128X32` config ([#26190](https://github.com/qmk/qmk_firmware/pull/26190))
* Migrate SPLIT_OLED_ENABLE ([#26194](https://github.com/qmk/qmk_firmware/pull/26194))
* Add API version assertion for split_data_sync module ([#26237](https://github.com/qmk/qmk_firmware/pull/26237))
Others:
* Bump vitepress to 1.6.4 ([#26067](https://github.com/qmk/qmk_firmware/pull/26067))
* Add usage clarifications to docs/features/unicode.md ([#26156](https://github.com/qmk/qmk_firmware/pull/26156))
Bugs:
* Fix `USER_PRINT` stripping out `uprintf` ([#25919](https://github.com/qmk/qmk_firmware/pull/25919))
* Fix possible repeat key infinite recursion ([#25926](https://github.com/qmk/qmk_firmware/pull/25926))
* Fix `cc-option` on arm-none-eabi-gcc ([#26114](https://github.com/qmk/qmk_firmware/pull/26114))
* Fix color diagnostics for arm-none-eabi-gcc ([#26115](https://github.com/qmk/qmk_firmware/pull/26115))
* Mask out active mods when unregistering after retro tapping ([#26127](https://github.com/qmk/qmk_firmware/pull/26127))
* fix `make test:all` failures seen on macOS Tahoe ([#26136](https://github.com/qmk/qmk_firmware/pull/26136))
* Add workaround for undefined reference to weak function under mingw ([#26167](https://github.com/qmk/qmk_firmware/pull/26167))
* fix(ws2812-pwm): allow WS2812_PWM_TICK_FREQUENCY override ([#26186](https://github.com/qmk/qmk_firmware/pull/26186))
* Clip mouse report values to the logical range from the USB descriptor. ([#26195](https://github.com/qmk/qmk_firmware/pull/26195))
* Align Mouse USB descriptor ([#26230](https://github.com/qmk/qmk_firmware/pull/26230))
+1 -1
View File
@@ -214,7 +214,7 @@
{ "text": "My Pull Request Was Flagged", "link": "/breaking_changes_instructions" },
{
"text": "Most Recent ChangeLog",
"link": "/ChangeLog/20260531"
"link": "/ChangeLog/20250831"
},
{ "text": "Past Breaking Changes", "link": "/breaking_changes_history" },
{ "text": "Deprecation Policy", "link": "/support_deprecation_policy" }
+12 -12
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?
* [2026 May 31](ChangeLog/20260531)
* [2026 Feb 22](ChangeLog/20260222)
* [2025 Nov 30](ChangeLog/20251130)
* [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 Aug 30, 2026.
The next Breaking Change is scheduled for November 30, 2025.
### Important Dates
* 2025 May 31 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
* 2026 Aug 2 - `develop` closed to new PRs.
* 2026 Aug 2 - Call for testers.
* 2026 Aug 16 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
* 2026 Aug 23 - `develop` is locked, only critical bugfix PRs merged.
* 2026 Aug 28 - `master` is locked, no PRs merged.
* 2026 Aug 30 - Merge `develop` to `master`.
* 2026 Aug 30 - `master` is unlocked. PRs can be merged again.
* 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?
-3
View File
@@ -2,9 +2,6 @@
This page links to all previous changelogs from the QMK Breaking Changes process.
* [2026 May 31](ChangeLog/20260531) - version 0.33.0
* [2026 Feb 22](ChangeLog/20260222) - version 0.32.0
* [2025 Nov 30](ChangeLog/20251130) - version 0.31.0
* [2025 Aug 31](ChangeLog/20250831) - version 0.30.0
* [2025 May 25](ChangeLog/20250525) - version 0.29.0
* [2025 Feb 23](ChangeLog/20250223) - version 0.28.0
+35 -6
View File
@@ -4,18 +4,47 @@
The QMK CLI (command line interface) makes building and working with QMK keyboards easier. We have provided a number of commands to simplify and streamline tasks such as obtaining and compiling the QMK firmware, creating keymaps, and more.
### Installation {#installation}
### Requirements {#requirements}
The recommended way to install the QMK CLI and all necessary dependencies (toolchains, flashing utilities, udev rules on Linux) is to use the bootstrapper script:
QMK requires Python 3.9 or greater. We try to keep the number of requirements small but you will also need to install the packages listed in [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt). These are installed automatically when you install the QMK CLI.
### Install Using Homebrew (macOS, some Linux) {#install-using-homebrew}
If you have installed [Homebrew](https://brew.sh) you can tap and install QMK:
```
curl -fsSL https://install.qmk.fm | sh
brew install qmk/qmk/qmk
export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
```
For more options, run:
### 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:
```
curl -fsSL https://install.qmk.fm | sh -s -- --help
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
```
For detailed setup instructions, see [Setting Up Your QMK Environment](newbs_getting_started#set-up-your-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.9 (or later) installed and have installed pip. Then install QMK with this command:
```
python3 -m pip install qmk
export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
```
### Packaging For Other Operating Systems {#packaging-for-other-operating-systems}
We are looking for people to create and maintain a `qmk` package for more operating systems. If you would like to create a package for your OS please follow these guidelines:
* Follow best practices for your OS when they conflict with these guidelines
* Document why in a comment when you do deviate
* Install using a virtualenv
* Instruct the user to set the environment variable `QMK_HOME` to have the firmware source checked out somewhere other than `~/qmk_firmware`.
+5 -5
View File
@@ -12,11 +12,11 @@ If you intend to maintain keyboards and/or contribute to QMK, you can enable the
`qmk config user.developer=True`
This will allow you to see all available subcommands.
::: tip
If you installed QMK using the bootstrapper (`curl -fsSL https://install.qmk.fm | sh`), the development requirements are already installed.
:::
This will allow you to see all available subcommands.
**Note:** You will have to install additional requirements:
```
python3 -m pip install -r requirements-dev.txt
```
# Subcommands
+18
View File
@@ -74,6 +74,24 @@ This is a C header file that is one of the first things included, and will persi
* pins mapped to rows and columns, from left to right. Defines a matrix where each switch is connected to a separate pin and ground.
* `#define AUDIO_VOICES`
* turns on the alternate audio voices (to cycle through)
* `#define C4_AUDIO`
* enables audio on pin C4
* Deprecated. Use `#define AUDIO_PIN C4`
* `#define C5_AUDIO`
* enables audio on pin C5
* Deprecated. Use `#define AUDIO_PIN C5`
* `#define C6_AUDIO`
* enables audio on pin C6
* Deprecated. Use `#define AUDIO_PIN C6`
* `#define B5_AUDIO`
* enables audio on pin B5 (duophony is enabled if one of B pins is enabled along with one of C pins)
* Deprecated. Use `#define AUDIO_PIN B5`, or use `#define AUDIO_PIN_ALT B5` if a `C` pin is enabled with `AUDIO_PIN`
* `#define B6_AUDIO`
* enables audio on pin B6 (duophony is enabled if one of B pins is enabled along with one of C pins)
* Deprecated. Use `#define AUDIO_PIN B6`, or use `#define AUDIO_PIN_ALT B6` if a `C` pin is enabled with `AUDIO_PIN`
* `#define B7_AUDIO`
* enables audio on pin B7 (duophony is enabled if one of B pins is enabled along with one of C pins)
* Deprecated. Use `#define AUDIO_PIN B7`, or use `#define AUDIO_PIN_ALT B7` if a `C` pin is enabled with `AUDIO_PIN`
* `#define BACKLIGHT_PIN B7`
* pin of the backlight
* `#define BACKLIGHT_LEVELS 3`
-4
View File
@@ -14,10 +14,6 @@ Example:
This page covers my super cool feature. You can use this feature to make coffee, squeeze fresh oj, and have an egg mcmuffin and hashbrowns delivered from your local macca's by drone.
```
# Paragraphs
Do not use hard line breaks within the raw Markdown for each paragraph. These are optional in Markdown, and have no effect on the rendered output. This means each raw paragraph will be a single long line in your editor (best viewed with line wrapping enabled).
# Headings
Your page should generally have multiple "H1" headings. Only H1 and H2 headings will included in the Table of Contents, so plan them out appropriately. Excess width should be avoided in H1 and H2 headings to prevent the Table of Contents from getting too wide.
+7 -7
View File
@@ -4,7 +4,7 @@ QMK presents itself to the host as a regular HID keyboard device, and as such re
There are two notable exceptions: the Caterina bootloader, usually seen on Pro Micros, and the HalfKay bootloader shipped with PJRC Teensys, appear as a serial port and a generic HID device respectively, and so do not require a driver.
We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have set up the development environment with MSYS2, the QMK CLI installation script will have already installed the drivers for you.
We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have set up the development environment with MSYS2, the `qmk_install.sh` script will have already installed the drivers for you.
## Installation
@@ -22,7 +22,7 @@ If Zadig lists one or more devices with the `HidUsb` driver, your keyboard is pr
If the arrow appears green, select the driver, and click **Install Driver**. See the [list of known bootloaders](#list-of-known-bootloaders) for the correct driver to install.
![Zadig with a bootloader driver correctly installed](/b8VgXzx.png)
![Zadig with a bootloader driver correctly installed](https://i.imgur.com/b8VgXzx.png)
Finally, unplug and replug the keyboard to make sure the new driver has been loaded. If you are using the QMK Toolbox to flash, exit and restart it too, as it can sometimes fail to recognize the driver change.
@@ -30,15 +30,15 @@ Finally, unplug and replug the keyboard to make sure the new driver has been loa
If you find that you can no longer type with the keyboard, you may have accidentally replaced the driver for the keyboard itself instead of for the bootloader. This can happen when the keyboard is not in the bootloader mode. You can easily confirm this in Zadig - a healthy keyboard has the `HidUsb` driver installed on all of its interfaces:
![A healthy keyboard as seen by Zadig](/Hx0E5kC.png)
![A healthy keyboard as seen by Zadig](https://i.imgur.com/Hx0E5kC.png)
Open the Device Manager, select **View → Devices by container**, and look for an entry with your keyboard's name.
![The board with the wrong driver installed, in Device Manager](/o7WLvBl.png)
![The board with the wrong driver installed, in Device Manager](https://i.imgur.com/o7WLvBl.png)
Right-click each entry and hit **Uninstall device**. Make sure to tick **Delete the driver software for this device** first if it appears.
![The Device Uninstall dialog, with the "delete driver" checkbox ticked](/aEs2RuA.png)
![The Device Uninstall dialog, with the "delete driver" checkbox ticked](https://i.imgur.com/aEs2RuA.png)
Click **Action → Scan for hardware changes**. At this point, you should be able to type again. Double check in Zadig that the keyboard device(s) are using the `HidUsb` driver. If so, you're all done, and your board should be functional again! Otherwise, repeat this process until Zadig reports the correct driver.
@@ -54,11 +54,11 @@ Open the Device Manager, select **View → Devices by container**, and look for
Find the `Inf name` value in the Details tab of the device properties. This should generally be something like `oemXX.inf`:
![Device properties showing the Inf name value](/Bu4mk9m.png)
![Device properties showing the Inf name value](https://i.imgur.com/Bu4mk9m.png)
Then, open a new Command Prompt window as an Administrator (type in `cmd` into the Start menu and press Ctrl+Shift+Enter). Run `pnputil /enum-drivers` to verify the `Inf name` matches the `Published Name` field of one of the entries:
![pnputil output with matching driver highlighted](/3RrSjzW.png)
![pnputil output with matching driver highlighted](https://i.imgur.com/3RrSjzW.png)
Run `pnputil /delete-driver oemXX.inf /uninstall`. This will delete the driver and remove it from any devices using it. Note that this will not uninstall the device itself.
-25
View File
@@ -221,31 +221,6 @@ Receive multiple bytes from the selected I2C device.
---
### `i2c_status_t i2c_transmit_and_receive(uint8_t address, const uint8_t* tx_data, uint16_t tx_length, uint8_t* rx_data, uint16_t rx_length, uint16_t timeout)` {#api-i2c-transmit-and-receive}
Send and receive multiple bytes from the selected I2C device.
#### Arguments {#api-i2c-transmit-and-receive-arguments}
- `uint8_t address`
The 7-bit I2C address of the device.
- `const uint8_t* tx_data`
A pointer to the data to transmit.
- `uint16_t tx_length`
The number of bytes to write. Take care not to overrun the length of `tx_data`.
- `uint8_t* rx_data`
A pointer to a buffer to read into.
- `uint16_t rx_length`
The number of bytes to read. Take care not to overrun the length of `data`.
- `uint16_t timeout`
The time in milliseconds to wait for a response from the target device.
#### Return Value {#api-i2c-transmit-and-receive-return}
`I2C_STATUS_TIMEOUT` if the timeout period elapses, `I2C_STATUS_ERROR` if some other error occurs, otherwise `I2C_STATUS_SUCCESS`.
---
### `i2c_status_t i2c_write_register(uint8_t devaddr, uint8_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register}
Write to a register with an 8-bit address on the I2C device.
+1 -1
View File
@@ -292,7 +292,7 @@ Set the color of a single LED. This function does not immediately update the LED
---
### `void ws2812_set_color_all(uint8_t red, uint8_t green, uint8_t blue)` {#api-ws2812-set-color-all}
### `void ws812_set_color_all(uint8_t red, uint8_t green, uint8_t blue)` {#api-ws2812-set-color-all}
Set the color of all LEDs.
+1 -1
View File
@@ -24,7 +24,7 @@ As its name implies Direct Pin works by connecting one switch per pin. The other
Here is a schematic showing how we connect a single button to pin A3 on a ProMicro:
![Schematic diagram showing a ProMicro with a wire coming out of A3, connecting to the left side of a switch. Another wire comes out of the right side of the switch to connect to the Ground Plane.](/JcDhZll.png)
![Schematic diagram showing a ProMicro with a wire coming out of A3, connecting to the left side of a switch. Another wire comes out of the right side of the switch to connect to the Ground Plane.](https://i.imgur.com/JcDhZll.png)
Once you have wired your switches you can assign keycodes to each pin and build a firmware by selecting the MCU you are using from the Keyboard dropdown. Use this link to show only Easy Maker Direct Pin:
+6 -3
View File
@@ -19,10 +19,13 @@ Note that running `make` with `sudo` is generally ***not*** a good idea, and you
### Linux `udev` Rules {#linux-udev-rules}
On Linux, you'll need proper privileges to communicate with the bootloader device. You can either use `sudo` when flashing firmware (not recommended), or install the udev rules from the [qmk_udev](https://github.com/qmk/qmk_udev) repository by running:
On Linux, you'll need proper privileges to communicate with the bootloader device. You can either use `sudo` when flashing firmware (not recommended), or place [this file](https://github.com/qmk/qmk_firmware/tree/master/util/udev/50-qmk.rules) into `/etc/udev/rules.d/`.
Once added, run the following:
```
util/install_udev.sh
sudo udevadm control --reload-rules
sudo udevadm trigger
```
**Note:** With older versions of ModemManager (< 1.12), filtering only works when not in strict mode. The following commands can update that setting:
@@ -41,7 +44,7 @@ Pro Micro (Atmega32u4), make sure to include `CONFIG_USB_ACM=y`. Other devices m
Issues encountered when flashing keyboards on Windows are most often due to having the wrong drivers installed for the bootloader, or none at all.
Re-running the QMK installation script (`curl -fsSL https://install.qmk.fm | sh`) or reinstalling the QMK Toolbox may fix the issue. Alternatively, you can download and run the [`qmk_driver_installer`](https://github.com/qmk/qmk_driver_installer) package manually.
Re-running the QMK installation script (`./util/qmk_install.sh` from the `qmk_firmware` directory in MSYS2 or WSL) or reinstalling the QMK Toolbox may fix the issue. Alternatively, you can download and run the [`qmk_driver_installer`](https://github.com/qmk/qmk_driver_installer) package manually.
If that doesn't work, then you may need to download and run Zadig. See [Bootloader Driver Installation with Zadig](driver_installation_zadig) for more detailed information.
+1 -1
View File
@@ -13,7 +13,7 @@ Keycodes are actually defined in [quantum/keycode.h](https://github.com/qmk/qmk_
There are 3 standard keyboard layouts in use around the world- ANSI, ISO, and JIS. North America primarily uses ANSI, Europe and Africa primarily use ISO, and Japan uses JIS. Regions not mentioned typically use either ANSI or ISO. The keycodes corresponding to these layouts are shown here:
<!-- Source for this image: https://www.keyboard-layout-editor.com/#/gists/bf431647d1001cff5eff20ae55621e9a -->
![Keyboard Layout Image](/5wsh5wM.png)
![Keyboard Layout Image](https://i.imgur.com/5wsh5wM.png)
## How Can I Make Custom Names For Complex Keycodes?
+100 -246
View File
@@ -2,22 +2,8 @@
This page documents the automated process for converting keyboards to use drop-in replacement controllers. This process is designed to be easy to use and can be completed in a few simple steps.
You can generate the firmware by appending `-e CONVERT_TO=<target>` to your compile/flash command. For example:
```sh
qmk flash -c -kb keebio/bdn9/rev1 -km default -e CONVERT_TO=proton_c
```
You can also configure this within your [keymap](#keymap) to accomplish the same thing.
::: tip
If you get build errors, you will need to convert the keyboard's code to be [compatible](#keyboard-req) with the converter feature, or provide additional [keymap](#keymap-add) configuration.
:::
## Supported Converters
Each converter category is broken down by its declared `pin compatibility`. This ensures that only valid combinations are attempted.
The following converters are available at this time:
| From | To |
@@ -42,56 +28,86 @@ The following converters are available at this time:
| `elite_c` | `helios` |
| `elite_c` | `liatris` |
## Configuration
Configuring a converter to use can be done by adding one of the following lines to your keymaps's configuration:
## Overview
:::::tabs
Each converter category is broken down by its declared `pin compatibility`. This ensures that only valid combinations are attempted. You can generate the firmware by appending `-e CONVERT_TO=<target>` to your compile/flash command. For example:
==== keymap.json
```json [keymap.json]
{
"version": 1,
"keyboard": "keebio/bdn9/rev1",
"keymap": "keebio_bdn9_rev1_layout_2025-05-20",
"converter": "proton_c", // [!code focus]
"layout": "LAYOUT",
}
```sh
qmk flash -c -kb keebio/bdn9/rev1 -km default -e CONVERT_TO=proton_c
```
==== rules.mk
```makefile
CONVERT_TO = proton_c
```
:::::
You can also add the same `CONVERT_TO=<target>` to your keymap's `rules.mk`, which will accomplish the same thing.
::: tip
If you get build errors, you will need to convert the keyboard's code to be [compatible](#keyboard-req) with the converter feature, or provide additional [keymap](#keymap-add) configuration.
If you get errors about `PORTB/DDRB`, etc not being defined, you'll need to convert the keyboard's code to use the [GPIO Controls](drivers/gpio) that will work for both ARM and AVR. This shouldn't affect the AVR builds at all.
:::
## Pro Micro Converters
### Conditional Configuration
If a board currently supported by QMK uses a [Pro Micro](https://www.sparkfun.com/products/12640) (or compatible board), the supported alternative controllers are:
Once a converter is enabled, it exposes the `CONVERT_TO_<target_uppercase>` flag that you can use in your code with `#ifdef`s, For example:
| Device | Target | CLI Argument | `rules.mk` | Condition |
|------------------------------------------------------------------------------------------|-------------------|---------------------------------|------------------------------|-------------------------------------|
| [Proton C](https://qmk.fm/proton-c/) | `proton_c` | `-e CONVERT_TO=proton_c` | `CONVERT_TO=proton_c` | `#ifdef CONVERT_TO_PROTON_C` |
| [Adafruit KB2040](https://learn.adafruit.com/adafruit-kb2040) | `kb2040` | `-e CONVERT_TO=kb2040` | `CONVERT_TO=kb2040` | `#ifdef CONVERT_TO_KB2040` |
| [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288) | `sparkfun_pm2040` | `-e CONVERT_TO=sparkfun_pm2040` | `CONVERT_TO=sparkfun_pm2040` | `#ifdef CONVERT_TO_SPARKFUN_PM2040` |
| [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622) | `blok` | `-e CONVERT_TO=blok` | `CONVERT_TO=blok` | `#ifdef CONVERT_TO_BLOK` |
| [Bit-C PRO](https://nullbits.co/bit-c-pro) | `bit_c_pro` | `-e CONVERT_TO=bit_c_pro` | `CONVERT_TO=bit_c_pro` | `#ifdef CONVERT_TO_BIT_C_PRO` |
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| [customMK Bonsai C4](https://shop.custommk.com/products/bonsai-c4-microcontroller-board) | `bonsai_c4` | `-e CONVERT_TO=bonsai_c4` | `CONVERT_TO=bonsai_c4` | `#ifdef CONVERT_TO_BONSAI_C4` |
| [RP2040 Community Edition](#rp2040_ce) | `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |
| [Liatris](https://splitkb.com/products/liatris) | `liatris` | `-e CONVERT_TO=liatris` | `CONVERT_TO=liatris` | `#ifdef CONVERT_TO_LIATRIS` |
| [Imera](https://splitkb.com/products/imera) | `imera` | `-e CONVERT_TO=imera` | `CONVERT_TO=imera` | `#ifdef CONVERT_TO_IMERA` |
| [Michi](https://github.com/ci-bus/michi-promicro-rp2040) | `michi` | `-e CONVERT_TO=michi` | `CONVERT_TO=michi` | `#ifdef CONVERT_TO_MICHI` |
| [Svlinky](https://github.com/sadekbaroudi/svlinky) | `svlinky` | `-e CONVERT_TO=svlinky` | `CONVERT_TO=svlinky` | `#ifdef CONVERT_TO_SVLINKY` |
```c
#ifdef CONVERT_TO_PROTON_C
// Proton C code
#else
// Pro Micro code
#endif
```
### Pin Compatibility
To ensure compatibility, provide validation, and enable future workflows, a keyboard should declare its `pin compatibility`. For legacy reasons, this is currently assumed to be `promicro`. The following pin compatibility interfaces are currently defined:
| Pin Compatibility | Notes |
|-------------------|-----------------------------------|
| `promicro` | Includes RX/TX LEDs |
| `elite_c` | Includes bottom row pins, no LEDs |
To declare the base for conversions, add this line to your keyboard's `rules.mk`:
```makefile
PIN_COMPATIBLE = elite_c
```
## Pro Micro
If a board currently supported in QMK uses a [Pro Micro](https://www.sparkfun.com/products/12640) (or compatible board), the supported alternative controllers are:
| Device | Target |
|------------------------------------------------------------------------------------------|-------------------|
| [Proton C](https://qmk.fm/proton-c/) | `proton_c` |
| [Adafruit KB2040](https://learn.adafruit.com/adafruit-kb2040) | `kb2040` |
| [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288) | `sparkfun_pm2040` |
| [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622) | `blok` |
| [Bit-C PRO](https://nullbits.co/bit-c-pro) | `bit_c_pro` |
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` |
| [customMK Bonsai C4](https://shop.custommk.com/products/bonsai-c4-microcontroller-board) | `bonsai_c4` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` |
| [Liatris](https://splitkb.com/products/liatris) | `liatris` |
| [Imera](https://splitkb.com/products/imera) | `imera` |
| [Michi](https://github.com/ci-bus/michi-promicro-rp2040) | `michi` |
| [Svlinky](https://github.com/sadekbaroudi/svlinky) | `svlinky` |
Converter summary:
| Target | Argument | `rules.mk` | Condition |
|-------------------|---------------------------------|------------------------------|-------------------------------------|
| `proton_c` | `-e CONVERT_TO=proton_c` | `CONVERT_TO=proton_c` | `#ifdef CONVERT_TO_PROTON_C` |
| `kb2040` | `-e CONVERT_TO=kb2040` | `CONVERT_TO=kb2040` | `#ifdef CONVERT_TO_KB2040` |
| `sparkfun_pm2040` | `-e CONVERT_TO=sparkfun_pm2040` | `CONVERT_TO=sparkfun_pm2040` | `#ifdef CONVERT_TO_SPARKFUN_PM2040` |
| `blok` | `-e CONVERT_TO=blok` | `CONVERT_TO=blok` | `#ifdef CONVERT_TO_BLOK` |
| `bit_c_pro` | `-e CONVERT_TO=bit_c_pro` | `CONVERT_TO=bit_c_pro` | `#ifdef CONVERT_TO_BIT_C_PRO` |
| `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| `bonsai_c4` | `-e CONVERT_TO=bonsai_c4` | `CONVERT_TO=bonsai_c4` | `#ifdef CONVERT_TO_BONSAI_C4` |
| `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |
| `liatris` | `-e CONVERT_TO=liatris` | `CONVERT_TO=liatris` | `#ifdef CONVERT_TO_LIATRIS` |
| `imera` | `-e CONVERT_TO=imera` | `CONVERT_TO=imera` | `#ifdef CONVERT_TO_IMERA` |
| `michi` | `-e CONVERT_TO=michi` | `CONVERT_TO=michi` | `#ifdef CONVERT_TO_MICHI` |
| `svlinky` | `-e CONVERT_TO=svlinky` | `CONVERT_TO=svlinky` | `#ifdef CONVERT_TO_SVLINKY` |
### Proton C {#proton_c}
@@ -103,26 +119,26 @@ The Proton C only has one on-board LED (C13), and by default, the TXLED (D5) is
The following defaults are based on what has been implemented for STM32 boards.
| Feature | Notes |
|--------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| [Audio](features/audio) | Enabled |
| [RGB Lighting](features/rgblight) | Disabled |
| Feature | Notes |
|----------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [Audio](features/audio) | Enabled |
| [RGB Lighting](features/rgblight) | Disabled |
| [Backlight](features/backlight) | Forces [task driven PWM](features/backlight#software-pwm-driver) until ARM can provide automatic configuration |
| USB Host (e.g. USB-USB converter) | Not supported (USB host code is AVR specific and is not currently supported on ARM) |
| [Split keyboards](features/split_keyboard) | Partial - heavily dependent on enabled features |
| USB Host (e.g. USB-USB converter) | Not supported (USB host code is AVR specific and is not currently supported on ARM) |
| [Split keyboards](features/split_keyboard) | Partial - heavily dependent on enabled features |
### Adafruit KB2040 {#kb2040}
The following defaults are based on what has been implemented for [RP2040](platformdev_rp2040) boards.
| Feature | Notes |
|--------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| [RGB Lighting](features/rgblight) | Enabled via `PIO` vendor driver |
| Feature | Notes |
|----------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [RGB Lighting](features/rgblight) | Enabled via `PIO` vendor driver |
| [Backlight](features/backlight) | Forces [task driven PWM](features/backlight#software-pwm-driver) until ARM can provide automatic configuration |
| USB Host (e.g. USB-USB converter) | Not supported (USB host code is AVR specific and is not currently supported on ARM) |
| [Split keyboards](features/split_keyboard) | Partial via `PIO` vendor driver - heavily dependent on enabled features |
| USB Host (e.g. USB-USB converter) | Not supported (USB host code is AVR specific and is not currently supported on ARM) |
| [Split keyboards](features/split_keyboard) | Partial via `PIO` vendor driver - heavily dependent on enabled features |
### SparkFun Pro Micro - RP2040, Blok, Bit-C PRO and Michi {#sparkfun_pm2040}
### SparkFun Pro Micro - RP2040, Blok, Bit-C PRO and Michi {#sparkfun_pm2040 }
Feature set is identical to [Adafruit KB2040](#kb2040).
@@ -161,193 +177,31 @@ Feature set is identical to [Adafruit KB2040](#kb2040). VBUS detection is enable
Feature set is a pro micro equivalent of the [RP2040 Community Edition](#rp2040_ce), except that two of the analog GPIO have been replaced with digital only GPIO. These two were moved to the FPC connector to support the [VIK specification](https://github.com/sadekbaroudi/vik). This means that if you are expecting analog support on all 4 pins as provided on a RP2040 Community Edition pinout, you will not have that. Please see the [Svlinky github page](https://github.com/sadekbaroudi/svlinky) for more details.
## Elite-C Converters
## Elite-C
If a board currently supported by QMK uses an [Elite-C](https://keeb.io/products/elite-c-low-profile-version-usb-c-pro-micro-replacement-atmega32u4), the supported alternative controllers are:
If a board currently supported in QMK uses an [Elite-C](https://keeb.io/products/elite-c-low-profile-version-usb-c-pro-micro-replacement-atmega32u4), the supported alternative controllers are:
| Device | Target | CLI Argument | `rules.mk` | Condition |
|----------------------------------------------------------------------------------|-------------|---------------------------|------------------------|-------------------------------|
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| [RP2040 Community Edition](#rp2040_ce_elite) | `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |
| [Liatris](https://splitkb.com/products/liatris) | `liatris` | `-e CONVERT_TO=liatris` | `CONVERT_TO=liatris` | `#ifdef CONVERT_TO_LIATRIS` |
| Device | Target |
|----------------------------------------------------------------------------------|-------------------|
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` |
| [Liatris](https://splitkb.com/products/liatris) | `liatris` |
### STeMCell {#stemcell_elite}
Converter summary:
| Target | Argument | `rules.mk` | Condition |
|-------------------|---------------------------------|------------------------------|-------------------------------------|
| `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |
| `liatris` | `-e CONVERT_TO=liatris` | `CONVERT_TO=liatris` | `#ifdef CONVERT_TO_LIATRIS` |
### STeMCell {#stemcell}_elite
Identical to [Pro Micro - STeMCell](#stemcell) with support for the additional bottom row of pins.
### RP2040 Community Edition {#rp2040_ce_elite}
Identical to [Pro Micro - RP2040 Community Edition](#rp2040_ce) with support for the additional bottom row of pins.
## Advanced Topics
### Keyboard Configuration
To configure a keyboard to allow the converter feature, add the following line to your keyboard's `.json` configuration:
```json [keyboard.json]
{
"maintainer": "QMK",
"development_board": "promicro", // [!code focus]
"diode_direction": "COL2ROW",
}
```
See the [pin compatibility](#pin_compatible) for more information.
#### Additional Requirements {#keyboard-req}
Keyboards must use the platform agnostic abstractions provided by QMK. This includes:
* Use of [GPIO Controls](drivers/gpio).
### Additional Keymap Configuration {#keymap-add}
While effort has been made to make converters as compatible as possible, sometimes additional platform specific configuration is required.
For example, enabling hardware peripherals by adding a keymap level `mcuconf.h` with something like the following:
```c
#pragma once
#include_next <mcuconf.h>
#undef RP_SIO_USE_UART0
#define RP_SIO_USE_UART0 TRUE
```
You can find details on how to configure drivers on their respective pages.
Alternatively, you may have to disable incompatible features. For example:
:::::tabs
==== keymap.json
```json [keymap.json]
{
"version": 1,
"keyboard": "keebio/bdn9/rev1",
"keymap": "keebio_bdn9_rev1_layout_2025-05-20",
"converter": "proton_c",
"config": { // [!code focus]
"features": { // [!code focus]
"audio": false // [!code focus]
}
}
"layout": "LAYOUT",
}
```
==== rules.mk
```makefile
AUDIO_ENABLE = no
```
:::::
### Conditional Configuration
Once a converter is enabled, it exposes the `CONVERT_TO_<target_uppercase>` flag that you can use in your code with `#ifdef`s, For example:
```c
#ifdef CONVERT_TO_PROTON_C
// Proton C code
#else
// Pro Micro code
#endif
```
### Pin Compatibility {#pin_compatible}
To ensure compatibility, provide validation, and power future workflows, a keyboard should declare its `pin compatibility`. This ensures that only valid combinations are attempted.
::: tip Note
This will already be configured for you if are using the `promicro` development board preset.
:::
To declare the base interface for conversions, add the following line to your keyboard's configuration:
```json [keyboard.json]
{
"maintainer": "QMK",
"development_board": "elite_c", // [!code focus]
"pin_compatible": "elite_c", // [!code focus]
"diode_direction": "COL2ROW",
}
```
The above example, configures a keyboard for a default of `elite_c` while allowing any of the `elite_c` converter targets.
The framework then allows mapping of pins from `<PIN_COMPATIBLE>` to converter `<target>`.
::: warning
Mapped pins should adhere strictly to the defined interface, any extras present on the hardware should be ignored.
:::
#### Available Pin Compatibility
:::::tabs
==== promicro
![promicro](/pin_compatible_promicro.svg)
<!-- ```svgbob
pins
.-------------. LEDs
| | _|_ _|_
D3 -+-O | \ /B0 \ /D5
D2 -+-O | -+- -+-
| | | |
| |
D1 -+-O O-+- F4
D0 -+-O O-+- F5
D4 -+-O O-+- F6
C6 -+-O O-+- F7
D7 -+-O O-+- B1
E6 -+-O O-+- B3
B4 -+-O O-+- B2
B5 -+-O O-+- B6
| |
'---+-+-+-+-+---'
``` -->
::: info Notes:
Includes LEDs - these may be mapped to unused/unavailable pins when not present.
:::
==== elite_c
![elite_c](/pin_compatible_elite_c.svg)
<!-- ```svgbob
pins
.-------------.
| |
D3 -+-O |
D2 -+-O |
| |
| |
D1 -+-O O-+- F4
D0 -+-O O-+- F5
D4 -+-O O-+- F6
C6 -+-O O-+- F7
D7 -+-O O-+- B1
E6 -+-O O-+- B3
B4 -+-O O-+- B2
B5 -+-O O O O O O O-+- B6
| | | | | | |
'---+-+-+-+-+---'
+ + + + +
B D C F F
7 5 7 1 0
``` -->
::: info Notes:
Includes bottom row pins, no LEDs.
:::
:::::
+7 -115
View File
@@ -1,20 +1,14 @@
# Persistent Configuration (EEPROM)
This allows you to configure persistent settings for your keyboard. These settings are stored in the EEPROM of your controller, and are retained even after power loss.
Keep in mind that EEPROM has a limited number of writes. While this is very high, it's not the only thing writing to the EEPROM, and if you write too often, you can potentially drastically shorten the life of your MCU.
::: tip
If you don't understand the examples, then you may want to avoid using this feature, as it is rather complicated.
:::
## Basic
The settings can be read with `eeconfig_read_kb` and `eeconfig_read_user`, and can be written to using `eeconfig_update_kb` and `eeconfig_update_user`. This is useful for features that you want to be able to toggle (like toggling rgb layer indication). Additionally, you can use `eeconfig_init_kb` and `eeconfig_init_user` to set the default values for the EEPROM.
This allows you to configure persistent settings for your keyboard. These settings are stored in the EEPROM of your controller, and are retained even after power loss. The settings can be read with `eeconfig_read_kb` and `eeconfig_read_user`, and can be written to using `eeconfig_update_kb` and `eeconfig_update_user`. This is useful for features that you want to be able to toggle (like toggling rgb layer indication). Additionally, you can use `eeconfig_init_kb` and `eeconfig_init_user` to set the default values for the EEPROM.
The complicated part here, is that there are a bunch of ways that you can store and access data via EEPROM, and there is no "correct" way to do this. However, you only have a DWORD (4 bytes) for each function.
### Example Implementation
Keep in mind that EEPROM has a limited number of writes. While this is very high, it's not the only thing writing to the EEPROM, and if you write too often, you can potentially drastically shorten the life of your MCU.
* If you don't understand the example, then you may want to avoid using this feature, as it is rather complicated.
## Example Implementation
This is an example of how to add settings, and read and write it. We're using the user keymap for the example here. This is a complex function, and has a lot going on. In fact, it uses a lot of the above functions to work!
@@ -132,111 +126,9 @@ void eeconfig_init_user(void) { // EEPROM is getting reset!
And you're done. The RGB layer indication will only work if you want it to. And it will be saved, even after unplugging the board. And if you use any of the RGB codes, it will disable the layer indication, so that it stays on the mode and color that you set it to.
### Basic API
## 'EECONFIG' Function Documentation
* Keyboard/Revision: `void eeconfig_init_kb(void)`, `uint32_t eeconfig_read_kb(void)` and `void eeconfig_update_kb(uint32_t val)`
* Keymap: `void eeconfig_init_user(void)`, `uint32_t eeconfig_read_user(void)` and `void eeconfig_update_user(uint32_t val)`
The `val` is the value of the data that you want to write to EEPROM. And the `eeconfig_read_*` function return a 32 bit (DWORD) value from the EEPROM.
## Datablock {#datablock}
An extended form exists that allows larger blocks of data to be allocated.
::: info
When using datablock, the [basic API](#eeconfig-function-documentation) is unavailable.
:::
:::::tabs
==== keyboard
In `config.h`, define the size required, and optionally a version number:
| Define | Default | Description |
|------------------------------|---------------------------|------------------------------------------------------------------|
| `EECONFIG_KB_DATA_SIZE` | `0` | Size in bytes for the persistent block of data |
| `EECONFIG_KB_DATA_VERSION` | `EECONFIG_KB_DATA_SIZE` | Version number that can be incremented to invalidate stored data |
Which exposes the following API:
```c
bool eeconfig_is_kb_datablock_valid(void);
uint32_t eeconfig_read_kb_datablock(void *data, uint32_t offset, uint32_t length) __attribute__((nonnull));
uint32_t eeconfig_update_kb_datablock(const void *data, uint32_t offset, uint32_t length) __attribute__((nonnull));
void eeconfig_init_kb_datablock(void);
# define eeconfig_read_kb_datablock_field(__object, __field) eeconfig_read_kb_datablock(&(__object.__field), offsetof(typeof(__object), __field), sizeof(__object.__field))
# define eeconfig_update_kb_datablock_field(__object, __field) eeconfig_update_kb_datablock(&(__object.__field), offsetof(typeof(__object), __field), sizeof(__object.__field))
```
==== keymap
In `config.h`, define the size required, and optionally a version number:
| Define | Default | Description |
|------------------------------|---------------------------|------------------------------------------------------------------|
| `EECONFIG_USER_DATA_SIZE` | `0` | Size in bytes for the persistent block of data |
| `EECONFIG_USER_DATA_VERSION` | `EECONFIG_USER_DATA_SIZE` | Version number that can be incremented to invalidate stored data |
Which exposes the following API:
```c
bool eeconfig_is_user_datablock_valid(void);
uint32_t eeconfig_read_user_datablock(void *data, uint32_t offset, uint32_t length) __attribute__((nonnull));
uint32_t eeconfig_update_user_datablock(const void *data, uint32_t offset, uint32_t length) __attribute__((nonnull));
void eeconfig_init_user_datablock(void);
# define eeconfig_read_user_datablock_field(__object, __field) eeconfig_read_user_datablock(&(__object.__field), offsetof(typeof(__object), __field), sizeof(__object.__field))
# define eeconfig_update_user_datablock_field(__object, __field) eeconfig_update_user_datablock(&(__object.__field), offsetof(typeof(__object), __field), sizeof(__object.__field))
```
:::::
### Example
This is an example of how to add settings, and read and write it. We're using the user keymap for the example here.
In your `config.h` add:
```c
#define EECONFIG_USER_DATA_SIZE 8
```
In your keymap.c file, add:
```c
#include "debug.h"
#include "timer.h"
#include "eeconfig.h"
typedef struct my_config_t {
uint64_t data;
} my_config_t;
static my_config_t config;
void keyboard_post_init_user(void) {
if (!eeconfig_is_user_datablock_valid()) {
eeconfig_init_user_datablock();
}
eeconfig_read_user_datablock(&config, 0, sizeof(my_config_t));
}
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
if (!record->event.pressed) {
config.data += 1;
eeconfig_update_user_datablock(&config, 0, sizeof(my_config_t));
}
return true;
}
void housekeeping_task_user(void) {
static uint32_t last_sync = 0;
if (timer_elapsed32(last_sync) > 1000) {
last_sync = timer_read32();
dprintf("Config: %ld\n", config.data);
}
}
```
+1 -1
View File
@@ -51,7 +51,7 @@ Sometimes you need more than one base layer. For example, if you want to switch
### Advanced Users {#advanced-users}
Once you have a good feel for how layers work and what you can do, you can get more creative. The rules listed in the beginner section will help you be successful by avoiding some of the trickier details but they can be constraining, especially for ultra-compact keyboard users. Understanding how layers work will allow you to use them in more advanced ways.
Once you have a good feel for how layers work and what you can do, you can get more creative. The rules listed in the beginner section will help you be successful by avoiding some of the tricker details but they can be constraining, especially for ultra-compact keyboard users. Understanding how layers work will allow you to use them in more advanced ways.
Layers stack on top of each other in numerical order. When determining what a keypress does, QMK scans the layers from the top down, stopping when it reaches the first active layer that is not set to `KC_TRNS`. As a result if you activate a layer that is numerically lower than your current layer, and your current layer (or another layer that is active and higher than your target layer) has something other than `KC_TRNS`, that is the key that will be sent, not the key on the layer you just activated. This is the cause of most people's "why doesn't my layer get switched" problem.
+2 -2
View File
@@ -8,7 +8,7 @@ The feature maintains a small buffer of recent key presses. On each key press, i
The tricky part is how to efficiently check the buffer for typos. We dont want to spend too much memory or time on storing or searching the typos. A good solution is to represent the typos with a trie data structure. A trie is a tree data structure where each node is a letter, and words are formed by following a path to one of the leaves.
![An example trie](/HL5DP8H.png)
![An example trie](https://i.imgur.com/HL5DP8H.png)
Since we search whether the buffer ends in a typo, we store the trie writing in reverse. The trie is queried starting from the last letter, then second to last letter, and so on, until either a letter doesnt match or we reach a leaf, meaning a typo was found.
@@ -279,7 +279,7 @@ All autocorrection data is stored in a single flat array autocorrect_data. Each
* 01 ⇒ branching node: a trie node with multiple children.
* 10 ⇒ leaf node: a leaf, corresponding to a typo and storing its correction.
![An example trie](/HL5DP8H.png)
![An example trie](https://i.imgur.com/HL5DP8H.png)
**Branching node**. Each branch is encoded with one byte for the keycode (KC_AKC_Z) followed by a link to the child node. Links between nodes are 16-bit byte offsets relative to the beginning of the array, serialized in little endian order.
+1 -1
View File
@@ -227,7 +227,7 @@ In this typical example, the backlight LEDs are all connected in parallel toward
A pulldown resistor is also placed between the gate pin and ground to keep it at a defined state when it is not otherwise being driven by the MCU.
The values of these resistors are not critical - see [this Electronics StackExchange question](https://electronics.stackexchange.com/q/68748) for more information.
![Backlight example circuit](/BmAvoUC.png)
![Backlight example circuit](https://i.imgur.com/BmAvoUC.png)
## API {#api}
+15 -39
View File
@@ -95,10 +95,6 @@ The use of `features` matches the definition normally provided within `keyboard.
The `keycodes` array allows a module to provide new keycodes (as well as corresponding aliases) to a keymap.
### `config.h`
This file will be automatically added to the build as if it were present in the keyboard or keymap.
### `rules.mk` / `post_rules.mk`
These two files follows standard QMK build system logic, allowing for `Makefile`-style customisation as if it were present in the keyboard or keymap.
@@ -135,45 +131,24 @@ This file defines LED matrix effects in the same form as used with `led_matrix_k
This file defines RGB matrix effects in the same form as used with `rgb_matrix_kb.inc` and `rgb_matrix_user.inc` (see [Custom RGB Matrix Effects](rgb_matrix#custom-rgb-matrix-effects)). Effect mode names are prepended with `RGB_MATRIX_COMMUNITY_MODULE_`.
### Additional Customization
#### Split Keyboard Data Sync
Defines follow the convention, `SPLIT_TRANSACTION_IDS_MODULE_<MODULE>` (see [Custom data sync](split_keyboard#custom-data-sync)).
#### Persistent Configuration
Defines follow the convention, `EECONFIG_MODULE_<MODULE>_DATA_SIZE` and `EECONFIG_MODULE_<MODULE>_DATA_VERSION` (see [Custom Persistent Configuration](../feature_eeprom#datablock)).
When configured, the following APIs are available:
| API Format | Example (`hello_world` module) | API Version |
|--------------------------------------------|-----------------------------------------------|-------------|
| `eeconfig_is_<module>_datablock_valid` | `eeconfig_is_hello_world_datablock_valid` | `1.1.3` |
| `eeconfig_read_<module>_datablock` | `eeconfig_read_hello_world_datablock` | `1.1.3` |
| `eeconfig_update_<module>_datablock` | `eeconfig_update_hello_world_datablock` | `1.1.3` |
| `eeconfig_init_<module>_datablock` | `eeconfig_init_hello_world_datablock` | `1.1.3` |
| `eeconfig_read_<module>_datablock_field` | `eeconfig_read_hello_world_datablock_field` | `1.1.3` |
| `eeconfig_update_<module>_datablock_field` | `eeconfig_update_hello_world_datablock_field` | `1.1.3` |
### Compatible APIs
Community Modules may provide specializations for the following APIs:
| Base API | API Format | Example (`hello_world` module) | API Version |
|----------------------------------|-------------------------------------------|----------------------------------------------|-------------|
| `keyboard_pre_init` | `keyboard_pre_init_<module>` | `keyboard_pre_init_hello_world` | `0.1.0` |
| `keyboard_post_init` | `keyboard_post_init_<module>` | `keyboard_post_init_hello_world` | `0.1.0` |
| `pre_process_record` | `pre_process_record_<module>` | `pre_process_record_hello_world` | `0.1.0` |
| `process_record` | `process_record_<module>` | `process_record_hello_world` | `0.1.0` |
| `post_process_record` | `post_process_record_<module>` | `post_process_record_hello_world` | `0.1.0` |
| `housekeeping_task` | `housekeeping_task_<module>` | `housekeeping_task_hello_world` | `1.0.0` |
| `suspend_power_down` | `suspend_power_down_<module>` | `suspend_power_down_hello_world` | `1.0.0` |
| `suspend_wakeup_init` | `suspend_wakeup_init_<module>` | `suspend_wakeup_init_hello_world` | `1.0.0` |
| `shutdown` | `shutdown_<module>` | `shutdown_hello_world` | `1.0.0` |
| `process_detected_host_os` | `process_detected_host_os_<module>` | `process_detected_host_os_hello_world` | `1.0.0` |
| `default_layer_state_set` | `default_layer_state_set_<module>` | `default_layer_state_set_hello_world` | `1.1.0` |
| `layer_state_set` | `layer_state_set_<module>` | `layer_state_set_hello_world` | `1.1.0` |
| Base API | API Format | Example (`hello_world` module) | API Version |
|----------------------------------|-------------------------------------------|---------------------------------------------|-------------|
| `keyboard_pre_init` | `keyboard_pre_init_<module>` | `keyboard_pre_init_hello_world` | `0.1.0` |
| `keyboard_post_init` | `keyboard_post_init_<module>` | `keyboard_post_init_hello_world` | `0.1.0` |
| `pre_process_record` | `pre_process_record_<module>` | `pre_process_record_hello_world` | `0.1.0` |
| `process_record` | `process_record_<module>` | `process_record_hello_world` | `0.1.0` |
| `post_process_record` | `post_process_record_<module>` | `post_process_record_hello_world` | `0.1.0` |
| `housekeeping_task` | `housekeeping_task_<module>` | `housekeeping_task_hello_world` | `1.0.0` |
| `suspend_power_down` | `suspend_power_down_<module>` | `suspend_power_down_hello_world` | `1.0.0` |
| `suspend_wakeup_init` | `suspend_wakeup_init_<module>` | `suspend_wakeup_init_hello_world` | `1.0.0` |
| `shutdown` | `shutdown_<module>` | `shutdown_hello_world` | `1.0.0` |
| `process_detected_host_os` | `process_detected_host_os_<module>` | `process_detected_host_os_hello_world` | `1.0.0` |
| `default_layer_state_set` | `default_layer_state_set_<module>` | `default_layer_state_set_hello_world` | `1.1.0` |
| `layer_state_set` | `layer_state_set_<module>` | `layer_state_set_hello_world` | `1.1.0` |
| `led_matrix_indicators` | `led_matrix_indicators_<module>` | `led_matrix_indicators_hello_world` | `1.1.0` |
| `led_matrix_indicators_advanced` | `led_matrix_indicators_advanced_<module>` | `led_matrix_indicators_advanced_hello_world` | `1.1.0` |
| `rgb_matrix_indicators` | `rgb_matrix_indicators_<module>` | `rgb_matrix_indicators_hello_world` | `1.1.0` |
@@ -181,6 +156,7 @@ Community Modules may provide specializations for the following APIs:
| `pointing_device_init` | `pointing_device_init_<module>` | `pointing_device_init_hello_world` | `1.1.0` |
| `pointing_device_task` | `pointing_device_task_<module>` | `pointing_device_task_hello_world` | `1.1.0` |
::: info
An unspecified API is disregarded if a Community Module does not provide a specialization for it.
:::
+6 -7
View File
@@ -32,13 +32,12 @@ For the details about the internals of the dynamic macros, please read the comme
There are a number of options added that should allow some additional degree of customization
|Define |Default |Description |
|------------------------------------------|----------------|-----------------------------------------------------------------------------------------------------------------|
|`DYNAMIC_MACRO_SIZE` |128 |Sets the amount of memory that Dynamic Macros can use. This is a limited resource, dependent on the controller. |
|`DYNAMIC_MACRO_USER_CALL` |*Not defined* |Defining this falls back to using the user `keymap.c` file to trigger the macro behavior. |
|`DYNAMIC_MACRO_NO_NESTING` |*Not Defined* |Defining this disables the ability to call a macro from another macro (nested macros). |
|`DYNAMIC_MACRO_DELAY` |*Not Defined* |Sets the waiting time (ms unit) when sending each key. |
|`DYNAMIC_MACRO_KEEP_ORIGINAL_LAYER_STATE` |*Not Defined* |Defining this keeps the layer state when starting to record a macro |
|Define |Default |Description |
|----------------------------|----------------|-----------------------------------------------------------------------------------------------------------------|
|`DYNAMIC_MACRO_SIZE` |128 |Sets the amount of memory that Dynamic Macros can use. This is a limited resource, dependent on the controller. |
|`DYNAMIC_MACRO_USER_CALL` |*Not defined* |Defining this falls back to using the user `keymap.c` file to trigger the macro behavior. |
|`DYNAMIC_MACRO_NO_NESTING` |*Not Defined* |Defining this disables the ability to call a macro from another macro (nested macros). |
|`DYNAMIC_MACRO_DELAY` |*Not Defined* |Sets the waiting time (ms unit) when sending each key. |
If the LEDs start blinking during the recording with each keypress, it means there is no more space for the macro in the macro buffer. To fit the macro in, either make the other macro shorter (they share the same buffer) or increase the buffer size by adding the `DYNAMIC_MACRO_SIZE` define in your `config.h` (default value: 128; please read the comments for it in the header).
+1 -12
View File
@@ -14,7 +14,7 @@ You can use key overrides in a similar way to momentary layer/fn keys to activat
To enable this feature, you need to add `KEY_OVERRIDE_ENABLE = yes` to your `rules.mk`.
Then, in your `keymap.c` file, you'll need to define the `key_overrides` config. See below for more details.
Then, in your `keymap.c` file, you'll need to define the array `key_overrides`, which defines all key overrides to be used. Each override is a value of type `key_override_t`. The array `key_overrides`contains pointers to `key_override_t` values (`const key_override_t **`).
## Creating Key Overrides {#creating-key-overrides}
@@ -47,17 +47,6 @@ const key_override_t *key_overrides[] = {
};
```
This second example inverts or swaps semicolon and colon on ANSI and many other layouts. That means pressing the key alone sends `shift` + `semicolon` giving `colon` (`S(KP_SCLN)` aka `KC_COLN`), but when pressing the key with shift, the shift modifier is suppressed (see `suppressed_mods` below), sending only `semicolon` (`KC_SCLN`):
```c
const key_override_t semicolon_colon_key_override = ko_make_basic(MOD_MASK_SHIFT, KC_COLN, KC_SCLN);
// This globally defines all key overrides to be used
const key_override_t *key_overrides[] = {
&semicolon_colon_key_override
};
```
## Intermediate Difficulty Examples {#intermediate-difficulty-examples}
### Media Controls & Screen Brightness {#media-controls-amp-screen-brightness}
+2 -2
View File
@@ -35,12 +35,12 @@ layer.
Consider a keymap with the following base layer.
![Base layer with a MO(NAV) key.](/DkEhj9x.png)
![Base layer with a MO(NAV) key.](https://i.imgur.com/DkEhj9x.png)
The highlighted key is a momentary layer switch `MO(NAV)`. Holding it accesses a
navigation layer.
![Nav layer with a Layer Lock key.](/2wUZNWk.png)
![Nav layer with a Layer Lock key.](https://i.imgur.com/2wUZNWk.png)
Holding the NAV key is fine for brief use, but awkward to continue holding when
-1
View File
@@ -77,7 +77,6 @@ Tips:
* For smoother cursor movements, lower the value of `MOUSEKEY_INTERVAL`. If the refresh rate of your display is 60Hz, you could set it to `16` (1/60). As this raises the cursor speed significantly, you may want to lower `MOUSEKEY_MAX_SPEED`.
* Setting `MOUSEKEY_TIME_TO_MAX` or `MOUSEKEY_WHEEL_TIME_TO_MAX` to `0` will disable acceleration for the cursor or scrolling respectively. This way you can make one of them constant while keeping the other accelerated, which is not possible in constant speed mode.
* Setting `MOUSEKEY_WHEEL_INTERVAL` too low will make scrolling too fast. Setting it too high will make scrolling too slow when the wheel key is held down.
* `MS_ACL0`, `MS_ACL1` and `MS_ACL2` change the cursor and scroll speed to 1/4, 1/2, and the maximum speed, respectively.
Cursor acceleration uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).
+1 -8
View File
@@ -136,19 +136,12 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
print_stored_setups();
}
return false;
default:
return true; // Process all other keycodes normally
}
}
```
Add both `STORE_SETUPS` and `PRINT_SETUPS` to your keyboard's keymap. Connect the keyboard to the device where the OS was not recognised, and press the `STORE_SETUPS` key to capture and store the fingerprint. On your development computer, run one of the suggested [console debugging tools](/faq_debug#debugging-tools), connect the keyboard, and press the `PRINT_SETUPS` key. The console should display multiple lines of data from the most recent `STORE_SETUPS` run.
Then please open an issue on Github with this information and tell what OS was not detected correctly and if you have any intermediate devices between keyboard and your computer.
Open an issue on GitHub and paste the console output into the issue. Also tell us which OS (including the version, if possible) was not detected correctly and whether any intermediate devices, such as a USB hub, were used between the keyboard and the target device.
::: tip
If `STORE_SETUPS` has not been used previously, `PRINT_SETUPS` will report whatever values are already present in the controller's EEPROM. These may appear as random numbers.
:::
## Credits
-34
View File
@@ -267,23 +267,6 @@ The paw 3204 sensor uses a serial type protocol for communication, and requires
The CPI range is 400-1600, with supported values of (400, 500, 600, 800, 1000, 1200 and 1600). Defaults to 1000 CPI.
### PAW-3222 Sensor
To use the PAW-3222 sensor, add this to your `rules.mk`:
```make
POINTING_DEVICE_DRIVER = paw3222
```
The following pins must be defined in `config.h`:
| Setting (`config.h`) | Description | Default |
| --------------------- | ------------------------------------------------------------------ | ---------------------------- |
| `PAW3222_CS_PIN` | (Required) The pin connected to the chip select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |
| `PAW3222_SPI_DIVISOR` | (Required) The SPI clock divisor. This is dependent on your MCU. | _not defined_ |
The CPI range is up to 4,000. Defaults to 1,000 CPI.
### Pimoroni Trackball
To use the Pimoroni Trackball module, add this to your `rules.mk`:
@@ -320,23 +303,6 @@ The PMW3320 sensor uses a serial type protocol for communication, and requires a
The CPI range is 500-3500, in increments of 250. Defaults to 1000 CPI.
### PMW-3325 Sensor
To use the PMW-3325 sensor, add this to your `rules.mk`:
```make
POINTING_DEVICE_DRIVER = pmw3325
```
The following pins must be defined in `config.h`:
| Setting (`config.h`) | Description | Default |
| --------------------- | ------------------------------------------------------------------ | ---------------------------- |
| `PMW3325_CS_PIN` | (Required) The pin connected to the chip select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |
| `PMW3325_SPI_DIVISOR` | (Required) The SPI clock divisor. This is dependent on your MCU. | _not defined_ |
The CPI range is 100-5000, in increments of 100. Defaults to 2000 CPI.
### PMW 3360 and PMW 3389 Sensor
This drivers supports both the PMW 3360 and PMW 3389 sensor as well as multiple sensors of the same type _per_ controller, so 2 can be attached at the same side for split keyboards (or unsplit keyboards).
+1 -1
View File
@@ -166,7 +166,7 @@ In your keyboard config.h:
The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU.
The GPIOs used for clock and data must be consecutive (in either order).
There are strict requirements for pin ordering but any pair of GPIO pins can be used. The GPIO used for clock must be directly after data, see the included info.json snippet for an example of correct order.
You may optionally switch the PIO peripheral used with the following define in config.h:
```c
+1 -1
View File
@@ -55,7 +55,7 @@ Changing the **Hue** cycles around the circle.<br>
Changing the **Saturation** moves between the inner and outer sections of the wheel, affecting the intensity of the color.<br>
Changing the **Value** sets the overall brightness.<br>
![QMK Color Wheel with HSV Values](/vkYVo66.jpg)
![QMK Color Wheel with HSV Values](https://i.imgur.com/vkYVo66.jpg)
## Keycodes
+3 -3
View File
@@ -91,11 +91,11 @@ SPLIT_TRANSPORT = custom
Configuring your layout in a split keyboard works slightly differently to a non-split keyboard. Take for example the following layout. The top left numbers refer to the matrix row and column, and the bottom right are the order of the keys in the layout:
![Physical layout](/QeY6kMQ.png)
![Physical layout](https://i.imgur.com/QeY6kMQ.png)
Since the matrix scanning procedure operates on entire rows, it first populates the left half's rows, then the right half's. Thus, the matrix as QMK views it has double the rows instead of double the columns:
![Matrix](/4wjJzBU.png)
![Matrix](https://i.imgur.com/4wjJzBU.png)
### Setting Handedness
@@ -497,7 +497,7 @@ Once you have done that, you will want to solder the diode from the 5V pad to th
You may need to use the 5V pad from the regulator block above as the pads were too small and placed too closely together to place the Schottky diode properly.
![Teensy++ 2.0](/BPEC5n5.jpg)
![Teensy++ 2.0](https://i.imgur.com/BPEC5n5.png)
## Additional Resources
+1 -18
View File
@@ -6,12 +6,11 @@ The [Open Steno Project](https://www.openstenoproject.org/) has built an open-so
## Steno Support in QMK
There are four ways that QMK keyboards can support steno, with varying degrees of configuration required:
There are three ways that QMK keyboards can support steno, with varying degrees of configuration required:
1. Plover with [Arpeggiation](https://plover.wiki/index.php/Glossary#Arpeggiate) requires no changes to any keyboard and is supported by QMK as well as any other QWERTY keyboard.
2. Plover with [NKRO](https://plover.wiki/index.php/Using_a_standard_keyboard_with_Plover#NKRO). If your keyboard supports NKRO in hardware and you have NKRO enabled as a USB endpoint, you can chord with the keyboard. Many devices will arrive stock like this and will require no changes.
3. Steno Machine Protocols. This requires the most configuration, but this has the advantage of allowing you to use your keyboard keys normally (either on another layer or another piece of hardware) without enabling and disabling your steno software.
4. Plover HID Protocol. This is a custom HID protocol that Plover can understand, but does not require a COM port. It is robust to device disconnects and saves an interface over the COM-based alternatives.
## Plover with QWERTY Keyboard {#plover-with-qwerty-keyboard}
@@ -93,22 +92,6 @@ Examples of steno strokes and the associated packet:
- `WAZ` = `10000000 00000010 00100000 00000000 00000000 00000001`
- `PHAPBGS` = `10000000 00000101 00100000 00000000 01101010 00000000`
## Plover HID Protocol {#plover-hid-protocol}
This mode operates independently of the other Steno "official" machine protocols. Like any other mouse or keyboard, it uses the USB HID protocol to communicate with Plover by sending an 8 byte (64 bit) packet representing a bitfield for all the possible keys on a steno machine plus a number of additional general purpose keys for custom use. This protocol is only understood by Plover as of [5.1.0](https://github.com/opensteno/plover/releases/tag/v5.1.0).
Add
```make
PLOVER_HID_ENABLE = yes
```
to your `rules.mk` file. This does **not** require `STENO_ENABLE` to be set.
All of the possible keycodes are defined with the `PLV_` prefix and are available without any additional includes.
More details can be found here: https://github.com/dnaq/plover-machine-hid
### Switching protocols on the fly {#switching-protocols-on-the-fly}
If you wish to switch the serial protocol used to transfer the steno chords without having to recompile your keyboard firmware every time, you can press the `QK_STENO_BOLT` and `QK_STENO_GEMINI` keycodes in order to switch protocols on the fly.
+3 -9
View File
@@ -40,10 +40,6 @@ Similar to the first option, the second and third option are good for simple lay
For more complicated cases, like blink the LEDs, fiddle with the backlighting, and so on, use the fourth or fifth option. Examples of each are listed below.
::: tip
If too many tap dances are active at the same time, later ones won't have any effect. You need to increase `TAP_DANCE_MAX_SIMULTANEOUS` by adding `#define TAP_DANCE_MAX_SIMULTANEOUS 5` (or higher) to your keymap's `config.h` file if you expect that users may hold down many tap dance keys simultaneously. By default, only 3 tap dance keys can be used together at the same time.
:::
## Implementation Details {#implementation}
Well, that's the bulk of it! You should now be able to work through the examples below, and to develop your own Tap Dance functionality. But if you want a deeper understanding of what's going on behind the scenes, then read on for the explanation of how it all works!
@@ -213,13 +209,11 @@ tap_dance_action_t tap_dance_actions[] = {
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
tap_dance_action_t *action;
tap_dance_state_t* state;
switch (keycode) {
case TD(CT_CLN):
action = tap_dance_get(QK_TAP_DANCE_GET_INDEX(keycode));
state = tap_dance_get_state(QK_TAP_DANCE_GET_INDEX(keycode));
if (!record->event.pressed && state != NULL && state->count && !state->finished) {
case TD(CT_CLN): // list all tap dance keycodes with tap-hold configurations
action = &tap_dance_actions[QK_TAP_DANCE_GET_INDEX(keycode)];
if (!record->event.pressed && action->state.count && !action->state.finished) {
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;
tap_code16(tap_hold->tap);
}
+5 -8
View File
@@ -8,9 +8,9 @@ There are some limitations to this feature. Because there is no "standard" metho
## Usage {#usage}
The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See [below](#input-subsystems) for more details.
The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See below for more details.
To start, add the following to your keymap's `rules.mk`:
Add the following to your keymap's `rules.mk`:
```make
UNICODE_COMMON = yes
@@ -18,25 +18,22 @@ UNICODE_COMMON = yes
## Basic Configuration {#basic-configuration}
The following options can be set or overridden in your `config.h`:
Add the following to your `config.h`:
|Define |Default |Description |
|------------------------|------------------|--------------------------------------------------------------------------------|
|`UNICODE_KEY_MAC` |`KC_LEFT_ALT` |The key to hold when beginning a Unicode sequence with the macOS input mode |
|`UNICODE_KEY_LNX` |`LCTL(LSFT(KC_U))`|The key to tap when beginning a Unicode sequence with the Linux input mode |
|`UNICODE_KEY_WINC` |`KC_RIGHT_ALT` |The key to hold when beginning a Unicode sequence with the WinCompose input mode|
|`UNICODE_SELECTED_MODES`|*n/a* |A comma separated list of input modes for cycling through |
|`UNICODE_SELECTED_MODES`|`-1` |A comma separated list of input modes for cycling through |
|`UNICODE_CYCLE_PERSIST` |`true` |Whether to persist the current Unicode input mode to EEPROM |
|`UNICODE_TYPE_DELAY` |`10` |The amount of time to wait, in milliseconds, between Unicode sequence keystrokes|
The default values work well for most use cases, so users usually only need to define `UNICODE_SELECTED_MODES` to set their desired input modes.
However, if you plan on switching input modes manually (see [keycodes](#keycodes) below) and don't plan on cycling through them, this definition can be omitted.
### Audio Feedback {#audio-feedback}
If you have the [Audio](audio) feature enabled on your board, you can configure it to play sounds when the input mode is changed.
Add one or more of the following definitions to your `config.h`:
Add the following to your `config.h`:
|Define |Default|Description |
|-------------------|-------|-----------------------------------------------------------|
+2 -2
View File
@@ -217,8 +217,8 @@ To generate this bootloader, use the `bootloader` target, eg. `make planck/rev4:
Compatible flashers:
* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI)
* [hid_bootloader_cli](https://github.com/qmk/lufa/tree/master/Bootloaders/HID/HostLoaderApp) / `:qmk-hid` target in QMK (recommended command line)
* TBD
* Currently, you need to either use the [Python script](https://github.com/qmk/lufa/tree/master/Bootloaders/HID/HostLoaderApp_python), or compile [`hid_bootloader_cli`](https://github.com/qmk/lufa/tree/master/Bootloaders/HID/HostLoaderApp), from the LUFA repo. Homebrew may (will) have support for this directly (via `brew install qmk/qmk/hid_bootloader_cli`).
Flashing sequence:
+5 -5
View File
@@ -8,15 +8,15 @@ This guide assumes you're somewhat comfortable with running things at the comman
Start on the [QMK GitHub page](https://github.com/qmk/qmk_firmware), and you'll see a button in the upper right that says "Fork":
![Fork on GitHub](/8Toomz4.jpg)
![Fork on GitHub](https://i.imgur.com/8Toomz4.jpg)
If you're a part of an organization, you'll need to choose which account to fork it to. In most circumstances, you'll want to fork it to your personal account. Once your fork is completed (sometimes this takes a little while), click the "Clone or Download" button:
![Download from GitHub](/N1NYcSz.jpg)
![Download from GitHub](https://i.imgur.com/N1NYcSz.jpg)
And be sure to select "HTTPS", and select the link and copy it:
![HTTPS link](/eGO0ohO.jpg)
![HTTPS link](https://i.imgur.com/eGO0ohO.jpg)
From here, enter `git clone --recurse-submodules ` into the command line, and then paste your link:
@@ -57,10 +57,10 @@ To https://github.com/whoeveryouare/qmk_firmware.git
Your changes now exist on your fork on GitHub - if you go back there (`https://github.com/<whoeveryouare>/qmk_firmware`), you can create a "New Pull Request" by clicking this button:
![New Pull Request](/DxMHpJ8.jpg)
![New Pull Request](https://i.imgur.com/DxMHpJ8.jpg)
Here you'll be able to see exactly what you've committed - if it all looks good, you can finalize it by clicking "Create Pull Request":
![Create Pull Request](/Ojydlaj.jpg)
![Create Pull Request](https://i.imgur.com/Ojydlaj.jpg)
After submitting, we may talk to you about your changes, ask that you make changes, and eventually accept it! Thanks for contributing to QMK :)
+1 -1
View File
@@ -91,7 +91,7 @@ Enables your LED to breath while your computer is sleeping. Timer1 is being used
`NKRO_ENABLE`
This allows the keyboard to tell the host OS that up to 248 keys are held down at once (default without NKRO is 6). NKRO is off by default, even if `NKRO_ENABLE` is set. NKRO can be toggled by binding `NK_TOGG` to a key and then hitting the key.
This allows the keyboard to tell the host OS that up to 248 keys are held down at once (default without NKRO is 6). NKRO is off by default, even if `NKRO_ENABLE` is set. NKRO can be forced by adding `#define FORCE_NKRO` to your config.h or by binding `MAGIC_TOGGLE_NKRO` to a key and then hitting the key.
`BACKLIGHT_ENABLE`
+14 -14
View File
@@ -36,12 +36,12 @@ What you want to achieve is one leg from each switch being attached to the corre
It is fairly simple to plan for an ortholinear keyboard (like a Planck).
![Example Planck matrix](/FRShcLD.png)
![Example Planck matrix](https://i.imgur.com/FRShcLD.png)
Image from [RoastPotatoes' "How to hand wire a Planck"](https://blog.roastpotatoes.co/guide/2015/11/04/how-to-handwire-a-planck/)
But the larger and more complicated your keyboard, the more complex the matrix. [Keyboard Firmware Builder](https://kbfirmware.com/) can help you plan your matrix layout (shown here with a basic fullsize ISO keyboard imported from [Keyboard Layout Editor](https://www.keyboard-layout-editor.com).
![Example ISO matrix](/UlJ4ZDP.png)
![Example ISO matrix](https://i.imgur.com/UlJ4ZDP.png)
Bear in mind that the number of rows plus the number of columns can not exceed the number of I/O pins on your controller. So the fullsize matrix shown above would be possible on a Proton C or Teensy++, but not on a regular Teensy or Pro Micro.
@@ -51,14 +51,14 @@ Bear in mind that the number of rows plus the number of columns can not exceed t
| :------------ |:-------------:| ------:| ------ |
| Pro Micro* | ATmega32u4 | 20 | [link](https://learn.sparkfun.com/tutorials/pro-micro--fio-v3-hookup-guide/hardware-overview-pro-micro#Teensy++_2.0) |
| Teensy 2.0 | ATmega32u4 | 25 | [link](https://www.pjrc.com/teensy/pinout.html) |
| [QMK Proton C](https://qmk.fm/proton-c/) | STM32F303xC | 36 | [link 1](https://qmk.fm/proton-c-pinout.jpg), [2](https://deskthority.net/wiki/QMK_Proton_C) |
| [QMK Proton C](https://qmk.fm/proton-c/) | STM32F303xC | 36 | [link 1](https://i.imgur.com/RhtrAlc.png), [2](https://deskthority.net/wiki/QMK_Proton_C) |
| Teensy++ 2.0 | AT90USB1286 | 46 | [link](https://www.pjrc.com/teensy/pinout.html#Teensy_2.0) |
*Elite C is essentially the same as a Pro Micro with a USB-C instead of Micro-USB
There are also a number of boards designed specifically for handwiring that mount directly to a small number of switches and offer pinouts for the rest. Though these are generally more expensive and may be more difficult to get hold of.
<img src="/QiA3ta6.jpg" alt="Postage board mini mounted in place" width="500"/>
<img src="https://i.imgur.com/QiA3ta6.jpg" alt="Postage board mini mounted in place" width="500"/>
| Board | Controller | # I/O |
| :------------ |:-------------:| ------:|
@@ -74,13 +74,13 @@ Established materials and techniques include:
| Technique | Examples | Pros | Cons | Image
| :-----------| :------- | :------ | :--- | :---
| Lengths of wire with stripped segments | [Sasha Solomon's Dactyl](https://medium.com/@sachee/building-my-first-keyboard-and-you-can-too-512c0f8a4c5f) and [Cribbit's modern hand wire](https://geekhack.org/index.php?topic=87689.0) | Neat and tidy | Some effort in stripping the wire | ![Stripped wire](/0GNIYY0.jpg)
| Short lengths of wire | [u/xicolinguada's ortho build](https://www.reddit.com/r/MechanicalKeyboards/comments/c39k4f/my_first_hand_wired_keyboard_its_not_perfect_but/) | Easier to strip the wire | More difficult to place | ![individual wire lengths](/mBe5vkL.jpg)
| Magnet/Enamelled wire | [fknraiden's custom board](https://geekhack.org/index.php?topic=74223.0) | Can be directly soldered onto (insulation burns off with heat) | Appearance? | ![Magnet wire](/b4b7KDb.jpg)
| Bending the legs of the diodes for the rows | [Matt3o's Brownfox](https://deskthority.net/viewtopic.php?f=7&t=6050) | Fewer solder joints required | Uninsulated | ![Bent diode legs](/aTnG8TV.jpg)
| Using rigid wiring (e.g. brass tube) | [u/d_stilgar's invisible hardline](https://www.reddit.com/r/MechanicalKeyboards/comments/8aw5j2/invisible_hardline_keyboard_progress_update_april/) and [u/jonasfasler's first attempt](https://www.reddit.com/r/MechanicalKeyboards/comments/de1jyv/my_first_attempt_at_handwiring_a_keyboard/) | Very pretty | More difficult. No physical insulation | ![Hardline hand wire](/CnASmPo.jpg)
| Bare wire with insulation added after (e.g. kapton tape) | [Matt3o's 65% on his website](https://matt3o.com/hand-wiring-a-custom-keyboard/) | Easier (no wire stripping required) | Not as attractive | ![Bare wire](/AvXZShD.jpg)
| Copper tape | [ManuForm Dactyl](https://github.com/tshort/dactyl-keyboard) | Very easy | Only really works when your plate/case aligns with the bottom of your switches | ![Copper tape](/RFyNMlL.jpg)
| Lengths of wire with stripped segments | [Sasha Solomon's Dactyl](https://medium.com/@sachee/building-my-first-keyboard-and-you-can-too-512c0f8a4c5f) and [Cribbit's modern hand wire](https://geekhack.org/index.php?topic=87689.0) | Neat and tidy | Some effort in stripping the wire | ![Stripped wire](https://i.imgur.com/0GNIYY0.jpg)
| Short lengths of wire | [u/xicolinguada's ortho build](https://www.reddit.com/r/MechanicalKeyboards/comments/c39k4f/my_first_hand_wired_keyboard_its_not_perfect_but/) | Easier to strip the wire | More difficult to place | ![individual wire lengths](https://i.imgur.com/mBe5vkL.jpg)
| Magnet/Enamelled wire | [fknraiden's custom board](https://geekhack.org/index.php?topic=74223.0) | Can be directly soldered onto (insulation burns off with heat) | Appearance? | ![Magnet wire](https://i.imgur.com/b4b7KDb.jpg)
| Bending the legs of the diodes for the rows | [Matt3o's Brownfox](https://deskthority.net/viewtopic.php?f=7&t=6050) | Fewer solder joints required | Uninsulated | ![Bent diode legs](https://i.imgur.com/aTnG8TV.jpg)
| Using rigid wiring (e.g. brass tube) | [u/d_stilgar's invisible hardline](https://www.reddit.com/r/MechanicalKeyboards/comments/8aw5j2/invisible_hardline_keyboard_progress_update_april/) and [u/jonasfasler's first attempt](https://www.reddit.com/r/MechanicalKeyboards/comments/de1jyv/my_first_attempt_at_handwiring_a_keyboard/) | Very pretty | More difficult. No physical insulation | ![Hardline hand wire](https://i.imgur.com/CnASmPo.jpg)
| Bare wire with insulation added after (e.g. kapton tape) | [Matt3o's 65% on his website](https://matt3o.com/hand-wiring-a-custom-keyboard/) | Easier (no wire stripping required) | Not as attractive | ![Bare wire](https://i.imgur.com/AvXZShD.jpg)
| Copper tape | [ManuForm Dactyl](https://github.com/tshort/dactyl-keyboard) | Very easy | Only really works when your plate/case aligns with the bottom of your switches | ![Copper tape](https://i.imgur.com/RFyNMlL.jpg)
Note that these methods can be combined. Prepare your lengths of wire before moving on to soldering.
@@ -97,11 +97,11 @@ There are a lot of soldering guides and tips available elsewhere but here are so
To ensure a strong solder joint you want a good amount of contact between the solder and the two pieces of metal you are connecting. A good way of doing this (though not required) is looping around pins or twisting wires together before applying solder.
<img src="/eHJjmnU.jpg" alt="Looped around rod" width="400"/>
<img src="https://i.imgur.com/eHJjmnU.jpg" alt="Looped around rod" width="200"/> <img src="https://i.imgur.com/8nbxmmr.jpg?1" alt="Looped diode leg" width="200"/>
If your diodes are on a packaging strip and need a bend in them (either the start of a loop or for connecting to its neighbour) this can easily done by bending it over something straight like the edge of a box, table, or ruler. This also helps keep track of the direction of the diode as all the bends will be on the same side.
<img src="/oITudbX.jpg" alt="Bent diode legs" width="400"/>
<img src="https://i.imgur.com/oITudbX.jpg" alt="Bent diode legs" width="200"/>
If your iron has temperature control, set it to 315ºC (600ºF).
@@ -164,7 +164,7 @@ Cut wires to the length of the distance from the a point on each column/row to t
Ribbon cable can be used to keep this extra tidy. You may also want to consider routing the wires beneath the existing columns/rows.
<img src="/z2QlKfB.jpg" alt="Ribbon Cable" width="600"/>
<img src="https://i.imgur.com/z2QlKfB.jpg" alt="Ribbon Cable" width="350"/>
As you solder the wires to the controller make a note of which row/column is going to which pin on the controller as we'll use this data to setup the matrix when we create the firmware.
-2
View File
@@ -33,13 +33,11 @@ If you own a board from one of the following vendors already, consider asking th
| iLovBee | Official 30-day copyright source code request issued Sep 11 2024 due to deception on PR, no response received. Ambiguity on PRs -- marketing says wireless, PR author said wired-only, then included wireless code anyway. Seemingly intentionally deceptive. |
| KiiBOOM | Seems to use the same OEM as Epomaker, same problems. |
| kprepublic | Makes no attempt to release source code, all boards in QMK are reverse-engineered, created, and supported by the community. New board variants magically appear without telling customers they're incompatible with existing QMK versions, in some cases bricking boards or requiring ISP flashing. |
| Lofree | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
| Luminkey | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
| Meletrix | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
| mmd / Smartmmd / i-game.tech | Ambiguity on PRs -- marketing says wireless, PR author said wired-only, then included wireless code anyway. Seemingly intentionally deceptive. |
| MyKeyClub | Community-supported JRIS75, vendor was contacted by community members and refused to cooperate. |
| owlab | Selling wired based on QMK without sources, just `via.json` provided. Ambiguous as to whether or not wireless firmware is based on QMK, given that their configuration tool looks very similar to VIA. |
| PMO Lab | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
| pressplayid | Selling wired and tri-mode boards based on QMK without sources, just `via.json` provided |
| qwertykeys | Selling wired and tri-mode boards based on QMK without sources, just `via.json` provided. |
| Redragon | Selling tri-mode boards based on QMK without sources, attempted upstreaming crippled firmware without wireless. |

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