veikman / dactyl-keyboard

Programmatic keyboard CAD
GNU Affero General Public License v3.0
268 stars 30 forks source link

The wiring to match the QMK firmware is confusing. #20

Open SeattleChris opened 4 years ago

SeattleChris commented 4 years ago

I was helping someone out with making their own DMOTE keyboard, and they were struggling with the proper order to wire things together. I looked at how the layout is defined in the QMK firmware and drew an image for how it seems the keys should be connected.

dmote-wire-drawn

Is my drawing correct?

Do you want me to submit a PR that includes this, or an updated, image?

veikman commented 4 years ago

It certainly makes for an awkward graph in 2D, doesn’t it? 😅

Your drawing is correct. Here’s a picture of my build from last year:

2019-07-03_wiring

Here’s a diagram of the same design, possibly less confusing. I just drew it. It can certainly be improved and annotated.

20200529_dmote_connectiongraph_v050

It may not be clear from these pictures, but the physical shape of the case is the only reason for the convoluted graph. I found this to be the easiest way to wire it up in practice.

As for how best to present this, I’m not sure. I am roughly on step 4 of the list in #16. My ongoing work on the Concertina design will require a different graph. Maintainability is crucial and the application is versatile.

Right now, I continue to believe that the best way to present a detailed build guide is as a blog post or equivalent article, separate from the evolving code repo. I would be happy to link to it.

SeattleChris commented 4 years ago

I think it is good if the repository, as the authoritative source, has a build guide. You could use the wiki feature of the GitHub repo, or markdown files in the docs directory. Then a blog post can be more focused on a more general audience to "get the word out", and not lose audience due to the overburden of including all the details.

SeattleChris commented 4 years ago

Yea, deciphering it from the QMK layout I figured it probably made more sense in real physical 3D. I have doubts a device picture could get a good angle to see the complicated thumb cluster wiring. The device walls, tighter clearance, and 3D context make it harder to comprehend. A cross-section view, or some way to diagram it is probably the best bet.

veikman commented 3 years ago

There is still no build guide or pretty wiring diagram for the DMOTE design, but those things do exist for the later Concertina design:

Those documents are external to the CAD application repository, by design.