[Keyboard] add Pandamic handwired (qmk#10227)

* Add pandemic keyboard

* Fix default keymap

* Add via keymap

* Fix via keymap

* Fix keymaps and pandamic.h

* add info.json

* update info.json

* Apply suggestions from code review

* Update keyboards/handwired/swiftrax/pandamic/info.json

* make suggested changes

keyboards/handwired/swiftrax/pandamic/config.h

@@ -0,0 +1,52 @@
+/*
+Copyright 2020 Swiftrax <[email protected]>
+
+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      0xEB0E
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Swiftrax
+#define PRODUCT         Pandamic
+
+/* key matrix size */
+#define MATRIX_ROWS 10
+#define MATRIX_COLS 10
+
+// ROWS: Top to bottom, COLS: Left to right
+
+#define MATRIX_ROW_PINS { D1, D2, B5, B7, D3, D5, D6, D4, D7, B4 }
+#define MATRIX_COL_PINS { B6, C6, C7, F7, F6, F5, F4, F1, F0, D0 }
+
+#define ENCODERS_PAD_A { E6 }
+#define ENCODERS_PAD_B { B0 }
+
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION ROW2COL
+
+/* define if matrix has ghost */
+//#define MATRIX_HAS_GHOST
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/*EEPROM for via*/
+#define DYNAMIC_KEYMAP_LAYER_COUNT 3

keyboards/handwired/swiftrax/pandamic/info.json

@@ -0,0 +1,12 @@
+{
+    "keyboard_name": "Pandamic",
+    "url": "https://github.com/swiftrax",
+    "maintainer": "swiftrax",
+    "width": 20.75, 
+    "height": 5.25, 
+    "layouts": {
+        "LAYOUT": {
+            "layout": [{"x":0, "y":0}, {"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":4.25, "y":0}, {"x":5.25, "y":0}, {"x":6.25, "y":0}, {"x":7.25, "y":0}, {"x":8.25, "y":0}, {"x":9.25, "y":0}, {"x":10.25, "y":0}, {"x":11.25, "y":0}, {"x":12.25, "y":0}, {"x":13.25, "y":0}, {"x":14.25, "y":0}, {"x":15.25, "y":0}, {"x":16.25, "y":0}, {"x":17.25, "y":0}, {"x":18.25, "y":0}, {"x":19.75, "y":0}, {"x":0, "y":1}, {"x":1, "y":1}, {"x":2, "y":1}, {"x":3, "y":1, "h":2}, {"x":4.25, "y":1, "w":1.5}, {"x":5.75, "y":1}, {"x":6.75, "y":1}, {"x":7.75, "y":1}, {"x":8.75, "y":1}, {"x":9.75, "y":1}, {"x":10.75, "y":1}, {"x":11.75, "y":1}, {"x":12.75, "y":1}, {"x":13.75, "y":1}, {"x":14.75, "y":1}, {"x":15.75, "y":1}, {"x":16.75, "y":1}, {"x":17.75, "y":1, "w":1.5}, {"x":19.75, "y":1}, {"x":0, "y":2}, {"x":1, "y":2}, {"x":2, "y":2}, {"x":4.25, "y":2, "w":1.75}, {"x":6, "y":2}, {"x":7, "y":2}, {"x":8, "y":2}, {"x":9, "y":2}, {"x":10, "y":2}, {"x":11, "y":2}, {"x":12, "y":2}, {"x":13, "y":2}, {"x":14, "y":2}, {"x":15, "y":2}, {"x":16, "y":2}, {"x":17, "y":2, "w":2.25}, {"x":19.75, "y":2}, {"x":0, "y":3}, {"x":1, "y":3}, {"x":2, "y":3}, {"x":3, "y":3, "h":2}, {"x":4.25, "y":3, "w":1.25}, {"x":5.5, "y":3}, {"x":6.5, "y":3}, {"x":7.5, "y":3}, {"x":8.5, "y":3}, {"x":9.5, "y":3}, {"x":10.5, "y":3}, {"x":11.5, "y":3}, {"x":12.5, "y":3}, {"x":13.5, "y":3}, {"x":14.5, "y":3}, {"x":15.5, "y":3}, {"x":16.5, "y":3, "w":1.75}, {"x":18.5, "y":3.25}, {"x":19.75, "y":3}, {"x":0, "y":4, "w":2}, {"x":2, "y":4}, {"x":4.25, "y":4, "w":1.25}, {"x":5.5, "y":4, "w":1.25}, {"x":6.75, "y":4, "w":1.25}, {"x":8, "y":4, "w":6.25}, {"x":14.25, "y":4}, {"x":15.25, "y":4}, {"x":16.25, "y":4}, {"x":17.5, "y":4.25}, {"x":18.5, "y":4.25}, {"x":19.5, "y":4.25}]
+        }
+    }
+}

keyboards/handwired/swiftrax/pandamic/keymaps/default/keymap.c

@@ -0,0 +1,49 @@
+/* Copyright 2020 swiftrax
+ *
+ * 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.
+// 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 _layer {
+  _MA,
+  _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[_MA] = LAYOUT(
+  KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS,   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_MUTE,
+  KC_P7,   KC_P8,   KC_P9,   KC_PPLS,   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_DEL,
+  KC_P4,   KC_P5,   KC_P6,              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_END,
+  KC_P1,   KC_P2,   KC_P3,   KC_PENT,   KC_LSFT, MO(_FN), KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,            KC_UP,         KC_HOME,
+  KC_P0,          KC_PDOT,              KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             MO(_FN), KC_RGUI, KC_RCTL,   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,  _______, _______,       _______,
+  _______, _______, _______, _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_PSCR,                _______,
+  _______, _______, _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                         _______,
+  _______, _______, _______, _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,             _______,    _______,
+  _______,          _______,            _______, _______, _______,                            _______,                            _______, _______, _______,    _______, _______, _______),  
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+  if (clockwise) {
+        tap_code(KC_VOLU);
+    } else {
+      tap_code(KC_VOLD);
+    }
+}

keyboards/handwired/swiftrax/pandamic/keymaps/via/keymap.c

@@ -0,0 +1,46 @@
+/* Copyright 2020 swiftrax
+ *
+ * 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
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[0] = LAYOUT(
+  KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS,   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_MUTE,
+  KC_P7,   KC_P8,   KC_P9,   KC_PPLS,   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_DEL,
+  KC_P4,   KC_P5,   KC_P6,              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_END,
+  KC_P1,   KC_P2,   KC_P3,   KC_PENT,   KC_LSFT, MO(1),   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,            KC_UP,         KC_HOME,
+  KC_P0,          KC_PDOT,              KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             MO(1),   KC_RGUI, KC_RCTL,   KC_LEFT, KC_DOWN, KC_RGHT ),  
+[1] = 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,  _______, _______,       _______,
+  _______, _______, _______, _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_PSCR,                _______,
+  _______, _______, _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                         _______,
+  _______, _______, _______, _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,             _______,    _______,
+  _______,          _______,            _______, _______, _______,                            _______,                            _______, _______, _______,    _______, _______, _______),  
+[2] = LAYOUT(
+  _______, _______, _______, _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______,
+  _______, _______, _______, _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                _______,
+  _______, _______, _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                         _______,
+  _______, _______, _______, _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,             _______,    _______,
+  _______,          _______,            _______, _______, _______,                            _______,                            _______, _______, _______,    _______, _______, _______),  
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+  if (clockwise) {
+        tap_code(KC_VOLU);
+    } else {
+      tap_code(KC_VOLD);
+    }
+}

keyboards/handwired/swiftrax/pandamic/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

keyboards/handwired/swiftrax/pandamic/pandamic.c

@@ -0,0 +1,16 @@
+/* Copyright 2020 swiftrax
+ *
+ * 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 "pandamic.h"

keyboards/handwired/swiftrax/pandamic/pandamic.h

@@ -0,0 +1,40 @@
+/* Copyright 2020 swiftrax
+ *
+ * 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"
+
+// readability
+#define XXX KC_NO
+
+#define LAYOUT( \
+    K000, K100, K001, K101,   K002, K102, K003, K103, K004, K104, K005, K105, K006, K106, K007, K107, K008, K108, K009,     K109,\
+    K200, K300, K201, K301,   K202, K302, K203, K303, K204, K304, K205, K305, K206, K306, K207, K307, K208, K308,           K309,\
+    K400, K500, K401,         K402, K502, K403, K503, K404, K504, K405, K505, K406, K506, K407, K507, K508,                 K509,\
+    K600, K700, K601, K701,   K602, K702, K603, K703, K604, K704, K605, K705, K606, K706, K607, K707, K608,         K609,   K709,\
+    K800,  K801,              K802, K902, K803,                   K805,                   K807, K907, K808,   K908, K809, K909   \
+) { \
+    {K000, K001, K002, K003, K004, K005, K006, K007, K008, K009},\
+    {K100, K101, K102, K103, K104, K105, K106, K107, K108, K109},\
+    {K200, K201, K202, K203, K204, K205, K206, K207, K208,  XXX},\
+    {K300, K301, K302, K303, K304, K305, K306, K307, K308, K309},\
+    {K400, K401, K402, K403, K404, K405, K406, K407,  XXX,  XXX},\
+    {K500,  XXX, K502, K503, K504, K505, K506, K507, K508, K509},\
+    {K600, K601, K602, K603, K604, K605, K606, K607, K608, K609},\
+    {K700, K701, K702, K703, K704, K705, K706, K707,  XXX, K709},\
+    {K800, K801, K802, K803,  XXX, K805,  XXX, K807, K808, K809},\
+    { XXX,  XXX, K902,  XXX,  XXX,  XXX,  XXX, K907, K908, K909} \
+}

keyboards/handwired/swiftrax/pandamic/readme.md

@@ -0,0 +1,13 @@
+# Pandamic
+
+A southpaw 65% mechanical keyboard with rotary encoder support
+
+* Keyboard Maintainer: [Swiftrax](https://github.com/swiftrax)
+* Hardware Supported: Pandamic
+* Hardware Availability: [GitHub.com](https://github.com/swiftrax/Pandamic)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make handwired/swiftrax/pandamic: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).

keyboards/handwired/swiftrax/pandamic/rules.mk

@@ -0,0 +1,23 @@
+# 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 = 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 = 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
+ENCODER_ENABLE = yes        # Rotary Encoder