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