Sidekick/qmk firmware (#9229)

* 5/28/20

* Create readme 2.md

* Revert inadvertently changed files

* Update keyboards/clawsome/sidekick/config.h

Co-authored-by: Nick Brassel <nick@tzarc.org>

* Update keyboards/clawsome/sidekick/rules.mk

Co-authored-by: Nick Brassel <nick@tzarc.org>

* Update keyboards/clawsome/sidekick/config.h

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/clawsome/sidekick/info.json

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/clawsome/sidekick/info.json

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/clawsome/sidekick/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/clawsome/sidekick/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/clawsome/sidekick/rules.mk

Co-authored-by: Nick Brassel <nick@tzarc.org>

Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Ryan <fauxpark@gmail.com>

keyboards/clawsome/sidekick/config.h

@@ -0,0 +1,37 @@
+/*
+Copyright 2020 AAClawson (AlisGraveNil)
+
+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      0xDB9F
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    AlisGraveNil
+#define PRODUCT         Sidekick
+#define DESCRIPTION     A 27-key QMK-powered macropad
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 7
+
+#define MATRIX_ROW_PINS { D0, C6, B2, B6, B5 }
+#define MATRIX_COL_PINS { F6, F5, B1, B3, E6, D7, D4 }
+
+#define DIODE_DIRECTION COL2ROW

keyboards/clawsome/sidekick/info.json

@@ -0,0 +1,40 @@
+{
+    "keyboard_name": "Sidekick",
+    "url": "",
+    "maintainer": "qmk",
+    "width": 7,
+    "height": 5,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"label":"K00 (D0,F6)", "x":0, "y":0},
+                {"label":"K01 (D0,F5)", "x":1, "y":0},
+                {"label":"K02 (D0,B1)", "x":2, "y":0},
+                {"label":"K03 (D0,B3)", "x":3, "y":0},
+                {"label":"K04 (D0,E6)", "x":4, "y":0},
+                {"label":"K05 (D0,D7)", "x":5, "y":0},
+                {"label":"K06 (D0,D4)", "x":6, "y":0},
+                {"label":"K10 (C6,F6)", "x":0, "y":1},
+                {"label":"K11 (C6,F5)", "x":1, "y":1},
+                {"label":"K12 (C6,B1)", "x":2, "y":1},
+                {"label":"K13 (C6,B3)", "x":3, "y":1},
+                {"label":"K14 (C6,E6)", "x":4, "y":1},
+                {"label":"K15 (C6,D7)", "x":5, "y":1},
+                {"label":"K16 (C6,D4)", "x":6, "y":1, "h":2},
+                {"label":"K23 (B2,B3)", "x":3, "y":2},
+                {"label":"K24 (B2,E6)", "x":4, "y":2},
+                {"label":"K25 (B2,D7)", "x":5, "y":2},
+                {"label":"K31 (B6,F5)", "x":1, "y":3},
+                {"label":"K33 (B6,B3)", "x":3, "y":3},
+                {"label":"K34 (B6,E6)", "x":4, "y":3},
+                {"label":"K35 (B6,D7)", "x":5, "y":3},
+                {"label":"K36 (B6,D4)", "x":6, "y":3, "h":2},
+                {"label":"K40 (B5,F6)", "x":0, "y":4},
+                {"label":"K41 (B5,F5)", "x":1, "y":4},
+                {"label":"K42 (B5,B1)", "x":2, "y":4},
+                {"label":"K43 (B5,B3)", "x":3, "y":4, "w":2},
+                {"label":"K45 (B5,D7)", "x":5, "y":4}
+            ]
+        }
+    }
+}

keyboards/clawsome/sidekick/keymaps/default/keymap.c

@@ -0,0 +1,41 @@
+/* Copyright 2020 AAClawson (AlisGraveNil)
+ *
+ * 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] = {
+   /*
+    * ------------------------------------
+    * |INS |HOME|PGUP|NUM | /  | *  | -  |
+    * ------------------------------------
+    * |DEL |END |PGDN| 7  | 8  | 9  | +  |
+    * ------------------------------|    |
+    * |    |    |    | 4  | 5  | 6  |    |
+    * ------------------------------------
+    * |    | UP |    | 1  | 2  | 3  |ENT |
+    * ------------------------------|    |
+    * |LEFT|DOWN|RGHT| 0       | .  |    |
+    * ------------------------------------
+    */
+    [0] = LAYOUT(
+        KC_INS,  KC_HOME, KC_PGUP, KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS,
+        KC_DEL,  KC_END,  KC_PGDN, KC_P7,   KC_P8,   KC_P9,   KC_PPLS,
+                                   KC_P4,   KC_P5,   KC_P6,
+                 KC_UP,            KC_P1,   KC_P2,   KC_P3,   KC_PENT,
+        KC_LEFT, KC_DOWN, KC_RGHT, KC_P0,            KC_PDOT
+    ),
+
+};
+

keyboards/clawsome/sidekick/readme.md

@@ -0,0 +1,14 @@
+# Sidekick
+
+This is a 5x7 macropad designed to be used with any 60% or less board.
+You still need those arrow keys and that num-pad, so here it is, in a conveniently move-able package!
+
+- Keyboard Maintainer: [AAClawson](https://github.com/AlisGraveNil)
+- Hardware Supported: Sidekick 2.0a & 2.0b, Pro Micro, Elite-C
+- Hardware Availability: Not available yet; will be sold at a later date
+
+Make example for this keyboard (after setting up your build environment):
+
+    make clawsome/sidekick: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/clawsome/sidekick/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 = 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 = no         # Enable keyboard RGB underglow
+MIDI_ENABLE = no             # MIDI support
+UNICODE_ENABLE = no          # Unicode
+BLUETOOTH_ENABLE = no        # Enable Bluetooth with the Adafruit EZ-Key HID
+AUDIO_ENABLE = no            # Audio output on port C6
+FAUXCLICKY_ENABLE = no       # Use buzzer to emulate clicky switches

keyboards/clawsome/sidekick/sidekick.c

@@ -0,0 +1,16 @@
+/* Copyright 2020 AAClawson (AlisGraveNil)
+ *
+ * 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 "sidekick.h"

keyboards/clawsome/sidekick/sidekick.h

@@ -0,0 +1,33 @@
+/* Copyright 2020 AAClawson (AlisGraveNil)
+ *
+ * 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 LAYOUT( \
+    K00, K01, K02, K03, K04, K05, K06,   \
+    K10, K11, K12, K13, K14, K15, K16,   \
+                   K23, K24, K25,        \
+         K31,      K33, K34, K35, K36,   \
+    K40, K41, K42, K43,      K45         \
+) { \
+    { K00,   K01,   K02,   K03,   K04,   K05,   K06   }, \
+    { K10,   K11,   K12,   K13,   K14,   K15,   K16   }, \
+    { KC_NO, KC_NO, KC_NO, K23,   K24,   K25,   KC_NO }, \
+    { KC_NO, K31,   KC_NO, K33,   K34,   K35,   K36   }, \
+    { K40,   K41,   K42,   K43,   KC_NO, K45,   KC_NO }, \
+}
+