-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated encoder config docs & standardization of existing shields #1970
Updated encoder config docs & standardization of existing shields #1970
Conversation
petejohanson
commented
Oct 18, 2023
•
edited
Loading
edited
- Update new shield guide for new sensor/encoder settings.
- Add DTS section to encoder config docs.
- Update existing in-tree shields/boards to use the new encoder configuration consistently.
c07e769
to
d1f120a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we also add a pointer to docs/features/encoders.md to the config page, for users that need to adjust the encoder properties in the keymap? Right now it says
See the New Keyboard Shield documentation for how to add or modify additional encoders to your shield.
but I feel like config page is better for adjusting already configured encoders.
This would close #1860. |
Also a bit unrelated but since we are touching encoder definitions in all shields: Should we get rid of the recommendation to set |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- ...I was surprised to see a PR which was ostensibly for docs incorporate changes to shields and boards.
- The suggested changes for MurphPad are at odds with my outstanding PR, which has been tested on an actual PCB and stock encoder provided by the vendor/creator. (I am also unsure if there is some reason its keymap was not modified—does the
sensors
node actually belong in the$shieldname.overlay
file?)
Yeah, the PR title/summary got auto-populated by my first commit, and then I got to the follow up work. I will update accordingly.
So, we have a mix of approaches, probably in part because we weren't very diligent about how to structure things when encoder work got added. IMHO, the "correct" way to do this is to add the sensors node in the overlay, and give it a label, e.g. So if you only installed encoders in certain positions, you might do:
for instance. I didn't want to "rock the boat" too much as part of this refactor, but I'm certainly open to it if we want to be consistent so that future shields/boards that might copy others get it "right". |
251f746
to
f67ca66
Compare
I want to explore this for sure, not sure it's in scope for this or not, since really we need to get the docs/reference designs fixed ASAP to avoid future confusion. I didn't create that as the default because the convention for generic sensor drivers is to not do so... What may make sense is to leave the driver Kconfig as is, but in ZMK's Kconfig override the default for our use. Thoughts? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just noting the missing tweak for murphpad
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one doesn't seem to have triggers-per-rotation
defined (sensors
node is in the keymap)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me aside from the issue with murphpad missing triggers-per-rotation.
f67ca66
to
3598005
Compare
* Update new shield guide for new sensor/encoder settings. * Add DTS section to encoder config docs. Co-authored-by: Cem Aksoylar <[email protected]>
* Update existing boards/shields for new `steps` and `triggers-per-rotation` set up.
3598005
to
703de1a
Compare