[Keyboard] Add support for Tunks Ergo33 keyboard (#10665)

* [Keyboard] Add support for Tunks Ergo33

* [Keyboard] Ergo33: Code style fixes

* [Keyboard] Ergo33: Add GPL license headers

* [Keyboard] Ergo33: remove keymap_config declarations

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>

keyboards/tunks/ergo33/keymaps/default/config.h

@@ -0,0 +1,26 @@
+/* Copyright 2020 Mika Kuitunen 
+  * 
+  * 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
+
+/* RGB LED count
+ * No external LED PCB: 10
+ * External LED PCB: 14
+ */
+#define RGBLED_NUM 14
+#define RGBLIGHT_ANIMATIONS
+#define RGBLIGHT_LAYERS
+#define RGBLIGHT_SLEEP

keyboards/tunks/ergo33/keymaps/default/keymap.c

@@ -0,0 +1,110 @@
+/* Copyright 2020 Mika Kuitunen 
+  * 
+  * 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
+
+/* Each layer gets a name for readability, which is then used in the keymap matrix below.
+ * The underscores don't mean anything - you can have a layer called STUFF or any other name.
+ */
+enum layers {
+    _BASE = 0,
+    _RGB,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    [_BASE] = LAYOUT(
+        KC_ESC,  KC_0,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,
+        KC_Y,    KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,
+        KC_H,    KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,
+        KC_N,    KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    TG(_RGB),
+        KC_LGUI, KC_LCTL,                                                 KC_ENT,
+                                               KC_LALT,  KC_SPC,  KC_ENT
+    ),
+
+    [_RGB] = LAYOUT(
+        RGB_RMOD, RGB_MOD, RGB_TOG, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        RGB_HUD,  RGB_HUI, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        RGB_SAD,  RGB_SAI, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        RGB_VAD,  RGB_VAI, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, TG(_RGB),
+        KC_TRNS,  KC_TRNS,                                                 KC_TRNS,
+                                               KC_TRNS,  KC_TRNS,  KC_TRNS
+    ),
+};
+
+#ifdef ENCODER_ENABLE
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) {
+        if (clockwise) {
+            tap_code(KC_MS_WH_DOWN);
+        } else {
+            tap_code(KC_MS_WH_UP);
+        }
+    }
+}
+#endif
+
+
+#ifdef RGBLIGHT_LAYERS
+#define HUE_PRIMARY 10
+#define HSV_OFF 0, 0, 0
+#define HSV_CAPS HUE_PRIMARY, 255, 64
+#define HSV_LAYER_BASE HUE_PRIMARY, 255, 64
+#define HSV_LAYER_RGB 213, 255, 64
+
+const rgblight_segment_t PROGMEM ug_default_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {10, 4, HSV_OFF}
+);
+
+const rgblight_segment_t PROGMEM ug_caps_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {11, 1, HSV_CAPS}
+);
+
+const rgblight_segment_t PROGMEM ug_base_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {13, 1, HSV_LAYER_BASE}
+);
+
+const rgblight_segment_t PROGMEM ug_rgb_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {13, 1, HSV_LAYER_RGB}
+);
+
+/* Define layer order, later layers take precedence */
+const rgblight_segment_t* const PROGMEM ug_layers[] = RGBLIGHT_LAYERS_LIST(
+    ug_default_layer,
+    ug_caps_layer,
+    ug_base_layer,
+    ug_rgb_layer
+);
+
+void keyboard_post_init_user(void) {
+    /* Enable the LED layers and set the initial state */
+    rgblight_layers = ug_layers;
+    rgblight_set_layer_state(0, true);
+    rgblight_set_layer_state(2, true);
+}
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+    /* Both layers will light up if both kb layers are active, latter overrides */
+    rgblight_set_layer_state(2, layer_state_cmp(state, 0));
+    rgblight_set_layer_state(3, layer_state_cmp(state, 1));
+    return state;
+}
+
+bool led_update_user(led_t led_state) {
+    rgblight_set_layer_state(1, led_state.caps_lock);
+    return true;
+}
+#endif

keyboards/tunks/ergo33/keymaps/default/readme.md

@@ -0,0 +1,11 @@
+# Default Ergo33 Layout
+
+This is the default layout for the Ergo33. It mostly follows the left side of a normal keyboard, except since there is an extra column on the left, `0` is above `TAB` and the left column is:
+```
+ESC
+Y
+H
+N
+GUI (Win)
+```
+The encoder acts as a mouse scrollwheel and encoder press is `Enter`. On the top LEDs the 1st is a layer indicator and the 3rd is a caps lock indicator.

