keyboards/planck/keymaps/circuit/keymap.c

   1 // Layout picture at http://www.keyboard-layout-editor.com/#/gists/125febfad6960add078e6f14256539b6
   2
   3 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
   4 #include "planck.h"
   5 #include "action_layer.h"
   6 #ifdef AUDIO_ENABLE
   7 #include "audio.h"
   8 #endif
   9 #include "eeconfig.h"
  10
  11 extern keymap_config_t keymap_config;
  12
  13 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  14 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  15 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  16 // entirely and just use numbers.
  17 #define _QWERTY 0
  18 #define _DVORAK 1
  19 #define _LOCKED 2
  20 #define _NUMBER 3
  21 #define _ACTION 4
  22 #define _FUNCTN 5
  23
  24 enum planck_keycodes {
  25     QWERTY = SAFE_RANGE,
  26     DVORAK,
  27     NUMBER,
  28     ACTION
  29 };
  30
  31 // Key code names
  32 #define SFT_ENT FUNC(0) // Tap for enter, hold for right shift
  33 #define LOCK    FUNC(1)
  34 #define KC_PSTE KC_PASTE
  35 #define _______ KC_TRNS
  36 #define XXXXXXX KC_NO
  37
  38 #ifdef TAP_DANCE_ENABLE
  39 #define SFT_CAP TD(0)   // Left shift, double tap for caps
  40 #endif
  41 #ifndef TAP_DANCE_ENABLE
  42 #define SFT_CAP KC_LSFT // Regular left shift
  43 #endif
  44
  45 // Tap Dance Definitions
  46 #ifdef TAP_DANCE_ENABLE
  47 qk_tap_dance_action_t tap_dance_actions[] = {
  48     [0]  = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS)
  49 };
  50 #endif
  51
  52 // Function definitions
  53 const uint16_t PROGMEM fn_actions[] = {
  54     [0] = ACTION_MODS_TAP_KEY(MOD_RSFT, KC_ENT),
  55     [1] = ACTION_LAYER_TOGGLE(_LOCKED)
  56 };
  57
  58 // Layout definitions
  59 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  60
  61 /* QWERTY
  62  * ,-----------------------------------------------------------------------------------.
  63  * | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | BKSP |
  64  * |------+------+------+------+------+------+------+------+------+------+------+------|
  65  * | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |   '  |
  66  * |------+------+------+------+------+------+------+------+------+------+------+------|
  67  * |*Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |  Up  |SftEnt|
  68  * |------+------+------+------+------+-------------+------+------+------+------+------|
  69  * | Ctrl | Alt  | Cmd  | Vol- | ACTN |    Space    | NUMS | Vol+ | Left | Down | Left |
  70  * `-----------------------------------------------------------------------------------'
  71  */
  72 [_QWERTY] = {
  73     {KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  74     {KC_TAB,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  75     {SFT_CAP, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_UP,   SFT_ENT},
  76     {KC_LCTL, KC_LALT, KC_LGUI, KC_VOLD, ACTION,  KC_SPC,  KC_SPC,  NUMBER,  KC_VOLU, KC_LEFT, KC_DOWN, KC_RGHT}
  77 },
  78
  79 /* DVORAK
  80  * ,-----------------------------------------------------------------------------------.
  81  * |      |   '  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  |      |
  82  * |------+------+------+------+------+------+------+------+------+------+------+------|
  83  * |      |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |   Z  |
  84  * |------+------+------+------+------+------+------+------+------+------+------+------|
  85  * |      |   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |      |      |
  86  * |------+------+------+------+------+-------------+------+------+------+------+------|
  87  * |      |      |      |      |      |             |      |      |      |      |      |
  88  * `-----------------------------------------------------------------------------------'
  89  */
  90 [_DVORAK] = {
  91     {_______, KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    _______},
  92     {_______, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_Z   },
  93     {_______, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    _______, _______},
  94     {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
  95 },
  96
  97 /* LOCK
  98  * ,-----------------------------------------------------------------------------------.
  99  * |      |      |      |      |      |      |      |      |      |      |      |      |
 100  * |------+------+------+------+------+------+------+------+------+------+------+------|
 101  * |      |      |      |      |      |      |      |      |      |      |      |      |
 102  * |------+------+------+------+------+------+------+------+------+------+------+------|
 103  * | Shift|      |      |      |      |      |      |      |      |      |      |      |
 104  * |------+------+------+------+------+-------------+------+------+------+------+------|
 105  * |      |      | NULL |      |      |             |      |      |      |      |      |
 106  * `-----------------------------------------------------------------------------------'
 107  */
 108 [_LOCKED] = {
 109     {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 110     {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 111     {KC_LSFT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 112     {_______, _______, XXXXXXX, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 113 },
 114
 115 /* NUMBERS
 116  * ,-----------------------------------------------------------------------------------.
 117  * |      |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |      |
 118  * |------+------+------+------+------+------+------+------+------+------+------+------|
 119  * |      |   ~  | NULL | NULL | NULL |   |  |   _  |   +  |   {  |   }  |   ?  |   /  |
 120  * |------+------+------+------+------+------+------+------+------+------+------+------|
 121  * |      |   `  | NULL | NULL | NULL |   \  |   -  |   =  |   [  |   ]  |      |      |
 122  * |------+------+------+------+------+-------------+------+------+------+------+------|
 123  * |      |      |      |      |      |     NULL    |      |      |      |      |      |
 124  * `-----------------------------------------------------------------------------------'
 125  */
 126 [_NUMBER] = {
 127     {_______, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______},
 128     {_______, KC_TILD, XXXXXXX, XXXXXXX, XXXXXXX, KC_PIPE, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_QUES, KC_SLSH},
 129     {_______, KC_GRV,  XXXXXXX, XXXXXXX, XXXXXXX, KC_BSLS, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, _______, _______},
 130     {_______, _______, _______, _______, _______, XXXXXXX, XXXXXXX, _______, _______, _______, _______, _______}
 131 },
 132
 133 /* ACTIONS
 134  * ,-----------------------------------------------------------------------------------.
 135  * |      |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |  Del |
 136  * |------+------+------+------+------+------+------+------+------+------+------+------|
 137  * |      | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL |
 138  * |------+------+------+------+------+------+------+------+------+------+------+------|
 139  * | CAPS | Undo |  Cut | Copy | Paste| NULL | NULL | NULL | NULL | NULL | PgUp | Enter|
 140  * |------+------+------+------+------+-------------+------+------+------+------+------|
 141  * |      |      |      | Mute |      |     NULL    |      | NULL | Home | PgDn |  End |
 142  * `-----------------------------------------------------------------------------------'
 143  */
 144 [_ACTION] = {
 145     {_______, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL },
 146     {_______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
 147     {KC_CAPS, KC_UNDO, KC_CUT,  KC_COPY, KC_PSTE, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PGUP, KC_ENT },
 148     {_______, _______, _______, KC_MUTE, _______, XXXXXXX, XXXXXXX, _______, XXXXXXX, KC_HOME, KC_PGDN, KC_END }
 149 },
 150
 151 /* FUNCTIONS
 152  * ,-----------------------------------------------------------------------------------.
 153  * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
 154  * |------+------+------+------+------+------+------+------+------+------+------+------|
 155  * |  F13 |  F14 |  F15 |  F16 |  F17 |  F18 |  F19 |  F20 |  F21 |  F22 |  F23 |  F24 |
 156  * |------+------+------+------+------+------+------+------+------+------+------+------|
 157  * | NULL | NULL | NULL | NULL | NULL |QWERTY|DVORAK| NULL | NULL | NULL | NULL | NULL |
 158  * |------+------+------+------+------+-------------+------+------+------+------+------|
 159  * | Reset| NULL | Lock | NULL |      |     NULL    |      | NULL | NULL | NULL | NULL |
 160  * `-----------------------------------------------------------------------------------'
 161  */
 162 [_FUNCTN] = {
 163     {KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12 },
 164     {KC_F13,  KC_F14,  KC_F15,  KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20,  KC_F21,  KC_F22,  KC_F23,  KC_F24 },
 165     {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, QWERTY,  DVORAK,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
 166     {RESET,   XXXXXXX, LOCK,    XXXXXXX, _______, XXXXXXX, XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX}
 167 }
 168
 169 };
 170
 171 #ifdef AUDIO_ENABLE
 172 float tone_startup[][2] = SONG(STARTUP_SOUND);
 173 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
 174 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
 175 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
 176 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 177 #endif
 178
 179
 180 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 181     switch (keycode) {
 182         case QWERTY:
 183             if (record->event.pressed) {
 184                 if (IS_LAYER_ON(_DVORAK)) {
 185 #ifdef AUDIO_ENABLE
 186                     PLAY_SONG(tone_qwerty);
 187 #endif
 188                     layer_off(_DVORAK);
 189                 }
 190             }
 191             return false;
 192             break;
 193         case DVORAK:
 194             if (record->event.pressed) {
 195                 if (!IS_LAYER_ON(_DVORAK)) {
 196 #ifdef AUDIO_ENABLE
 197                     PLAY_SONG(tone_dvorak);
 198 #endif
 199                     layer_on(_DVORAK);
 200                 }
 201             }
 202             return false;
 203             break;
 204         case NUMBER:
 205             if (record->event.pressed) {
 206                 layer_on(_NUMBER);
 207                 update_tri_layer(_NUMBER, _ACTION, _FUNCTN);
 208             } else {
 209                 layer_off(_NUMBER);
 210                 update_tri_layer(_NUMBER, _ACTION, _FUNCTN);
 211             }
 212             return false;
 213             break;
 214         case ACTION:
 215             if (record->event.pressed) {
 216                 layer_on(_ACTION);
 217                 update_tri_layer(_NUMBER, _ACTION, _FUNCTN);
 218             } else {
 219                 layer_off(_ACTION);
 220                 update_tri_layer(_NUMBER, _ACTION, _FUNCTN);
 221             }
 222             return false;
 223             break;
 224     }
 225     return true;
 226 }
 227
 228 void matrix_init_user(void) {
 229 #ifdef AUDIO_ENABLE
 230     startup_user();
 231 #endif
 232 }
 233
 234 #ifdef AUDIO_ENABLE
 235
 236 void startup_user()
 237 {
 238     _delay_ms(20); // gets rid of tick
 239     PLAY_SONG(tone_startup);
 240 }
 241
 242 void shutdown_user()
 243 {
 244     PLAY_SONG(tone_goodbye);
 245     _delay_ms(150);
 246     stop_all_notes();
 247 }
 248
 249 void music_on_user(void)
 250 {
 251     music_scale_user();
 252 }
 253
 254 void music_scale_user(void)
 255 {
 256     PLAY_SONG(music_scale);
 257 }
 258
 259 #endif