]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/planck/keymaps/callum/keymap.c
Adds support for Planck Rev 6 (#2666)
[qmk_firmware.git] / keyboards / planck / keymaps / callum / keymap.c
index 4d0151710ef0858498cef4926a54ff4b0fc02a56..2a816bf677c39571b6ed6c622e47cd8dca19acb8 100644 (file)
+#pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
 #include "planck.h"
 #include "action_layer.h"
-#ifdef AUDIO_ENABLE
-  #include "audio.h"
-#endif
-#include "eeconfig.h"
 
 extern keymap_config_t keymap_config;
 
-// 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.
-#define _BASE 0
-#define _MOVE 1
-#define _SYMB 2
-#define _MOUSE 3
-#define _FUNC 4
+#define G(X) LGUI(X)
+#define A(X) LALT(X)
+#define C(X) LCTL(X)
+#define AC(X) A(C(X))
+#define SC(X) S(C(X))
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
 
-enum planck_keycodes {
-  MOVE = SAFE_RANGE,
-  SYMB,
-  FUNC,
-  BELOW,
-  ABOVE
+enum planck_layers {
+    _COLEMAK,
+    _QWERTY,
+    _SYMB,
+    _MOVE,
+    _FUNC,
 };
 
-// Fillers to make layering more clear
-#define _______ KC_TRNS
-#define XXXXXXX KC_NO
+enum planck_keycodes {
+    COLEMAK = SAFE_RANGE,
+    QWERTY,
+    SYMB,
+    MOVE,
+    FUNC,
+};
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-/* BASE
- * ,-----------------------------------------------------------------------------------.
- * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  |  -   |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Bksp |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  | Shift|
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Func | Ctrl |  Alt |  Cmd | Symb | Enter| Space| Move |  Cmd |  Alt | Ctrl | Func |
- * `-----------------------------------------------------------------------------------'
- */
-[_BASE] = {
-  {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_MINS},
-  {KC_BSPC, KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
-  {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT},
-  {FUNC,    KC_LCTL, KC_LALT, KC_LGUI, SYMB,    KC_ENT,  KC_SPC,  MOVE,    KC_RGUI, KC_RALT, KC_RCTL, FUNC   }
-},
+    /* COLEMAK
+     * ,-----------------------------------------------------------------------.
+     * |Tab  |  Q  |  W  |  F  |  P  |  G  |  J  |  L  |  U  |  Y  |  ;  |  -  |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |Bksp |  A  |  R  |  S  |  T  |  D  |  H  |  N  |  E  |  I  |  O  |  '  |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |Shift|  Z  |  X  |  C  |  V  |  B  |  K  |  M  |  ,  |  .  |  /  |Shift|
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |Func |Ctrl | Alt |Super|Symb |Enter|Space|Move |Super| Alt |Ctrl |Func |
+     * `-----------------------------------------------------------------------'
+     */
+    [_COLEMAK] = {
+        {
+            KC_TAB,       KC_Q,         KC_W,         KC_F,
+            KC_P,         KC_G,         KC_J,         KC_L,
+            KC_U,         KC_Y,         KC_SCLN,      KC_MINS
+        },
+        {
+            KC_BSPC,      KC_A,         KC_R,         KC_S,
+            KC_T,         KC_D,         KC_H,         KC_N,
+            KC_E,         KC_I,         KC_O,         KC_QUOT
+        },
+        {
+            KC_LSFT,      KC_Z,         KC_X,         KC_C,
+            KC_V,         KC_B,         KC_K,         KC_M,
+            KC_COMM,      KC_DOT,       KC_SLSH,      KC_RSFT
+        },
+        {
+            FUNC,         KC_LCTL,      KC_LALT,      KC_LGUI,
+            SYMB,         KC_ENT,       KC_SPC,       MOVE,
+            KC_RGUI,      KC_RALT,      KC_RCTL,      FUNC
+        }
+    },
+
+    /* QWERTY
+     * ,-----------------------------------------------------------------------.
+     * |Tab  |  Q  |  W  |  E  |  R  |  T  |  Y  |  U  |  I  |  O  |  P  |  -  |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |Bksp |  A  |  S  |  D  |  F  |  G  |  H  |  J  |  K  |  L  |  ;  |  '  |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |Shift|  Z  |  X  |  C  |  V  |  B  |  N  |  M  |  ,  |  .  |  /  |Shift|
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |Func |Ctrl | Alt |Super|Symb |Enter|Space|Move |Super| Alt |Ctrl |Func |
+     * `-----------------------------------------------------------------------'
+     */
+    [_QWERTY] = {
+        {
+            KC_TAB,       KC_Q,         KC_W,         KC_E,
+            KC_R,         KC_T,         KC_Y,         KC_U,
+            KC_I,         KC_O,         KC_P,         KC_MINS
+        },
+        {
+            KC_BSPC,      KC_A,         KC_S,         KC_D,
+            KC_F,         KC_G,         KC_H,         KC_J,
+            KC_K,         KC_L,         KC_SCLN,      KC_QUOT
+        },
+        {
+            KC_LSFT,      KC_Z,         KC_X,         KC_C,
+            KC_V,         KC_B,         KC_N,         KC_M,
+            KC_COMM,      KC_DOT,       KC_SLSH,      KC_RSFT
+        },
+        {
+            FUNC,         KC_LCTL,      KC_LALT,      KC_LGUI,
+            SYMB,         KC_ENT,       KC_SPC,       MOVE,
+            KC_RGUI,      KC_RALT,      KC_RCTL,      FUNC
+        }
+    },
 
-/* MOVE
- * ,-----------------------------------------------------------------------------------.
- * |  Esc |      | Cmd-L|  Up  | Cmd-R|      |      | Cmd-L|  Up  | Cmd-R|      |  Esc |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |  Del | Caps | Left | Down | Right|      |      | Left | Down | Right| Caps |  Del |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |      |      | Pg Up| Pg Dn| Above|      | Pg Dn| Pg Up|      |      |      |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |      |      |      |      | Below|      |      |      |      |      |      |
- * `-----------------------------------------------------------------------------------'
- */
-[_MOVE] = {
-  {KC_ESC,  XXXXXXX, LGUI(KC_LEFT), KC_UP, LGUI(KC_RGHT), XXXXXXX, XXXXXXX, LGUI(KC_LEFT), KC_UP, LGUI(KC_RGHT), XXXXXXX, KC_ESC },
-  {KC_DEL,  KC_CAPS, KC_LEFT, KC_DOWN, KC_RGHT, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_RGHT, KC_CAPS, KC_DEL },
-  {_______, XXXXXXX, XXXXXXX, KC_PGUP, KC_PGDN,   ABOVE, XXXXXXX, KC_PGDN, KC_PGUP, XXXXXXX, XXXXXXX, _______},
-  {_______, _______, _______, _______, _______,   BELOW, _______, _______, _______, _______, _______, _______}
-},
+    /* SYMB
+     * ,-----------------------------------------------------------------------.
+     * | Esc |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |     |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * | Del |  !  |  @  |  #  |  $  |  %  |  ^  |  &  |  *  |  (  |  )  |     |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |     |  ~  |  `  |  +  |  =  |  |  |  \  |  [  |  ]  |  {  |  }  |     |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |     |     |     |     |     |     |     |     |     |     |     |     |
+     * `-----------------------------------------------------------------------'
+     */
+    [_SYMB] = {
+        {
+            KC_ESC,       KC_1,         KC_2,         KC_3,
+            KC_4,         KC_5,         KC_6,         KC_7,
+            KC_8,         KC_9,         KC_0,         _______
+        },
+        {
+            KC_DEL,       KC_EXLM,      KC_AT,        KC_HASH,
+            KC_DLR,       KC_PERC,      KC_CIRC,      KC_AMPR,
+            KC_ASTR,      KC_LPRN,      KC_RPRN,      _______
+        },
+        {
+            _______,      KC_TILD,      KC_GRV,       KC_PLUS,
+            KC_EQL,       KC_PIPE,      KC_BSLS,      KC_LBRC,
+            KC_RBRC,      KC_LCBR,      KC_RCBR,      _______
+        },
+        {
+            _______,      _______,      _______,      _______,
+            _______,      _______,      _______,      _______,
+            _______,      _______,      _______,      _______
+        }
+    },
 
-/* SYMB
- * ,-----------------------------------------------------------------------------------.
- * |  Esc |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |   –  |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |  Del |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |   £  |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |   ~  |   `  |   +  |   =  |   |  |   \  |   [  |   ]  |   {  |   }  |      |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |      |      |      |      |      |      |      |      |      |      |      |
- * `-----------------------------------------------------------------------------------'
- */
-[_SYMB] = {
-  {KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    LALT(KC_MINS)},
-  {KC_DEL,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, LALT(KC_3)},
-  {_______, KC_TILD, KC_GRV,  KC_PLUS, KC_EQL,  KC_PIPE, KC_BSLS, KC_LBRC, KC_RBRC, KC_LCBR, KC_RCBR, _______},
-  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
-},
+    /* MOVE
+     * ,-----------------------------------------------------------------------.
+     * |     |     |     |     |     |     |     |Home | Up  | End |     | Esc |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |     |     |     |     |     |     |     |Left |Down |Right|Caps | Del |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |     |     |     |     |     |     |     |PgDn |PgUp |TabL |TabR |     |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |     |     |     |     |     |     |     |     |     |     |     |     |
+     * `-----------------------------------------------------------------------'
+     */
+    [_MOVE] = {
+        {
+            AC(KC_A),     AC(KC_B),     AC(KC_C),     AC(KC_D),
+            AC(KC_E),     AC(KC_F),     XXXXXXX,      KC_HOME,
+            KC_UP,        KC_END,       XXXXXXX,      KC_ESC
+        },
+        {
+            AC(KC_G),     AC(KC_H),     AC(KC_I),     AC(KC_J),
+            AC(KC_K),     AC(KC_L),     XXXXXXX,      KC_LEFT,
+            KC_DOWN,      KC_RGHT,      KC_CAPS,      KC_DEL
+        },
+        {
+            _______,      AC(KC_M),     AC(KC_N),     AC(KC_O),
+            AC(KC_P),     AC(KC_Q),     XXXXXXX,      KC_PGDN,
+            KC_PGUP,      SC(KC_TAB),   C(KC_TAB),    _______
+        },
+        {
+            _______,      _______,      _______,      _______,
+            _______,      _______,      _______,      _______,
+            _______,      _______,      _______,      _______
+        }
+    },
 
-/* MOUSE
- * ,-----------------------------------------------------------------------------------.
- * |      |      | ACC-2| ACC-1| ACC-0|      |      | SW-L |  M-U | SW-R |      |      |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |      | MB-3 | MB-2 | MB-1 |      |      |  M-L |  M-D |  M-R |      |      |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |      |      |      |      |      |      | SW-D | SW-U |      |      |      |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |      |      |      |      |      |      |      |      |      |      |      |
- * `-----------------------------------------------------------------------------------'
- */
-[_MOUSE] = {
-  {XXXXXXX, XXXXXXX, KC_ACL2, KC_ACL1, KC_ACL0, XXXXXXX, XXXXXXX, KC_WH_L, KC_MS_U, KC_WH_R, XXXXXXX, XXXXXXX},
-  {XXXXXXX, XXXXXXX, KC_BTN3, KC_BTN2, KC_BTN1, XXXXXXX, XXXXXXX, KC_MS_L, KC_MS_D, KC_MS_R, XXXXXXX, XXXXXXX},
-  {_______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_WH_D, KC_WH_U, XXXXXXX, XXXXXXX, _______},
-  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
-},
+    /* FUNC
+     * ,-----------------------------------------------------------------------.
+     * |Reset| F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 |VolUp|
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |Power| F11 | F12 | F13 | F14 | F15 | F16 | F17 | F18 | F19 | F20 |VolDn|
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |     | F21 | F22 | F23 | F24 |     |     |     |     |Clmak|Qwrty|     |
+     * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+     * |     |     |     |     |Prev |Mute |Play |Next |     |     |     |     |
+     * `-----------------------------------------------------------------------'
+     */
+    [_FUNC] = {
+        {
+            RESET,        KC_F1,        KC_F2,        KC_F3,
+            KC_F4,        KC_F5,        KC_F6,        KC_F7,
+            KC_F8,        KC_F9,        KC_F10,       KC_VOLU
+        },
+        {
+            KC_POWER,     KC_F11,       KC_F12,       KC_F13,
+            KC_F14,       KC_F15,       KC_F16,       KC_F17,
+            KC_F18,       KC_F19,       KC_F20,       KC_VOLD
+        },
+        {
+            _______,      KC_F21,       KC_F22,       KC_F23,
+            KC_F24,       XXXXXXX,      XXXXXXX,      XXXXXXX,
+            XXXXXXX,      COLEMAK,      QWERTY,       _______
+        },
+        {
+            _______,      _______,      _______,      _______,
+            KC_MPRV,      KC_MUTE,      KC_MPLY,      KC_MNXT,
+            _______,      _______,      _______,      _______
+        }
+    }
+};
 
-/* FUNC
- * ,-----------------------------------------------------------------------------------.
- * | Reset|  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 | Vol+ |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |  F11 |  F12 |  F13 |  F14 |  F15 |  F16 |  F17 |  F18 |  F19 |  F20 | Vol- |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |  F21 |  F22 |  F23 |  F24 |      |      | Power|      |      |      |      |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * |      |      |      |      | Prev | Mute | Play | Next |      |      |      |      |
- * `-----------------------------------------------------------------------------------'
- */
-[_FUNC] = {
-  {RESET,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_VOLU},
-  {XXXXXXX, KC_F11,  KC_F12,  KC_F13,  KC_F14,  KC_F15,  KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20,  KC_VOLD},
-  {_______, KC_F21,  KC_F22,  KC_F23,  KC_F24,  XXXXXXX, XXXXXXX, KC_POWER, XXXXXXX, XXXXXXX, XXXXXXX, _______},
-  {_______, _______, _______, _______, KC_MPRV, KC_MUTE, KC_MPLY, KC_MNXT, _______, _______, _______, _______}
+#ifdef AUDIO_ENABLE
+float colemak_song[][2] = SONG(COLEMAK_SOUND);
+float qwerty_song[][2] = SONG(QWERTY_SOUND);
+#endif
+
+void set_colemak(void) {
+#ifdef AUDIO_ENABLE
+    stop_all_notes();
+    PLAY_SONG(colemak_song);
+#endif
+    set_single_persistent_default_layer(_COLEMAK);
 }
 
-};
+void set_qwerty(void) {
+#ifdef AUDIO_ENABLE
+    stop_all_notes();
+    PLAY_SONG(qwerty_song);
+#endif
+    set_single_persistent_default_layer(_QWERTY);
+}
 
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-  switch (keycode) {
-    case MOVE:
-      if (record->event.pressed) {
-        layer_on(_MOVE);
-        update_tri_layer(_MOVE, _SYMB, _MOUSE);
-      } else {
-        layer_off(_MOVE);
-        update_tri_layer(_MOVE, _SYMB, _MOUSE);
-      }
-      return false;
-      break;
-    case SYMB:
-      if (record->event.pressed) {
-        layer_on(_SYMB);
-        update_tri_layer(_MOVE, _SYMB, _MOUSE);
-      } else {
-        layer_off(_SYMB);
-        update_tri_layer(_MOVE, _SYMB, _MOUSE);
-      }
-      return false;
-      break;
-    case FUNC:
-      if (record->event.pressed) {
-        layer_on(_FUNC);
-      } else {
-        layer_off(_FUNC);
-      }
-      return false;
-      break;
-    case BELOW:
-      if (record->event.pressed) {
-        register_code(KC_LGUI);
-        register_code(KC_RGHT);
-        unregister_code(KC_RGHT);
-        unregister_code(KC_LGUI);
-        register_code(KC_ENT);
-        unregister_code(KC_ENT);
-      }
-      return false;
-      break;
-    case ABOVE:
-      if (record->event.pressed) {
-        register_code(KC_LGUI);
-        register_code(KC_LEFT);
-        unregister_code(KC_LEFT);
-        unregister_code(KC_LGUI);
-        register_code(KC_ENT);
-        unregister_code(KC_ENT);
-        register_code(KC_UP);
-        unregister_code(KC_UP);
-      }
-      return false;
-      break;
-  }
-  return true;
+    switch (keycode) {
+        case COLEMAK:
+            if (record->event.pressed) {
+                set_colemak();
+            }
+            return false;
+            break;
+        case QWERTY:
+            if (record->event.pressed) {
+                set_qwerty();
+            }
+            return false;
+            break;
+        case SYMB:
+            if (record->event.pressed) {
+                layer_on(_SYMB);
+            } else {
+                layer_off(_SYMB);
+            }
+            return false;
+            break;
+        case MOVE:
+            if (record->event.pressed) {
+                layer_on(_MOVE);
+            } else {
+                layer_off(_MOVE);
+            }
+            return false;
+            break;
+        case FUNC:
+            if (record->event.pressed) {
+                layer_on(_FUNC);
+            } else {
+                layer_off(_FUNC);
+            }
+            return false;
+            break;
+    }
+    return true;
 }