keyboards/planck/keymaps/dbroqua/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 _LOWER 1
  19 #define _RAISE 2
  20 #define _MULTIMEDIA 3
  21 #define _ADJUST 4
  22
  23 enum planck_keycodes {
  24   QWERTY = SAFE_RANGE,
  25   LOWER,
  26   RAISE,
  27   BACKLIT
  28 };
  29
  30 // Fillers to make layering more clear
  31 #define _______ KC_TRNS
  32 #define XXXXXXX KC_NO
  33
  34 // Func macro definitions.
  35 #define SFT_TAB  FUNC(0) // Tap for Enter, hold for Shift
  36
  37 // Enable these functions using FUNC(n) macro.
  38 const uint16_t PROGMEM fn_actions[] = {
  39     [0] = ACTION_LAYER_TAP_KEY(_MULTIMEDIA, KC_TAB)
  40  };
  41
  42 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  43
  44 /* Qwerty
  45  * ,-----------------------------------------------------------------------------------.
  46  * | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  47  * |------+------+------+------+------+------+------+------+------+------+------+------|
  48  * | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  49  * |------+------+------+------+------+------+------+------+------+------+------+------|
  50  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  51  * |------+------+------+------+------+------+------+------+------+------+------+------|
  52  * | Ctrl | GUI  | AltGr| Alt  | Lower|    Space    | Raise| Left | Down |  Up  |Right |
  53  * `-----------------------------------------------------------------------------------'
  54  */
  55 [_QWERTY] = {
  56   {KC_ESC,  KC_Q,       KC_W,       KC_E,       KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,    KC_O,    KC_P,    KC_BSPC},
  57   {SFT_TAB, 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_RALT,    KC_LALT,    LOWER,  KC_SPC, KC_SPC, RAISE,  KC_LEFT, KC_DOWN, KC_UP,   KC_RIGHT}
  60 },
  61
  62 /* Lower
  63  * ,-----------------------------------------------------------------------------------.
  64  * |      |      |      |      |      |      |      |      |      |      |   (  |   )  |
  65  * |------+------+------+------+------+------+------+------+------+------+------+------|
  66  * | Brite|      |      |      |      |      |      |      |      |      |   {  |   }  |
  67  * |------+------+------+------+------+------+------+------+------+------+------+------|
  68  * |      |      |      |      |      |      |      |      |      |      |   [  |   ]  |
  69  * |------+------+------+------+------+------+------+------+------+------+------+------|
  70  * |      |      |      |      |      |             |      | Home | PgDwn| PgUp | End  |
  71  * `-----------------------------------------------------------------------------------'
  72  */
  73 [_LOWER] = {
  74   {_______, _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,    KC_LPRN,  KC_RPRN},
  75   {BACKLIT, _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,    KC_LCBR,  KC_RCBR},
  76   {_______, _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,    KC_LBRC,  KC_RBRC},
  77   {_______, _______,  _______,  _______,  _______,  _______,  _______,  _______,  KC_HOME,  KC_PGDN,    KC_PGUP,  KC_END}
  78 },
  79
  80 /* Raise
  81  * ,-----------------------------------------------------------------------------------.
  82  * |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |  10  |   -  |   =  |
  83  * |------+------+------+------+------+------+------+------+------+------+------+------|
  84  * |      |      |      |      |      |      |      |      |      |      |      |  `   |
  85  * |------+------+------+------+------+------+------+------+------+------+------+------|
  86  * |      |      |      |      |      |      |      |      |      |      |   \  |      |
  87  * |------+------+------+------+------+------+------+------+------+------+------+------|
  88  * |      |      |      |      |      |             |      |      |      |      |      |
  89  * `-----------------------------------------------------------------------------------'
  90  */
  91 [_RAISE] = {
  92   {KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL},
  93   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_GRV},
  94   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_BSLS, _______},
  95   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
  96 },
  97
  98 /* _MULTIMEDIA
  99  * ,-----------------------------------------------------------------------------------.
 100  * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  | F10  | F11  | F12  |
 101  * |------+------+------+------+------+------+------+------+------+------+------+------|
 102  * |      |      |      |      |      |      |      |  Psc |      |      |      |      |
 103  * |------+------+------+------+------+------+------+------+------+------+------+------|
 104  * |      |      |      |      |      | Mute | Vol+ | Vol- |      |      |      |Insert|
 105  * |------+------+------+------+------+------+------+------+------+------+------+------|
 106  * |      |      |      |      |      |             |      | Prev | Play | Next |  Del |
 107  * `-----------------------------------------------------------------------------------'
 108  */
 109 [_MULTIMEDIA] = {
 110   {KC_F1,   KC_F2,      KC_F3,      KC_F4,      KC_F5,      KC_F6,      KC_F7,      KC_F8,      KC_F9,      KC_F10,     KC_F11,     KC_F12},
 111   {_______, _______,    _______,    _______,    _______,    _______,    _______,    KC_PSCR,    _______,    _______,    _______,    _______},
 112   {_______, _______,    _______,    _______,    _______,    KC_MUTE,    KC_VOLU,    KC_VOLD,    _______,    _______,    _______,    KC_INS},
 113   {_______, _______,    _______,    _______,    _______,    _______,    _______,    _______,    KC_MPRV,    KC_MPLY,    KC_MNXT,    KC_DEL}
 114 },
 115
 116
 117 /* Adjust (Lower + Raise)
 118  * ,-----------------------------------------------------------------------------------.
 119  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 120  * |------+------+------+------+------+------+------+------+------+------+------+------|
 121  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|      |      |      |      |
 122  * |------+------+------+------+------+------+------+------+------+------+------+------|
 123  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 124  * |------+------+------+------+------+------+------+------+------+------+------+------|
 125  * |      |      |      |      |      |             |      |      |      |      |      |
 126  * `-----------------------------------------------------------------------------------'
 127  */
 128 [_ADJUST] = {
 129   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 130   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  _______, _______, _______, _______},
 131   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 132   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 133 }
 134
 135
 136 };
 137
 138 #ifdef AUDIO_ENABLE
 139
 140 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 141 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 142 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 143 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 144 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 145 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 146 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 147
 148 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 149 #endif
 150
 151
 152 void persistent_default_layer_set(uint16_t default_layer) {
 153   eeconfig_update_default_layer(default_layer);
 154   default_layer_set(default_layer);
 155 }
 156
 157 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 158   switch (keycode) {
 159     case QWERTY:
 160       if (record->event.pressed) {
 161         #ifdef AUDIO_ENABLE
 162           PLAY_SONG(tone_qwerty);
 163         #endif
 164         persistent_default_layer_set(1UL<<_QWERTY);
 165       }
 166       return false;
 167       break;
 168     case LOWER:
 169       if (record->event.pressed) {
 170         layer_on(_LOWER);
 171         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 172       } else {
 173         layer_off(_LOWER);
 174         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 175       }
 176       return false;
 177       break;
 178     case RAISE:
 179       if (record->event.pressed) {
 180         layer_on(_RAISE);
 181         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 182       } else {
 183         layer_off(_RAISE);
 184         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 185       }
 186       return false;
 187       break;
 188     case BACKLIT:
 189       if (record->event.pressed) {
 190         register_code(KC_RSFT);
 191         #ifdef BACKLIGHT_ENABLE
 192           backlight_step();
 193         #endif
 194       } else {
 195         unregister_code(KC_RSFT);
 196       }
 197       return false;
 198       break;
 199   }
 200   return true;
 201 }
 202
 203 void matrix_init_user(void) {
 204     #ifdef AUDIO_ENABLE
 205         startup_user();
 206     #endif
 207 }
 208
 209 #ifdef AUDIO_ENABLE
 210
 211 void startup_user()
 212 {
 213     _delay_ms(20); // gets rid of tick
 214     PLAY_SONG(tone_startup);
 215 }
 216
 217 void shutdown_user()
 218 {
 219     PLAY_SONG(tone_goodbye);
 220     _delay_ms(150);
 221     stop_all_notes();
 222 }
 223
 224 void music_on_user(void)
 225 {
 226     music_scale_user();
 227 }
 228
 229 void music_scale_user(void)
 230 {
 231     PLAY_SONG(music_scale);
 232 }
 233
 234 #endif