added tapdance locking

2 files changed, 66 insertions, 44 deletions

diff --git a/keyboards/ergodox/keymaps/familiar/Makefile b/keyboards/ergodox/keymaps/familiar/Makefile
new file mode 100644
index 0000000000..31e0fcf293
--- /dev/null
+++ b/keyboards/ergodox/keymaps/familiar/Makefile
@@ -0,0 +1 @@
+TAP_DANCE_ENABLE=yes
diff --git a/keyboards/ergodox/keymaps/familiar/keymap.c b/keyboards/ergodox/keymaps/familiar/keymap.c
index 714118d93e..fb326b3ddf 100644
--- a/keyboards/ergodox/keymaps/familiar/keymap.c
+++ b/keyboards/ergodox/keymaps/familiar/keymap.c
@@ -3,10 +3,13 @@
 #include "action_layer.h"
 #include "version.h"
 
+// Leader Key Timeout
+//#define LEADER_TIMEOUT 300
+
 // Layers
 #define BASE 0 // default layer
-#define INTL 1 // international symbols
-#define INSF 2 // international symbols shifted
+#define SYMB 1 // international symbols
+#define CSYM 2 // international symbols shifted
 #define NUMP 3 // numpad
 #define ARRW 4 // function, media, arrow keys
 
@@ -14,63 +17,81 @@
 #define _______ KC_TRNS
 #define XXXXXXX KC_NO
 
+// Tap Dancing
+void dance_lock (qk_tap_dance_state_t *state, void *user_data) {
+    if (state->count == 1) { // Press once for NUMLOCK
+        register_code (KC_NLCK);
+        unregister_code (KC_NLCK);
+    } else if (state->count == 2) { // Press twice for CAPSLOCK
+        register_code (KC_CAPS);
+        unregister_code (KC_CAPS);
+    } else if (state->count == 3) { //Press thrice for SCROLLLOCK
+        register_code (KC_SLCK);
+        unregister_code (KC_SLCK);
+    }
+}
+enum {LOCKS = 0};
+qk_tap_dance_action_t tap_dance_actions[] = {
+    [LOCKS] = ACTION_TAP_DANCE_FN(dance_lock)
+};
+
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
 // Otherwise, it needs KC_*
 /* layer 0 : default
  *
  * ,--------------------------------------------------.           ,--------------------------------------------------.
- * | ESC    |   1  |   2  |   3  |   4  |   5  |   6  |           |  7   |   8  |   9  |   0  |   -  |   =  | BCKSPC |
+ * | `      |   1  |   2  |   3  |   4  |   5  |   6  |           |  7   |   8  |   9  |   0  |   -  |   =  | BCKSPC |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  * | TAB    |   Q  |   W  |   E  |   R  |   T  | HOME |           | PGUP |   Y  |   U  |   I  |   O  |   P  | DELETE |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- * | `      |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |  ENTER |
+ * | '      |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |  ENTER |
  * |--------+------+------+------+------+------|  END |           | PGDN |------+------+------+------+------+--------|
  * | (/LSFT |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |  UP  | )/RSFT |
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
- * | LCTRL  | LGUI | MENU |   '  | LALT |                                       |[/RALT|   ]  | LEFT | DOWN |  RIGHT |
+ * | LCTRL  | LGUI | MENU | LEAD | LALT |                                       |[/RALT|]/RCTL| LEFT | DOWN |  RIGHT |
  * `------------------------------------'                                       `------------------------------------'
  *                                        ,-------------.       ,-------------.
- *                                        | VOL- | VOL+ |       |PRTSCR|      |
+ *                                        |PRTSCR| ESC  |       | VOL- | VOL+ |
  *                                 ,------|------|------|       |------+------+------.
- *                                 |      |SLASH/| MUTE |       |NUMLCK|WHACK/|      |
- *                                 | SPC  | MO(1)|------|       |------|MO(1) | SPC  |
- *                                 |      |      | LAY3 |       | LAY2 |      |      |
+ *                                 |      |SLASH/| LOCKS|       | MUTE |WHACK/|      |
+ *                                 |  SPC | MO(4)|------|       |------|MO(4) | SPC  |
+ *                                 |      |      | TO(3)|       |TO(1) |      |      |
  *                                 `--------------------'       `--------------------'
  */
 [BASE] = KEYMAP(
         // left hand
-        KC_ESC,     KC_1,       KC_2,       KC_3,       KC_4,       KC_5,       KC_6,
+        KC_GRV,     KC_1,       KC_2,       KC_3,       KC_4,       KC_5,       KC_6,
         KC_TAB,     KC_Q,       KC_W,       KC_E,       KC_R,       KC_T,       KC_HOME,
-        KC_GRV,     KC_A,       KC_S,       KC_D,       KC_F,       KC_G,
+        KC_QUOT,    KC_A,       KC_S,       KC_D,       KC_F,       KC_G,
         KC_LSPO,    KC_Z,       KC_X,       KC_C,       KC_V,       KC_B,       KC_END,
-        KC_LCTL,    KC_LGUI,    KC_MENU,    KC_QUOT,    KC_LALT,
-                                                                    KC_VOLD,    KC_VOLU,
-                                                                                KC_MUTE,
-                                                KC_SPC,     LT(ARRW, KC_SLSH),  TG(INTL),
+        KC_LCTL,    KC_LGUI,    KC_MENU,    KC_LEAD,    KC_LALT,
+                                                                    KC_PSCR,    KC_ESC,
+                                                                                TD(LOCKS),
+                                                KC_SPC,     LT(ARRW, KC_SLSH),  TG(SYMB),
         // right hand
             KC_7,       KC_8,       KC_9,       KC_0,       KC_MINS,    KC_EQL,     KC_BSPC,
             KC_PGUP,    KC_Y,       KC_U,       KC_I,       KC_O,       KC_P,       KC_DEL,
                         KC_H,       KC_J,       KC_K,       KC_L,       KC_SCLN,    KC_ENTER,
             KC_PGDN,    KC_N,       KC_M,       KC_COMM,    KC_DOT,     KC_UP,      KC_RSPC,
                         MT(MOD_RALT, KC_LBRC),  KC_RBRC,    KC_LEFT,    KC_DOWN,    KC_RGHT,
-            KC_PSCR,     _______,
-            KC_NLCK,
-            TG(NUMP),   LT(ARRW, C_BSLS),   KC_SPC
+            KC_VOLD,    KC_VOLU,
+            KC_MUTE,
+            TG(NUMP),   LT(ARRW, KC_BSLS),   KC_SPC
     ),
 
 /* layer 1: International symbols, etc
  *
  * ,--------------------------------------------------.           ,--------------------------------------------------.
- * |     ´  |   ¡  |   ²  |   ³  |   ¤  |   €  |   ¼  |           |  ½   |  ¾   |  ‘   |  ’   |  ¥   |  ×   |        |
+ * |     ¬  |   ¡  |   ²  |   ³  |   ¤  |   €  |   ¼  |           |  ½   |  ¾   |  ‘   |  ’   |  ¥   |  ×   |        |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  * |        |   ä  |   å  |   é  |   ®  |   þ  |      |           |      |  ü   |  ú   |  í   |  ó   |  ö   |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- * |        |   á  |   ß  |   ð  |      |      |------|           |------|      |      |      |  ø   |  ¶   |        |
+ * |     ´  |   á  |   ß  |   ð  |      |      |------|           |------|      |      |      |  ø   |  ¶   |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- * |MO(INSF)|   æ  |      |   ©  |      |      |      |           |      |  ñ   |  µ   |  ç   |      |      |MO(INSF)|
+ * |MO(CSYM)|   æ  |   ¿  |   ©  |      |      |      |           |      |  ñ   |  µ   |  ç   |      |      |MO(CSYM)|
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
- * |        |      |      |   ¬  |   ¿  |                                       |  «   |  »   |      |      |        |
+ * |        |      |      |      |      |                                       |  «   |  »   |      |      |        |
  * `------------------------------------'                                       `------------------------------------'
  *                                        ,-------------.       ,-------------.
  *                                        |      |      |       |      |      |
@@ -80,13 +101,13 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                                 |      |      |      |       |      |      |      |
  *                                 `--------------------'       `--------------------'
  */
