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 physical layouts for Jian, Jiran and Jorne #2538

Merged
merged 3 commits into from
Oct 16, 2024
Merged

feat(shields): add physical layouts for Jian, Jiran and Jorne #2538

merged 3 commits into from
Oct 16, 2024

Conversation

krikun98
Copy link
Contributor

@krikun98 krikun98 commented Oct 7, 2024 •
edited
Loading

Board/Shield Check-list

  • This board/shield is tested working on real hardware
  • General consistent formatting of DeviceTree files
  • Keymaps do not use deprecated key defines (Check using the upgrader tool)
  • 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)

Adding physical layouts and updating keymaps for Jian, Jiran and Jorne keyboards.

@krikun98 krikun98 requested a review from a team as a code owner October 7, 2024 00:21
@krikun98
Copy link
Contributor Author

krikun98 commented Oct 7, 2024

Jorne update was tested on working hardware with nrfmicro_13 boards, Jian layouts were tested on the Jorian840 (physically identical board), and the Jiran layouts were checked with https://zmk-physical-layout-converter.streamlit.app - currently looking for testers for these two shields.

@krikun98 krikun98 mentioned this pull request Oct 7, 2024
Open
45 tasks
@krikun98 krikun98 changed the title Krikun98 physical layouts Physical layouts for Jian, Jiran and Jorne Oct 7, 2024
@krikun98 krikun98 changed the title Physical layouts for Jian, Jiran and Jorne feat(shields): add physical layouts for Jian, Jiran and Jorne Oct 7, 2024
@krikun98
Copy link
Contributor Author

krikun98 commented Oct 7, 2024 •
edited
Loading

Moved layouts to shield directories, added feat(shields): to commits.

petejohanson
petejohanson approved these changes Oct 9, 2024
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.

All seems reasonable to me. Please let me know once you've had testers confirm, or if you're ok with merging as is and allowing testing later. Thanks!

@krikun98 krikun98 force-pushed the krikun98_physical_layouts branch 2 times, most recently from 86726ca to 0023f98 Compare October 10, 2024 08:44
@caksoylar
Copy link
Contributor

In #2544 we are naming the individual position map labels <layout_name>_posmap, where <layout_name> is the one referred to in physical-layout property. It'd be good to conform to those here, at least for the shared layout.

@petejohanson
Copy link
Contributor

@krikun98 We've so far only been putting shared layout in place for layouts that are sufficiently common for reuse. I only see the Jian using the shared Jian layout in this PR. Is it used elsewhere that we need to elevate it at this point?

@krikun98
Copy link
Contributor Author

@krikun98 We've so far only been putting shared layout in place for layouts that are sufficiently common for reuse. I only see the Jian using the shared Jian layout in this PR. Is it used elsewhere that we need to elevate it at this point?

The Jiran is re-using two of the Jian's layouts right in the PR: app/boards/shields/jiran/layouts/6column.dtsi and app/boards/shields/jiran/layouts/jian.dtsi. There are also out-of-tree boards that re-use the layout - Jorian840, Jiran BLE, etc.

@krikun98
feat(shields): add physical layouts and update keymap for Jorne
1f72189 
Add physical layouts and update the keymap for Joric's Jorne.
Layouts are added for all three possible transforms:
- Full (with additional pinky key)
- 6 column (Corne), re-uses Corne layout
- 5 column (Minidox), re-uses Corne layout

Keymap update includes quick-tap-ms (essential for this keymap), small
guide clarifications, output selection, tri-layer and &studio_unlock.
@krikun98
feat(shields): add physical layouts and update keymap for Jian
2a951fd 
Add physical layouts and update the keymap for King of Hedgehogs' Jian.
Layouts are added for all three possible transforms:
- Full (with additional pinky key)
- 6 column (Corne)
- 5 column (Minidox)

The layouts are added to be re-usable for the Jiran and other custom boards/shields.

Keymap update includes, small guide clarifications, output selection,
tri-layer and &studio_unlock.
@krikun98
feat(shields): add physical layouts and update keymap for Jiran
575c77a 
Add physical layouts and update the keymap for Ladniy's Jiran.
Layouts are added for all three possible transforms:
- Full (with additional pinky key and number row)
- Jian (with additional pinky key), re-uses Jian layout
- 6 column (Corne), re-uses Jian layout

Keymap update includes &studio_unlock.
@krikun98
Copy link
Contributor Author

In #2544 we are naming the individual position map labels <layout_name>_posmap, where <layout_name> is the one referred to in physical-layout property. It'd be good to conform to those here, at least for the shared layout.

An earlier iteration of #2544 had the Corne mappings suffixed with _mapping, which is what I based all of these off. Refactored to _posmap.

petejohanson
petejohanson approved these changes Oct 16, 2024
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.

Thanks!

@petejohanson petejohanson merged commit 11537eb into zmkfirmware:main Oct 16, 2024
30 checks passed
@caksoylar caksoylar added shields PRs and issues related to shields studio ZMK Studio (runtime keymaps) labels Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petejohanson petejohanson petejohanson approved these changes

Assignees
No one assigned
Labels
shields PRs and issues related to shields studio ZMK Studio (runtime keymaps)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@krikun98 @caksoylar @petejohanson