keyboard/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 _MUSIC 5
  23 #define _PLOVER 6
  24 #define _ADJUST 16
  25
  26 // Macro name shortcuts
  27 #define QWERTY M(_QWERTY)
  28 #define COLEMAK M(_COLEMAK)
  29 #define DVORAK M(_DVORAK)
  30 #define LOWER M(_LOWER)
  31 #define RAISE M(_RAISE)
  32 #define M_BL 5
  33 #define AUD_OFF M(6)
  34 #define AUD_ON M(7)
  35 #define MUS_OFF M(8)
  36 #define MUS_ON M(9)
  37 #define VC_IN M(10)
  38 #define VC_DE M(11)
  39 #define PLOVER M(12)
  40 #define EXT_PLV M(13)
  41 #define TOG_OUT M(14)
  42
  43 // Fillers to make layering more clear
  44 #define _______ KC_TRNS
  45 #define XXXXXXX KC_NO
  46
  47 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  48
  49 /* Qwerty
  50  * ,-----------------------------------------------------------------------------------.
  51  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  52  * |------+------+------+------+------+-------------+------+------+------+------+------|
  53  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  54  * |------+------+------+------+------+------|------+------+------+------+------+------|
  55  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  56  * |------+------+------+------+------+------+------+------+------+------+------+------|
  57  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  58  * `-----------------------------------------------------------------------------------'
  59  */
  60 [_QWERTY] = {
  61   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  62   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  63   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  64   {M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  65 },
  66
  67 /* Colemak
  68  * ,-----------------------------------------------------------------------------------.
  69  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  70  * |------+------+------+------+------+-------------+------+------+------+------+------|
  71  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  72  * |------+------+------+------+------+------|------+------+------+------+------+------|
  73  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  74  * |------+------+------+------+------+------+------+------+------+------+------+------|
  75  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  76  * `-----------------------------------------------------------------------------------'
  77  */
  78 [_COLEMAK] = {
  79   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  80   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  81   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  82   {M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  83 },
  84
  85 /* Dvorak
  86  * ,-----------------------------------------------------------------------------------.
  87  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  88  * |------+------+------+------+------+-------------+------+------+------+------+------|
  89  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  90  * |------+------+------+------+------+------|------+------+------+------+------+------|
  91  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  92  * |------+------+------+------+------+------+------+------+------+------+------+------|
  93  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  94  * `-----------------------------------------------------------------------------------'
  95  */
  96 [_DVORAK] = {
  97   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  98   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
  99   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
 100   {M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 101 },
 102
 103 /* Lower
 104  * ,-----------------------------------------------------------------------------------.
 105  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 106  * |------+------+------+------+------+-------------+------+------+------+------+------|
 107  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 108  * |------+------+------+------+------+------|------+------+------+------+------+------|
 109  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |      |      |      |      |Enter |
 110  * |------+------+------+------+------+------+------+------+------+------+------+------|
 111  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 112  * `-----------------------------------------------------------------------------------'
 113  */
 114 [_LOWER] = {
 115   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 116   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 117   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______},
 118   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 119 },
 120
 121 /* Raise
 122  * ,-----------------------------------------------------------------------------------.
 123  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 124  * |------+------+------+------+------+-------------+------+------+------+------+------|
 125  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 126  * |------+------+------+------+------+------|------+------+------+------+------+------|
 127  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |      |      |      |      |Enter |
 128  * |------+------+------+------+------+------+------+------+------+------+------+------|
 129  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 130  * `-----------------------------------------------------------------------------------'
 131  */
 132 [_RAISE] = {
 133   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 134   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 135   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______},
 136   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 137 },
 138
 139 /* Music (reserved for process_action_user)
 140  *
 141  */
 142 [_MUSIC] = {
 143   {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
 144   {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
 145   {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
 146   {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, LOWER,   XXXXXXX, XXXXXXX, RAISE,   XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX}
 147 },
 148
 149 /* Plover layer (http://opensteno.org)
 150  * ,-----------------------------------------------------------------------------------.
 151  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 152  * |------+------+------+------+------+-------------+------+------+------+------+------|
 153  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 154  * |------+------+------+------+------+------|------+------+------+------+------+------|
 155  * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 156  * |------+------+------+------+------+------+------+------+------+------+------+------|
 157  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 158  * `-----------------------------------------------------------------------------------'
 159  */
 160
 161 [_PLOVER] = {
 162   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 163   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 164   {TOG_OUT, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 165   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 166 },
 167
 168 /* Adjust (Lower + Raise)
 169  * ,-----------------------------------------------------------------------------------.
 170  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 171  * |------+------+------+------+------+-------------+------+------+------+------+------|
 172  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 173  * |------+------+------+------+------+------|------+------+------+------+------+------|
 174  * |      |Voice-|Voice+|Mus on|Musoff|      |      |      |      |      |      |      |
 175  * |------+------+------+------+------+------+------+------+------+------+------+------|
 176  * |      |      |      |      |      |             |      |      |      |      |      |
 177  * `-----------------------------------------------------------------------------------'
 178  */
 179 [_ADJUST] = {
 180   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 181   {_______, _______, _______, AUD_ON,  AUD_OFF, AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 182   {_______, VC_DE,   VC_IN,   MUS_ON,  MUS_OFF, _______, _______, _______, _______, _______, _______, _______},
 183   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 184 }
 185
 186
 187 };
 188
 189 const uint16_t PROGMEM fn_actions[] = {
 190
 191 };
 192
 193 #ifdef AUDIO_ENABLE
 194 float tone_startup[][2] = {
 195   {440.0*pow(2.0,(31)/12.0), 12},
 196   {440.0*pow(2.0,(28)/12.0), 8},
 197   {440.0*pow(2.0,(19)/12.0), 8},
 198   {440.0*pow(2.0,(24)/12.0), 8},
 199   {440.0*pow(2.0,(28)/12.0), 20}
 200 };
 201
 202 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 203 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 204 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 205 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 206 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 207
 208 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
 209 float goodbye[][2] = SONG(GOODBYE_SOUND);
 210 #endif
 211
 212
 213 void persistant_default_layer_set(uint16_t default_layer) {
 214   eeconfig_update_default_layer(default_layer);
 215   default_layer_set(default_layer);
 216 }
 217
 218 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 219 {
 220       switch(id) {
 221         case _QWERTY:
 222           if (record->event.pressed) {
 223             #ifdef AUDIO_ENABLE
 224               PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 225             #endif
 226             persistant_default_layer_set(1UL<<_QWERTY);
 227           }
 228           break;
 229         case _COLEMAK:
 230           if (record->event.pressed) {
 231             #ifdef AUDIO_ENABLE
 232               PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 233             #endif
 234             persistant_default_layer_set(1UL<<_COLEMAK);
 235           }
 236           break;
 237         case _DVORAK:
 238           if (record->event.pressed) {
 239             #ifdef AUDIO_ENABLE
 240               PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 241             #endif
 242             persistant_default_layer_set(1UL<<_DVORAK);
 243           }
 244           break;
 245         case _LOWER:
 246           if (record->event.pressed) {
 247             layer_on(_LOWER);
 248             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 249           } else {
 250             layer_off(_LOWER);
 251             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 252           }
 253           break;
 254         case _RAISE:
 255           if (record->event.pressed) {
 256             layer_on(_RAISE);
 257             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 258           } else {
 259             layer_off(_RAISE);
 260             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 261           }
 262           break;
 263         case M_BL:
 264           if (record->event.pressed) {
 265             register_code(KC_RSFT);
 266             #ifdef BACKLIGHT_ENABLE
 267               backlight_step();
 268             #endif
 269           } else {
 270             unregister_code(KC_RSFT);
 271           }
 272         break;
 273         case 6:
 274           if (record->event.pressed) {
 275             #ifdef AUDIO_ENABLE
 276               audio_off();
 277             #endif
 278           }
 279         break;
 280         case 7:
 281           if (record->event.pressed) {
 282             #ifdef AUDIO_ENABLE
 283               audio_on();
 284               PLAY_NOTE_ARRAY(tone_startup, false, 0);
 285             #endif
 286           }
 287         break;
 288         case 8:
 289           if (record->event.pressed) {
 290             #ifdef AUDIO_ENABLE
 291               layer_off(_MUSIC);
 292               stop_all_notes();
 293             #endif
 294           }
 295         break;
 296         case 9:
 297           if (record->event.pressed) {
 298             #ifdef AUDIO_ENABLE
 299               PLAY_NOTE_ARRAY(music_scale, false, 0);
 300               layer_on(_MUSIC);
 301             #endif
 302           }
 303         break;
 304         case 10:
 305           if (record->event.pressed) {
 306             #ifdef AUDIO_ENABLE
 307               voice_iterate();
 308               PLAY_NOTE_ARRAY(music_scale, false, 0);
 309             #endif
 310           }
 311         break;
 312         case 11:
 313           if (record->event.pressed) {
 314             #ifdef AUDIO_ENABLE
 315               voice_deiterate();
 316               PLAY_NOTE_ARRAY(music_scale, false, 0);
 317             #endif
 318           }
 319         break;
 320         case 12:
 321           if (record->event.pressed) {
 322             #ifdef AUDIO_ENABLE
 323               stop_all_notes();
 324               PLAY_NOTE_ARRAY(tone_plover, false, 0);
 325             #endif
 326             layer_off(_RAISE);
 327             layer_off(_LOWER);
 328             layer_off(_ADJUST);
 329             layer_off(_MUSIC);
 330             layer_on(_PLOVER);
 331             if (!eeconfig_is_enabled()) {
 332                 eeconfig_init();
 333             }
 334             keymap_config.raw = eeconfig_read_keymap();
 335             keymap_config.nkro = 1;
 336             eeconfig_update_keymap(keymap_config.raw);
 337           }
 338         break;
 339         case 13:
 340           if (record->event.pressed) {
 341             #ifdef AUDIO_ENABLE
 342               PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 343             #endif
 344             layer_off(_PLOVER);
 345           }
 346         break;
 347         case 14:
 348           if (record->event.pressed) {
 349             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 );
 350           }
 351         break;
 352       }
 353     return MACRO_NONE;
 354 };
 355
 356 void matrix_init_user(void) {
 357   #ifdef AUDIO_ENABLE
 358     _delay_ms(20); // stops the tick
 359     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 360   #endif
 361 }
 362
 363 #ifdef AUDIO_ENABLE
 364 void play_goodbye_tone()
 365 {
 366   PLAY_NOTE_ARRAY(goodbye, false, 0);
 367   _delay_ms(150);
 368 }
 369
 370 uint8_t starting_note = 0x0C;
 371 int offset = 0;
 372
 373 void process_action_user(keyrecord_t *record) {
 374
 375   if (IS_LAYER_ON(_MUSIC)) {
 376     if (record->event.pressed) {
 377         play_note(((double)220.0)*pow(2.0, -4.0)*pow(2.0,(starting_note + SCALE[record->event.key.col + offset])/12.0+(MATRIX_ROWS - record->event.key.row)), 0xF);
 378     } else {
 379         stop_note(((double)220.0)*pow(2.0, -4.0)*pow(2.0,(starting_note + SCALE[record->event.key.col + offset])/12.0+(MATRIX_ROWS - record->event.key.row)));
 380     }
 381   }
 382
 383 }
 384 #endif