[Keyboard] smallkeyboard support (#12817)

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>

keyboards/smallkeyboard/config.h

@@ -0,0 +1,104 @@
+/* Copyright 2021 zhouqiong19840119
+  * 
+  * 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
+
+/* USB Device descriptor parameter */
+#include "config_common.h"
+#define VENDOR_ID       0x7A71 // "zq" = zhouqiong19840119
+#define PRODUCT_ID      0x736B // "sk" = smallkeyboard
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    zhouqiong19840119
+#define PRODUCT         smallkeyboard
+
+/* key matrix size */
+#define MATRIX_ROWS 2
+#define MATRIX_COLS 3
+
+/*
+ * 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 {C7, C6 }
+#define MATRIX_COL_PINS {F7, F6, F5}
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION ROW2COL
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 3
+
+/* disable these deprecated features by default */
+//#ifndef LINK_TIME_OPTIMIZATION_ENABLE
+//#    define NO_ACTION_MACRO
+//#    define NO_ACTION_FUNCTION
+//#endif
+
+#ifdef RGB_MATRIX_ENABLE
+#    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_KEYPRESSES
+#    define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#    define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+#    define DISABLE_RGB_MATRIX_BAND_SAT
+#    define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+#    define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+#    define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+#    define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+#    define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+#    define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+#    define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+#    define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+#    define DISABLE_RGB_MATRIX_SPLASH
+#    define DISABLE_RGB_MATRIX_MULTISPLASH
+#    define DISABLE_RGB_MATRIX_SOLID_SPLASH
+#    define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
+#    define DISABLE_RGB_MATRIX_DIGITAL_RAIN
+
+// This is a 7-bit address, that gets left-shifted and bit 0
+// set to 0 for write, 1 for read (as per I2C protocol)
+// The address will vary depending on your wiring:
+// 0b1110100 AD <-> GND
+// 0b1110111 AD <-> VCC
+// 0b1110101 AD <-> SCL
+// 0b1110110 AD <-> SDA
+#define DRIVER_ADDR_1 0b1110100
+//#define DRIVER_ADDR_2 0b1110110
+
+#define DRIVER_COUNT 1
+#define DRIVER_1_LED_TOTAL 6
+//#define DRIVER_1_LED_TOTAL 25
+//#define DRIVER_2_LED_TOTAL 24
+//#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
+#define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
+#endif
+//#define RGB_DI_PIN B7
+//#ifdef RGB_DI_PIN
+//#define RGBLIGHT_ANIMATIONS
+//#define RGBLED_NUM 8
+//#define RGBLIGHT_HUE_STEP 5
+//#define RGBLIGHT_SAT_STEP 5
+//#define RGBLIGHT_VAL_STEP 5
+//#define RGBLIGHT_SLEEP
+//#endif

keyboards/smallkeyboard/info.json

@@ -0,0 +1,17 @@
+{
+  "keyboard_name": "smallkeyboard",
+  "url": "",
+  "maintainer": "zhouqiong19840119",
+  "layouts": {
+    "LAYOUT_ortho_2x3": {
+      "layout": [
+                {"x":0, "y":0},
+                {"x":1, "y":0},
+                {"x":2, "y":0},
+                {"x":0, "y":1},
+                {"x":1, "y":1},
+                {"x":2, "y":1}
+      ]
+    }
+  }
+}

keyboards/smallkeyboard/keymaps/default/keymap.c

@@ -0,0 +1,28 @@
+/* Copyright 2021 zhouqiong19840119
+  * 
+  * 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_ortho_2x3(
+        KC_P1, KC_P2, MO(1),
+        KC_P3, KC_P4, KC_P3),
+    [1] = LAYOUT_ortho_2x3(
+        RGB_TOG, RGB_MOD, MO(1),
+        AU_ON,   AU_OFF,  MI_ON),
+    [2] = LAYOUT_ortho_2x3(
+        KC_P4, KC_P5, MO(1),
+        KC_P1, KC_P2, KC_P3),
+};

keyboards/smallkeyboard/keymaps/via/keymap.c

@@ -0,0 +1,28 @@
+/* Copyright 2021 zhouqiong19840119
+  * 
+  * 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_ortho_2x3(
+        KC_P1, KC_P2, MO(1),
+        KC_P3, KC_P4, KC_P3),
+    [1] = LAYOUT_ortho_2x3(
+        RGB_TOG, RGB_MOD, MO(1),
+        AU_ON,   AU_OFF,  MI_ON),
+    [2] = LAYOUT_ortho_2x3(
+        KC_P4, KC_P5, MO(1),
+        KC_P1, KC_P2, KC_P3),
+};

keyboards/smallkeyboard/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

keyboards/smallkeyboard/readme.md

@@ -0,0 +1,18 @@
+# SMALLKEYBOARD
+
+![](https://github.com/zhouqiong19840119/MacroKeyboard-little/blob/main/Small%20(1).jpg)
+
+* Keyboard Maintainer: [zhouqiong19840119](https://github.com/zhouqiong19840119)
+* Hardware Availability: 
+
+Make example for this keyboard (after setting up your build environment):
+
+    make smallkeyboard:default
+
+Flashing example for this keyboard:
+
+    make smallkeyboard:default:flash
+
+To reset the board into bootloader mode, hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings).
+
+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/smallkeyboard/rules.mk

@@ -0,0 +1,26 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite     # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = yes        # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = no            # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output
+
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = IS31FL3731
+
+RGB_MATRIX_SUPPORTED = yes

keyboards/smallkeyboard/smallkeyboard.c

@@ -0,0 +1,49 @@
+/* Copyright 2021 zhouqiong19840119
+  * 
+  * 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 "smallkeyboard.h"
+
+#ifdef RGB_MATRIX_ENABLE
+
+const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
+/* Refer to IS31 manual for these locations
+ *   driver
+ *   |  R location
+ *   |  |       G location
+ *   |  |       |       B location
+ *   |  |       |       | */
+	{0, C1_3,  C2_3,  C3_3},// BL1
+    {0, C1_4,  C2_4,  C3_4},// BL2
+    {0, C1_5,  C2_5,  C3_5},// BL3
+    {0, C1_11, C2_11, C3_11},// BL4
+    {0, C1_12, C2_12, C3_12},// BL5
+    {0, C1_13, C2_13, C3_13},// BL6
+};
+
+led_config_t g_led_config = {
+    {
+        { 0,      1,     2},
+        { 3,      4,     5},
+    },
+    {
+        { 48, 32},{ 48, 48},{ 64, 48},
+        { 80, 16},{ 64, 32},{ 80, 32}
+    },
+    {
+        4, 4, 4, 
+        1, 1, 4
+    }
+};
+#endif

keyboards/smallkeyboard/smallkeyboard.h

@@ -0,0 +1,26 @@
+/* Copyright 2021 zhouqiong198401189
+  * 
+  * 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 "quantum.h"
+
+#define LAYOUT_ortho_2x3( \
+    K00, K01, K02,\
+    K10, K11, K12 \
+) { \
+    { K00, K01, K02 }, \
+    { K10, K11, K12 }  \
+}