Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat(shields): Add Eternal Keypad #1136

Merged
merged 5 commits into from Sep 5, 2022
Merged

feat(shields): Add Eternal Keypad #1136

merged 5 commits into from Sep 5, 2022

Conversation

halcyonCorsair
Copy link
Contributor

@halcyonCorsair halcyonCorsair commented Feb 19, 2022 •
edited

Add Eternal Keypad gaming keypad.

Board/Shield Check-list

  • This board/shield is tested working on real hardware
  • Definitions follow the general style of other shields/boards upstream (Reference)
  • .zmk.yml metadata file added
  • 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)
  • General consistent formatting of DeviceTree files
  • Keymaps do not use deprecated key defines (Check using the upgrader tool)
  • &pro_micro used in favor of &pro_micro_d/a if applicable
  • If split, no name added for the right/peripheral half
  • Kconfig.defconfig file correctly wraps all configuration in conditional on the shield symbol
  • .conf file has optional extra features commented out
  • Keyboard/PCB is part of a shipped group buy or is generally available in stock to purchase (OSH/personal projects without general availability should create a zmk-config repo instead)

@halcyonCorsair
Copy link
Contributor Author

I can't speak for other places, it is at least commercially available in Australia: https://customkbd.com/collections/complete-kits/products/eternal-keypad-kit

@halcyonCorsair halcyonCorsair changed the title Add Eternal Keypad feat(shields): Add Eternal Keypad Feb 19, 2022
@Nicell Nicell added enhancement New feature or request shields PRs and issues related to shields labels Mar 14, 2022
Nicell
Nicell requested changes Apr 14, 2022
View reviewed changes
Copy link
Member

@Nicell Nicell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry it took so long for the review! Re-request a review when you've addressed the feedback.

app/boards/shields/eternal_keypad/eternal_keypad.zmk.yml
Comment on lines +1 to +8
file_format: "1"
id: eternal_keypad
name: Eternal Keypad
type: shield
url: https://github.com/duckyb/eternal-keypad
requires: [pro_micro]
features:
- keys
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should probably be another .zmk.yml file for _lefty

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do.

app/boards/shields/eternal_keypad/eternal_keypad_lefty.keymap
@@ -0,0 +1,54 @@
/*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused at the differences in keymaps from this and the non-lefty variant (second layer totally blank here, slight differences in letters?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, I don't have a built version of the lefty, or an unbuilt pcb to test with. Since this is specifically a gaming board, and the pcb is reversible, you can cheat by using the default transform and flipping A/D (to preserve WASD), and LEFT/RIGHT, then all the other keys will be in the correct locations upside down.

I did make a mistake here by forgetting to swap LEFT/RIGHT and adding the extra BT control keys to the ARROW layer, so I'll fix that before review.

app/boards/shields/eternal_keypad/eternal_keypad_lefty.keymap Outdated
/ {
chosen {
zmk,kscan = &kscan0;
zmk,matrix_transform = &default_transform;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be the lefty transform?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In an ideal world, yes. See the previous comment for details.

@halcyonCorsair
Copy link
Contributor Author

@Nicell this PR is now ready for a re-review.

petejohanson
petejohanson reviewed Aug 5, 2022
View reviewed changes
Copy link
Contributor

@petejohanson petejohanson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor nit-pick, should the display name match?

app/boards/shields/eternal_keypad/eternal_keypad_lefty.zmk.yml Outdated Show resolved Hide resolved
@petejohanson petejohanson merged commit ce7a0e2 into zmkfirmware:main Sep 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@duckyb duckyb duckyb left review comments

@Nicell Nicell Nicell requested changes

@petejohanson petejohanson petejohanson approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request shields PRs and issues related to shields
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@halcyonCorsair @petejohanson @Nicell @duckyb