Add support for external userspace, encoder maps, and more by schuay · Pull Request #5 · tompi/qmk_firmware

schuay · 2026-01-03T15:36:27Z

I ended up merging most things into cheapino.c, except matrix.c due to the license. What do you think? Which branch would you like to merge into?

`ws812` -> `ws2812`

…-side mods and fix heading for Speculative Hold. (qmk#25924) * Note Chordal Hold supports multiple same-side mods. * Fix "Speculative Hold" heading from H3 -> H2.

Handle broken symlinks in 'qmk doctor' udev checks

) Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.7.6 to 4.8.0. - [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases) - [Commits](JamesIves/github-pages-deploy-action@v4.7.6...v4.8.0) --- updated-dependencies: - dependency-name: JamesIves/github-pages-deploy-action dependency-version: 4.8.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update support S6xty5 * Delete chconf.h * Update manufacturer, community layout for hhkb * Update layout * fix row index * Update tyson60s * Update community layout and layout name * Update remove rgb test mode * Update capslock led * Apply suggestions from code review Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Remove deprecated s6xty5 * Update tyson60 product id --------- Co-authored-by: Trần Thanh Sơn <son.tt1@teko.vn> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>

Copilot

Pull request overview

This pull request adds comprehensive support for the Cheapino keyboard to QMK firmware, including custom matrix scanning, encoder handling via matrix intersections, RGB lighting with startup effects, and ghosting mitigation for the keyboard's unique hardware design.

Changes:

Added custom matrix scanning implementation to handle the Cheapino's unique wiring scheme
Implemented encoder support using matrix intersections instead of dedicated pins
Added RGB lighting with startup LED flash animation and ghosting detection/mitigation logic

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
keyboards/cheapino/rules.mk	Includes custom matrix.c implementation
keyboards/cheapino/readme.md	Adds keyboard documentation with build and flash instructions
keyboards/cheapino/mcuconf.h	Configures I2C peripheral for RP2040
keyboards/cheapino/matrix.c	Implements custom matrix scanning with dual-direction scanning
keyboards/cheapino/keyboard.json	Defines keyboard configuration, layout, features, and pin mappings
keyboards/cheapino/config.h	Configures WS2812 RGB LED settings
keyboards/cheapino/cheapino.c	Implements keyboard initialization, encoder handling, and ghosting mitigation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-10T12:21:14Z

keyboards/cheapino/matrix.c

+    extern void fix_encoder_action(matrix_row_t current_matrix[]);
+    extern void fix_ghosting(matrix_row_t matrix[]);


External function declarations should typically be placed in header files rather than inside function bodies. Consider moving these declarations to a header file that can be included in both matrix.c and cheapino.c for better code organization and type safety.

Copilot · 2026-01-10T12:21:15Z

keyboards/cheapino/cheapino.c

+    bool         colA        = encoder_row & ENC_A_BIT;
+    bool         colB        = encoder_row & ENC_B_BIT;
+
+    extern bool encoder_queue_event(uint8_t, bool);


The external function declaration should be placed at the top of the file or in a header file rather than inside the function body. This improves code organization and makes the dependency more explicit.

Copilot · 2026-01-10T12:21:16Z

keyboards/cheapino/cheapino.c

+    for (short i = 0; i<3; i++) {
+        fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);
+        fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);
+    }
+
+    // Then exactly same procedure on the left side
+    for (short i = 0; i<3; i++) {
+        fix_ghosting_instance(matrix, i+4, possible_error_cause<<6, 4+((i+1)%3), possible_error<<6, error_fix<<6);
+        fix_ghosting_instance(matrix, i+4, possible_error_cause<<6, 4+((i+2)%3), possible_error<<6, error_fix<<6);


There's inconsistent spacing in the loop condition. Use consistent spacing around operators for better readability.

Suggested change

for (short i = 0; i<3; i++) {

fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);

fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);

}

// Then exactly same procedure on the left side

for (short i = 0; i<3; i++) {

fix_ghosting_instance(matrix, i+4, possible_error_cause<<6, 4+((i+1)%3), possible_error<<6, error_fix<<6);

fix_ghosting_instance(matrix, i+4, possible_error_cause<<6, 4+((i+2)%3), possible_error<<6, error_fix<<6);

for (short i = 0; i < 3; i++) {

fix_ghosting_instance(matrix, i, possible_error_cause, (i + 1) % 3, possible_error, error_fix);

fix_ghosting_instance(matrix, i, possible_error_cause, (i + 2) % 3, possible_error, error_fix);

}

// Then exactly same procedure on the left side

for (short i = 0; i < 3; i++) {

fix_ghosting_instance(matrix, i + 4, possible_error_cause << 6, 4 + ((i + 1) % 3), possible_error << 6, error_fix << 6);

fix_ghosting_instance(matrix, i + 4, possible_error_cause << 6, 4 + ((i + 2) % 3), possible_error << 6, error_fix << 6);

Copilot · 2026-01-10T12:21:16Z

keyboards/cheapino/cheapino.c

+    for (short i = 0; i<3; i++) {
+        fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);
+        fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);
+    }
+
+    // Then exactly same procedure on the left side
+    for (short i = 0; i<3; i++) {


There's inconsistent spacing in the loop condition. Use consistent spacing around operators for better readability.

Suggested change

for (short i = 0; i<3; i++) {

fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);

fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);

}

// Then exactly same procedure on the left side

for (short i = 0; i<3; i++) {

for (short i = 0; i < 3; i++) {

fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);

fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);

}

// Then exactly same procedure on the left side

for (short i = 0; i < 3; i++) {

Copilot · 2026-01-10T12:21:17Z

keyboards/cheapino/readme.md

+![cheapino](imgur.com image replace me!)
+


The placeholder text "imgur.com image replace me!" should be replaced with an actual image URL or removed. This is incomplete documentation.

Suggested change

![cheapino](imgur.com image replace me!)

Copilot · 2026-01-10T12:21:18Z

keyboards/cheapino/cheapino.c

+    // First the right side
+    for (short i = 0; i<3; i++) {
+        fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);
+        fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);
+    }
+
+    // Then exactly same procedure on the left side


The loop condition uses the modulo operator to cycle through indices, but the logic is complex and could benefit from clearer documentation explaining why indices (i+1)%3 and (i+2)%3 are used. This would improve code maintainability.

Suggested change

// First the right side

for (short i = 0; i<3; i++) {

fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);

fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);

}

// Then exactly same procedure on the left side

// First the right side.

// For each of the three rows on this side (i = 0..2), check for ghosting

// interactions with the other two rows. The expressions (i+1)%3 and (i+2)%3

// cycle through the two remaining row indices in {0,1,2} without going out

// of bounds, so every pair of rows on the right side is considered.

for (short i = 0; i<3; i++) {

fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);

fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);

}

// Then exactly same procedure on the left side.

// Rows for the left side are stored starting at index 4, so we add 4 to the

// row indices. The bit patterns are shifted by 6 to match the left-half

// column positions, but the modulo math ((i+1)%3, (i+2)%3) still cycles

// within the three left-side rows in the same way as on the right.

Copilot · 2026-01-10T12:21:18Z

keyboards/cheapino/readme.md

+
+![cheapino](imgur.com image replace me!)
+
+*A short description of the keyboard/project*


The placeholder text "A short description of the keyboard/project" should be replaced with an actual description of the Cheapino keyboard. This is incomplete documentation.

Suggested change

*A short description of the keyboard/project*

*Cheapino is a budget-friendly, QMK-powered custom keyboard designed as an accessible entry point for building and programming your own mechanical keyboard.*

Copilot · 2026-01-10T12:21:18Z

keyboards/cheapino/keyboard.json

@@ -0,0 +1,137 @@
+{
+    "manufacturer": "Thomas Haukland",
+    "keyboard_name": "cheapino2",


The keyboard_name is set to "cheapino2" but the directory and other references use "cheapino". This inconsistency may cause confusion. Consider using "cheapino" for consistency or updating all references to match "cheapino2".

Suggested change

"keyboard_name": "cheapino2",

"keyboard_name": "cheapino",

Copilot · 2026-01-10T12:21:19Z

keyboards/cheapino/cheapino.c

+/* This is for debugging the matrix rows
+void printBits(uint16_t n)
+{
+    long i;
+    for (i = 15; i >= 0; i--) {
+        if ((n & (1 << i)) != 0) {
+            printf("1");
+        }
+        else {
+            printf("0");
+        }
+    }
+    printf("\n");
+}
+*/
+


This commented-out debugging function should either be removed if not needed, or properly documented if it's intended to be kept for future debugging purposes. Leaving large blocks of commented code reduces code maintainability.

Suggested change

/* This is for debugging the matrix rows

void printBits(uint16_t n)

{

long i;

for (i = 15; i >= 0; i--) {

if ((n & (1 << i)) != 0) {

printf("1");

}

else {

printf("0");

}

}

printf("\n");

}

*/

Copilot · 2026-01-10T12:21:19Z

keyboards/cheapino/cheapino.c

+// These are observed ghosts(following a pattern). TODO: need to fix this for v3
+// Might need to add 2 diodes(one in each direction) for every row, to increase voltage drop.


The comment references "v3" but it's unclear what version the current code is for. This comment should be updated to clarify which version it applies to, or the TODO should be addressed if this is for v3.

Suggested change

// These are observed ghosts(following a pattern). TODO: need to fix this for v3

// Might need to add 2 diodes(one in each direction) for every row, to increase voltage drop.

// These are observed ghosts (following a pattern). TODO: if a v3 PCB/hardware revision is created,

// re-validate these patterns and update this table as needed. Might need to add 2 diodes

// (one in each direction) for every row, to increase voltage drop.

schuay · 2026-01-12T16:51:43Z

Just making sure - you're not waiting for me to respond to the copilot review, right?

getreu · 2026-01-18T12:16:51Z

@schuay, I would like to test this. It seems there is a ./keyboards/cheapino/default/keymap.json missing?

schuay · 2026-01-18T13:10:50Z

@schuay, I would like to test this. It seems there is a ./keyboards/cheapino/default/keymap.json missing?

Yes, this PR only provides the firmware. Did you see tompi/cheapino#155 (comment) where others have used this successfully?

Porting existing cheapino keymaps should only be a matter of updating the encoder mapping, which is now part of the LAYOUT_split_3x5_3 macro. See https://github.com/tompi/qmk_firmware/pull/5/files#diff-8512016014c07fd247117877fd233e3b170d1d3debed4eb98bdba00d954e0644R92.

getreu · 2026-01-18T14:13:42Z

@schuay, I would like to test this. It seems there is a ./keyboards/cheapino/default/keymap.json missing?

Yes, this PR only provides the firmware. Did you see tompi/cheapino#155 (comment) where others have used this successfully?

No, I hadn't seen it. I gives clear instructions from where to get the bits and pieces. Thank you for the hint!

Porting existing cheapino keymaps should only be a matter of updating the encoder mapping, which is now part of the LAYOUT_split_3x5_3 macro. See https://github.com/tompi/qmk_firmware/pull/5/files#diff-8512016014c07fd247117877fd233e3b170d1d3debed4eb98bdba00d954e0644R92.

Related to this is a comment of @FlorianGabelle. He writes:

Also, this is a small detail but in keyboards/cheapino/keymaps/vial/keymap.c, the last key corresponding to encoder press must be moved to the 6th position (between T and Y in a QWERTY layout) in keymaps for each layer, otherwise KC_Y will be assigned to the encoder press and all following keys will be shifted by one position.

Can you confirm this?

schuay · 2026-01-18T16:30:38Z

Also, this is a small detail but in keyboards/cheapino/keymaps/vial/keymap.c, the last key corresponding to encoder press must be moved to the 6th position (between T and Y in a QWERTY layout) in keymaps for each layer, otherwise KC_Y will be assigned to the encoder press and all following keys will be shifted by one position.

Can you confirm this?

Yeah exactly. It's there because that's where the encoder is physically located. Please keep further discussion in the issue (not this PR). Good luck!

* Fixup tominabox1 le chiffre default keymap * Apply suggestions from code review Co-authored-by: Jack Sangdahl <jack@pngu.org> --------- Co-authored-by: Jack Sangdahl <jack@pngu.org>

schuay · 2026-02-04T07:39:47Z

@tompi can I do anything to unblock this PR?

tompi · 2026-02-04T08:13:38Z

Hey, sorry about the delay, but tried to fetch the pr and compile, but seems like there is no default keymap? Should this be merged to the cheapino-branch?

https://github.com/tompi/qmk_firmware/tree/cheapinov2-miryoku# at b1e2da5

* Extract keymap definitions to follow the external userspace model. A default keymap should probably be added again as an example. * Move configuration to keyboard.json. * Enable LTO. * Move encoder button handling to the keymap for full qmk feature support (layers, mod-tap). * Inject encoder turn events into the qmk encoder pipeline, with the same motivation as above. * Rename files to avoid clashing with qmk-internal files (encoder.h). * Faster matrix store/compare primitives.

schuay · 2026-02-04T09:39:15Z

Hey, sorry about the delay, but tried to fetch the pr and compile, but seems like there is no default keymap? Should this be merged to the cheapino-branch?

I've added one in the latest push a minute ago, based on your current default keymap but with the added encoder position. Please try again.

Wrt merging: yes, into the cheapino branch, which additionally would have to be rebased on top of current QMK head. Maybe it's easiest to do this all locally on your side? Or, if you prefer, you could create a cheapino-next branch based off qmk_firmware HEAD and I can resubmit the PR there.

getreu · 2026-02-08T21:19:58Z

@schuay, I believe in your layout file in table 3, line 1 is a typo. See my MR in your repo: schuay#1

I think in the 3. table, row 1 is mistake.

NullSeile and others added 8 commits January 3, 2026 19:45

Fix RGB Matrix Typing Heatmap overflow (qmk#25915)

91a9f9e

Fix small typo in WS2812 driver doc (qmk#25928)

8c035c2

`ws812` -> `ws2812`

docs/tap_hold.md fixes: Note that Chordal Hold supports multiple same…

3194862

…-side mods and fix heading for Speculative Hold. (qmk#25924) * Note Chordal Hold supports multiple same-side mods. * Fix "Speculative Hold" heading from H3 -> H2.

Handle broken symlinks in qmk doctor udev checks (qmk#25934)

1e68392

Handle broken symlinks in 'qmk doctor' udev checks

Update fatotesa keyboard config. (qmk#25811)

3d591a2

Short term fix for avr-libc@2.3.0 (qmk#25938)

a0b15d0

tompi requested a review from Copilot January 10, 2026 12:18

Copilot started reviewing on behalf of tompi January 10, 2026 12:18 View session

Copilot AI reviewed Jan 10, 2026

View reviewed changes

Gondolindrim and others added 2 commits January 11, 2026 09:47

First support for KKC Wily (qmk#25852)

70c36c6

Remove binary symbols from keymaps (qmk#25947)

e391793

zvecr and others added 2 commits January 13, 2026 16:48

Lint default dynamic keymap layer count (qmk#25948)

7d66c11

Backport GitHub Copilot instructions. (qmk#25953)

127c664

zvecr and others added 2 commits January 20, 2026 08:48

Fix avrdude version check logic (qmk#25957)

863b308

Fixup tominabox1 le chiffre default keymap (qmk#25966)

38815db

* Fixup tominabox1 le chiffre default keymap * Apply suggestions from code review Co-authored-by: Jack Sangdahl <jack@pngu.org> --------- Co-authored-by: Jack Sangdahl <jack@pngu.org>

schuay and others added 6 commits February 4, 2026 10:22

Import cheapino

b02b222

https://github.com/tompi/qmk_firmware/tree/cheapinov2-miryoku# at b1e2da5

disable lto and enable encoder by default

0371599

update debounce_init signature

b7936cc

simplify file structure

b4abbab

add default keymap

8e99361

schuay force-pushed the cheapino branch from 4ffaaf4 to 8e99361 Compare February 4, 2026 09:30

Fix keymap layout by swapping key positions

4d41e56

I think in the 3. table, row 1 is mistake.

tompi mentioned this pull request Feb 17, 2026

Is QMK config not updated? tompi/cheapino#167

Closed

		extern void fix_encoder_action(matrix_row_t current_matrix[]);
		extern void fix_ghosting(matrix_row_t matrix[]);

-    // First the right side
-    for (short i = 0; i<3; i++) {
-        fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);
-        fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);
-    }
-    // Then exactly same procedure on the left side
+    // First the right side.
+    // For each of the three rows on this side (i = 0..2), check for ghosting
+    // interactions with the other two rows. The expressions (i+1)%3 and (i+2)%3
+    // cycle through the two remaining row indices in {0,1,2} without going out
+    // of bounds, so every pair of rows on the right side is considered.
+    for (short i = 0; i<3; i++) {
+        fix_ghosting_instance(matrix, i, possible_error_cause, (i+1)%3, possible_error, error_fix);
+        fix_ghosting_instance(matrix, i, possible_error_cause, (i+2)%3, possible_error, error_fix);
+    }
+    // Then exactly same procedure on the left side.
+    // Rows for the left side are stored starting at index 4, so we add 4 to the
+    // row indices. The bit patterns are shifted by 6 to match the left-half
+    // column positions, but the modulo math ((i+1)%3, (i+2)%3) still cycles
+    // within the three left-side rows in the same way as on the right.


		![cheapino](imgur.com image replace me!)

		A short description of the keyboard/project

	A short description of the keyboard/project
	Cheapino is a budget-friendly, QMK-powered custom keyboard designed as an accessible entry point for building and programming your own mechanical keyboard.

		// These are observed ghosts(following a pattern). TODO: need to fix this for v3
		// Might need to add 2 diodes(one in each direction) for every row, to increase voltage drop.

-// These are observed ghosts(following a pattern). TODO: need to fix this for v3
-// Might need to add 2 diodes(one in each direction) for every row, to increase voltage drop.
+// These are observed ghosts (following a pattern). TODO: if a v3 PCB/hardware revision is created,
+// re-validate these patterns and update this table as needed. Might need to add 2 diodes
+// (one in each direction) for every row, to increase voltage drop.

Conversation

schuay commented Jan 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

schuay commented Jan 12, 2026

Uh oh!

getreu commented Jan 18, 2026

Uh oh!

schuay commented Jan 18, 2026

Uh oh!

getreu commented Jan 18, 2026

Uh oh!

schuay commented Jan 18, 2026

Uh oh!

schuay commented Feb 4, 2026

Uh oh!

tompi commented Feb 4, 2026

Uh oh!

schuay commented Feb 4, 2026

Uh oh!

getreu commented Feb 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

schuay commented Jan 3, 2026 •

edited

Loading

getreu commented Feb 8, 2026 •

edited

Loading