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 Gherkin Sheild #355

Closed
wants to merge 7 commits into from
Closed

Conversation

davidphilipbarr
Copy link
Contributor

Gherkin shield with default keymap.

@innovaker innovaker added enhancement New feature or request shields PRs and issues related to shields labels Nov 10, 2020
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 making this shield! I have a few comments, and then there's a couple files that still need to be added/updated:

.github/workflows/build.yml: Add your board to the shield list.

gherkin.conf: This file should be added even if it's blank, so that it's copied into user-configs properly

docs/docs/hardware.md: You should add the Gherkin to this list

docs/static/setup.ps1 and docs/static/setup.sh: Gherkin should be added as a non-split option for both files.

Comment on lines +15 to +27
default_transform: keymap_transform_0 {
compatible = "zmk,matrix-transform";
columns = <6>;
rows = <5>;
map = <
RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,5)
RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5)
RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5)
RC(3,0) RC(3,1) RC(3,2) RC(3,3) RC(3,4) RC(3,5)
RC(4,0) RC(4,1) RC(4,2) RC(4,3) RC(4,4) RC(4,5)

>;
};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't believe this is necessary as this keyboard is a perfect grid. Similar to it missing in the planck seen here: https://github.com/zmkfirmware/zmk/blob/main/app/boards/arm/planck/planck_rev6.dts#L20

It doesn't hurt to include this I suppose, but it's also superfluous.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't actually own a gherkin to test on, so i'm too afraid to delete this because gherkin does have a git of a funny matrix, but if you're confident i can remove it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added references to the other files.

if SHIELD_GHERKIN

config ZMK_KEYBOARD_NAME
default "GHERKIN"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick, is "GHERKIN" all caps the actual name? I've always seen it as "Gherkin".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a fair cop, renamed to Gherkin

Comment on lines +11 to +12
#define DEFAULT 0

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#define DEFAULT 0

Unused define.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DELETED

Comment on lines +20 to +24
RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,5)
RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5)
RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5)
RC(3,0) RC(3,1) RC(3,2) RC(3,3) RC(3,4) RC(3,5)
RC(4,0) RC(4,1) RC(4,2) RC(4,3) RC(4,4) RC(4,5)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we do keep this transform, it should be in the shape of the Gherkin (3x10?) not 5x6.

@innovaker
Copy link
Contributor

Is this PR dead?

@davidphilipbarr
Copy link
Contributor Author

Apologies, I haven't been able to test the transform changes requested as I don't have access to a gherkin.

I know it works 'as is' but I'd be unable to test further changes. I'll keep it available in my own zmk-config. But I guess consider it closed.

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