keyboards/tunks/ergo33/keymaps/prpro/config.h

@@ -0,0 +1,28 @@
+/* Copyright 2020 Mika Kuitunen 
+  * 
+  * 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
+
+/* RGB LED count
+ * No external LED PCB: 10
+ * External LED PCB: 14
+ */
+#define RGBLED_NUM 14
+#define RGBLIGHT_LAYERS
+#define RGBLIGHT_SLEEP
+
+/* Tap dance delay in ms */
+#define TAPPING_TERM 175

keyboards/tunks/ergo33/keymaps/prpro/keymap.c

@@ -0,0 +1,164 @@
+/* Copyright 2020 Mika Kuitunen 
+  * 
+  * 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
+
+#include "keymap_finnish.h"
+
+enum layers {
+    _BASE = 0,
+    _PRPRO,
+    _PRPRO2,
+};
+
+/* Tap Dance declarations */
+enum {
+    TD_1,
+    TD_2,
+    TD_3,
+    TD_4,
+    TD_5,
+    TD_6,
+    TD_COMMA,
+    TD_HOME,
+    TD_K,
+    TD_DEL,
+    TD_X,
+    TD_C,
+    TD_V,
+    TD_Z
+};
+
+/* Tap Dance definitions */
+qk_tap_dance_action_t tap_dance_actions[] = {
+    [TD_1] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_1), LCTL(LSFT(KC_1))),
+    [TD_2] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_2), LCTL(LSFT(KC_2))),
+    [TD_3] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_3), LCTL(LSFT(KC_3))),
+    [TD_4] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_4), LCTL(LSFT(KC_4))),
+    [TD_5] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_5), LCTL(LSFT(KC_5))),
+    [TD_6] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_6), LCTL(LSFT(KC_6))),
+    [TD_COMMA] = ACTION_TAP_DANCE_DOUBLE(KC_COMMA, KC_DOT),
+    [TD_HOME] = ACTION_TAP_DANCE_DOUBLE(KC_HOME, KC_END),
+    [TD_K] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_K), LCTL(LSFT(KC_K))),
+    [TD_DEL] = ACTION_TAP_DANCE_DOUBLE(KC_DEL, LSFT(KC_DEL)),
+    [TD_X] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_X), KC_S),
+    [TD_C] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_C), KC_M),
+    [TD_V] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_V), LCTL(KC_L)),
+    [TD_Z] = ACTION_TAP_DANCE_DOUBLE(LCTL(KC_Z), LCTL(LSFT(KC_Z)))
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    [_BASE] = LAYOUT(
+        KC_ESC,  KC_0,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,
+        KC_Y,    KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,
+        KC_H,    KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,
+        KC_N,    KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    TG(_PRPRO),
+        KC_LGUI, KC_LCTL,                                                KC_ENT,
+                                               KC_LALT,  KC_SPC,  KC_ENT
+    ),
+
+    [_PRPRO] = LAYOUT(
+        KC_ESC,     KC_M,        KC_V,         KC_UP,      KC_A,       KC_Y,       KC_C,
+        KC_1,       KC_2,        KC_LEFT,      KC_DOWN,    KC_RIGHT,   TD(TD_Z),   TD(TD_DEL),
+        FI_SECT,    TD(TD_HOME), KC_J,         KC_K,       KC_L,       TD(TD_K),   TG(_PRPRO2),
+        KC_S,       KC_LSFT,     LCTL(KC_X),   LCTL(KC_C), LCTL(KC_V), LCTL(KC_S), TG(_PRPRO),
+        LCTL(KC_L), KC_LCTL,                                                                   KC_ENT,
+                                                                  KC_LALT,     KC_SPC,  KC_ENT
+    ),
+
+    [_PRPRO2] = LAYOUT(
+        KC_TRNS, KC_TRNS, TD(TD_1), TD(TD_2), TD(TD_3),     TD(TD_4), TD(TD_5),
+        KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS,  KC_TRNS,      KC_TRNS,  KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS,  KC_TRNS,      KC_TRNS,  KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_I,     KC_O,     TD(TD_COMMA), KC_TRNS,  TG(_PRPRO2),
+        KC_TRNS, KC_TRNS,                                                         KC_TRNS,
+                                                      KC_TRNS,   KC_TRNS, KC_TRNS
+    ),
+};
+
+#ifdef ENCODER_ENABLE
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) {
+        if (clockwise) {
+            tap_code(KC_MS_WH_DOWN);
+        } else {
+            tap_code(KC_MS_WH_UP);
+        }
+    }
+}
+#endif
+
+#ifdef RGBLIGHT_LAYERS
+#define HUE_PRIMARY 10
+#define HSV_PRIMARY HUE_PRIMARY, 255, 255
+#define HSV_OFF 0, 0, 0
+#define HSV_CAPS HUE_PRIMARY, 255, 64
+#define HSV_LAYER_BASE HUE_PRIMARY, 255, 64
+#define HSV_LAYER_PRPRO 213, 255, 64
+#define HSV_LAYER_PRPRO2 184, 255, 64
+
+const rgblight_segment_t PROGMEM ug_default_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {0, 14, HSV_PRIMARY},
+    {10, 4, HSV_OFF}
+);
+
+const rgblight_segment_t PROGMEM ug_caps_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {11, 1, HSV_CAPS}
+);
+
+const rgblight_segment_t PROGMEM ug_base_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {13, 1, HSV_LAYER_BASE}
+);
+
+const rgblight_segment_t PROGMEM ug_prpro_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {13, 1, HSV_LAYER_PRPRO}
+);
+
+const rgblight_segment_t PROGMEM ug_prpro2_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {13, 1, HSV_LAYER_PRPRO2}
+);
+
+/* Define layer order, later layers take precedence */
+const rgblight_segment_t* const PROGMEM ug_layers[] = RGBLIGHT_LAYERS_LIST(
+    ug_default_layer,
+    ug_caps_layer,
+    ug_base_layer,
+    ug_prpro_layer,
+    ug_prpro2_layer
+);
+
+void keyboard_post_init_user(void) {
+    /* Enable the LED layers */
+    rgblight_layers = ug_layers;
+    rgblight_set_layer_state(0, true);
+    rgblight_set_layer_state(2, true);
+}
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+    rgblight_set_layer_state(0, true);
+    /* Both layers will light up if both kb layers are active */
+    rgblight_set_layer_state(2, layer_state_cmp(state, 0));
+    rgblight_set_layer_state(3, layer_state_cmp(state, 1));
+    rgblight_set_layer_state(4, layer_state_cmp(state, 2));
+    return state;
+}
+
+bool led_update_user(led_t led_state) {
+    rgblight_set_layer_state(1, led_state.caps_lock);
+    return true;
+}
+#endif

