[Keyboard] add Basekeys Trifecta (#10375)

* Trifecta 09-20

* Update keyboards/basekeys/trifecta/config.h

* Update keyboards/basekeys/trifecta/config.h

* Update keyboards/basekeys/trifecta/config.h

* Update keyboards/basekeys/trifecta/keymaps/default/keymap.c

* Update keyboards/basekeys/trifecta/keymaps/via/keymap.c

* Update keyboards/basekeys/trifecta/rules.mk

* Update rules.mk

Suggested Changes

* Update keyboards/basekeys/trifecta/readme.md

* Update keyboards/basekeys/trifecta/readme.md

* Tap Dance Removal

* Update keyboards/basekeys/trifecta/keymaps/default/keymap.c

* Update keyboards/basekeys/trifecta/keymaps/default/keymap.c

* Update keyboards/basekeys/trifecta/keymaps/via/keymap.c

keyboards/basekeys/trifecta/config.h

@@ -0,0 +1,123 @@
+/* Copyright 2020 Swiftrax and Basekeys.com
+ *
+ * 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       0x04D8
+#define PRODUCT_ID      0xEAF3
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Swiftrax
+#define PRODUCT         Trifecta
+
+/* key matrix size */
+#define MATRIX_ROWS 10
+#define MATRIX_COLS 8
+
+/* key matrix pins */
+
+#define MATRIX_ROW_PINS { B0, B7, F7, B1, B6, C6, C7, B5, F6, D2 }
+#define MATRIX_COL_PINS { F0, F1, F4, F5, D1, B2, D0, B3 }
+
+
+#define ENCODERS_PAD_A { D4, D6, D7 }
+#define ENCODERS_PAD_B { B4, D3, D5 }
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+
+#define RGB_DI_PIN E6
+#define DRIVER_LED_TOTAL 80
+
+/* RGB LED */
+#ifdef RGBLIGHT_ENABLE
+#define RGB_DI_PIN E6
+#define RGBLED_NUM 80    // Number of LEDs. backlight x69
+#define RGBLIGHT_HUE_STEP 10
+#define RGBLIGHT_SAT_STEP 17
+#define RGBLIGHT_VAL_STEP 17
+#define RGBLIGHT_ANIMATIONS
+#endif
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* Limits the brightness of the LEDS range of 255-0 (255 is default)*/
+#define RGBLIGHT_LIMIT_VAL 128
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* 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
+
+/* EEPROM for via */
+#define DYNAMIC_KEYMAP_LAYER_COUNT 3
+
+/* bootmagic row col assignment */
+#define BOOTMAGIC_LITE_ROW 1
+#define BOOTMAGIC_LITE_COLUMN 0
+
+#ifdef RGB_MATRIX_ENABLE
+#   define RGB_MATRIX_KEYPRESSES // reacts to keypresses
+// #   define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
+// #   define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
+//#   define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended
+#   define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#   define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
+#   define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
+#    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash. 
+#    define RGB_MATRIX_HUE_STEP 8
+#    define RGB_MATRIX_SAT_STEP 8
+#    define RGB_MATRIX_VAL_STEP 8
+#    define RGB_MATRIX_SPD_STEP 10
+
+/* Disable the animations you don't want/need.  You will need to disable a good number of these    *
+ * because they take up a lot of space.  Disable until you can successfully compile your firmware. */
+// #   define DISABLE_RGB_MATRIX_ALPHAS_MODS
+// #   define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+// #   define DISABLE_RGB_MATRIX_BREATHING
+// #   define DISABLE_RGB_MATRIX_CYCLE_ALL
+// #   define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+// #   define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
+// #   define DISABLE_RGB_MATRIX_CYCLE_OUT_IN
+// #   define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+// #   define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+// #   define DISABLE_RGB_MATRIX_DUAL_BEACON
+// #   define DISABLE_RGB_MATRIX_RAINBOW_BEACON
+// #   define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+// #   define DISABLE_RGB_MATRIX_RAINDROPS
+// #   define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+// #   define DISABLE_RGB_MATRIX_TYPING_HEATMAP
+// #   define DISABLE_RGB_MATRIX_DIGITAL_RAIN
+// #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE
+// #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+// #   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
+#endif

keyboards/basekeys/trifecta/keymaps/default/keymap.c

@@ -0,0 +1,71 @@
+/* Copyright 2020 Swiftrax and Basekeys.com
+ *
+ * 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
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _FN,
+    _MEDIA };
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT(
+    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_DEL,   KC_DEL,
+    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_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_HOME,
+    KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,        MO(_MEDIA),   KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,        KC_UP,
+    KC_LCTL, KC_LGUI,  KC_LALT,         KC_SPC,                         KC_SPC,           KC_RGUI, KC_RCTL,  MO(_FN),        KC_LEFT, KC_DOWN, KC_RGHT
+  ),
+
+  [_FN] = LAYOUT(
+     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, _______,  _______,     _______,
+    _______, _______, _______, _______,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,               _______,
+    _______, RGB_MOD, RGB_HUI, RGB_SAI,  RGB_VAI, _______, _______, _______, _______, _______, _______, _______, _______,                         _______,
+    _______, RGB_TOG, RGB_HUD, RGB_SAD,  RGB_VAD, _______, _______, _______, _______, _______, _______, _______,  _______,                   KC_PGUP,
+    _______, _______, _______,           _______, _______,          _______,          _______,          _______,                    KC_HOME, KC_PGDN, KC_END
+  ),
+
+  [_MEDIA] = LAYOUT(
+     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_MOD, RGB_HUI, RGB_SAI,  RGB_VAI, _______, _______, _______, _______, _______, _______, _______, _______,                         _______,
+    _______, RGB_TOG, RGB_HUD, RGB_SAD,  RGB_VAD, _______, _______, _______, _______, _______, _______, _______,  _______,                   KC_PGUP,
+    _______, _______, _______,           _______, _______,          _______,          _______,          _______,                    KC_HOME, KC_PGDN, KC_END
+  )
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) { /* First encoder */
+        if (clockwise) {
+            tap_code(KC_VOLU);
+        } else {
+            tap_code(KC_VOLD);
+        }
+    } else if (index == 1) { /* Second encoder */
+        if (clockwise) {
+            tap_code(KC_MNXT);
+        } else {
+            tap_code(KC_MPRV);
+        }
+     } else if (index == 2) { /* Third encoder */
+        if (clockwise) {
+            tap_code(KC_RGHT);
+        } else {
+            tap_code(KC_LEFT);
+        }
+    }
+}

