Add mini36 (qmk#18739)

keyboards/controllerworks/mini36/config.h

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2022 Kevin Gee <info@controller.works>
+ * 
+ * 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"
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+/* #define DEBOUNCE 5 */
+
+#define WS2812_PIO_USE_PIO1
+#define RGBLED_NUM 48
+#define DRIVER_LED_TOTAL RGBLED_NUM
+#define RGB_MATRIX_SPLIT \
+        { 24, 24 }
+
+#define SPLIT_TRANSPORT_MIRROR
+#define SPLIT_LAYER_STATE_ENABLE
+#define SPLIT_LED_STATE_ENABLE
+#define SPLIT_MODS_ENABLE
+
+#define I2C_DRIVER I2CD1
+#define I2C1_SCL_PIN GP25
+#define I2C1_SDA_PIN GP24
+
+/* #define EE_HANDS  */
+/* #define MASTER_LEFT */
+/* #define MASTER_RIGHT */
+
+/* Top left key on left half */
+#define BOOTMAGIC_LITE_ROW    0
+#define BOOTMAGIC_LITE_COLUMN 0
+/* Top right key on right half */
+#define BOOTMAGIC_LITE_ROW_RIGHT    0
+#define BOOTMAGIC_LITE_COLUMN_RIGHT 0
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT

keyboards/controllerworks/mini36/halconf.h

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2022 Kevin Gee <info@controller.works>
+ * 
+ * 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 HAL_USE_I2C TRUE
+
+#include_next "halconf.h"

keyboards/controllerworks/mini36/info.json

@@ -0,0 +1,154 @@
+{
+    "manufacturer": "Controller Works",
+    "keyboard_name": "mini36",
+    "maintainer": "controller-works",
+    "processor": "RP2040",
+    "url": "https://controller.works/products/mini36-low-profile-ergonomic-keyboard",
+    "tags": ["split", "RP2040", "choc v1", "choc spaced" ],    
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0x0004",
+        "vid": "0x4357"
+    },
+    "bootloader": "rp2040",
+    "diode_direction": "COL2ROW",
+    "build": {
+        "lto":true
+    },
+    "matrix_pins": {
+        "direct": [
+            ["GP3",  "GP4",   "GP5",  "GP6",  "GP7"],
+            ["GP9",  "GP10", "GP11", "GP12", "GP13"],
+            ["GP15", "GP16", "GP17", "GP18", "GP19"],
+            ["GP20", "GP21", "GP22",   null,   null]
+        ]
+    },
+    "rgblight": {
+        "pin": "GP0"
+     },
+    "split": {
+        "enabled": true,
+        "matrix_pins": {
+            "right": {
+                "direct": [
+                    ["GP7",   "GP6",  "GP5",  "GP4",  "GP3"],
+                    ["GP13", "GP12", "GP11", "GP10",  "GP9"],
+                    ["GP19", "GP18", "GP17", "GP16", "GP15"],
+                    ["GP22", "GP21", "GP20",   null,   null]                    
+                ]
+            }
+        },
+        "soft_serial_pin": "GP1",
+        "transport": {
+            "protocol": "serial"
+        }
+    },
+    "features": {
+        "bootmagic": true,
+        "command": false,
+        "console": false,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgb_matrix": true,
+        "oled": true
+    },
+
+    "rgb_matrix": {
+        "driver": "WS2812",
+        "layout": [
+            { "flags": 2, "x": 71, "y": 4 },
+            { "flags": 2, "x": 32, "y": 2 },
+            { "flags": 2, "x": 0, "y": 24 },
+            { "flags": 2, "x": 16, "y": 51 },
+            { "flags": 2, "x": 63, "y": 58 },
+            { "flags": 2, "x": 94, "y": 55 },
+            { "flags": 1, "matrix": [3, 2], "x": 90,  "y": 64 },
+            { "flags": 4, "matrix": [2, 4], "x": 79,  "y": 39 },
+            { "flags": 4, "matrix": [1, 4], "x": 79,  "y": 22 },
+            { "flags": 4, "matrix": [0, 4], "x": 79,  "y": 5 },
+            { "flags": 4, "matrix": [0, 3], "x": 61,  "y": 2 },
+            { "flags": 4, "matrix": [1, 3], "x": 61,  "y": 19 },
+            { "flags": 4, "matrix": [2, 3], "x": 61,  "y": 37 },
+            { "flags": 1, "matrix": [3, 1], "x": 74,  "y": 58 },
+            { "flags": 1, "matrix": [3, 0], "x": 53,  "y": 55 },
+            { "flags": 4, "matrix": [2, 2], "x": 43,  "y": 34 },
+            { "flags": 4, "matrix": [1, 2], "x": 43,  "y": 17 },
+            { "flags": 4, "matrix": [0, 2], "x": 43,  "y": 0 },
+            { "flags": 4, "matrix": [0, 1], "x": 25,  "y": 2 },
+            { "flags": 4, "matrix": [1, 1], "x": 25,  "y": 19 },
+            { "flags": 4, "matrix": [2, 1], "x": 25,  "y": 37 },
+            { "flags": 4, "matrix": [2, 0], "x": 7,  "y": 41 },
+            { "flags": 4, "matrix": [1, 0], "x": 7,  "y": 24 },
+            { "flags": 4, "matrix": [0, 0], "x": 7,  "y": 7 },
+            { "flags": 2, "x": 153, "y": 4 },
+            { "flags": 2, "x": 192, "y": 2 },
+            { "flags": 2, "x": 224, "y": 24 },
+            { "flags": 2, "x": 204, "y": 53 },
+            { "flags": 2, "x": 161, "y": 57 },
+            { "flags": 2, "x": 130, "y": 55 },
+            { "flags": 1, "matrix": [7, 0], "x": 134,  "y": 64 },
+            { "flags": 4, "matrix": [6, 0], "x": 145,  "y": 39 },
+            { "flags": 4, "matrix": [5, 0], "x": 145,  "y": 22 },
+            { "flags": 4, "matrix": [4, 0], "x": 145,  "y": 5 },
+            { "flags": 4, "matrix": [4, 1], "x": 163,  "y": 2 },
+            { "flags": 4, "matrix": [5, 1], "x": 163,  "y": 19 },
+            { "flags": 4, "matrix": [6, 1], "x": 163,  "y": 37 },
+            { "flags": 1, "matrix": [7, 1], "x": 150,  "y": 58 },
+            { "flags": 1, "matrix": [7, 2], "x": 171,  "y": 55 },
+            { "flags": 4, "matrix": [6, 2], "x": 181,  "y": 34 },
+            { "flags": 4, "matrix": [5, 2], "x": 181,  "y": 17 },
+            { "flags": 4, "matrix": [4, 2], "x": 181,  "y": 0 },
+            { "flags": 4, "matrix": [4, 3], "x": 199,  "y": 2 },
+            { "flags": 4, "matrix": [5, 3], "x": 199,  "y": 19 },
+            { "flags": 4, "matrix": [6, 3], "x": 199,  "y": 37 },
+            { "flags": 4, "matrix": [6, 4], "x": 217,  "y": 41 },
+            { "flags": 4, "matrix": [5, 4], "x": 217,  "y": 24 },
+            { "flags": 4, "matrix": [4, 4], "x": 217,  "y": 7 }
+          ]
+    },
+
+    "community_layouts": ["split_3x5_3"],
+    "layouts": {
+        "LAYOUT_split_3x5_3": {
+            "layout": [
+                { "matrix": [0, 0], "x": 0, "y": 0.25 },
+                { "matrix": [0, 1], "x": 1, "y": 0.125 },
+                { "matrix": [0, 2], "x": 2, "y": 0 },
+                { "matrix": [0, 3], "x": 3, "y": 0.125 },
+                { "matrix": [0, 4], "x": 4, "y": 0.25 },
+                { "matrix": [4, 0], "x": 7, "y": 0.25 },
+                { "matrix": [4, 1], "x": 8, "y": 0.125 },
+                { "matrix": [4, 2], "x": 9, "y": 0 },
+                { "matrix": [4, 3], "x": 10, "y": 0.125 },
+                { "matrix": [4, 4], "x": 11, "y": 0.25 },
+                { "matrix": [1, 0], "x": 0, "y": 1.25 },
+                { "matrix": [1, 1], "x": 1, "y": 1.125 },
+                { "matrix": [1, 2], "x": 2, "y": 1 },
+                { "matrix": [1, 3], "x": 3, "y": 1.125 },
+                { "matrix": [1, 4], "x": 4, "y": 1.25 },
+                { "matrix": [5, 0], "x": 7, "y": 1.25 },
+                { "matrix": [5, 1], "x": 8, "y": 1.125 },
+                { "matrix": [5, 2], "x": 9, "y": 1 },
+                { "matrix": [5, 3], "x": 10, "y": 1.125 },
+                { "matrix": [5, 4], "x": 11, "y": 1.25 },
+                { "matrix": [2, 0], "x": 0, "y": 2.25 },
+                { "matrix": [2, 1], "x": 1, "y": 2.125 },
+                { "matrix": [2, 2], "x": 2, "y": 2 },
+                { "matrix": [2, 3], "x": 3, "y": 2.125 },
+                { "matrix": [2, 4], "x": 4, "y": 2.25 },
+                { "matrix": [6, 0], "x": 7, "y": 2.25 },
+                { "matrix": [6, 1], "x": 8, "y": 2.125 },
+                { "matrix": [6, 2], "x": 9, "y": 2 },
+                { "matrix": [6, 3], "x": 10, "y": 2.125 },
+                { "matrix": [6, 4], "x": 11, "y": 2.25 },
+                { "matrix": [3, 0], "x": 2.5, "y": 3.25 },
+                { "matrix": [3, 1], "x": 3.5, "y": 3.5 },
+                { "matrix": [3, 2], "x": 4.5, "y": 3.75, "h":1.5 },
+                { "matrix": [7, 0], "x": 6.5, "y": 3.75, "h":1.5 },
+                { "matrix": [7, 1], "x": 7.5, "y": 3.5 },
+                { "matrix": [7, 2], "x": 8.5, "y": 3.25 }
+            ]
+          }
+    }
+}

keyboards/controllerworks/mini36/keymaps/default/config.h

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2022 Kevin Gee <info@controller.works>
+ * 
+ * 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
+#ifdef RGB_MATRIX_ENABLE
+//#    define SPLIT_TRANSPORT_MIRROR
+#   define RGB_MATRIX_KEYPRESSES // reacts to keypresses
+// #   define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
+// #   define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
+#   define RGB_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended
+#   define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+// #   define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
+// #   define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
+#    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash.
+#    define RGB_MATRIX_HUE_STEP 8
+#    define RGB_MATRIX_SAT_STEP 8
+#    define RGB_MATRIX_VAL_STEP 8
+#    define RGB_MATRIX_SPD_STEP 10
+
+#    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

keyboards/controllerworks/mini36/keymaps/default/keymap.c

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2022 Kevin Gee <info@controller.works>
+ * 
+ * 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/>.
+ */
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT_split_3x5_3(
+  //,--------------------------------------------.                    ,--------------------------------------------.
+         KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,                         KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,
+  //|--------+--------+--------+--------+--------|                    |--------+--------+--------+--------+--------|
+ LCTL_T(KC_A),    KC_S,    KC_D,    KC_F,    KC_G,                         KC_H,    KC_J,    KC_K,    KC_L, KC_SCLN,
+  //|--------+--------+--------+--------+--------|                    |--------+--------+--------+--------+--------|
+ LSFT_T(KC_Z),    KC_X,    KC_C,    KC_V,    KC_B,                         KC_N,    KC_M, KC_COMM,  KC_DOT, KC_SLSH,
+  //|--------+--------+--------+--------+--------+--------|  |--------+--------+--------+--------+--------+--------|
+                                 KC_LGUI,   MO(1),  KC_SPC,     KC_SPC,   MO(2), GUI_T(KC_TAB)
+                            //`--------------------------'  `--------------------------'
+
+  ),
+
+  [1] = LAYOUT_split_3x5_3(
+  //,--------------------------------------------.                    ,--------------------------------------------.
+         KC_1,    KC_2,    KC_3,    KC_4,    KC_5,                         KC_6,    KC_7,    KC_8,    KC_9,    KC_0,
+  //|--------+--------+--------+--------+--------|                    |--------+--------+--------+--------+--------|
+       KC_TAB, XXXXXXX, XXXXXXX, XXXXXXX, KC_PGUP,                      XXXXXXX,   KC_UP, XXXXXXX, XXXXXXX, XXXXXXX,
+  //|--------+--------+--------+--------+--------|                    |--------+--------+--------+--------+--------|
+      KC_MPRV, KC_MPLY, KC_MNXT, XXXXXXX, KC_PGDN,                      KC_LEFT, KC_DOWN, KC_RIGHT, XXXXXXX, XXXXXXX,
+  //|--------+--------+--------+--------+--------+--------|  |--------+--------+--------+--------+--------+--------|
+                                 KC_LGUI, _______,  KC_ESC,     KC_ENT,   MO(3), KC_RALT
+                             //`--------------------------'  `--------------------------'
+  ),
+
+  [2] = LAYOUT_split_3x5_3(
+  //,--------------------------------------------.                    ,--------------------------------------------.
+      KC_EXLM,   KC_AT, KC_HASH,  KC_DLR, KC_PERC,                      KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN,
+  //|--------+--------+--------+--------+--------|                    |--------+--------+--------+--------+--------|
+        KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,                      KC_MINS,  KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
+  //|--------+--------+--------+--------+--------|                    |--------+--------+--------+--------+--------|
+        KC_F6,   KC_F7,   KC_F8,   KC_F9,  KC_F10,                      KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
+  //|--------+--------+--------+--------+--------+--------|  |--------+--------+--------+--------+--------+--------|
+                                 KC_LGUI,   MO(3),  KC_ESC,     KC_DEL, _______, KC_RALT
+                             //`--------------------------'  `--------------------------'
+  ),
+
+  [3] = LAYOUT_split_3x5_3(
+  //,--------------------------------------------.                    ,--------------------------------------------.
+      QK_BOOT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,                      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+  //|--------+--------+--------+--------+--------|                    |--------+--------+--------+--------+--------|
+      RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, RGB_SPI,                      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+  //|--------+--------+--------+--------+--------|                    |--------+--------+--------+--------+--------|
+      RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, RGB_SPD,                      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+  //|--------+--------+--------+--------+--------+--------|  |--------+--------+--------+--------+--------+--------|
+                                 KC_LGUI, _______,  KC_SPC,     KC_ENT, _______, KC_RALT
+                             //`--------------------------'  `--------------------------'
+  )
+};