zmk icon indicating copy to clipboard operation
zmk copied to clipboard

feat(shields): Add Breeze

Open idan opened this issue 3 years ago • 5 comments

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: https://github.com/zmkfirmware/zmk/pull/735

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

Board/Shield Check-list

  • [x] This board/shield is tested working on real hardware
  • [x] Definitions follow the general style of other shields/boards upstream (Reference)
  • [x] .zmk.yml metadata file added
  • [x] 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)
  • [x] General consistent formatting of DeviceTree files
  • [x] Keymaps do not use deprecated key defines (Check using the upgrader tool)
  • [x] &pro_micro used in favor of &pro_micro_d/a if applicable
  • [x] If split, no name added for the right/peripheral half
  • [x] Kconfig.defconfig file correctly wraps all configuration in conditional on the shield symbol
  • [x] .conf file has optional extra features commented out
  • [x] 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)

idan avatar Feb 07 '22 19:02 idan

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

idan avatar May 04 '22 15:05 idan

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

houllette avatar Jan 21 '24 06:01 houllette

@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.

caksoylar avatar Jan 21 '24 07:01 caksoylar

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.

lesshonor avatar Jan 21 '24 14:01 lesshonor

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

houllette avatar Jan 21 '24 21:01 houllette