[Keymap] New Planck 2x2U keymap (#5519)

* Initial keymapping

* Removed unneccessary config files

* Update readme.md

* Updated symbol locations, tap dance on parentheses for brackets.

* Update readme.md

* Fixed layout image inconsistencies

* More quality shift key layer control, swapped enter + shift enter

* Keyap tweaks and config cleanup

* Almost compiling, still has layout reference issues.

* Finally compiling. 2x2u layout (default, not mine) had nonexistent keys on it

* Super minor changes

* Ctrl+Bksp after first tap

* Changed bind so un/lock is explicit to work with remote un/locking

* Added keyboard passwords please don't hate me

* Changed backspace functionality and added em dash

* Changed to send_string because it's preferred for macros

* Minor fixes

* Removed global redefinition and fixed possible issue between 6KRO and NKRO

* Cleanup

* Layer names, password layer is OSL over toggle

* Hopefully now in QMK preferred format.

* Blank passwords.c

I realized with me excluding this it wouldn't compile - so adding a blank one.

* Fixed OSLs not cancelling after tapping term

* Matrix change.

KC_NO instead of repeating.

* Unneeded line.

Co-Authored-By: IsaacElenbaas <34344969+IsaacElenbaas@users.noreply.github.com>

* Fixed return statements to work with after-press functions

* External image host

* Removed image from github

* Removed unneccessary rules.mk lines and fixed tabbing

* Typos

* Fixes upon part arrival.

* Final changes and bug fixes

* Preventing KC_NO from waking monitors.

* Fix to rest of matrices

In response to https://github.com/evillemez/qmk_firmware/issues/1—the rest have the same problem.
The switch of k37 for k36 is just for consistency between that and the 2x2u.

* Workaround for #6214, minor changes, CRLF change in passwords because it won't leave my modified no matter what I do.

keyboards/planck/keymaps/dvorak2space/config.h

@@ -0,0 +1,3 @@
+#pragma once
+#define TAPPING_TOGGLE 1
+#define PERMISSIVE_HOLD

keyboards/planck/keymaps/dvorak2space/keymap.c

@@ -0,0 +1,242 @@
+#include QMK_KEYBOARD_H
+#include "passwords.c" //Instead of extern just to cut down on compile time. Holds a single array.
+#define MOUSEL KC_BTN1
+#define MOUSER KC_BTN2
+#define CTRLL LCTL(KC_LEFT)
+#define CTRLR LCTL(KC_RGHT)
+#define CAD LCTL(LALT(KC_DEL))
+
+#define BASE_L  0
+#define SHFT_L  1
+#define MOD_L   2
+#define NAV_L   3
+#define AHK_L   4
+#define LOCK_L  5
+#define PASS_L  6
+
+static host_driver_t *host_driver = 0;
+
+enum {
+  HK_SLP = SAFE_RANGE,
+  HK_IF,
+  HK_ELSE,
+  HK_COSL
+};
+
+enum {
+  FB = 0,
+  LPN,
+  RPN,
+  BCK,
+  DSH
+};
+
+enum {
+  SINGLE_TAP = 1,
+  SINGLE_HOLD = 2,
+  DOUBLE_TAP = 3,
+  DOUBLE_HOLD = 4,
+  DOUBLE_SINGLE_TAP = 5, //Distinguishes between double tapping and typing, "tapping", for example. Not sure how accurate it is, and I have no need, so avoiding it at the moment.
+  TRIPLE_TAP = 6,
+  TRIPLE_HOLD = 7
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+/* Base
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   '  |   ,  |   .  |   p  |   y  |   f  |   g  |   c  |   r  |   l  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Nav  |   a  |   o  |   e  |   u  |   i  |   d  |   h  |   t  |   n  |   s  | Enter|
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shft |   ;  |   q  |   j  |   k  |   x  |   b  |   m  |   w  |   v  |   z  | Shft |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Esc  | RClk | LClk | Ctrl |    Space    |   Modifier  |  GUI | VolD | VolU |Macros|
+ * `-----------------------------------------------------------------------------------'
+ */
+  [0] = LAYOUT_planck_2x2u(
+    KC_TAB,  KC_QUOT,KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    TD(BCK),
+    MO(NAV_L),KC_A,  KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_ENT,
+    KC_LSFT, KC_SCLN,KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_RSFT,
+    KC_ESC,  MOUSER, MOUSEL,  KC_LCTL,          KC_SPC,  MO(MOD_L),        KC_LGUI, KC_VOLD, KC_VOLU, OSL(AHK_L)
+  ),
+/* Custom Shifts
+ * ,-----------------------------------------------------------------------------------.
+ * |      |      |   ?  |   !  |      |      |      |      |      |      |      |      |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      |      |      |      |      |      |      |      |      |      |      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |      |      |      |      |      |      |      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |             |             |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+  [1] = LAYOUT_planck_2x2u(
+    KC_TRNS,KC_TRNS,KC_SLSH,KC_1,   KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
+    KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
+    KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
+    KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,        KC_TRNS,KC_NO,          KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS
+  ),
+/* Modifier
+ * ,-----------------------------------------------------------------------------------.
+ * |  Tab |   +  |   -  |   *  |  / \ |  if  | else |  ( [ |  ) ] |   {  |   }  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |   =  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Enter|
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |   `  |   <  |   >  |   &  |   |  |   _  |   $  |   @  |   #  |   %  |   ^  |   ~  |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |    Space    |             |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+  [2] = LAYOUT_planck_2x2u(
+    KC_TRNS,KC_PLUS,TD(DSH),KC_ASTR,TD(FB), HK_IF,  HK_ELSE,TD(LPN),TD(RPN),KC_LCBR,KC_RCBR,KC_TRNS,
+    KC_EQL, KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,   KC_TRNS,
+    KC_GRV, KC_LT,  KC_GT,  KC_AMPR,KC_PIPE,KC_UNDS,KC_DLR, KC_AT,  KC_HASH,KC_PERC,KC_CIRC,LSFT(KC_GRV),
+    KC_NO,  KC_NO,  KC_NO,  KC_NO,          KC_SPC, KC_TRNS,        KC_NO,  KC_NO,  KC_NO,  KC_NO
+  ),
+//Nav
+  [3] = LAYOUT_planck_2x2u(
+    KC_TRNS,KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_HOME,KC_UP,  KC_END,  KC_NO,  KC_TRNS,
+    KC_TRNS,KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  CTRLL,  KC_LEFT,KC_DOWN,KC_RGHT, CTRLR,  KC_TRNS,
+    KC_LSFT,KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,   KC_NO,  KC_NO,
+    KC_NO,  KC_NO,  KC_NO,  KC_NO,          KC_SPC, KC_NO,          KC_NO,  KC_NO,   KC_NO,  KC_NO
+  ),
+//AHK-Bindable Macros
+  [4] = LAYOUT_planck_2x2u(
+    KC_F13,      KC_F14,      KC_F15,      KC_F16,      KC_F17,      KC_F18,      KC_F19,      KC_F20,      KC_F21,      KC_F22,      KC_F23,      KC_F24,
+    LCTL(KC_F13),LCTL(KC_F14),LCTL(KC_F15),LCTL(KC_F16),LCTL(KC_F17),LCTL(KC_F18),LCTL(KC_F19),LCTL(KC_F20),LCTL(KC_F21),LCTL(KC_F22),LCTL(KC_F23),LCTL(KC_F24),
+    LSFT(KC_F13),LSFT(KC_F14),LSFT(KC_F15),LSFT(KC_F16),LSFT(KC_F17),LSFT(KC_F18),LSFT(KC_F19),LSFT(KC_F20),LSFT(KC_F21),LSFT(KC_F22),LSFT(KC_F23),LSFT(KC_F24),
+    RESET,       LALT(KC_F14),LALT(KC_F15),OSL(PASS_L),              CAD,         LALT(KC_F19),             LALT(KC_F21),LALT(KC_F22),HK_SLP,      HK_COSL
+  ),
+//Locked Screen
+  [5] = LAYOUT_planck_2x2u(
+    KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,
+    KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,
+    KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,
+    KC_NO,  KC_NO,  KC_NO,  KC_NO,          KC_NO,  KC_NO,          KC_NO,  KC_NO,  HK_SLP, KC_NO
+  ),
+//Passwords (by first letter of service name, at least better than just one)
+  [6] = LAYOUT_planck_2x2u(
+    KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_NO,
+    KC_NO,  KC_A,   KC_O,   KC_E,   KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_NO,
+    KC_NO,  KC_NO,  KC_Q,   KC_J,   KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_NO,
+    KC_NO,  KC_NO,  KC_NO,  HK_COSL,         KC_NO,   KC_NO,            KC_NO,   KC_NO,   KC_NO,   KC_NO
+  )
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) { //X_KEY doesn't support aliases
+  switch(keycode) {
+    //if shift pressed and not shift layer or released and other shift not pressed
+    //in separate things because MOD_BIT (probably?) isn't toggled until after this returns true and shift is actually toggled
+    case KC_LSFT: //if pressed and not shift layer or released and other shift not pressed
+      if((record->event.pressed && IS_LAYER_OFF(SHFT_L)) || (!record->event.pressed && !(get_mods() & MOD_BIT(KC_RSFT)))) { layer_invert(SHFT_L); }
+      break;
+    case KC_RSFT:
+      if((record->event.pressed && IS_LAYER_OFF(SHFT_L)) || (!record->event.pressed && !(get_mods() & MOD_BIT(KC_LSFT)))) { layer_invert(SHFT_L); }
+      break;
+    case KC_ENT: //won't repeat on hold and I can't find a solution other than hardcoding timers but I kinda prefer it anyway. Swaps enter and shift enter
+      if(record->event.pressed) {
+        (IS_LAYER_ON(SHFT_L)) //if shifted release correct shift, send, and press same shift, else send shift enter
+          ? (get_mods() & MOD_BIT(KC_LSFT))
+            ? SEND_STRING(SS_UP(X_LSHIFT) SS_TAP(X_ENTER) SS_DOWN(X_LSHIFT))
+            : SEND_STRING(SS_UP(X_RSHIFT) SS_TAP(X_ENTER) SS_DOWN(X_RSHIFT))
+          : SEND_STRING(SS_LSFT(SS_TAP(X_ENTER)));
+      }
+      return false;
+    case HK_IF:
+      if(record->event.pressed) { SEND_STRING("if"); }
+      break;
+    case HK_ELSE:
+      if(record->event.pressed) { SEND_STRING("else"); }
+      break;
+    case HK_COSL:
+      clear_keyboard();
+      break;
+    case HK_SLP:
+      if(record->event.pressed) {
+        if(IS_LAYER_OFF(LOCK_L)) {
+          host_driver = host_get_driver();
+          SEND_STRING(SS_LALT(SS_TAP(X_F23)));
+          host_set_driver(0);
+        }
+        else {
+          host_set_driver(host_driver);
+          SEND_STRING(SS_LALT(SS_TAP(X_F24)));
+        }
+        return false;
+      }
+      layer_invert(LOCK_L);
+      if(IS_LAYER_ON(AHK_L))
+        layer_invert(AHK_L);
+      break;
+    default:
+      if(IS_LAYER_ON(PASS_L) && keycode <= KC_Z) {
+        SEND_STRING(passwords[keycode - KC_A]);
+        layer_invert(PASS_L);
+        return false;
+      }
+  }
+  return true;
+};
+
+//tapdance state evaluation
+int cur_dance(qk_tap_dance_state_t *state) {
+  int press = 0;
+  switch(state->count) {
+    case 1:
+      press = (state->interrupted || !state->pressed)
+        ? SINGLE_TAP
+        : SINGLE_HOLD;
+      break;
+     case 2:
+      press = DOUBLE_TAP;
+      break;
+    case 3:
+      press = TRIPLE_TAP;
+  }
+  return press;
+}
+
+void back_tap(qk_tap_dance_state_t *state, void *user_data) { tap_code(KC_BSPACE); }
+
+void back_finished(qk_tap_dance_state_t *state, void *user_data) { if(!(state->interrupted || !state->pressed)) tap_code16(LCTL(KC_BSPACE)); }
+
+void slash_finished(qk_tap_dance_state_t *state, void *user_data) {
+  int td_state = cur_dance(state);
+  switch(td_state) {
+    case SINGLE_TAP:
+      clear_mods();
+      clear_weak_mods();
+      tap_code(KC_SLSH);
+      break;
+    case DOUBLE_TAP:
+      tap_code(KC_NUBS);
+  }
+}
+
+void dash_finished(qk_tap_dance_state_t *state, void *user_data) {
+  int td_state = cur_dance(state);
+  switch(td_state) {
+    case SINGLE_TAP:
+      tap_code(KC_PMNS);
+      break;
+    case SINGLE_HOLD:
+      register_mods(MOD_BIT(KC_LALT));
+      tap_code(KC_KP_0);
+      tap_code(KC_KP_1);
+      tap_code(KC_KP_5);
+      tap_code(KC_KP_1);
+      unregister_mods(MOD_BIT(KC_LALT));
+      break;
+    case DOUBLE_TAP:
+      tap_code(KC_PMNS);
+      tap_code(KC_PMNS);
+  }
+}
+
+qk_tap_dance_action_t tap_dance_actions[] = {
+  [LPN] = ACTION_TAP_DANCE_DOUBLE(KC_LPRN, KC_LBRC),
+  [RPN] = ACTION_TAP_DANCE_DOUBLE(KC_RPRN, KC_RBRC),
+  [FB]  = ACTION_TAP_DANCE_FN_ADVANCED(NULL, slash_finished, NULL),
+  [BCK] = ACTION_TAP_DANCE_FN_ADVANCED(back_tap, back_finished, NULL), //each tap, on finished, and reset. Normally register_code on press unregister on reset so keys can be held down.
+  [DSH] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, dash_finished, NULL)
+};

keyboards/planck/keymaps/dvorak2space/passwords.c

@@ -0,0 +1,28 @@
+char *passwords[26] = {
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  "",
+  ""
+};

keyboards/planck/keymaps/dvorak2space/readme.md

@@ -0,0 +1,5 @@
+![Keyboard Layout](https://i.imgur.com/9jYjllM.png)
+
+# IsaacElenbaas's Planck Layout
+
+Split spacebar, Dvorak. Bottom right button leads to layer with lots of things to be mapped in AutoHotkey. The ones I use (of which the best are sleep, which turns off the monitors and locks all inputs, rebinding keyboard-only mouse inputs, and redirecting media keys to a specific player) can be found [here.](https://github.com/IsaacElenbaas/personal_scripts/blob/master/Keyboard.ahk) Capslock goes to a right-hand navigation layer, there is a custom layer when holding shift, holding dash gives an em dash, holding backspace deletes a word, and I have a obfuscation-based password system you probably shouldn't use, but the rest is pretty standard.

keyboards/planck/keymaps/dvorak2space/rules.mk

@@ -0,0 +1,20 @@
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
+CONSOLE_ENABLE = no         # Console for debug(+400)
+COMMAND_ENABLE = no        # Commands for debug and configuration
+NKRO_ENABLE = no            # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work. Can make windows not recognize device.
+BACKLIGHT_ENABLE = no      # 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.
+API_SYSEX_ENABLE = no
+TAP_DANCE_ENABLE = yes
+
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
+
+LAYOUTS_HAS_RGB = no