implement rgb matrix for momokai keyboards (#19904)

Co-authored-by: jack <0x6a73@protonmail.com>

keyboards/momokai/tap_duo/config.h

@@ -38,84 +38,61 @@
 
 //TODO: implement RGB Matrix
 #define RGB_DI_PIN F0
-#define RGBLED_NUM 4
-#define RGBLIGHT_HUE_STEP 8
-#define RGBLIGHT_SAT_STEP 8
-#define RGBLIGHT_VAL_STEP 8
+#ifdef RGB_MATRIX_ENABLE
+#define RGB_MATRIX_LED_COUNT 4
+#define RGB_MATRIX_KEYPRESSES // reacts to keypresses
+#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#define RGB_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended
+#    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 200
+    // RGB Matrix Animation modes. Explicitly enabled
+    // For full list of effects, see:
+    // https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
+    #define ENABLE_RGB_MATRIX_SOLID_COLOR
+    #define ENABLE_RGB_MATRIX_ALPHAS_MODS
+    #define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+    #define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
+    #define ENABLE_RGB_MATRIX_BREATHING
+    #define ENABLE_RGB_MATRIX_BAND_SAT
+    #define ENABLE_RGB_MATRIX_BAND_VAL
+    #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+    #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+    #define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+    #define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+    #define ENABLE_RGB_MATRIX_CYCLE_ALL
+    #define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+    #define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
+    #define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+    #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
+    #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+    #define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
+    #define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+    #define ENABLE_RGB_MATRIX_DUAL_BEACON
+    #define ENABLE_RGB_MATRIX_RAINBOW_BEACON
+    #define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+    #define ENABLE_RGB_MATRIX_RAINDROPS
+    #define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+    #define ENABLE_RGB_MATRIX_HUE_BREATHING
+    #define ENABLE_RGB_MATRIX_HUE_PENDULUM
+    #define ENABLE_RGB_MATRIX_HUE_WAVE
+    #define ENABLE_RGB_MATRIX_PIXEL_RAIN
+    #define ENABLE_RGB_MATRIX_PIXEL_FLOW
+    #define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
 
-#define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_RAINBOW_SWIRL
+    // enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
+    #define ENABLE_RGB_MATRIX_TYPING_HEATMAP
+    #define ENABLE_RGB_MATRIX_DIGITAL_RAIN
 
-
-/*== all animations enable ==*/
-//  #define RGBLIGHT_ANIMATIONS
-/*== or choose animations ==*/
-  #define RGBLIGHT_EFFECT_BREATHING
-  #define RGBLIGHT_EFFECT_RAINBOW_MOOD
-  #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
-  #define RGBLIGHT_EFFECT_SNAKE
-  #define RGBLIGHT_EFFECT_KNIGHT
-  #define RGBLIGHT_EFFECT_CHRISTMAS
-  #define RGBLIGHT_EFFECT_STATIC_GRADIENT
-  #define RGBLIGHT_EFFECT_RGB_TEST
-  #define RGBLIGHT_EFFECT_ALTERNATING
-
-// #ifdef RGB_DI_PIN
-// #define DRIVER_LED_TOTAL 5
-
-// #define RGB_MATRIX_KEYPRESSES // reacts to keypresses
-// // #    define RGBLIGHT_LIMIT_VAL 180 // Limit to vendor-recommended value
-// #endif
-// #ifdef RGB_MATRIX_ENABLE
-// // #    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 180 // Limit to vendor-recommended value
-//     // RGB Matrix Animation modes. Explicitly enabled
-//     // For full list of effects, see:
-//     // https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
-//     #define ENABLE_RGB_MATRIX_SOLID_COLOR
-//     #define ENABLE_RGB_MATRIX_ALPHAS_MODS
-//     #define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
-//     #define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
-//     #define ENABLE_RGB_MATRIX_BREATHING
-//     // #define ENABLE_RGB_MATRIX_BAND_SAT
-//     // #define ENABLE_RGB_MATRIX_BAND_VAL
-//     // #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
-//     // #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
-//     // #define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
-//     // #define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
-//     #define ENABLE_RGB_MATRIX_CYCLE_ALL
-//     #define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
-//     #define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
-//     // #define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
-//     #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
-//     // #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
-//     #define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
-//     #define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
-//     // #define ENABLE_RGB_MATRIX_DUAL_BEACON
-//     #define ENABLE_RGB_MATRIX_RAINBOW_BEACON
-//     // #define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
-//     #define ENABLE_RGB_MATRIX_RAINDROPS
-//     #define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
-//     #define ENABLE_RGB_MATRIX_HUE_BREATHING
-//     #define ENABLE_RGB_MATRIX_HUE_PENDULUM
-//     #define ENABLE_RGB_MATRIX_HUE_WAVE
-//     #define ENABLE_RGB_MATRIX_PIXEL_RAIN
-//     #define ENABLE_RGB_MATRIX_PIXEL_FLOW
-//     #define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
-
-//     // enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
-//     // #define ENABLE_RGB_MATRIX_TYPING_HEATMAP
-//     // #define ENABLE_RGB_MATRIX_DIGITAL_RAIN
-
-//     // enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
-//     #define ENABLE_RGB_MATRIX_SOLID_REACTIVE
-//     #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
-//     #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
-//     #define ENABLE_RGB_MATRIX_SPLASH
-//     // #define ENABLE_RGB_MATRIX_MULTISPLASH
-//     #define ENABLE_RGB_MATRIX_SOLID_SPLASH
-//     // #define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
-// #endif
+    // enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
+    // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+    #define ENABLE_RGB_MATRIX_SPLASH
+    #define ENABLE_RGB_MATRIX_MULTISPLASH
+    #define ENABLE_RGB_MATRIX_SOLID_SPLASH
+    #define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
+#endif

keyboards/momokai/tap_duo/rules.mk

@@ -8,7 +8,8 @@ CONSOLE_ENABLE = no         # Console for debug
 COMMAND_ENABLE = no         # Commands for debug and configuration
 NKRO_ENABLE = no            # Enable N-Key Rollover
 BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
-RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
 AUDIO_ENABLE = no           # Audio output
-
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = WS2812
 LTO_ENABLE = yes

keyboards/momokai/tap_duo/tap_duo.c

@@ -16,16 +16,16 @@
 
 #include "tap_duo.h"
 
-// #ifdef RGB_MATRIX_ENABLE
-// led_config_t g_led_config = { {
-//     // Key Matrix to LED Index
-//     { 0, 1, 2, NO_LED, NO_LED, NO_LED}
-// }, {
-//     // LED Index to Physical Position
-//     {  56,  0}, { 112,  0}, { 168,  0}, { 0,  64}, { 224,  64}
-// }, {
-//     // LED Index to Flag
-//     4,4,4,2,2
-// } };
+#ifdef RGB_MATRIX_ENABLE
+led_config_t g_led_config = { {
+    // Key Matrix to LED Index
+    { 0, 1, NO_LED, NO_LED, NO_LED}
+}, {
+    // LED Index to Physical Position
+    { 112,  0}, { 168,  0}, { 0,  64}, { 224,  64}
+}, {
+    // LED Index to Flag
+    4,4,2,2
+} };
 
-// #endif
+#endif

keyboards/momokai/tap_trio/config.h

@@ -25,81 +25,64 @@
 
 //TODO: implement RGB Matrix
 #define RGB_DI_PIN F0
-#define RGBLED_NUM 5
-#define RGBLIGHT_HUE_STEP 8
-#define RGBLIGHT_SAT_STEP 8
-#define RGBLIGHT_VAL_STEP 8
+// #define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_RAINBOW_SWIRL
 
-#define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_RAINBOW_SWIRL
 
+#ifdef RGB_MATRIX_ENABLE
+#define RGB_MATRIX_LED_COUNT 5
+#define RGB_MATRIX_KEYPRESSES // reacts to keypresses
+#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#define RGB_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended
+#    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 200
+    // RGB Matrix Animation modes. Explicitly enabled
+    // For full list of effects, see:
+    // https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
+    #define ENABLE_RGB_MATRIX_SOLID_COLOR
+    #define ENABLE_RGB_MATRIX_ALPHAS_MODS
+    #define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+    #define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
+    #define ENABLE_RGB_MATRIX_BREATHING
+    #define ENABLE_RGB_MATRIX_BAND_SAT
+    #define ENABLE_RGB_MATRIX_BAND_VAL
+    #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+    #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+    #define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+    #define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+    #define ENABLE_RGB_MATRIX_CYCLE_ALL
+    #define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+    #define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
+    #define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+    #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
+    #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+    #define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
+    #define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+    #define ENABLE_RGB_MATRIX_DUAL_BEACON
+    #define ENABLE_RGB_MATRIX_RAINBOW_BEACON
+    #define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+    #define ENABLE_RGB_MATRIX_RAINDROPS
+    #define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+    #define ENABLE_RGB_MATRIX_HUE_BREATHING
+    #define ENABLE_RGB_MATRIX_HUE_PENDULUM
+    #define ENABLE_RGB_MATRIX_HUE_WAVE
+    #define ENABLE_RGB_MATRIX_PIXEL_RAIN
+    #define ENABLE_RGB_MATRIX_PIXEL_FLOW
+    #define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
 
-  #define RGBLIGHT_EFFECT_BREATHING
-  #define RGBLIGHT_EFFECT_RAINBOW_MOOD
-  #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
-  #define RGBLIGHT_EFFECT_SNAKE
-  #define RGBLIGHT_EFFECT_KNIGHT
-  #define RGBLIGHT_EFFECT_CHRISTMAS
-  #define RGBLIGHT_EFFECT_STATIC_GRADIENT
-  #define RGBLIGHT_EFFECT_RGB_TEST
-  #define RGBLIGHT_EFFECT_ALTERNATING
+    // enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
+    #define ENABLE_RGB_MATRIX_TYPING_HEATMAP
+    #define ENABLE_RGB_MATRIX_DIGITAL_RAIN
 
-// #ifdef RGB_DI_PIN
-// #define RGB_MATRIX_LED_COUNT 5
-
-// #define RGB_MATRIX_KEYPRESSES // reacts to keypresses
-// // #    define RGBLIGHT_LIMIT_VAL 180 // Limit to vendor-recommended value
-// #endif
-// #ifdef RGB_MATRIX_ENABLE
-// // #    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 180 // Limit to vendor-recommended value
-//     // RGB Matrix Animation modes. Explicitly enabled
-//     // For full list of effects, see:
-//     // https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
-//     #define ENABLE_RGB_MATRIX_SOLID_COLOR
-//     #define ENABLE_RGB_MATRIX_ALPHAS_MODS
-//     #define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
-//     #define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
-//     #define ENABLE_RGB_MATRIX_BREATHING
-//     // #define ENABLE_RGB_MATRIX_BAND_SAT
-//     // #define ENABLE_RGB_MATRIX_BAND_VAL
-//     // #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
-//     // #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
-//     // #define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
-//     // #define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
-//     #define ENABLE_RGB_MATRIX_CYCLE_ALL
-//     #define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
-//     #define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
-//     // #define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
-//     #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
-//     // #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
-//     #define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
-//     #define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
-//     // #define ENABLE_RGB_MATRIX_DUAL_BEACON
-//     #define ENABLE_RGB_MATRIX_RAINBOW_BEACON
-//     // #define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
-//     #define ENABLE_RGB_MATRIX_RAINDROPS
-//     #define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
-//     #define ENABLE_RGB_MATRIX_HUE_BREATHING
-//     #define ENABLE_RGB_MATRIX_HUE_PENDULUM
-//     #define ENABLE_RGB_MATRIX_HUE_WAVE
-//     #define ENABLE_RGB_MATRIX_PIXEL_RAIN
-//     #define ENABLE_RGB_MATRIX_PIXEL_FLOW
-//     #define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
-
-//     // enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
-//     // #define ENABLE_RGB_MATRIX_TYPING_HEATMAP
-//     // #define ENABLE_RGB_MATRIX_DIGITAL_RAIN
-
-//     // enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
-//     #define ENABLE_RGB_MATRIX_SOLID_REACTIVE
-//     #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
-//     #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
-//     // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
-//     #define ENABLE_RGB_MATRIX_SPLASH
-//     // #define ENABLE_RGB_MATRIX_MULTISPLASH
-//     #define ENABLE_RGB_MATRIX_SOLID_SPLASH
-//     // #define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
-// #endif
+    // enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
+    // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+    #define ENABLE_RGB_MATRIX_SPLASH
+    #define ENABLE_RGB_MATRIX_MULTISPLASH
+    #define ENABLE_RGB_MATRIX_SOLID_SPLASH
+    #define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
+#endif

keyboards/momokai/tap_trio/rules.mk

@@ -8,7 +8,8 @@ CONSOLE_ENABLE = no         # Console for debug
 COMMAND_ENABLE = no         # Commands for debug and configuration
 NKRO_ENABLE = no            # Enable N-Key Rollover
 BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
-RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
 AUDIO_ENABLE = no           # Audio output
-
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = WS2812
 LTO_ENABLE = yes

keyboards/momokai/tap_trio/tap_trio.c

@@ -16,16 +16,16 @@
 
 #include "tap_trio.h"
 
-// #ifdef RGB_MATRIX_ENABLE
-// led_config_t g_led_config = { {
-//     // Key Matrix to LED Index
-//     { 0, 1, 2, NO_LED, NO_LED, NO_LED}
-// }, {
-//     // LED Index to Physical Position
-//     {  56,  0}, { 112,  0}, { 168,  0}, { 0,  64}, { 224,  64}
-// }, {
-//     // LED Index to Flag
-//     4,4,4,2,2
-// } };
+#ifdef RGB_MATRIX_ENABLE
+led_config_t g_led_config = { {
+    // Key Matrix to LED Index
+    { 0, 1, 2, NO_LED, NO_LED, NO_LED}
+}, {
+    // LED Index to Physical Position
+    {  56,  0}, { 112,  0}, { 168,  0}, { 0,  64}, { 224,  64}
+}, {
+    // LED Index to Flag
+    4,4,4,2,2
+} };
 
-// #endif
+#endif