feat(shields): Add Breeze

[idan]

Add a shield definition for the Breeze split keyboard from Afternoon
labs.

This is for the standard breeze variant, with the arrow keys present
on the right half but not the left.

Definition is based in part on an abandoned PR by @devries:
#735

Signed-off-by: Idan Gazit [email protected]
Co-authored-by: devriesp [email protected]

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)

[peterlvno]

@idan based on the keymap (line 61), shouldn't the order of the arrows be like this?

|   <-  |   v   |  ^  |  ->   |

[idan]

Ah good catch @peterlvno! The keymap is correct, it's the illustrative comments that are wrong. I'll correct later today, I have also made some other tweaks to this layout that make sense as a default. Thank you!

[idan]

@peterlvno okay, I cleaned up the default keymap to something way simpler in 0973971, and I think there are no lingering mistakes!

[petejohanson]

Couple minor things.

[Nicell]

One comment on the new transform added, and then if you could delete breeze_left.conf and breeze_right.conf, that'd be perfect. We're keeping only the main shield.conf file in tree.

[idan]

@Nicell @petejohanson bump; I think this should be ready now?

[Nicell]

@idan Sorry, I found one more thing on this review, then I think we're good to go.

[Nicell]

I see these are the same GPIO as the ones in the left .overlay. This can probably just be put in the .dtsi then instead of in each, right? The left side can just have the include line and on the right side the include and row offset.

[houllette]

Howdy! I am looking to adapt my Afternoon Breeze to use ZMK - any chance I could bump this issue and hope y'all could push it over the finish line? I'm wayyy to new to this project to even have a hope of closing it out myself haha

[caksoylar]

@houllette If you want to unblock yourself, you can copy the app/boards/shields/breeze folder from this PR's tree into your config repo, after creating one with some other keyboard or creating an empty one by using the template. You'd place it under the boards/shields/ folder and the build process will pick up the files from there. This modular approach is fully supported by design in ZMK.

[lesshonor]

Howdy! I am looking to adapt my Afternoon Breeze to use ZMK - any chance I could bump this issue and hope y'all could push it over the finish line? I'm wayyy to new to this project to even have a hope of closing it out myself haha

While the pull requests are still open, the main ZMK repository is de facto not accepting shield additions or changes.

Consider forking Afternoon Labs' config repository. While it doesn't have all the improvements of #1312, being under the Afternoon Labs account gives it additional visibility. So it likely has the highest chance of being maintained.

[houllette]

@caksoylar @lesshonor - thank you both so much! This should be enough to go off of; I appreciate it!