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

Adds support for the Ahokore V2 #743

Closed
wants to merge 3 commits into from

Conversation

dezlidezlidezli
Copy link

Hello all! This pull request adds support for the Ahokore V2, PCB files available in here. This is a wireless board (no shield) with designed with an nrf52840 holyiot module.

Please let me know if merging my code into main is the wrong thing to do at this point of ZMK's existence. I contacted Pete just before opening this, and he said merging into main would be a good idea for now.

The original Ahokore will not be produced at scale, and I do not see anyone else other than existing owners using it, so it will not be merged into main and the Ahokore V2 may take the name "ahokore".

To do before merged:

  • code reviews
  • add Ahokore to setup.sh - I attempted to do this myself, but it appears this system is designed only for keyboards that consist of a board and a shield, and I saw no clean way to add the Ahokore. Please let me know how to go about this.

@Nicell Nicell added board PRs and issues related to boards. enhancement New feature or request labels Jan 30, 2022
@Nicell
Copy link
Member

Nicell commented Jan 30, 2022

@dezlidezlidezli This message wasn't put here when the metadata changes came out. Please review these changes if you'd like to update and get this board merged in! Some parts may not be applicable to your board FYI.

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.

@lesshonor
Copy link
Contributor

lesshonor commented Jul 7, 2024

This PR should probably be closed at this point.

Anyone wishing to build Ahokore for ZMK should work with its zmk-config repository—or perhaps better, this module-ified fork.

@caksoylar caksoylar closed this Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
board PRs and issues related to boards. enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants