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

Add Contra shield #633

Merged
merged 8 commits into from
Jan 30, 2022
Merged

Add Contra shield #633

merged 8 commits into from
Jan 30, 2022

Conversation

iangus
Copy link
Contributor

@iangus iangus commented Jan 24, 2021

  • Adds shield configuration for the Contra PCB
  • Tested on nice!nano

@Nicell Nicell self-requested a review January 26, 2021 16:39
@Nicell Nicell added shields PRs and issues related to shields enhancement New feature or request labels Jan 26, 2021
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.

@iangus This looks good! Clean and simple shield by the looks of it. Could you update the copyright year please?

app/boards/shields/contra/Kconfig.defconfig Outdated Show resolved Hide resolved
app/boards/shields/contra/Kconfig.shield Outdated Show resolved Hide resolved
@iangus
Copy link
Contributor Author

iangus commented Jan 29, 2021

@Nicell updated the copyright headers to 2021 with ceee2ec

@Nicell
Copy link
Member

Nicell commented Jan 29, 2021

@iangus Thanks for the quick response. We unfortunately have a long queue of shields we're working through, which requires a rebase after each one is merged in. I'll ping you again here when you're up for bat and we need you to rebase/make final changes.

@iangus
Copy link
Contributor Author

iangus commented Jan 29, 2021

@Nicell sounds good. Just mention me here or in the discord, and I'll get this rebased/ready for merge.

@iangus iangus requested a review from Nicell September 22, 2021 21:26
@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.

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.

Thanks for the contribution!

@Nicell Nicell merged commit 4039a50 into zmkfirmware:main Jan 30, 2022
PedroDiogo pushed a commit to PedroDiogo/zmk that referenced this pull request Feb 7, 2022
* Add Contra Shield (zmkfirmware#1)

* Add bluetooth control layer to contra keymap (zmkfirmware#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
mirandaflu pushed a commit to mirandaflu/zmk that referenced this pull request Jun 5, 2022
* Add Contra Shield (zmkfirmware#1)

* Add bluetooth control layer to contra keymap (zmkfirmware#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
violet-fish pushed a commit to violet-fish/zmk that referenced this pull request Jun 19, 2022
* Add Contra Shield (#1)

* Add bluetooth control layer to contra keymap (#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
fsargent pushed a commit to fsargent/zmk that referenced this pull request Jul 11, 2022
* Add Contra Shield (zmkfirmware#1)

* Add bluetooth control layer to contra keymap (zmkfirmware#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
alinelena pushed a commit to alinelena/zmk that referenced this pull request Aug 24, 2022
* Add Contra Shield (#1)

* Add bluetooth control layer to contra keymap (#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
tyalie pushed a commit to tyalie/zmk that referenced this pull request Nov 15, 2022
* Add Contra Shield (#1)

* Add bluetooth control layer to contra keymap (#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
abondis pushed a commit to abondis/zmk that referenced this pull request Feb 12, 2023
* Add Contra Shield (zmkfirmware#1)

* Add bluetooth control layer to contra keymap (zmkfirmware#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
abondis pushed a commit to abondis/zmk that referenced this pull request Feb 12, 2023
* Add Contra Shield (zmkfirmware#1)

* Add bluetooth control layer to contra keymap (zmkfirmware#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
abondis pushed a commit to abondis/zmk that referenced this pull request Feb 14, 2023
* Add Contra Shield (zmkfirmware#1)

* Add bluetooth control layer to contra keymap (zmkfirmware#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
NikolaRavic pushed a commit to NikolaRavic/zmk-firmware that referenced this pull request Feb 27, 2023
* Add Contra Shield (#1)

* Add bluetooth control layer to contra keymap (#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
yuanbin pushed a commit to yuanbin/zmk that referenced this pull request Jun 14, 2023
* Add Contra Shield (moergo-sc#1)

* Add bluetooth control layer to contra keymap (moergo-sc#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
FearlessSpiff pushed a commit to FearlessSpiff/zmk that referenced this pull request Oct 31, 2023
* Add Contra Shield (#1)

* Add bluetooth control layer to contra keymap (urob#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
FearlessSpiff pushed a commit to FearlessSpiff/zmk that referenced this pull request Oct 31, 2023
* Add Contra Shield (#1)

* Add bluetooth control layer to contra keymap (urob#2)

* fix contra keymap issues

* add bluetooth control layer

* clean up contra files

* add contra.conf file

* add missing bracket for default_layer

* update copyright year to 2021

* add contra metadata file

* refactor pro micro overlay for new syntax
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.

3 participants