keyboards/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
  10 #include "eeconfig.h"
  11
  12 extern keymap_config_t keymap_config;
  13
  14 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  15 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  16 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  17 // entirely and just use numbers.
  18 #define _QWERTY 0
  19 #define _COLEMAK 1
  20 #define _DVORAK 2
  21 #define _LOWER 3
  22 #define _RAISE 4
  23 #define _PLOVER 5
  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 PLOVER M(12)
  34 #define EXT_PLV M(13)
  35
  36 // Fillers to make layering more clear
  37 #define _______ KC_TRNS
  38 #define XXXXXXX KC_NO
  39
  40 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  41
  42 /* Qwerty
  43  * ,-----------------------------------------------------------------------------------.
  44  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  45  * |------+------+------+------+------+-------------+------+------+------+------+------|
  46  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  47  * |------+------+------+------+------+------|------+------+------+------+------+------|
  48  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  49  * |------+------+------+------+------+------+------+------+------+------+------+------|
  50  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  51  * `-----------------------------------------------------------------------------------'
  52  */
  53 [_QWERTY] = {
  54   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  55   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  56   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  57   {M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  58 },
  59
  60 /* Colemak
  61  * ,-----------------------------------------------------------------------------------.
  62  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  63  * |------+------+------+------+------+-------------+------+------+------+------+------|
  64  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  65  * |------+------+------+------+------+------|------+------+------+------+------+------|
  66  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  67  * |------+------+------+------+------+------+------+------+------+------+------+------|
  68  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  69  * `-----------------------------------------------------------------------------------'
  70  */
  71 [_COLEMAK] = {
  72   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  73   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  74   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  75   {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  76 },
  77
  78 /* Dvorak
  79  * ,-----------------------------------------------------------------------------------.
  80  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  81  * |------+------+------+------+------+-------------+------+------+------+------+------|
  82  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  83  * |------+------+------+------+------+------|------+------+------+------+------+------|
  84  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  85  * |------+------+------+------+------+------+------+------+------+------+------+------|
  86  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  87  * `-----------------------------------------------------------------------------------'
  88  */
  89 [_DVORAK] = {
  90   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  91   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
  92   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
  93   {M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  94 },
  95
  96 /* Lower
  97  * ,-----------------------------------------------------------------------------------.
  98  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
  99  * |------+------+------+------+------+-------------+------+------+------+------+------|
 100  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 101  * |------+------+------+------+------+------|------+------+------+------+------+------|
 102  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |Enter |
 103  * |------+------+------+------+------+------+------+------+------+------+------+------|
 104  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 105  * `-----------------------------------------------------------------------------------'
 106  */
 107 [_LOWER] = {
 108   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 109   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 110   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
 111   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 112 },
 113
 114 /* Raise
 115  * ,-----------------------------------------------------------------------------------.
 116  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 117  * |------+------+------+------+------+-------------+------+------+------+------+------|
 118  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 119  * |------+------+------+------+------+------|------+------+------+------+------+------|
 120  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |Enter |
 121  * |------+------+------+------+------+------+------+------+------+------+------+------|
 122  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 123  * `-----------------------------------------------------------------------------------'
 124  */
 125 [_RAISE] = {
 126   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 127   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 128   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUHS, _______, _______, _______},
 129   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 130 },
 131
 132 /* Plover layer (http://opensteno.org)
 133  * ,-----------------------------------------------------------------------------------.
 134  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 135  * |------+------+------+------+------+-------------+------+------+------+------+------|
 136  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 137  * |------+------+------+------+------+------|------+------+------+------+------+------|
 138  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 139  * |------+------+------+------+------+------+------+------+------+------+------+------|
 140  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 141  * `-----------------------------------------------------------------------------------'
 142  */
 143
 144 [_PLOVER] = {
 145   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 146   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 147   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 148   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 149 },
 150
 151 /* Adjust (Lower + Raise)
 152  * ,-----------------------------------------------------------------------------------.
 153  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 154  * |------+------+------+------+------+-------------+------+------+------+------+------|
 155  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 156  * |------+------+------+------+------+------|------+------+------+------+------+------|
 157  * |      |Voice-|Voice+|Mus on|Musoff|      |      |      |      |      |      |      |
 158  * |------+------+------+------+------+------+------+------+------+------+------+------|
 159  * |      |      |      |      |      |             |      |      |      |      |      |
 160  * `-----------------------------------------------------------------------------------'
 161  */
 162 [_ADJUST] = {
 163   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 164   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 165   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 166   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 167 }
 168
 169
 170 };
 171
 172 const uint16_t PROGMEM fn_actions[] = {
 173
 174 };
 175
 176 #ifdef AUDIO_ENABLE
 177
 178 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 179 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 180 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 181 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 182 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 183 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 184 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 185
 186 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 187 #endif
 188
 189
 190
 191 void persistant_default_layer_set(uint16_t default_layer) {
 192   eeconfig_update_default_layer(default_layer);
 193   default_layer_set(default_layer);
 194 }
 195
 196 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 197 {
 198       switch(id) {
 199         case _QWERTY:
 200           if (record->event.pressed) {
 201             #ifdef AUDIO_ENABLE
 202               PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 203             #endif
 204             persistant_default_layer_set(1UL<<_QWERTY);
 205           }
 206           break;
 207         case _COLEMAK:
 208           if (record->event.pressed) {
 209             #ifdef AUDIO_ENABLE
 210               PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 211             #endif
 212             persistant_default_layer_set(1UL<<_COLEMAK);
 213           }
 214           break;
 215         case _DVORAK:
 216           if (record->event.pressed) {
 217             #ifdef AUDIO_ENABLE
 218               PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 219             #endif
 220             persistant_default_layer_set(1UL<<_DVORAK);
 221           }
 222           break;
 223         case _LOWER:
 224           if (record->event.pressed) {
 225             layer_on(_LOWER);
 226             #ifdef BACKLIGHT_ENABLE
 227                 breathing_speed_set(2);
 228                 breathing_pulse();
 229             #endif
 230             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 231           } else {
 232             layer_off(_LOWER);
 233             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 234           }
 235           break;
 236         case _RAISE:
 237           if (record->event.pressed) {
 238             layer_on(_RAISE);
 239             #ifdef BACKLIGHT_ENABLE
 240                 breathing_speed_set(2);
 241                 breathing_pulse();
 242             #endif
 243             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 244           } else {
 245             layer_off(_RAISE);
 246             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 247           }
 248           break;
 249         case M_BL:
 250           if (record->event.pressed) {
 251             register_code(KC_RSFT);
 252             #ifdef BACKLIGHT_ENABLE
 253               backlight_step();
 254             #endif
 255           } else {
 256             unregister_code(KC_RSFT);
 257           }
 258         break;
 259         case 12:
 260           if (record->event.pressed) {
 261             #ifdef AUDIO_ENABLE
 262               stop_all_notes();
 263               PLAY_NOTE_ARRAY(tone_plover, false, 0);
 264             #endif
 265             layer_off(_RAISE);
 266             layer_off(_LOWER);
 267             layer_off(_ADJUST);
 268             layer_on(_PLOVER);
 269             if (!eeconfig_is_enabled()) {
 270                 eeconfig_init();
 271             }
 272             keymap_config.raw = eeconfig_read_keymap();
 273             keymap_config.nkro = 1;
 274             eeconfig_update_keymap(keymap_config.raw);
 275           }
 276         break;
 277         case 13:
 278           if (record->event.pressed) {
 279             #ifdef AUDIO_ENABLE
 280               PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 281             #endif
 282             layer_off(_PLOVER);
 283           }
 284         break;
 285
 286       }
 287     return MACRO_NONE;
 288 };
 289
 290 void matrix_init_user(void) {
 291   #ifdef AUDIO_ENABLE
 292         startup_user();
 293   #endif
 294 }
 295
 296 #ifdef AUDIO_ENABLE
 297 void startup_user()
 298 {
 299     _delay_ms(20); // gets rid of tick
 300     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 301 }
 302
 303 void shutdown_user()
 304 {
 305     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 306     _delay_ms(150);
 307     stop_all_notes();
 308 }
 309
 310 void music_on_user(void)
 311 {
 312     music_scale_user();
 313 }
 314
 315 void music_scale_user(void)
 316 {
 317     PLAY_NOTE_ARRAY(music_scale, false, 0);
 318 }
 319
 320 #endif
 321
 322 LEADER_EXTERNS();
 323
 324 void matrix_scan_user(void) {
 325   LEADER_DICTIONARY() {
 326     leading = false;
 327     leader_end();
 328
 329     SEQ_ONE_KEY (KC_V) {
 330       SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
 331     }
 332     SEQ_ONE_KEY(KC_F) {
 333       SEND_STRING("if yes\n\tpeanut butter\nelse\n\trice snacks");
 334     }
 335     SEQ_TWO_KEYS(KC_A, KC_S) {
 336       register_code(KC_H);
 337       unregister_code(KC_H);
 338     }
 339     SEQ_THREE_KEYS(KC_A, KC_S, KC_D) {
 340       register_code(KC_LGUI);
 341       register_code(KC_S);
 342       unregister_code(KC_S);
 343       unregister_code(KC_LGUI);
 344     }
 345   }
 346 }