keyboards/planck/keymaps/handwired_binaryplease/keymap.c

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