VIA support for Planck Rev6

[mixedfeelings]

Description

Adds simple VIA support for Planck Rev6 with a default QWERTY layout

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Issues Fixed or Closed by This PR

Checklist

• My code follows the code style of this project.
• 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).

[mixedfeelings]

@jackhumbert wanted me to tag him for approval of the vendor / product IDs before merging.

[noroadsleft]

LGTM pending approval of the Vendor and Product IDs.

[Erovia]

There is going to be a problem with this.
Rev6 uses a different matrix from all the others (rev1-rev5, ez).
Since the PID is defined at the keyboard level, it will be used for all revisions, VIA will recognize them but will not work.

My proposal is to:

• either move the PID definition to the revision level for each board
• or use one PID for rev6 (defined at the rev level) and another one for all the other boards. (since they have the same matrix layout, one VIA json should work for them)

[mixedfeelings]

@Erovia it seems like the latter option would be the easiest to implement as you would only need two JSONs (for now). Perhaps the PID could refer to matrix revision rather than actual product.

@jackhumbert did you have any further thoughts on VID / PID?

Thanks for looking at this, everyone!

[Erovia]

In any case, 2 json should be enough.
In the first case, the rev1-rev5,ez boards could share the same PID.

I kinda hate the idea of repeating the same thing 6 different places, but also hate the idea of having 1 exception. ¯\(ツ)/¯

[drashna]

Does VIA not read the DEVICE_VER?

[noroadsleft]

Does VIA not read the DEVICE_VER?

It does not.

[mixedfeelings]

Thanks everyone, I guess that leaves me in a holding pattern until it is decided how to handle PIDs for the multiple Planck matrices.

[fauxpark]

Personally I'd like to see VIA take into account the DEVICE_VER value. This seems like the perfect use case for it.

[Erovia]

@Wilba6582 @olivia @yiancar
Could you please weigh in on this topic?

[jackhumbert]

The split between the versions happens at the microcontroller level (rev1-5 vs rev6 & ez), so I think we can use these values (all have the Vendor ID of 0xFEED):

• rev1-5: 0xAE01
• rev6 & ez 0xA4F9

These were generated with the strings "Planck AVR" and "Planck ARM" using the (somewhat) standard command:

 echo -n "<PRODUCT>" | shasum | cut -c1-4 |tr '[:lower:]' '[:upper:]'

[mixedfeelings]

Good info, @jackhumbert, thank you. Do you have any thoughts on VendorID? I don't think we can use 0xFEED for VIA.

For @noroadsleft, @Erovia, @fauxpark: Does the microcontroller level distinction get us around this particular block for the purpose of officially supporting VIA for planck?

[fauxpark]

I think we should probably also make a distinction between the rev6 (ARM) and EZ, which would be 0xC6CF.

[drashna]

For @noroadsleft, @Erovia, @fauxpark: Does the microcontroller level distinction get us around this particular block for the purpose of officially supporting VIA for planck?

It should, I think. The AVR versions have no real differences, other than backlight/rgb support, and bootloader, IIRC. Everything else is the same.

I think we should probably also make a distinction between the rev6 (ARM) and EZ, which would be 0xC6CF.

For the Planck EZ, would prefer this, specifically:

#define VENDOR_ID       0x3297
#define PRODUCT_ID      0xC6CF

[mixedfeelings]

Would the olkb pcb's have the same VID as the EZ, or is that vendor ID unique to ZSA boards?

[drashna]

Would the olkb pcb's have the same VID as the EZ, or is that vendor ID unique to ZSA boards?

The Vender ID is unique and belongs to ZSA. It shouldn't be used for the OLKB boards (the EZ is a collaboration board between ZSA and OLKB/jack, but is sold and maintained by ZSA)

https://www.the-sz.com/products/usbid/index.php?v=0x3297&p=&n=

[rstacruz]

Hey all, I'd like to give this a try. Can I compile a firmware from this branch, and expect it to work with the VIA app?

I assume this requires a .json file for Via with a keymap, any hints on how I can generate one?

[mixedfeelings]

I assume this requires a .json file for Via with a keymap, any hints on how I can generate one?

Here you go: https://github.com/mixedfeelings/keyboards/tree/planck-rev6.1/src/olkb/planck/rev6

I haven't submitted a PR to VIA yet, as I am waiting for the blockers here to get resolved.

[jackhumbert]

Just to recap, the Planck EZ should remain untouched (it already has its VID/PID set) and these settings for config.h for the Planck Rev 1-5 will work for me:

#undef PRODUCT_ID
#define PRODUCT_ID 0xAE01

the Planck Rev 6:

#undef PRODUCT_ID
#define PRODUCT_ID 0xA4F9

and the Planck Light:

#undef PRODUCT_ID
#define PRODUCT_ID 0xBEA2

I'd like to keep 0xFEED as the Vendor ID for the above, if that's an option.

[mixedfeelings]

I'd like to keep 0xFEED as the Vendor ID for the above, if that's an option.

Thanks, @jackhumbert! Understood on all the above points, but unfortunately 0xFEED can't be used for VIA. They require the Vendor ID to be unique and specific.

[jackhumbert]

Right! Some of that is coming back to me - let's use 0x03A8 for the VID. This was going to be the QMK-wide one at some point (with PIDs generated via command I mentioned earlier), but those plans haven't really been fleshed out yet.

[mixedfeelings]

@jackhumbert You beat me too it, thank you so much!!

[drashna]

For reference, is there a Product ID to use for the Planck THK (#12597)?

[jackhumbert]

For reference, is there a Product ID to use for the Planck THK (#12597)?

Just added!