Helen 80 addition (#11133)

Co-authored-by: james sa <james@keto.tw>
Co-authored-by: James Sa <james.sa.2013@gmail.com>

keyboards/playkbtw/helen80/config.h

@@ -0,0 +1,74 @@
+/* Copyright 2020 Play Keyboard
+ *
+ * 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       0x706B
+#define PRODUCT_ID      0x4845
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Play Keyboard
+#define PRODUCT         Helen 80
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#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 { E6, B7, D4, F0, D6, D7 }
+#define MATRIX_COL_PINS { D1, D0, F7, F6, F5, D5, D3, D2, C7, C6, B5, F4, F1, B4, B0 }
+
+#define DIODE_DIRECTION COL2ROW
+
+#define BACKLIGHT_PIN B6
+// #define BACKLIGHT_BREATHING
+#define BACKLIGHT_LEVELS 3
+
+#define RGB_DI_PIN E2
+#ifdef RGB_DI_PIN
+    #define RGBLED_NUM 87
+    #define RGBLIGHT_HUE_STEP 8
+    #define RGBLIGHT_SAT_STEP 8
+    #define RGBLIGHT_VAL_STEP 8
+    #define RGBLIGHT_LIMIT_VAL 180 /* 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
+
+// generated by KBFirmware JSON to QMK Parser
+// https://noroadsleft.github.io/kbf_qmk_converter/

keyboards/playkbtw/helen80/helen80.c

@@ -0,0 +1,20 @@
+/* Copyright 2020 Play Keyboard
+ *
+ * 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 "helen80.h"
+
+// generated by KBFirmware JSON to QMK Parser
+// https://noroadsleft.github.io/kbf_qmk_converter/

keyboards/playkbtw/helen80/helen80.h

@@ -0,0 +1,38 @@
+/* Copyright 2020 Play Keyboard
+ *
+ * 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_tkl_ansi( \
+    K00,      K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C,   K0D, K0E, K3D, \
+    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1E,   K5B, K5C, K3E, \
+    K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D,   K2E, K5D, K5E, \
+    K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B,      K3C,                  \
+    K40,      K41, K42, K43, K44, K45, K46, K47, K48, K49, K4A,      K4B,        K4C,      \
+    K50, K51, K52,                K53,                K54, K55, K56, K57,   K58, K59, K5A  \
+) { \
+    { K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07,   K08,   K09,   K0A,   K0B,   K0C,   K0D,   K0E   }, \
+    { K10,   K11,   K12,   K13,   K14,   K15,   K16,   K17,   K18,   K19,   K1A,   K1B,   K1C,          K1E   }, \
+    { K20,   K21,   K22,   K23,   K24,   K25,   K26,   K27,   K28,   K29,   K2A,   K2B,   K2C,   K2D,   K2E   }, \
+    { K30,   K31,   K32,   K33,   K34,   K35,   K36,   K37,   K38,   K39,   K3A,   K3B,   K3C,   K3D,   K3E   }, \
+    { K40,   K41,   K42,   K43,   K44,   K45,   K46,   K47,   K48,   K49,   K4A,   K4B,   K4C                 }, \
+    { K50,   K51,   K52,   K53,   K54,   K55,   K56,   K57,   K58,   K59,   K5A,   K5B,   K5C,   K5D,   K5E   }, \
+}
+
+// generated by KBFirmware JSON to QMK Parser
+// https://noroadsleft.github.io/kbf_qmk_converter/

keyboards/playkbtw/helen80/info.json

@@ -0,0 +1,101 @@
+{
+  "keyboard_name": "helen80",
+  "url": "",
+  "maintainer": "yj7272098",
+  "width": 18.25,
+  "height": 6.5,
+  "layouts": {
+        "LAYOUT_tkl_ansi": {
+            "layout": [
+                {"label":"K00 (E6,D1)", "x":0, "y":0},
+                {"label":"K01 (E6,D0)", "x":2, "y":0},
+                {"label":"K02 (E6,F7)", "x":3, "y":0},
+                {"label":"K03 (E6,F6)", "x":4, "y":0},
+                {"label":"K04 (E6,F5)", "x":5, "y":0},
+                {"label":"K05 (E6,D5)", "x":6.5, "y":0},
+                {"label":"K06 (E6,D3)", "x":7.5, "y":0},
+                {"label":"K07 (E6,D2)", "x":8.5, "y":0},
+                {"label":"K08 (E6,C7)", "x":9.5, "y":0},
+                {"label":"K09 (E6,C6)", "x":11, "y":0},
+                {"label":"K0A (E6,B5)", "x":12, "y":0},
+                {"label":"K0B (E6,F4)", "x":13, "y":0},
+                {"label":"K0C (E6,F1)", "x":14, "y":0},
+                {"label":"K0D (E6,B4)", "x":15.25, "y":0},
+                {"label":"K0E (E6,B0)", "x":16.25, "y":0},
+                {"label":"K3D (F0,B4)", "x":17.25, "y":0},
+                {"label":"K10 (B7,D1)", "x":0, "y":1.5},
+                {"label":"K11 (B7,D0)", "x":1, "y":1.5},
+                {"label":"K12 (B7,F7)", "x":2, "y":1.5},
+                {"label":"K13 (B7,F6)", "x":3, "y":1.5},
+                {"label":"K14 (B7,F5)", "x":4, "y":1.5},
+                {"label":"K15 (B7,D5)", "x":5, "y":1.5},
+                {"label":"K16 (B7,D3)", "x":6, "y":1.5},
+                {"label":"K17 (B7,D2)", "x":7, "y":1.5},
+                {"label":"K18 (B7,C7)", "x":8, "y":1.5},
+                {"label":"K19 (B7,C6)", "x":9, "y":1.5},
+                {"label":"K1A (B7,B5)", "x":10, "y":1.5},
+                {"label":"K1B (B7,F4)", "x":11, "y":1.5},
+                {"label":"K1C (B7,F1)", "x":12, "y":1.5},                
+                {"label":"K1E (B7,B0)", "x":13, "y":1.5, "w":2},
+                {"label":"K5B (D7,F4)", "x":15.25, "y":1.5},
+                {"label":"K5C (D7,F1)", "x":16.25, "y":1.5},
+                {"label":"K3E (F0,B0)", "x":17.25, "y":1.5},
+                {"label":"K20 (D4,D1)", "x":0, "y":2.5, "w":1.5},
+                {"label":"K21 (D4,D0)", "x":1.5, "y":2.5},
+                {"label":"K22 (D4,F7)", "x":2.5, "y":2.5},
+                {"label":"K23 (D4,F6)", "x":3.5, "y":2.5},
+                {"label":"K24 (D4,F5)", "x":4.5, "y":2.5},
+                {"label":"K25 (D4,D5)", "x":5.5, "y":2.5},
+                {"label":"K26 (D4,D3)", "x":6.5, "y":2.5},
+                {"label":"K27 (D4,D2)", "x":7.5, "y":2.5},
+                {"label":"K28 (D4,C7)", "x":8.5, "y":2.5},
+                {"label":"K29 (D4,C6)", "x":9.5, "y":2.5},
+                {"label":"K2A (D4,B5)", "x":10.5, "y":2.5},
+                {"label":"K2B (D4,F4)", "x":11.5, "y":2.5},
+                {"label":"K2C (D4,F1)", "x":12.5, "y":2.5},
+                {"label":"K2D (D4,B4)", "x":13.5, "y":2.5, "w":1.5},
+                {"label":"K2E (D4,B0)", "x":15.25, "y":2.5},
+                {"label":"K5D (D7,B4)", "x":16.25, "y":2.5},
+                {"label":"K5E (D7,B0)", "x":17.25, "y":2.5},
+                {"label":"K30 (F0,D1)", "x":0, "y":3.5, "w":1.75},
+                {"label":"K31 (F0,D0)", "x":1.75, "y":3.5},
+                {"label":"K32 (F0,F7)", "x":2.75, "y":3.5},
+                {"label":"K33 (F0,F6)", "x":3.75, "y":3.5},
+                {"label":"K34 (F0,F5)", "x":4.75, "y":3.5},
+                {"label":"K35 (F0,D5)", "x":5.75, "y":3.5},
+                {"label":"K36 (F0,D3)", "x":6.75, "y":3.5},
+                {"label":"K37 (F0,D2)", "x":7.75, "y":3.5},
+                {"label":"K38 (F0,C7)", "x":8.75, "y":3.5},
+                {"label":"K39 (F0,C6)", "x":9.75, "y":3.5},
+                {"label":"K3A (F0,B5)", "x":10.75, "y":3.5},
+                {"label":"K3B (F0,F4)", "x":11.75, "y":3.5},
+                {"label":"K3C (F0,F1)", "x":12.75, "y":3.5, "w":2.25},
+                {"label":"K40 (D6,D1)", "x":0, "y":4.5, "w":2.25},            
+                {"label":"K42 (D6,F7)", "x":2.25, "y":4.5},
+                {"label":"K43 (D6,F6)", "x":3.25, "y":4.5},
+                {"label":"K44 (D6,F5)", "x":4.25, "y":4.5},
+                {"label":"K45 (D6,D5)", "x":5.25, "y":4.5},
+                {"label":"K46 (D6,D3)", "x":6.25, "y":4.5},
+                {"label":"K47 (D6,D2)", "x":7.25, "y":4.5},
+                {"label":"K48 (D6,C7)", "x":8.25, "y":4.5},
+                {"label":"K49 (D6,C6)", "x":9.25, "y":4.5},
+                {"label":"K4A (D6,B5)", "x":10.25, "y":4.5},
+                {"label":"K4B (D6,F4)", "x":11.25, "y":4.5},
+                {"label":"K4C (D6,F1)", "x":12.25, "y":4.5, "w":2.75},                
+                {"label":"K4E (D6,B0)", "x":16.25, "y":4.5},
+                {"label":"K50 (D7,D1)", "x":0, "y":5.5, "w":1.25},
+                {"label":"K51 (D7,D0)", "x":1.25, "y":5.5, "w":1.25},
+                {"label":"K52 (D7,F7)", "x":2.5, "y":5.5, "w":1.25},
+                {"label":"K53 (D7,F6)", "x":3.75, "y":5.5, "w":6.25},
+                {"label":"K54 (D7,F5)", "x":10, "y":5.5, "w":1.25},
+                {"label":"K55 (D7,D5)", "x":11.25, "y":5.5, "w":1.25},
+                {"label":"K56 (D7,D3)", "x":12.5, "y":5.5, "w":1.25},
+                {"label":"K57 (D7,D2)", "x":13.75, "y":5.5, "w":1.25},
+                {"label":"K58 (D7,C7)", "x":15.25, "y":5.5},
+                {"label":"K59 (D7,C6)", "x":16.25, "y":5.5},
+                {"label":"K5A (D7,B5)", "x":17.25, "y":5.5}
+            ]
+        }
+    }
+    ,"meta": "https://noroadsleft.github.io/kbf_qmk_converter/"
+}

keyboards/playkbtw/helen80/keymaps/default/keymap.c

@@ -0,0 +1,44 @@
+/* Copyright 2020 Play Keyboard
+  *
+  * 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
+
+enum _layer {
+    _BASE,
+    _RGB
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  [_BASE] = LAYOUT_tkl_ansi(
+        KC_ESC,           KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,    KC_PSCR, KC_SLCK, KC_PAUS,
+        KC_GRV,  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_INS,  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_DEL,  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, KC_RGUI, MO(_RGB),KC_RCTL,   KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+
+  [_RGB] = LAYOUT_tkl_ansi(
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   _______, _______, _______,
+        _______, RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, _______, _______, _______, _______, _______, _______, _______,   RESET,   _______, _______,
+        _______, RGB_TOG, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,            _______,
+        _______, _______, _______,                            _______,                            _______, _______, _______, _______,   _______, _______, _______
+    ),
+
+};

keyboards/playkbtw/helen80/keymaps/default/readme.md

@@ -0,0 +1,3 @@
+# Default Helen 80 Layout
+
+This is the default tkl_ansi layout that comes flashed on every Helen 80.

keyboards/playkbtw/helen80/keymaps/via/keymap.c

@@ -0,0 +1,44 @@
+/* Copyright 2020 Play Keyboard
+  *
+  * 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
+
+enum _layer {
+    _BASE,
+    _RGB
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  [_BASE] = LAYOUT_tkl_ansi(
+        KC_ESC,           KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,    KC_PSCR, KC_SLCK, KC_PAUS,
+        KC_GRV,  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_INS,  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_DEL,  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, KC_RGUI, MO(_RGB),KC_RCTL,   KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+
+  [_RGB] = LAYOUT_tkl_ansi(
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   _______, _______, _______,
+        _______, RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, _______, _______, _______, _______, _______, _______, _______,   RESET,   _______, _______,
+        _______, RGB_TOG, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,            _______,
+        _______, _______, _______,                            _______,                            _______, _______, _______, _______,   _______, _______, _______
+    ),
+
+};

keyboards/playkbtw/helen80/keymaps/via/rules.mk

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

keyboards/playkbtw/helen80/readme.md

@@ -0,0 +1,17 @@
+# Helen 80
+
+![Helen 80](https://cdn.store-assets.com/s/409567/i/18788640.png)
+
+A 80% RGB hotswap keyboard kit made by Play Keyboard.
+
+* Keyboard Maintainer: [Barry Huang](https://github.com/yj7272098)
+* Hardware Supported: Helen 80
+* Hardware Availability: [Play Keyboard](http://play-keyboard.store/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make playkbtw/helen80:default
+
+You can get into bootloader by pressing the reset button from the back of PCB.
+
+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/playkbtw/helen80/rules.mk

@@ -0,0 +1,30 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = full     # 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 = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+LTO_ENABLE = yes
+
+KEY_LOCK_ENABLE = no      # Enable KC_LOCK support
+
+LAYOUTS = tkl_ansi
+
+# generated by KBFirmware JSON to QMK Parser
+# https://noroadsleft.github.io/kbf_qmk_converter/