]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboard/planck/keymaps/cbbrowne/keymap.c
Notes on what's done, and plans to change my key mapping
[qmk_firmware.git] / keyboard / planck / keymaps / cbbrowne / keymap.c
1 #include "planck.h"
2 #ifdef BACKLIGHT_ENABLE
3   #include "backlight.h"
4 #endif
5
6 /* Each layer is given a name to aid in readability, which is then
7    used in the keymap matrix below.  The underscores do not denote 
8    anything - you can have a layer called STUFF or any other name.
9
10    Layer names don't all need to be of the same length, obviously, and
11    you could also skip them entirely and just use numbers, though that
12    means needing to manage the numbers.
13
14    It is preferable to keep the symbols short so that a line worth of
15    key mappings fits compactly onto a line of code. */
16
17 /* This was originally based on planck/keymaps/default/default.c, and
18    then cbbrowne has revised things */
19
20 /* Things I did not like about the default mapping 
21
22    - I find control too hard to get to.  I think I'll want it on a
23      left finger.  Gonna need to lose something to do that...
24    - Almost certainly, KC_LCTL should be on [2][1]
25    - having dash on [lower-j] is a bit nonintuitive, but may be OK
26    - I'll bet I should switch ESC/TAB
27    - I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
28      and shift ESC off the first column so KC_LCTL and KC_LALT can
29      be on the first column.
30
31
32    - I'm keeping Colemak and Dvorak around for reference, and added
33      Workman just for fun.  They're useless to me, though.
34 */
35
36 /* Other things to do...
37
38    - Need to think about what zsh and readline actions I use lots
39    - Wanna figure out macros, so I can put in a "cbbrowne" macro
40    - Ought to ensure that Control-Alt-Delete is convenient enough
41    - How about Alt-F1 thru Alt-F8?
42    - What's the keystroke to get from X to console these days?
43    - I do indeed want a sweet number pad!
44    - A layer for doing console switching would not be a bad idea
45 */
46
47 enum layers {
48   _QW = 0,  /* Qwerty mapping */
49   _CM, /* Colemak */
50   _DV, /* Dvorak */
51   _WK, /* Workman */
52   _LW, /* Lower layer, where top line has symbols !@#$%^&*() */
53   _RS, /* Raised layer, where top line has digits 1234567890 */
54   _KP, /* Key pad */
55 };
56
57 /* Note that Planck has dimensions 4 rows x 12 columns */
58
59 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
60 [_QW] = { /* Qwerty */
61   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
62   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
63   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
64   {M(0),    KC_LCTL, KC_LALT, KC_LGUI, MO(_LW), KC_SPC,  KC_SPC,  MO(_RS), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
65 },
66 [_CM] = { /* Colemak */
67   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
68   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
69   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
70   {M(0),    KC_LCTL, KC_LALT, KC_LGUI, MO(_LW), KC_SPC,  KC_SPC,  MO(_RS), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
71 },
72 [_DV] = { /* Dvorak */
73   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC}, 
74   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH}, 
75   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT }, 
76   {M(0),    KC_LCTL, KC_LALT, KC_LGUI, MO(_LW), KC_SPC,  KC_SPC,  MO(_RS), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT} 
77 }, 
78 [_WK] = { /* Workman */
79   {KC_TAB,  KC_Q,    KC_D,    KC_R,    KC_W,    KC_B,    KC_J,    KC_F,    KC_U,    KC_P,    KC_SCLN,    KC_BSPC},
80   {KC_ESC,  KC_A,    KC_S,    KC_H,    KC_T,    KC_G,    KC_Y,    KC_N,    KC_E,    KC_O,    KC_I,       KC_QUOT},
81   {KC_LSFT, KC_Z,    KC_X,    KC_M,    KC_C,    KC_V,    KC_K,    KC_L,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
82   {M(0),    KC_LCTL, KC_LALT, KC_LGUI, MO(_LW), KC_SPC,  KC_SPC,  MO(_RS), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
83 }, 
84 [_RS] = { /* RAISE */
85   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
86   {KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
87   {KC_TRNS, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  DF(_QW), DF(_CM), DF(_WK), RESET,   KC_TRNS},
88   {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
89 },
90 [_LW] = { /* LOWER */
91   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
92   {KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
93   {KC_TRNS, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  DF(_QW), DF(_CM), DF(_WK), RESET,   KC_TRNS},
94   {KC_TRNS, DF(_KP), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
95 },
96 [_KP] = { /* Key Pad */
97   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_KP_ENTER, KC_KP_PLUS, KC_KP_PLUS, KC_KP_ENTER, KC_KP_ENTER},
98   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_KP_MINUS, KC_7, KC_8,    KC_9,  KC_KP_DOT},
99   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_KP_PLUS,    KC_4, KC_5,  KC_6, KC_0},
100   {BL_STEP, KC_LCTL, KC_LALT, KC_LGUI, KC_NO, KC_SPC,  KC_SPC,  DF(_QW),   KC_1, KC_2, KC_3,  KC_0}
101 }
102 };
103
104 /* I'm planning to use this to set up some macros, including one to
105    expand into "cbbrowne", more to prove it can be done than anything
106    else.
107 */
108
109 enum macro_id {
110   M_P0,
111   M_P1,
112   M_P2,
113   M_P3,
114   M_P4,
115   M_P5,
116   M_USERNAME
117 };
118
119
120 const uint16_t PROGMEM fn_actions[] = {
121
122 };
123
124 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
125 {
126   // MACRODOWN only works in this function
127       switch(id) {
128         case 0:
129           if (record->event.pressed) {
130             register_code(KC_RSFT);
131             #ifdef BACKLIGHT_ENABLE
132               backlight_step();
133             #endif
134           } else {
135             unregister_code(KC_RSFT);
136           }
137         break;
138       }
139     return MACRO_NONE;
140 };