keyboard/planck/keymaps/cbbrowne/keymap.c

   1 #include "planck.h"
   2 #ifdef BACKLIGHT_ENABLE
   3   #include "backlight.h"
   4 #endif
   5 #include "config_user.h"
   6 #include "quantum.h"
   7
   8 /* Each layer is given a name to aid in readability, which is then
   9    used in the keymap matrix below.  The underscores do not denote
  10    anything - you can have a layer called STUFF or any other name.
  11
  12    Layer names don't all need to be of the same length, obviously, and
  13    you could also skip them entirely and just use numbers, though that
  14    means needing to manage the numbers.
  15
  16    It is preferable to keep the symbols short so that a line worth of
  17    key mappings fits compactly onto a line of code. */
  18
  19 /* This was originally based on planck/keymaps/default/default.c, and
  20    then cbbrowne has revised things */
  21
  22 /* Things I did not like about the default mapping
  23
  24    - I found control too hard to get to.  I use it more than Tab, so
  25      switched it there.
  26    - Having dash on [lower-j] is a bit nonintuitive, but may be OK
  27    - I'll bet I should switch ESC/TAB
  28    - I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
  29      and shift ESC off the first column so KC_LCTL and KC_LALT can
  30      be on the first column.
  31    - I needed to swap ' and ENTER
  32
  33    - All of the above are done :-)
  34
  35    - Dropped out support for Dvorak and friends.  They aren't
  36      improvements to me
  37 */
  38
  39
  40 /* Some interesting things implemented
  41
  42    - There is a macro that writes out "cbbrowne" to show that I could
  43    - There is a (somewhat cruddy) linear congruential random number
  44      generator.
  45      - I would like to be seeding it with clock info to make it look
  46        more random
  47    - There are two macros that use the random number generators
  48      - one, M_RANDDIGIT, generates a random digit based on state
  49        of the random number generator
  50      - the other, M_RANDLETTER, generates a random letter based on state
  51        of the random number generator
  52      - in both, note the use of register_code()/unregister_code()
  53        to indicate the desired key
  54    - I do indeed want a sweet number pad!
  55 */
  56
  57 /* Other things to do...
  58
  59    - Need to think about what zsh and readline actions I use lots
  60    - Ought to ensure that Control-Alt-Delete is convenient enough
  61    - How about Alt-F1 thru Alt-F8?
  62    - What's the keystroke to get from X to console these days?
  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_F9,   KC_F10,   KC_F11,  KC_F12,   KC_PGUP, KC_KP_ENTER, KC_7, KC_8, KC_9, KC_BSPC},
 103   {KC_LCTL, M(M_RANDDIGIT),   KC_F5,   KC_F6,    KC_F7,   KC_F8,    KC_PGDN, KC_KP_MINUS, KC_4, KC_5, KC_6, KC_PIPE},
 104   {KC_LSFT, M(M_RANDLETTER),  KC_F1,   KC_F2,    KC_F3,   KC_F4,    KC_DEL,  KC_KP_PLUS,  KC_1, KC_2,  KC_3, KC_ENTER},
 105   {BL_STEP, M(M_LED), KC_LALT, KC_LGUI, KC_NO, KC_SPC,  KC_SPC,  DF(_QW),   KC_LEFT, KC_DOWN, KC_UP,  KC_RIGHT}
 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 /* lots of prime numbers everywhere... */
 114 static uint16_t random_value = 157;
 115
 116 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 117 {
 118   uint8_t clockbyte=0;
 119   clockbyte = TCNT1 % 256;
 120   uint8_t rval;
 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       SEND_STRING("cbbrowne");
 136     }
 137     break;
 138   case M_RANDDIGIT:
 139     /* Generate, based on random number generator, a keystroke for
 140        a numeric digit chosen at random */
 141     random_value = ((random_value + randadd) * randmul) % randmod;
 142     if (record->event.pressed) {
 143       /* Here, we mix the LCRNG with low bits from one of the system
 144          clocks via XOR in the theory that this may be more random
 145          than either separately */
 146       rval = (random_value ^ clockbyte) % 10;
 147       /* Note that KC_1 thru KC_0 are a contiguous range */
 148       register_code (KC_1 + rval);
 149       unregister_code (KC_1 + rval);
 150     }
 151     break;
 152   case M_RANDLETTER:
 153     /* Generate, based on random number generator, a keystroke for
 154        a letter chosen at random */
 155     /* Here, we mix the LCRNG with low bits from one of the system
 156        clocks via XOR in the theory that this may be more random
 157        than either separately */
 158     random_value = ((random_value + randadd) * randmul) % randmod;
 159     if (record->event.pressed) {
 160       rval = (random_value ^ clockbyte) % 26;
 161       register_code (KC_A + rval);
 162       unregister_code (KC_A + rval);
 163     }
 164     break;
 165   }
 166   return MACRO_NONE;
 167 };