Eek! keyboard firmware merge into QMK

keyboards/eek/config.h

@@ -0,0 +1,197 @@
+/*
+Copyright 2020 klackygears
+
+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       0x4A53
+#define PRODUCT_ID      0x0002
+#define DEVICE_VER      0x0004
+#define MANUFACTURER    klackygears
+#define PRODUCT         eek!
+//#define DESCRIPTION     A portable 36 key split layout keyboard
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 10
+
+#define MATRIX_ROW_PINS { E6, B4, B5, B6 }
+#if FLIPPED
+   #define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3, B2, B6, C6, D4 }
+#else
+   #define MATRIX_COL_PINS { D4, C6, B6, B2, B3, B1, F7, F6, F5, F4 }
+#endif
+
+#define UNUSED_PINS { D2, D1, D0 }
+#define DIODE_DIRECTION COL2ROW
+
+
+ #define RGB_DI_PIN B3
+#ifdef RGB_DI_PIN
+  #define RGBLED_NUM 18
+  #define RGBLIGHT_HUE_STEP 4
+  #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 */
+/*== 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
+// /*== customize breathing effect ==*/
+//   /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//   #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+//   /*==== use exp() and sin() ====*/
+//   #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+//   #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+ #endif
+
+ #ifdef RGB_MATRIX_ENABLE
+  #define DRIVER_LED_TOTAL 36
+  #define RGB_MATRIX_LED_FLUSH_LIMIT 16
+  #define RGB_MATRIX_STARTUP_VAL 150
+  #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 200
+ #endif
+
+ #ifdef AUDIO_ENABLE
+  #define B0_AUDIO
+ #endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+
+/* 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
+
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+// #define GRAVE_ESC_CTRL_OVERRIDE
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Magic Key Options
+ *
+ * Magic keys are hotkey commands that allow control over firmware functions of
+ * the keyboard. They are best used in combination with the HID Listen program,
+ * found here: https://www.pjrc.com/teensy/hid_listen.html
+ *
+ * The options below allow the magic key functionality to be changed. This is
+ * useful if your keyboard/keypad is missing keys and you want magic key support.
+ *
+ */
+
+/* key combination for magic key command */
+/* defined by default; to change, uncomment and set to the combination you want */
+// #define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))
+
+/* control how magic key switches layers */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
+
+/* override magic key keymap */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
+//#define MAGIC_KEY_HELP           H
+//#define MAGIC_KEY_HELP_ALT       SLASH
+//#define MAGIC_KEY_DEBUG          D
+//#define MAGIC_KEY_DEBUG_MATRIX   X
+//#define MAGIC_KEY_DEBUG_KBD      K
+//#define MAGIC_KEY_DEBUG_MOUSE    M
+//#define MAGIC_KEY_VERSION        V
+//#define MAGIC_KEY_STATUS         S
+//#define MAGIC_KEY_CONSOLE        C
+//#define MAGIC_KEY_LAYER0         0
+//#define MAGIC_KEY_LAYER0_ALT     GRAVE
+//#define MAGIC_KEY_LAYER1         1
+//#define MAGIC_KEY_LAYER2         2
+//#define MAGIC_KEY_LAYER3         3
+//#define MAGIC_KEY_LAYER4         4
+//#define MAGIC_KEY_LAYER5         5
+//#define MAGIC_KEY_LAYER6         6
+//#define MAGIC_KEY_LAYER7         7
+//#define MAGIC_KEY_LAYER8         8
+//#define MAGIC_KEY_LAYER9         9
+//#define MAGIC_KEY_BOOTLOADER     B
+//#define MAGIC_KEY_BOOTLOADER_ALT ESC
+//#define MAGIC_KEY_LOCK           CAPS
+//#define MAGIC_KEY_EEPROM         E
+//#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
+//#define MAGIC_KEY_NKRO           N
+//#define MAGIC_KEY_SLEEP_LED      Z
+
+/*
+ * 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
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
+
+
+/* Bootmagic Lite key configuration */
+// #define BOOTMAGIC_LITE_ROW 0
+// #define BOOTMAGIC_LITE_COLUMN 0

keyboards/eek/eek.c

