zmkfirmware
feat(docs) Adds a feature page about dongles
Contains a quick setup for using a dongle or adding a third split as central
Related to discussion started by user caksoylar under issue #948
I think it would be good to scrub all references to split keyboards from the page, and focus on dongles entirely. A separate page can handle the discussion on split keyboards, That would let this page be streamlined a bunch.
My current line of thought is to have this PR be included in a "Blueprints" category following the idea started in #1952, rather than under the features category. I plan on putting some time into that soon, and would like to "eat" this PR (still giving you author credits ofc) for that purpose when I get around to it. Your thoughts?
I wanted to include some of the split information, because there could be builds that implement 3 splits or more (using a numpad as a third split comes to mind) so that is why I did not wish to box it in as much. If we rename and change this to just dongles, then yes, it does make sense to just streamline it.
I do not mind if this is moved under somewhere else nor care if I get any credit for writing. I am just trying to give back to the ZMK community for all the free help I am getting.
I also think that now it makes sense to rename the file from splits to dongles, just want avoid any renaming until the doc review is completed
Hi @RasmusKoit, thank you very much for taking the initiative to tackle this. I think it's a good idea to have a guide such as this one to describe the why and how of "dongle" keyboards. However I think it is a bit awkward to have this without first having an explainer page on split keyboards in general. This would also save you from repeating any information in there.
My understanding from here/Discord is @Nick-Munnich had similar thoughts and this page right now is being geared more towards being a recipe/blueprint? If so, I think that's a good approach. This pushed me a bit to write a split keyboards feature page at #2406 so we have a good base to add on to.
Appreciate the contribution!
@Nick-Munnich @caksoylar I've improved the document again and would like another review please
I think a note that this requires defining a custom shield and a pointer to new shield guide as a prerequisite is needed on this page.
At least as I understand the functionality, displays on both the splits become "peripheral" and are unable to display, for example, active layer. If so, that seems like a significant disadvantage.
Edit: Thinking through this, it might be an advantage with, for example, a dongle at the bottom of a monitor that can display information in an arguably easier to glance at location than on the keyboard.
Hey All, Could I ask if this guide is functionally working? I'd like to set this up myself since I have 3 nice!nano's
Hey All, Could I ask if this guide is functionally working? I'd like to set this up myself since I have 3 nice!nano's
Hey @jasper-at-windswept for a functionally working build you can check https://github.com/RasmusKoit/pipar or https://github.com/RasmusKoit/miryoku_zmk
@RasmusKoit That pipar config is great thank you. I am having an issue though, for some reason for me having columns set to 0 like yours in my dongle overlay is causing the build to fail. Is there any change you could help me with this? https://github.com/jasper-at-windswept/zmk-config-corone
Please keep in mind that pipar uses Xiao ble and not a pro micro, you can reference both this doc and the repo to find the right combination though.
Please let me know if you get stuck again
Hey @RasmusKoit I have managed to get it to build but for some reason no matter what I do, the left side of my board remains the central peripheral despite setting it to not be. I can tell it is the central peripheral because on the nice!view it shows the controller-to-PC status indicator instead of the peripheral image display. Your help would be greatly appreciated! https://github.com/jasper-at-windswept/zmk-config-corone
please flash each part with the reset firmware first!
then you should get it working