keyboards/planck/keymaps/default/keymap.c

   1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
   2 // this is the style you want to emulate.
   3
   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 _COLEMAK 1
  19 #define _DVORAK 2
  20 #define _LOWER 3
  21 #define _RAISE 4
  22 #define _PLOVER 5
  23 #define _ADJUST 16
  24
  25 enum planck_keycodes {
  26   QWERTY = SAFE_RANGE,
  27   COLEMAK,
  28   DVORAK,
  29   PLOVER,
  30   LOWER,
  31   RAISE,
  32   BACKLIT,
  33   EXT_PLV,
  34   TOG_OUT
  35 };
  36
  37 // Fillers to make layering more clear
  38 #define _______ KC_TRNS
  39 #define XXXXXXX KC_NO
  40
  41 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  42
  43 /* Qwerty
  44  * ,-----------------------------------------------------------------------------------.
  45  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  46  * |------+------+------+------+------+-------------+------+------+------+------+------|
  47  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  48  * |------+------+------+------+------+------|------+------+------+------+------+------|
  49  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  50  * |------+------+------+------+------+------+------+------+------+------+------+------|
  51  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  52  * `-----------------------------------------------------------------------------------'
  53  */
  54 [_QWERTY] = {
  55   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  56   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  57   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  58   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  59 },
  60
  61 /* Colemak
  62  * ,-----------------------------------------------------------------------------------.
  63  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  64  * |------+------+------+------+------+-------------+------+------+------+------+------|
  65  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  66  * |------+------+------+------+------+------|------+------+------+------+------+------|
  67  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  68  * |------+------+------+------+------+------+------+------+------+------+------+------|
  69  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  70  * `-----------------------------------------------------------------------------------'
  71  */
  72 [_COLEMAK] = {
  73   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  74   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  75   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  76   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  77 },
  78
  79 /* Dvorak
  80  * ,-----------------------------------------------------------------------------------.
  81  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  82  * |------+------+------+------+------+-------------+------+------+------+------+------|
  83  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  84  * |------+------+------+------+------+------|------+------+------+------+------+------|
  85  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  86  * |------+------+------+------+------+------+------+------+------+------+------+------|
  87  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  88  * `-----------------------------------------------------------------------------------'
  89  */
  90 [_DVORAK] = {
  91   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  92   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
  93   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
  94   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  95 },
  96
  97 /* Lower
  98  * ,-----------------------------------------------------------------------------------.
  99  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 100  * |------+------+------+------+------+-------------+------+------+------+------+------|
 101  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 102  * |------+------+------+------+------+------|------+------+------+------+------+------|
 103  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |Enter |
 104  * |------+------+------+------+------+------+------+------+------+------+------+------|
 105  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 106  * `-----------------------------------------------------------------------------------'
 107  */
 108 [_LOWER] = {
 109   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 110   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 111   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
 112   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 113 },
 114
 115 /* Raise
 116  * ,-----------------------------------------------------------------------------------.
 117  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 118  * |------+------+------+------+------+-------------+------+------+------+------+------|
 119  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 120  * |------+------+------+------+------+------|------+------+------+------+------+------|
 121  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |Enter |
 122  * |------+------+------+------+------+------+------+------+------+------+------+------|
 123  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 124  * `-----------------------------------------------------------------------------------'
 125  */
 126 [_RAISE] = {
 127   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 128   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 129   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, _______, _______, _______},
 130   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 131 },
 132
 133 /* Plover layer (http://opensteno.org)
 134  * ,-----------------------------------------------------------------------------------.
 135  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 136  * |------+------+------+------+------+-------------+------+------+------+------+------|
 137  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 138  * |------+------+------+------+------+------|------+------+------+------+------+------|
 139  * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 140  * |------+------+------+------+------+------+------+------+------+------+------+------|
 141  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 142  * `-----------------------------------------------------------------------------------'
 143  */
 144
 145 [_PLOVER] = {
 146   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 147   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 148   {TOG_OUT, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 149   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 150 },
 151
 152 /* Adjust (Lower + Raise)
 153  * ,-----------------------------------------------------------------------------------.
 154  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 155  * |------+------+------+------+------+-------------+------+------+------+------+------|
 156  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 157  * |------+------+------+------+------+------|------+------+------+------+------+------|
 158  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 159  * |------+------+------+------+------+------+------+------+------+------+------+------|
 160  * |      |      |      |      |      |             |      |      |      |      |      |
 161  * `-----------------------------------------------------------------------------------'
 162  */
 163 [_ADJUST] = {
 164   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 165   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 166   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 167   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 168 }
 169
 170
 171 };
 172
 173 #ifdef AUDIO_ENABLE
 174
 175 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 176 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 177 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 178 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 179 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 180 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 181 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 182
 183 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 184 #endif
 185
 186
 187 void persistant_default_layer_set(uint16_t default_layer) {
 188   eeconfig_update_default_layer(default_layer);
 189   default_layer_set(default_layer);
 190 }
 191
 192 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 193   switch (keycode) {
 194     case QWERTY:
 195       if (record->event.pressed) {
 196         #ifdef AUDIO_ENABLE
 197           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 198         #endif
 199         persistant_default_layer_set(1UL<<_QWERTY);
 200       }
 201       break;
 202     case COLEMAK:
 203       if (record->event.pressed) {
 204         #ifdef AUDIO_ENABLE
 205           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 206         #endif
 207         persistant_default_layer_set(1UL<<_COLEMAK);
 208       }
 209       break;
 210     case DVORAK:
 211       if (record->event.pressed) {
 212         #ifdef AUDIO_ENABLE
 213           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 214         #endif
 215         persistant_default_layer_set(1UL<<_DVORAK);
 216       }
 217       break;
 218     case LOWER:
 219       if (record->event.pressed) {
 220         layer_on(_LOWER);
 221         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 222       } else {
 223         layer_off(_LOWER);
 224         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 225       }
 226       break;
 227     case RAISE:
 228       if (record->event.pressed) {
 229         layer_on(_RAISE);
 230         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 231       } else {
 232         layer_off(_RAISE);
 233         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 234       }
 235       break;
 236     case BACKLIT:
 237       if (record->event.pressed) {
 238         register_code(KC_RSFT);
 239         #ifdef BACKLIGHT_ENABLE
 240           backlight_step();
 241         #endif
 242       } else {
 243         unregister_code(KC_RSFT);
 244       }
 245     break;
 246     case PLOVER:
 247       if (record->event.pressed) {
 248         #ifdef AUDIO_ENABLE
 249           stop_all_notes();
 250           PLAY_NOTE_ARRAY(tone_plover, false, 0);
 251         #endif
 252         layer_off(_RAISE);
 253         layer_off(_LOWER);
 254         layer_off(_ADJUST);
 255         layer_on(_PLOVER);
 256         if (!eeconfig_is_enabled()) {
 257             eeconfig_init();
 258         }
 259         keymap_config.raw = eeconfig_read_keymap();
 260         keymap_config.nkro = 1;
 261         eeconfig_update_keymap(keymap_config.raw);
 262       }
 263     break;
 264     case EXT_PLV:
 265       if (record->event.pressed) {
 266         #ifdef AUDIO_ENABLE
 267           PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 268         #endif
 269         layer_off(_PLOVER);
 270       }
 271     break;
 272     case TOG_OUT:
 273       if (record->event.pressed) {
 274         return MACRO( D(E), D(R), D(F), D(V), D(O), D(L), U(E), U(R), U(F), U(V), U(O), U(L), END );
 275       }
 276     break;
 277   }
 278   return true;
 279 }
 280
 281 void matrix_init_user(void) {
 282     #ifdef AUDIO_ENABLE
 283         startup_user();
 284     #endif
 285 }
 286
 287 #ifdef AUDIO_ENABLE
 288
 289 void startup_user()
 290 {
 291     _delay_ms(20); // gets rid of tick
 292     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 293 }
 294
 295 void shutdown_user()
 296 {
 297     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 298     _delay_ms(150);
 299     stop_all_notes();
 300 }
 301
 302 void music_on_user(void)
 303 {
 304     music_scale_user();
 305 }
 306
 307 void music_scale_user(void)
 308 {
 309     PLAY_NOTE_ARRAY(music_scale, false, 0);
 310 }
 311
 312 #endif