keyboards/tunks/ergo33/keymaps/prpro/readme.md

@@ -0,0 +1,5 @@
+# Ergo33 Premiere Pro  Layout
+
+Default layout + Premiere pro editing layout for Ergo33.
+
+On this layout, the second and third layers are Adobe Premiere Pro hotkeys. You'll need to use [My custom shortcuts](https://github.com/kulmajaba/tunks-keyboard/blob/master/Ergo33%20prpro.kys) for it to work.

keyboards/tunks/ergo33/keymaps/prpro/rules.mk

@@ -0,0 +1 @@
+TAP_DANCE_ENABLE = yes      # Tap dance

keyboards/tunks/ergo33/keymaps/rgb/config.h

@@ -0,0 +1,24 @@
+/* Copyright 2020 Mika Kuitunen 
+  * 
+  * 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
+
+/* RGB LED count
+ * No external LED PCB: 10
+ * External LED PCB: 14
+ */
+#define RGBLED_NUM 10
+#define RGBLIGHT_ANIMATIONS

keyboards/tunks/ergo33/keymaps/rgb/keymap.c

@@ -0,0 +1,33 @@
+/* Copyright 2020 Mika Kuitunen 
+  * 
+  * 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 layers {
+    _BASE = 0,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    [_BASE] = LAYOUT(
+        RGB_RMOD, RGB_MOD, RGB_TOG, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        RGB_HUD,  RGB_HUI, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        RGB_SAD,  RGB_SAI, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        RGB_VAD,  RGB_VAI, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS,  KC_TRNS,                                                 KC_TRNS,
+                                                KC_TRNS,  KC_TRNS,  KC_TRNS
+    ),
+};

keyboards/tunks/ergo33/keymaps/rgb/readme.md

@@ -0,0 +1,3 @@
+# Ergo33 RGB Layout
+
+Pure RGB lighting layout for product photography.