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