keyboards/planck/keymaps/circuit/keymap.c

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