[Keyboard] Add support for ikki68 (#10576)

* ikki68 from wuquestudio

* NEW ikki68

* Add support for ikki68

* Update readme.md

Co-authored-by: root <root@LAPTOP-GZH.localdomain>

keyboards/wuque/ikki68/config.h

@@ -0,0 +1,68 @@
+/*
+Copyright 2020 wuquestudio
+
+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       0x696B
+#define PRODUCT_ID      0x0003
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    wuque studio
+#define PRODUCT         ikki68
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 17
+
+#define MATRIX_ROW_PINS { B0, B1, B2, B3, E6 }
+#define MATRIX_COL_PINS { D1, D0, D2, D3, D5, D4, D6, D7, B4, B5, F0, F1, B6, F4, F5, F6,F7 }
+
+#define DIODE_DIRECTION COL2ROW 
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+#define RGB_DI_PIN E2
+#ifdef RGB_DI_PIN
+    #define RGBLED_NUM 8
+    #define RGBLIGHT_HUE_STEP 8
+    #define RGBLIGHT_SAT_STEP 8
+    #define RGBLIGHT_VAL_STEP 8
+    #define RGBLIGHT_LIMIT_VAL 200 /* The maximum brightness level */
+    #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+/*======= RGB function=======*/
+/*== 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

keyboards/wuque/ikki68/ikki68.c

@@ -0,0 +1,30 @@
+/* Copyright 2020 wuquestudio
+ *
+ * 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 "ikki68.h"
+
+void matrix_init_kb(void) {
+    setPinOutput(C6);
+  
+    matrix_init_user();
+}
+bool led_update_kb(led_t led_state) {
+    bool res = led_update_user(led_state);
+    if(res) {
+        writePin(C6, !led_state.caps_lock);
+    }
+    return res;
+}

keyboards/wuque/ikki68/ikki68.h

@@ -0,0 +1,33 @@
+/* Copyright 2020 wuquestudio
+ *
+ * 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_68_ansi( \
+    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0E,        K0F, K0G, \
+    K10,   K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, K1E,      K1F, K1G, \
+    K20,    K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D,                    \
+    K31,       K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3D,            K3F,      \
+    K40,  K41,  K43,              K46,                K4A,  K4B,  K4D,      K4E, K4F, K4G  \
+) { \
+    { K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07,   K08,   K09,   K0A,   K0B,   K0C,   KC_NO, K0E,   K0F,   K0G   }, \
+    { K10,   KC_NO, K12,   K13,   K14,   K15,   K16,   K17,   K18,   K19,   K1A,   K1B,   K1C,   K1D,   K1E,   K1F,   K1G   }, \
+    { K20,   KC_NO, K22,   K23,   K24,   K25,   K26,   K27,   K28,   K29,   K2A,   K2B,   K2C,   K2D,   KC_NO, KC_NO, KC_NO }, \
+    { KC_NO, K31,   K32,   K33,   K34,   K35,   K36,   K37,   K38,   K39,   K3A,   K3B,   KC_NO, K3D,   KC_NO, K3F,   KC_NO }, \
+    { K40,   K41,   KC_NO, K43,   KC_NO, KC_NO, K46,   KC_NO, KC_NO, KC_NO, K4A,   K4B,   KC_NO, K4D,   K4E,   K4F,   K4G   }, \
+}

keyboards/wuque/ikki68/info.json

@@ -0,0 +1,81 @@
+{
+    "keyboard_name": "ikki68",
+    "url": "https://ikki68.com/",
+    "maintainer": "qmk",
+    "width": 17.5,
+    "height": 5,
+    "layouts": {
+        "LAYOUT_68_ansi": {
+            "layout": [
+                {"label":"K00 (B0,D1)", "x":0, "y":0},
+                {"label":"K01 (B0,D0)", "x":1, "y":0},
+                {"label":"K02 (B0,D2)", "x":2, "y":0},
+                {"label":"K03 (B0,D3)", "x":3, "y":0},
+                {"label":"K04 (B0,D5)", "x":4, "y":0},
+                {"label":"K05 (B0,D4)", "x":5, "y":0},
+                {"label":"K06 (B0,D6)", "x":6, "y":0},
+                {"label":"K07 (B0,D7)", "x":7, "y":0},
+                {"label":"K08 (B0,B4)", "x":8, "y":0},
+                {"label":"K09 (B0,B5)", "x":9, "y":0},
+                {"label":"K0A (B0,F0)", "x":10, "y":0},
+                {"label":"K0B (B0,F1)", "x":11, "y":0},
+                {"label":"K0C (B0,B6)", "x":12, "y":0},
+                {"label":"K0E (B0,F5)", "x":13, "y":0, "w":2},
+                {"label":"K0F (B0,F6)", "x":15.5, "y":0},
+                {"label":"K0G (B0,F7)", "x":16.5, "y":0},
+                {"label":"K10 (B1,D1)", "x":0, "y":1, "w":1.5},
+                {"label":"K12 (B1,D2)", "x":1.5, "y":1},
+                {"label":"K13 (B1,D3)", "x":2.5, "y":1},
+                {"label":"K14 (B1,D5)", "x":3.5, "y":1},
+                {"label":"K15 (B1,D4)", "x":4.5, "y":1},
+                {"label":"K16 (B1,D6)", "x":5.5, "y":1},
+                {"label":"K17 (B1,D7)", "x":6.5, "y":1},
+                {"label":"K18 (B1,B4)", "x":7.5, "y":1},
+                {"label":"K19 (B1,B5)", "x":8.5, "y":1},
+                {"label":"K1A (B1,F0)", "x":9.5, "y":1},
+                {"label":"K1B (B1,F1)", "x":10.5, "y":1},
+                {"label":"K1C (B1,B6)", "x":11.5, "y":1},
+                {"label":"K1D (B1,F4)", "x":12.5, "y":1},
+                {"label":"K1E (B1,F5)", "x":13.5, "y":1, "w":1.5},
+                {"label":"K1F (B1,F6)", "x":15.5, "y":1},
+                {"label":"K1G (B1,F7)", "x":16.5, "y":1},
+                {"label":"K20 (B2,D1)", "x":0, "y":2, "w":1.75},
+                {"label":"K22 (B2,D2)", "x":1.75, "y":2},
+                {"label":"K23 (B2,D3)", "x":2.75, "y":2},
+                {"label":"K24 (B2,D5)", "x":3.75, "y":2},
+                {"label":"K25 (B2,D4)", "x":4.75, "y":2},
+                {"label":"K26 (B2,D6)", "x":5.75, "y":2},
+                {"label":"K27 (B2,D7)", "x":6.75, "y":2},
+                {"label":"K28 (B2,B4)", "x":7.75, "y":2},
+                {"label":"K29 (B2,B5)", "x":8.75, "y":2},
+                {"label":"K2A (B2,F0)", "x":9.75, "y":2},
+                {"label":"K2B (B2,F1)", "x":10.75, "y":2},
+                {"label":"K2C (B2,B6)", "x":11.75, "y":2},
+                {"label":"K2D (B2,F4)", "x":12.75, "y":2, "w":2.25},
+                {"label":"K31 (B3,D0)", "x":0, "y":3, "w":2.25},
+                {"label":"K32 (B3,D2)", "x":2.25, "y":3},
+                {"label":"K33 (B3,D3)", "x":3.25, "y":3},
+                {"label":"K34 (B3,D5)", "x":4.25, "y":3},
+                {"label":"K35 (B3,D4)", "x":5.25, "y":3},
+                {"label":"K36 (B3,D6)", "x":6.25, "y":3},
+                {"label":"K37 (B3,D7)", "x":7.25, "y":3},
+                {"label":"K38 (B3,B4)", "x":8.25, "y":3},
+                {"label":"K39 (B3,B5)", "x":9.25, "y":3},
+                {"label":"K3A (B3,F0)", "x":10.25, "y":3},
+                {"label":"K3B (B3,F1)", "x":11.25, "y":3},
+                {"label":"K3D (B3,F4)", "x":12.25, "y":3, "w":2.75},
+                {"label":"K3F (B3,F6)", "x":15.5, "y":3},
+                {"label":"K40 (E6,D1)", "x":0, "y":4, "w":1.25},
+                {"label":"K41 (E6,D0)", "x":1.25, "y":4, "w":1.25},
+                {"label":"K43 (E6,D3)", "x":2.5, "y":4, "w":1.25},
+                {"label":"K46 (E6,D6)", "x":3.75, "y":4, "w":6.25},
+                {"label":"K4A (E6,F0)", "x":10, "y":4, "w":1.25},
+                {"label":"K4B (E6,F1)", "x":11.25, "y":4, "w":1.25},
+                {"label":"K4D (E6,F4)", "x":12.5, "y":4, "w":1.25},
+                {"label":"K4E (E6,F5)", "x":14.5, "y":4},
+                {"label":"K4F (E6,F6)", "x":15.5, "y":4},
+                {"label":"K4G (E6,F7)", "x":16.5, "y":4}
+            ]
+        }
+    }
+}

keyboards/wuque/ikki68/keymaps/default/keymap.c

@@ -0,0 +1,35 @@
+/* Copyright 2020 wuquestudio
+ *
+ * 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_68_ansi(
+        KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC,              KC_HOME, KC_PGUP,
+        KC_TAB,      KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS,          KC_END,  KC_PGDN,
+        KC_CAPS,       KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT,
+        KC_LSFT,            KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,                     KC_UP,
+        KC_LCTL,   KC_LGUI,   KC_LALT,                       KC_SPC,                              KC_RALT,   MO(1),     KC_RCTL,          KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [1] = LAYOUT_68_ansi(
+        KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______,              _______, RESET,
+        _______,     RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, _______,          _______, _______,
+        _______,       _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                     _______,
+        _______,   _______,   _______,                      _______,                              _______,   _______,   _______,          _______, _______, _______
+    ),
+
+};

keyboards/wuque/ikki68/keymaps/default/readme.md

@@ -0,0 +1 @@
+# The default keymap for ikki68

keyboards/wuque/ikki68/keymaps/via/keymap.c

@@ -0,0 +1,49 @@
+/* Copyright 2020 wuquestudio
+ *
+ * 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_68_ansi(
+        KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC,              KC_HOME, KC_PGUP,
+        KC_TAB,      KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS,          KC_END,  KC_PGDN,
+        KC_CAPS,       KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT,
+        KC_LSFT,            KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,                     KC_UP,
+        KC_LCTL,   KC_LGUI,   KC_LALT,                       KC_SPC,                              KC_RALT,   MO(1),     KC_RCTL,          KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [1] = LAYOUT_68_ansi(
+        KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______,              _______, RESET,
+        _______,     RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, _______,          _______, _______,
+        _______,       _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                     _______,
+        _______,   _______,   _______,                      _______,                              _______,   _______,   _______,          _______, _______, _______
+    ),
+    [2] = LAYOUT_68_ansi(
+        _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,            _______, RESET,
+        _______,     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, _______,
+        _______,       _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                     _______,
+        _______,   _______,   _______,                      _______,                              _______,   _______,   _______,          _______, _______, _______
+    ),
+    [3] = LAYOUT_68_ansi(
+         _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,            _______, RESET,
+        _______,     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, _______,
+        _______,       _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                     _______,
+        _______,   _______,   _______,                      _______,                              _______,   _______,   _______,          _______, _______, _______
+    ),
+
+};

keyboards/wuque/ikki68/keymaps/via/readme.md

@@ -0,0 +1 @@
+# The via keymap for ikki68

keyboards/wuque/ikki68/keymaps/via/rules.mk

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

keyboards/wuque/ikki68/readme.md

@@ -0,0 +1,20 @@
+# ikki68
+
+![ikki68](https://ikki68.com/wp-content/uploads/2020/06/cover-ikki68-coronation-2.jpg)
+​
+Hope this kit is the same as ikki, every rebirth will be stronger
+More Info at [wuquestudio](https://shop.wuquestudio.com/).
+​
+* Keyboard Maintainer: [wuquestudio](https://shop.wuquestudio.com)
+* Hardware Supported: ikki 68 Standard
+* Hardware Availability: [wuquestudio](https://shop.wuquestudio.com/products/ikki68)
+​
+Make example for this keyboard (after setting up your build environment):
+
+    make wuque/ikki68:default
+
+Flashing example for this keyboard:
+
+    make wuque/ikki68: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/wuque/ikki68/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     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # 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 = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+
+LAYOUTS = 68_ansi