Add Canoe Gen2 #10344

evyd13 · 2020-09-17T14:57:21Z

Description

Adds the Canoe Gen2. It has per key RGB using the ws2812 protocol.

Types of Changes

Issues Fixed or Closed by This PR

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).

drashna

I'm not really a fan of the folder name. /percent/canoe/gen2 or rev2 would be better, I think.

keyboards/percent/canoegen2/keymaps/via/rules.mk

keyboards/percent/canoegen2/canoegen2.h

keyboards/percent/canoegen2/canoegen2.c

noroadsleft

I'm not really a fan of the folder name. /percent/canoe/gen2 or rev2 would be better, I think.

I agree with @drashna about this. The folder name should definitely be percent/canoe/gen2 or percent/canoe/rev2.

Summary of Requested Changes

rename LAYOUT_65_ansi to LAYOUT_65_ansi_blocker_split_bs
rename LAYOUT_65_iso to LAYOUT_65_iso_blocker_split_bs
update Community Layout support per the above (though based on keyboard renders 65_(ansi|iso) layouts are almost undoubtedly supported)

keyboards/percent/canoegen2/canoegen2.h

keyboards/percent/canoegen2/info.json

keyboards/percent/canoegen2/keymaps/default/keymap.c

keyboards/percent/canoegen2/rules.mk

str-dst · 2020-09-25T13:22:53Z

I'm not really a fan of the folder name. /percent/canoe/gen2 or rev2 would be better, I think.

I agree with @drashna about this. The folder name should definitely be percent/canoe/gen2 or percent/canoe/rev2.

Imho no because that would give the impression that the boards are in some way related to each other design or pcb wise which is entirely not the case.
The Gen 2 is a complete redesign with an entirely different PCB (the gen 1 used a ps2avr PCB).
The only similarity between these boards is that they are called Canoe.

The Gen2 is not just a revision of the Gen1

fauxpark · 2020-09-25T13:25:25Z

The same is technically true of the Planck and Preonic...

str-dst · 2020-09-25T13:30:28Z

Putting the boards in one folder would be like putting Keycult boards in one folder named TKL with subfolders named No1 and No2 because "technically" they are just another version of the Keycult TKL.

It doesn't make sense because it's not just some revision of the board.
The first board was called Canoe. The second Canoe Gen2.
So it makes sense to put it in a folder called canoegen2.

drashna · 2020-09-25T19:13:54Z

The first board was called Canoe. The second Canoe Gen2.

Both boards use the same layout, correct? If so, then revision works fine here.
That's fauxparks point with the planck and preonic. Specifically, there are 4 different planck boards, the Rev1-5, the Rev6, the EZ, and the Light. They're all "planck" but the matrix and features and controller are all different. Rev1-5 uses atmega32u4, the rev6 and EZ use stm32f303, and the light uses at90usb1286. The EZ and Light use per key RGB, using different ISSI controllers), etc.

So having a different controller, a different matrix and different features really isn't a good reason to have a completely different name and folder.

And there are plenty of other boards that follow this pattern too (for instance, the helix).

So it makes sense to put it in a folder called canoegen2.

IMO, no it doesn't, given the precedent already in the repo.

However canoe/gen2 would also be fine. and looks better than canoegen2.

Erovia · 2020-09-25T19:19:15Z

So it makes sense to put it in a folder called canoegen2.

Not just looks better, but is what the users familiar with QMK are expecting.

jackhumbert · 2020-09-25T19:21:20Z

It doesn't make sense because it's not just some revision of the board.

I think "gen" is functionally the same as "rev" here, so should get the same treatment.

Usually when introducing another revision, what code was previously just keyboard/ gets moved to keyboard/rev1/, and any shared code can be moved to back to keyboard/. This allows folks to easily use the same keymap between both revisions without having to copy it into the new keyboard's folder.

str-dst · 2020-09-25T19:44:46Z

It doesn't make sense because it's not just some revision of the board.

I think "gen" is functionally the same as "rev" here, so should get the same treatment.

No it is not. Again: this is not a "revision" of the board.
It's an entirely new design and should be treated as such.

Just because they are the same layout doesn't make them the same board.
The boards do not share anything but the layout and a part of the name.

Moving the old board in a folder named gen1 makes even less sense since there is no Canoe Gen1. It's only "Canoe".

Putting them in the same folder would most likely cause confusion with the users since it would give the impression that the boards are in some way compatible with each other which is not the case.

str-dst · 2020-09-25T20:01:15Z

