Merge remote-tracking branch 'origin/master' into develop

7 files changed, 575 insertions, 0 deletions

diff --git a/keyboards/yampad/config.h b/keyboards/yampad/config.h
new file mode 100644
index 0000000000..d04ae37d5a
--- /dev/null
+++ b/keyboards/yampad/config.h
@@ -0,0 +1,85 @@
+/*
+Copyright 2012 Jun Wako <wakojun@gmail.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       0xFEED
+#define PRODUCT_ID      0x8369
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Mattia Dal Ben
+#define PRODUCT         Yampad
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 4
+
+/*
+ * 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 { C6, D7, E6, B4, B5 }
+#define MATRIX_COL_PINS { B1, B3, B2, B6 }
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* Underlight configuration */
+#define RGB_DI_PIN F4
+#define RGBLED_NUM 9
+#define RGBLIGHT_ANIMATIONS
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 2
+
+/* 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
+
+/*
+ * 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
diff --git a/keyboards/yampad/keymaps/default/keymap.c b/keyboards/yampad/keymaps/default/keymap.c
new file mode 100644
index 0000000000..dfecab17eb
--- /dev/null
+++ b/keyboards/yampad/keymaps/default/keymap.c
@@ -0,0 +1,163 @@
+/* MIT License
+
+Copyright (c) 2019 Mattia Dal Ben
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+#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.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+enum layers {
+    _BL,
+    _NV,
+    _FN
+};
+
+enum custom_keycodes {
+    KC_DBL0 = SAFE_RANGE,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+/* Keymap _BL: (Base Layer) Default Layer
+ * ,-------------------.
+ * | NV | /  | *  |-/FN|
+ * |----|----|----|----|
+ * | 7  | 8  | 9  |    |
+ * |----|----|----| +  |
+ * | 4  | 5  | 6  |    |
+ * |----|----|----|----|
+ * | 1  | 2  | 3  |    |
+ * |----|----|----| En |
+ * | 0  | 00 | .  |    |
+ * `-------------------'
+ */
+  [_BL] = LAYOUT(
+    TG(_NV),  KC_PSLS,  KC_PAST,   LT(_FN, KC_PMNS),
+    KC_P7,    KC_P8,    KC_P9,
+    KC_P4,    KC_P5,    KC_P6,     KC_PPLS,
+    KC_P1,    KC_P2,    KC_P3,
+    KC_P0,    KC_DBL0,  KC_PDOT,   KC_PENT
+  ),
+
+/* Keymap _NV: Navigation layer
+ * ,-------------------.
+ * |INS |HOME|PGUP|    |
+ * |----|----|----|----|
+ * |DEL |END |PGDN|    |
+ * |----|----|----|    |
+ * |    |    |    |    |
+ * |----|----|----|----|
+ * |    | UP |    |    |
+ * |----|----|----|    |
+ * |LEFT|DOWN|RIGH|    |
+ * `-------------------'
+ */
+  [_NV] = LAYOUT(
+    KC_INS,   KC_HOME,  KC_PGUP,   TG(_NV),
+    KC_DEL,   KC_END,   KC_PGDN,
+    XXXXXXX,  XXXXXXX,  XXXXXXX,   XXXXXXX,
+    XXXXXXX,  KC_UP,    XXXXXXX,
+    KC_LEFT,  KC_DOWN,  KC_RGHT,   XXXXXXX
+  ),
+
+/* Keymap _FN: RGB Function Layer
+ * ,-------------------.
+ * |RMOD|RGBP|RTOG| FN |
+ * |----|----|----|----|
+ * |HUD |HUI |    |    |
+ * |----|----|----|    |
+ * |SAD |SAI |    |    |
+ * |----|----|----|----|
+ * |VAD |VAS |    |    |
+ * |----|----|----|    |
+ * |RST |    |    |    |
+ * `-------------------'
+ */
+  [_FN] = LAYOUT(
+    RGB_MOD,  RGB_M_P,  RGB_TOG,   _______,
+    RGB_HUD,  RGB_HUI,  XXXXXXX,
+    RGB_SAD,  RGB_SAI,  XXXXXXX,   XXXXXXX,
+    RGB_VAD,  RGB_VAI,  XXXXXXX,
+    RESET,    XXXXXXX,  XXXXXXX,   XXXXXXX
+  ),
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case KC_DBL0:
+      if (record->event.pressed) {
+        SEND_STRING("00");
+      } else {
+        // when keycode KC_DBL0 is released
+      }
+      break;
+
+  }
+  return true;
+};
+
+#ifdef OLED_DRIVER_ENABLE
+
+oled_rotation_t oled_init_user(oled_rotation_t rotation) {
+    return OLED_ROTATION_270;  // flips the display 270 degrees
+}
+
+void oled_task_user(void) {
+  // Host Keyboard Layer Status
+  oled_write_P(PSTR("Layer"), false);
+  switch (get_highest_layer(layer_state)) {
+    case _BL:
+      oled_write_ln_P(PSTR(" BAS"), false);
+      break;
+    case _NV:
+      oled_write_ln_P(PSTR(" NAV"), false);
+      break;
+    case _FN:
+      oled_write_ln_P(PSTR(" RGB"), false);
+      break;
+    default:
+      // Or use the write_ln shortcut over adding '\n' to the end of your string
+      oled_write_ln_P(PSTR(" UND"), false);
+  }
+
+  // Host Keyboard LED Status
+  led_t led_state = host_keyboard_led_state();
+  oled_write_P(PSTR("-----"), false);
+  oled_write_P(PSTR("Stats"), false);
+  oled_write_P(led_state.num_lock ? PSTR("num:*") : PSTR("num:."), false);
+  oled_write_P(led_state.caps_lock ? PSTR("cap:*") : PSTR("cap:."), false);
+  oled_write_P(led_state.scroll_lock ? PSTR("scr:*") : PSTR("scr:."), false);
+
+  // Host Keyboard RGB backlight status
+  oled_write_P(PSTR("-----"), false);
+  oled_write_P(PSTR("Light"), false);
+
+  static char led_buf[30];
+  snprintf(led_buf, sizeof(led_buf) - 1, "RGB:%cM: %2d\nh: %2ds: %2dv: %2d\n",
+      rgblight_is_enabled() ? '*' : '.', (uint8_t)rgblight_get_mode(),
+      (uint8_t)(rgblight_get_hue() / RGBLIGHT_HUE_STEP),
+      (uint8_t)(rgblight_get_sat() / RGBLIGHT_SAT_STEP),
+      (uint8_t)(rgblight_get_val() / RGBLIGHT_VAL_STEP));
+  oled_write(led_buf, false);
+}
+#endif
diff --git a/keyboards/yampad/keymaps/traditional/keymap.c b/keyboards/yampad/keymaps/traditional/keymap.c
new file mode 100644
index 0000000000..e9fd2b8ae1
--- /dev/null
+++ b/keyboards/yampad/keymaps/traditional/keymap.c
@@ -0,0 +1,163 @@
+/* MIT License
+
+Copyright (c) 2020 Richard Davey (Daveyr)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/    
+
+#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.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+enum layers {
+  _BL = 0,
+  _NV,
+  _FN
+};
+
+enum custom_keycodes {
+  KC_DBL0 = SAFE_RANGE,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+/* Keymap _BL: (Base Layer) Default Layer
+ * ,-------------------.
+ * | NV | /  | *  |-/FN|
+ * |----|----|----|----|
+ * | 7  | 8  | 9  |    |
+ * |----|----|----| +  |
+ * | 4  | 5  | 6  |    |
+ * |----|----|----|----|
+ * | 1  | 2  | 3  |    |
+ * |----|----|----| En |
+ * | 0  | 00 | .  |    |
+ * `-------------------'
+ */
+  [_BL] = LAYOUT(
+    TG(_NV),  KC_PSLS,  KC_PAST,   LT(_FN, KC_PMNS),
+    KC_P7,    KC_P8,    KC_P9,
+    KC_P4,    KC_P5,    KC_P6,     KC_PPLS,
+    KC_P1,    KC_P2,    KC_P3,
+    KC_P0,    KC_DBL0,  KC_PDOT,   KC_PENT
+  ),
+
+/* Keymap _NV: Navigation layer
+ * ,-------------------.
+ * |INS |BSPC|    |    |
+ * |----|----|----|----|
+ * |HOME| UP |PGUP|    |
+ * |----|----|----|    |
+ * |LEFT|DEL |RGHT|    |
+ * |----|----|----|----|
+ * |END |DOWN|PGDN|    |
+ * |----|----|----|    |
+ * |    |    |    |    |
+ * `-------------------'
+ */
+  [_NV] = LAYOUT(
+    KC_INS,   KC_BSPACE,  XXXXXXX,   TG(_NV),
+    KC_HOME,  KC_UP,   KC_PGUP,
+    KC_LEFT,  KC_DEL,  KC_RGHT,   XXXXXXX,
+    KC_END,   KC_DOWN, KC_PGDN,
+    XXXXXXX,  XXXXXXX, XXXXXXX,   XXXXXXX
+  ),
+
+/* Keymap _FN: RGB Function Layer
+ * ,-------------------.
+ * |RMOD|RGBP|RTOG| FN |
+ * |----|----|----|----|
+ * |HUD |HUI |    |    |
+ * |----|----|----|    |
+ * |SAD |SAI |    |    |
+ * |----|----|----|----|
+ * |VAD |VAS |    |    |
+ * |----|----|----|    |
+ * |RST |    |    |    |
+ * `-------------------'
+ */
+  [_FN] = LAYOUT(
+    RGB_MOD,  RGB_M_P,  RGB_TOG,   _______,
+    RGB_HUD,  RGB_HUI,  XXXXXXX,
+    RGB_SAD,  RGB_SAI,  XXXXXXX,   XXXXXXX,
+    RGB_VAD,  RGB_VAI,  XXXXXXX,
+    RESET,    XXXXXXX,  XXXXXXX,   XXXXXXX
+  ),
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case KC_DBL0:
+      if (record->event.pressed) {
+        SEND_STRING("00");
+      } else {
+        // when keycode KC_DBL0 is released
+      }
+      break;
+
+  }
+  return true;
+};
+
+#ifdef OLED_DRIVER_ENABLE
+
+oled_rotation_t oled_init_user(oled_rotation_t rotation) {
+    return OLED_ROTATION_270;  // flips the display 270 degrees
+}
+
+void oled_task_user(void) {
+  // Host Keyboard Layer Status
+  oled_write_P(PSTR("Layer"), false);
+  switch (get_highest_layer(layer_state)) {
+    case _BL:
+      oled_write_ln_P(PSTR(" BAS"), false);
+      break;
+    case _NV:
+      oled_write_ln_P(PSTR(" NAV"), false);
+      break;
+    case _FN:
+      oled_write_ln_P(PSTR(" RGB"), false);
+      break;
+    default:
+      // Or use the write_ln shortcut over adding '\n' to the end of your string
+      oled_write_ln_P(PSTR(" UND"), false);
+  }
+
+  // Host Keyboard LED Status
+  led_t led_state = host_keyboard_led_state();
+  oled_write_P(PSTR("-----"), false);
+  oled_write_P(PSTR("Stats"), false);
+  oled_write_P(led_state.num_lock ? PSTR("num:*") : PSTR("num:."), false);
+  oled_write_P(led_state.caps_lock ? PSTR("cap:*") : PSTR("cap:."), false);
+  oled_write_P(led_state.scroll_lock ? PSTR("scr:*") : PSTR("scr:."), false);
+
+  // Host Keyboard RGB backlight status
+  oled_write_P(PSTR("-----"), false);
+  oled_write_P(PSTR("Light"), false);
+
+  static char led_buf[30];
+  snprintf(led_buf, sizeof(led_buf) - 1, "RGB:%cM: %2d\nh: %2ds: %2dv: %2d\n",
+      rgblight_is_enabled() ? '*' : '.', (uint8_t)rgblight_get_mode(),
+      (uint8_t)(rgblight_get_hue() / RGBLIGHT_HUE_STEP),
+      (uint8_t)(rgblight_get_sat() / RGBLIGHT_SAT_STEP),
+      (uint8_t)(rgblight_get_val() / RGBLIGHT_VAL_STEP));
+  oled_write(led_buf, false);
+}
+#endif
diff --git a/keyboards/yampad/readme.md b/keyboards/yampad/readme.md
new file mode 100644
index 0000000000..e6cc03d60d
--- /dev/null
+++ b/keyboards/yampad/readme.md
@@ -0,0 +1,19 @@
+# Yampad
+
+![yampad](https://github.com/mattdibi/yampad/blob/master/img/yampad.jpg)
+
+The Yampad project is an open-source, QMK (Quantum Mechanical Keyboard Firmware) powered, hot-swappable, RGB-backlighted, OLED featured, mechanical numpad. This repository will be used to share information about the project and instruction on how to use and assemble the Yampad.
+
+* Keyboard Maintainer: [mattdibi](https://github.com/mattdibi)
+* Hardware Supported: Pro Micro, (ATmega32u4)
+* Hardware Availability: https://github.com/mattdibi/yampad
+
+Make example for this keyboard (after setting up your build environment):
+
+    make yampad:default
+
+Flashing example for this keyboard:
+
+    make yampad: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/yampad/rules.mk b/keyboards/yampad/rules.mk
new file mode 100644
index 0000000000..db0a8b5da5
--- /dev/null
+++ b/keyboards/yampad/rules.mk
@@ -0,0 +1,24 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = no        # 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 = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+OLED_DRIVER_ENABLE = yes
+DEBOUNCE_TYPE = eager_pk
diff --git a/keyboards/yampad/yampad.c b/keyboards/yampad/yampad.c
new file mode 100644
index 0000000000..764f48404d
--- /dev/null
+++ b/keyboards/yampad/yampad.c
@@ -0,0 +1,64 @@
+    
+/* Copyright 2019
+ *
+ * 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 "yampad.h"
+
+#if defined(OLED_DRIVER_ENABLE)
+__attribute__((weak))
+oled_rotation_t oled_init_user(oled_rotation_t rotation) {
+    return OLED_ROTATION_270;  // flips the display 270 degrees
+}
+
+__attribute__((weak)) 
+void oled_task_user(void) {
+  // Host Keyboard Layer Status
+  oled_write_P(PSTR("Layer"), false);
+  switch (get_highest_layer(layer_state)) {
+    case 0:
+      oled_write_ln_P(PSTR(" BAS"), false);
+      break;
+    case 1:
+      oled_write_ln_P(PSTR(" NAV"), false);
+      break;
+    case 2:
+      oled_write_ln_P(PSTR(" RGB"), false);
+      break;
+    default:
+      // Or use the write_ln shortcut over adding '\n' to the end of your string
+      oled_write_ln_P(PSTR(" UND"), false);
+  }
+
+  // Host Keyboard LED Status
+  led_t led_state = host_keyboard_led_state();
+  oled_write_P(PSTR("-----"), false);
+  oled_write_P(PSTR("Stats"), false);
+  oled_write_P(led_state.num_lock ? PSTR("num:*") : PSTR("num:."), false);
+  oled_write_P(led_state.caps_lock ? PSTR("cap:*") : PSTR("cap:."), false);
+  oled_write_P(led_state.scroll_lock ? PSTR("scr:*") : PSTR("scr:."), false);
+
+  // Host Keyboard RGB backlight status
+  oled_write_P(PSTR("-----"), false);
+  oled_write_P(PSTR("Light"), false);
+
+  static char led_buf[30];
+  snprintf(led_buf, sizeof(led_buf) - 1, "RGB:%cM: %2d\nh: %2ds: %2dv: %2d\n",
+      rgblight_is_enabled() ? '*' : '.', (uint8_t)rgblight_get_mode(),
+      (uint8_t)(rgblight_get_hue() / RGBLIGHT_HUE_STEP),
+      (uint8_t)(rgblight_get_sat() / RGBLIGHT_SAT_STEP),
+      (uint8_t)(rgblight_get_val() / RGBLIGHT_VAL_STEP));
+  oled_write(led_buf, false);
+}
+#endif
diff --git a/keyboards/yampad/yampad.h b/keyboards/yampad/yampad.h
new file mode 100644
index 0000000000..68ec98ffdd
--- /dev/null
+++ b/keyboards/yampad/yampad.h
@@ -0,0 +1,57 @@
+
+/* Copyright 2019
+ *
+ * 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 ___ KC_NO
+
+/* 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.
+ */
+
+/* COSPAD numpad matrix layout
+   * ,-------------------.
+   * | 00 | 01 | 02 | 03 |
+   * |----|----|----|----|
+   * | 10 | 11 | 12 |    |
+   * |----|----|----| 13 |
+   * | 20 | 21 | 22 |    |
+   * |----|----|----|----|
+   * | 30 | 31 | 32 |    |
+   * |----|----|----| 43 |
+   * | 40 | 41 | 42 |    |
+   * `-------------------'
+ */
+#define LAYOUT( \
+	k00, k01, k02, k03,  \
+	k10, k11, k12,       \
+	k20, k21, k22, k13,  \
+	k30, k31, k32,       \
+	k40, k41, k42, k43   \
+) \
+{ \
+	{k00, k01, k02, k03}, \
+	{k10, k11, k12, k13}, \
+	{k20, k21, k22, ___}, \
+	{k30, k31, k32, ___}, \
+	{k40, k41, k42, k43}  \
+}