Submitting ArrowPad, A QMK-based 21/24 key keypad (#372)

* Created arrow pad, a QMK based numpad designed for heavy text editing

* Enabled backlighting, numlock indicator, and forced nkro for arrowpad

* WIP Arrowpad 21

* WIP Arrowpad 21

* Combined Arrow Pad 21 and 24

* Combined Arrow Pad 21 and 24

* Removed 21 folder

3 files changed, 338 insertions, 0 deletions

diff --git a/keyboard/arrow_pad/keymaps/pad_24/config.h b/keyboard/arrow_pad/keymaps/pad_24/config.h
new file mode 100644
index 0000000000..75369c047f
--- /dev/null
+++ b/keyboard/arrow_pad/keymaps/pad_24/config.h
@@ -0,0 +1,158 @@
+/*
+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/>.
+*/
+
+#ifndef CONFIG_H
+#define CONFIG_H
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x4096
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Nobody
+#define PRODUCT         Arrow Pad 24
+#define DESCRIPTION     24-Key QMK Assistant
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#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 { F0, F1, F4, F5, F6, F7 }
+#define MATRIX_COL_PINS { B0, B1, B2, B3 }
+#define UNUSED_PINS
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION ROW2COL
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCING_DELAY 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+#define BACKLIGHT_LEVELS 3
+
+/* 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
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+#define FORCE_NKRO
+
+/*
+ * Magic Key Options
+ *
+ * Magic keys are hotkey commands that allow control over firmware functions of
+ * the keyboard. They are best used in combination with the HID Listen program,
+ * found here: https://www.pjrc.com/teensy/hid_listen.html
+ *
+ * The options below allow the magic key functionality to be changed. This is
+ * useful if your keyboard/keypad is missing keys and you want magic key support.
+ *
+ */
+
+/* key combination for magic key command */
+#define IS_COMMAND() ( \
+    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
+)
+
+/* control how magic key switches layers */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
+
+/* override magic key keymap */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
+//#define MAGIC_KEY_HELP1          H
+//#define MAGIC_KEY_HELP2          SLASH
+//#define MAGIC_KEY_DEBUG          D
+//#define MAGIC_KEY_DEBUG_MATRIX   X
+//#define MAGIC_KEY_DEBUG_KBD      K
+//#define MAGIC_KEY_DEBUG_MOUSE    M
+//#define MAGIC_KEY_VERSION        V
+//#define MAGIC_KEY_STATUS         S
+//#define MAGIC_KEY_CONSOLE        C
+//#define MAGIC_KEY_LAYER0_ALT1    ESC
+//#define MAGIC_KEY_LAYER0_ALT2    GRAVE
+//#define MAGIC_KEY_LAYER0         0
+//#define MAGIC_KEY_LAYER1         1
+//#define MAGIC_KEY_LAYER2         2
+//#define MAGIC_KEY_LAYER3         3
+//#define MAGIC_KEY_LAYER4         4
+//#define MAGIC_KEY_LAYER5         5
+//#define MAGIC_KEY_LAYER6         6
+//#define MAGIC_KEY_LAYER7         7
+//#define MAGIC_KEY_LAYER8         8
+//#define MAGIC_KEY_LAYER9         9
+//#define MAGIC_KEY_BOOTLOADER     PAUSE
+//#define MAGIC_KEY_LOCK           CAPS
+//#define MAGIC_KEY_EEPROM         E
+//#define MAGIC_KEY_NKRO           N
+//#define MAGIC_KEY_SLEEP_LED      Z
+
+/*
+ * 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
+
+#endif
diff --git a/keyboard/arrow_pad/keymaps/pad_24/keymap.c b/keyboard/arrow_pad/keymaps/pad_24/keymap.c
new file mode 100644
index 0000000000..5647f75afe
--- /dev/null
+++ b/keyboard/arrow_pad/keymaps/pad_24/keymap.c
@@ -0,0 +1,163 @@
+// This is the canonical layout file for the Quantum project. If you want to add another keyboard,
+// this is the style you want to emulate.
+
+#include "arrow_pad.h"
+#include "led.h"
+
+// This is the 21-key keypad to 2x11 element matrix mapping
+#define KEYMAP( \
+    KM_ESC, KM_TAB, KM_BSL, KM_ARR, \
+    KM_NUM, KM_FSL, KM_AST, KM_MIN, \
+    KM___7, KM___8, KM___9, KM_EQU, \
+    KM___4, KM___5, KM___6, KM_PLS, \
+    KM___1, KM___2, KM___3, ___ENT, \
+    KM___0, _____0, KM_DOT, KM_ENT  \
+) { \
+    { KM_ESC, KM_TAB, KM_BSL, KM_ARR  }, \
+    { KM_NUM, KM_FSL, KM_AST, KM_MIN  }, \
+    { KM___7, KM___8, KM___9, KM_EQU  }, \
+    { KM___4, KM___5, KM___6, KM_PLS  }, \
+    { KM___1, KM___2, KM___3, KC_NO   }, \
+    { KM___0, KC_NO,  KM_DOT, KM_ENT  }  \
+}
+
+#define LAYER_BASE                      0
+#define LAYER_EDIT                      1
+#define LAYER_FUNCTION                  2
+
+#define MACRO_COPY_CUT                  0
+#define MACRO_SHIFT_CONTROL             1
+#define MACRO_CONTROL_ALT               2
+
+#define M_COPY              KC_FN5
+#define M_SHFCT             KC_FN6
+#define M_CTALT             KC_FN7
+
+#define SC_UNDO             LCTL(KC_Z)
+#define SC_REDO             LCTL(KC_Y)
+#define SC_CUT              LCTL(KC_X)
+#define SC_COPY             LCTL(KC_C)
+#define SC_PSTE             LCTL(KC_V)
+#define SC_SELA             LCTL(KC_A)
+#define SC_SAVE             LCTL(KC_S)
+#define SC_OPEN             LCTL(KC_O)
+#define SC_ACLS             LALT(KC_F4)
+#define SC_CCLS             LCTL(KC_F4)
+
+#define _______             KC_TRNS
+#define XXXXXXX             KC_NO
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[LAYER_BASE] = KEYMAP(                \
+  KC_ESC,  KC_TAB,  KC_BSLS, KC_FN0,  \
+  KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS, \
+  KC_P7,   KC_P8,   KC_P9,   KC_PEQL, \
+  KC_P4,   KC_P5,   KC_P6,   KC_PPLS, \
+  KC_P1,   KC_P2,   KC_P3,   XXXXXXX, \
+  KC_P0,   KC_PCMM, KC_PDOT, KC_PENT  ),
+
+[LAYER_EDIT] = KEYMAP(                \
+  KC_ESC,  KC_TAB,  KC_SPC,  _______, \
+  KC_FN1,  SC_PSTE, SC_REDO, SC_UNDO, \
+  KC_HOME, KC_UP,   KC_PGUP, KC_LALT, \
+  KC_LEFT, M_COPY,  KC_RGHT, KC_LCTL, \
+  KC_END,  KC_DOWN, KC_PGDN, XXXXXXX, \
+  KC_BSPC, KC_PENT, KC_DEL,  M_SHFCT),
+
+[LAYER_FUNCTION] = KEYMAP(            \
+  KC_FN2,  KC_FN3,  KC_FN4,  _______, \
+  KC_FN1,  _______, _______, _______, \
+  _______, _______, _______, _______, \
+  _______, _______, _______, _______, \
+  _______, _______, _______, XXXXXXX, \
+  RESET,   _______, _______, _______  ),
+
+};
+
+
+const uint16_t PROGMEM fn_actions[] = {
+	[0] = ACTION_LAYER_MOMENTARY(LAYER_FUNCTION),
+	[1] = ACTION_LAYER_TOGGLE(LAYER_EDIT),
+	[2] = ACTION_BACKLIGHT_TOGGLE(),
+	[3] = ACTION_BACKLIGHT_INCREASE(),
+	[4] = ACTION_BACKLIGHT_DECREASE(),
+	[5] = ACTION_MACRO_TAP(MACRO_COPY_CUT),
+    [6] = ACTION_MACRO_TAP(MACRO_SHIFT_CONTROL),
+    [7] = ACTION_MACRO_TAP(MACRO_CONTROL_ALT),
+
+};
+
+
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+}
+
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+  // MACRODOWN only works in this function
+    switch (id) {
+
+    case MACRO_COPY_CUT:
+        if (record->event.pressed) {
+            register_code(KC_LCTL);
+            if (record->tap.count == 1) {
+                register_code(KC_C);
+                unregister_code(KC_C);
+            }
+            else if (record->tap.count == 2) {
+                register_code(KC_X);
+                unregister_code(KC_X);
+            }
+            unregister_code(KC_LCTL);
+        }
+        break;
+
+    case MACRO_SHIFT_CONTROL:
+        if (record->event.pressed) {
+            if (record->tap.count <= 2) register_mods(MOD_BIT(KC_LSFT));
+            if (record->tap.count == 2) register_mods(MOD_BIT(KC_LCTL));
+            if (record->tap.count == 3) register_code(KC_PENT);;
+        }
+        else {
+            unregister_mods(MOD_BIT(KC_LSFT) | MOD_BIT(KC_LCTL));
+            unregister_code(KC_PENT);
+        }
+        break;
+
+    case MACRO_CONTROL_ALT:
+        if (record->event.pressed) {
+            if (record->tap.count < 2)  register_mods(MOD_BIT(KC_LCTL));
+            if (record->tap.count >= 2) register_mods(MOD_BIT(KC_LALT));
+        }
+        else {
+            unregister_mods(MOD_BIT(KC_LCTL) | MOD_BIT(KC_LALT));
+        }
+        break;
+    }
+
+    return MACRO_NONE;
+}
+
+void led_set_user(uint8_t usb_led)
+{
+    if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
+        // output high
+        DDRD |= (1<<6);
+        PORTD |= (1<<6);
+    } else {
+        // Hi-Z
+        DDRD &= ~(1<<6);
+        PORTD &= ~(1<<6);
+    }
+    if (usb_led & (1<<USB_LED_NUM_LOCK)) {
+        // output low
+        DDRC |= (1<<7);
+        PORTC |= ~(1<<7);
+    } else {
+        // Hi-Z
+        DDRC &= ~(1<<7);
+        PORTC &= ~(1<<7);
+    }
+}
\ No newline at end of file
diff --git a/keyboard/arrow_pad/keymaps/pad_24/makefile.mk b/keyboard/arrow_pad/keymaps/pad_24/makefile.mk
new file mode 100644
index 0000000000..e31bfe1af2
--- /dev/null
+++ b/keyboard/arrow_pad/keymaps/pad_24/makefile.mk
@@ -0,0 +1,17 @@
+BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE  = no  # Mouse keys(+4700)
+EXTRAKEY_ENABLE  = no  # Audio control and System control(+450)
+CONSOLE_ENABLE   = no  # Console for debug(+400)
+COMMAND_ENABLE   = yes # Commands for debug and configuration
+NKRO_ENABLE      = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
+MIDI_ENABLE      = no  # MIDI controls
+AUDIO_ENABLE     = no  # Audio output on port C6
+UNICODE_ENABLE   = no  # Unicode
+BLUETOOTH_ENABLE = no  # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE  = no  # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
+
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no  # Breathing sleep LED during USB suspend
+
+CONFIG_H = keymaps/$(KEYMAP)/config.h
\ No newline at end of file