Add gBoards GergoPlex firmware #10406

pirj · 2020-09-23T15:09:04Z

Description

Add firmware for gBoards GergoPlex.

This PR differ from the original GergoPlex pull request:

rebased on master (in hopes for breaking changes to be removed, since it doesn't affect any existing firmware, but introduces a new one)
[...] code review notes addressed
code layout fixed
prettified layouts (at the cost of using LAYOUT_kc instead of LAYOUT_split_3x5_3, asked a question how to benefit from both)
removed Via layout (it doesn't support chords/combos and is useless on a 35% keyboard)

All @germ's original commits are left intact.

Not done

Is a custom matrix really needed?

According to custom_matrix.md:

The reasons to use [custom matrix] ... I/O multiplexer

And MCP23018, I/O port expander, is used for the left half of the split keyboard.

feature_split_keyboard.md suggests:

assumes that you're using two Pro Micro-compatible controllers

And GergoPlex is only using one AVR, and MCP is used for the other half (just like ErgoDox EZ, torn, spiderisland/split78, moonlander, ymdk/sp64, wheatfield/split75, sx60, net_type_a, hotdox, handwired/ferris, ergotaco, other gBoards keyboards, and a fair number of keyboards using PORT_EXPANDER_ADDRESS in their firmwares).

I hope to get rid of at least a part of the custom matrix code using MATRIX_ROW_PINS, MATRIX_COL_PINS, DIODE_DIRECTION.
Also to only keep a fraction of MCP23018 code with SPLIT_KEYBOARD=true and SPLIT_TRANSPORT=custom, SOFT_SERIAL_PIN, USE_I2C etc.
Will do this in a follow-up, since it's not too straightforward.

Types of Changes

Keyboard (addition or update)

Issues Fixed or Closed by This PR

Replaces Gboards Consolidation #8262, gBoards GergoPlex #8928
Depends on gBoards Common #8921 (merged)

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Co-Authored-By: Drashna Jaelre <[email protected]>

Co-authored-by: Drashna Jaelre <[email protected]>

Via doesn't support chords/combos, and this makes the keymap on such a small keyboard quite uncomfortable and incomplete.

pirj · 2020-10-05T09:07:23Z

keyboards/gboards/gergoplex/gergoplex.c

+
+    // unused pins - C7, D4, D5, D7, E6
+    // set as input with internal pull-up enabled
+    DDRB &= ~(1 << 0 | 1 << 4 | 1 << 5 | 1 << 6 | 1 << 7);


I intend to replace this according to this comment:

We rather use the GPIO control functions: https://docs.qmk.fm/#/internals_gpio_control?id=functions

keyboards/gboards/gergoplex/rules.mk

baylessj · 2020-10-06T15:57:18Z

Hi @pirj! I just received my Gergoplex and I'm looking to start personalizing my keymap. I don't see the Gergoplex layout in master yet, should I create a fork off of yours to start my modifications? I also see a couple other PRs opened by Germ for this board, not sure which one is the best base to work off of.

pirj · 2020-10-06T17:38:16Z

Hey @baylessj . Got ahead, check out this branch and test it. It's currently driving my GergoPlex with no issues. It's a cleanup and minor refactoring of the original pull request. I plan to work on this even further, but that shouldn't prevent you from hacking in your layout - default/keymap.c is very unlikely to undergo any changes.

baylessj · 2020-10-08T00:29:52Z

Thanks for working on this @pirj, currently typing on my fork of your fork. Took a bit to get used to the organization of the key combo code when modifying that but everything else was smooth sailing with making my keymap.

keyboards/gboards/gergoplex/gergoplex.h

keyboards/gboards/gergoplex/rules.mk

keyboards/gboards/gergoplex/config.h

caksoylar · 2020-11-06T19:39:54Z

FWIW I also have been running this branch (with @drashna's suggested changes on the layout definition applied) with my keymap for a week or so and haven't had any issues.

manna-harbour · 2020-11-30T04:43:05Z

Here is a commit to add split_3x5_3 LAYOUT support to this branch: manna-harbour@bba7a50

That branch can be used to build miryoku for the gergoplex by merging in the miryoku development branch.

ghost · 2020-11-30T17:06:38Z

Here is a commit to add split_3x5_3 LAYOUT support to this branch: manna-harbour@bba7a50

That branch can be used to build miryoku for the gergoplex by merging in the miryoku development branch.

I can confirm merging manna-harbour@bba7a50 and manna-harbour:miryoku into pirj:prettify-gergoplex builds and is functional on my GergoPlex with the command make gboards/gergoplex:manna-harbour_miryoku:flash
Thanks for the help @manna-harbour!

stale · 2021-01-15T09:20:01Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

bttnns · 2021-01-25T19:47:00Z

What else is left todo here?

sorry, new around here and have a gergoplex =)

yorickpeterse · 2021-01-26T13:39:57Z

Same here: I recently got a Gergoplex as well and have been using this PR, which thus far works great. It would be nice to see this merged into QMK at some point 😄

pirj · 2021-01-26T13:56:08Z

Sorry, it is taking me longer to get back to this.
I'm going to:

make changes requested during the review
try my chances with reusing existing code from custom_matrix=lite
and re-request a review.

yorickpeterse · 2021-03-04T13:04:37Z

Any progress on this pull request? I'd love to help out in whatever way I can, but my knowledge of QMK internals is pretty much non-existing. If anything needs testing, let me know 😄

stale · 2021-04-07T02:31:29Z

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.

baylessj · 2021-04-07T11:53:55Z

This really should still get merged in... @pirj are you able to get back to those action items you listed in your comment above? Or would you prefer if someone else takes over the finishing touches on the PR?

pirj · 2021-04-07T12:11:29Z

@baylessj Not yet. There are a few cosmetic things that need to be done. I appreciate if someone takes this over. Or I can do it, but I'd love to take a chance with reusing the code from ergodox, and this will take longer than just cosmetic changes.

pirj · 2021-05-28T15:10:57Z

PR updated. @drashna, please have a look.
I think I've addressed your concerns. Reopening the PR did not happen automatically, and I don't have an option to do so.

What has been done:

rebased on fresh master
got rid of LAYOUT_kc favoring LAYOUT_split_3x5_3
fixed matrix custom C code to build with updated external dependencies (gcc) (phex -> print_hex8, pbin_reverse16 -> print_bin_reverse16)
changed VENDOR_ID to 0x6B0A(rds) to match gBoards and not be suspiciously low (0x0007)
fixed combo layout docs
reworked custom matrix code not to use PORTx/DDRx directly
removed redundant #define statements
slightly updated docs

What has NOT been done:

in the custom matrix code rows and cols seem to be mixed up
the code is reading directly using PINF
~~KC_RMB/KC_LMB don't seem to work~~ fixed in gBoards GergoPlex #13027
SPLIT_KEYBOARD=yes

@germ do you mind having a look, and test it out, too?
@yorickpeterse, @baylessj, @stjoni, @caksoylar, @btannous appreciate if you can test this, too.

pirj · 2021-05-28T15:14:54Z

keyboards/gboards/gergoplex/gergoplex.c

+    // unused pins - C7, D4, D5, D7, E6
+    // set as input with internal pull-up enabled
+    DDRB &= ~(1 << 0 | 1 << 4 | 1 << 5 | 1 << 6 | 1 << 7);
+    PORTB |= (1 << 0 | 1 << 4 | 1 << 5 | 1 << 6 | 1 << 7);


I don't understand what's going on, it's updated in my branch that is linked to this PR https://github.com/pirj/qmk_firmware/blob/prettify-gergoplex/keyboards/gboards/gergoplex/gergoplex.c, but not here.

GitHub probably doesn't update closed PRs.

pirj · 2021-05-28T15:34:16Z

This PR doesn't seem to be updated with my branch updates for some reason.
I've opened up #13027. Sorry for the trouble.

bttnns · 2021-05-28T16:05:56Z

cloned pirj's branch, built, flashed and am running this latest update on my gergoplex, things seem OK - will update if something seems broken as I use the keyboard today

germ and others added 14 commits September 23, 2020 17:52

Moved gergoplex to seperate PR

8e3ed77

vendor + cformat

3cd63f4

Update keyboards/gboards/k/gergoplex/matrix.c

54f78e5

Co-Authored-By: Drashna Jaelre <[email protected]>

lifiting keyboards up

23350df

Update readme.md

56b0da7

Update keyboards/gboards/gergoplex/config.h

74376f0

Co-authored-by: Drashna Jaelre <[email protected]>

remove English dicts

c896a36

cformatted

9cafccb

Prettify keymap

e615d4f

Remove via keymaps

338d2c7

Via doesn't support chords/combos, and this makes the keymap on such a small keyboard quite uncomfortable and incomplete.

Address QMK pull code review notes

7f74660

Cleanup (tabs, excessive comments)

0f3da58

Fix keymap typos

5f48209

Use enum to define layers

8aa63f7

pirj marked this pull request as draft September 23, 2020 15:12

pirj mentioned this pull request Sep 23, 2020

Prettify GergoPlex keymap germ/qmk_firmware#23

Closed

15 tasks

drashna approved these changes Oct 4, 2020

View reviewed changes

drashna requested a review from a team October 4, 2020 20:09

drashna added the keyboard label Oct 4, 2020

pirj commented Oct 5, 2020

View reviewed changes

keyboards/gboards/gergoplex/rules.mk Show resolved Hide resolved

drashna requested changes Oct 13, 2020

View reviewed changes

keyboards/gboards/gergoplex/gergoplex.h Show resolved Hide resolved

keyboards/gboards/gergoplex/rules.mk Show resolved Hide resolved

caksoylar reviewed Oct 21, 2020

View reviewed changes

keyboards/gboards/gergoplex/config.h Show resolved Hide resolved

drashna reviewed Nov 4, 2020

View reviewed changes

keyboards/gboards/gergoplex/config.h Show resolved Hide resolved

drashna reviewed Nov 4, 2020

View reviewed changes

keyboards/gboards/gergoplex/config.h Show resolved Hide resolved

pirj mentioned this pull request Nov 28, 2020

gBoards GergoPlex #8928

Closed

2 tasks

stale bot added the awaiting changes label Jan 15, 2021

stale bot closed this Apr 7, 2021

pirj commented May 28, 2021

View reviewed changes

pirj mentioned this pull request May 28, 2021

gBoards GergoPlex #13027

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add gBoards GergoPlex firmware #10406

Add gBoards GergoPlex firmware #10406

pirj commented Sep 23, 2020 •

edited

Loading

pirj Oct 5, 2020

baylessj commented Oct 6, 2020

pirj commented Oct 6, 2020

baylessj commented Oct 8, 2020

caksoylar commented Nov 6, 2020

manna-harbour commented Nov 30, 2020

ghost commented Nov 30, 2020

stale bot commented Jan 15, 2021

bttnns commented Jan 25, 2021 •

edited

Loading

yorickpeterse commented Jan 26, 2021

pirj commented Jan 26, 2021

yorickpeterse commented Mar 4, 2021

stale bot commented Apr 7, 2021

baylessj commented Apr 7, 2021

pirj commented Apr 7, 2021

pirj commented May 28, 2021 •

edited

Loading

pirj May 28, 2021

fauxpark May 28, 2021

pirj commented May 28, 2021

bttnns commented May 28, 2021

Add gBoards GergoPlex firmware #10406

Add gBoards GergoPlex firmware #10406

Conversation

pirj commented Sep 23, 2020 • edited Loading

Description

Not done

Types of Changes

Issues Fixed or Closed by This PR

Checklist

pirj Oct 5, 2020

Choose a reason for hiding this comment

baylessj commented Oct 6, 2020

pirj commented Oct 6, 2020

baylessj commented Oct 8, 2020

caksoylar commented Nov 6, 2020

manna-harbour commented Nov 30, 2020

ghost commented Nov 30, 2020

stale bot commented Jan 15, 2021

bttnns commented Jan 25, 2021 • edited Loading

yorickpeterse commented Jan 26, 2021

pirj commented Jan 26, 2021

yorickpeterse commented Mar 4, 2021

stale bot commented Apr 7, 2021

baylessj commented Apr 7, 2021

pirj commented Apr 7, 2021

pirj commented May 28, 2021 • edited Loading

pirj May 28, 2021

Choose a reason for hiding this comment

fauxpark May 28, 2021

Choose a reason for hiding this comment

pirj commented May 28, 2021

bttnns commented May 28, 2021

pirj commented Sep 23, 2020 •

edited

Loading

bttnns commented Jan 25, 2021 •

edited

Loading

pirj commented May 28, 2021 •

edited

Loading