The first board was called Canoe. The second Canoe Gen2.

Both boards use the same layout, correct? If so, then revision works fine here.

This doesn't make any sense at all.
Just because a board has the same layout doesn't mean that it's in any way a similar keyboard.
By that logic we could just place all boards by the same designer in folders named after the layouts.

The planck example does not apply here because the planck with all it's PCB revisions is still the same board and all the PCBs are compatible with the Planck case.
This is simply not the case with the Canoe Gen2.

Again: This is an entirely new design and the boards are in no way compatible with each other.
The Gen2 PCB does not fit the original Canoe case and vice versa.
Placing the two boards in the same folder would imply that the boards are compatible with each other.

fauxpark · 2020-09-25T20:06:40Z

it would give the impression that the boards are in some way compatible with each other which is not the case.

The only compatibility that really matters here is the layout support, as we aim to abstract away the hardware-specific stuff for exactly this reason.

The planck example does not apply here because the planck with all it's PCB revisions is still the same board

As Drashna mentioned above, the different revisions of the Planck use different MCUs (and I believe the rev6 was designed by someone else whereas most/all of the earlier revs were designed by Wilba). So I think it very much applies here.

The very fact that this board is named "Gen2" kind of implies that a gen1 also exists. I'd argue that is more confusing to users.

str-dst · 2020-09-25T20:10:34Z

it would give the impression that the boards are in some way compatible with each other which is not the case.

The only compatibility that really matters here is the layout support, as we aim to abstract away the hardware-specific stuff for exactly this reason.

The planck example does not apply here because the planck with all it's PCB revisions is still the same board

As Drashna mentioned above, the different revisions of the Planck use different MCUs (and I believe the rev6 was designed by someone else whereas most/all of the earlier revs were designed by Wilba). So I think it very much applies here.

The very fact that this board is named "Gen2" kind of implies that a gen1 also exists. I'd argue that is more confusing to users.

"Canoe Gen2" is the name of the board. It's not "Canoe" generation 2 or something. Yes technically this could be seen like this but it is meant as the name of the board here.

And again it is not just the MCU or matrix that is different on the new PCB. It does not fit the original Canoe case.

fauxpark · 2020-09-25T20:18:20Z

So why does the website say "revision"?

As for it not fitting the case - AFAICT it doesn't seem like you can buy the PCB on its own, so that doesn't matter anyway.

str-dst · 2020-09-25T20:19:32Z

So why does the website say "revision"?

As for it not fitting the case - AFAICT it doesn't seem like you can buy the PCB on its own, so that doesn't matter anyway.

You can't right now but there are more PCBs planned. A hotswap PCB should become available later this year for the board as well as a separately available soldered PCB.

jackhumbert · 2020-09-25T20:23:51Z

After talking to kingnestea on the Percent Studio discord, they're ok with /percent/canoe_gen2 - if you can update the keyboard name to that, that'd be great!

noroadsleft

#10344 (comment) still needs changing; the via keymap won't compile without this change (LAYOUT_65_iso doesn't exist).

noroadsleft

Looks good to me.

noroadsleft · 2020-09-26T05:39:19Z

Thanks!

evyd13 · 2020-09-26T05:44:07Z

Thank you!

* 'master' of https://github.com/qmk/qmk_firmware: (3643 commits) Swapparoo of bottom row keys (qmk#10277) [Keyboard] Add PloopyCo devices (qmk#7935) Keyboard update: SL40 (qmk#10445) [keyboard] Add SP-111 support (qmk#10193) Add logic for AT90USBxx7 where needed (qmk#10203) Trifecta Keymap [Docs] Wording & formatting changes in the Tapping Force Hold section of the Tap Hold page + removed trailing whitespaces (qmk#10391) `setrgb()`: Use arrow operator (qmk#10451) [Keyboard] add Percent Canoe Gen2 (qmk#10344) [Keyboard] add hannah65 by Team Mechlovin (qmk#10284) Fix Belgian sendstring properly (qmk#10444) Add VIA support for lazydesigners/the30 (qmk#10374) [Keyboard] add duckboard by doodboard (qmk#10318) Fix Belgian sendstring file (qmk#10443) [Keyboard] added Bolsa65 keyboard by FJLabs (qmk#10394) CLI/Doctor: Print QMK_HOME (qmk#10398) Add Wyvern Keyboard (qmk#10378) Adding Bear 65 Ergo Keyboard To QMK (qmk#10384) VIA Support: Gray Studio HB85 (qmk#10329) format code according to conventions [skip ci] ...

