Add KPRepublic/BM40hsrgb rev2

[rgoulter]

For KPRepublic's BM40 rev2.

The code in this PR is similar to #15060 (@peepeetee's PR for KPRepublic's BM65 rev2) and #15177 (peepeetee's PR on behalf of bdtc123 for BM60 rev2). -- And especially similar to #16452 (which also aims to add KPRepublic BM40 rev2), except this PR copies the BM65 rev2's custom RGB matrix driver for the IS31FL (used for per-key RGB) and WS2821B (used for underglow RGB).

This is a breaking change.

Instead of:

qmk compile --keyboard kprepublic/bm40hsrgb --keymap defaultr

The older rev1 PCBs now have /rev1 added; thus should be built with:

qmk compile --keyboard kprepublic/bm40hsrgb/rev2 --keymap default

(fyi people with bm40 keymaps: @gabustoledo
gabustoledo, @lmlask
lmlask).

Description

• Move kprepublic/bm40hsrgb code to rev1 directory.
• Add code for the BM40 rev2 (copy-pasting the custom RGB matrix driver IS31FL3733 + WS2812 from aforementioned PRs).

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

[peepeetee]

Question:
Is this a duplicate of #16452?

[rgoulter]

@peepeetee it is! I'd searched the github issues for "BM40" and "kprepublic" and couldn't see a PR for it 😅 :

("bm40hsrgb" would've found it).

The code is a bit different. This PR handles the WS2812 underglow LEDs whereas #16452 does not uses the underglow LEDs with RGB Light instead of RGB Matrix.

[spider9375]

Is there anything that prevents this PR from merging?

[SyreeseOfficial]

Hello all! I'm trying to build a BM40 build. My PCB is the rev2 model. I've never built a keeb or flashed a keeb until this (my first attempt). I'm also completely new to GitHub. Is there any way I can use this info to get my keyboard working? All the keys are wrong and most of them don't work. Thanks for any help. Pls lmk if there's any other info I can provide as well. I'll also link to my reddit post asking for help that has some images attached along with more info on the problem (HERE).

[rgoulter]

@SyreeseOfficial you'll probably get quicker help asking on discord.

For getting your qmk_firmware to have the code in this PR, this comment is useful

qmk_firmware/keyboards/planck/rev6/rules.mk

Line 33 in 4791cfa

LAYOUTS = ortho_4x12 planck_mit

which gives the following git commands to run in qmk_firmware:

git fetch origin pull/<PR_NUMBER>/head:review/<PR_NUMBER>
git checkout review/<PR_NUMBER>
git rebase develop

[hienvd]

Any new updates guys?
I'm waiting for this PR to configure my BM40 rev2

[rafael-malmegrin]

Any new updates guys? I'm waiting for this PR to configure my BM40 rev2

I managed to flash my BM40v2 with the files from this pull, if you have a local QMK environment setup you can do it. I got a warning saying the firmware had almost no bytes left but it worked, I was able to duplicate and edit the default keymap and flash it, it's working fine on both of my v2 pcb's.

[rgoulter]

I got a warning saying the firmware had almost no bytes left but it worked

Adding

LTO_ENABLE = yes

to rules.mk in the keymap helps. https://docs.qmk.fm/#/squeezing_avr

[rafael-malmegrin]

LTO_ENABLE = yes

That did help, compiled my keymap again and did not get the warning, thanks.

[seth-rah]

Just to understand the system

The outdated change requests, do they require approval before the PR can be merged or is it just a case of needing enough approvals?

As one has been there for more than a year and might just be a blocker if those rules exist.

[rgoulter]

I see that PRs targetting develop are merged again. I think that was the last thing blocking this PR?

[fauxpark]

kprepublic/bm40hsrgb/rev2:via seems to be failing CI. User keymaps are no issue, but the default and via keymaps at least must compile, in order to merge.

[MattNemeth]

I don't currently have another keyboard to test this but I have experienced a bug when combining TT(layer x) + TO(layer y). I imagine this is not specific to this PR but cannot confirm and will wait until this is merged before opening an issue on the main qmk repo. The issue is as follows:

1. Hold TT(layer x) key
2. When on layer x, tap a TO(layer y) key
3. Resulting functionality is activating layer x (as if it was pressed enough times to enable the tap toggle)

When layer x is toggled on, TO(layer y) works as expected. Using MO(layer y) instead of TT(layer y) works as expected and goes to layer y.

[rgoulter]

I see the QMK CI build finished, I see that default and via keymaps are passing for kprepublic/bm40hsrgb/rev2.

[MattNemeth]

If anyone else was struggling to find up to date info on how to get firmware built and working for their new BM40 Rev 2 using QMK this is the way to do it as of the time of this comment. Hopefully this will be merged soon and be on the official repo soon but if it still isn't, use this PR. Lots of outdated info across the web about this board over the past few years with broken links. Hopefully this comment will save someone the hours I spent trying to figure out how to flash this "QMK Fully Compatible" board as they claim on KPRepublic...

[dornyika]

If anyone else was struggling to find up to date info on how to get firmware built and working for their new BM40 Rev 2 using QMK this is the way to do it as of the time of this comment. Hopefully this will be merged soon and be on the official repo soon but if it still isn't, use this PR. Lots of outdated info across the web about this board over the past few years with broken links. Hopefully this comment will save someone the hours I spent trying to figure out how to flash this "QMK Fully Compatible" board as they claim on KPRepublic...

Sorry I'm missing something. How do I suppose to do it?

[seth-rah]

@waffle87 & @zvecr

Does this MR require your approval to move forward? As the old comments appear to be outdated

[MattNemeth]

@dornyika if you havent got it working yet you'll need to clone the original QMK repo and checkout this pull request. You can make/modify/create your own keymap starting with the default and get it working this way

[rgoulter]

🎉

[tristanware]

Huge thanks to @rgoulter for all the effort!