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   uint8_t clockbyte=0;
 122   clockbyte = TCNT1 % 256;
 123   uint8_t rval;
 124   // MACRODOWN only works in this function
 125   switch(id) {
 126   case M_LED:
 127     if (record->event.pressed) {
 128       register_code(KC_RSFT);
 129 #ifdef BACKLIGHT_ENABLE
 130       backlight_step();
 131 #endif
 132     } else {
 133       unregister_code(KC_RSFT);
 134     }
 135     break;
 136   case M_USERNAME:
 137     if (record->event.pressed) {
 138       return MACRO( I(1), T(C), T(B), T(B), T(R), T(O), T(W), T(N), T(E));
 139     } else {
 140       return MACRO_NONE ;
 141     }
 142     break;
 143   case M_RANDDIGIT:
 144     /* Generate, based on random number generator, a keystroke for
 145        a numeric digit chosen at random */
 146     random_value = ((random_value + randadd) * randmul) % randmod;
 147     if (record->event.pressed) {
 148       /* Here, we mix the LCRNG with low bits from one of the system
 149          clocks via XOR in the theory that this may be more random
 150          than either separately */
 151       rval = (random_value ^ clockbyte) % 10;
 152       /* Note that KC_1 thru KC_0 are a contiguous range */
 153       register_code (KC_1 + rval);
 154       unregister_code (KC_1 + rval);
 155     }
 156     break;
 157   case M_RANDLETTER:
 158     /* Generate, based on random number generator, a keystroke for
 159        a letter chosen at random */
 160     /* Here, we mix the LCRNG with low bits from one of the system
 161        clocks via XOR in the theory that this may be more random
 162        than either separately */
 163     random_value = ((random_value + randadd) * randmul) % randmod;
 164     if (record->event.pressed) {
 165       rval = (random_value ^ clockbyte) % 26;
 166       register_code (KC_A + rval);
 167       unregister_code (KC_A + rval);
 168     }
 169     break;
 170   }
 171   return MACRO_NONE;
 172 };