@@ -0,0 +1,101 @@
+/* Copyright 2020 klackygears
+ *
+ * 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 "eek.h"
+
+// Optional override functions below.
+// You can leave any or all of these undefined.
+// These are only required if you want to perform custom actions.
+
+
+
+
+#ifdef RGB_MATRIX_ENABLE
+
+  // Logical Layout
+  // Columns
+  //  0  1  2  3  4
+  //                   ROWS
+  //  4  3  2  1  0      0
+  //  5  6  7  8  9      1
+  // 14 13 12 11 10      2
+  //       15 16 17      3
+
+ // Logical Layout v1.3
+  // Columns
+  //  0  1  2  3  4  5  6  7  8  9
+  //                                 ROWS
+  //  0  1  2  3  4  5  6  7  8  9     0
+  // 19 18 17 16 15 14 13 12 11 10     1
+  // 20 21 22 23 24 25 26 27 28 29     2
+  //       35 34 33 32 31 30           3
+
+
+led_config_t g_led_config = { {
+    {    4,   3,   2,   1,   0,  0,   1,  2,  3,  4  },
+    {    5,   6,   7,   8,   9,  9,   8,  7,  6,  5  },
+    {   14,  13,  12,  11,  10,  10, 11, 12, 13, 14  },
+    { NO_LED, NO_LED, 15, 16, 17, 17, 16, 15, NO_LED, NO_LED }
+}, {
+    {  93, 13 }, {  77,  7 }, {  62,  0 }, {  46,  0 }, {  31,  0 },
+    {  85, 24 }, {  70, 17 }, {  54, 10 }, {  39, 10 }, {  23, 10 },
+    {  77, 34 }, {  62, 27 }, {  46, 20 }, {  31, 20 }, {  15, 20 },
+    {  39, 34 }, {  54, 37 }, {  70, 44 },
+    { 131, 13 }, { 147,  7 }, { 162,  0 }, { 178,  0 }, { 193,  0 },
+    { 201, 10 }, { 185, 10 }, { 170, 10 }, { 154, 17 }, { 139, 24 },
+    { 147, 34 }, { 162, 27 }, { 178, 20 }, { 193, 20 }, { 209, 20 },
+    { 185, 34 }, { 170, 37 }, { 154, 44 },
+}, {
+     4, 4, 4, 4, 4,
+     4, 4, 4, 4, 4,
+     4, 4, 4, 4, 4,
+     1, 1, 1, 4, 4,
+     4, 4, 4, 4, 4,
+     4, 4, 4, 4, 4,
+     4, 4, 4, 1, 1,
+     1,
+} };
+#endif
+
+/*
+
+void matrix_init_kb(void) {
+  // put your keyboard start-up code here
+  // runs once when the firmware starts up
+
+  matrix_init_user();
+}
+
+void matrix_scan_kb(void) {
+  // put your looping keyboard code here
+  // runs every cycle (a lot)
+
+  matrix_scan_user();
+}
+
+bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
+  // put your per-action keyboard code here
+  // runs for every action, just before processing by the firmware
+
+  return process_record_user(keycode, record);
+}
+
+void led_set_kb(uint8_t usb_led) {
+  // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
+
+  led_set_user(usb_led);
+}
+
+*/

keyboards/eek/eek.h

@@ -0,0 +1,39 @@
+/* Copyright 2020 klackygears
+ *
+ * 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"
+
+/* This a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT( \
+    K00, K01, K02, K03, K04,     K05, K06, K07, K08, K09, \
+    K10, K11, K12, K13, K14,     K15, K16, K17, K18, K19, \
+    K20, K21, K22, K23, K24,     K25, K26, K27, K28, K29, \
+              K32, K33, K34,     K35, K36, K37 \
+) \
+{ \
+    { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09 }, \
+    { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19 }, \
+    { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29 }, \
+    { KC_NO, KC_NO, K32, K33, K34, K35, K36, K37, KC_NO, KC_NO } \
+}

keyboards/eek/info.json

@@ -0,0 +1,13 @@
+{
+    "keyboard_name": "eek!",
+    "url": "http://www.keyboard-layout-editor.com/#/gists/3e4d0cd1534dd4e4b9f25cf2b36d0d63",
+    "maintainer": "klackygears",
+    "width": 13,
+    "height": 6.25,
+    "layouts": {
+            "LAYOUT": {
+                "layout": [{"label":"E", "x":0.5, "y":0.75}, {"label":"W", "x":-0.5, "y":1.1300000000000001}, {"label":"R", "x":1.5, "y":1.1300000000000001}, {"label":"T", "x":2.5, "y":1.25}, {"label":"Q", "x":-1.5, "y":1.6300000000000001}, {"label":"D", "x":0.5, "y":1.75}, {"label":"S", "x":-0.5, "y":2.13}, {"label":"F", "x":1.5, "y":2.13}, {"label":"G", "x":2.5, "y":2.25}, {"label":"A", "x":-1.5, "y":2.63}, {"label":"C", "x":0.5, "y":2.75}, {"label":"X", "x":-0.5, "y":3.13}, {"label":"V", "x":1.5, "y":3.13}, {"label":"B", "x":2.5, "y":3.25}, {"label":"Z", "x":-1.5, "y":3.63}, {"label":"Ctrl", "x":0.5, "y":4}, {"label":"Lower", "x":1.5, "y":4.13}, {"label":"Space", "x":2.5, "y":4.25}, {"label":"I", "x":1.15, "y":3.4}, {"label":"U", "x":0.15, "y":3.78}, {"label":"O", "x":2.15, "y":3.78}, {"label":"Y", "x":-0.85, "y":3.9}, {"label":"P", "x":3.15, "y":4.28}, {"label":"K", "x":1.15, "y":4.4}, {"label":"J", "x":0.15, "y":4.78}, {"label":"L", "x":2.15, "y":4.78}, {"label":"H", "x":-0.85, "y":4.9}, {"label":";", "x":3.15, "y":5.28}, {"label":",", "x":1.15, "y":5.4}, {"label":"M", "x":0.15, "y":5.78}, {"label":".", "x":2.15, "y":5.78}, {"label":"N", "x":-0.85, "y":5.9}, {"label":"/", "x":3.15, "y":6.28}, {"label":"Shift", "x":1.15, "y":6.65}, {"label":"Raise", "x":0.15, "y":6.78}, {"label":"BSpc", "x":-0.85, "y":6.9}]
+            }
+        }
+
+}