keyboards/planck/keymaps/that_canadian/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 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
   5 #include "planck.h"
   6 #include "action_layer.h"
   7 #ifdef AUDIO_ENABLE
   8   #include "audio.h"
   9 #endif
  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
  20 #define _LOWER 2
  21 #define _RAISE 3
  22
  23 #define _FUNCTION 15
  24 #define _ADJUST 16
  25
  26 enum planck_keycodes {
  27   QWERTY = SAFE_RANGE,
  28   LOWER,
  29   RAISE
  30 };
  31
  32 // Fillers to make layering more clear
  33 #define _______ KC_TRNS
  34 #define XXXXXXX KC_NO
  35
  36 // Defines for task manager and such
  37 #define CALTDEL LCTL(LALT(KC_DEL))
  38 #define TSKMGR LCTL(LSFT(KC_ESC))
  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  * | Func |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  | Enter|
  47  * |------+------+------+------+------+------|------+------+------+------+------+------|
  48  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |  '   |
  49  * |------+------+------+------+------+------+------+------+------+------+------+------|
  50  * | Ctrl |  `   | GUI  | Alt  |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   {MO(_FUNCTION), KC_A,   KC_S,    KC_D,    KC_F,  KC_G,   KC_H,   KC_J,  KC_K,    KC_L,    KC_SCLN, KC_ENT},
  56   {OSM(MOD_LSFT), KC_Z,   KC_X,    KC_C,    KC_V,  KC_B,   KC_N,   KC_M,  KC_COMM, KC_DOT,  KC_SLSH, KC_QUOT},
  57   {KC_LCTL,       KC_GRV, KC_LGUI, KC_LALT, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  58 },
  59
  60 /* Lower
  61  * ,-----------------------------------------------------------------------------------.
  62  * | Esc  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
  63  * |------+------+------+------+------+-------------+------+------+------+------+------|
  64  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |Enter |
  65  * |------+------+------+------+------+------|------+------+------+------+------+------|
  66  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |      |      | Mute |      |  |   |
  67  * |------+------+------+------+------+------+------+------+------+------+------+------|
  68  * |      |      |      |      |Lower | Bksp | Bksp |Raise | Next | Vol- | Vol+ | Play |
  69  * `-----------------------------------------------------------------------------------'
  70  */
  71 [_LOWER] = {
  72   {KC_ESC,  KC_EXLM,  KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL},
  73   {_______, KC_F1,    KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, _______},
  74   {_______, KC_F7,    KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, KC_MUTE, _______, KC_PIPE},
  75   {_______, _______,  _______, _______, _______, KC_BSPC, KC_BSPC, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  76 },
  77
  78 /* Raise
  79  * ,-----------------------------------------------------------------------------------.
  80  * | Esc  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
  81  * |------+------+------+------+------+-------------+------+------+------+------+------|
  82  * |      |   4  |   5  |   6  |   +  |  F5  |  F6  |   -  |   =  |   [  |   ]  |Enter |
  83  * |------+------+------+------+------+------|------+------+------+------+------+------|
  84  * |Enter |   7  |   8  |   9  |   -  |  F11 |  F12 |ISO # |ISO / | Mute |      |   \  |
  85  * |------+------+------+------+------+------+------+------+------+------+------+------|
  86  * |      |   ,  |   0  |  .   |Lower | Bksp | Bksp |Raise | Next | Vol- | Vol+ | Play |
  87  * `-----------------------------------------------------------------------------------'
  88  */
  89 [_RAISE] = {
  90   {KC_ESC,  KC_1,    KC_2,  KC_3,   KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
  91   {_______, KC_4,    KC_5,  KC_6,   KC_PLUS, KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, _______},
  92   {KC_ENT,  KC_7,    KC_8,  KC_9,   KC_MINS, KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_MUTE, _______, KC_BSLS},
  93   {_______, KC_COMM, KC_0,  KC_DOT, _______, KC_BSPC, KC_BSPC, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  94 },
  95
  96 /* Adjust (Lower + Raise)
  97  * ,-----------------------------------------------------------------------------------.
  98  * |Taskmg|      |      |      |      |      |      |      |      |      |      |caltde|
  99  * |------+------+------+------+------+-------------+------+------+------+------+------|
 100  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|      |      |      |      |
 101  * |------+------+------+------+------+------|------+------+------+------+------+------|
 102  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 103  * |------+------+------+------+------+------+------+------+------+------+------+------|
 104  * |      |      |      |      |      |      |      |      |      |      |      | RESET|
 105  * `-----------------------------------------------------------------------------------'
 106  */
 107 [_ADJUST] = {
 108   {TSKMGR,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, CALTDEL},
 109   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  _______, _______, _______, _______},
 110   {_______,  MUV_DE, MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 111   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET}
 112 },
 113
 114 /* Function
 115  * ,-----------------------------------------------------------------------------------.
 116  * |      |      |      |      |      |      |      |      |  Up  |      |      |      |
 117  * |------+------+------+------+------+-------------+------+------+------+------+------|
 118  * |      |      |      |      |      |      |      | Left | Down |Right |      |      |
 119  * |------+------+------+------+------+------|------+------+------+------+------+------|
 120  * | Caps |      |      |      |      |      |      |      |      |      |      |      |
 121  * |------+------+------+------+------+------+------+------+------+------+------+------|
 122  * |      |      |      |      |      |      |      |      |      |      |      |
 123  * `-----------------------------------------------------------------------------------'
 124  */
 125 [_FUNCTION] = {
 126   {_______, _______, _______, _______, _______, _______, _______, _______, KC_UP,   _______, _______, _______},
 127   {_______, _______, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
 128   {KC_CAPS, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 129   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 130 }
 131
 132
 133 };
 134
 135 #ifdef AUDIO_ENABLE
 136
 137 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 138 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 139 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 140 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 141 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 142
 143 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 144 #endif
 145
 146
 147 void persistant_default_layer_set(uint16_t default_layer) {
 148   eeconfig_update_default_layer(default_layer);
 149   default_layer_set(default_layer);
 150 }
 151
 152 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 153   switch (keycode) {
 154     case QWERTY:
 155       if (record->event.pressed) {
 156         #ifdef AUDIO_ENABLE
 157           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 158         #endif
 159         persistant_default_layer_set(1UL<<_QWERTY);
 160       }
 161       return false;
 162       break;
 163     case LOWER:
 164       if (record->event.pressed) {
 165         layer_on(_LOWER);
 166         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 167       } else {
 168         layer_off(_LOWER);
 169         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 170       }
 171       return false;
 172       break;
 173     case RAISE:
 174       if (record->event.pressed) {
 175         layer_on(_RAISE);
 176         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 177       } else {
 178         layer_off(_RAISE);
 179         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 180       }
 181       return false;
 182       break;
 183   }
 184   return true;
 185 }
 186
 187 void matrix_init_user(void) {
 188     #ifdef AUDIO_ENABLE
 189         startup_user();
 190     #endif
 191 }
 192
 193 #ifdef AUDIO_ENABLE
 194
 195 void startup_user()
 196 {
 197     _delay_ms(20); // gets rid of tick
 198     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 199 }
 200
 201 void shutdown_user()
 202 {
 203     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 204     _delay_ms(150);
 205     stop_all_notes();
 206 }
 207
 208 void music_on_user(void)
 209 {
 210     music_scale_user();
 211 }
 212
 213 void music_scale_user(void)
 214 {
 215     PLAY_NOTE_ARRAY(music_scale, false, 0);
 216 }
 217
 218 #endif