[Keyboard] Add RGB Matrix support to id67 and add thewerther keymap

keyboards/id67/id67.c → keyboards/id67/default_rgb/default_rgb.c

@@ -14,4 +14,4 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "id67.h"
+#include "default_rgb.h"

keyboards/id67/default_rgb/readme.md

@@ -0,0 +1,19 @@
+# IDOBAO ID67
+
+A 65% hotswap keyboard from IDOBAO.
+
+## ANSI support:
+
+* Keyboard Maintainer: Tybera
+* Hardware Supported: IDOBAO ID67
+* Hardware Availability: [IDOBAO](https://www.idobao.net/products/idobao-id67-65-hot-swappable-mechanical-keyboard-kit-1)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make id67/default_rgb:default
+
+Flashing example for this keyboard:
+
+    make id67/default_rgb:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

keyboards/id67/readme.md

@@ -6,14 +6,24 @@ A 65% hotswap keyboard from IDOBAO.
 
 * Keyboard Maintainer: Tybera
 * Hardware Supported: IDOBAO ID67
-* Hardware Availability: [IDOBAO]https://www.idobao.net/products/idobao-id67-65-hot-swappable-mechanical-keyboard-kit-1
+* Hardware Availability: [IDOBAO](https://www.idobao.net/products/idobao-id67-65-hot-swappable-mechanical-keyboard-kit-1)
 
-Make example for this keyboard (after setting up your build environment):
+## Variants
 
-    make id67:default
+Currently there are two variants for the id67:
+1. `rgb_default` which uses the `RGB Lightning` feature for the on-board LEDs.
+2. `rgb` which uses the more advanced `RGB Matrix` feature for the per-key and underglow (bottom of PCB) LEDs.
 
-Flashing example for this keyboard:
+Make examples for this keyboard (after setting up your build environment):
 
-    make id67:default:flash
+    make id67/default_rgb:default
+
+    make id67/rgb:default
+
+Flashing examples for this keyboard:
+
+    make id67/default_rgb:default:flash
+
+    make id67/rgb:default:flash
 
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

keyboards/id67/rgb/config.h

@@ -0,0 +1,120 @@
+/* Copyright 2021 Tybera
+ * Copyright 2021 thewerther
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0x6964 /* "id" */
+#define PRODUCT_ID      0x0067
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    IDOBAO
+#define PRODUCT         ID67
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 15
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+ */
+#define MATRIX_ROW_PINS { B0, B1, B2, B3, F7 }
+#define MATRIX_COL_PINS { C7, F6, F5, F4, F1, B7, D5, D1, D2, D3, D4, D0, D6, D7, B4 }
+
+#define DIODE_DIRECTION COL2ROW
+#define RGB_DI_PIN F0
+
+// RGB Light config
+#if defined(RGBLIGHT_ENABLE)
+    #define RGBLED_NUM 77
+    #define RGBLIGHT_HUE_STEP 8
+    #define RGBLIGHT_SAT_STEP 8
+    #define RGBLIGHT_VAL_STEP 8
+    #define RGBLIGHT_LIMIT_VAL 150 /* The maximum brightness level */
+    #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+/*== 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
+#endif
+
+// RGB Matrix config
+#if defined(RGB_MATRIX_ENABLE)
+    #define DRIVER_LED_TOTAL 77
+    #define DRIVER_LED_UNDERGLOW 10
+
+    #define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended
+    #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255
+
+    #define RGB_MATRIX_KEYPRESSES
+    #define ENABLE_RGB_MATRIX_ALPHAS_MODS          // Static dual hue, speed is hue for secondary hue
+    #define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN     // Static gradient top to bottom, speed controls how much gradient changes
+    #define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT  // Static gradient left to right, speed controls how much gradient changes
+    #define ENABLE_RGB_MATRIX_BREATHING            // Single hue brightness cycling animation
+    #define ENABLE_RGB_MATRIX_BAND_SAT             // Single hue band fading saturation scrolling left to right
+    #define ENABLE_RGB_MATRIX_BAND_VAL             // Single hue band fading brightness scrolling left to right
+    #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT    // Single hue 3 blade spinning pinwheel fades saturation
+    #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL    // Single hue 3 blade spinning pinwheel fades brightness
+    #define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT      // Single hue spinning spiral fades saturation
+    #define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL      // Single hue spinning spiral fades brightness
+    #define ENABLE_RGB_MATRIX_CYCLE_ALL            // Full keyboard solid hue cycling through full gradient
+    #define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT     // Full gradient scrolling left to right
+    #define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN        // Full gradient scrolling top to bottom
+    #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN         // Full gradient scrolling out to in
+    #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL    // Full dual gradients scrolling out to in
+    #define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON  // Full gradent Chevron shapped scrolling left to right
+    #define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL       // Full gradient spinning pinwheel around center of keyboard
+    #define ENABLE_RGB_MATRIX_CYCLE_SPIRAL         // Full gradient spinning spiral around center of keyboard
+    #define ENABLE_RGB_MATRIX_DUAL_BEACON          // Full gradient spinning around center of keyboard
+    #define ENABLE_RGB_MATRIX_RAINBOW_BEACON       // Full tighter gradient spinning around center of keyboard
+    #define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS    // Full dual gradients spinning two halfs of keyboard
+    #define ENABLE_RGB_MATRIX_RAINDROPS            // Randomly changes a single key's hue
+    #define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS  // Randomly changes a single key's hue and saturation
+    #define ENABLE_RGB_MATRIX_HUE_BREATHING        // Hue shifts up a slight ammount at the same time, then shifts back
+    #define ENABLE_RGB_MATRIX_HUE_PENDULUM         // Hue shifts up a slight ammount in a wave to the right, then back to the left
+    #define ENABLE_RGB_MATRIX_HUE_WAVE             // Hue shifts up a slight ammount and then back down in a wave to the right
+#if defined(RGB_MATRIX_KEYPRESSES) || defined(RGB_MATRIX_KEYRELEASES)
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE// Pulses keys hit to hue & value then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE       // Static single hue, pulses keys hit to shifted hue then fades to current hue
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE       // Hue & value pulse near a single key hit then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE  // Hue & value pulse near multiple key hits then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS      // Hue & value pulse the same column and row of a single key hit then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS // Hue & value pulse the same column and row of multiple key hits then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS      // Hue & value pulse away on the same column and row of a single key hit then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS // Hue & value pulse away on the same column and row of multiple key hits then fades value out
+    #define ENABLE_RGB_MATRIX_SPLASH               // Full gradient & value pulse away from a single key hit then fades value out
+    #define ENABLE_RGB_MATRIX_MULTISPLASH          // Full gradient & value pulse away from multiple key hits then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_SPLASH         // Hue & value pulse away from a single key hit then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH    // Hue & value pulse away from multiple key hits then fades value out
+#endif // #if defined(RGB_MATRIX_KEYPRESSES) || defined(RGB_MATRIX_KEYRELEASES)
+#endif // #if defined(RGB_MATRIX_ENABLE)

keyboards/id67/rgb/info.json

@@ -0,0 +1,85 @@
+{
+    "keyboard_name": "ID67 RGB Matrix variant",
+    "url": "",
+    "maintainer": "qmk",
+    "layout_aliases": {
+        "LAYOUT": "LAYOUT_65_ansi_blocker"
+    },
+    "layouts": {
+        "LAYOUT_65_ansi_blocker": {
+            "layout": [
+                {"label":"K00 (B0,C7)", "x":0, "y":0},
+                {"label":"K01 (B0,F6)", "x":1, "y":0},
+                {"label":"K02 (B0,F5)", "x":2, "y":0},
+                {"label":"K03 (B0,F4)", "x":3, "y":0},
+                {"label":"K04 (B0,F1)", "x":4, "y":0},
+                {"label":"K05 (B0,B7)", "x":5, "y":0},
+                {"label":"K06 (B0,D5)", "x":6, "y":0},
+                {"label":"K07 (B0,D1)", "x":7, "y":0},
+                {"label":"K08 (B0,D2)", "x":8, "y":0},
+                {"label":"K09 (B0,D3)", "x":9, "y":0},
+                {"label":"K0A (B0,D4)", "x":10, "y":0},
+                {"label":"K0B (B0,D0)", "x":11, "y":0},
+                {"label":"K0C (B0,D6)", "x":12, "y":0},
+                {"label":"K0D (B0,D7)", "x":13, "y":0, "w":2},
+                {"label":"K0E (B0,B4)", "x":15, "y":0},
+
+                {"label":"K10 (B1,C7)", "x":0, "y":1, "w":1.5},
+                {"label":"K11 (B1,F6)", "x":1.5, "y":1},
+                {"label":"K12 (B1,F5)", "x":2.5, "y":1},
+                {"label":"K13 (B1,F4)", "x":3.5, "y":1},
+                {"label":"K14 (B1,F1)", "x":4.5, "y":1},
+                {"label":"K15 (B1,B7)", "x":5.5, "y":1},
+                {"label":"K16 (B1,D5)", "x":6.5, "y":1},
+                {"label":"K17 (B1,D1)", "x":7.5, "y":1},
+                {"label":"K18 (B1,D2)", "x":8.5, "y":1},
+                {"label":"K19 (B1,D3)", "x":9.5, "y":1},
+                {"label":"K1A (B1,D4)", "x":10.5, "y":1},
+                {"label":"K1B (B1,D0)", "x":11.5, "y":1},
+                {"label":"K1C (B1,D6)", "x":12.5, "y":1},
+                {"label":"K1D (B1,D7)", "x":13.5, "y":1, "w":1.5},
+                {"label":"K1E (B1,B4)", "x":15, "y":1},
+
+                {"label":"K20 (B2,C7)", "x":0, "y":2, "w":1.75},
+                {"label":"K21 (B2,F6)", "x":1.75, "y":2},
+                {"label":"K22 (B2,F5)", "x":2.75, "y":2},
+                {"label":"K23 (B2,F4)", "x":3.75, "y":2},
+                {"label":"K24 (B2,F1)", "x":4.75, "y":2},
+                {"label":"K25 (B2,B7)", "x":5.75, "y":2},
+                {"label":"K26 (B2,D5)", "x":6.75, "y":2},
+                {"label":"K27 (B2,D1)", "x":7.75, "y":2},
+                {"label":"K28 (B2,D2)", "x":8.75, "y":2},
+                {"label":"K29 (B2,D3)", "x":9.75, "y":2},
+                {"label":"K2A (B2,D4)", "x":10.75, "y":2},
+                {"label":"K2B (B2,D0)", "x":11.75, "y":2},
+                {"label":"K2D (B2,D7)", "x":12.75, "y":2, "w":2.25},
+                {"label":"K2E (B2,B4)", "x":15, "y":2},
+
+                {"label":"K30 (B3,C7)", "x":0, "y":3, "w":2.25},
+                {"label":"K32 (B3,F5)", "x":2.25, "y":3},
+                {"label":"K33 (B3,F4)", "x":3.25, "y":3},
+                {"label":"K34 (B3,F1)", "x":4.25, "y":3},
+                {"label":"K35 (B3,B7)", "x":5.25, "y":3},
+                {"label":"K36 (B3,D5)", "x":6.25, "y":3},
+                {"label":"K37 (B3,D1)", "x":7.25, "y":3},
+                {"label":"K38 (B3,D2)", "x":8.25, "y":3},
+                {"label":"K39 (B3,D3)", "x":9.25, "y":3},
+                {"label":"K3A (B3,D4)", "x":10.25, "y":3},
+                {"label":"K3B (B3,D0)", "x":11.25, "y":3},
+                {"label":"K3C (B3,D6)", "x":12.25, "y":3, "w":1.75},
+                {"label":"K3D (B3,D7)", "x":14, "y":3},
+                {"label":"K3E (B3,B4)", "x":15, "y":3},
+
+                {"label":"K40 (F7,C7)", "x":0, "y":4, "w":1.25},
+                {"label":"K41 (F7,F6)", "x":1.25, "y":4, "w":1.25},
+                {"label":"K43 (F7,F4)", "x":2.5, "y":4, "w":1.25},
+                {"label":"K46 (F7,D5)", "x":3.75, "y":4, "w":6.25},
+                {"label":"K4A (F7,D4)", "x":10, "y":4, "w":1.25},
+                {"label":"K4B (F7,D0)", "x":11.25, "y":4, "w":1.25},
+                {"label":"K4C (F7,D6)", "x":13, "y":4},
+                {"label":"K4D (F7,D7)", "x":14, "y":4},
+                {"label":"K4E (F7,B4)", "x":15, "y":4}
+            ]
+        }
+    }
+}

keyboards/id67/rgb/keymaps/thewerther/config.h

@@ -0,0 +1,91 @@
+/* Copyright 2021 thewerther
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#define DRIVER_LED_UNDERGLOW 10
+
+#if defined(RGB_MATRIX_ENABLE)
+    #define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended
+    #undef RGB_MATRIX_MAXIMUM_BRIGHTNESS
+    #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 255 // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255
+
+    // change saturation and hue step size
+    #undef RGBLIGHT_HUE_STEP
+    #undef RGBLIGHT_SAT_STEP
+    #define RGBLIGHT_SAT_STEP 5
+    #define RGBLIGHT_HUE_STEP 5
+
+    #define RGB_MATRIX_KEYPRESSES
+
+    // disable effects from keyboard level config.h
+    #undef ENABLE_RGB_MATRIX_ALPHAS_MODS
+    #undef ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+    #undef ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
+    #undef ENABLE_RGB_MATRIX_BREATHING
+    #undef ENABLE_RGB_MATRIX_BAND_SAT
+    #undef ENABLE_RGB_MATRIX_BAND_VAL
+    #undef ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+    #undef ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+    #undef ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+    #undef ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+    #undef ENABLE_RGB_MATRIX_CYCLE_ALL
+    #undef ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+    #undef ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
+    #undef ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+    #undef ENABLE_RGB_MATRIX_CYCLE_OUT_IN
+    #undef ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+    #undef ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
+    #undef ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+    #undef ENABLE_RGB_MATRIX_DUAL_BEACON
+    #undef ENABLE_RGB_MATRIX_RAINBOW_BEACON
+    #undef ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+    #undef ENABLE_RGB_MATRIX_RAINDROPS
+    #undef ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+    #undef ENABLE_RGB_MATRIX_HUE_BREATHING
+    #undef ENABLE_RGB_MATRIX_HUE_PENDULUM
+    #undef ENABLE_RGB_MATRIX_HUE_WAVE
+    #undef ENABLE_RGB_MATRIX_PIXEL_FRACTAL
+    #undef ENABLE_RGB_MATRIX_PIXEL_RAIN
+    #undef ENABLE_RGB_MATRIX_TYPING_HEATMAP
+    #undef ENABLE_RGB_MATRIX_DIGITAL_RAIN
+    #undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+    #undef ENABLE_RGB_MATRIX_SOLID_REACTIVE
+    #undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+    #undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+    #undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+    #undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+    #undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+    #undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+    #undef ENABLE_RGB_MATRIX_SPLASH
+    #undef ENABLE_RGB_MATRIX_MULTISPLASH
+    #undef ENABLE_RGB_MATRIX_SOLID_SPLASH
+    #undef ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
+
+    // only enable a few
+    #define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+    #define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+    #define ENABLE_RGB_MATRIX_DUAL_BEACON
+    #define ENABLE_RGB_MATRIX_RAINBOW_BEACON
+
+#if defined(RGB_MATRIX_KEYPRESSES) || defined(RGB_MATRIX_KEYRELEASES)
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE// Pulses keys hit to hue & value then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE       // Static single hue, pulses keys hit to shifted hue then fades to current hue
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE       // Hue & value pulse near a single key hit then fades value out
+    #define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH    // Hue & value pulse away from multiple key hits then fades value out
+#endif // # if defined(RGB_MATRIX_KEYPRESSES) || defined(RGB_MATRIX_KEYRELEASES)
+#endif // # if defined(RGB_MATRIX_ENABLE)
+