* Add Canoe Gen2 * Fix info.json * Update info.json * Changes * Move canoegen2 to canoe_gen2 * Update canoe_gen2.h

evyd13 added 3 commits September 17, 2020 16:51

Add Canoe Gen2

713ba81

Fix info.json

54ab0cd

Update info.json

80a1b51

drashna approved these changes Sep 20, 2020

View reviewed changes

drashna requested a review from a team September 20, 2020 23:18

drashna added the keyboard label Sep 20, 2020

fauxpark requested changes Sep 21, 2020

View reviewed changes

drashna requested a review from a team September 22, 2020 05:30

noroadsleft requested changes Sep 23, 2020

View reviewed changes

Changes

a7fce3e

drashna self-requested a review September 25, 2020 19:01

Move canoegen2 to canoe_gen2

6bfbe86

noroadsleft requested changes Sep 26, 2020

View reviewed changes

Update canoe_gen2.h

91ec059

fauxpark approved these changes Sep 26, 2020

View reviewed changes

noroadsleft approved these changes Sep 26, 2020

View reviewed changes

noroadsleft merged commit 1b7101f into qmk:master Sep 26, 2020

evyd13 mentioned this pull request Sep 26, 2020

Add Canoe Gen2 the-via/keyboards#339

Merged

6 tasks

evyd13 deleted the canoegen2 branch September 26, 2020 05:50

rgoulter pushed a commit to rgoulter/qmk_firmware that referenced this pull request Oct 4, 2020

[Keyboard] add Percent Canoe Gen2 (qmk#10344)

7fd393e

* Add Canoe Gen2 * Fix info.json * Update info.json * Changes * Move canoegen2 to canoe_gen2 * Update canoe_gen2.h

kjganz pushed a commit to kjganz/qmk_firmware that referenced this pull request Oct 28, 2020

[Keyboard] add Percent Canoe Gen2 (qmk#10344)

bb56f77

* Add Canoe Gen2 * Fix info.json * Update info.json * Changes * Move canoegen2 to canoe_gen2 * Update canoe_gen2.h

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Canoe Gen2 #10344

Add Canoe Gen2 #10344

evyd13 commented Sep 17, 2020

drashna left a comment

noroadsleft left a comment

str-dst commented Sep 25, 2020 •

edited

Loading

fauxpark commented Sep 25, 2020

str-dst commented Sep 25, 2020

drashna commented Sep 25, 2020

Erovia commented Sep 25, 2020 •

edited

Loading

jackhumbert commented Sep 25, 2020

str-dst commented Sep 25, 2020 •

edited

Loading

str-dst commented Sep 25, 2020 •

edited

Loading

fauxpark commented Sep 25, 2020

str-dst commented Sep 25, 2020

fauxpark commented Sep 25, 2020

str-dst commented Sep 25, 2020

jackhumbert commented Sep 25, 2020 •

edited

Loading

noroadsleft left a comment

noroadsleft left a comment

noroadsleft commented Sep 26, 2020

evyd13 commented Sep 26, 2020

Add Canoe Gen2 #10344

Add Canoe Gen2 #10344

Conversation

evyd13 commented Sep 17, 2020

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

drashna left a comment

Choose a reason for hiding this comment

noroadsleft left a comment

Choose a reason for hiding this comment

Summary of Requested Changes

str-dst commented Sep 25, 2020 • edited Loading

fauxpark commented Sep 25, 2020

str-dst commented Sep 25, 2020

drashna commented Sep 25, 2020

Erovia commented Sep 25, 2020 • edited Loading

jackhumbert commented Sep 25, 2020

str-dst commented Sep 25, 2020 • edited Loading

str-dst commented Sep 25, 2020 • edited Loading

fauxpark commented Sep 25, 2020

str-dst commented Sep 25, 2020

fauxpark commented Sep 25, 2020

str-dst commented Sep 25, 2020

jackhumbert commented Sep 25, 2020 • edited Loading

noroadsleft left a comment

Choose a reason for hiding this comment

noroadsleft left a comment

Choose a reason for hiding this comment

noroadsleft commented Sep 26, 2020

evyd13 commented Sep 26, 2020

str-dst commented Sep 25, 2020 •

edited

Loading

Erovia commented Sep 25, 2020 •

edited

Loading

str-dst commented Sep 25, 2020 •

edited

Loading

str-dst commented Sep 25, 2020 •

edited

Loading

jackhumbert commented Sep 25, 2020 •

edited

Loading