zmk icon indicating copy to clipboard operation
zmk copied to clipboard

feat(split): Allow wired split for Ergodash

Open seanlano opened this issue 6 months ago • 4 comments

The Ergodash shield uses a Pro Micro compatible TRRS wired split configuration. This small change enables this with the existing Ergodash shield definition.

PR check-list

  • [x] Branch has a clean commit history
  • [ ] ~~Additional tests are included, if changing behaviors/core code that is testable.~~
  • [x] Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
  • [x] Pre-commit used to check formatting of files, commit messages, etc.
  • [ ] ~~Includes any necessary documentation changes.~~

seanlano avatar Aug 17 '25 08:08 seanlano

I've very new to Zephyr and ZMK (although I'm otherwise an experience firmware developer), so I'm not 100% sure that this is the right way to do this – suggestions gladly welcomed!

I had tried putting the block:

    wired_split {
        compatible = "zmk,wired-split";
        device = <&pro_micro_serial>;
    };

into a local zmk-config keymap file, but that didn't work (you can see my attempts here)

I found that it only worked when in the .dtsi file, so I figured I'd create a PR for it.

seanlano avatar Aug 17 '25 08:08 seanlano

Oh and I have a KB2040 driver, which seems to not enable serial by default - so I also added this to my keymap file:

&pro_micro_serial {
    status = "okay";
};

seanlano avatar Aug 17 '25 08:08 seanlano

I think we'll need to think a bit about how to best begin supporting wired split keyboards in-tree -- this would be the first such keyboard. I'm not sure our setup scripts/schema/stuff are configured to allow everything to work smoothly. That said, thanks for the PR, it'll help keep an eye on the subject.

Regarding your local attempts, the reason it didn't work in the keymap is because you didn't enable

&pro_micro_serial {
    status = "okay";
};

in the keymap as well at the time -- you only did so after copying over and modifying the shield definition.

nmunnich avatar Aug 17 '25 08:08 nmunnich

Thanks @nmunnich , yeah I've been playing some more and do have it working now just with a local keymap and no changes to the Ergodash shield.

I'll keep an eye out for other changes and help test where I can, but yeah this seems to work for me without needing the PR.

(If anyone happens to find this in the future, you can see the config I changed for a KB2040 and Ergodash in this commit)

seanlano avatar Aug 17 '25 09:08 seanlano