keyboards/basekeys/trifecta/keymaps/default/rules.mk

@@ -0,0 +1,2 @@
+CONSOLE_ENABLE = no        # Console for debug
+COMMAND_ENABLE = no

keyboards/basekeys/trifecta/keymaps/via/keymap.c

@@ -0,0 +1,71 @@
+/* Copyright 2020 Swiftrax and Basekeys.com
+ *
+ * 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
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _FN,
+    _MEDIA };
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT(
+    KC_ESC,  RGB_TOG,    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_DEL,   KC_DEL,
+    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_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_HOME,
+    KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,        MO(_MEDIA),   KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,        KC_UP,
+    KC_LCTL, KC_LGUI,  KC_LALT,         KC_SPC,                         KC_SPC,           KC_RGUI, KC_RCTL,  MO(_FN),        KC_LEFT, KC_DOWN, KC_RGHT
+  ),
+
+  [_FN] = LAYOUT(
+     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, _______,  _______,     _______, 
+    _______, _______, _______, _______,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,               _______,
+    _______, RGB_MOD, RGB_HUI, RGB_SAI,  RGB_VAI, _______, _______, _______, _______, _______, _______, _______, _______,                         _______,
+    _______, RGB_TOG, RGB_HUD, RGB_SAD,  RGB_VAD, _______, _______, _______, _______, _______, _______, _______,  _______,                   KC_PGUP,
+    _______, _______, _______,           _______, _______,          _______,          _______,          _______,                    KC_HOME, KC_PGDN, KC_END
+  ),
+
+  [_MEDIA] = LAYOUT(
+     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_MOD, RGB_HUI, RGB_SAI,  RGB_VAI, _______, _______, _______, _______, _______, _______, _______, _______,                         _______,
+    _______, RGB_TOG, RGB_HUD, RGB_SAD,  RGB_VAD, _______, _______, _______, _______, _______, _______, _______,  _______,                   KC_PGUP,
+    _______, _______, _______,           _______, _______,          _______,          _______,          _______,                    KC_HOME, KC_PGDN, KC_END
+  )
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) { /* First encoder */
+        if (clockwise) {
+            tap_code(KC_VOLU);
+        } else {
+            tap_code(KC_VOLD);
+        }
+    } else if (index == 1) { /* Second encoder */
+        if (clockwise) {
+            tap_code(KC_RGHT);
+        } else {
+            tap_code(KC_LEFT);
+        }
+     } else if (index == 2) { /* Third encoder */
+        if (clockwise) {
+            rgblight_step();
+        } else {
+           rgblight_step_reverse();
+        }
+    }
+}

