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   _QWERTY = 0,  /* Qwerty mapping */
  69   _LOWER, /* Lower layer, where top line has symbols !@#$%^&*() */
  70   _RAISE, /* Raised layer, where top line has digits 1234567890 */
  71   _KEYPAD, /* Key pad */
  72   _ADJUST, /* Special Adjust layer coming via tri-placement */
  73 };
  74
  75 enum macro_id {
  76   M_LED = 0,
  77   M_USERNAME,
  78   M_RANDDIGIT,
  79   M_RANDLETTER,
  80   M_VERSION,
  81   MACRO_UPPER,
  82   MACRO_LOWER,
  83 };
  84
  85 #define M_LOWER M(MACRO_LOWER)
  86 #define M_UPPER M(MACRO_UPPER)
  87
  88 /* Note that Planck has dimensions 4 rows x 12 columns */
  89
  90 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  91 [_QWERTY] = { /* 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, MT(MOD_RSFT, 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, M_LOWER, KC_SPC,  KC_SPC,  M_UPPER, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  96   /* Note that KC_SPC is recorded TWICE, so that either matrix position can activate it */
  97 },
  98 [_RAISE] = { /* RAISE */
  99   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 100   {_______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 101   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  DF(_QWERTY), DF(_KEYPAD), DF(_KEYPAD), RESET,   _______},
 102   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 103 },
 104 [_LOWER] = { /* LOWER */
 105   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 106   {_______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 107   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  DF(_QWERTY), DF(_KEYPAD), DF(_KEYPAD), RESET,   _______},
 108   {_______, DF(_KEYPAD), _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 109 },
 110 [_KEYPAD] = { /* Key Pad */
 111   {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},
 112   {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},
 113   {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},
 114   {BL_STEP, M(M_LED), KC_LALT, KC_LGUI, KC_NO, KC_SPC,  KC_SPC,  DF(_QWERTY),   KC_LEFT, KC_DOWN, KC_UP,  KC_RIGHT}
 115 },
 116
 117 [_ADJUST] = { /* Adjustments - gonna shift the wild tools in here */
 118   { M(M_LED), _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
 119   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
 120   {_______, _______, _______, _______, _______,   RESET,   RESET, _______, _______, _______, _______, _______ },
 121   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ }
 122 }
 123 };
 124
 125 /* What is fn_actions actually used for??? */
 126 const uint16_t PROGMEM fn_actions[] = {
 127 };
 128
 129 /* This bit of logic seeds a wee linear congruential random number generator */
 130 /* lots of prime numbers everywhere... */
 131 static uint16_t random_value = 157;
 132
 133 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 134 {
 135   uint8_t clockbyte=0;
 136   clockbyte = TCNT1 % 256;
 137   uint8_t rval;
 138   // MACRODOWN only works in this function
 139   switch(id) {
 140   case M_LED:
 141     if (record->event.pressed) {
 142       register_code(KC_RSFT);
 143 #ifdef BACKLIGHT_ENABLE
 144       backlight_step();
 145 #endif
 146     } else {
 147       unregister_code(KC_RSFT);
 148     }
 149     break;
 150   case M_USERNAME:
 151     if (record->event.pressed) {
 152       SEND_STRING("cbbrowne");
 153     }
 154     break;
 155   case M_VERSION:
 156     if (record->event.pressed) {
 157       SEND_STRING(QMK_KEYBOARD "/" QMK_KEYMAP "@" QMK_VERSION "@" QMK_BUILDDATE);
 158     }
 159     break;
 160   case M_RANDDIGIT:
 161     /* Generate, based on random number generator, a keystroke for
 162        a numeric digit chosen at random */
 163     random_value = ((random_value + randadd) * randmul) % randmod;
 164     if (record->event.pressed) {
 165       /* Here, we mix the LCRNG with low bits from one of the system
 166          clocks via XOR in the theory that this may be more random
 167          than either separately */
 168       rval = (random_value ^ clockbyte) % 10;
 169       /* Note that KC_1 thru KC_0 are a contiguous range */
 170       register_code (KC_1 + rval);
 171       unregister_code (KC_1 + rval);
 172     }
 173     break;
 174   case M_RANDLETTER:
 175     /* Generate, based on random number generator, a keystroke for
 176        a letter chosen at random */
 177     /* Here, we mix the LCRNG with low bits from one of the system
 178        clocks via XOR in the theory that this may be more random
 179        than either separately */
 180     random_value = ((random_value + randadd) * randmul) % randmod;
 181     if (record->event.pressed) {
 182       rval = (random_value ^ clockbyte) % 26;
 183       register_code (KC_A + rval);
 184       unregister_code (KC_A + rval);
 185     }
 186     break;
 187   case MACRO_UPPER:
 188     if (record->event.pressed)
 189       {
 190         layer_on(_RAISE);
 191         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 192       }
 193     else
 194       {
 195         layer_off(_RAISE);
 196         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 197       }
 198     break;
 199   case MACRO_LOWER:
 200     if (record->event.pressed)
 201       {
 202         layer_on(_LOWER);
 203         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 204       }
 205     else
 206       {
 207         layer_off(_LOWER);
 208         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 209       }
 210     break;
 211
 212   }
 213   return MACRO_NONE;
 214 };