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