Firmware: use external userspace and fix encoder integration

[schuay]

Hi @tompi ,

I've updated the cheapino firmware to use qmk's new external userspace model, and fixed the encoder implementation so it properly interacts with tap-hold keys. The change is available here: qmk/qmk_firmware@d7a214c

I think it'd be great to upstream this. What do you think about:

• Pulling the encoder changes.
• Pulling the external qmk userspace changes, and
• Adding the non-userspace firmware parts to the upstream QMK repo?

I've seen elsewhere that you're not crazy about adding cheapino to QMK, but with external userspace it really is the most convenient way IMHO.

Let me know if you're interested.

[tompi]

Hey, this is super work!

If you want to make a PR against qmk, Im perfectly fine with that?

[schuay]

It seems more appropriate for you to do it as the project owner; also, I don't use VIAL at all, so I can't test for correctness there. It'd also be great if you (or someone else) could verify that my changes work with your keymap/settings etc.

If you absolutely don't want to do the QMK pull request, do let me know - I may look into it. I no longer use the cheapino though (I've moved on to a custom design, taking inspiration from your thumb cluster positioning :), so urgency on my side isn't super high.

[chozian]

Has a decision been made on this? It would be great to see this merged for everyone to enjoy modern QMK features with the cheapino.

[FlorianGabelle]

I have used @schuay's latest QMK changes (qmk/qmk_firmware@master...schuay:qmk_firmware:cheapino) and @tompi's vial keymap from cheapinov2 vial-qmk branch (vial-kb/vial-qmk@vial...tompi:vial-qmk:cheapinov2).
I can comment on vial-qmk compilation.

Two changes must be made to allow for compiling the fimrware in vial-qmk ($ make cheapino:vial):

• @schuay : add ENCODER_ENABLE = yes to keyboards/cheapino/rules.mk (would it be better located here than in userspace since it won't compile without it, including in QMK ? If not, it would need to be added to keyboards/cheapino/keymaps/vial/rules.mk)
• @tompi : add VIA_ENABLE = yes to keyboards/cheapino/keymaps/vial/rules.mk, otherwise compilation will fail at keymap introspection stage.

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.

Having said that, I now have the latest release of vial-qmk running on my keyboard including encoder functionality and its mapping in Vial, as well as support for all the latest QMK/Vial features of course.

Note that I have almost exclusively focused on vial-qmk port and will not comment on compilation and functionality in QMK which I have not tested very extensively, but I tried once and had to comment out COMBO_ENABLE = yes to fix an error related to 'key_combos' undeclared during compilation. It may be user error on my side too.

Oh and I forget to say a big THANK YOU for this project and both your contributions !

[schuay]

Great, thanks. I will update my PR later today, let's try to get this into a state where it "just works".

BTW there is another active PR to merge cheapino upstream here: qmk/qmk_firmware#25817 . @azzamsa we should coordinate.

[schuay]

.. and updated here: qmk/qmk_firmware@master...schuay:qmk_firmware:cheapino

[enderbeatt]

.. and updated here: qmk/qmk_firmware@master...schuay:qmk_firmware:cheapino

Hi, I have tried to compile this one, I get the following compilation error:

Compiling: keyboards/cheapino/matrix-encoder.c                                                     In file included from ./lib/chibios/os/hal/include/hal.h:249,
                 from platforms/chibios/platform_deps.h:18,
                 from quantum/quantum.h:18,
                 from keyboards/cheapino/matrix-encoder.h:4,
                 from keyboards/cheapino/matrix-encoder.c:1:
./lib/chibios/os/hal/ports/RP/RP2040/hal_lld.h:34:10: fatal error: hardware/clocks.h: No such file or directory
   34 | #include "hardware/clocks.h"
      |          ^~~~~~~~~~~~~~~~~~~

EDIT: Turns out my git submodules were not properly initialized. Fixed that part at least.

[enderbeatt]

vial-qmk hasn't deprecated num_rows in debounce_init. i reverted this commit for myself qmk/qmk_firmware@2d59087

Compiling: keyboards/cheapino/matrix.c                                                             keyboards/cheapino/matrix.c: In function 'matrix_init_custom':
keyboards/cheapino/matrix.c:119:5: error: too few arguments to function 'debounce_init'
  119 |     debounce_init();
      |     ^~~~~~~~~~~~~
In file included from keyboards/cheapino/matrix.c:27:
quantum/debounce.h:19:6: note: declared here
   19 | void debounce_init(uint8_t num_rows);
      |      ^~~~~~~~~~~~~

[enderbeatt]

add VIA_ENABLE = yes to keyboards/cheapino/keymaps/vial/rules.mk, otherwise compilation will fail at keymap introspection stage.

this was the last thing i needed, it compiled!

[enderbeatt]

flashed my keyboard, seems to be working just fine!!!! thanks and happy new year :)

[azzamsa]

Great, thanks. I will update my PR later today, let's try to get this into a state where it "just works".

BTW there is another active PR to merge cheapino upstream here: qmk/qmk_firmware#25817 . @azzamsa we should coordinate.

Let's do.

The only reason I wanted to bring it upstream is the hassle to to rebase/merge every time I wanted to use latest commit on QMK.

[schuay]

@tompi would you like me to create a PR to merge into your qmk_firmware fork? Note you would have to sync to upstream qmk_firmware first.

[tompi]

Hi @schuay
I think I managed to sync my fork to upstream version now.

Would appreciate a PR!

Quickly looked at comments from drashna, and only thing Im not sure about is the "MATRIX_HAS_GHOST" feature, could not find any documentation on that...