mirror of
https://github.com/qmk/qmk_firmware.git
synced 2026-06-21 14:54:15 -04:00
Compare commits
151 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| fd624d016b | |||
| 6741f9dc26 | |||
| f8910d3a60 | |||
| c638100030 | |||
| 1d2f52e407 | |||
| 746eff22db | |||
| d36397fdd4 | |||
| 8522bb342d | |||
| 721affff7b | |||
| 4f6c5d2745 | |||
| 92dc82ae08 | |||
| b64014d5df | |||
| 0d401d1182 | |||
| 6ada0933db | |||
| 85886db43b | |||
| 0515002e7d | |||
| d8c8872753 | |||
| 7f702d2262 | |||
| 520b726b5c | |||
| 6a0e2a8868 | |||
| 4dc0a6e9e3 | |||
| 90082403de | |||
| 7b30455a93 | |||
| cffafbbdc7 | |||
| 1ef87578e2 | |||
| 55be8f2c2b | |||
| f34bc9a6bc | |||
| df94ffcc66 | |||
| 486f01f513 | |||
| ee74da3a4d | |||
| c53dd0fbb6 | |||
| 480d808683 | |||
| 11abc31420 | |||
| 62a8db33a3 | |||
| f0c79ee455 | |||
| 6b54261fa5 | |||
| 58d4decf48 | |||
| a9efff322c | |||
| 7b51d7e665 | |||
| 613d63aa66 | |||
| 5b630f7a08 | |||
| 286bc43459 | |||
| 2ea1a0192f | |||
| 25f641f2ff | |||
| 1620390d67 | |||
| 781b8ff406 | |||
| 05c4322c65 | |||
| 462556f4de | |||
| d19204824d | |||
| 2fa6ed6631 | |||
| c20d0a83b5 | |||
| 719b03f9c1 | |||
| 3c338996f0 | |||
| 06c24a811e | |||
| e56d518fc9 | |||
| 3a8ea37a13 | |||
| fdcf53854a | |||
| 47fd58e63e | |||
| e3b26fa6ba | |||
| 88cf7d87ec | |||
| f31df2ed6b | |||
| e4bf68ca94 | |||
| 459542a255 | |||
| 9879063f8c | |||
| 4d25dfae32 | |||
| e9ee03983e | |||
| e173b4020d | |||
| 6ee28ac86f | |||
| a3caec1580 | |||
| 08d91c3d4e | |||
| 9d47119457 | |||
| 4b19065f7b | |||
| cf2dcd6e24 | |||
| 62d25f02a4 | |||
| 078ec10e42 | |||
| 0efd817f42 | |||
| ce4f342ceb | |||
| 2b88b7b20a | |||
| 1a56fbece2 | |||
| a498daf627 | |||
| 5db9f2fb41 | |||
| c9f942e43c | |||
| 8d8cd1ca61 | |||
| f0622da7a8 | |||
| c5391ca2d6 | |||
| 4a962d7679 | |||
| e2c7d621a1 | |||
| 0c5e36d056 | |||
| 7d40a3328f | |||
| 21c193f77b | |||
| 1182760a7c | |||
| 60638d3043 | |||
| cc291cff7f | |||
| 70694abdfe | |||
| 1daa191e09 | |||
| 2ddd7c0667 | |||
| 2dc7d991b1 | |||
| 3a7e4d933e | |||
| 710e041c39 | |||
| d99f3acd8c | |||
| 84cd973c49 | |||
| 2c98f3782a | |||
| cbb8d156b0 | |||
| ded30bb42e | |||
| dd74b2326f | |||
| fbb0acdaa0 | |||
| a34c3b915e | |||
| 915edc3a3f | |||
| 50a411c95e | |||
| 7b4565a409 | |||
| 4dd01f4331 | |||
| 593cd168c6 | |||
| c31ebfeb0a | |||
| 6f4a45e392 | |||
| 53e1f9e0bd | |||
| 534f59a169 | |||
| 7382c0a6f2 | |||
| 43a27da296 | |||
| 3d0ccbb1d5 | |||
| a20facf8ec | |||
| 941b63c9a9 | |||
| d340f3396f | |||
| 12f92db5d9 | |||
| 9da27a3dcf | |||
| a3529e1c25 | |||
| 1f96f890fa | |||
| 1a3728db21 | |||
| c27e3aee19 | |||
| 86fbc9efe0 | |||
| c0bbf2f0f9 | |||
| f63d01d786 | |||
| f01698b3f8 | |||
| 53c0e30e96 | |||
| 2afc217124 | |||
| e4de46b3b0 | |||
| b6ff72cb03 | |||
| cd78765edc | |||
| 71b6b46534 | |||
| 263d56ce7e | |||
| f7a77c8b70 | |||
| 53953f4229 | |||
| 4b3b32e173 | |||
| e83672fdc4 | |||
| af6b953b2c | |||
| 59e1a0d437 | |||
| 311e915d96 | |||
| e2f62925d9 | |||
| d87e72a9b3 | |||
| dfb6158c62 | |||
| a1a2e3a390 | |||
| 6d7589e249 |
+48
-235
@@ -1,11 +1,13 @@
|
||||
---
|
||||
applyTo: "**"
|
||||
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
|
||||
@@ -41,37 +43,20 @@ This document provides automated review guidance based on the [QMK PR Checklist]
|
||||
- **Exception**: Simple assignment-only `rules.mk` files don't need headers
|
||||
- **Flag**: Missing or ambiguous license headers (blocks merge)
|
||||
|
||||
### QMK Best Practices
|
||||
- **Include Guards**: Use `#pragma once` instead of `#ifndef` guards in headers
|
||||
- **Abstractions Required**: No low-level GPIO/I2C/SPI functions
|
||||
- Must use QMK abstractions (flag direct hardware access)
|
||||
- **Timing Functions**:
|
||||
- Use `wait_ms()` instead of `_delay_ms()`
|
||||
- Remove `#include <util/delay.h>`
|
||||
- Use `timer_read()`, `timer_read32()` from `timer.h`
|
||||
- **New Abstractions**: If proposing new abstraction, suggest:
|
||||
1. Prototype in own keyboard first
|
||||
2. Discuss with QMK Collaborators on Discord
|
||||
3. Refactor as separate core change
|
||||
4. Remove the keyboard-specific implementation from board
|
||||
|
||||
---
|
||||
|
||||
## Keymap PR Reviews
|
||||
|
||||
**Scope**: These rules apply to files within `keyboards/*/keymaps/*` subdirectories.
|
||||
|
||||
### Note on Personal Keymaps
|
||||
- **Policy Change**: Personal keymap submissions no longer accepted
|
||||
- **Permitted**: Vendor-specific keymaps only
|
||||
- Naming convention: `default_${vendor}` (e.g., `default_clueboard`)
|
||||
- Can be more feature-rich than stock `default` keymaps
|
||||
### 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**: Prefer layer enums to `#define`s
|
||||
- **Enums**: Suggest using layer enums instead of `#define`s for layers (soft suggestion only)
|
||||
- **Custom Keycodes**: First entry must be `QK_USER`
|
||||
- **Formatting**: Check spacing alignment on commas and keycodes (spaces, not tabs)
|
||||
- **VIA**: Keymaps should NOT enable VIA
|
||||
- VIA keymaps belong in [VIA QMK Userspace](https://github.com/the-via/qmk_userspace_via)
|
||||
|
||||
@@ -96,245 +81,70 @@ This document provides automated review guidance based on the [QMK PR Checklist]
|
||||
- **Data Driven Migration**: Must target `develop`
|
||||
|
||||
### info.json and keyboard.json Requirements
|
||||
- **Data-Driven Configuration**: Encourage maximum use of `info.json` and `keyboard.json` schema features
|
||||
- **Schema Validation**: All `info.json` and `keyboard.json` files must validate against `data/schemas/keyboard.jsonschema`
|
||||
- Use QMK CLI: `qmk lint -kb <keyboard_name>` to validate
|
||||
- Schema defines required fields, data types, and valid values
|
||||
- Check for schema validation errors before submitting PR
|
||||
- **Schema Validation**: Verify that `info.json` and `keyboard.json` files are valid JSON (no syntax errors, no trailing commas, properly closed brackets)
|
||||
- **Mandatory Elements**:
|
||||
- Valid URL
|
||||
- Valid maintainer
|
||||
- Valid USB VID/PID and device version
|
||||
- Displays correctly in Configurator (Ctrl+Shift+I to preview)
|
||||
- `layout` definitions include matrix positions
|
||||
- Standard layout definitions where applicable
|
||||
- Community Layout macro names when applicable
|
||||
- `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: Use `LAYOUT` or community layout name
|
||||
- Multiple layouts: Include `LAYOUT_all` + alternate names
|
||||
- Prefer community layout names (e.g., `LAYOUT_tkl_ansi`, `LAYOUT_ortho_4x4`)
|
||||
- **Configuration in info.json or keyboard.json** (when applicable):
|
||||
- Direct pin configuration
|
||||
- Backlight, Split keyboard, Encoder, Bootmagic configs
|
||||
- LED Indicator, RGB Light, RGB Matrix configs
|
||||
- **Format**: Run `qmk format-json -i` before submitting
|
||||
|
||||
### USB VID/PID Uniqueness
|
||||
VID+PID combination must be unique across all keyboards. Individual VID or PID values can be reused with different partners.
|
||||
**Validation Steps:**
|
||||
1. Extract VID and PID from keyboard.json/info.json in the PR
|
||||
2. Search for existing usage: `grep -r '"vid".*"0xVVVV"' keyboards/ --include="*.json" | grep -l '"pid".*"0xPPPP"'`
|
||||
3. If results found: Check if BOTH VID AND PID match in same file
|
||||
- Both match = **COLLISION** - request different PID
|
||||
- Only one matches = **OK** - different keyboards can share individual values
|
||||
4. For keyboard variants/revisions under same keyboard folder:
|
||||
- Different PID recommended for functionally different variants
|
||||
- Same PID acceptable if revisions only differ in hardware routing/pin assignments
|
||||
**Quick Reference:**
|
||||
- Same PID + Different VID = Valid
|
||||
- Same VID + Different PID = Valid
|
||||
- Same VID + Same PID = Invalid
|
||||
**Review Response:**
|
||||
For collision:
|
||||
```
|
||||
VID+PID collision: 0xVVVV:0xPPPP already used by keyboards/[path]/file.json
|
||||
+Please assign a different PID. VID can remain the same.
|
||||
```
|
||||
For uniqueness confirmed:
|
||||
```
|
||||
VID+PID validation: 0xVVVV:0xPPPP is unique (no collisions found)
|
||||
```
|
||||
- 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
|
||||
- One-off prototypes will be questioned
|
||||
- Open-source should link to files
|
||||
- **Reset Instructions**: Clear bootloader mode instructions
|
||||
- **Images Required**:
|
||||
- Keyboard and PCB photos preferred
|
||||
- Must be hosted externally (imgur, etc.)
|
||||
- Direct image links required (not preview pages)
|
||||
- Example: `https://i.imgur.com/vqgE7Ok.jpg` not `https://imgur.com/vqgE7Ok`
|
||||
- **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**:
|
||||
- `MIDI_ENABLE`, `FAUXCLICKY_ENABLE`, `HD44780_ENABLE`
|
||||
- Size comments like `(-/+size)`
|
||||
- Alternate bootloader lists if one specified
|
||||
- MCU parameter re-definitions matching defaults in `mcu_selection.mk`
|
||||
- **Comment Updates**: Change bootloader comments to generic
|
||||
- **Forbidden Features at Keyboard Level** (these belong in keymap-level `rules.mk` only):
|
||||
- `COMBO_ENABLE`
|
||||
- `ENCODER_MAP_ENABLE`
|
||||
|
||||
### config.h Standards (Keyboard Level)
|
||||
- **Prohibited**:
|
||||
- `#define DESCRIPTION`
|
||||
- Magic Key Options, MIDI Options, HD44780 configuration
|
||||
- User preference `#define`s (belong in keymap)
|
||||
- Re-defining default values (`DEBOUNCE`, RGB settings)
|
||||
- Copy/pasted comment blocks explaining features
|
||||
- Comment blocks explaining features
|
||||
- Commented-out unused defines
|
||||
- `#include "config_common.h"`
|
||||
- `#define MATRIX_ROWS/COLS` (unless custom matrix)
|
||||
- **Minimal Code**: Only critical board boot code required
|
||||
- **No Vial**: Vial-related files/changes not accepted
|
||||
|
||||
### Keyboard Implementation Files
|
||||
|
||||
#### `<keyboard>.c`
|
||||
- **Remove Empty Functions**: Delete empty or commented-out weak-defined functions
|
||||
- `xxxx_xxxx_kb()`, `xxxx_xxxx_user()` implementations
|
||||
- **Migration**: `matrix_init_board()` → `keyboard_pre_init_kb()`
|
||||
- **Custom Matrix**: Use `lite` variant when possible for standard debounce
|
||||
- `CUSTOM_MATRIX = lite` preferred
|
||||
- Full custom matrix (`yes`) requires justification
|
||||
- **LED Indicators**: Prefer Configuration Options over custom `led_update_*()` implementations
|
||||
- **Hardware Configuration**: Basic functionality for OLED, encoders, etc. at keyboard level
|
||||
- **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**: Move to `info.json` or `keyboard.json` (no longer in header)
|
||||
- **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
|
||||
- No custom keycodes
|
||||
- No advanced features (non-exhaustive list of examples: tap dance, macros)
|
||||
- Basic mod taps and home row mods acceptable when necessary
|
||||
- Standard layouts preferred -- see examples in `layouts/default/` and `layouts/community/`
|
||||
- ⚠️ 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
|
||||
- **Additional Keymaps**: Example/bells-and-whistles keymaps acceptable in same PR (separate from default)
|
||||
|
||||
### 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)
|
||||
- Multi-board code is candidate for core refactoring when intended for use by multiple vendors
|
||||
|
||||
### Wireless Keyboards
|
||||
- **Policy**: Wireless/Bluetooth PRs rejected without complete wireless code
|
||||
- Wireless code may not include anything resembling precompiled data such as `*.a` files or other libraries
|
||||
- Firmware blobs are not permitted in raw form or as compiled C-style arrays either.
|
||||
- GPL2+ license requires full source disclosure
|
||||
- Historically abused for VIA compatibility without releasing sources
|
||||
- PRs without wireless capability will be held indefinitely
|
||||
- Existing merged wireless boards from same vendor held until sources provided
|
||||
|
||||
### ChibiOS-Specific Requirements
|
||||
- **Board Definitions**: Strong preference for existing ChibiOS board definitions
|
||||
- Use equivalent Nucleo boards when possible
|
||||
- Example: STM32L082KZ can use `BOARD = ST_NUCLEO64_L073RZ`
|
||||
- QMK is eliminating custom board definitions due to maintenance burden
|
||||
- **New Board Definitions**:
|
||||
- Must NOT be embedded in keyboard PR
|
||||
- Submit as separate Core PR
|
||||
- `board.c` must have standard `__early_init()` and empty `boardInit()`
|
||||
- Migrate code intended for `__early_init()` → keyboard-local `early_hardware_init_pre/post()`
|
||||
- Migrate code intended for `boardInit()` → keyboard-local `board_init()`
|
||||
|
||||
---
|
||||
|
||||
## Core PR Reviews
|
||||
|
||||
### Targeting and Scope
|
||||
- **Branch**: All core PRs must target `develop` branch
|
||||
- **Single Focus**: Smallest set of changes per PR
|
||||
- PRs with multiple areas will be asked to split
|
||||
- Keyboard/keymap changes only if affecting base builds or default-like keymaps
|
||||
- Keymap modifications (non-default) should be followup PR after core merge
|
||||
- Large refactoring PRs affecting other keymaps raised separately
|
||||
|
||||
### Testing Requirements
|
||||
- **New Hardware Support**: Requires test keyboard under `keyboards/handwired/onekey`
|
||||
- New MCUs: Add child keyboard targeting new MCU for build verification
|
||||
- New hardware (displays, matrix, peripherals): Provide associated keymap
|
||||
- Exception: If existing keymap can leverage functionality (consult Collaborators)
|
||||
- **Callbacks**: New `_kb`/`_user` callbacks must return `bool` for user override
|
||||
- **Unit Tests**: Strongly recommended, may be required
|
||||
- Critical code areas (keycode pipeline) will require tests
|
||||
- Boost confidence in current and future correctness
|
||||
|
||||
### Code Quality
|
||||
- **Subjective Review**: Other requirements at QMK Collaborators' discretion
|
||||
- **Documentation**: Core changes should be well-documented
|
||||
|
||||
---
|
||||
|
||||
## Automated Review Checklist
|
||||
|
||||
When reviewing PRs, check the following systematically:
|
||||
|
||||
### File Changes Review
|
||||
1. **License headers** on all C/H files (GPL2+ preferred, others must be GPL2+ compatible, SPDX format preferred)
|
||||
2. **File naming** lowercase (flag exceptions needing justification)
|
||||
3. **Include guards** use `#pragma once`
|
||||
4. **No low-level hardware access** (GPIO, I2C, SPI direct register writes)
|
||||
5. **Timing abstractions** (`wait_ms()`, `timer_read()` usage)
|
||||
|
||||
### info.json and keyboard.json Validation
|
||||
1. **Schema Compliance**: `keyboard.json` and `info.json` files validate against `data/schemas/keyboard.jsonschema`
|
||||
- Both files are identical syntax, however the `keyboard.json` dictates a buildable target, `info.json` does not
|
||||
- Run `qmk lint -kb <keyboard>` to check schema validation
|
||||
- Check for proper data types (strings, integers, arrays, objects)
|
||||
- Verify required fields are present
|
||||
- Ensure enum values match allowed options in schema
|
||||
2. All mandatory fields present and valid
|
||||
3. `qmk format-json -i` has been run (formats and validates)
|
||||
4. Layout macros moved from headers
|
||||
5. Community layout names used where applicable
|
||||
|
||||
### rules.mk Cleanup
|
||||
1. Deprecated features removed
|
||||
2. No size comments
|
||||
3. No keymap-only features at keyboard level
|
||||
4. No redundant MCU parameter definitions
|
||||
|
||||
### config.h Cleanup
|
||||
1. No `DESCRIPTION`, `config_common.h`, or prohibited includes
|
||||
2. No default value re-definitions
|
||||
3. No commented-out defines or feature documentation blocks
|
||||
4. No user preference defines at keyboard level
|
||||
|
||||
### Keymap Quality
|
||||
1. Default keymaps are pristine (no custom keycodes/advanced features)
|
||||
2. No `QMKBEST`/`QMKURL` macros
|
||||
3. Encoder map feature used instead of `encoder_update_user()`
|
||||
4. Tri Layer feature used for multi-layer access
|
||||
5. No VIA enabled in default keymap
|
||||
|
||||
### Documentation
|
||||
1. readme.md follows template
|
||||
2. Flash command present with `:flash`
|
||||
3. Reset instructions clear
|
||||
4. External image hosting (direct links)
|
||||
5. Valid hardware availability link
|
||||
|
||||
### Code Organization
|
||||
1. Empty weak-defined functions removed from `<keyboard>.c`
|
||||
2. Proper migration of init functions
|
||||
3. No cross-vendor source files
|
||||
4. No VIA/KLE JSON files
|
||||
|
||||
### Branch and Scope
|
||||
1. Not submitted from submitter's own `master` branch (use feature branches)
|
||||
2. PR is focused on single change
|
||||
3. Targets correct branch:
|
||||
- `master` for new keyboard additions
|
||||
- `develop` for keyboard updates/refactors/moves and core changes
|
||||
4. No merge conflicts
|
||||
|
||||
---
|
||||
|
||||
@@ -352,7 +162,6 @@ See: [Best Practices: Your Fork's Master](https://docs.qmk.fm/newbs_git_using_yo
|
||||
❌ This PR targets the wrong branch:
|
||||
- **New keyboard additions** should target `master`
|
||||
- **Keyboard updates/refactors/moves** should target `develop`
|
||||
- **Core changes** should target `develop`
|
||||
|
||||
Please change the target branch accordingly.
|
||||
```
|
||||
@@ -380,7 +189,7 @@ Exception: Only valid if from upstream sources (LUFA, ChibiOS) or justified by c
|
||||
### For config.h violations:
|
||||
```
|
||||
⚠️ Found prohibited config.h elements:
|
||||
- [list specific issues: DESCRIPTION, default value re-definitions, etc.]
|
||||
- [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).
|
||||
```
|
||||
@@ -393,31 +202,34 @@ Please remove these and refer to [Data Driven Configuration](https://docs.qmk.fm
|
||||
- Validate with: \`qmk lint -kb <keyboard_name>\`
|
||||
```
|
||||
|
||||
### For schema validation errors:
|
||||
```
|
||||
❌ Schema validation failed for info.json or keyboard.json:
|
||||
- [list specific validation errors from schema]
|
||||
- Check `data/schemas/keyboard.jsonschema` for valid field definitions
|
||||
- Common issues:
|
||||
- Invalid data types (e.g., string instead of integer)
|
||||
- Missing required fields
|
||||
- Invalid enum values
|
||||
- Incorrectly formatted pin definitions
|
||||
```
|
||||
|
||||
### For non-pristine default keymap:
|
||||
```
|
||||
⚠️ Default keymap should be pristine (clean slate for users):
|
||||
- Remove: [custom keycodes/tap dance/macros/etc.]
|
||||
- Keep it minimal with standard layouts where possible
|
||||
⚠️ 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]
|
||||
|
||||
Consider moving advanced features to a separate example keymap.
|
||||
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.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Notes for GitHub Copilot
|
||||
## 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 ⚠️
|
||||
@@ -425,6 +237,7 @@ Consider moving advanced features to a separate example keymap.
|
||||
- **Link to relevant QMK documentation** for each issue
|
||||
- **Prioritize blocking issues** (license, merge conflicts, branch policy)
|
||||
- **Be constructive**: Suggest fixes, not just problems
|
||||
- **Acknowledge trade-offs**: Some guidelines have valid exceptions
|
||||
- **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.
|
||||
|
||||
@@ -25,7 +25,7 @@ jobs:
|
||||
if: github.repository == 'qmk/qmk_firmware'
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 1
|
||||
persist-credentials: false
|
||||
|
||||
@@ -28,7 +28,7 @@ jobs:
|
||||
if: github.repository == 'qmk/qmk_firmware'
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
|
||||
@@ -49,14 +49,14 @@ jobs:
|
||||
- debian:11
|
||||
- debian:12
|
||||
- debian:13
|
||||
- ubuntu:20.04
|
||||
- ubuntu:22.04
|
||||
- ubuntu:24.04
|
||||
- ubuntu:26.04
|
||||
|
||||
# RHEL/CentOS/Fedora based
|
||||
- fedora:41
|
||||
- fedora:42
|
||||
- fedora:43
|
||||
- fedora:44
|
||||
- rockylinux:8
|
||||
- rockylinux:9
|
||||
- rockylinux/rockylinux:10
|
||||
@@ -64,7 +64,7 @@ jobs:
|
||||
- almalinux:9
|
||||
- almalinux:10
|
||||
|
||||
# OpenSUSE based (we skip Tumbleweed as it has issues with package versions between pattern installs and other dependencies preinstalled into the base container)
|
||||
# OpenSUSE based (we skip Tumbleweed as it has issues with package mirrors regularly being out of date)
|
||||
- opensuse/leap:latest
|
||||
|
||||
# Gentoo-based
|
||||
@@ -96,7 +96,7 @@ jobs:
|
||||
;;
|
||||
*suse*)
|
||||
zypper --non-interactive refresh
|
||||
zypper --non-interactive install sudo git shadow findutils # findutils=xargs
|
||||
zypper --non-interactive install sudo git shadow findutils tar # findutils=xargs
|
||||
;;
|
||||
*gentoo*)
|
||||
emerge-webrsync
|
||||
@@ -123,7 +123,7 @@ jobs:
|
||||
echo 'Defaults secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"' >> /etc/sudoers
|
||||
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 1
|
||||
submodules: recursive
|
||||
@@ -201,7 +201,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 1
|
||||
submodules: recursive
|
||||
@@ -258,7 +258,7 @@ jobs:
|
||||
git:
|
||||
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 1
|
||||
submodules: recursive
|
||||
|
||||
@@ -41,7 +41,7 @@ jobs:
|
||||
git config --global --add safe.directory '*'
|
||||
|
||||
- name: Checkout QMK Firmware
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip3 install -r requirements-dev.txt
|
||||
@@ -89,7 +89,7 @@ jobs:
|
||||
git config --global --add safe.directory '*'
|
||||
|
||||
- name: Checkout QMK Firmware
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ jobs:
|
||||
git config --global --add safe.directory '*'
|
||||
|
||||
- name: Checkout QMK Firmware
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip3 install -r requirements-dev.txt
|
||||
@@ -86,7 +86,7 @@ jobs:
|
||||
git config --global --add safe.directory '*'
|
||||
|
||||
- name: Checkout QMK Firmware
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
@@ -166,7 +166,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout QMK Firmware
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Download firmwares
|
||||
uses: actions/download-artifact@v8
|
||||
|
||||
@@ -24,7 +24,7 @@ jobs:
|
||||
- name: Disable safe.directory check
|
||||
run : git config --global --add safe.directory '*'
|
||||
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ jobs:
|
||||
if: github.repository == 'qmk/qmk_firmware'
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
token: ${{ secrets.QMK_BOT_TOKEN }}
|
||||
fetch-depth: 0
|
||||
|
||||
@@ -30,7 +30,7 @@ jobs:
|
||||
container: ghcr.io/qmk/qmk_cli
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 1
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ jobs:
|
||||
- riot
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
token: ${{ secrets.QMK_BOT_TOKEN }}
|
||||
fetch-depth: 0
|
||||
|
||||
@@ -26,7 +26,7 @@ jobs:
|
||||
- name: Disable safe.directory check
|
||||
run : git config --global --add safe.directory '*'
|
||||
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ jobs:
|
||||
- name: Disable safe.directory check
|
||||
run : git config --global --add safe.directory '*'
|
||||
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ jobs:
|
||||
- name: Disable safe.directory check
|
||||
run : git config --global --add safe.directory '*'
|
||||
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
- name: Disable safe.directory check
|
||||
run : git config --global --add safe.directory '*'
|
||||
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip3 install -r requirements-dev.txt
|
||||
|
||||
@@ -19,7 +19,7 @@ jobs:
|
||||
- name: Disable safe.directory check
|
||||
run : git config --global --add safe.directory '*'
|
||||
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip3 install -r requirements-dev.txt
|
||||
|
||||
@@ -27,7 +27,7 @@ jobs:
|
||||
container: ghcr.io/qmk/qmk_cli
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
|
||||
@@ -118,7 +118,7 @@ endef
|
||||
TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
|
||||
|
||||
# As TRY_TO_MATCH_RULE_FROM_LIST_HELPER, but with additional
|
||||
# resolution of keyboard_aliases.hjson for provided rule
|
||||
# resolution of keyboard_aliases.hjson for provided rule
|
||||
define TRY_TO_MATCH_RULE_FROM_LIST_HELPER_KB
|
||||
# Split on ":", padding with empty strings to avoid indexing issues
|
||||
TOKEN1:=$$(shell python3 -c "import sys; print((sys.argv[1].split(':',1)+[''])[0])" $$(RULE))
|
||||
@@ -300,6 +300,7 @@ endef
|
||||
define BUILD_TEST
|
||||
TEST_PATH := $1
|
||||
TEST_NAME := $$(notdir $$(TEST_PATH))
|
||||
TEST_ID := $$(patsubst ./tests/%,%,$$(TEST_PATH))
|
||||
TEST_FULL_NAME := $$(subst /,_,$$(patsubst $$(ROOT_DIR)tests/%,%,$$(TEST_PATH)))
|
||||
MAKE_TARGET := $2
|
||||
COMMAND := $1
|
||||
@@ -313,7 +314,7 @@ define BUILD_TEST
|
||||
TEST_MSG := $$(MSG_TEST)
|
||||
$$(TEST_FULL_NAME)_COMMAND := \
|
||||
printf "$$(TEST_MSG)\n"; \
|
||||
$$(TEST_EXECUTABLE); \
|
||||
$$(TEST_EXECUTABLE) --gtest_color=$$(COLOR); \
|
||||
if [ $$$$? -gt 0 ]; \
|
||||
then error_occurred=1; \
|
||||
fi; \
|
||||
@@ -451,16 +452,17 @@ distclean_userspace: clean
|
||||
endif
|
||||
|
||||
# Extra targets for formatting and/or pytest, running within the qmk/qmk_cli container to match GHA.
|
||||
CONTAINER_PREAMBLE := export HOME="/tmp"; export PATH="/tmp/.local/bin:\$$PATH"; python3 -m pip install --upgrade pip; python3 -m pip install -r requirements-dev.txt
|
||||
|
||||
.PHONY: format-core
|
||||
format-core:
|
||||
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk format-c --core-only -a && qmk format-python -a"
|
||||
RUNTIME=docker ./util/docker_cmd.sh qmk format-c --core-only -a
|
||||
RUNTIME=docker ./util/docker_cmd.sh qmk format-python -a
|
||||
|
||||
.PHONY: pytest
|
||||
pytest:
|
||||
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk pytest"
|
||||
RUNTIME=docker ./util/docker_cmd.sh qmk pytest
|
||||
|
||||
.PHONY: format-and-pytest
|
||||
format-and-pytest:
|
||||
RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk format-c --core-only -a && qmk format-python -a && qmk pytest"
|
||||
RUNTIME=docker ./util/docker_cmd.sh qmk format-c --core-only -a
|
||||
RUNTIME=docker ./util/docker_cmd.sh qmk format-python -a
|
||||
RUNTIME=docker ./util/docker_cmd.sh qmk pytest
|
||||
|
||||
@@ -187,9 +187,9 @@ include $(COMMUNITY_RULES_MK)
|
||||
|
||||
ifneq ($(COMMUNITY_MODULES),)
|
||||
|
||||
$(INTERMEDIATE_OUTPUT)/src/community_config.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
||||
$(INTERMEDIATE_OUTPUT)/src/community_post_config.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
||||
$(eval CMD=$(QMK_BIN) generate-community-config-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_config.h $(KEYMAP_JSON))
|
||||
$(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)
|
||||
@@ -227,10 +227,10 @@ $(INTERMEDIATE_OUTPUT)/src/split_transaction_id_community_modules.inc: $(KEYMAP_
|
||||
$(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_CONFIG_H = $(INTERMEDIATE_OUTPUT)/src/community_config.h
|
||||
COMMUNITY_POST_CONFIG_H = $(INTERMEDIATE_OUTPUT)/src/community_post_config.h
|
||||
SRC += $(INTERMEDIATE_OUTPUT)/src/community_modules.c
|
||||
|
||||
generated-files: $(INTERMEDIATE_OUTPUT)/src/community_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
|
||||
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
|
||||
|
||||
@@ -331,10 +331,6 @@ define config_h_community_module_appender
|
||||
endef
|
||||
$(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call config_h_community_module_appender,$(module))))
|
||||
|
||||
ifneq ($(COMMUNITY_CONFIG_H),)
|
||||
CONFIG_H += $(COMMUNITY_CONFIG_H)
|
||||
endif
|
||||
|
||||
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
|
||||
CONFIG_H += $(KEYBOARD_PATH_5)/config.h
|
||||
endif
|
||||
@@ -376,6 +372,10 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
|
||||
POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
|
||||
endif
|
||||
|
||||
ifneq ($(COMMUNITY_POST_CONFIG_H),)
|
||||
POST_CONFIG_H += $(COMMUNITY_POST_CONFIG_H)
|
||||
endif
|
||||
|
||||
CONFIG_H += $(INTERMEDIATE_OUTPUT)/src/info_config.h
|
||||
KEYBOARD_SRC += $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c
|
||||
|
||||
|
||||
@@ -98,6 +98,7 @@ endif
|
||||
|
||||
VALID_STENO_PROTOCOL_TYPES := geminipr txbolt all
|
||||
STENO_PROTOCOL ?= all
|
||||
|
||||
ifeq ($(strip $(STENO_ENABLE)), yes)
|
||||
ifeq ($(filter $(STENO_PROTOCOL),$(VALID_STENO_PROTOCOL_TYPES)),)
|
||||
$(call CATASTROPHIC_ERROR,Invalid STENO_PROTOCOL,STENO_PROTOCOL="$(STENO_PROTOCOL)" is not a valid stenography protocol)
|
||||
@@ -125,7 +126,7 @@ ifeq ($(strip $(MOUSEKEY_ENABLE)), yes)
|
||||
MOUSE_ENABLE := yes
|
||||
endif
|
||||
|
||||
VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick azoteq_iqs5xx cirque_pinnacle_i2c cirque_pinnacle_spi paw3204 paw3222 pmw3320 pmw3360 pmw3389 pimoroni_trackball custom
|
||||
VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick azoteq_iqs5xx cirque_pinnacle_i2c cirque_pinnacle_spi paw3204 paw3222 pmw3320 pmw3325 pmw3360 pmw3389 pimoroni_trackball custom
|
||||
ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
|
||||
ifeq ($(filter $(POINTING_DEVICE_DRIVER),$(VALID_POINTING_DEVICE_DRIVER_TYPES)),)
|
||||
$(call CATASTROPHIC_ERROR,Invalid POINTING_DEVICE_DRIVER,POINTING_DEVICE_DRIVER="$(POINTING_DEVICE_DRIVER)" is not a valid pointing device type)
|
||||
@@ -159,6 +160,8 @@ ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
|
||||
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),)
|
||||
|
||||
@@ -50,10 +50,14 @@ 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 ----------------
|
||||
|
||||
@@ -66,9 +70,9 @@ CFLAGS += $(CDEFS)
|
||||
CFLAGS += -O$(OPT)
|
||||
# add color
|
||||
ifeq ($(COLOR),true)
|
||||
ifeq ("$(shell echo "int main(){}" | $(CC) -fdiagnostics-color -x c - -o /dev/null 2>&1)", "")
|
||||
CFLAGS+= -fdiagnostics-color
|
||||
endif
|
||||
CFLAGS+= -fdiagnostics-color=always
|
||||
else
|
||||
CFLAGS+= -fdiagnostics-color=never
|
||||
endif
|
||||
CFLAGS += -Wall
|
||||
CFLAGS += -Wstrict-prototypes
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
{
|
||||
"license": "GPL-2.0-or-later",
|
||||
"devDependencies": {
|
||||
"vite": "^5.4.21",
|
||||
"vitepress": "^1.1.0",
|
||||
"vitepress-plugin-tabs": "^0.5.0",
|
||||
"vue": "^3.4.24"
|
||||
"vitepress": "^1.6.4",
|
||||
"vitepress-plugin-tabs": "^0.8.0"
|
||||
},
|
||||
"scripts": {
|
||||
"docs:dev": "vitepress dev --host 0.0.0.0",
|
||||
|
||||
+748
-386
File diff suppressed because it is too large
Load Diff
@@ -45,6 +45,7 @@ GENERIC_FEATURES = \
|
||||
MOUSEKEY \
|
||||
MUSIC \
|
||||
OS_DETECTION \
|
||||
PLOVER_HID \
|
||||
PROGRAMMABLE_BUTTON \
|
||||
REPEAT_KEY \
|
||||
SECURE \
|
||||
|
||||
@@ -77,13 +77,13 @@ define GENERATE_MSG_MAKE_KB
|
||||
endef
|
||||
MSG_MAKE_KB = $(eval $(call GENERATE_MSG_MAKE_KB))$(MSG_MAKE_KB_ACTUAL)
|
||||
define GENERATE_MSG_MAKE_TEST
|
||||
MSG_MAKE_TEST_ACTUAL := Making test $(BOLD)$(TEST_NAME)$(NO_COLOR)
|
||||
MSG_MAKE_TEST_ACTUAL := Making test $(BOLD)$(TEST_ID)$(NO_COLOR)
|
||||
ifneq ($$(MAKE_TARGET),)
|
||||
MSG_MAKE_TEST_ACTUAL += with target $(BOLD)$$(MAKE_TARGET)$(NO_COLOR)
|
||||
endif
|
||||
endef
|
||||
MSG_MAKE_TEST = $(eval $(call GENERATE_MSG_MAKE_TEST))$(MSG_MAKE_TEST_ACTUAL)
|
||||
MSG_TEST = Testing $(BOLD)$(TEST_NAME)$(NO_COLOR)
|
||||
MSG_TEST = Testing $(BOLD)$(TEST_ID)$(NO_COLOR)
|
||||
define GENERATE_MSG_AVAILABLE_KEYMAPS
|
||||
MSG_AVAILABLE_KEYMAPS_ACTUAL := Available keymaps for $(BOLD)$$(CURRENT_KB)$(NO_COLOR):
|
||||
endef
|
||||
|
||||
@@ -63,6 +63,7 @@ OTHER_OPTION_NAMES = \
|
||||
LCD_BACKLIGHT_ENABLE \
|
||||
MACROS_ENABLED \
|
||||
PS2_ENABLE \
|
||||
PLOVER_HID_ENABLE \
|
||||
PS2_MOUSE_ENABLE \
|
||||
PS2_DRIVER \
|
||||
RAW_ENABLE \
|
||||
|
||||
@@ -0,0 +1,265 @@
|
||||
{
|
||||
"ranges": {
|
||||
"0x5A40/0x003F": {
|
||||
"define": "QK_PLOVER_HID"
|
||||
}
|
||||
},
|
||||
"keycodes": {
|
||||
"0x5A40": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_S1"
|
||||
},
|
||||
"0x5A41": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_TL"
|
||||
},
|
||||
"0x5A42": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_KL"
|
||||
},
|
||||
"0x5A43": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_PL"
|
||||
},
|
||||
"0x5A44": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_WL"
|
||||
},
|
||||
"0x5A45": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_HL"
|
||||
},
|
||||
"0x5A46": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_RL"
|
||||
},
|
||||
"0x5A47": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_A"
|
||||
},
|
||||
"0x5A48": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_O"
|
||||
},
|
||||
"0x5A49": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_ST1"
|
||||
},
|
||||
"0x5A4A": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_E"
|
||||
},
|
||||
"0x5A4B": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_U"
|
||||
},
|
||||
"0x5A4C": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_FR"
|
||||
},
|
||||
"0x5A4D": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_RR"
|
||||
},
|
||||
"0x5A4E": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_PR"
|
||||
},
|
||||
"0x5A4F": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_BR"
|
||||
},
|
||||
"0x5A50": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_LR"
|
||||
},
|
||||
"0x5A51": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_GR"
|
||||
},
|
||||
"0x5A52": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_TR"
|
||||
},
|
||||
"0x5A53": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_SR"
|
||||
},
|
||||
"0x5A54": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_DR"
|
||||
},
|
||||
"0x5A55": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_ZR"
|
||||
},
|
||||
"0x5A56": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N1"
|
||||
},
|
||||
"0x5A57": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_S2"
|
||||
},
|
||||
"0x5A58": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_ST2"
|
||||
},
|
||||
"0x5A59": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_ST3"
|
||||
},
|
||||
"0x5A5A": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_ST4"
|
||||
},
|
||||
"0x5A5B": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N2"
|
||||
},
|
||||
"0x5A5C": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N3"
|
||||
},
|
||||
"0x5A5D": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N4"
|
||||
},
|
||||
"0x5A5E": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N5"
|
||||
},
|
||||
"0x5A5F": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N6"
|
||||
},
|
||||
"0x5A60": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N7"
|
||||
},
|
||||
"0x5A61": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N8"
|
||||
},
|
||||
"0x5A62": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_N9"
|
||||
},
|
||||
"0x5A63": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_NA"
|
||||
},
|
||||
"0x5A64": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_NB"
|
||||
},
|
||||
"0x5A65": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_NC"
|
||||
},
|
||||
"0x5A66": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X1"
|
||||
},
|
||||
"0x5A67": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X2"
|
||||
},
|
||||
"0x5A68": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X3"
|
||||
},
|
||||
"0x5A69": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X4"
|
||||
},
|
||||
"0x5A6A": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X5"
|
||||
},
|
||||
"0x5A6B": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X6"
|
||||
},
|
||||
"0x5A6C": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X7"
|
||||
},
|
||||
"0x5A6D": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X8"
|
||||
},
|
||||
"0x5A6E": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X9"
|
||||
},
|
||||
"0x5A6F": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X10"
|
||||
},
|
||||
"0x5A70": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X11"
|
||||
},
|
||||
"0x5A71": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X12"
|
||||
},
|
||||
"0x5A72": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X13"
|
||||
},
|
||||
"0x5A73": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X14"
|
||||
},
|
||||
"0x5A74": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X15"
|
||||
},
|
||||
"0x5A75": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X16"
|
||||
},
|
||||
"0x5A76": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X17"
|
||||
},
|
||||
"0x5A77": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X18"
|
||||
},
|
||||
"0x5A78": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X19"
|
||||
},
|
||||
"0x5A79": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X20"
|
||||
},
|
||||
"0x5A7A": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X21"
|
||||
},
|
||||
"0x5A7B": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X22"
|
||||
},
|
||||
"0x5A7C": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X23"
|
||||
},
|
||||
"0x5A7D": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X24"
|
||||
},
|
||||
"0x5A7E": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X25"
|
||||
},
|
||||
"0x5A7F": {
|
||||
"group": "plover_hid",
|
||||
"key": "PLV_X26"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
{
|
||||
// This version exists to signify addition of eeconfig support.
|
||||
}
|
||||
@@ -19,6 +19,8 @@
|
||||
// Audio
|
||||
"AUDIO_DEFAULT_ON": {"info_key": "audio.default.on", "value_type": "bool"},
|
||||
"AUDIO_DEFAULT_CLICKY_ON": {"info_key": "audio.default.clicky", "value_type": "bool"},
|
||||
"AUDIO_PIN": {"info_key": "audio.pins.0"},
|
||||
"AUDIO_PIN_ALT": {"info_key": "audio.pins.1"},
|
||||
"AUDIO_POWER_CONTROL_PIN": {"info_key": "audio.power_control.pin"},
|
||||
"AUDIO_POWER_CONTROL_PIN_ON_STATE": {"info_key": "audio.power_control.on_state", "value_type": "int" },
|
||||
"AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "flag"},
|
||||
@@ -225,6 +227,8 @@
|
||||
"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"},
|
||||
@@ -269,9 +273,9 @@
|
||||
"PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false, "value_type": "str", "deprecated": true, "replace_with": "`keyboard_name` in info.json"},
|
||||
"PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.pid` in info.json"},
|
||||
"VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.vid` in info.json"},
|
||||
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag", "deprecated": true, "replace_with": "`host.default.nkro` in info.json"},
|
||||
|
||||
// Items we want flagged in lint
|
||||
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag", "invalid": true, "replace_with": "`host.default.nkro` in info.json"},
|
||||
"VIAL_KEYBOARD_UID": {"info_key": "_invalid.vial_uid", "invalid": true},
|
||||
"VIAL_UNLOCK_COMBO_COLS": {"info_key": "_invalid.vial_unlock_cols", "invalid": true},
|
||||
"VIAL_UNLOCK_COMBO_ROWS": {"info_key": "_invalid.vial_unlock_rows", "invalid": true}
|
||||
|
||||
@@ -46,7 +46,8 @@
|
||||
"manufacturer": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
"format": "uri",
|
||||
"minLength": 1
|
||||
},
|
||||
"development_board": {
|
||||
"type": "string",
|
||||
@@ -992,6 +993,7 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"chordal_hold": {"type": "boolean"},
|
||||
"flow_tap_term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
||||
"force_hold": {"type": "boolean"},
|
||||
"force_hold_per_key": {"type": "boolean"},
|
||||
"ignore_mod_tap_interrupt": {"type": "boolean"},
|
||||
@@ -1001,6 +1003,9 @@
|
||||
"permissive_hold_per_key": {"type": "boolean"},
|
||||
"retro": {"type": "boolean"},
|
||||
"retro_per_key": {"type": "boolean"},
|
||||
"speculative_hold": {"type": "boolean"},
|
||||
"speculative_hold_flow_term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
||||
"speculative_hold_one_key": {"type": "boolean"},
|
||||
"term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
||||
"term_per_key": {"type": "boolean"},
|
||||
"toggle": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
||||
|
||||
@@ -0,0 +1,122 @@
|
||||
# QMK Breaking Changes - 2026 May 31 Changelog
|
||||
|
||||
## Notable Changes {#notable-changes}
|
||||
|
||||
## Deprecation Notices
|
||||
|
||||
In line with the [notice period](../support_deprecation_policy#how-much-advance-notice-will-be-given), deprecation notices for larger items are listed here.
|
||||
|
||||
### Removal of deprecated isLeftHand ([25897](https://github.com/qmk/qmk_firmware/pull/25897))
|
||||
|
||||
Users must migrate to `is_keyboard_left()` found in `split_util.h` instead. For example:
|
||||
|
||||
```diff
|
||||
oled_rotation_t oled_init_user(oled_rotation_t rotation) {
|
||||
- return isLeftHand ? OLED_ROTATION_180 : OLED_ROTATION_0;
|
||||
+ return is_keyboard_left() ? OLED_ROTATION_180 : OLED_ROTATION_0;
|
||||
}
|
||||
```
|
||||
|
||||
### Removal of `usb.force_nkro`/`FORCE_NKRO` ([#25262](https://github.com/qmk/qmk_firmware/pull/25262))
|
||||
|
||||
Unpicking the assumption that only USB can do NKRO, forcing of NKRO on every boot has been deprecated. As this setting persists, it produces unnecessary user confusion when the various NKRO keycodes (for example `NK_TOGG`) do not behave as expected.
|
||||
|
||||
The new defaults can be configured in the following ways:
|
||||
|
||||
:::::tabs
|
||||
|
||||
==== keyboard.json
|
||||
|
||||
```json [keyboard.json]
|
||||
{
|
||||
"host": { // [!code focus]
|
||||
"default": { // [!code focus]
|
||||
"nkro": true // [!code focus]
|
||||
} // [!code focus]
|
||||
} // [!code focus]
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
==== keymap.json
|
||||
|
||||
```json [keymap.json]
|
||||
{
|
||||
"config": {
|
||||
"host": { // [!code focus]
|
||||
"default": { // [!code focus]
|
||||
"nkro": true // [!code focus]
|
||||
} // [!code focus]
|
||||
} // [!code focus]
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
==== config.h
|
||||
|
||||
```c [config.h]
|
||||
#pragma once
|
||||
|
||||
#define NKRO_DEFAULT_ON true // [!code focus]
|
||||
```
|
||||
|
||||
:::::
|
||||
|
||||
## Full changelist
|
||||
|
||||
Core:
|
||||
* Remove deprecated `isLeftHand` ([#25897](https://github.com/qmk/qmk_firmware/pull/25897))
|
||||
* Either output Unicode or insert in Leader sequence ([#25940](https://github.com/qmk/qmk_firmware/pull/25940))
|
||||
* Add resolution information to digitizer ([#25958](https://github.com/qmk/qmk_firmware/pull/25958))
|
||||
* Always generate .map files. ([#25961](https://github.com/qmk/qmk_firmware/pull/25961))
|
||||
* Add an `mcu_reset` impl for the kiibohd bootloader. ([#25963](https://github.com/qmk/qmk_firmware/pull/25963))
|
||||
* VIA v13 ([#26001](https://github.com/qmk/qmk_firmware/pull/26001))
|
||||
* Added PixArt PMW-3325 mouse sensor driver ([#26065](https://github.com/qmk/qmk_firmware/pull/26065))
|
||||
* Update WL backing store from 16 to 32-bit for AT32 ([#26066](https://github.com/qmk/qmk_firmware/pull/26066))
|
||||
* Refactor Pixel Fractal effect ([#26071](https://github.com/qmk/qmk_firmware/pull/26071))
|
||||
* Minor combo code optimisation ([#26073](https://github.com/qmk/qmk_firmware/pull/26073))
|
||||
* Options to constrain Speculative Hold: `SPECULATIVE_HOLD_ONE_KEY` and `SPECULATIVE_HOLD_FLOW_TERM`. ([#26099](https://github.com/qmk/qmk_firmware/pull/26099))
|
||||
* Add includes for std::setw ([#26153](https://github.com/qmk/qmk_firmware/pull/26153))
|
||||
* Bind gtest colour to QMKs 'COLOR' variable ([#26159](https://github.com/qmk/qmk_firmware/pull/26159))
|
||||
* Print correct test names ([#26160](https://github.com/qmk/qmk_firmware/pull/26160))
|
||||
* Ignore Uninteresting test warnings during test teardown ([#26161](https://github.com/qmk/qmk_firmware/pull/26161))
|
||||
* Remove FORCE_NKRO ([#26206](https://github.com/qmk/qmk_firmware/pull/26206))
|
||||
|
||||
CLI:
|
||||
* Update lint to check all keymaps within the repo ([#25970](https://github.com/qmk/qmk_firmware/pull/25970))
|
||||
* Fail when a duplicate module name is detected ([#26238](https://github.com/qmk/qmk_firmware/pull/26238))
|
||||
|
||||
Submodule updates:
|
||||
* Update ChibiOS, ChibiOS-Contrib. ([#25730](https://github.com/qmk/qmk_firmware/pull/25730))
|
||||
* Revert "Update ChibiOS, ChibiOS-Contrib." ([#26074](https://github.com/qmk/qmk_firmware/pull/26074))
|
||||
* ChibiOS, ChibiOS-Contrib updates (redux) ([#26079](https://github.com/qmk/qmk_firmware/pull/26079))
|
||||
* Bump googletest to v1.16.0 ([#26154](https://github.com/qmk/qmk_firmware/pull/26154))
|
||||
|
||||
Keyboards:
|
||||
* Require "url" field to not be empty ([#25152](https://github.com/qmk/qmk_firmware/pull/25152))
|
||||
* Add nomis/rpi_pico_25x1 macropad ([#25346](https://github.com/qmk/qmk_firmware/pull/25346))
|
||||
* Remove override of QK_{LED,RGB}_MATRIX_TOGGLE keycode ([#25672](https://github.com/qmk/qmk_firmware/pull/25672))
|
||||
* Add reverse layout to SouthPad v2 ([#25707](https://github.com/qmk/qmk_firmware/pull/25707))
|
||||
* Adding Handwired Bouvet Macropad ([#26040](https://github.com/qmk/qmk_firmware/pull/26040))
|
||||
* Remove blockader user keymap ([#26075](https://github.com/qmk/qmk_firmware/pull/26075))
|
||||
* Remove deprecated audio pin defines ([#26111](https://github.com/qmk/qmk_firmware/pull/26111))
|
||||
* Remove `OLED_DISPLAY_128X32` config ([#26190](https://github.com/qmk/qmk_firmware/pull/26190))
|
||||
* Migrate SPLIT_OLED_ENABLE ([#26194](https://github.com/qmk/qmk_firmware/pull/26194))
|
||||
* Add API version assertion for split_data_sync module ([#26237](https://github.com/qmk/qmk_firmware/pull/26237))
|
||||
|
||||
Others:
|
||||
* Bump vitepress to 1.6.4 ([#26067](https://github.com/qmk/qmk_firmware/pull/26067))
|
||||
* Add usage clarifications to docs/features/unicode.md ([#26156](https://github.com/qmk/qmk_firmware/pull/26156))
|
||||
|
||||
Bugs:
|
||||
* Fix `USER_PRINT` stripping out `uprintf` ([#25919](https://github.com/qmk/qmk_firmware/pull/25919))
|
||||
* Fix possible repeat key infinite recursion ([#25926](https://github.com/qmk/qmk_firmware/pull/25926))
|
||||
* Fix `cc-option` on arm-none-eabi-gcc ([#26114](https://github.com/qmk/qmk_firmware/pull/26114))
|
||||
* Fix color diagnostics for arm-none-eabi-gcc ([#26115](https://github.com/qmk/qmk_firmware/pull/26115))
|
||||
* Mask out active mods when unregistering after retro tapping ([#26127](https://github.com/qmk/qmk_firmware/pull/26127))
|
||||
* fix `make test:all` failures seen on macOS Tahoe ([#26136](https://github.com/qmk/qmk_firmware/pull/26136))
|
||||
* Add workaround for undefined reference to weak function under mingw ([#26167](https://github.com/qmk/qmk_firmware/pull/26167))
|
||||
* fix(ws2812-pwm): allow WS2812_PWM_TICK_FREQUENCY override ([#26186](https://github.com/qmk/qmk_firmware/pull/26186))
|
||||
* Clip mouse report values to the logical range from the USB descriptor. ([#26195](https://github.com/qmk/qmk_firmware/pull/26195))
|
||||
* Align Mouse USB descriptor ([#26230](https://github.com/qmk/qmk_firmware/pull/26230))
|
||||
+1
-1
@@ -214,7 +214,7 @@
|
||||
{ "text": "My Pull Request Was Flagged", "link": "/breaking_changes_instructions" },
|
||||
{
|
||||
"text": "Most Recent ChangeLog",
|
||||
"link": "/ChangeLog/20260222"
|
||||
"link": "/ChangeLog/20260531"
|
||||
},
|
||||
{ "text": "Past Breaking Changes", "link": "/breaking_changes_history" },
|
||||
{ "text": "Deprecation Policy", "link": "/support_deprecation_policy" }
|
||||
|
||||
+10
-10
@@ -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)
|
||||
* [Older Breaking Changes](breaking_changes_history)
|
||||
|
||||
## When is the next Breaking Change?
|
||||
|
||||
The next Breaking Change is scheduled for May 31, 2026.
|
||||
The next Breaking Change is scheduled for Aug 30, 2026.
|
||||
|
||||
### Important Dates
|
||||
|
||||
* 2025 Feb 22 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
|
||||
* 2026 May 3 - `develop` closed to new PRs.
|
||||
* 2026 May 3 - Call for testers.
|
||||
* 2026 May 17 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
|
||||
* 2026 May 24 - `develop` is locked, only critical bugfix PRs merged.
|
||||
* 2026 May 29 - `master` is locked, no PRs merged.
|
||||
* 2026 May 31 - Merge `develop` to `master`.
|
||||
* 2026 May 31 - `master` is unlocked. PRs can be merged again.
|
||||
* 2025 May 31 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
|
||||
* 2026 Aug 2 - `develop` closed to new PRs.
|
||||
* 2026 Aug 2 - Call for testers.
|
||||
* 2026 Aug 16 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
|
||||
* 2026 Aug 23 - `develop` is locked, only critical bugfix PRs merged.
|
||||
* 2026 Aug 28 - `master` is locked, no PRs merged.
|
||||
* 2026 Aug 30 - Merge `develop` to `master`.
|
||||
* 2026 Aug 30 - `master` is unlocked. PRs can be merged again.
|
||||
|
||||
## What changes will be included?
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
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
|
||||
|
||||
@@ -74,24 +74,6 @@ This is a C header file that is one of the first things included, and will persi
|
||||
* pins mapped to rows and columns, from left to right. Defines a matrix where each switch is connected to a separate pin and ground.
|
||||
* `#define AUDIO_VOICES`
|
||||
* turns on the alternate audio voices (to cycle through)
|
||||
* `#define C4_AUDIO`
|
||||
* enables audio on pin C4
|
||||
* Deprecated. Use `#define AUDIO_PIN C4`
|
||||
* `#define C5_AUDIO`
|
||||
* enables audio on pin C5
|
||||
* Deprecated. Use `#define AUDIO_PIN C5`
|
||||
* `#define C6_AUDIO`
|
||||
* enables audio on pin C6
|
||||
* Deprecated. Use `#define AUDIO_PIN C6`
|
||||
* `#define B5_AUDIO`
|
||||
* enables audio on pin B5 (duophony is enabled if one of B pins is enabled along with one of C pins)
|
||||
* Deprecated. Use `#define AUDIO_PIN B5`, or use `#define AUDIO_PIN_ALT B5` if a `C` pin is enabled with `AUDIO_PIN`
|
||||
* `#define B6_AUDIO`
|
||||
* enables audio on pin B6 (duophony is enabled if one of B pins is enabled along with one of C pins)
|
||||
* Deprecated. Use `#define AUDIO_PIN B6`, or use `#define AUDIO_PIN_ALT B6` if a `C` pin is enabled with `AUDIO_PIN`
|
||||
* `#define B7_AUDIO`
|
||||
* enables audio on pin B7 (duophony is enabled if one of B pins is enabled along with one of C pins)
|
||||
* Deprecated. Use `#define AUDIO_PIN B7`, or use `#define AUDIO_PIN_ALT B7` if a `C` pin is enabled with `AUDIO_PIN`
|
||||
* `#define BACKLIGHT_PIN B7`
|
||||
* pin of the backlight
|
||||
* `#define BACKLIGHT_LEVELS 3`
|
||||
|
||||
@@ -135,28 +135,45 @@ This file defines LED matrix effects in the same form as used with `led_matrix_k
|
||||
|
||||
This file defines RGB matrix effects in the same form as used with `rgb_matrix_kb.inc` and `rgb_matrix_user.inc` (see [Custom RGB Matrix Effects](rgb_matrix#custom-rgb-matrix-effects)). Effect mode names are prepended with `RGB_MATRIX_COMMUNITY_MODULE_`.
|
||||
|
||||
### Custom split keyboard data sync
|
||||
### Additional Customization
|
||||
|
||||
Defines follow the convention, `SPLIT_TRANSACTION_IDS_MODULE_<MODULE>` (see [Custom data sync](split_keyboard#custom-data-sync)).
|
||||
#### 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` |
|
||||
@@ -164,7 +181,6 @@ Community Modules may provide specializations for the following APIs:
|
||||
| `pointing_device_init` | `pointing_device_init_<module>` | `pointing_device_init_hello_world` | `1.1.0` |
|
||||
| `pointing_device_task` | `pointing_device_task_<module>` | `pointing_device_task_hello_world` | `1.1.0` |
|
||||
|
||||
|
||||
::: info
|
||||
An unspecified API is disregarded if a Community Module does not provide a specialization for it.
|
||||
:::
|
||||
|
||||
@@ -320,6 +320,23 @@ The PMW3320 sensor uses a serial type protocol for communication, and requires a
|
||||
|
||||
The CPI range is 500-3500, in increments of 250. Defaults to 1000 CPI.
|
||||
|
||||
### PMW-3325 Sensor
|
||||
|
||||
To use the PMW-3325 sensor, add this to your `rules.mk`:
|
||||
|
||||
```make
|
||||
POINTING_DEVICE_DRIVER = pmw3325
|
||||
```
|
||||
|
||||
The following pins must be defined in `config.h`:
|
||||
|
||||
| Setting (`config.h`) | Description | Default |
|
||||
| --------------------- | ------------------------------------------------------------------ | ---------------------------- |
|
||||
| `PMW3325_CS_PIN` | (Required) The pin connected to the chip select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |
|
||||
| `PMW3325_SPI_DIVISOR` | (Required) The SPI clock divisor. This is dependent on your MCU. | _not defined_ |
|
||||
|
||||
The CPI range is 100-5000, in increments of 100. Defaults to 2000 CPI.
|
||||
|
||||
### PMW 3360 and PMW 3389 Sensor
|
||||
|
||||
This drivers supports both the PMW 3360 and PMW 3389 sensor as well as multiple sensors of the same type _per_ controller, so 2 can be attached at the same side for split keyboards (or unsplit keyboards).
|
||||
|
||||
@@ -166,7 +166,7 @@ In your keyboard config.h:
|
||||
|
||||
The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU.
|
||||
|
||||
There are strict requirements for pin ordering but any pair of GPIO pins can be used. The GPIO used for clock must be directly after data, see the included info.json snippet for an example of correct order.
|
||||
The GPIOs used for clock and data must be consecutive (in either order).
|
||||
|
||||
You may optionally switch the PIO peripheral used with the following define in config.h:
|
||||
```c
|
||||
|
||||
@@ -6,11 +6,12 @@ The [Open Steno Project](https://www.openstenoproject.org/) has built an open-so
|
||||
|
||||
## Steno Support in QMK
|
||||
|
||||
There are three ways that QMK keyboards can support steno, with varying degrees of configuration required:
|
||||
There are four ways that QMK keyboards can support steno, with varying degrees of configuration required:
|
||||
|
||||
1. Plover with [Arpeggiation](https://plover.wiki/index.php/Glossary#Arpeggiate) requires no changes to any keyboard and is supported by QMK as well as any other QWERTY keyboard.
|
||||
2. Plover with [NKRO](https://plover.wiki/index.php/Using_a_standard_keyboard_with_Plover#NKRO). If your keyboard supports NKRO in hardware and you have NKRO enabled as a USB endpoint, you can chord with the keyboard. Many devices will arrive stock like this and will require no changes.
|
||||
3. Steno Machine Protocols. This requires the most configuration, but this has the advantage of allowing you to use your keyboard keys normally (either on another layer or another piece of hardware) without enabling and disabling your steno software.
|
||||
4. Plover HID Protocol. This is a custom HID protocol that Plover can understand, but does not require a COM port. It is robust to device disconnects and saves an interface over the COM-based alternatives.
|
||||
|
||||
## Plover with QWERTY Keyboard {#plover-with-qwerty-keyboard}
|
||||
|
||||
@@ -92,6 +93,22 @@ Examples of steno strokes and the associated packet:
|
||||
- `WAZ` = `10000000 00000010 00100000 00000000 00000000 00000001`
|
||||
- `PHAPBGS` = `10000000 00000101 00100000 00000000 01101010 00000000`
|
||||
|
||||
## Plover HID Protocol {#plover-hid-protocol}
|
||||
|
||||
This mode operates independently of the other Steno "official" machine protocols. Like any other mouse or keyboard, it uses the USB HID protocol to communicate with Plover by sending an 8 byte (64 bit) packet representing a bitfield for all the possible keys on a steno machine plus a number of additional general purpose keys for custom use. This protocol is only understood by Plover as of [5.1.0](https://github.com/opensteno/plover/releases/tag/v5.1.0).
|
||||
|
||||
Add
|
||||
|
||||
```make
|
||||
PLOVER_HID_ENABLE = yes
|
||||
```
|
||||
|
||||
to your `rules.mk` file. This does **not** require `STENO_ENABLE` to be set.
|
||||
|
||||
All of the possible keycodes are defined with the `PLV_` prefix and are available without any additional includes.
|
||||
|
||||
More details can be found here: https://github.com/dnaq/plover-machine-hid
|
||||
|
||||
### Switching protocols on the fly {#switching-protocols-on-the-fly}
|
||||
|
||||
If you wish to switch the serial protocol used to transfer the steno chords without having to recompile your keyboard firmware every time, you can press the `QK_STENO_BOLT` and `QK_STENO_GEMINI` keycodes in order to switch protocols on the fly.
|
||||
|
||||
@@ -8,9 +8,9 @@ There are some limitations to this feature. Because there is no "standard" metho
|
||||
|
||||
## Usage {#usage}
|
||||
|
||||
The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See below for more details.
|
||||
The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See [below](#input-subsystems) for more details.
|
||||
|
||||
Add the following to your keymap's `rules.mk`:
|
||||
To start, add the following to your keymap's `rules.mk`:
|
||||
|
||||
```make
|
||||
UNICODE_COMMON = yes
|
||||
@@ -18,22 +18,25 @@ UNICODE_COMMON = yes
|
||||
|
||||
## Basic Configuration {#basic-configuration}
|
||||
|
||||
Add the following to your `config.h`:
|
||||
The following options can be set or overridden in your `config.h`:
|
||||
|
||||
|Define |Default |Description |
|
||||
|------------------------|------------------|--------------------------------------------------------------------------------|
|
||||
|`UNICODE_KEY_MAC` |`KC_LEFT_ALT` |The key to hold when beginning a Unicode sequence with the macOS input mode |
|
||||
|`UNICODE_KEY_LNX` |`LCTL(LSFT(KC_U))`|The key to tap when beginning a Unicode sequence with the Linux input mode |
|
||||
|`UNICODE_KEY_WINC` |`KC_RIGHT_ALT` |The key to hold when beginning a Unicode sequence with the WinCompose input mode|
|
||||
|`UNICODE_SELECTED_MODES`|`-1` |A comma separated list of input modes for cycling through |
|
||||
|`UNICODE_SELECTED_MODES`|*n/a* |A comma separated list of input modes for cycling through |
|
||||
|`UNICODE_CYCLE_PERSIST` |`true` |Whether to persist the current Unicode input mode to EEPROM |
|
||||
|`UNICODE_TYPE_DELAY` |`10` |The amount of time to wait, in milliseconds, between Unicode sequence keystrokes|
|
||||
|
||||
The default values work well for most use cases, so users usually only need to define `UNICODE_SELECTED_MODES` to set their desired input modes.
|
||||
However, if you plan on switching input modes manually (see [keycodes](#keycodes) below) and don't plan on cycling through them, this definition can be omitted.
|
||||
|
||||
### Audio Feedback {#audio-feedback}
|
||||
|
||||
If you have the [Audio](audio) feature enabled on your board, you can configure it to play sounds when the input mode is changed.
|
||||
|
||||
Add the following to your `config.h`:
|
||||
Add one or more of the following definitions to your `config.h`:
|
||||
|
||||
|Define |Default|Description |
|
||||
|-------------------|-------|-----------------------------------------------------------|
|
||||
|
||||
@@ -91,7 +91,7 @@ Enables your LED to breath while your computer is sleeping. Timer1 is being used
|
||||
|
||||
`NKRO_ENABLE`
|
||||
|
||||
This allows the keyboard to tell the host OS that up to 248 keys are held down at once (default without NKRO is 6). NKRO is off by default, even if `NKRO_ENABLE` is set. NKRO can be forced by adding `#define FORCE_NKRO` to your config.h or by binding `MAGIC_TOGGLE_NKRO` to a key and then hitting the key.
|
||||
This allows the keyboard to tell the host OS that up to 248 keys are held down at once (default without NKRO is 6). NKRO is off by default, even if `NKRO_ENABLE` is set. NKRO can be toggled by binding `NK_TOGG` to a key and then hitting the key.
|
||||
|
||||
`BACKLIGHT_ENABLE`
|
||||
|
||||
|
||||
@@ -75,6 +75,8 @@ curl -fsSL https://install.qmk.fm | sh
|
||||
|
||||
::: info
|
||||
Many Linux distributions are supported, but not all. Mainstream distributions will have best success -- if possible, choose either Debian or its derivatives (such as Ubuntu, or Mint), CentOS or its derivatives (such as Fedora, or Rocky Linux), and Arch or its derivatives (such as Manjaro, or CachyOS).
|
||||
|
||||
**The standard QMK build environment installed below does not support `musl`-based Linux distributions.**
|
||||
:::
|
||||
|
||||
Install the QMK CLI by running:
|
||||
|
||||
+24
-1
@@ -824,7 +824,30 @@ bool get_speculative_hold(uint16_t keycode, keyrecord_t* record) {
|
||||
}
|
||||
```
|
||||
|
||||
Some operating systems or applications assign actions to tapping a modifier key by itself, e.g., tapping GUI to open a start menu. Because Speculative Hold sends a lone modifier key press in some cases, it can falsely trigger these actions. To prevent this, set `DUMMY_MOD_NEUTRALIZER_KEYCODE` (and optionally `MODS_TO_NEUTRALIZE`) in your `config.h` in the same way as described above for [Retro Tapping](#retro-tapping).
|
||||
Some operating systems or applications assign actions to tapping a modifier key by itself, e.g., tapping GUI to open a start menu. Because Speculative Hold sometimes sends a lone modifier key press, it can falsely trigger these actions (known as the "flashing mods" problem). How such an input is handled depends on the OS and application, so unfortunately, there is no universal solution.
|
||||
|
||||
To mitigate this issue, you can set `DUMMY_MOD_NEUTRALIZER_KEYCODE` (and optionally `MODS_TO_NEUTRALIZE`) in your `config.h`, as described above for [Retro Tapping](#retro-tapping).
|
||||
|
||||
You can further prevent flashing mods by restricting when Speculative Hold is allowed to trigger. There are several options for this:
|
||||
|
||||
* Constrain Speculative Hold to one key at a time. Add to your config.h:
|
||||
|
||||
```c
|
||||
#define SPECULATIVE_HOLD_ONE_KEY
|
||||
```
|
||||
|
||||
With this option, Speculative Hold does not apply when any mods are already active. Mod combinations across multiple keys can still be made after the mod-tap keys settle.
|
||||
|
||||
* Disable Speculative Hold during the flow of fast typing. Add to your config.h:
|
||||
|
||||
```c
|
||||
#define SPECULATIVE_HOLD_FLOW_TERM 200
|
||||
```
|
||||
|
||||
This value specifies a duration in milliseconds. Speculative Hold does not apply if a key is pressed within this threshold of the previous key. The effect is similar to [Flow Tap](#flow-tap); however, `SPECULATIVE_HOLD_FLOW_TERM` only restricts when speculation is allowed, without affecting how the key settles.
|
||||
|
||||
* Use the Flow Tap option. In the fast flow of typing, the mod-tap key is immediately settled, and therefore no speculation occurs. See [Flow Tap](#flow-tap) for details.
|
||||
|
||||
|
||||
## Why do we include the key record for the per key functions?
|
||||
|
||||
|
||||
@@ -354,7 +354,7 @@ bool azoteq_iqs5xx_init(void) {
|
||||
};
|
||||
|
||||
report_mouse_t azoteq_iqs5xx_get_report(report_mouse_t mouse_report) {
|
||||
report_mouse_t temp_report = {0};
|
||||
report_mouse_t temp_report = {.buttons = mouse_report.buttons};
|
||||
|
||||
azoteq_iqs5xx_base_data_t base_data = {0};
|
||||
i2c_status_t status = azoteq_iqs5xx_get_base_data(&base_data);
|
||||
|
||||
@@ -0,0 +1,173 @@
|
||||
// Copyright 2024 Colin Lam (Ploopy Corporation)
|
||||
// Copyright 2026 HorrorTroll <https://github.com/HorrorTroll>
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
|
||||
#include "pmw3325.h"
|
||||
#include "wait.h"
|
||||
#include "gpio.h"
|
||||
#include "spi_master.h"
|
||||
#include "pointing_device_internal.h"
|
||||
|
||||
#define MSB1 0x80
|
||||
#define MSB0 0x7F
|
||||
|
||||
const pointing_device_driver_t pmw3325_pointing_device_driver = {
|
||||
.init = pmw3325_init,
|
||||
.get_report = pmw3325_get_report,
|
||||
.set_cpi = pmw3325_set_cpi,
|
||||
.get_cpi = pmw3325_get_cpi,
|
||||
};
|
||||
|
||||
// Convert a 16-bit twos complement binary-represented number into a
|
||||
// signed 16-bit integer.
|
||||
static int16_t convert_twoscomp_16(uint8_t high, uint8_t low) {
|
||||
uint16_t data = (high << 8) | low;
|
||||
|
||||
if ((data & 0x8000) == 0x8000) {
|
||||
return -32768 + (data & 0x7FFF);
|
||||
} else {
|
||||
return data;
|
||||
}
|
||||
}
|
||||
|
||||
void pmw3325_write(uint8_t reg_addr, uint8_t data) {
|
||||
spi_start(PMW3325_CS_PIN, false, 3, PMW3325_SPI_DIVISOR);
|
||||
wait_us(1); // tNCS_SCLK
|
||||
spi_write(reg_addr | MSB1);
|
||||
wait_us(180); // tSRAD
|
||||
spi_write(data);
|
||||
wait_us(1); // tSCLK_NCS
|
||||
spi_stop();
|
||||
wait_us(20); // tSRR
|
||||
}
|
||||
|
||||
uint8_t pmw3325_read(uint8_t reg_addr) {
|
||||
spi_start(PMW3325_CS_PIN, false, 3, PMW3325_SPI_DIVISOR);
|
||||
wait_us(1); // tNCS_SCLK
|
||||
spi_write(reg_addr & MSB0);
|
||||
wait_us(180); // tSRAD
|
||||
uint8_t data = spi_read();
|
||||
wait_us(1); // tSCLK_NCS
|
||||
spi_stop();
|
||||
wait_us(20); // tSRR
|
||||
|
||||
return data;
|
||||
}
|
||||
|
||||
bool pmw3325_init(void) {
|
||||
wait_ms(50);
|
||||
gpio_set_pin_output(PMW3325_CS_PIN);
|
||||
|
||||
// CS must be kept high at power-up stage for at least 1ms
|
||||
gpio_write_pin_low(PMW3325_CS_PIN);
|
||||
wait_ms(10);
|
||||
gpio_write_pin_high(PMW3325_CS_PIN);
|
||||
|
||||
spi_init();
|
||||
|
||||
// reboot
|
||||
pmw3325_write(0x3A, 0x5A);
|
||||
wait_ms(10);
|
||||
|
||||
pmw3325_write(0x18, 0x39);
|
||||
|
||||
if (!pmw3325_check_signature()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// read a burst, then discard
|
||||
pmw3325_read(0x02);
|
||||
pmw3325_read(0x03);
|
||||
pmw3325_read(0x04);
|
||||
pmw3325_read(0x05);
|
||||
pmw3325_read(0x06);
|
||||
|
||||
// initialize
|
||||
pmw3325_write(0x78, 0x80);
|
||||
pmw3325_write(0x79, 0x80);
|
||||
pmw3325_write(0x14, 0x80);
|
||||
pmw3325_write(0x20, 0x40);
|
||||
pmw3325_write(0x1A, 0x40);
|
||||
pmw3325_write(0x47, 0x00);
|
||||
pmw3325_write(0x48, 0x01);
|
||||
pmw3325_write(0x60, 0x01);
|
||||
pmw3325_write(0x69, 0x03);
|
||||
pmw3325_write(0x1D, 0x90);
|
||||
pmw3325_write(0x1B, 0x2E);
|
||||
pmw3325_write(0x24, 0x05);
|
||||
pmw3325_write(0x56, 0x00);
|
||||
pmw3325_write(0x2C, 0x8A);
|
||||
pmw3325_write(0x2D, 0x58);
|
||||
pmw3325_write(0x40, 0x80);
|
||||
pmw3325_write(0x7F, 0x01);
|
||||
pmw3325_write(0x7A, 0x32);
|
||||
pmw3325_write(0x6A, 0x93);
|
||||
pmw3325_write(0x6B, 0x68);
|
||||
pmw3325_write(0x6C, 0x71);
|
||||
pmw3325_write(0x6D, 0x50);
|
||||
pmw3325_write(0x7F, 0x00);
|
||||
pmw3325_write(0x7F, 0x02);
|
||||
pmw3325_write(0x29, 0x1C);
|
||||
pmw3325_write(0x2A, 0x1A);
|
||||
pmw3325_write(0x2B, 0x90);
|
||||
pmw3325_write(0x40, 0x80);
|
||||
pmw3325_write(0x7F, 0x00);
|
||||
return true;
|
||||
}
|
||||
|
||||
report_pmw3325_t pmw3325_read_burst(void) {
|
||||
report_pmw3325_t report = {0};
|
||||
|
||||
uint8_t motion = pmw3325_read(0x02);
|
||||
if ((motion & MSB1) == MSB1) {
|
||||
// Motion detected
|
||||
uint8_t dx_l = pmw3325_read(0x03);
|
||||
uint8_t dx_h = pmw3325_read(0x04);
|
||||
uint8_t dy_l = pmw3325_read(0x05);
|
||||
uint8_t dy_h = pmw3325_read(0x06);
|
||||
|
||||
report.dx = convert_twoscomp_16(dx_h, dx_l);
|
||||
report.dy = convert_twoscomp_16(dy_h, dy_l);
|
||||
}
|
||||
|
||||
return report;
|
||||
}
|
||||
|
||||
static const uint8_t pmw3325_cpi_lut[50] = {0x02, 0x04, 0x06, 0x08, 0x0B, 0x0D, 0x0F, 0x12, 0x14, 0x16, 0x19, 0x1B, 0x1D, 0x20, 0x22, 0x24, 0x27, 0x29, 0x2B, 0x2E, 0x30, 0x32, 0x34, 0x37, 0x39, 0x3B, 0x3E, 0x40, 0x42, 0x45, 0x47, 0x49, 0x4C, 0x4E, 0x50, 0x53, 0x55, 0x57, 0x5A, 0x5C, 0x5E, 0x61, 0x63, 0x65, 0x68, 0x6A, 0x6C, 0x6F, 0x71, 0x73};
|
||||
|
||||
void pmw3325_set_cpi(uint16_t cpi) {
|
||||
uint8_t cpival = CONSTRAIN((cpi / PMW3325_CPI_STEP), (PMW3325_CPI_MIN / PMW3325_CPI_STEP), (PMW3325_CPI_MAX / PMW3325_CPI_STEP)) - 1U;
|
||||
|
||||
pmw3325_write(0x1B, pmw3325_cpi_lut[cpival]);
|
||||
}
|
||||
|
||||
uint16_t pmw3325_get_cpi(void) {
|
||||
uint8_t cpival = pmw3325_read(0x1B);
|
||||
|
||||
for (uint8_t cpi = 0; cpi < 50; cpi++) {
|
||||
if (pmw3325_cpi_lut[cpi] == cpival) {
|
||||
return (cpi + 1) * PMW3325_CPI_STEP;
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
report_mouse_t pmw3325_get_report(report_mouse_t mouse_report) {
|
||||
report_pmw3325_t data = pmw3325_read_burst();
|
||||
|
||||
if (data.dx != 0 || data.dy != 0) {
|
||||
pd_dprintf("Raw ] X: %d, Y: %d\n", data.dx, data.dy);
|
||||
mouse_report.x = CONSTRAIN_HID_XY(data.dx);
|
||||
mouse_report.y = CONSTRAIN_HID_XY(data.dy);
|
||||
}
|
||||
|
||||
return mouse_report;
|
||||
}
|
||||
|
||||
bool pmw3325_check_signature(void) {
|
||||
uint8_t checkval_1 = pmw3325_read(0x00);
|
||||
uint8_t checkval_2 = pmw3325_read(0x3F);
|
||||
|
||||
return (checkval_1 == 0x43 && checkval_2 == 0xBC);
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
// Copyright 2021 Colin Lam (Ploopy Corporation)
|
||||
// Copyright 2026 HorrorTroll <https://github.com/HorrorTroll>
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
#include "pointing_device.h"
|
||||
|
||||
#ifndef PMW3325_CS_PIN
|
||||
# ifdef POINTING_DEVICE_CS_PIN
|
||||
# define PMW3325_CS_PIN POINTING_DEVICE_CS_PIN
|
||||
# else
|
||||
# error "No chip select pin defined -- missing POINTING_DEVICE_CS_PIN or PMW3325_CS_PIN define"
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#ifndef PMW3325_SPI_DIVISOR
|
||||
# error "No PMW3325 SPI divisor defined -- missing PMW3325_SPI_DIVISOR"
|
||||
#endif
|
||||
|
||||
typedef struct {
|
||||
int16_t dx;
|
||||
int16_t dy;
|
||||
} report_pmw3325_t;
|
||||
|
||||
extern const pointing_device_driver_t pmw3325_pointing_device_driver;
|
||||
|
||||
bool pmw3325_init(void);
|
||||
report_pmw3325_t pmw3325_read_burst(void);
|
||||
void pmw3325_set_cpi(uint16_t cpi);
|
||||
uint16_t pmw3325_get_cpi(void);
|
||||
report_mouse_t pmw3325_get_report(report_mouse_t mouse_report);
|
||||
bool pmw3325_check_signature(void);
|
||||
|
||||
#if !defined(PMW3325_CPI)
|
||||
# define PMW3325_CPI 2000
|
||||
#endif
|
||||
|
||||
#define PMW3325_CPI_MIN 100
|
||||
#define PMW3325_CPI_MAX 5000
|
||||
#define PMW3325_CPI_STEP 100
|
||||
#define CONSTRAIN(amt, low, high) ((amt) < (low) ? (low) : ((amt) > (high) ? (high) : (amt)))
|
||||
@@ -3,7 +3,6 @@
|
||||
|
||||
#pragma once
|
||||
|
||||
#define OLED_DISPLAY_128X32
|
||||
#define I2C1_SCL_PIN GP17
|
||||
#define I2C1_SDA_PIN GP16
|
||||
#define I2C_DRIVER I2CD0
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
/*
|
||||
This is the c configuration file for the keymap
|
||||
|
||||
Copyright 2012 Jun Wako <wakojun@gmail.com>
|
||||
Copyright 2015 Jack Humbert
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
//#define USE_I2C
|
||||
|
||||
#define FORCE_NKRO
|
||||
@@ -14,6 +14,11 @@
|
||||
"command": true,
|
||||
"nkro": true
|
||||
},
|
||||
"host": {
|
||||
"default": {
|
||||
"nkro": true
|
||||
}
|
||||
},
|
||||
"qmk": {
|
||||
"locking": {
|
||||
"enabled": true,
|
||||
|
||||
@@ -140,30 +140,3 @@ void housekeeping_task_kb(void){
|
||||
gpio_write_pin(LED_MAC_OS_PIN, (get_highest_layer(default_layer_state) == 3));
|
||||
gpio_write_pin(LED_WIN_LOCK_PIN, keymap_config.no_gui);
|
||||
}
|
||||
|
||||
bool process_record_kb(uint16_t keycode, keyrecord_t* record) {
|
||||
if (!process_record_user(keycode, record)) {
|
||||
return false;
|
||||
}
|
||||
switch (keycode) {
|
||||
case QK_RGB_MATRIX_TOGGLE:
|
||||
if (record->event.pressed) {
|
||||
switch (rgb_matrix_get_flags()) {
|
||||
case LED_FLAG_ALL: {
|
||||
rgb_matrix_set_flags(LED_FLAG_NONE);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
} break;
|
||||
default: {
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
} break;
|
||||
}
|
||||
}
|
||||
if (!rgb_matrix_is_enabled()) {
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
rgb_matrix_enable();
|
||||
}
|
||||
return false;
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,6 @@ This layout replaces the stock layout on the Vortex Race 3.
|
||||
|
||||
- Caps Lock indicator LED is enabled by default
|
||||
- Layer Tap on Caps Lock (tap for Caps Lock, hold for _FN1)
|
||||
- FORCE_NKRO enabled by default
|
||||
|
||||
- Pn key is set to 'KC_NO' by default
|
||||
* Might be a good place for a macro, or to put your PC to sleep, etc.
|
||||
|
||||
@@ -4,7 +4,6 @@ This layout replaces the stock layout on the Vortex Race 3.
|
||||
|
||||
- Caps Lock indicator LED is enabled by default
|
||||
- Layer Tap on Caps Lock (tap for Caps Lock, hold for _FN1)
|
||||
- FORCE_NKRO enabled by default
|
||||
|
||||
- Pn key is set to 'KC_NO' by default
|
||||
* Might be a good place for a macro, or to put your PC to sleep, etc.
|
||||
|
||||
@@ -4,7 +4,6 @@ This layout replaces the stock layout on the Vortex Race 3.
|
||||
|
||||
- Caps Lock indicator LED is enabled by default
|
||||
- Layer Tap on Caps Lock (tap for Caps Lock, hold for _FN1)
|
||||
- FORCE_NKRO enabled by default
|
||||
|
||||
- Pn key is set to 'KC_NO' by default
|
||||
* Might be a good place for a macro, or to put your PC to sleep, etc.
|
||||
|
||||
@@ -4,7 +4,6 @@ This layout replaces the stock layout on the Vortex Race 3.
|
||||
|
||||
- Caps Lock indicator LED is enabled by default
|
||||
- Layer Tap on Caps Lock (tap for Caps Lock, hold for _FN1)
|
||||
- FORCE_NKRO enabled by default
|
||||
|
||||
- Pn key is set to 'KC_NO' by default
|
||||
* Might be a good place for a macro, or to put your PC to sleep, etc.
|
||||
|
||||
@@ -4,7 +4,6 @@ This layout replaces the stock layout on the Vortex Race 3.
|
||||
|
||||
- Caps Lock indicator LED is enabled by default
|
||||
- Layer Tap on Caps Lock (tap for Caps Lock, hold for _FN1)
|
||||
- FORCE_NKRO enabled by default
|
||||
|
||||
- Pn key is set to 'KC_NO' by default
|
||||
* Might be a good place for a macro, or to put your PC to sleep, etc.
|
||||
|
||||
@@ -19,6 +19,5 @@
|
||||
|
||||
// OLED driver
|
||||
#ifdef OLED_DRIVER_ENABLE
|
||||
#define OLED_DISPLAY_128X32
|
||||
#define OLED_TIMEOUT 30000
|
||||
#endif
|
||||
|
||||
@@ -3,10 +3,6 @@
|
||||
|
||||
#pragma once
|
||||
|
||||
#ifdef OLED_ENABLE
|
||||
#define OLED_DISPLAY_128X32
|
||||
#endif
|
||||
|
||||
#ifdef PS2_DRIVER_INTERRUPT
|
||||
#define PS2_CLOCK_PIN E6
|
||||
#define PS2_DATA_PIN D7
|
||||
|
||||
@@ -0,0 +1,180 @@
|
||||
{
|
||||
"manufacturer": "CannonKeys",
|
||||
"keyboard_name": "Minimi40 Ortho",
|
||||
"maintainer": "awkannan",
|
||||
"bootloader": "stm32-dfu",
|
||||
"diode_direction": "COL2ROW",
|
||||
"features": {
|
||||
"bootmagic": true,
|
||||
"extrakey": true,
|
||||
"mousekey": true,
|
||||
"nkro": true
|
||||
},
|
||||
"matrix_pins": {
|
||||
"cols": ["B11", "B10", "B2", "B1", "B0", "A4", "C14", "B6", "B5", "B4", "B3", "A15"],
|
||||
"rows": ["A5", "A7", "A3", "B7"]
|
||||
},
|
||||
"processor": "STM32F072",
|
||||
"url": "https://cannonkeys.com",
|
||||
"usb": {
|
||||
"device_version": "0.0.1",
|
||||
"pid": "0x0037",
|
||||
"vid": "0xCA04"
|
||||
},
|
||||
"community_layouts": ["ortho_4x12"],
|
||||
"layouts": {
|
||||
"LAYOUT_ortho_4x12": {
|
||||
"layout": [
|
||||
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||
{"matrix": [0, 10], "x": 10, "y": 0},
|
||||
{"matrix": [0, 11], "x": 11, "y": 0},
|
||||
{"matrix": [1, 0], "x": 0, "y": 1},
|
||||
{"matrix": [1, 1], "x": 1, "y": 1},
|
||||
{"matrix": [1, 2], "x": 2, "y": 1},
|
||||
{"matrix": [1, 3], "x": 3, "y": 1},
|
||||
{"matrix": [1, 4], "x": 4, "y": 1},
|
||||
{"matrix": [1, 5], "x": 5, "y": 1},
|
||||
{"matrix": [1, 6], "x": 6, "y": 1},
|
||||
{"matrix": [1, 7], "x": 7, "y": 1},
|
||||
{"matrix": [1, 8], "x": 8, "y": 1},
|
||||
{"matrix": [1, 9], "x": 9, "y": 1},
|
||||
{"matrix": [1, 10], "x": 10, "y": 1},
|
||||
{"matrix": [1, 11], "x": 11, "y": 1},
|
||||
{"matrix": [2, 0], "x": 0, "y": 2},
|
||||
{"matrix": [2, 1], "x": 1, "y": 2},
|
||||
{"matrix": [2, 2], "x": 2, "y": 2},
|
||||
{"matrix": [2, 3], "x": 3, "y": 2},
|
||||
{"matrix": [2, 4], "x": 4, "y": 2},
|
||||
{"matrix": [2, 5], "x": 5, "y": 2},
|
||||
{"matrix": [2, 6], "x": 6, "y": 2},
|
||||
{"matrix": [2, 7], "x": 7, "y": 2},
|
||||
{"matrix": [2, 8], "x": 8, "y": 2},
|
||||
{"matrix": [2, 9], "x": 9, "y": 2},
|
||||
{"matrix": [2, 10], "x": 10, "y": 2},
|
||||
{"matrix": [2, 11], "x": 11, "y": 2},
|
||||
{"matrix": [3, 0], "x": 0, "y": 3},
|
||||
{"matrix": [3, 1], "x": 1, "y": 3},
|
||||
{"matrix": [3, 2], "x": 2, "y": 3},
|
||||
{"matrix": [3, 3], "x": 3, "y": 3},
|
||||
{"matrix": [3, 4], "x": 4, "y": 3},
|
||||
{"matrix": [3, 5], "x": 5, "y": 3},
|
||||
{"matrix": [3, 6], "x": 6, "y": 3},
|
||||
{"matrix": [3, 7], "x": 7, "y": 3},
|
||||
{"matrix": [3, 8], "x": 8, "y": 3},
|
||||
{"matrix": [3, 9], "x": 9, "y": 3},
|
||||
{"matrix": [3, 10], "x": 10, "y": 3},
|
||||
{"matrix": [3, 11], "x": 11, "y": 3}
|
||||
]
|
||||
},
|
||||
"LAYOUT_ortho_4x12_2x2bar": {
|
||||
"layout": [
|
||||
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||
{"matrix": [0, 10], "x": 10, "y": 0},
|
||||
{"matrix": [0, 11], "x": 11, "y": 0},
|
||||
{"matrix": [1, 0], "x": 0, "y": 1},
|
||||
{"matrix": [1, 1], "x": 1, "y": 1},
|
||||
{"matrix": [1, 2], "x": 2, "y": 1},
|
||||
{"matrix": [1, 3], "x": 3, "y": 1},
|
||||
{"matrix": [1, 4], "x": 4, "y": 1},
|
||||
{"matrix": [1, 5], "x": 5, "y": 1},
|
||||
{"matrix": [1, 6], "x": 6, "y": 1},
|
||||
{"matrix": [1, 7], "x": 7, "y": 1},
|
||||
{"matrix": [1, 8], "x": 8, "y": 1},
|
||||
{"matrix": [1, 9], "x": 9, "y": 1},
|
||||
{"matrix": [1, 10], "x": 10, "y": 1},
|
||||
{"matrix": [1, 11], "x": 11, "y": 1},
|
||||
{"matrix": [2, 0], "x": 0, "y": 2},
|
||||
{"matrix": [2, 1], "x": 1, "y": 2},
|
||||
{"matrix": [2, 2], "x": 2, "y": 2},
|
||||
{"matrix": [2, 3], "x": 3, "y": 2},
|
||||
{"matrix": [2, 4], "x": 4, "y": 2},
|
||||
{"matrix": [2, 5], "x": 5, "y": 2},
|
||||
{"matrix": [2, 6], "x": 6, "y": 2},
|
||||
{"matrix": [2, 7], "x": 7, "y": 2},
|
||||
{"matrix": [2, 8], "x": 8, "y": 2},
|
||||
{"matrix": [2, 9], "x": 9, "y": 2},
|
||||
{"matrix": [2, 10], "x": 10, "y": 2},
|
||||
{"matrix": [2, 11], "x": 11, "y": 2},
|
||||
{"matrix": [3, 0], "x": 0, "y": 3},
|
||||
{"matrix": [3, 1], "x": 1, "y": 3},
|
||||
{"matrix": [3, 2], "x": 2, "y": 3},
|
||||
{"matrix": [3, 3], "x": 3, "y": 3},
|
||||
{"matrix": [3, 5], "x": 4, "y": 3, "w": 2},
|
||||
{"matrix": [3, 7], "x": 6, "y": 3, "w": 2},
|
||||
{"matrix": [3, 8], "x": 8, "y": 3},
|
||||
{"matrix": [3, 9], "x": 9, "y": 3},
|
||||
{"matrix": [3, 10], "x": 10, "y": 3},
|
||||
{"matrix": [3, 11], "x": 11, "y": 3}
|
||||
]
|
||||
},
|
||||
"LAYOUT_planck_mit": {
|
||||
"layout": [
|
||||
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||
{"matrix": [0, 10], "x": 10, "y": 0},
|
||||
{"matrix": [0, 11], "x": 11, "y": 0},
|
||||
{"matrix": [1, 0], "x": 0, "y": 1},
|
||||
{"matrix": [1, 1], "x": 1, "y": 1},
|
||||
{"matrix": [1, 2], "x": 2, "y": 1},
|
||||
{"matrix": [1, 3], "x": 3, "y": 1},
|
||||
{"matrix": [1, 4], "x": 4, "y": 1},
|
||||
{"matrix": [1, 5], "x": 5, "y": 1},
|
||||
{"matrix": [1, 6], "x": 6, "y": 1},
|
||||
{"matrix": [1, 7], "x": 7, "y": 1},
|
||||
{"matrix": [1, 8], "x": 8, "y": 1},
|
||||
{"matrix": [1, 9], "x": 9, "y": 1},
|
||||
{"matrix": [1, 10], "x": 10, "y": 1},
|
||||
{"matrix": [1, 11], "x": 11, "y": 1},
|
||||
{"matrix": [2, 0], "x": 0, "y": 2},
|
||||
{"matrix": [2, 1], "x": 1, "y": 2},
|
||||
{"matrix": [2, 2], "x": 2, "y": 2},
|
||||
{"matrix": [2, 3], "x": 3, "y": 2},
|
||||
{"matrix": [2, 4], "x": 4, "y": 2},
|
||||
{"matrix": [2, 5], "x": 5, "y": 2},
|
||||
{"matrix": [2, 6], "x": 6, "y": 2},
|
||||
{"matrix": [2, 7], "x": 7, "y": 2},
|
||||
{"matrix": [2, 8], "x": 8, "y": 2},
|
||||
{"matrix": [2, 9], "x": 9, "y": 2},
|
||||
{"matrix": [2, 10], "x": 10, "y": 2},
|
||||
{"matrix": [2, 11], "x": 11, "y": 2},
|
||||
{"matrix": [3, 0], "x": 0, "y": 3},
|
||||
{"matrix": [3, 1], "x": 1, "y": 3},
|
||||
{"matrix": [3, 2], "x": 2, "y": 3},
|
||||
{"matrix": [3, 3], "x": 3, "y": 3},
|
||||
{"matrix": [3, 4], "x": 4, "y": 3},
|
||||
{"matrix": [3, 6], "x": 5, "y": 3, "w": 2},
|
||||
{"matrix": [3, 7], "x": 7, "y": 3},
|
||||
{"matrix": [3, 8], "x": 8, "y": 3},
|
||||
{"matrix": [3, 9], "x": 9, "y": 3},
|
||||
{"matrix": [3, 10], "x": 10, "y": 3},
|
||||
{"matrix": [3, 11], "x": 11, "y": 3}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
// Copyright 2024 Andrew Kannan
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
#include QMK_KEYBOARD_H
|
||||
|
||||
enum custom_layers {
|
||||
_BASE,
|
||||
_RAISE,
|
||||
_LOWER,
|
||||
};
|
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||
|
||||
/* Qwerty
|
||||
* ,-----------------------------------------------------------------------------------.
|
||||
* | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
|
||||
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
||||
* | Esc | A | S | D | F | G | H | J | K | L | ; | " |
|
||||
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
||||
* | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
|
||||
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
||||
* | ` | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
|
||||
* `-----------------------------------------------------------------------------------'
|
||||
*/
|
||||
[_BASE] = LAYOUT_ortho_4x12(
|
||||
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
|
||||
KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
|
||||
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
|
||||
KC_GRV, KC_LCTL, KC_LALT, KC_LGUI, MO(_LOWER), KC_SPC, KC_SPC, MO(_RAISE), KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
|
||||
),
|
||||
/* Lower
|
||||
* ,-----------------------------------------------------------------------------------.
|
||||
* | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
|
||||
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
||||
* | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
|
||||
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
||||
* | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
|
||||
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
||||
* | | | | | | | | Next | Vol- | Vol+ | Play |
|
||||
* `-----------------------------------------------------------------------------------'
|
||||
*/
|
||||
[_LOWER] = LAYOUT_ortho_4x12(
|
||||
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
|
||||
KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
|
||||
_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______,
|
||||
QK_BOOT, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
|
||||
),
|
||||
|
||||
/* Raise
|
||||
* ,-----------------------------------------------------------------------------------.
|
||||
* | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
|
||||
* |------+------+------+------+------+-------------+------+------+------+------+------|
|
||||
* | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
|
||||
* |------+------+------+------+------+------|------+------+------+------+------+------|
|
||||
* | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
|
||||
* |------+------+------+------+------+------+------+------+------+------+------+------|
|
||||
* | | | | | | | | Next | Vol- | Vol+ | Play |
|
||||
* `-----------------------------------------------------------------------------------'
|
||||
*/
|
||||
[_RAISE] = LAYOUT_ortho_4x12(
|
||||
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
|
||||
KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
|
||||
_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______,
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
|
||||
),
|
||||
};
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# Minimi40 Ortho
|
||||
|
||||
* Hardware Supported: STM32F072CBT6/APM32F072CBT6
|
||||
|
||||
Make example for this keyboard (after setting up your build environment):
|
||||
|
||||
make cannonkeys/minimi40/ortho:default
|
||||
|
||||
Flashing example for this keyboard:
|
||||
|
||||
make cannonkeys/minimi40/ortho:default:flash
|
||||
|
||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||
|
||||
## Bootloader
|
||||
|
||||
Enter the bootloader in 3 ways:
|
||||
|
||||
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
|
||||
* **Physical reset button**: Toggle the switch on the back of the pcb to "1" and briefly press the button on the back of the PCB
|
||||
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
|
||||
@@ -0,0 +1,3 @@
|
||||
# Wildcard to allow APM32 MCU
|
||||
DFU_SUFFIX_ARGS = -v FFFF -p FFFF
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# Minimi40
|
||||
|
||||
This has both the ortho and staggered versions of the wired Minimi40 PCBs
|
||||
The hotswap and solderable versions use the same firmware.
|
||||
|
||||
This firmware can also be used on the GEON F1-40
|
||||
|
||||
Please check each folder's README for more details.
|
||||
|
||||
* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
|
||||
* Hardware Availability: [CannonKeys](https://cannonkeys.com)
|
||||
@@ -0,0 +1,9 @@
|
||||
// Copyright 2024 Andrew Kannan
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
|
||||
#pragma once
|
||||
|
||||
#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET
|
||||
#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET_TIMEOUT 500U
|
||||
|
||||
#define PICO_XOSC_STARTUP_DELAY_MULTIPLIER 64
|
||||
@@ -0,0 +1,116 @@
|
||||
{
|
||||
"manufacturer": "CannonKeys",
|
||||
"keyboard_name": "Minimi40 Staggered",
|
||||
"maintainer": "awkannan",
|
||||
"bootloader": "rp2040",
|
||||
"diode_direction": "COL2ROW",
|
||||
"features": {
|
||||
"bootmagic": true,
|
||||
"extrakey": true,
|
||||
"mousekey": true,
|
||||
"nkro": true
|
||||
},
|
||||
"matrix_pins": {
|
||||
"cols": ["GP28", "GP8", "GP10", "GP7", "GP6", "GP5", "GP4", "GP3", "GP2", "GP1", "GP0"],
|
||||
"rows": ["GP17", "GP27", "GP11", "GP12"]
|
||||
},
|
||||
"processor": "RP2040",
|
||||
"url": "https://cannonkeys.com",
|
||||
"usb": {
|
||||
"device_version": "0.0.1",
|
||||
"pid": "0x0036",
|
||||
"vid": "0xCA04"
|
||||
},
|
||||
"layouts": {
|
||||
"LAYOUT_all": {
|
||||
"layout": [
|
||||
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||
{"matrix": [3, 7], "x": 10, "y": 0},
|
||||
{"matrix": [0, 10], "x": 11, "y": 0},
|
||||
{"matrix": [1, 0], "x": 0, "y": 1, "w": 1.25},
|
||||
{"matrix": [1, 1], "x": 1.25, "y": 1},
|
||||
{"matrix": [1, 2], "x": 2.25, "y": 1},
|
||||
{"matrix": [1, 3], "x": 3.25, "y": 1},
|
||||
{"matrix": [1, 4], "x": 4.25, "y": 1},
|
||||
{"matrix": [1, 5], "x": 5.25, "y": 1},
|
||||
{"matrix": [1, 6], "x": 6.25, "y": 1},
|
||||
{"matrix": [1, 7], "x": 7.25, "y": 1},
|
||||
{"matrix": [1, 8], "x": 8.25, "y": 1},
|
||||
{"matrix": [1, 9], "x": 9.25, "y": 1},
|
||||
{"matrix": [1, 10], "x": 10.25, "y": 1, "w": 1.75},
|
||||
{"matrix": [2, 0], "x": 0, "y": 2, "w": 1.75},
|
||||
{"matrix": [2, 1], "x": 1.75, "y": 2},
|
||||
{"matrix": [2, 2], "x": 2.75, "y": 2},
|
||||
{"matrix": [2, 3], "x": 3.75, "y": 2},
|
||||
{"matrix": [2, 4], "x": 4.75, "y": 2},
|
||||
{"matrix": [2, 5], "x": 5.75, "y": 2},
|
||||
{"matrix": [2, 6], "x": 6.75, "y": 2},
|
||||
{"matrix": [2, 7], "x": 7.75, "y": 2},
|
||||
{"matrix": [2, 8], "x": 8.75, "y": 2},
|
||||
{"matrix": [2, 9], "x": 9.75, "y": 2},
|
||||
{"matrix": [2, 10], "x": 10.75, "y": 2, "w": 1.25},
|
||||
{"matrix": [3, 0], "x": 0, "y": 3, "w": 1.25},
|
||||
{"matrix": [3, 1], "x": 1.25, "y": 3},
|
||||
{"matrix": [3, 2], "x": 2.25, "y": 3, "w": 1.25},
|
||||
{"matrix": [3, 4], "x": 3.5, "y": 3, "w": 2.25},
|
||||
{"matrix": [3, 6], "x": 5.75, "y": 3, "w": 2.75},
|
||||
{"matrix": [3, 8], "x": 8.5, "y": 3, "w": 1.25},
|
||||
{"matrix": [3, 9], "x": 9.75, "y": 3},
|
||||
{"matrix": [3, 10], "x": 10.75, "y": 3, "w": 1.25}
|
||||
]
|
||||
},
|
||||
"LAYOUT_full_space": {
|
||||
"layout": [
|
||||
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||
{"matrix": [0, 4], "x": 4, "y": 0},
|
||||
{"matrix": [0, 5], "x": 5, "y": 0},
|
||||
{"matrix": [0, 6], "x": 6, "y": 0},
|
||||
{"matrix": [0, 7], "x": 7, "y": 0},
|
||||
{"matrix": [0, 8], "x": 8, "y": 0},
|
||||
{"matrix": [0, 9], "x": 9, "y": 0},
|
||||
{"matrix": [3, 7], "x": 10, "y": 0},
|
||||
{"matrix": [0, 10], "x": 11, "y": 0},
|
||||
{"matrix": [1, 0], "x": 0, "y": 1, "w": 1.25},
|
||||
{"matrix": [1, 1], "x": 1.25, "y": 1},
|
||||
{"matrix": [1, 2], "x": 2.25, "y": 1},
|
||||
{"matrix": [1, 3], "x": 3.25, "y": 1},
|
||||
{"matrix": [1, 4], "x": 4.25, "y": 1},
|
||||
{"matrix": [1, 5], "x": 5.25, "y": 1},
|
||||
{"matrix": [1, 6], "x": 6.25, "y": 1},
|
||||
{"matrix": [1, 7], "x": 7.25, "y": 1},
|
||||
{"matrix": [1, 8], "x": 8.25, "y": 1},
|
||||
{"matrix": [1, 9], "x": 9.25, "y": 1},
|
||||
{"matrix": [1, 10], "x": 10.25, "y": 1, "w": 1.75},
|
||||
{"matrix": [2, 0], "x": 0, "y": 2, "w": 1.75},
|
||||
{"matrix": [2, 1], "x": 1.75, "y": 2},
|
||||
{"matrix": [2, 2], "x": 2.75, "y": 2},
|
||||
{"matrix": [2, 3], "x": 3.75, "y": 2},
|
||||
{"matrix": [2, 4], "x": 4.75, "y": 2},
|
||||
{"matrix": [2, 5], "x": 5.75, "y": 2},
|
||||
{"matrix": [2, 6], "x": 6.75, "y": 2},
|
||||
{"matrix": [2, 7], "x": 7.75, "y": 2},
|
||||
{"matrix": [2, 8], "x": 8.75, "y": 2},
|
||||
{"matrix": [2, 9], "x": 9.75, "y": 2},
|
||||
{"matrix": [2, 10], "x": 10.75, "y": 2, "w": 1.25},
|
||||
{"matrix": [3, 0], "x": 0, "y": 3, "w": 1.25},
|
||||
{"matrix": [3, 1], "x": 1.25, "y": 3},
|
||||
{"matrix": [3, 4], "x": 2.25, "y": 3, "w": 6.25},
|
||||
{"matrix": [3, 8], "x": 8.5, "y": 3, "w": 1.25},
|
||||
{"matrix": [3, 9], "x": 9.75, "y": 3},
|
||||
{"matrix": [3, 10], "x": 10.75, "y": 3, "w": 1.25}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
// Copyright 2024 Andrew Kannan
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
#include QMK_KEYBOARD_H
|
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||
|
||||
[0] = LAYOUT_all(
|
||||
KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
|
||||
KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_ENT,
|
||||
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_RSFT, MO(2),
|
||||
KC_LCTL, KC_LGUI, KC_LALT, LT(1, KC_SPC), KC_SPC, KC_RALT, MO(1), KC_RCTL
|
||||
),
|
||||
[1] = LAYOUT_all(
|
||||
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL,
|
||||
_______, _______, _______, _______, _______, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, _______,
|
||||
_______, _______, _______, _______, _______, KC_SLSH, KC_SCLN, KC_QUOT, KC_DOT, KC_UP, _______,
|
||||
_______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RIGHT
|
||||
),
|
||||
[2] = LAYOUT_all(
|
||||
_______, KC_F1, KC_F2, KC_F3, KC_F4, _______, _______, _______, _______, _______, _______, KC_DEL,
|
||||
_______, KC_F5, KC_F6, KC_F7, KC_F8, _______, _______, _______, _______, _______, _______,
|
||||
KC_CAPS, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______, _______, _______, _______,
|
||||
_______, _______, _______, _______, _______, KC_PGUP, _______, KC_PGDN
|
||||
)
|
||||
};
|
||||
@@ -0,0 +1,21 @@
|
||||
# Minimi40 Staggered
|
||||
|
||||
* Hardware Supported: RP2040
|
||||
|
||||
Make example for this keyboard (after setting up your build environment):
|
||||
|
||||
make cannonkeys/minimi40/staggered:default
|
||||
|
||||
Flashing example for this keyboard:
|
||||
|
||||
make cannonkeys/minimi40/staggered:default:flash
|
||||
|
||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||
|
||||
## Bootloader
|
||||
|
||||
Enter the bootloader in 3 ways:
|
||||
|
||||
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
|
||||
* **Physical reset button**: Hold the "BOOTMODE" button on the back of the PCB and briefly press the "RESET" button on the back of the PCB
|
||||
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
|
||||
@@ -157,32 +157,3 @@ bool rgb_matrix_indicators_advanced_kb(uint8_t led_min, uint8_t led_max) {
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
|
||||
if (!process_record_user(keycode, record)) {
|
||||
return false;
|
||||
}
|
||||
switch (keycode) {
|
||||
#ifdef RGB_MATRIX_ENABLE
|
||||
case QK_RGB_MATRIX_TOGGLE:
|
||||
if (record->event.pressed) {
|
||||
switch (rgb_matrix_get_flags()) {
|
||||
case LED_FLAG_ALL: {
|
||||
rgb_matrix_set_flags(LED_FLAG_NONE);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
} break;
|
||||
default: {
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
} break;
|
||||
}
|
||||
}
|
||||
if (!rgb_matrix_is_enabled()) {
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
rgb_matrix_enable();
|
||||
}
|
||||
return false;
|
||||
#endif
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
{
|
||||
"board": "GENERIC_RP_RP2040",
|
||||
"bootloader": "rp2040",
|
||||
"diode_direction": "COL2ROW",
|
||||
"features": {
|
||||
"bootmagic": true,
|
||||
"extrakey": true,
|
||||
"mousekey": true
|
||||
},
|
||||
"processor": "RP2040",
|
||||
"ps2": {
|
||||
"driver": "vendor",
|
||||
"enabled": true,
|
||||
"mouse_enabled": true
|
||||
},
|
||||
"layouts": {
|
||||
"LAYOUT_iso": {
|
||||
"layout": [
|
||||
{"label": "Esc", "matrix": [5, 0], "x": 0, "y": 0, "w": 0.9, "h": 0.75},
|
||||
{"label": "Mute", "matrix": [4, 10], "x": 0.9, "y": 0, "w": 0.75, "h": 0.5},
|
||||
{"label": "Vol -", "matrix": [3, 10], "x": 1.65, "y": 0, "w": 0.75, "h": 0.5},
|
||||
{"label": "Vol +", "matrix": [2, 10], "x": 2.4, "y": 0, "w": 0.75, "h": 0.5},
|
||||
{"label": "ThinkVantage", "matrix": [5, 10], "x": 3.5, "y": 0, "w": 1.25, "h": 0.5},
|
||||
{"label": "PrtSc", "matrix": [1, 13], "x": 8.9, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "ScrLk", "matrix": [2, 13], "x": 9.8, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "Pause", "matrix": [6, 12], "x": 10.7, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "Insert", "matrix": [0, 9], "x": 12, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "Home", "matrix": [0, 12], "x": 12.9, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "PgUp", "matrix": [0, 11], "x": 13.8, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "F1", "matrix": [0, 1], "x": 0, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F2", "matrix": [0, 2], "x": 0.9, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F3", "matrix": [3, 2], "x": 1.8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F4", "matrix": [5, 2], "x": 2.7, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F5", "matrix": [5, 8], "x": 4, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F6", "matrix": [5, 5], "x": 4.9, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F7", "matrix": [3, 6], "x": 5.8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F8", "matrix": [0, 6], "x": 6.7, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F9", "matrix": [0, 8], "x": 8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F10", "matrix": [1, 8], "x": 8.9, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F11", "matrix": [1, 10], "x": 9.8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F12", "matrix": [1, 9], "x": 10.7, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "Delete", "matrix": [0, 10], "x": 12, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "End", "matrix": [1, 12], "x": 12.9, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "PgDn", "matrix": [1, 11], "x": 13.8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "`\u00ac", "matrix": [0, 0], "x": 0, "y": 1.4},
|
||||
{"label": "1!", "matrix": [1, 0], "x": 1, "y": 1.4},
|
||||
{"label": "2\"", "matrix": [1, 1], "x": 2, "y": 1.4},
|
||||
{"label": "3\u00a3", "matrix": [1, 2], "x": 3, "y": 1.4},
|
||||
{"label": "4$", "matrix": [1, 3], "x": 4, "y": 1.4},
|
||||
{"label": "5%", "matrix": [0, 3], "x": 5, "y": 1.4},
|
||||
{"label": "6^", "matrix": [0, 4], "x": 6, "y": 1.4},
|
||||
{"label": "7&", "matrix": [1, 4], "x": 7, "y": 1.4},
|
||||
{"label": "8*", "matrix": [1, 5], "x": 8, "y": 1.4},
|
||||
{"label": "9(", "matrix": [1, 6], "x": 9, "y": 1.4},
|
||||
{"label": "0)", "matrix": [1, 7], "x": 10, "y": 1.4},
|
||||
{"label": "-_", "matrix": [0, 7], "x": 11, "y": 1.4},
|
||||
{"label": "=+", "matrix": [0, 5], "x": 12, "y": 1.4},
|
||||
{"label": "Bksp", "matrix": [3, 8], "x": 13, "y": 1.4, "w": 2},
|
||||
{"label": "Tab", "matrix": [3, 0], "x": 0, "y": 2.4, "w": 1.5},
|
||||
{"label": "Q", "matrix": [2, 0], "x": 1.5, "y": 2.4},
|
||||
{"label": "W", "matrix": [2, 1], "x": 2.5, "y": 2.4},
|
||||
{"label": "E", "matrix": [2, 2], "x": 3.5, "y": 2.4},
|
||||
{"label": "R", "matrix": [2, 3], "x": 4.5, "y": 2.4},
|
||||
{"label": "T", "matrix": [3, 3], "x": 5.5, "y": 2.4},
|
||||
{"label": "Y", "matrix": [3, 4], "x": 6.5, "y": 2.4},
|
||||
{"label": "U", "matrix": [2, 4], "x": 7.5, "y": 2.4},
|
||||
{"label": "I", "matrix": [2, 5], "x": 8.5, "y": 2.4},
|
||||
{"label": "O", "matrix": [2, 6], "x": 9.5, "y": 2.4},
|
||||
{"label": "P", "matrix": [2, 7], "x": 10.5, "y": 2.4},
|
||||
{"label": "[{", "matrix": [3, 7], "x": 11.5, "y": 2.4},
|
||||
{"label": "]}", "matrix": [3, 5], "x": 12.5, "y": 2.4},
|
||||
{"label": "Caps Lock", "matrix": [3, 1], "x": 0, "y": 3.4, "w": 1.75},
|
||||
{"label": "A", "matrix": [4, 0], "x": 1.75, "y": 3.4},
|
||||
{"label": "S", "matrix": [4, 1], "x": 2.75, "y": 3.4},
|
||||
{"label": "D", "matrix": [4, 2], "x": 3.75, "y": 3.4},
|
||||
{"label": "F", "matrix": [4, 3], "x": 4.75, "y": 3.4},
|
||||
{"label": "G", "matrix": [5, 3], "x": 5.75, "y": 3.4},
|
||||
{"label": "H", "matrix": [5, 4], "x": 6.75, "y": 3.4},
|
||||
{"label": "J", "matrix": [4, 4], "x": 7.75, "y": 3.4},
|
||||
{"label": "K", "matrix": [4, 5], "x": 8.75, "y": 3.4},
|
||||
{"label": "L", "matrix": [4, 6], "x": 9.75, "y": 3.4},
|
||||
{"label": ";:", "matrix": [4, 7], "x": 10.75, "y": 3.4},
|
||||
{"label": "'@", "matrix": [5, 7], "x": 11.75, "y": 3.4},
|
||||
{"label": "#~", "matrix": [6, 7], "x": 12.75, "y": 3.4},
|
||||
{"label": "Enter", "matrix": [6, 8], "x": 13.75, "y": 2.4, "w": 1.25, "h": 2},
|
||||
{"label": "Shift", "matrix": [3, 14], "x": 0, "y": 4.4, "w": 1.25},
|
||||
{"label": "\\|", "matrix": [5, 1], "x": 1.25, "y": 4.4},
|
||||
{"label": "Z", "matrix": [6, 0], "x": 2.25, "y": 4.4},
|
||||
{"label": "X", "matrix": [6, 1], "x": 3.25, "y": 4.4},
|
||||
{"label": "C", "matrix": [6, 2], "x": 4.25, "y": 4.4},
|
||||
{"label": "V", "matrix": [6, 3], "x": 5.25, "y": 4.4},
|
||||
{"label": "B", "matrix": [7, 3], "x": 6.25, "y": 4.4},
|
||||
{"label": "N", "matrix": [7, 4], "x": 7.25, "y": 4.4},
|
||||
{"label": "M", "matrix": [6, 4], "x": 8.25, "y": 4.4},
|
||||
{"label": ",<", "matrix": [6, 5], "x": 9.25, "y": 4.4},
|
||||
{"label": ".>", "matrix": [6, 6], "x": 10.25, "y": 4.4},
|
||||
{"label": "/?", "matrix": [7, 7], "x": 11.25, "y": 4.4},
|
||||
{"label": "Shift", "matrix": [6, 14], "x": 12.25, "y": 4.4, "w": 2.75},
|
||||
{"label": "Fn", "matrix": [4, 9], "x": 0, "y": 5.4},
|
||||
{"label": "Ctrl", "matrix": [0, 15], "x": 1, "y": 5.4, "w": 1.25},
|
||||
{"label": "Left OS", "matrix": [2, 11], "x": 2.25, "y": 5.4, "w": 0.9},
|
||||
{"label": "Alt", "matrix": [5, 13], "x": 3.15, "y": 5.4},
|
||||
{"label": "Space", "matrix": [7, 8], "x": 4.15, "y": 5.4, "w": 5},
|
||||
{"label": "AltGr", "matrix": [7, 13], "x": 9.25, "y": 5.4},
|
||||
{"label": "Menu", "matrix": [4, 11], "x": 10.25, "y": 5.4},
|
||||
{"label": "Ctrl", "matrix": [6, 15], "x": 11.25, "y": 5.4},
|
||||
{"label": "Browser Back", "matrix": [6, 11], "x": 12.25, "y": 5.4, "w": 0.9, "h": 0.75},
|
||||
{"label": "Up", "matrix": [5, 12], "x": 13.15, "y": 5.4, "w": 0.9, "h": 0.75},
|
||||
{"label": "Browser Forward", "matrix": [7, 11], "x": 14.05, "y": 5.4, "w": 0.9, "h": 0.75},
|
||||
{"label": "Left", "matrix": [7, 12], "x": 12.25, "y": 6.15, "w": 0.9, "h": 0.75},
|
||||
{"label": "Down", "matrix": [7, 10], "x": 13.15, "y": 6.15, "w": 0.9, "h": 0.75},
|
||||
{"label": "Right", "matrix": [7, 9], "x": 14.05, "y": 6.15, "w": 0.9, "h": 0.75}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"manufacturer": "Frank Adams",
|
||||
"keyboard_name": "converter/thinkpad_t6x/pico_t61",
|
||||
"maintainer": "Al En",
|
||||
"matrix_pins": {
|
||||
"cols": ["GP27", "GP26", "GP17", "GP14", "GP12", "GP19", "GP18", "GP15", "GP13", "GP6", "GP16", "GP5", "GP28", "GP2", "GP4", "GP3"],
|
||||
"rows": ["GP11", "GP22", "GP10", "GP21", "GP9", "GP20", "GP8", "GP7"]
|
||||
},
|
||||
"ps2": {
|
||||
"clock_pin": "GP0",
|
||||
"data_pin": "GP1"
|
||||
},
|
||||
"url": "https://github.com/thedalles77/USB_Laptop_Keyboard_Controller/tree/master/Example_Keyboards/Pico_T61_Keyboard",
|
||||
"usb": {
|
||||
"device_version": "1.0.0",
|
||||
"pid": "0xBACA",
|
||||
"vid": "0xFEED"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
# converter/thinkpad_t6x/pico_t61
|
||||
|
||||

|
||||
|
||||
This is a converter PCB for Lenovo Thinkpad keyboards from T60, T400 and X200 series, based on the Raspberry Pi Pico W. The QMK implementation here is specific to the converter in the link below. Similar PCB designs to convert a Thinkpad keyboard to USB exist, but they use a different microcontroller and wiring of the keyboard connector with the MCU.
|
||||
|
||||
* Keyboard Maintainer: [Al En](https://github.com/gitaen)
|
||||
* Hardware Supported: The linked converter PCB with keyboards from various Thinkpad models
|
||||
* Hardware Availability: [Custom PCB](https://github.com/thedalles77/USB_Laptop_Keyboard_Controller/tree/master/Example_Keyboards/Pico_T61_Keyboard)
|
||||
|
||||
Make example for this keyboard (after setting up your build environment):
|
||||
|
||||
make converter/thinkpad_t6x/pico_t61:default
|
||||
|
||||
Flashing example for this keyboard:
|
||||
|
||||
make converter/thinkpad_t6x/pico_t61:default:flash
|
||||
|
||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||
|
||||
## Bootloader
|
||||
|
||||
Enter the bootloader in 3 ways:
|
||||
|
||||
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (\`~) and plug in the keyboard
|
||||
* **Physical BOOTSEL button**: Hold down the BOOTSEL button on the Raspberry PiPico W and plug the keyboard
|
||||
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
|
||||
@@ -2,130 +2,18 @@
|
||||
"manufacturer": "strobo5",
|
||||
"keyboard_name": "converter/thinkpad_t6x/rpi_pico",
|
||||
"maintainer": "strobo5",
|
||||
"board": "GENERIC_RP_RP2040",
|
||||
"bootloader": "rp2040",
|
||||
"diode_direction": "COL2ROW",
|
||||
"features": {
|
||||
"bootmagic": true,
|
||||
"extrakey": true,
|
||||
"mousekey": true
|
||||
},
|
||||
"matrix_pins": {
|
||||
"cols": ["GP7", "GP9", "GP11", "GP13", "GP17", "GP16", "GP14", "GP12", "GP15", "GP8", "GP10", "GP6", "GP4", "GP2", "GP5", "GP3"],
|
||||
"rows": ["GP20", "GP26", "GP22", "GP21", "GP18", "GP19", "GP27", "GP28"]
|
||||
},
|
||||
"processor": "RP2040",
|
||||
"ps2": {
|
||||
"clock_pin": "GP1",
|
||||
"data_pin": "GP0",
|
||||
"driver": "vendor",
|
||||
"enabled": true,
|
||||
"mouse_enabled": true
|
||||
"data_pin": "GP0"
|
||||
},
|
||||
"url": "https://github.com/strobo5/T61_PiPico_Scanner",
|
||||
"usb": {
|
||||
"device_version": "1.0.0",
|
||||
"pid": "0x0000",
|
||||
"vid": "0xFEED"
|
||||
},
|
||||
"layouts": {
|
||||
"LAYOUT_iso": {
|
||||
"layout": [
|
||||
{"label": "Esc", "matrix": [5, 0], "x": 0, "y": 0, "w": 0.9, "h": 0.75},
|
||||
{"label": "Mute", "matrix": [4, 10], "x": 0.9, "y": 0, "w": 0.75, "h": 0.5},
|
||||
{"label": "Vol -", "matrix": [3, 10], "x": 1.65, "y": 0, "w": 0.75, "h": 0.5},
|
||||
{"label": "Vol +", "matrix": [2, 10], "x": 2.4, "y": 0, "w": 0.75, "h": 0.5},
|
||||
{"label": "ThinkVantage", "matrix": [5, 10], "x": 3.5, "y": 0, "w": 1.25, "h": 0.5},
|
||||
{"label": "PrtSc", "matrix": [1, 13], "x": 8.9, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "ScrLk", "matrix": [2, 13], "x": 9.8, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "Pause", "matrix": [6, 12], "x": 10.7, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "Insert", "matrix": [0, 9], "x": 12, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "Home", "matrix": [0, 12], "x": 12.9, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "PgUp", "matrix": [0, 11], "x": 13.8, "y": 0, "w": 0.9, "h": 0.65},
|
||||
{"label": "F1", "matrix": [0, 1], "x": 0, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F2", "matrix": [0, 2], "x": 0.9, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F3", "matrix": [3, 2], "x": 1.8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F4", "matrix": [5, 2], "x": 2.7, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F5", "matrix": [5, 8], "x": 4, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F6", "matrix": [5, 5], "x": 4.9, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F7", "matrix": [3, 6], "x": 5.8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F8", "matrix": [0, 6], "x": 6.7, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F9", "matrix": [0, 8], "x": 8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F10", "matrix": [1, 8], "x": 8.9, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F11", "matrix": [1, 10], "x": 9.8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "F12", "matrix": [1, 9], "x": 10.7, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "Delete", "matrix": [0, 10], "x": 12, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "End", "matrix": [1, 12], "x": 12.9, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "PgDn", "matrix": [1, 11], "x": 13.8, "y": 0.75, "w": 0.9, "h": 0.65},
|
||||
{"label": "`\u00ac", "matrix": [0, 0], "x": 0, "y": 1.4},
|
||||
{"label": "1!", "matrix": [1, 0], "x": 1, "y": 1.4},
|
||||
{"label": "2\"", "matrix": [1, 1], "x": 2, "y": 1.4},
|
||||
{"label": "3\u00a3", "matrix": [1, 2], "x": 3, "y": 1.4},
|
||||
{"label": "4$", "matrix": [1, 3], "x": 4, "y": 1.4},
|
||||
{"label": "5%", "matrix": [0, 3], "x": 5, "y": 1.4},
|
||||
{"label": "6^", "matrix": [0, 4], "x": 6, "y": 1.4},
|
||||
{"label": "7&", "matrix": [1, 4], "x": 7, "y": 1.4},
|
||||
{"label": "8*", "matrix": [1, 5], "x": 8, "y": 1.4},
|
||||
{"label": "9(", "matrix": [1, 6], "x": 9, "y": 1.4},
|
||||
{"label": "0)", "matrix": [1, 7], "x": 10, "y": 1.4},
|
||||
{"label": "-_", "matrix": [0, 7], "x": 11, "y": 1.4},
|
||||
{"label": "=+", "matrix": [0, 5], "x": 12, "y": 1.4},
|
||||
{"label": "Bksp", "matrix": [3, 8], "x": 13, "y": 1.4, "w": 2},
|
||||
{"label": "Tab", "matrix": [3, 0], "x": 0, "y": 2.4, "w": 1.5},
|
||||
{"label": "Q", "matrix": [2, 0], "x": 1.5, "y": 2.4},
|
||||
{"label": "W", "matrix": [2, 1], "x": 2.5, "y": 2.4},
|
||||
{"label": "E", "matrix": [2, 2], "x": 3.5, "y": 2.4},
|
||||
{"label": "R", "matrix": [2, 3], "x": 4.5, "y": 2.4},
|
||||
{"label": "T", "matrix": [3, 3], "x": 5.5, "y": 2.4},
|
||||
{"label": "Y", "matrix": [3, 4], "x": 6.5, "y": 2.4},
|
||||
{"label": "U", "matrix": [2, 4], "x": 7.5, "y": 2.4},
|
||||
{"label": "I", "matrix": [2, 5], "x": 8.5, "y": 2.4},
|
||||
{"label": "O", "matrix": [2, 6], "x": 9.5, "y": 2.4},
|
||||
{"label": "P", "matrix": [2, 7], "x": 10.5, "y": 2.4},
|
||||
{"label": "[{", "matrix": [3, 7], "x": 11.5, "y": 2.4},
|
||||
{"label": "]}", "matrix": [3, 5], "x": 12.5, "y": 2.4},
|
||||
{"label": "Caps Lock", "matrix": [3, 1], "x": 0, "y": 3.4, "w": 1.75},
|
||||
{"label": "A", "matrix": [4, 0], "x": 1.75, "y": 3.4},
|
||||
{"label": "S", "matrix": [4, 1], "x": 2.75, "y": 3.4},
|
||||
{"label": "D", "matrix": [4, 2], "x": 3.75, "y": 3.4},
|
||||
{"label": "F", "matrix": [4, 3], "x": 4.75, "y": 3.4},
|
||||
{"label": "G", "matrix": [5, 3], "x": 5.75, "y": 3.4},
|
||||
{"label": "H", "matrix": [5, 4], "x": 6.75, "y": 3.4},
|
||||
{"label": "J", "matrix": [4, 4], "x": 7.75, "y": 3.4},
|
||||
{"label": "K", "matrix": [4, 5], "x": 8.75, "y": 3.4},
|
||||
{"label": "L", "matrix": [4, 6], "x": 9.75, "y": 3.4},
|
||||
{"label": ";:", "matrix": [4, 7], "x": 10.75, "y": 3.4},
|
||||
{"label": "'@", "matrix": [5, 7], "x": 11.75, "y": 3.4},
|
||||
{"label": "#~", "matrix": [6, 7], "x": 12.75, "y": 3.4},
|
||||
{"label": "Enter", "matrix": [6, 8], "x": 13.75, "y": 2.4, "w": 1.25, "h": 2},
|
||||
{"label": "Shift", "matrix": [3, 14], "x": 0, "y": 4.4, "w": 1.25},
|
||||
{"label": "\\|", "matrix": [5, 1], "x": 1.25, "y": 4.4},
|
||||
{"label": "Z", "matrix": [6, 0], "x": 2.25, "y": 4.4},
|
||||
{"label": "X", "matrix": [6, 1], "x": 3.25, "y": 4.4},
|
||||
{"label": "C", "matrix": [6, 2], "x": 4.25, "y": 4.4},
|
||||
{"label": "V", "matrix": [6, 3], "x": 5.25, "y": 4.4},
|
||||
{"label": "B", "matrix": [7, 3], "x": 6.25, "y": 4.4},
|
||||
{"label": "N", "matrix": [7, 4], "x": 7.25, "y": 4.4},
|
||||
{"label": "M", "matrix": [6, 4], "x": 8.25, "y": 4.4},
|
||||
{"label": ",<", "matrix": [6, 5], "x": 9.25, "y": 4.4},
|
||||
{"label": ".>", "matrix": [6, 6], "x": 10.25, "y": 4.4},
|
||||
{"label": "/?", "matrix": [7, 7], "x": 11.25, "y": 4.4},
|
||||
{"label": "Shift", "matrix": [6, 14], "x": 12.25, "y": 4.4, "w": 2.75},
|
||||
{"label": "Fn", "matrix": [4, 9], "x": 0, "y": 5.4},
|
||||
{"label": "Ctrl", "matrix": [0, 15], "x": 1, "y": 5.4, "w": 1.25},
|
||||
{"label": "Left OS", "matrix": [2, 11], "x": 2.25, "y": 5.4, "w": 0.9},
|
||||
{"label": "Alt", "matrix": [5, 13], "x": 3.15, "y": 5.4},
|
||||
{"label": "Space", "matrix": [7, 8], "x": 4.15, "y": 5.4, "w": 5},
|
||||
{"label": "AltGr", "matrix": [7, 13], "x": 9.25, "y": 5.4},
|
||||
{"label": "Menu", "matrix": [4, 11], "x": 10.25, "y": 5.4},
|
||||
{"label": "Ctrl", "matrix": [6, 15], "x": 11.25, "y": 5.4},
|
||||
{"label": "Browser Back", "matrix": [6, 11], "x": 12.25, "y": 5.4, "w": 0.9, "h": 0.75},
|
||||
{"label": "Up", "matrix": [5, 12], "x": 13.15, "y": 5.4, "w": 0.9, "h": 0.75},
|
||||
{"label": "Browser Forward", "matrix": [7, 11], "x": 14.05, "y": 5.4, "w": 0.9, "h": 0.75},
|
||||
{"label": "Left", "matrix": [7, 12], "x": 12.25, "y": 6.15, "w": 0.9, "h": 0.75},
|
||||
{"label": "Down", "matrix": [7, 10], "x": 13.15, "y": 6.15, "w": 0.9, "h": 0.75},
|
||||
{"label": "Right", "matrix": [7, 9], "x": 14.05, "y": 6.15, "w": 0.9, "h": 0.75}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -17,7 +17,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
#pragma once
|
||||
|
||||
#define B7_AUDIO
|
||||
#define AUDIO_PIN B7
|
||||
|
||||
/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
|
||||
* This is useful for the Windows task manager shortcut (ctrl+shift+esc).
|
||||
|
||||
@@ -17,7 +17,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
#pragma once
|
||||
|
||||
#define B7_AUDIO
|
||||
#define AUDIO_PIN B7
|
||||
|
||||
/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
|
||||
* This is useful for the Windows task manager shortcut (ctrl+shift+esc).
|
||||
|
||||
@@ -6,32 +6,6 @@
|
||||
|
||||
#ifdef RGB_MATRIX_ENABLE
|
||||
|
||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
|
||||
if (!process_record_user(keycode, record)) {
|
||||
return false;
|
||||
}
|
||||
switch (keycode) {
|
||||
case RM_TOGG:
|
||||
if (record->event.pressed) {
|
||||
switch (rgb_matrix_get_flags()) {
|
||||
case LED_FLAG_ALL: {
|
||||
rgb_matrix_set_flags(LED_FLAG_NONE);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
} break;
|
||||
default: {
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
} break;
|
||||
}
|
||||
}
|
||||
if (!rgb_matrix_is_enabled()) {
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
rgb_matrix_enable();
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool rgb_matrix_indicators_kb(void) {
|
||||
if (!rgb_matrix_indicators_user()) {
|
||||
return false;
|
||||
|
||||
@@ -18,5 +18,4 @@
|
||||
#define IS31FL3733_I2C_ADDRESS_2 IS31FL3733_I2C_ADDRESS_VCC_VCC
|
||||
#define IS31FL3733_PWM_FREQUENCY IS31FL3733_PWM_FREQUENCY_26K7_HZ
|
||||
|
||||
#define RGB_MATRIX_CYCLE_ZONES_ENABLE
|
||||
#define RGB_MATRIX_CAPS_LOCK_INDEX 30
|
||||
|
||||
@@ -18,5 +18,4 @@
|
||||
#define IS31FL3733_I2C_ADDRESS_2 IS31FL3733_I2C_ADDRESS_VCC_VCC
|
||||
#define IS31FL3733_PWM_FREQUENCY IS31FL3733_PWM_FREQUENCY_26K7_HZ
|
||||
|
||||
#define RGB_MATRIX_CYCLE_ZONES_ENABLE
|
||||
#define RGB_MATRIX_CAPS_LOCK_INDEX 50
|
||||
|
||||
@@ -19,35 +19,4 @@ bool rgb_matrix_indicators_kb(void) {
|
||||
return true;
|
||||
}
|
||||
# endif
|
||||
|
||||
# ifdef RGB_MATRIX_CYCLE_ZONES_ENABLE
|
||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
|
||||
if (!process_record_user(keycode, record)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!record->event.pressed) {
|
||||
switch (keycode) {
|
||||
case QK_RGB_MATRIX_TOGGLE:
|
||||
switch (rgb_matrix_get_flags()) {
|
||||
case LED_FLAG_ALL:
|
||||
rgb_matrix_set_flags(LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER | LED_FLAG_INDICATOR);
|
||||
break;
|
||||
case (LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER | LED_FLAG_INDICATOR):
|
||||
rgb_matrix_set_flags(LED_FLAG_UNDERGLOW);
|
||||
break;
|
||||
case LED_FLAG_UNDERGLOW:
|
||||
rgb_matrix_set_flags(LED_FLAG_NONE);
|
||||
break;
|
||||
default:
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
break;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
};
|
||||
# endif
|
||||
|
||||
#endif
|
||||
|
||||
@@ -13,5 +13,4 @@
|
||||
#define IS31FL3733_I2C_ADDRESS_2 IS31FL3733_I2C_ADDRESS_VCC_VCC
|
||||
#define IS31FL3733_PWM_FREQUENCY IS31FL3733_PWM_FREQUENCY_26K7_HZ
|
||||
|
||||
#define RGB_MATRIX_CYCLE_ZONES_ENABLE
|
||||
#define RGB_MATRIX_CAPS_LOCK_INDEX 62
|
||||
|
||||
@@ -18,5 +18,3 @@
|
||||
#define IS31FL3733_I2C_ADDRESS_2 IS31FL3733_I2C_ADDRESS_VCC_VCC
|
||||
#define IS31FL3733_I2C_ADDRESS_3 IS31FL3733_I2C_ADDRESS_GND_GND
|
||||
#define IS31FL3733_PWM_FREQUENCY IS31FL3733_PWM_FREQUENCY_26K7_HZ
|
||||
|
||||
#define RGB_MATRIX_CYCLE_ZONES_ENABLE
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
#undef PERMISSIVE_HOLD
|
||||
|
||||
|
||||
#define FORCE_NKRO
|
||||
#define NKRO_DEFAULT_ON true
|
||||
|
||||
#ifndef TAPPING_TOGGLE
|
||||
#define TAPPING_TOGGLE 1
|
||||
|
||||
@@ -15,6 +15,11 @@
|
||||
"nkro": true,
|
||||
"rgblight": true
|
||||
},
|
||||
"host": {
|
||||
"default": {
|
||||
"nkro": true
|
||||
}
|
||||
},
|
||||
"qmk": {
|
||||
"locking": {
|
||||
"enabled": true,
|
||||
|
||||
@@ -16,4 +16,3 @@
|
||||
#pragma once
|
||||
|
||||
#define ONESHOT_TIMEOUT 2000
|
||||
#define FORCE_NKRO
|
||||
|
||||
@@ -7,6 +7,5 @@
|
||||
#define I2C1_SCL_PIN GP27
|
||||
#define I2C1_SDA_PIN GP26
|
||||
#define I2C_DRIVER I2CD1
|
||||
#define OLED_DISPLAY_128X32
|
||||
#define OLED_BRIGHTNESS 128
|
||||
#endif
|
||||
|
||||
@@ -101,39 +101,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||
),
|
||||
};
|
||||
|
||||
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
||||
switch (keycode) {
|
||||
case QK_RGB_MATRIX_TOGGLE:
|
||||
if (record->event.pressed) {
|
||||
switch (rgb_matrix_get_flags()) {
|
||||
case LED_FLAG_ALL: {
|
||||
rgb_matrix_set_flags(LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER | LED_FLAG_INDICATOR);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
}
|
||||
break;
|
||||
case (LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER | LED_FLAG_INDICATOR): {
|
||||
rgb_matrix_set_flags(LED_FLAG_UNDERGLOW);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
}
|
||||
break;
|
||||
case (LED_FLAG_UNDERGLOW): {
|
||||
rgb_matrix_set_flags(LED_FLAG_NONE);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
}
|
||||
break;
|
||||
default: {
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
rgb_matrix_enable_noeeprom();
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool rgb_matrix_indicators_user(void) {
|
||||
rgb_matrix_set_color(46, 0, 0, 0);
|
||||
rgb_matrix_set_color(104, 0, 0, 0);
|
||||
|
||||
@@ -25,38 +25,6 @@
|
||||
#include <math.h>
|
||||
#include <lib/lib8tion/lib8tion.h>
|
||||
|
||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
|
||||
switch (keycode) {
|
||||
case QK_RGB_MATRIX_TOGGLE:
|
||||
if (record->event.pressed) {
|
||||
switch (rgb_matrix_get_flags()) {
|
||||
case LED_FLAG_ALL: {
|
||||
rgb_matrix_set_flags(LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER | LED_FLAG_INDICATOR);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
}
|
||||
break;
|
||||
case (LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER | LED_FLAG_INDICATOR): {
|
||||
rgb_matrix_set_flags(LED_FLAG_UNDERGLOW);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
}
|
||||
break;
|
||||
case (LED_FLAG_UNDERGLOW): {
|
||||
rgb_matrix_set_flags(LED_FLAG_NONE);
|
||||
rgb_matrix_set_color_all(0, 0, 0);
|
||||
}
|
||||
break;
|
||||
default: {
|
||||
rgb_matrix_set_flags(LED_FLAG_ALL);
|
||||
rgb_matrix_enable_noeeprom();
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return process_record_user(keycode, record);
|
||||
}
|
||||
|
||||
bool rgb_matrix_indicators_kb(void) {
|
||||
if (!rgb_matrix_indicators_user()) {
|
||||
return false;
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
{
|
||||
"manufacturer": "Kenneth Fossen",
|
||||
"keyboard_name": "Bouvet Macropad v1",
|
||||
"maintainer": "spydx",
|
||||
"development_board": "promicro",
|
||||
"diode_direction": "COL2ROW",
|
||||
"features": {
|
||||
"extrakey": true,
|
||||
"mousekey": true,
|
||||
"nkro": true
|
||||
},
|
||||
"matrix_pins": {
|
||||
"cols": ["D7","E6","B4","B5"],
|
||||
"rows": ["B1", "B3", "B2", "B6"]
|
||||
},
|
||||
"encoders": {
|
||||
"rotary": [
|
||||
{"pin_a": "C6", "pin_b": "D4"},
|
||||
{"pin_a": "F6", "pin_b": "F7"}
|
||||
]
|
||||
},
|
||||
"url": "https://kefo.no",
|
||||
"usb": {
|
||||
"device_version": "1.0.0",
|
||||
"pid": "0x0000",
|
||||
"vid": "0xFEED"
|
||||
},
|
||||
"layouts": {
|
||||
"LAYOUT": {
|
||||
"layout": [
|
||||
{"matrix": [0, 0], "x": 0, "y": 0},
|
||||
{"matrix": [0, 1], "x": 1, "y": 0},
|
||||
{"matrix": [0, 2], "x": 2, "y": 0},
|
||||
{"matrix": [0, 3], "x": 3, "y": 0},
|
||||
|
||||
{"matrix": [1, 0], "x": 0, "y": 1},
|
||||
{"matrix": [1, 1], "x": 1, "y": 1},
|
||||
{"matrix": [1, 2], "x": 2, "y": 1},
|
||||
{"matrix": [1, 3], "x": 3, "y": 1},
|
||||
|
||||
{"matrix": [2, 0], "x": 0, "y": 2},
|
||||
{"matrix": [2, 1], "x": 1, "y": 2},
|
||||
{"matrix": [2, 2], "x": 2, "y": 2},
|
||||
{"matrix": [2, 3], "x": 3, "y": 2},
|
||||
|
||||
{"matrix": [3, 1], "x": 1, "y": 3},
|
||||
{"matrix": [3, 2], "x": 2, "y": 3}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
// Copyright 2026 Kenneth Fossen
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
|
||||
#include QMK_KEYBOARD_H
|
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||
[0] = LAYOUT(
|
||||
KC_MCTL, LCS(KC_TAB), C(KC_TAB), KC_MPLY,
|
||||
KC_P4, KC_P5, KC_P6, KC_PAST,
|
||||
KC_P1, KC_P2, KC_P3, KC_PENT,
|
||||
LCMD(KC_C), LCMD(KC_V)
|
||||
)
|
||||
};
|
||||
|
||||
#if defined(ENCODER_MAP_ENABLE)
|
||||
const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
|
||||
[0] = { ENCODER_CCW_CW(KC_MPRV, KC_MNXT), ENCODER_CCW_CW(KC_VOLD, KC_VOLU) }
|
||||
};
|
||||
#endif
|
||||
@@ -0,0 +1,27 @@
|
||||
# bouvet/macropad/v1
|
||||
|
||||

|
||||
Small macropad, with two rotary encoder buttons and 14 keys.
|
||||
Optional OLED 128x16 screen, small learning and sharing project.
|
||||
|
||||
* Keyboard Maintainer: [Kenneth Fossen](https://github.com/spydx)
|
||||
* Hardware Supported: Bouvet Macropad
|
||||
* Hardware Availability: [Shop](https://www.kefo.no/macropad)
|
||||
|
||||
Make example for this keyboard (after setting up your build environment):
|
||||
|
||||
make handwired/bouvet/macropad/v1:default
|
||||
|
||||
Flashing example for this keyboard:
|
||||
|
||||
make handwired/bouvet/macropad/v1:default:flash
|
||||
|
||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||
|
||||
## Bootloader
|
||||
|
||||
Enter the bootloader in 3 ways:
|
||||
|
||||
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
|
||||
* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
|
||||
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
|
||||
@@ -13,6 +13,11 @@
|
||||
"mousekey": true,
|
||||
"nkro": true
|
||||
},
|
||||
"host": {
|
||||
"default": {
|
||||
"nkro": true
|
||||
}
|
||||
},
|
||||
"matrix_pins": {
|
||||
"cols": ["C7", "C6", "B6", "B5", "B4", "D7", "D6", "D4"],
|
||||
"rows": ["D5", "D3", "D2", "D1", "D0", "B7"]
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
/*
|
||||
Copyright 2020 Ckat <ckat@teknik.io>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
/* ensure NKRO is on */
|
||||
#define FORCE_NKRO
|
||||
@@ -1,21 +0,0 @@
|
||||
/*
|
||||
Copyright 2020 Ckat <ckat@teknik.io>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
/* ensure NKRO is on */
|
||||
#define FORCE_NKRO
|
||||
@@ -11,7 +11,6 @@
|
||||
#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET_TIMEOUT 500U
|
||||
|
||||
// settings for the oled keyboard demo with Adafruit 0.91" OLED display on the Stemma QT port
|
||||
#define OLED_DISPLAY_128X32
|
||||
#define I2C_DRIVER I2CD0
|
||||
#define I2C1_SDA_PIN GP12
|
||||
#define I2C1_SCL_PIN GP13
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
// Copyright 2026 QMK
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
#include QMK_KEYBOARD_H
|
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {LAYOUT_ortho_1x1(KC_A)};
|
||||
|
||||
void keyboard_post_init_user(void) {
|
||||
// Customise these values to desired behaviour
|
||||
debug_enable = true;
|
||||
debug_matrix = true;
|
||||
// debug_keyboard=true;
|
||||
// debug_mouse=true;
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"config": {
|
||||
"features": {
|
||||
"console": true
|
||||
}
|
||||
},
|
||||
"modules": [
|
||||
"qmk/nvm_test"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
// Copyright 2022 QMK
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
|
||||
#include QMK_KEYBOARD_H
|
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||
[0] = LAYOUT(KC_L, KC_R)
|
||||
};
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"modules": [
|
||||
"qmk/split_data_sync"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,288 @@
|
||||
{
|
||||
"manufacturer": "hnkbd",
|
||||
"keyboard_name": "hnk100",
|
||||
"maintainer": "ascYAOBT",
|
||||
"bootloader": "atmel-dfu",
|
||||
"diode_direction": "COL2ROW",
|
||||
"features": {
|
||||
"bootmagic": true,
|
||||
"extrakey": true,
|
||||
"mousekey": true,
|
||||
"nkro": true,
|
||||
"rgb_matrix": true
|
||||
},
|
||||
"matrix_pins": {
|
||||
"cols": ["C6", "C7", "F7", "F6", "F5", "F4", "F1", "D2", "D1", "D0", "D3", "D5"],
|
||||
"rows": ["B6", "B5", "B4", "D7", "D6", "D4", "F0", "E6", "B0", "B1", "B3", "B7"]
|
||||
},
|
||||
"processor": "atmega32u4",
|
||||
"rgb_matrix": {
|
||||
"animations": {
|
||||
"band_pinwheel_val": true,
|
||||
"band_sat": true,
|
||||
"band_spiral_sat": true,
|
||||
"band_val": true,
|
||||
"breathing": true,
|
||||
"cycle_all": true,
|
||||
"cycle_left_right": true,
|
||||
"cycle_out_in": true,
|
||||
"cycle_pinwheel": true,
|
||||
"cycle_spiral": true,
|
||||
"cycle_up_down": true,
|
||||
"dual_beacon": true,
|
||||
"gradient_left_right": true,
|
||||
"gradient_up_down": true,
|
||||
"hue_breathing": true,
|
||||
"hue_pendulum": true,
|
||||
"hue_wave": true,
|
||||
"jellybean_raindrops": true,
|
||||
"pixel_flow": true,
|
||||
"pixel_rain": true,
|
||||
"rainbow_beacon": true,
|
||||
"rainbow_moving_chevron": true,
|
||||
"rainbow_pinwheels": true,
|
||||
"raindrops": true,
|
||||
"solid_reactive_cross": true,
|
||||
"solid_reactive_simple": true,
|
||||
"solid_reactive_wide": true,
|
||||
"splash": true,
|
||||
"typing_heatmap": true
|
||||
},
|
||||
"brightness_steps": 20,
|
||||
"default": {
|
||||
"animation": "solid_color",
|
||||
"val": 120
|
||||
},
|
||||
"driver": "ws2812",
|
||||
"hue_steps": 22,
|
||||
"layout": [
|
||||
{"matrix": [0, 0], "x": 0, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 2], "x": 20, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 3], "x": 30, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 4], "x": 40, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 5], "x": 50, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 7], "x": 65, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 8], "x": 75, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 9], "x": 85, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 10], "x": 95, "y": 0, "flags": 4},
|
||||
{"matrix": [0, 11], "x": 110, "y": 0, "flags": 4},
|
||||
{"matrix": [6, 0], "x": 120, "y": 0, "flags": 4},
|
||||
{"matrix": [6, 1], "x": 130, "y": 0, "flags": 4},
|
||||
{"matrix": [6, 2], "x": 140, "y": 0, "flags": 4},
|
||||
{"matrix": [6, 3], "x": 150, "y": 0, "flags": 4},
|
||||
{"matrix": [6, 4], "x": 160, "y": 0, "flags": 4},
|
||||
{"matrix": [6, 5], "x": 170, "y": 0, "flags": 4},
|
||||
{"matrix": [7, 9], "x": 210, "y": 12, "flags": 4},
|
||||
{"matrix": [7, 8], "x": 200, "y": 12, "flags": 4},
|
||||
{"matrix": [7, 7], "x": 190, "y": 12, "flags": 4},
|
||||
{"matrix": [7, 6], "x": 180, "y": 12, "flags": 4},
|
||||
{"matrix": [7, 5], "x": 170, "y": 12, "flags": 4},
|
||||
{"matrix": [7, 4], "x": 160, "y": 12, "flags": 4},
|
||||
{"matrix": [7, 3], "x": 150, "y": 12, "flags": 4},
|
||||
{"matrix": [7, 2], "x": 135, "y": 12, "flags": 4},
|
||||
{"matrix": [7, 0], "x": 120, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 11], "x": 110, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 10], "x": 100, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 9], "x": 90, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 8], "x": 80, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 7], "x": 70, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 6], "x": 60, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 5], "x": 50, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 4], "x": 40, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 3], "x": 30, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 2], "x": 20, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 1], "x": 10, "y": 12, "flags": 4},
|
||||
{"matrix": [1, 0], "x": 0, "y": 12, "flags": 4},
|
||||
{"matrix": [2, 0], "x": 0, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 1], "x": 15, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 2], "x": 25, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 3], "x": 35, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 4], "x": 45, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 5], "x": 55, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 6], "x": 65, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 7], "x": 75, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 8], "x": 85, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 9], "x": 95, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 10], "x": 105, "y": 24, "flags": 4},
|
||||
{"matrix": [2, 11], "x": 115, "y": 24, "flags": 4},
|
||||
{"matrix": [8, 0], "x": 125, "y": 24, "flags": 4},
|
||||
{"matrix": [8, 2], "x": 137, "y": 24, "flags": 4},
|
||||
{"matrix": [8, 3], "x": 150, "y": 24, "flags": 4},
|
||||
{"matrix": [8, 4], "x": 160, "y": 24, "flags": 4},
|
||||
{"matrix": [8, 5], "x": 170, "y": 24, "flags": 4},
|
||||
{"matrix": [8, 6], "x": 180, "y": 24, "flags": 4},
|
||||
{"matrix": [8, 7], "x": 190, "y": 24, "flags": 4},
|
||||
{"matrix": [8, 8], "x": 200, "y": 24, "flags": 4},
|
||||
{"matrix": [9, 9], "x": 210, "y": 36, "flags": 4},
|
||||
{"matrix": [9, 8], "x": 200, "y": 36, "flags": 4},
|
||||
{"matrix": [9, 7], "x": 190, "y": 36, "flags": 4},
|
||||
{"matrix": [9, 6], "x": 180, "y": 36, "flags": 4},
|
||||
{"matrix": [9, 2], "x": 135, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 11], "x": 117, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 10], "x": 107, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 9], "x": 97, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 8], "x": 87, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 7], "x": 77, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 6], "x": 67, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 5], "x": 57, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 4], "x": 47, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 3], "x": 37, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 2], "x": 27, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 1], "x": 17, "y": 36, "flags": 4},
|
||||
{"matrix": [3, 0], "x": 4, "y": 36, "flags": 4},
|
||||
{"matrix": [4, 0], "x": 6, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 1], "x": 22, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 2], "x": 32, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 3], "x": 42, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 4], "x": 52, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 5], "x": 62, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 6], "x": 72, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 7], "x": 82, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 8], "x": 92, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 9], "x": 102, "y": 48, "flags": 4},
|
||||
{"matrix": [4, 10], "x": 112, "y": 48, "flags": 4},
|
||||
{"matrix": [10, 2], "x": 142, "y": 48, "flags": 4},
|
||||
{"matrix": [10, 4], "x": 160, "y": 48, "flags": 4},
|
||||
{"matrix": [10, 6], "x": 180, "y": 48, "flags": 4},
|
||||
{"matrix": [10, 7], "x": 190, "y": 48, "flags": 4},
|
||||
{"matrix": [10, 8], "x": 200, "y": 48, "flags": 4},
|
||||
{"matrix": [11, 9], "x": 210, "y": 60, "flags": 4},
|
||||
{"matrix": [11, 8], "x": 200, "y": 60, "flags": 4},
|
||||
{"matrix": [11, 6], "x": 185, "y": 60, "flags": 4},
|
||||
{"matrix": [11, 5], "x": 170, "y": 60, "flags": 4},
|
||||
{"matrix": [11, 4], "x": 160, "y": 60, "flags": 4},
|
||||
{"matrix": [11, 3], "x": 150, "y": 60, "flags": 4},
|
||||
{"matrix": [11, 2], "x": 140, "y": 60, "flags": 4},
|
||||
{"matrix": [11, 0], "x": 128, "y": 60, "flags": 4},
|
||||
{"matrix": [5, 10], "x": 115, "y": 60, "flags": 4},
|
||||
{"matrix": [5, 8], "x": 103, "y": 60, "flags": 4},
|
||||
{"matrix": [5, 5], "x": 63, "y": 60, "flags": 4},
|
||||
{"matrix": [5, 2], "x": 26, "y": 60, "flags": 4},
|
||||
{"matrix": [5, 1], "x": 14, "y": 60, "flags": 4},
|
||||
{"matrix": [5, 0], "x": 2, "y": 60, "flags": 4}
|
||||
],
|
||||
"max_brightness": 170,
|
||||
"saturation_steps": 22,
|
||||
"sleep": true
|
||||
},
|
||||
"url": "https://hnkbd.ca/",
|
||||
"usb": {
|
||||
"device_version": "1.0.0",
|
||||
"pid": "0x0002",
|
||||
"vid": "0x484E"
|
||||
},
|
||||
"ws2812": {
|
||||
"pin": "B2"
|
||||
},
|
||||
"community_layouts": ["fullsize_ansi"],
|
||||
"layouts": {
|
||||
"LAYOUT_fullsize_ansi": {
|
||||
"layout": [
|
||||
{"label": "Esc", "matrix": [0, 0], "x": 0, "y": 0},
|
||||
{"label": "F1", "matrix": [0, 2], "x": 2, "y": 0},
|
||||
{"label": "F2", "matrix": [0, 3], "x": 3, "y": 0},
|
||||
{"label": "F3", "matrix": [0, 4], "x": 4, "y": 0},
|
||||
{"label": "F4", "matrix": [0, 5], "x": 5, "y": 0},
|
||||
{"label": "F5", "matrix": [0, 7], "x": 6.5, "y": 0},
|
||||
{"label": "F6", "matrix": [0, 8], "x": 7.5, "y": 0},
|
||||
{"label": "F7", "matrix": [0, 9], "x": 8.5, "y": 0},
|
||||
{"label": "F8", "matrix": [0, 10], "x": 9.5, "y": 0},
|
||||
{"label": "F9", "matrix": [0, 11], "x": 11, "y": 0},
|
||||
{"label": "F10", "matrix": [6, 0], "x": 12, "y": 0},
|
||||
{"label": "F11", "matrix": [6, 1], "x": 13, "y": 0},
|
||||
{"label": "F12", "matrix": [6, 2], "x": 14, "y": 0},
|
||||
{"label": "PSc", "matrix": [6, 3], "x": 15.25, "y": 0},
|
||||
{"label": "Scr", "matrix": [6, 4], "x": 16.25, "y": 0},
|
||||
{"label": "Pse", "matrix": [6, 5], "x": 17.25, "y": 0},
|
||||
{"label": "Grv", "matrix": [1, 0], "x": 0, "y": 1.25},
|
||||
{"label": "1", "matrix": [1, 1], "x": 1, "y": 1.25},
|
||||
{"label": "2", "matrix": [1, 2], "x": 2, "y": 1.25},
|
||||
{"label": "3", "matrix": [1, 3], "x": 3, "y": 1.25},
|
||||
{"label": "4", "matrix": [1, 4], "x": 4, "y": 1.25},
|
||||
{"label": "5", "matrix": [1, 5], "x": 5, "y": 1.25},
|
||||
{"label": "5", "matrix": [1, 6], "x": 6, "y": 1.25},
|
||||
{"label": "7", "matrix": [1, 7], "x": 7, "y": 1.25},
|
||||
{"label": "8", "matrix": [1, 8], "x": 8, "y": 1.25},
|
||||
{"label": "9", "matrix": [1, 9], "x": 9, "y": 1.25},
|
||||
{"label": "0", "matrix": [1, 10], "x": 10, "y": 1.25},
|
||||
{"label": "Mins", "matrix": [1, 11], "x": 11, "y": 1.25},
|
||||
{"label": "Eql", "matrix": [7, 0], "x": 12, "y": 1.25},
|
||||
{"label": "Bspc", "matrix": [7, 2], "x": 13, "y": 1.25, "w": 2},
|
||||
{"label": "Ins", "matrix": [7, 3], "x": 15.25, "y": 1.25},
|
||||
{"label": "Home", "matrix": [7, 4], "x": 16.25, "y": 1.25},
|
||||
{"label": "PgUp", "matrix": [7, 5], "x": 17.25, "y": 1.25},
|
||||
{"label": "Num", "matrix": [7, 6], "x": 18.5, "y": 1.25},
|
||||
{"label": "PsLs", "matrix": [7, 7], "x": 19.5, "y": 1.25},
|
||||
{"label": "Past", "matrix": [7, 8], "x": 20.5, "y": 1.25},
|
||||
{"label": "Pmns", "matrix": [7, 9], "x": 21.5, "y": 1.25},
|
||||
{"label": "Tab", "matrix": [2, 0], "x": 0, "y": 2.25, "w": 1.5},
|
||||
{"label": "Q", "matrix": [2, 1], "x": 1.5, "y": 2.25},
|
||||
{"label": "W", "matrix": [2, 2], "x": 2.5, "y": 2.25},
|
||||
{"label": "E", "matrix": [2, 3], "x": 3.5, "y": 2.25},
|
||||
{"label": "R", "matrix": [2, 4], "x": 4.5, "y": 2.25},
|
||||
{"label": "T", "matrix": [2, 5], "x": 5.5, "y": 2.25},
|
||||
{"label": "Y", "matrix": [2, 6], "x": 6.5, "y": 2.25},
|
||||
{"label": "U", "matrix": [2, 7], "x": 7.5, "y": 2.25},
|
||||
{"label": "I", "matrix": [2, 8], "x": 8.5, "y": 2.25},
|
||||
{"label": "O", "matrix": [2, 9], "x": 9.5, "y": 2.25},
|
||||
{"label": "P", "matrix": [2, 10], "x": 10.5, "y": 2.25},
|
||||
{"label": "Lbrc", "matrix": [2, 11], "x": 11.5, "y": 2.25},
|
||||
{"label": "Rbrc", "matrix": [8, 0], "x": 12.5, "y": 2.25},
|
||||
{"label": "BsLs", "matrix": [8, 2], "x": 13.5, "y": 2.25, "w": 1.5},
|
||||
{"label": "Del", "matrix": [8, 3], "x": 15.25, "y": 2.25},
|
||||
{"label": "End", "matrix": [8, 4], "x": 16.25, "y": 2.25},
|
||||
{"label": "PgDn", "matrix": [8, 5], "x": 17.25, "y": 2.25},
|
||||
{"label": "P7", "matrix": [8, 6], "x": 18.5, "y": 2.25},
|
||||
{"label": "P8", "matrix": [8, 7], "x": 19.5, "y": 2.25},
|
||||
{"label": "P9", "matrix": [8, 8], "x": 20.5, "y": 2.25},
|
||||
{"label": "Caps", "matrix": [3, 0], "x": 0, "y": 3.25, "w": 1.75},
|
||||
{"label": "A", "matrix": [3, 1], "x": 1.75, "y": 3.25},
|
||||
{"label": "S", "matrix": [3, 2], "x": 2.75, "y": 3.25},
|
||||
{"label": "D", "matrix": [3, 3], "x": 3.75, "y": 3.25},
|
||||
{"label": "F", "matrix": [3, 4], "x": 4.75, "y": 3.25},
|
||||
{"label": "G", "matrix": [3, 5], "x": 5.75, "y": 3.25},
|
||||
{"label": "H", "matrix": [3, 6], "x": 6.75, "y": 3.25},
|
||||
{"label": "J", "matrix": [3, 7], "x": 7.75, "y": 3.25},
|
||||
{"label": "K", "matrix": [3, 8], "x": 8.75, "y": 3.25},
|
||||
{"label": "L", "matrix": [3, 9], "x": 9.75, "y": 3.25},
|
||||
{"label": "Scln", "matrix": [3, 10], "x": 10.75, "y": 3.25},
|
||||
{"label": "Quot", "matrix": [3, 11], "x": 11.75, "y": 3.25},
|
||||
{"label": "Ent", "matrix": [9, 2], "x": 12.75, "y": 3.25, "w": 2.25},
|
||||
{"label": "P4", "matrix": [9, 6], "x": 18.5, "y": 3.25},
|
||||
{"label": "P5", "matrix": [9, 7], "x": 19.5, "y": 3.25},
|
||||
{"label": "P6", "matrix": [9, 8], "x": 20.5, "y": 3.25},
|
||||
{"label": "PPls", "matrix": [9, 9], "x": 21.5, "y": 2.25, "h": 2},
|
||||
{"label": "Lsft", "matrix": [4, 0], "x": 0, "y": 4.25, "w": 2.25},
|
||||
{"label": "Z", "matrix": [4, 1], "x": 2.25, "y": 4.25},
|
||||
{"label": "X", "matrix": [4, 2], "x": 3.25, "y": 4.25},
|
||||
{"label": "C", "matrix": [4, 3], "x": 4.25, "y": 4.25},
|
||||
{"label": "V", "matrix": [4, 4], "x": 5.25, "y": 4.25},
|
||||
{"label": "B", "matrix": [4, 5], "x": 6.25, "y": 4.25},
|
||||
{"label": "N", "matrix": [4, 6], "x": 7.25, "y": 4.25},
|
||||
{"label": "M", "matrix": [4, 7], "x": 8.25, "y": 4.25},
|
||||
{"label": "Comm", "matrix": [4, 8], "x": 9.25, "y": 4.25},
|
||||
{"label": "Dot", "matrix": [4, 9], "x": 10.25, "y": 4.25},
|
||||
{"label": "Slsh", "matrix": [4, 10], "x": 11.25, "y": 4.25},
|
||||
{"label": "Rsft", "matrix": [10, 2], "x": 12.25, "y": 4.25, "w": 2.75},
|
||||
{"label": "Up", "matrix": [10, 4], "x": 16.25, "y": 4.25},
|
||||
{"label": "P1", "matrix": [10, 6], "x": 18.5, "y": 4.25},
|
||||
{"label": "P2", "matrix": [10, 7], "x": 19.5, "y": 4.25},
|
||||
{"label": "P3", "matrix": [10, 8], "x": 20.5, "y": 4.25},
|
||||
{"label": "Lctl", "matrix": [5, 0], "x": 0, "y": 5.25, "w": 1.25},
|
||||
{"label": "Lgui", "matrix": [5, 1], "x": 1.25, "y": 5.25, "w": 1.25},
|
||||
{"label": "Lalt", "matrix": [5, 2], "x": 2.5, "y": 5.25, "w": 1.25},
|
||||
{"label": "Spc", "matrix": [5, 5], "x": 3.75, "y": 5.25, "w": 6.25},
|
||||
{"label": "Ralt", "matrix": [5, 8], "x": 10, "y": 5.25, "w": 1.25},
|
||||
{"label": "Ropt", "matrix": [5, 10], "x": 11.25, "y": 5.25, "w": 1.25},
|
||||
{"label": "Mo", "matrix": [11, 0], "x": 12.5, "y": 5.25, "w": 1.25},
|
||||
{"label": "Rctl", "matrix": [11, 2], "x": 13.75, "y": 5.25, "w": 1.25},
|
||||
{"label": "Left", "matrix": [11, 3], "x": 15.25, "y": 5.25},
|
||||
{"label": "Down", "matrix": [11, 4], "x": 16.25, "y": 5.25},
|
||||
{"label": "Right", "matrix": [11, 5], "x": 17.25, "y": 5.25},
|
||||
{"label": "P0", "matrix": [11, 6], "x": 18.5, "y": 5.25, "w": 2},
|
||||
{"label": "Pdot", "matrix": [11, 8], "x": 20.5, "y": 5.25},
|
||||
{"label": "Pent", "matrix": [11, 9], "x": 21.5, "y": 4.25, "h": 2}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
// Copyright 2023 QMK
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
|
||||
#include QMK_KEYBOARD_H
|
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||
[0] = LAYOUT_fullsize_ansi(
|
||||
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, KC_SCRL, KC_PAUS,
|
||||
|
||||
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_HOME, KC_PGUP, KC_NUM, KC_PSLS, KC_PAST, KC_PMNS,
|
||||
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_END, KC_PGDN, KC_P7, KC_P8, KC_P9,
|
||||
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_P4, KC_P5, KC_P6, KC_PPLS,
|
||||
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_P1, KC_P2, KC_P3,
|
||||
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_ROPT, MO(1), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0, KC_PDOT, KC_PENT
|
||||
),
|
||||
[1] = LAYOUT_fullsize_ansi(
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
|
||||
_______, _______, KC_VOLU, _______, _______, _______, _______, _______, _______, _______, _______, _______, RM_SATU, RM_HUEU, _______, _______, _______, _______, _______, _______,
|
||||
_______, KC_MUTE, KC_VOLD, KC_PAUS, _______, _______, _______, _______, _______, _______, _______, RM_SATD, RM_HUED, _______, _______, _______, _______,
|
||||
_______, KC_PIPE, _______, _______, _______, _______, _______, _______, _______, _______, _______, RM_TOGG, RM_VALU, _______, _______, _______,
|
||||
_______, _______, _______, KC_PSCR, _______, RM_SPDD, _______, RM_SPDU, RM_PREV, RM_VALD, RM_NEXT, _______, _______, _______
|
||||
)
|
||||
};
|
||||
@@ -0,0 +1,25 @@
|
||||
# hnk100
|
||||
|
||||
Our Hide Nothing Keyboard version of the traditional 100%, with or without RGB support. For more information visit https://hnkbd.ca
|
||||
|
||||
* Keyboard Maintainer: [hnkbd](https://github.com/ascYAOBT)
|
||||
* Hardware Supported: hnk100, either with or without per key RGB LED
|
||||
* Hardware Availability: https://hnkbd.ca
|
||||
|
||||
Make example for this keyboard (after setting up your build environment):
|
||||
|
||||
make hnk/hnk100:default
|
||||
|
||||
Flashing example for this keyboard:
|
||||
|
||||
make hnk/hnk100:default:flash
|
||||
|
||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
|
||||
|
||||
## Bootloader
|
||||
|
||||
Enter the bootloader in 3 ways:
|
||||
|
||||
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
|
||||
* **Physical reset button**: Briefly press the button on the back of the PCB while plugged in and with QMK Toolbox opened.
|
||||
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user