keyboards/planck/keymaps/cbbrowne/keymap.c

   1 #include "planck.h"
   2 #ifdef BACKLIGHT_ENABLE
   3   #include "backlight.h"
   4 #endif
   5 #include "config.h"
   6 #include "quantum.h"
   7 #include "version.h"
   8
   9 /* Each layer is given a name to aid in readability, which is then
  10    used in the keymap matrix below.  The underscores do not denote
  11    anything - you can have a layer called STUFF or any other name.
  12
  13    Layer names don't all need to be of the same length, obviously, and
  14    you could also skip them entirely and just use numbers, though that
  15    means needing to manage the numbers.
  16
  17    It is preferable to keep the symbols short so that a line worth of
  18    key mappings fits compactly onto a line of code. */
  19
  20 /* This was originally based on planck/keymaps/default/default.c, and
  21    then cbbrowne has revised things */
  22
  23 /* Things I did not like about the default mapping
  24
  25    - I found control too hard to get to.  I use it more than Tab, so
  26      switched it there.
  27    - Having dash on [lower-j] is a bit nonintuitive, but may be OK
  28    - I'll bet I should switch ESC/TAB
  29    - I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
  30      and shift ESC off the first column so KC_LCTL and KC_LALT can
  31      be on the first column.
  32    - I needed to swap ' and ENTER
  33
  34    - All of the above are done :-)
  35
  36    - Dropped out support for Dvorak and friends.  They aren't
  37      improvements to me
  38 */
  39
  40
  41 /* Some interesting things implemented
  42
  43    - There is a macro that writes out "cbbrowne" to show that I could
  44    - There is a (somewhat cruddy) linear congruential random number
  45      generator.
  46      - I would like to be seeding it with clock info to make it look
  47        more random
  48    - There are two macros that use the random number generators
  49      - one, M_RANDDIGIT, generates a random digit based on state
  50        of the random number generator
  51      - the other, M_RANDLETTER, generates a random letter based on state
  52        of the random number generator
  53      - in both, note the use of register_code()/unregister_code()
  54        to indicate the desired key
  55    - I do indeed want a sweet number pad!
  56 */
  57
  58 /* Other things to do...
  59
  60    - Need to think about what zsh and readline actions I use lots
  61    - Ought to ensure that Control-Alt-Delete is convenient enough
  62    - How about Alt-F1 thru Alt-F8?
  63    - What's the keystroke to get from X to console these days?
  64    - A layer for doing console switching would not be a bad idea
  65 */
  66
  67 enum layers {
  68   _QW = 0,  /* Qwerty mapping */
  69   _LW, /* Lower layer, where top line has symbols !@#$%^&*() */
  70   _RS, /* Raised layer, where top line has digits 1234567890 */
  71   _KP, /* Key pad */
  72 };
  73
  74 enum macro_id {
  75   M_LED = 0,
  76   M_USERNAME,
  77   M_RANDDIGIT,
  78   M_RANDLETTER,
  79   M_VERSION
  80 };
  81
  82 /* Note that Planck has dimensions 4 rows x 12 columns */
  83
  84 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  85 [_QW] = { /* Qwerty */
  86   {KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  87   {KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT},
  88   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_QUOT },
  89   {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}
  90 },
  91 [_RS] = { /* RAISE */
  92   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
  93   {KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
  94   {KC_TRNS, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  DF(_QW), DF(_KP), DF(_KP), RESET,   KC_TRNS},
  95   {KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  96 },
  97 [_LW] = { /* LOWER */
  98   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
  99   {KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 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, DF(_KP), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 102 },
 103 [_KP] = { /* Key Pad */
 104   {KC_ESC,  M(M_USERNAME),    M(M_VERSION),   KC_F10,   KC_F11,  KC_F12,   KC_PGUP, KC_KP_ENTER, KC_7, KC_8, KC_9, KC_BSPC},
 105   {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},
 106   {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},
 107   {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}
 108 }
 109 };
 110
 111 const uint16_t PROGMEM fn_actions[] = {
 112 };
 113
 114 /* This bit of logic seeds a wee linear congruential random number generator */
 115 /* lots of prime numbers everywhere... */
 116 static uint16_t random_value = 157;
 117
 118 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 119 {
 120   uint8_t clockbyte=0;
 121   clockbyte = TCNT1 % 256;
 122   uint8_t rval;
 123   // MACRODOWN only works in this function
 124   switch(id) {
 125   case M_LED:
 126     if (record->event.pressed) {
 127       register_code(KC_RSFT);
 128 #ifdef BACKLIGHT_ENABLE
 129       backlight_step();
 130 #endif
 131     } else {
 132       unregister_code(KC_RSFT);
 133     }
 134     break;
 135   case M_USERNAME:
 136     if (record->event.pressed) {
 137       SEND_STRING("cbbrowne");
 138     }
 139     break;
 140   case M_VERSION:
 141     if (record->event.pressed) {
 142       SEND_STRING(QMK_KEYBOARD "/" QMK_KEYMAP "@" QMK_VERSION "@" QMK_BUILDDATE);
 143     }
 144     break;
 145   case M_RANDDIGIT:
 146     /* Generate, based on random number generator, a keystroke for
 147        a numeric digit chosen at random */
 148     random_value = ((random_value + randadd) * randmul) % randmod;
 149     if (record->event.pressed) {
 150       /* Here, we mix the LCRNG with low bits from one of the system
 151          clocks via XOR in the theory that this may be more random
 152          than either separately */
 153       rval = (random_value ^ clockbyte) % 10;
 154       /* Note that KC_1 thru KC_0 are a contiguous range */
 155       register_code (KC_1 + rval);
 156       unregister_code (KC_1 + rval);
 157     }
 158     break;
 159   case M_RANDLETTER:
 160     /* Generate, based on random number generator, a keystroke for
 161        a letter chosen at random */
 162     /* Here, we mix the LCRNG with low bits from one of the system
 163        clocks via XOR in the theory that this may be more random
 164        than either separately */
 165     random_value = ((random_value + randadd) * randmul) % randmod;
 166     if (record->event.pressed) {
 167       rval = (random_value ^ clockbyte) % 26;
 168       register_code (KC_A + rval);
 169       unregister_code (KC_A + rval);
 170     }
 171     break;
 172   }
 173   return MACRO_NONE;
 174 };