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
  10 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  11 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  12 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  13 // entirely and just use numbers.
  14 #define _QWERTY 0
  15 #define _COLEMAK 1
  16 #define _DVORAK 2
  17 #define _LOWER 3
  18 #define _RAISE 4
  19 #define _ADJUST 5
  20 #define _MUSIC 6
  21
  22 // Macro name shortcuts
  23 #define QWERTY M(_QWERTY)
  24 #define COLEMAK M(_COLEMAK)
  25 #define DVORAK M(_DVORAK)
  26 #define LOWER M(_LOWER)
  27 #define RAISE M(_RAISE)
  28 #define M_BL 5
  29 #ifdef AUDIO_ENABLE
  30   #define AUD_OFF M(6)
  31   #define AUD_ON M(7)
  32 #endif
  33 #define MUS_OFF M(8)
  34 #define MUS_ON M(9)
  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   {M(M_BL), 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 |      |      |      |      |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,  _______, _______, _______, _______, _______},
 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 |      |      |      |      |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,  _______, _______, _______, _______, _______},
 129   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 130 },
 131
 132 /* Adjust (Lower + Raise)
 133  * ,-----------------------------------------------------------------------------------.
 134  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 135  * |------+------+------+------+------+-------------+------+------+------+------+------|
 136  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|      |      |
 137  * |------+------+------+------+------+------|------+------+------+------+------+------|
 138  * |      |      |      |      |      |      |      |      |      |      |      |      |
 139  * |------+------+------+------+------+------+------+------+------+------+------+------|
 140  * |      |      |      |      |      |             |      |      |      |      |      |
 141  * `-----------------------------------------------------------------------------------'
 142  */
 143 [_ADJUST] = {
 144   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 145   {_______, _______, _______, AUD_ON,  AUD_OFF, AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  _______, _______},
 146   {_______, _______, _______, MUS_ON,  MUS_OFF, _______, _______, _______, _______, _______, _______, _______},
 147   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 148 },
 149
 150 /* Music (reserved for process_action_user)
 151  *
 152  */
 153 [_MUSIC] = {
 154   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 155   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 156   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 157   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 158 }
 159 };
 160
 161 const uint16_t PROGMEM fn_actions[] = {
 162
 163 };
 164
 165 #ifdef AUDIO_ENABLE
 166 float tone_startup[][2] = {
 167   {440.0*pow(2.0,(31)/12.0), 12},
 168   {440.0*pow(2.0,(28)/12.0), 8},
 169   {440.0*pow(2.0,(19)/12.0), 8},
 170   {440.0*pow(2.0,(24)/12.0), 8},
 171   {440.0*pow(2.0,(28)/12.0), 20}
 172 };
 173
 174 float tone_qwerty[][2] = {
 175   {440.0*pow(2.0,(23)/12.0), 8},
 176   {440.0*pow(2.0,(24)/12.0), 8},
 177   {0, 4},
 178   {440.0*pow(2.0,(31)/12.0), 16}
 179 };
 180
 181 float tone_colemak[][2] = {
 182   {440.0*pow(2.0,(23)/12.0), 8},
 183   {440.0*pow(2.0,(24)/12.0), 8},
 184   {0, 4},
 185   {440.0*pow(2.0,(31)/12.0), 12},
 186   {0, 4},
 187   {440.0*pow(2.0,(35)/12.0), 12}
 188 };
 189
 190 float tone_dvorak[][2] = {
 191   {440.0*pow(2.0,(23)/12.0), 8},
 192   {440.0*pow(2.0,(24)/12.0), 8},
 193   {0, 4},
 194   {440.0*pow(2.0,(31)/12.0), 8},
 195   {0, 4},
 196   {440.0*pow(2.0,(33)/12.0), 8},
 197   {0, 4},
 198   {440.0*pow(2.0,(31)/12.0), 8}
 199 };
 200
 201 float tone_music[][2] = {
 202   {440.0*pow(2.0,(12)/12.0), 8},
 203   {440.0*pow(2.0,(14)/12.0), 8},
 204   {440.0*pow(2.0,(16)/12.0), 8},
 205   {440.0*pow(2.0,(17)/12.0), 8},
 206   {440.0*pow(2.0,(19)/12.0), 8},
 207   {440.0*pow(2.0,(21)/12.0), 8},
 208   {440.0*pow(2.0,(23)/12.0), 8},
 209   {440.0*pow(2.0,(24)/12.0), 8}
 210 };
 211 #endif
 212
 213
 214 void persistant_default_layer_set(uint16_t default_layer) {
 215   eeconfig_write_default_layer(default_layer);
 216   default_layer_set(default_layer);
 217 }
 218
 219 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 220 {
 221       switch(id) {
 222         case _QWERTY:
 223           if (record->event.pressed) {
 224             #ifdef AUDIO_ENABLE
 225               PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 226             #endif
 227             persistant_default_layer_set(1UL<<_QWERTY);
 228           }
 229           break;
 230         case _COLEMAK:
 231           if (record->event.pressed) {
 232             #ifdef AUDIO_ENABLE
 233               PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 234             #endif
 235             persistant_default_layer_set(1UL<<_COLEMAK);
 236           }
 237           break;
 238         case _DVORAK:
 239           if (record->event.pressed) {
 240             #ifdef AUDIO_ENABLE
 241               PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 242             #endif
 243             persistant_default_layer_set(1UL<<_DVORAK);
 244           }
 245           break;
 246         case _LOWER:
 247           if (record->event.pressed) {
 248             layer_on(_LOWER);
 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             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 259           } else {
 260             layer_off(_RAISE);
 261             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 262           }
 263           break;
 264         case M_BL:
 265           if (record->event.pressed) {
 266             register_code(KC_RSFT);
 267             #ifdef BACKLIGHT_ENABLE
 268               backlight_step();
 269             #endif
 270           } else {
 271             unregister_code(KC_RSFT);
 272           }
 273         break;
 274         case 6:
 275           if (record->event.pressed) {
 276             #ifdef AUDIO_ENABLE
 277               audio_off();
 278             #endif
 279           }
 280         break;
 281         case 7:
 282           if (record->event.pressed) {
 283             #ifdef AUDIO_ENABLE
 284               audio_on();
 285               PLAY_NOTE_ARRAY(tone_startup, false, 0);
 286             #endif
 287           }
 288         break;
 289         case 8:
 290           if (record->event.pressed) {
 291             #ifdef AUDIO_ENABLE
 292               layer_off(_MUSIC);
 293               stop_all_notes();
 294             #endif
 295           }
 296         break;
 297         case 9:
 298           if (record->event.pressed) {
 299             #ifdef AUDIO_ENABLE
 300               PLAY_NOTE_ARRAY(tone_music, false, 0);
 301               layer_on(_MUSIC);
 302             #endif
 303           }
 304         break;
 305       }
 306     return MACRO_NONE;
 307 };
 308
 309 uint8_t starting_note = 0x0C;
 310 int offset = 7;
 311
 312 void process_action_user(keyrecord_t *record) {
 313
 314   if (IS_LAYER_ON(_MUSIC)) {
 315     if (record->event.pressed) {
 316         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);
 317     } else {
 318         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)));
 319     }
 320   }
 321
 322 }
 323
 324 void matrix_init_user(void) {
 325   #ifdef AUDIO_ENABLE
 326     init_notes();
 327     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 328   #endif
 329 }