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    - I think I wanna swap ' and ENTER
  31
  32    - All of the above are done :-)
  33
  34    - I'm keeping Colemak and Dvorak around for reference, and added
  35      Workman just for fun.  They're useless to me, though.
  36 */
  37
  38
  39 /* Some interesting things implemented
  40
  41    - There is a macro that writes out "cbbrowne" just because I could
  42    - There is a (somewhat cruddy) linear congruential random number
  43      generator.
  44      - I would like to be seeding it with clock info to make it look
  45        more random
  46    - There are two macros that use the random number generators
  47      - one, M_RANDDIGIT, generates a random digit based on state
  48        of the random number generator
  49      - the other, M_RANDLETTER, generates a random letter based on state
  50        of the random number generator
  51      - in both, note the use of register_code()/unregister_code()
  52        to indicate the desired key
  53 */
  54
  55 /* Other things to do...
  56
  57    - Need to think about what zsh and readline actions I use lots
  58    - Wanna figure out macros, so I can put in a "cbbrowne" macro
  59    - Ought to ensure that Control-Alt-Delete is convenient enough
  60    - How about Alt-F1 thru Alt-F8?
  61    - What's the keystroke to get from X to console these days?
  62    - I do indeed want a sweet number pad!
  63    - A layer for doing console switching would not be a bad idea
  64 */
  65
  66 enum layers {
  67   _QW = 0,  /* Qwerty mapping */
  68   _LW, /* Lower layer, where top line has symbols !@#$%^&*() */
  69   _RS, /* Raised layer, where top line has digits 1234567890 */
  70   _KP, /* Key pad */
  71 };
  72
  73 enum macro_id {
  74   M_LED = 0,
  75   M_USERNAME,
  76   M_RANDDIGIT,
  77   M_RANDLETTER
  78 };
  79
  80 /* Note that Planck has dimensions 4 rows x 12 columns */
  81
  82 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  83 [_QW] = { /* Qwerty */
  84   {KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  85   {KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT},
  86   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_QUOT },
  87   {KC_TAB,  M(M_LED), KC_LALT, KC_LGUI, MO(_LW), KC_SPC,  KC_SPC,  MO(_RS), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  88 },
  89 [_RS] = { /* RAISE */
  90   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
  91   {KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
  92   {KC_TRNS, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  DF(_QW), DF(_KP), DF(_KP), RESET,   KC_TRNS},
  93   {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  94 },
  95 [_LW] = { /* LOWER */
  96   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
  97   {KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
  98   {KC_TRNS, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  DF(_QW), DF(_KP), DF(_KP), RESET,   KC_TRNS},
  99   {KC_TRNS, DF(_KP), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 100 },
 101 [_KP] = { /* Key Pad */
 102   {KC_ESC,  M(M_USERNAME),    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_KP_ENTER, KC_KP_PLUS, KC_KP_PLUS, KC_KP_ENTER, KC_BSPC},
 103   {KC_LCTL, M(M_RANDDIGIT),    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_KP_MINUS, KC_7, KC_8,    KC_9,  KC_ENT},
 104   {KC_LSFT, M(M_RANDLETTER),    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_KP_PLUS,    KC_4, KC_5,  KC_6, KC_DOT},
 105   {BL_STEP, M(M_LED), KC_LALT, KC_LGUI, KC_NO, KC_SPC,  KC_SPC,  DF(_QW),   KC_1, KC_2, KC_3,  KC_0}
 106 }
 107 };
 108
 109 const uint16_t PROGMEM fn_actions[] = {
 110 };
 111
 112 /* This bit of logic seeds a wee linear congruential random number generator */
 113
 114 static uint16_t random_value = 157;
 115 #define randadd 53
 116 #define randmul 181
 117 #define randmod 167
 118
 119 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 120 {
 121   // MACRODOWN only works in this function
 122   switch(id) {
 123   case M_LED:
 124     if (record->event.pressed) {
 125       register_code(KC_RSFT);
 126 #ifdef BACKLIGHT_ENABLE
 127       backlight_step();
 128 #endif
 129     } else {
 130       unregister_code(KC_RSFT);
 131     }
 132     break;
 133   case M_USERNAME:
 134     if (record->event.pressed) {
 135       return MACRO( I(1), T(C), T(B), T(B), T(R), T(O), T(W), T(N), T(E));
 136     } else {
 137       return MACRO_NONE ;
 138     }
 139     break;
 140   case M_RANDDIGIT:
 141     /* Generate, based on random number generator, a keystroke for
 142        a numeric digit chosen at random */
 143     random_value = ((random_value + randadd) * randmul) % randmod;
 144     if (record->event.pressed)
 145     switch(random_value % 10) {
 146     case 0:
 147       register_code (KC_0);
 148       unregister_code (KC_0);
 149       break;
 150     case 1:
 151       register_code (KC_1);
 152       unregister_code (KC_1);
 153       break;
 154     case 2:
 155       register_code (KC_2);
 156       unregister_code (KC_2);
 157       break;
 158     case 3:
 159       register_code (KC_3);
 160       unregister_code (KC_3);
 161       break;
 162     case 4:
 163       register_code (KC_4);
 164       unregister_code (KC_4);
 165       break;
 166     case 5:
 167       register_code (KC_5);
 168       unregister_code (KC_5);
 169       break;
 170     case 6:
 171       register_code (KC_6);
 172       unregister_code (KC_6);
 173       break;
 174     case 7:
 175       register_code (KC_7);
 176       unregister_code (KC_7);
 177       break;
 178     case 8:
 179       register_code (KC_8);
 180       unregister_code (KC_8);
 181       break;
 182     case 9:
 183       register_code (KC_9);
 184       unregister_code (KC_9);
 185       break;
 186     }
 187     break;
 188   case M_RANDLETTER:
 189     /* Generate, based on random number generator, a keystroke for
 190        a letter chosen at random */
 191     random_value = ((random_value + randadd) * randmul) % randmod;
 192     if (record->event.pressed)
 193     switch(random_value % 26) {
 194     case 0:
 195       register_code(KC_A);
 196       unregister_code(KC_A);
 197       break;
 198     case 1:
 199       register_code(KC_B);
 200       unregister_code(KC_B);
 201       break;
 202     case 2:
 203       register_code(KC_C);
 204       unregister_code(KC_C);
 205       break;
 206     case 3:
 207       register_code(KC_D);
 208       unregister_code(KC_D);
 209       break;
 210     case 4:
 211       register_code(KC_E);
 212       unregister_code(KC_E);
 213       break;
 214     case 5:
 215       register_code(KC_F);
 216       unregister_code(KC_F);
 217       break;
 218     case 6:
 219       register_code(KC_G);
 220       unregister_code(KC_G);
 221       break;
 222     case 7:
 223       register_code(KC_H);
 224       unregister_code(KC_H);
 225       break;
 226     case 8:
 227       register_code(KC_I);
 228       unregister_code(KC_I);
 229       break;
 230     case 9:
 231       register_code(KC_J);
 232       unregister_code(KC_J);
 233       break;
 234     case 10:
 235       register_code(KC_K);
 236       unregister_code(KC_K);
 237       break;
 238     case 11:
 239       register_code(KC_L);
 240       unregister_code(KC_L);
 241       break;
 242     case 12:
 243       register_code(KC_M);
 244       unregister_code(KC_M);
 245       break;
 246     case 13:
 247       register_code(KC_N);
 248       unregister_code(KC_N);
 249       break;
 250     case 14:
 251       register_code(KC_O);
 252       unregister_code(KC_O);
 253       break;
 254     case 15:
 255       register_code(KC_P);
 256       unregister_code(KC_P);
 257       break;
 258     case 16:
 259       register_code(KC_Q);
 260       unregister_code(KC_Q);
 261       break;
 262     case 17:
 263       register_code(KC_R);
 264       unregister_code(KC_R);
 265       break;
 266     case 18:
 267       register_code(KC_S);
 268       unregister_code(KC_S);
 269       break;
 270     case 19:
 271       register_code(KC_T);
 272       unregister_code(KC_T);
 273       break;
 274     case 20:
 275       register_code(KC_U);
 276       unregister_code(KC_U);
 277       break;
 278     case 21:
 279       register_code(KC_V);
 280       unregister_code(KC_V);
 281       break;
 282     case 22:
 283       register_code(KC_W);
 284       unregister_code(KC_W);
 285       break;
 286     case 23:
 287       register_code(KC_X);
 288       unregister_code(KC_X);
 289       break;
 290     case 24:
 291       register_code(KC_Y);
 292       unregister_code(KC_Y);
 293       break;
 294     case 25:
 295       register_code(KC_Z);
 296       unregister_code(KC_Z);
 297       break;
 298     }
 299     break;
 300   }
 301   return MACRO_NONE;
 302 };