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.

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

feat(shield): Add Bat43 shield #956

Merged
merged 2 commits into from
Mar 14, 2022
Merged

feat(shield): Add Bat43 shield #956

merged 2 commits into from
Mar 14, 2022

Conversation

dnaq
Copy link
Contributor

@dnaq dnaq commented Sep 24, 2021

See https://kbd.dailycraft.jp/bat43/ for details.

The shield uses the default keymap of the bat43, with the tiny tactile
pushbuttons used for output selection and bluetooth functions.

@dxmh dxmh added enhancement New feature or request shields PRs and issues related to shields labels Sep 24, 2021
@petejohanson
Copy link
Contributor

Thank you, contributor, for your patience with how long review and merge of boards/shields has taken!

There are three recent refactors/changes to boards and shields that require some attention, and then we can finally get this PR merged!

  1. Hardware Metadata
  2. Pro Micro shield DT naming changes
  3. Split changes for BLE advertising

Hardware Metadata

The Problem

When first developing the process around contributing new shields/boards to ZMK, we failed to recognize that several key files (setup scripts, documentation page of supported hardware, and GH Action build.yml file) required changes, often in the same spot, for every PR. This resulted in immediate merge conflicts for every other PR after one was merged, which is a headache for contributors.

The Fix

By adding discrete metadata files that are located with the boards/shields in question, and using that metadata to generate setup scripts, website hardware list, etc., users can contributing new hardware descriptions without the need to change the same files that other contributors are changing.

Next Steps

First, refer to https://zmk.dev/docs/development/hardware-metadata-files to familiarize yourself with the new metadata file format.

Next, you have two options for fixing up your PR:

  1. If comfortable with git rebase, perform an interactive rebase and revert any changes to build.yml, hardware.md, or the setup scripts setup.sh/setup.ps1, and then add the new metadata YAML file. Then force push your branch. Or,
  2. Create a new branch from an up-to-date main, copy in the files for your new hardware, add the metadata file, then commit and push the new branch. Then, edit your open PR to point to your new branch.

Pro Micro shield DT naming changes

In #876, we have simplified the DT naming for the "nexus node" we expose for pro-micro compatible boards, deprecating the use of pro_micro_a, and renaming pro_micro_d node to simply pro_micro. For pro-micro boards and shields, you'll need to adjust your DT to use the proper names.

Please see https://zmk.dev/docs/development/new-shield#shield-overlays for the updated docs on this.

Split Shield Advertising Changes

In addition, if this is a split PR, please see #658 where we have changed our conventions to remove the the name from the right sides, to prevent users attempting to pair with them and causing split sync issues. This also includes removing the " Left" suffix from the naming on the left side. See the changes in that PR for examples of what to change with your split shield.

Getting Help

If you have any questions about any of these changes, please comment here and tag @zmkfirmware/boards-shields or ask in the #boards-shields Discord channel.

@dnaq
Copy link
Contributor Author

dnaq commented Oct 2, 2021

@petejohanson Updated the shield with the new pro micro pin names.

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.

Minor header tweaks needed, otherwise LGTM. Thanks!

app/boards/shields/bat43/bat43.keymap Show resolved Hide resolved
app/boards/shields/bat43/Kconfig.defconfig Outdated Show resolved Hide resolved
app/boards/shields/bat43/Kconfig.shield Outdated Show resolved Hide resolved
app/boards/shields/bat43/bat43.overlay Outdated Show resolved Hide resolved
@dnaq
Copy link
Contributor Author

dnaq commented Oct 9, 2021

@petejohanson done

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.

One small change I noticed! Please request my re-review after fixed 😄

app/boards/shields/bat43/bat43.keymap Outdated Show resolved Hide resolved
@Nicell Nicell dismissed petejohanson’s stale review March 14, 2022 05:42

All feedback addressed

@Nicell Nicell merged commit a1a8c30 into zmkfirmware:main Mar 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request shields PRs and issues related to shields
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants