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    - I haven't got page-up/page-down, let's have that...
  66 */
  67
  68 enum layers {
  69   _QWERTY = 0,  /* Qwerty mapping */
  70   _LOWER, /* Lower layer, where top line has symbols !@#$%^&*() */
  71   _RAISE, /* Raised layer, where top line has digits 1234567890 */
  72   _KEYPAD, /* Key pad */
  73   _ADJUST, /* Special Adjust layer coming via tri-placement */
  74 };
  75
  76 enum macro_id {
  77   M_LED = 0,
  78   M_USERNAME,
  79   M_RANDDIGIT,
  80   M_RANDLETTER,
  81   M_VERSION,
  82   MACRO_UPPER,
  83   MACRO_LOWER,
  84 };
  85
  86 #define M_LOWER M(MACRO_LOWER)
  87 #define M_UPPER M(MACRO_UPPER)
  88 #define ROT_LED M(M_LED)   /* Rotate LED */
  89 #define QWERTY DF(_QWERTY)   /* Switch to QWERTY layout */
  90 #define KEYPAD DF(_KEYPAD)   /* Switch to keypad */
  91 #define USERNAME M(M_USERNAME) /* shortcut for username */
  92 #define RANDDIG M(M_RANDDIGIT)
  93 #define RANDALP M(M_RANDLETTER)
  94 #define CTLENTER MT(MOD_RCTL, KC_ENT)
  95 #define SHIFTQUOTE MT(MOD_RSFT, KC_QUOT)
  96 #define ALTRIGHT MT(MOD_LALT, KC_RGHT)
  97 #define MVERSION M(M_VERSION)
  98 #define ALTSLASH LALT(KC_SLSH)
  99
 100
 101 /* Note that Planck has dimensions 4 rows x 12 columns */
 102
 103 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 104 [_QWERTY] = { /* Qwerty */
 105   {KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
 106   {KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, CTLENTER},
 107   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SHIFTQUOTE },
 108   {KC_TAB,  KC_LALT, ROT_LED, KC_LGUI, M_LOWER, KC_SPC,  KC_SPC,  M_UPPER, KC_LEFT, KC_DOWN, KC_UP,   ALTRIGHT}
 109   /* Note that KC_SPC is recorded TWICE, so that either matrix position can activate it */
 110 },
 111 [_RAISE] = { /* RAISE */
 112   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 113   {_______, KC_4,    KC_5,    KC_6,    _______, _______, _______,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 114   {_______, KC_7,    KC_8,    KC_9,    _______, _______, _______,  QWERTY,  KEYPAD,  KEYPAD,  ALTSLASH,_______},
 115   {_______, KC_0, _______, _______, _______, _______, _______, _______, KC_PGDN, KC_HOME, KC_END,  KC_PGUP}
 116 },
 117 [_LOWER] = { /* LOWER */
 118   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 119   {_______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 120   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  QWERTY,  KEYPAD,  KEYPAD, ALTSLASH,   _______},
 121   {_______, KEYPAD, _______, _______, _______, _______, _______, _______, KC_PGDN, KC_HOME,  KC_END, KC_PGUP}
 122     },
 123 [_KEYPAD] = { /* Key Pad */
 124   {KC_ESC,  USERNAME,    MVERSION,   KC_F10,   KC_F11,  KC_F12,   KC_PGUP, KC_KP_ENTER, KC_7, KC_8, KC_9, KC_BSPC},
 125   {KC_LCTL, RANDDIG,   KC_F5,   KC_F6,    KC_F7,   KC_F8,    KC_PGDN, KC_KP_MINUS, KC_4, KC_5, KC_6, KC_PIPE},
 126   {KC_LSFT, RANDALP,   KC_F1,   KC_F2,    KC_F3,   KC_F4,    KC_DEL,  KC_KP_PLUS,  KC_1, KC_2,  KC_3, KC_ENTER},
 127   {KC_TAB,  KC_LALT, ROT_LED, KC_LGUI,  M_LOWER,  KC_SPC,    KC_SPC,  QWERTY,   KC_LEFT, KC_DOWN, KC_UP,  KC_RIGHT}
 128 },
 129
 130 [_ADJUST] = { /* Adjustments - gonna shift the wild tools in here */
 131   {ROT_LED,USERNAME,MVERSION, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
 132   {_______, RANDDIG, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
 133   {_______, RANDALP, _______, _______, _______,   RESET,   RESET, _______, _______, _______, _______, _______ },
 134   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ }
 135 }
 136 };
 137
 138 /* What is fn_actions actually used for??? */
 139 const uint16_t PROGMEM fn_actions[] = {
 140 };
 141
 142 /* This bit of logic seeds a wee linear congruential random number generator */
 143 /* lots of prime numbers everywhere... */
 144 static uint16_t random_value = 157;
 145
 146 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 147 {
 148   uint8_t clockbyte=0;
 149   clockbyte = TCNT1 % 256;
 150   uint8_t rval;
 151   // MACRODOWN only works in this function
 152   switch(id) {
 153   case M_LED:
 154     if (record->event.pressed) {
 155       register_code(KC_RSFT);
 156 #ifdef BACKLIGHT_ENABLE
 157       backlight_step();
 158 #endif
 159     } else {
 160       unregister_code(KC_RSFT);
 161     }
 162     break;
 163   case M_USERNAME:
 164     if (record->event.pressed) {
 165       SEND_STRING("cbbrowne");
 166     }
 167     break;
 168   case M_VERSION:
 169     if (record->event.pressed) {
 170       SEND_STRING(QMK_KEYBOARD "/" QMK_KEYMAP "@" QMK_VERSION "@" QMK_BUILDDATE);
 171     }
 172     break;
 173   case M_RANDDIGIT:
 174     /* Generate, based on random number generator, a keystroke for
 175        a numeric digit chosen at random */
 176     random_value = ((random_value + randadd) * randmul) % randmod;
 177     if (record->event.pressed) {
 178       /* Here, we mix the LCRNG with low bits from one of the system
 179          clocks via XOR in the theory that this may be more random
 180          than either separately */
 181       rval = (random_value ^ clockbyte) % 10;
 182       /* Note that KC_1 thru KC_0 are a contiguous range */
 183       register_code (KC_1 + rval);
 184       unregister_code (KC_1 + rval);
 185     }
 186     break;
 187   case M_RANDLETTER:
 188     /* Generate, based on random number generator, a keystroke for
 189        a letter chosen at random */
 190     /* Here, we mix the LCRNG with low bits from one of the system
 191        clocks via XOR in the theory that this may be more random
 192        than either separately */
 193     random_value = ((random_value + randadd) * randmul) % randmod;
 194     if (record->event.pressed) {
 195       rval = (random_value ^ clockbyte) % 26;
 196       register_code (KC_A + rval);
 197       unregister_code (KC_A + rval);
 198     }
 199     break;
 200   case MACRO_UPPER:
 201     if (record->event.pressed)
 202       {
 203         layer_on(_RAISE);
 204 #ifdef BACKLIGHT_ENABLE
 205         breathing_speed_set(2);
 206         breathing_pulse();
 207 #endif
 208         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 209       }
 210     else
 211       {
 212         layer_off(_RAISE);
 213         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 214       }
 215     break;
 216   case MACRO_LOWER:
 217     if (record->event.pressed)
 218       {
 219         layer_on(_LOWER);
 220 #ifdef BACKLIGHT_ENABLE
 221         breathing_speed_set(2);
 222         breathing_pulse();
 223 #endif
 224         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 225       }
 226     else
 227       {
 228         layer_off(_LOWER);
 229         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 230       }
 231     break;
 232
 233   }
 234   return MACRO_NONE;
 235 };