summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-08-26 17:47:28 +0000
committerQMK Bot <hello@qmk.fm>2021-08-26 17:47:28 +0000
commita13b0d8a6cdfbb0c7873144e464c4ae13fa30854 (patch)
tree4bfecaebfdab0caccb35a35d0df2afc59dadb21a
parent87cdb1cf9a89a702f0c4286d4260fc84b18ae042 (diff)
parent3fce5e6912d78ec9fff4124b6952e3b8a0d4d3ae (diff)
downloadqmk_firmware-a13b0d8a6cdfbb0c7873144e464c4ae13fa30854.tar.gz
qmk_firmware-a13b0d8a6cdfbb0c7873144e464c4ae13fa30854.zip
Merge remote-tracking branch 'origin/master' into develop
-rw-r--r--keyboards/v4n4g0rth0n/config.h46
-rw-r--r--keyboards/v4n4g0rth0n/info.json66
-rw-r--r--keyboards/v4n4g0rth0n/readme.md17
-rw-r--r--keyboards/v4n4g0rth0n/v1/config.h23
-rw-r--r--keyboards/v4n4g0rth0n/v1/keymaps/default/keymap.c48
-rw-r--r--keyboards/v4n4g0rth0n/v1/readme.md1
-rw-r--r--keyboards/v4n4g0rth0n/v1/rules.mk22
-rw-r--r--keyboards/v4n4g0rth0n/v2/config.h23
-rw-r--r--keyboards/v4n4g0rth0n/v2/keymaps/default/keymap.c86
-rw-r--r--keyboards/v4n4g0rth0n/v2/readme.md1
-rw-r--r--keyboards/v4n4g0rth0n/v2/rules.mk25
-rw-r--r--keyboards/v4n4g0rth0n/v4n4g0rth0n.c17
-rw-r--r--keyboards/v4n4g0rth0n/v4n4g0rth0n.h43
13 files changed, 418 insertions, 0 deletions
diff --git a/keyboards/v4n4g0rth0n/config.h b/keyboards/v4n4g0rth0n/config.h
new file mode 100644
index 0000000000..e023875feb
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/config.h
@@ -0,0 +1,46 @@
+/*
+Copyright 2021 jpuerto
+
+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 0xB33F
+#define PRODUCT_ID 0x58E4
+#define MANUFACTURER s8erdude
+#define PRODUCT v4n4g0rth0n
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 12
+
+/* COL2ROW, ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION
+
+// TOP, MID, BOT
+// B4, D7, D6
+#define LED_NUM_LOCK_PIN B4
+#define LED_CAPS_LOCK_PIN D7
+#define LED_SCROLL_LOCK_PIN D6
diff --git a/keyboards/v4n4g0rth0n/info.json b/keyboards/v4n4g0rth0n/info.json
new file mode 100644
index 0000000000..2be13c39e2
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/info.json
@@ -0,0 +1,66 @@
+{
+ "keyboard_name": "v4n4g0rth0n",
+ "url": "https://github.com/jpuerto96/v4n4g0rth0n",
+ "maintainer": "jpuerto96 (s8erdude)",
+ "width": 12.75,
+ "height": 5,
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ {"label":"1", "x":0.5, "y":0},
+ {"label":"2", "x":1.5, "y":0},
+ {"label":"3", "x":2.5, "y":0},
+ {"label":"4", "x":3.5, "y":0},
+ {"label":"5", "x":4.5, "y":0},
+ {"label":"6", "x":5.5, "y":0},
+ {"label":"Tab", "x":0, "y":1},
+
+ {"label":"Q", "x":1, "y":1},
+ {"label":"W", "x":2, "y":1},
+ {"label":"E", "x":3, "y":1},
+ {"label":"R", "x":4, "y":1},
+ {"label":"T", "x":5, "y":1},
+ {"label":"Y", "x":6.75, "y":1},
+ {"label":"U", "x":7.75, "y":1},
+ {"label":"I", "x":8.75, "y":1},
+ {"label":"O", "x":9.75, "y":1},
+ {"label":"P", "x":10.75, "y":1},
+ {"label":"Back Space", "x":11.75, "y":1},
+
+ {"label":"Esc", "x":0, "y":2},
+ {"label":"A", "x":1, "y":2},
+ {"label":"S", "x":2, "y":2},
+ {"label":"D", "x":3, "y":2},
+ {"label":"F", "x":4, "y":2},
+ {"label":"G", "x":5, "y":2},
+ {"label":"H", "x":6.75, "y":2},
+ {"label":"J", "x":7.75, "y":2},
+ {"label":"K", "x":8.75, "y":2},
+ {"label":"L", "x":9.75, "y":2},
+ {"label":";", "x":10.75, "y":2},
+ {"label":"'", "x":11.75, "y":2},
+
+ {"label":"Shift", "x":0, "y":3},
+ {"label":"Z", "x":1, "y":3},
+ {"label":"X", "x":2, "y":3},
+ {"label":"C", "x":3, "y":3},
+ {"label":"V", "x":4, "y":3},
+ {"label":"B", "x":5, "y":3},
+ {"label":"N", "x":6.75, "y":3},
+ {"label":"M", "x":7.75, "y":3},
+ {"label":",", "x":8.75, "y":3},
+ {"label":".", "x":9.75, "y":3},
+ {"label":"&uarr;", "x":10.75, "y":3},
+ {"label":"Return", "x":11.75, "y":3},
+
+ {"label":"Gui", "x":0, "y":4},
+ {"label":"Ctrl", "x":1, "y":4},
+ {"label":"Alt", "x":2, "y":4},
+ {"label":"Space", "x":3, "y":4, "w":3},
+ {"label":"Enter", "x":6.75, "y":4, "w":3},
+ {"label":"&larr;", "x":9.75, "y":4},
+ {"label":"&darr;", "x":10.75, "y":4},
+ {"label":"&rarr;", "x":11.75, "y":4}]
+ }
+ }
+}
diff --git a/keyboards/v4n4g0rth0n/readme.md b/keyboards/v4n4g0rth0n/readme.md
new file mode 100644
index 0000000000..dd44c95e82
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/readme.md
@@ -0,0 +1,17 @@
+# v4n4g0rth0n
+
+Drop in ortholinear PCB replacement for V4N4G0N
+
+* Keyboard Maintainer: [jpuerto](https://github.com/jpuerto96)
+* Hardware Supported: Only supports v4n4g0rth0n PCB
+* Hardware Availability: [GitHub](https://github.com/jpuerto96/v4n4g0rth0n)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make v4n4g0rth0n/v1:default
+
+Flashing example for this keyboard:
+
+ make v4n4g0rth0n/v1: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).
diff --git a/keyboards/v4n4g0rth0n/v1/config.h b/keyboards/v4n4g0rth0n/v1/config.h
new file mode 100644
index 0000000000..dd72cf6500
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v1/config.h
@@ -0,0 +1,23 @@
+/*
+Copyright 2021 jpuerto
+
+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
+
+#define DEVICE_VER 0x0001
+
+#define MATRIX_ROW_PINS { C7, C6, B6, B5, B7}
+#define MATRIX_COL_PINS { D3, D2, D1, D0, D5, F7, F6, E6, F5, F4, F1, F0}
diff --git a/keyboards/v4n4g0rth0n/v1/keymaps/default/keymap.c b/keyboards/v4n4g0rth0n/v1/keymaps/default/keymap.c
new file mode 100644
index 0000000000..a1c547e884
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v1/keymaps/default/keymap.c
@@ -0,0 +1,48 @@
+/* Copyright 2021 jpuerto
+ *
+ * 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,
+ _NUM,
+ _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ /* Base */
+ [_BASE] = LAYOUT(
+ KC_1, KC_2, KC_3, KC_4, KC_5, KC_6,
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
+ KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+ KC_LCAP, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_SLSH,
+ KC_LGUI, MO(_NUM), MO(_FN), KC_SPC, KC_ENT, KC_LEFT, KC_DOWN, KC_RIGHT
+ ),
+ [_NUM] = LAYOUT(
+ KC_1, KC_2, KC_3, KC_4, KC_5, KC_6,
+ KC_TAB, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
+ KC_LCTL, RESET, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_SLSH,
+ RESET, KC_TRNS, KC_TRNS, KC_SPC, KC_ENT, KC_LEFT, KC_DOWN, KC_RIGHT
+ ),
+ [_FN] = LAYOUT(
+ KC_1, KC_2, KC_3, KC_4, KC_5, KC_6,
+ KC_TAB, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
+ KC_LCTL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_MINS, KC_EQL, KC_LCBR, KC_RCBR, KC_PIPE, KC_GRV,
+ KC_LSFT, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_UNDS, KC_PLUS, KC_LBRC, KC_RBRC, KC_BSLS, KC_TILD,
+ RESET, KC_TRNS, KC_TRNS, KC_SPC, KC_ENT, KC_LEFT, KC_DOWN, KC_RIGHT
+ )
+};
diff --git a/keyboards/v4n4g0rth0n/v1/readme.md b/keyboards/v4n4g0rth0n/v1/readme.md
new file mode 100644
index 0000000000..957511705a
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v1/readme.md
@@ -0,0 +1 @@
+Revision 1 of this PCB that does not support a slider.
diff --git a/keyboards/v4n4g0rth0n/v1/rules.mk b/keyboards/v4n4g0rth0n/v1/rules.mk
new file mode 100644
index 0000000000..cb9faecf74
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v1/rules.mk
@@ -0,0 +1,22 @@
+# 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 = yes # 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 = no # USB Nkey Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
diff --git a/keyboards/v4n4g0rth0n/v2/config.h b/keyboards/v4n4g0rth0n/v2/config.h
new file mode 100644
index 0000000000..6e78e73573
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v2/config.h
@@ -0,0 +1,23 @@
+/*
+Copyright 2021 jpuerto
+
+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
+
+#define DEVICE_VER 0x0002
+
+#define MATRIX_ROW_PINS { C7, C6, B6, B5, B7}
+#define MATRIX_COL_PINS { D3, D2, D1, D0, D5, F7, F6, E6, F5, F4, F1, B0}
diff --git a/keyboards/v4n4g0rth0n/v2/keymaps/default/keymap.c b/keyboards/v4n4g0rth0n/v2/keymaps/default/keymap.c
new file mode 100644
index 0000000000..11616b2e7b
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v2/keymaps/default/keymap.c
@@ -0,0 +1,86 @@
+/* Copyright 2021 jpuerto
+ *
+ * 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 "analog.h"
+int16_t max_pot_val = 1023;
+int16_t max_ticks = 20;
+int16_t pot_oldVal = 0;
+int16_t pot_val = 0;
+bool moving = false;
+#define POT_TOLERANCE 50
+#define POT_PIN F0
+#include "print.h"
+
+
+void matrix_init_user(void) {
+ analogReference(ADC_REF_POWER);
+}
+
+void matrix_scan_user(void){
+ pot_val = (analogReadPin(POT_PIN));
+
+ // If there is a big enough change, then we need to do something
+ if (abs(pot_val - pot_oldVal) > POT_TOLERANCE) {
+ moving = true;
+ pot_oldVal = pot_val;
+ }
+ else{
+ if (moving){
+ // Do some fancy conversion to get 'absolute' position to num tap_codes to send
+ // Reset moving to 0 so that we don't get multiple attempts to do this
+ int num_ticks = ((float)pot_val/max_pot_val)*max_ticks;
+ for (int i = 0; i<max_ticks;++i){
+ tap_code(KC__VOLDOWN);
+ }
+ for (int i = 0; i<num_ticks;++i){
+ tap_code(KC__VOLUP);
+ }
+ moving = false;
+ }
+ }
+}
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+ _BASE,
+ _NUM,
+ _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ /* Base */
+ [_BASE] = LAYOUT(
+ KC_1, KC_2, KC_3, KC_4, KC_5, KC_6,
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
+ KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+ KC_LCAP, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_SLSH,
+ KC_LGUI, MO(_NUM), MO(_FN), KC_SPC, KC_ENT, KC_LEFT, KC_DOWN, KC_RIGHT
+ ),
+ [_NUM] = LAYOUT(
+ KC_1, KC_2, KC_3, KC_4, KC_5, KC_6,
+ KC_TAB, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
+ KC_LCTL, RESET, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_SLSH,
+ RESET, KC_TRNS, KC_TRNS, KC_SPC, KC_ENT, KC_LEFT, KC_DOWN, KC_RIGHT
+ ),
+ [_FN] = LAYOUT(
+ KC_1, KC_2, KC_3, KC_4, KC_5, KC_6,
+ KC_TAB, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
+ KC_LCTL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_MINS, KC_EQL, KC_LCBR, KC_RCBR, KC_PIPE, KC_GRV,
+ KC_LSFT, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_UNDS, KC_PLUS, KC_LBRC, KC_RBRC, KC_BSLS, KC_TILD,
+ RESET, KC_TRNS, KC_TRNS, KC_SPC, KC_ENT, KC_LEFT, KC_DOWN, KC_RIGHT
+ )
+};
diff --git a/keyboards/v4n4g0rth0n/v2/readme.md b/keyboards/v4n4g0rth0n/v2/readme.md
new file mode 100644
index 0000000000..d6ecd75769
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v2/readme.md
@@ -0,0 +1 @@
+PCB with slider support.
diff --git a/keyboards/v4n4g0rth0n/v2/rules.mk b/keyboards/v4n4g0rth0n/v2/rules.mk
new file mode 100644
index 0000000000..2a569001f8
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v2/rules.mk
@@ -0,0 +1,25 @@
+# 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 = yes # 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 = no # USB Nkey Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
+
+SRC += analog.c
+
diff --git a/keyboards/v4n4g0rth0n/v4n4g0rth0n.c b/keyboards/v4n4g0rth0n/v4n4g0rth0n.c
new file mode 100644
index 0000000000..983bd78787
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v4n4g0rth0n.c
@@ -0,0 +1,17 @@
+/* Copyright 2021 jpuerto
+ *
+ * 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 "v4n4g0rth0n.h"
diff --git a/keyboards/v4n4g0rth0n/v4n4g0rth0n.h b/keyboards/v4n4g0rth0n/v4n4g0rth0n.h
new file mode 100644
index 0000000000..7c8edfeb12
--- /dev/null
+++ b/keyboards/v4n4g0rth0n/v4n4g0rth0n.h
@@ -0,0 +1,43 @@
+/* Copyright 2021 jpuerto
+ *
+ * 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
+
+/* This is 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, \
+ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, \
+ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, \
+ k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, \
+ k40, k41, k42, k44, k47, k49, k4A, k4B \
+) { \
+ { k00, k01, k02, k03, k04, k05, XXX, XXX, XXX, XXX, XXX, XXX }, \
+ { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B }, \
+ { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B }, \
+ { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B }, \
+ { k40, k41, k42, XXX, k44, XXX, XXX, k47, XXX, k49, k4A, k4B } \
+}