keyboards/basekeys/trifecta/keymaps/via/rules.mk

@@ -0,0 +1,3 @@
+VIA_ENABLE = yes
+CONSOLE_ENABLE = no        # Console for debug
+COMMAND_ENABLE = no

keyboards/basekeys/trifecta/readme.md

@@ -0,0 +1,17 @@
+# Trifecta
+
+![Trifecta](https://i.imgur.com/tlIwQowl.jpeg)
+
+An Alice style board with arrowkeys, based on the Fate Arisu layout.
+
+* Keyboard Maintainer: [swiftrax](https://github.com/swiftrax)  
+* Hardware Supported: Trifecta PCB, ATMEGA32U4-AU
+* Hardware Availability: [Website](https://mykeyboard.eu/catalogue/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make basekeys/trifecta:default
+
+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)
+
+[Build guide](https://www.basekeys.com/category/build-guides/)

keyboards/basekeys/trifecta/rules.mk

@@ -0,0 +1,24 @@
+# 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 = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = yes        # Console for debug
+COMMAND_ENABLE = yes        # 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 = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+
+ENCODER_ENABLE = yes

keyboards/basekeys/trifecta/trifecta.c

@@ -0,0 +1,61 @@
+/* Copyright 2020 Swiftrax and Basekeys.com
+ *
+ * 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 "trifecta.h"
+
+#ifdef RGB_MATRIX_ENABLE
+
+led_config_t g_led_config = { {
+    { NO_LED, 70,     61,     52,     43, 34,     24,     14  },
+    {     79, 69,     60,     51,     42, 33,     23, NO_LED  },
+    { NO_LED, 71,     62,     53,     44, 35,     25,     15  },
+    {     78, 68,     59,     50,     41, 32,     22, NO_LED  },
+    {     77, 67,     58,     49,     40, 31, NO_LED,     16  },
+    { NO_LED, 72,     63,     54,     45, 36,     26, NO_LED  },
+    { NO_LED, 73,     64,     55,     46, 37,     27,     17  },
+    {     76, 66,     57,     48,     39, 30,     21, NO_LED  },
+    { NO_LED, 74,     56, NO_LED, NO_LED, 38,     28,     18  },
+    {     75, 65, NO_LED, NO_LED,     47, 29,     20,     19  }
+}, {
+	// Underglow
+    {  218,   7 },  { 214,  45 }, { 180,  47 }, {  147, 50 }, {  94,  62 }, {  37,  51 }, {   4,   8 }, {   36,  15 },
+    {  62,   18 },  {  78,   5 }, { 119,   7 }, {  145, 16 }, { 166,   3 }, { 200,  16 }, 
+    
+    //Per Key
+    { 185,  11 },  { 191,  22 }, { 188,  33 }, { 200,  46 }, { 200,  57 }, { 212,  57 }, { 188,  57 }, { 181,  44 },
+    { 176,  22 },  { 168,  11 }, { 155,  11 }, { 164,  22 }, { 169,  32 }, { 165,  44 }, { 172,  55 }, { 157,  54 }, 
+    { 153,  44 },  { 156,  33 }, { 153,  22 }, { 142,  12 }, { 130,  13 }, { 138,  23 }, { 143,  33 }, { 140,  45 }, 
+    { 137,  56 },  { 128,  47 }, { 132,  35 }, { 127,  25 }, { 119,  16 }, { 107,  17 }, { 115,  27 }, { 120,  37 }, 
+    { 116,  48 },  { 117,  59 }, { 104,  51 }, { 109,  39 }, { 104,  29 }, {  86,  19 }, {  74,  16 }, {  78,  28 }, 
+    {  79,  39 },  {  82,  50 }, {  73,  60 }, {  71,  48 }, {  67,  37 }, {  66,  26 }, {  63,  15 }, {  50,  12 }, 
+    {  55,  24 },  {  55,  35 }, {  59,  47 }, {  50,  56 }, {  47,  45 }, {  43,  33 }, {  43,  22 }, {  39,  10 }, 
+    {  25,  11 },  {  29,  22 }, {  30,  33 }, {  34,  44 }, {  24,  54 }, {   9,  55 }, {  15,  44 }, {  14,  33 }, 
+    {  14,  22 },  {  14,  11 }
+}, {
+    2, 2, 2, 2, 2, 2, 2, 2, 
+    2, 2, 2, 2, 2, 2, 
+
+    4, 4, 4, 4, 4, 4, 4, 4,
+    4, 4, 4, 4, 4, 4, 4, 4, 
+    4, 4, 4, 4, 4, 4, 4, 4, 
+    4, 4, 4, 4, 4, 4, 4, 4, 
+    4, 4, 4, 4, 4, 4, 4, 4, 
+    4, 4, 4, 4, 4, 4, 4, 4, 
+    4, 4, 4, 4, 4, 4, 4, 4, 
+    4, 4, 4, 4, 4, 4, 4, 4, 
+    4, 4
+} };
+#endif

keyboards/basekeys/trifecta/trifecta.h

@@ -0,0 +1,48 @@
+/* Copyright 2020 Swiftrax and Basekeys.com
+ *
+ * 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 XXX KC_NO//readabilty 
+
+/* 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( \
+    k10,  k01,  k11,  k02,  k12,  k03,  k13,      k04,  k14,  k05,  k15,  k06,  k16,  k07,  k17,          k37,  \
+    k30,  k21,  k31,  k22,  k32,  k23,            k33,  k24,  k34,  k25,  k35,  k26,  k36,  k27,          k57,  \
+    k40,  k51,  k41,  k52,  k42,  k53,            k43,  k54,  k44,  k55,  k45,  k56,  k47,                k77,  \
+    k70,  k61,  k71,  k62,  k72,  k63,            k73,  k64,  k74,  k65,  k75,  k66,  k76,          k67,        \
+    k90,  k81,        k91,        k82,                  k94,        k85,  k95,  k86,          k96,  k87,  k97   \
+) \
+{ \
+   { XXX,  k01,  k02,  k03,  k04,  k05,  k06,  k07}, \
+   { k10,  k11,  k12,  k13,  k14,  k15,  k16,  k17}, \
+   { XXX,  k21,  k22,  k23,  k24,  k25,  k26,  k27}, \
+   { k30,  k31,  k32,  k33,  k34,  k35,  k36,  k37}, \
+   { k40,  k41,  k42,  k43,  k44,  k45,  XXX,  k47}, \
+   { XXX,  k51,  k52,  k53,  k54,  k55,  k56,  k57}, \
+   { XXX,  k61,  k62,  k63,  k64,  k65,  k66,  k67}, \
+   { k70,  k71,  k72,  k73,  k74,  k75,  k76,  k77}, \
+   { XXX,  k81,  k82,  XXX,  XXX,  k85,  k86,  k87}, \
+   { k90,  k91,  XXX,  XXX,  k94,  k95,  k96,  k97}  \
+}