Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER #10231

fauxpark · 2020-09-03T18:53:45Z

Description

~~It's probably about time we deprecated this.~~

Heads up to keymap owners:
~~@drashna - crkbd, layouts/ortho_4x12~~
~~@bcat - crkbd~~
@Curry - crkbd
@dsanchezseco - crkbd
@kidBrazil - crkbd
@ninjonas - crkbd
~~@rpbaptist - crkbd~~
~~@soundmonster - crkbd~~
@Salicylic-acid3 - naked48, setta21
~~@kageurufu - rgbkb/sol~~
~~@XScorpion2 - rgbkb/sol~~
~~@toshi0383 - zinc~~
~~@tominabox1 - userspace~~

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

LGTM

noroadsleft

Looks good, pending user approval.

zvecr

Personally i would rather have and enable = yes/no and driver = IS31blah.

zvecr · 2020-09-30T21:14:17Z

XScorpion2

meh, don't understand why 2 defines is better than 1, but approved anyways.

fauxpark · 2020-10-01T12:55:12Z

@XScorpion2
The idea is that users should not need to know which specific driver is used on a given board to turn RGB matrix on if it is supported but not enabled by default.

zvecr · 2020-10-01T12:59:19Z

I guess there was a little context missing in my previous comment. Having the 2 parts of the logic split has a few benefits,

Configurator can just end up with a enable/disable toggle switch without having to know what driver is the correct one to specify
Where not enabled by default (rev6 planck is a good example), it allows users to not have to dig for the correct driver setting
Userspace "disable rgb matrix by default, but enable it on this single board" only has to interact with the enable flag

XScorpion2 · 2020-10-01T13:09:04Z

Thanks for the extra context, coffee hit too which helps

noroadsleft

Based on users/tominabox1/rules.mk, it seems keyboards/lazydesigners/dimple/rules.mk should have:

RGB_MATRIX_ENABLE = no
RGB_MATRIX_DRIVE = WS2812

tominabox1

the Dimple does not support rgb_matrix in the default sense. I was planning on working on it some time ago and never did it. Shouldn't add this to the keyboard folder.

Would suggest removing the RGB_Matrix stuff from the Dimple section of my userspace rules.mk.

I approve the change for CRKBD in my rules.

Erovia

LGTM

keyboards/crkbd/keymaps/soundmonster/rules.mk

drashna · 2020-11-19T17:30:31Z

Has some merge conflicts

fauxpark · 2020-11-22T11:58:05Z

I think we may need one more rebase of develop so I can include more recent boards which have RGB Matrix, so that we don't break them.

* Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change

* Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (qmk#10183) * Add support for soft serial to ATmega32U2 (qmk#10204) * Change MIDI velocity implementation to allow direct control of velocity value (qmk#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (qmk#10417) * Joystick 16-bit support (qmk#10439) * Per-encoder resolutions (qmk#10259) * Share button state from mousekey to pointing_device (qmk#10179) * Add hotfix for chibios keyboards not wake (qmk#10088) * Add advanced/efficient RGB Matrix Indicators (qmk#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (qmk#10206) * Add milc as a dependency and remove the installed milc (qmk#10563) * ChibiOS upgrade: early init conversions (qmk#10214) * ChibiOS upgrade: configuration file migrator (qmk#9952) * Haptic and solenoid cleanup (qmk#9700) * XD75 cleanup (qmk#10524) * OLED display update interval support (qmk#10388) * Add definition based on currently-selected serial driver. (qmk#10716) * New feature: Retro Tapping per key (qmk#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (qmk#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (qmk#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (qmk#8669) * Minor change to behavior allowing display updates to continue between task ticks (qmk#10750) * Some GPIO manipulations in matrix.c change to atomic. (qmk#10491) * qmk cformat (qmk#10767) * [Keyboard] Update the Speedo firmware for v3.0 (qmk#10657) * Maartenwut/Maarten namechange to evyd13/Evy (qmk#10274) * [quantum] combine repeated lines of code (qmk#10837) * Add step sequencer feature (qmk#9703) * aeboards/ext65 refactor (qmk#10820) * Refactor xelus/dawn60 for Rev2 later (qmk#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (qmk#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (qmk#10549) * update chibios os usb for the otg driver (qmk#8893) * Remove HD44780 References, Part 4 (qmk#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (qmk#10512) * Fix cursor position bug in oled_write_raw functions (qmk#10800) * Fixup version.h writing when using SKIP_VERSION=yes (qmk#10972) * Allow for certain code in the codebase assuming length of string. (qmk#10974) * Add AT90USB support for serial.c (qmk#10706) * Auto shift: support repeats and early registration (qmk#9826) * Rename ledmatrix.h to match .c file (qmk#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (qmk#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (qmk#10840) * Merge point for 2020 Nov 28 Breaking Change

fauxpark added enhancement keyboard labels Sep 3, 2020

fauxpark requested a review from a team September 3, 2020 18:53

drashna approved these changes Sep 3, 2020

View reviewed changes

drashna requested a review from a team September 3, 2020 19:41

noroadsleft approved these changes Sep 4, 2020

View reviewed changes

drashna requested a review from a team September 5, 2020 23:34

fauxpark force-pushed the rgb-matrix-yes-to-3731 branch from b2f87de to 42da2d2 Compare September 16, 2020 07:47

zvecr reviewed Sep 30, 2020

View reviewed changes

fauxpark changed the title ~~Change RGB_MATRIX_ENABLE = yes to IS31FL3731~~ Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER Sep 30, 2020

fauxpark requested review from noroadsleft, drashna, zvecr and a team September 30, 2020 21:04

zvecr approved these changes Sep 30, 2020

View reviewed changes

fauxpark added breaking_change Changes that need to wait for a version increment core labels Oct 1, 2020

fauxpark force-pushed the rgb-matrix-yes-to-3731 branch from 60222eb to 6786b72 Compare October 1, 2020 04:56

drashna approved these changes Oct 1, 2020

View reviewed changes

drashna requested a review from a team October 1, 2020 05:03

XScorpion2 approved these changes Oct 1, 2020

View reviewed changes

noroadsleft reviewed Oct 1, 2020

View reviewed changes

tominabox1 reviewed Oct 1, 2020

View reviewed changes

Erovia approved these changes Oct 1, 2020

View reviewed changes

kageurufu approved these changes Oct 1, 2020

View reviewed changes

fauxpark force-pushed the rgb-matrix-yes-to-3731 branch from 7eec18b to 05013e1 Compare October 1, 2020 17:35

soundmonster reviewed Nov 18, 2020

View reviewed changes

keyboards/crkbd/keymaps/soundmonster/rules.mk Show resolved Hide resolved

fauxpark force-pushed the rgb-matrix-yes-to-3731 branch from ee2da81 to 218f5ba Compare November 22, 2020 16:55

fauxpark added 6 commits November 28, 2020 21:52

Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER

3d75648

Add some missed ones

3b671f4

Remove commented out RGB_MATRIX_ENABLE

ba324ca

Add new ones since develop rebase

5c33f29

Update for new boards

296b9ee

Update one last time for duckypad

b66090e

fauxpark force-pushed the rgb-matrix-yes-to-3731 branch from 218f5ba to b66090e Compare November 28, 2020 10:54

fauxpark added 2 commits November 28, 2020 22:05

Merge branch 'develop' into rgb-matrix-yes-to-3731

7d8fc4b

Remove enable flag for zygomorph

495c4b0

noroadsleft approved these changes Nov 28, 2020

View reviewed changes

noroadsleft merged commit 2e64269 into qmk:develop Nov 28, 2020

fauxpark deleted the rgb-matrix-yes-to-3731 branch November 28, 2020 11:28

fauxpark mentioned this pull request Jan 14, 2021

Add Launch Pad VIA support #11238

Closed

14 tasks

BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024

Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (qmk#10231)

dc5d4b6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER #10231

Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER #10231

fauxpark commented Sep 3, 2020 •

edited

Loading

drashna left a comment

noroadsleft left a comment

zvecr left a comment

zvecr commented Sep 30, 2020

XScorpion2 left a comment

fauxpark commented Oct 1, 2020

zvecr commented Oct 1, 2020

XScorpion2 commented Oct 1, 2020

noroadsleft left a comment

tominabox1 left a comment

Erovia left a comment

drashna commented Nov 19, 2020

fauxpark commented Nov 22, 2020

Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER #10231

Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER #10231

Conversation

fauxpark commented Sep 3, 2020 • edited Loading

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

zvecr left a comment

Choose a reason for hiding this comment

zvecr commented Sep 30, 2020

XScorpion2 left a comment

Choose a reason for hiding this comment

fauxpark commented Oct 1, 2020

zvecr commented Oct 1, 2020

XScorpion2 commented Oct 1, 2020

noroadsleft left a comment

Choose a reason for hiding this comment

tominabox1 left a comment

Choose a reason for hiding this comment

Erovia left a comment

Choose a reason for hiding this comment

drashna commented Nov 19, 2020

fauxpark commented Nov 22, 2020

fauxpark commented Sep 3, 2020 •

edited

Loading