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 _QW 0
  15 #define _CM 1
  16 #define _DV 2
  17 #define _LW 3
  18 #define _RS 4
  19 #define _AD 5
  20
  21 // Macro name shortcuts
  22 #define M_QW 0
  23 #define M_CM 1
  24 #define M_DV 2
  25 #define M_LW 3
  26 #define M_RS 4
  27 #define M_BL 5
  28
  29 // Fillers to make layering more clear
  30 #define _______ KC_TRNS
  31 #define XXXXXXX KC_NO
  32
  33 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  34
  35 /* Qwerty
  36  * ,-----------------------------------------------------------------------------------.
  37  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  38  * |------+------+------+------+------+-------------+------+------+------+------+------|
  39  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  40  * |------+------+------+------+------+------|------+------+------+------+------+------|
  41  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  42  * |------+------+------+------+------+------+------+------+------+------+------+------|
  43  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  44  * `-----------------------------------------------------------------------------------'
  45  */
  46 [_QW] = {
  47   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  48   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  49   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  50   {M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, M(M_LW), KC_SPC,  KC_SPC,  M(M_RS), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  51 },
  52
  53 /* Colemak
  54  * ,-----------------------------------------------------------------------------------.
  55  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  56  * |------+------+------+------+------+-------------+------+------+------+------+------|
  57  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  58  * |------+------+------+------+------+------|------+------+------+------+------+------|
  59  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  60  * |------+------+------+------+------+------+------+------+------+------+------+------|
  61  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  62  * `-----------------------------------------------------------------------------------'
  63  */
  64 [_CM] = {
  65   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  66   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  67   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  68   {M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, M(M_LW), KC_SPC,  KC_SPC,  M(M_RS), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  69 },
  70
  71 /* Dvorak
  72  * ,-----------------------------------------------------------------------------------.
  73  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  74  * |------+------+------+------+------+-------------+------+------+------+------+------|
  75  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  76  * |------+------+------+------+------+------|------+------+------+------+------+------|
  77  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  78  * |------+------+------+------+------+------+------+------+------+------+------+------|
  79  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  80  * `-----------------------------------------------------------------------------------'
  81  */
  82 [_DV] = {
  83   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  84   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
  85   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
  86   {M(M_BL), KC_LCTL, KC_LALT, KC_LGUI, M(M_LW), KC_SPC,  KC_SPC,  M(M_RS), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  87 },
  88
  89 /* Lower
  90  * ,-----------------------------------------------------------------------------------.
  91  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
  92  * |------+------+------+------+------+-------------+------+------+------+------+------|
  93  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
  94  * |------+------+------+------+------+------|------+------+------+------+------+------|
  95  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |      |      |      |      |Enter |
  96  * |------+------+------+------+------+------+------+------+------+------+------+------|
  97  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
  98  * `-----------------------------------------------------------------------------------'
  99  */
 100 [_LW] = {
 101   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 102   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 103   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______},
 104   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 105 },
 106
 107 /* Raise
 108  * ,-----------------------------------------------------------------------------------.
 109  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 110  * |------+------+------+------+------+-------------+------+------+------+------+------|
 111  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 112  * |------+------+------+------+------+------|------+------+------+------+------+------|
 113  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |      |      |      |      |Enter |
 114  * |------+------+------+------+------+------+------+------+------+------+------+------|
 115  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 116  * `-----------------------------------------------------------------------------------'
 117  */
 118 [_RS] = {
 119   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 120   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 121   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______},
 122   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 123 },
 124
 125 /* Adjust (Lower + Raise)
 126  * ,-----------------------------------------------------------------------------------.
 127  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 128  * |------+------+------+------+------+-------------+------+------+------+------+------|
 129  * |      |      |      |      |      |      |      |Qwerty|Colemk|Dvorak|      |      |
 130  * |------+------+------+------+------+------|------+------+------+------+------+------|
 131  * |      |      |      |      |      |      |      |      |      |      |      |      |
 132  * |------+------+------+------+------+------+------+------+------+------+------+------|
 133  * |      |      |      |      |      |             |      |      |      |      |      |
 134  * `-----------------------------------------------------------------------------------'
 135  */
 136 [_AD] = {
 137   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 138   {_______, _______, _______, _______, _______, _______, _______, M(M_QW), M(M_CM), M(M_DV), _______, _______},
 139   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 140   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 141 }
 142 };
 143
 144 const uint16_t PROGMEM fn_actions[] = {
 145
 146 };
 147
 148 #ifdef AUDIO_ENABLE
 149 float tone_qw[][2] = {
 150   {440.0*pow(2.0,(59)/12.0), 8},
 151   {440.0*pow(2.0,(60)/12.0), 8},
 152   {0, 4},
 153   {440.0*pow(2.0,(67)/12.0), 16}
 154 };
 155
 156 float tone_cm[][2] = {
 157   {440.0*pow(2.0,(59)/12.0), 8},
 158   {440.0*pow(2.0,(60)/12.0), 8},
 159   {0, 4},
 160   {440.0*pow(2.0,(67)/12.0), 16},
 161   {0, 4},
 162   {440.0*pow(2.0,(71)/12.0), 16}
 163 };
 164
 165 float tone_dv[][2] = {
 166   {440.0*pow(2.0,(59)/12.0), 8},
 167   {440.0*pow(2.0,(60)/12.0), 8},
 168   {0, 4},
 169   {440.0*pow(2.0,(67)/12.0), 16},
 170   {0, 4},
 171   {440.0*pow(2.0,(69)/12.0), 16},
 172   {0, 4},
 173   {440.0*pow(2.0,(67)/12.0), 16}
 174 };
 175 #endif
 176
 177 #define IS_LAYER_ON(layer)  ((layer_state) & (1<<(layer)))
 178 #define IS_LAYER_OFF(layer) ((!layer_state) & (1<<(layer)))
 179
 180 void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3) {
 181   if (IS_LAYER_ON(layer1) && IS_LAYER_ON(layer2)) {
 182     layer_on(layer3);
 183   } else {
 184     layer_off(layer3);
 185   }
 186 }
 187 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 188 {
 189   // MACRODOWN only works in this function
 190       switch(id) {
 191         case M_QW:
 192           if (record->event.pressed) {
 193             #ifdef AUDIO_ENABLE
 194               play_notes(&tone_qw, 4, false);
 195             #endif
 196             default_layer_set(1UL<<_QW);
 197           }
 198           break;
 199         case M_CM:
 200           if (record->event.pressed) {
 201             #ifdef AUDIO_ENABLE
 202               play_notes(&tone_cm, 6, false);
 203             #endif
 204             default_layer_set(1UL<<_CM);
 205           }
 206           break;
 207         case M_DV:
 208           if (record->event.pressed) {
 209             #ifdef AUDIO_ENABLE
 210               play_notes(&tone_dv, 8, false);
 211             #endif
 212             default_layer_set(1UL<<_DV);
 213           }
 214           break;
 215         case M_LW:
 216           if (record->event.pressed) {
 217             layer_on(_LW);
 218             update_tri_layer(_LW, _RS, _AD);
 219           } else {
 220             layer_off(_LW);
 221             update_tri_layer(_LW, _RS, _AD);
 222           }
 223           break;
 224         case M_RS:
 225           if (record->event.pressed) {
 226             layer_on(_RS);
 227             update_tri_layer(_LW, _RS, _AD);
 228           } else {
 229             layer_off(_RS);
 230             update_tri_layer(_LW, _RS, _AD);
 231           }
 232           break;
 233         case M_BL:
 234           if (record->event.pressed) {
 235             register_code(KC_RSFT);
 236             #ifdef BACKLIGHT_ENABLE
 237               backlight_step();
 238             #endif
 239           } else {
 240             unregister_code(KC_RSFT);
 241           }
 242         break;
 243       }
 244     return MACRO_NONE;
 245 };
 246
 247 #ifdef AUDIO_ENABLE
 248 float start_up[][2] = {
 249   {440.0*pow(2.0,(67)/12.0), 12},
 250   {440.0*pow(2.0,(64)/12.0), 8},
 251   {440.0*pow(2.0,(55)/12.0), 8},
 252   {440.0*pow(2.0,(60)/12.0), 8},
 253   {440.0*pow(2.0,(64)/12.0), 20}
 254 };
 255 #endif
 256
 257 void matrix_init_user(void) {
 258   #ifdef AUDIO_ENABLE
 259     init_notes();
 260     play_notes(&start_up, 5, false);
 261   #endif
 262 }