-[INTL] = KEYMAP(
+[SYMB] = KEYMAP(
         // left hand
-        UC(0x00B4), UC(0x00A1), UC(0x00B2), UC(0x00B3), UC(0x00A4), UC(0x20AC), UC(0x00BC),
+        UC(0x00AC), UC(0x00A1), UC(0x00B2), UC(0x00B3), UC(0x00A4), UC(0x20AC), UC(0x00BC),
         _______,    UC(0x00E4), UC(0x00E5), UC(0x00E9), UC(0x00AE), UC(0x00FE), _______,
-        _______,    UC(0x00E1), UC(0x00DF), UC(0x00F0), _______,    _______,
-        MO(INSF),   UC(0x00E6), _______,    UC(0x00A9), _______,    _______,    _______,
-        _______,    _______,    _______,    UC(0x00AC), UC(0x00BF),
+        UC(0x00B4), UC(0x00E1), UC(0x00DF), UC(0x00F0), _______,    _______,
+        MO(CSYM),   UC(0x00E6), UC(0x00BF), UC(0x00A9), _______,    _______,    _______,
+        _______,    _______,    _______,    _______,    _______,
                                             _______,    _______,
                                                         _______,
                             _______,        _______,    _______,
@@ -94,7 +115,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
             UC(0x00BD), UC(0x00BE), UC(0x2018), UC(0x2019), UC(0x00A5), UC(0x00D7), _______,
             _______,    UC(0x00FC), UC(0x00FA), UC(0x00ED), UC(0x00F3), UC(0x00F6), _______,
                         _______,    _______,    _______,    UC(0x00F8), UC(0x00B6), _______,
-            _______,    UC(0x00F1), UC(0x00B5), UC(0x00E7), _______,    _______,    MO(INSF),
+            _______,    UC(0x00F1), UC(0x00B5), UC(0x00E7), _______,    _______,    MO(CSYM),
                                     UC(0x00AB), UC(0x00BB), _______,    _______,    _______,
             _______,    _______,
             _______,
@@ -106,11 +127,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  * which don't produce an "upper case" or "shifted" international symobol.
  *
  * ,--------------------------------------------------.           ,--------------------------------------------------.
- * |     ¨  |   ¹  |      |      |   £  |      |      |           |      |      |      |      |  —  |  ÷   |        |
+ * |        |   ¹  |      |      |   £  |      |      |           |      |      |      |      |  —  |  ÷   |        |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  * |        |   Ä  |   Å  |   É  |      |   Þ  |      |           |      |  Ü   |  Ú   |  Í   |  Ó   |  Ö   |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- * |        |   Á  |   §  |   Ð  |      |      |------|           |------|      |      |      |  Ø   |  °   |        |
+ * |     ¨  |   Á  |   §  |   Ð  |      |      |------|           |------|      |      |      |  Ø   |  °   |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  * |        |   Æ  |      |   ¢  |      |      |      |           |      |  Ñ   |      |  Ç   |      |      |        |
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
@@ -124,11 +145,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                                 |      |      |      |       |      |      |      |
  *                                 `--------------------'       `--------------------'
  */
-[INSF] = KEYMAP(
+[CSYM] = KEYMAP(
         // left hand
-        UC(0x00A8), UC(0x00B9), _______,    _______,    UC(0x00A3), _______,    _______,
-        _______,    UC(0x00C4), UC(0x00C5), UC(0x00C9), _______,    UC(0x00DE), _______,
-        _______,    UC(0x00C1), UC(0x00A7), UC(0x00D0), S(KC_F),    S(KC_G),
+        _______,    UC(0x00B9), _______,    _______,    UC(0x00A3), _______,    _______,
+        _______,    UC(0x00C4), UC(0x00C5), UC(0x00C9), S(KC_R),    UC(0x00DE), _______,
+        UC(0x00A8), UC(0x00C1), UC(0x00A7), UC(0x00D0), S(KC_F),    S(KC_G),
         _______,    UC(0x00C6), S(KC_X),    UC(0x00A2), S(KC_V),    S(KC_B),    _______,
         _______,    _______,    _______,    UC(0x00A6), _______,
                                                                     _______,    _______,
@@ -191,20 +212,20 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  * This layer is at the top so that the functions still work no matter what layers are active.
  *
  * ,--------------------------------------------------.           ,--------------------------------------------------.
- * | ESCAPE |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |           |  F7  |  F8  |  F9  | F10  | F11  | F12  | SYSREQ |
+ * | ESCAPE |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |           |  F7  |  F8  |  F9  | F10  | F11  | F12  |        |
  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  * |        |      |      |  UP  |      |      |      |           |      |      |      |      |      |      | INSERT |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- * |CAPSLOCK|      | LEFT | DOWN |RIGHT |      |------|           |------| LEFT | DOWN |  UP  | RIGHT|      |        |
+ * |        |      | LEFT | DOWN |RIGHT |      |------|           |------| LEFT | DOWN |  UP  | RIGHT|      |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  * |        |M_PREV|M_STOP|M_PLPS|M_NEXT|      |      |           |      |      |      |      |      | PGUP |        |
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  * |        |      |      |      |      |                                       |      |      | HOME | PGDN |    END |
  * `------------------------------------'                                       `------------------------------------'
  *                                        ,-------------.       ,-------------.
- *                                        |      | PAUSE|       |SYSREQ|      |
+ *                                        | PAUSE|SYSREQ|       |      |      |
  *                                 ,------|------|------|       |------+------+------.
- *                                 |      |      |      |       |SCRLK |      |      |
+ *                                 |      |      |      |       |      |      |      |
  *                                 |      |      |------|       |------|      |      |
  *                                 |      |      |      |       |      |      |      |
  *                                 `--------------------'       `--------------------'
@@ -213,10 +234,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
         // left hand
         KC_ESC,     KC_F1,      KC_F2,      KC_F3,      KC_F4,      KC_F5,      KC_F6,
         _______,    _______,    _______,    KC_UP,      _______,    _______,    _______,
-        KC_CAPS,    _______,    KC_LEFT,    KC_DOWN,    KC_RGHT,    _______,
+        _______,    _______,    KC_LEFT,    KC_DOWN,    KC_RGHT,    _______,
         _______,    _______,    _______,    _______,    _______,    _______,    _______,
         _______,    _______,    _______,    _______,    _______,
-                                                                    _______,    KC_PAUSE,
+                                                                    KC_PAUSE,   _______,
                                                                                 _______,
                                                     _______,        _______,    _______,
         // right hand
@@ -225,8 +246,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
                         KC_LEFT,    KC_DOWN,    KC_UP,      KC_RGHT,    _______,    _______,
             _______,    _______,    _______,    _______,    _______,    KC_PGUP,    _______,
                                     _______,    _______,    KC_HOME,    KC_PGDN,    KC_END,
-            KC_SYSREQ,  _______,
-            KC_SLCK,
+            _______,    _______,
+            _______,
             _______,    _______,    _______
     ),
 };
@@ -249,8 +270,8 @@ void matrix_scan_user(void) {
     ergodox_right_led_2_off();
     ergodox_right_led_3_off();
     switch (layer) {
-        case INTL:
-        case INSF:
+        case SYMB:
+        case CSYM:
             ergodox_right_led_1_on();
             break;
         case NUMP: