keyboards/xd75/keymaps/cbbrowne/keymap.c

   1 /* Copyright 2017 Christopher B Browne
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #include "xd75.h"
  17
  18 /* Fillers to make layering more clear */
  19 #define ___T___ KC_TRNS
  20
  21 /* Layer shorthand */
  22
  23 enum layers {
  24   _QWERTY = 0,  /* Qwerty mapping */
  25   _LOWER, /* Lower layer, where top line has symbols !@#$%^&*() */
  26   _RAISE, /* Raised layer, where top line has digits 1234567890 */
  27   _ADJUST, /* Special Adjust layer coming via tri-placement */
  28   _FUNCTION /* Function key layer */
  29 };
  30
  31
  32 /* Macros need to be uniquely identified; using an enum to do this
  33    automatically
  34  */
  35
  36 enum macro_id {
  37   M_LED = 0,
  38   M_USERNAME,
  39   M_RANDDIGIT,
  40   M_RANDLETTER,
  41   M_VERSION,
  42   MACRO_UPPER,
  43   MACRO_LOWER,
  44 };
  45
  46 /* I want some short forms for keycodes so that they fit into
  47    limited-width cells */
  48
  49 #define M_LOWER M(MACRO_LOWER)
  50 #define M_UPPER M(MACRO_UPPER)
  51 #define ROT_LED M(M_LED)   /* Rotate LED */
  52 #define QWERTY DF(_QWERTY)   /* Switch to QWERTY layout */
  53 #define QCENT2 DF(_QCENT2)   /* Switch to QWERTY-with-centre layout */
  54 #define USERNAME M(M_USERNAME) /* shortcut for username */
  55 #define RANDDIG M(M_RANDDIGIT)
  56 #define RANDALP M(M_RANDLETTER)
  57 #define CTLENTER MT(MOD_RCTL, KC_ENT)
  58 #define SHIFTQUOTE MT(MOD_RSFT, KC_QUOT)
  59 #define ALTRIGHT MT(MOD_LALT, KC_RGHT)
  60 #define MVERSION M(M_VERSION)
  61 #define ALTSLASH LALT(KC_SLSH)
  62 #define FUNCTION MO(_FUNCTION)
  63 #define MRAISE MO(_RAISE)
  64 #define MLOWER MO(_LOWER)
  65 #define ALTPLUS ALT_T(KC_PLUS)
  66
  67 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  68
  69 /* QWERTY - MIT ENHANCED / GRID COMPATIBLE
  70  * .---------------------------------------------------------------------------------------------------------------------- 2u ------------.
  71  * | `      | 1      | 2      | 3      | 4      | 5      | 6      | 7      | 8      | 9      | 0      | -      | =      | XXXXXX . BACKSP |
  72  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
  73  * | TAB    | Q      | W      | E      | R      | T      | Y      | U      | I      | O      | P      | [      | ]      | \      | DEL    |
  74  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
  75  * | ESC    | A      | S      | D      | F      | G      | H      | J      | K      | L      | ;      | '      | XXXXXX . ENTER  | PG UP  |
  76  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
  77  * | LSHIFT | Z      | X      | C      | V      | B      | N      | M      | ,      | .      | /      | XXXXXX . RSHIFT | UP     | PG DN  |
  78  * |--------+--------+--------+--------+--------+- 2u ------------+--------+--------+--------+--------+-----------------+--------+--------|
  79  * | BRITE  | LCTRL  | LALT   | LGUI   | RAISE  | XXXXXX . SPACE  | LOWER  | RGUI   | RALT   | RCTRL  | FN     | LEFT   | DOWN   | RIGHT  |
  80  * '--------------------------------------------------------------------------------------------------------------------------------------'
  81  */
  82
  83   /* layout for centred keypad + qwerty...
  84
  85 |ESC| 1 | 2 | 3 | 4 | 5 | ? | ? | ? | ? | 6 | 7 | 8 | 9 | 0 |
  86 |TAB| q | w | e | r | t | ? | ? | ? | ? | y | u | i | o | p |
  87 |CTL| a | s | d | f | g | ? | ? | ? | ? | h | j | k | l | ; |
  88 |SHF| z | x | c | v | b | ? | ? | ? | ? | n | m | , | . | / |
  89 |ALT|LED|   |   |   |   |   |   |   |   |   |   |   |   |   |
  90
  91
  92 keys needing to be assigned:
  93 51 - KC_TAB - tab
  94    - ROT_LED - rotate LED
  95 15 - KC_LALT - Left ALT
  96 53,55 - M_RAISE - switch to RAISE layer
  97 5b - M_LOWER - switch to LOWER layer
  98 56,59,5a   - KC_SPC - space
  99 5c - KC_LEFT - famous arrows
 100 5d - KC_DOWN - famous arrows
 101 5e - KC_UP - famous arrows
 102 5f - KC_RIGHT - famous arrows
 103 3f - KC_ENT - enter
 104    - KC_GRV - leftwards quote
 105 4f - KC_QUOT - rightwards quote
 106 1f - KC_BSPC - backspace
 107 11 - KC_ESC
 108 19 - KC_GRV - ` - raised
 109 19 - KC_TILD - ~ - lowered
 110
 111   */
 112
 113 [_QWERTY] = LAYOUT_ortho_5x15( /* QWERTY, with keypad in the centre */
 114       KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,   KC_EQL, KC_MINS, KC_EQL,   KC_6,    KC_7,    KC_8,    KC_9,    KC_0, KC_BSPC ,
 115       KC_LALT, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,   KC_7,    KC_8,   KC_EQL,  KC_Y,    KC_U,    KC_I,    KC_O,    KC_P, ALTPLUS ,
 116       KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,   KC_LBRC, KC_RBRC,KC_MINS, KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, CTLENTER ,
 117       KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,   KC_PGUP, KC_EQL,   KC_BSLS, KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SHIFTQUOTE ,
 118        KC_TAB,  FUNCTION, MRAISE,  FUNCTION, MRAISE, KC_SPC,KC_PGDN,  KC_MINS, KC_SPC, KC_SPC,  MLOWER, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
 119 ),
 120
 121 /* LOWER
 122  * .---------------------------------------------------------------------------------------------------------------------- 2u ------------.
 123  * |        | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    | F11    | F12    | XXXXXX .        |
 124  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 125  * |        | !      | @      | #      | $      | %      | ^      | &      | *      | (      | )      |        |        |        | INS    |
 126  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
 127  * |        | F1     | F2     | F3     | F4     | F5     | F6     | _      | +      | {      | }      | |      | XXXXXX .        |        |
 128  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
 129  * |        | F7     | F8     | F9     | F10    | F11    | F12    |        |        |        |        | XXXXXX .        |        |        |
 130  * |--------+--------+--------+--------+--------+- 2u ------------+--------+--------+--------+--------+-----------------+--------+--------|
 131  * |        |        |        |        |        | XXXXXX .        |        |        |        |        |        |        |        |        |
 132  * '--------------------------------------------------------------------------------------------------------------------------------------'
 133  */
 134
 135 [_LOWER] = LAYOUT_ortho_5x15( /* LOWERED */
 136     ___T___, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,  _______, _______, KC_TILD,  KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11 ,
 137     ___T___, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, _______, _______, _______, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_INS  ,
 138     ___T___, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,  _______, _______, _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE ,
 139     _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______, ___T___, ___T___, _______ ,
 140     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
 141  ),
 142
 143 /* RAISED
 144  * .---------------------------------------------------------------------------------------------------------------------- 2u ------------.
 145  * |        | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    | F11    | F12    | XXXXXX .        |
 146  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 147  * |        | 1      | 2      | 3      | 4      | 5      | 6      | 7      | 8      | 9      | 0      |        |        |        | INS    |
 148  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
 149  * |        | F1     | F2     | F3     | F4     | F5     | F6     | -      | =      | [      | ]      | \      | XXXXXX .        |        |
 150  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
 151  * |        | F7     | F8     | F9     | F10    | F11    | F12    |        |        |        |        | XXXXXX .        |        |        |
 152  * |--------+--------+--------+--------+--------+- 2u ------------+--------+--------+--------+--------+-----------------+--------+--------|
 153  * |        |        |        |        |        | XXXXXX .        |        |        |        |        |        |        |        |        |
 154  * '--------------------------------------------------------------------------------------------------------------------------------------'
 155  */
 156
 157 [_RAISE] = LAYOUT_ortho_5x15 ( /* RAISED */
 158    KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,  MVERSION, _______, KC_GRV,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  ___T___ ,
 159    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,   USERNAME, _______, KC_7,    KC_8,    KC_LCBR, KC_RCBR,    _______, _______, KC_INS   ,
 160    KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   RANDDIG, _______, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS, ___T___, ___T___ ,
 161    KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  RANDALP, _______, _______, _______, _______, ___T___, ___T___, _______, _______  ,
 162    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
 163 ),
 164
 165 /* FUNCTION
 166  * .---------------------------------------------------------------------------------------------------------------------- 2u ------------.
 167  * | NUM LK | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    | F11    | F12    | XXXXXX .        |
 168  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 169  * | SCR LK | F13    | F14    | F15    | F16    | F17    | F18    | F19    | F20    | F21    | F22    | F23    | F24    | PAUSE  | PR SCR |
 170  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
 171  * | CAP LK | MS BT5 | MS BT4 | MS BT3 | MS BT2 | SLOW M | FAST M | NEXT   | VOL+   | VOL-   | PLAY   |        | XXXXXX |        | WHEEL+ |
 172  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
 173  * | RGB TG | RGB MD | RGB HI | RGB HD | RGB SI | RGB SD | RGB VI | RGB VD | BL TOG | BL INC | BL DEC | XXXXXX |        | MOUS U | WHEEL- |
 174  * |--------+--------+--------+--------+--------+-- 2u -----------+--------+--------+--------+--------+-----------------+--------+--------|
 175  * | RESET  |        | QWERTY | COLEMK | DVORAK | XXXXXX . MS BT1 |        |        |        |        |        | MOUS L | MOUS D | MOUS R |
 176  * '--------------------------------------------------------------------------------------------------------------------------------------'
 177  */
 178
 179 [_FUNCTION] = LAYOUT_ortho_5x15( /* FUNCTION */
 180    KC_NLCK, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  RESET, RESET,
 181    KC_SLCK, KC_F13,  KC_F14,  KC_F15,  KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20,  KC_F21,  KC_F22,  KC_F23,  KC_F24,  KC_PAUS, KC_PSCR  ,
 182    KC_CAPS, KC_BTN5, KC_BTN4, KC_BTN3, KC_BTN2, KC_ACL0, KC_ACL2, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY, _______, ___T___, ___T___, KC_WH_U  ,
 183    RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, BL_TOGG, BL_INC,  BL_DEC,   ___T___, ___T___, KC_MS_U, KC_WH_D  ,
 184    RESET  , _______, DF(_QWERTY), DF(_QWERTY), DF(_QWERTY), KC_BTN1, KC_BTN1, _______, _______, _______, _______, _______, KC_MS_L, KC_MS_D, KC_MS_R
 185  )
 186 };
 187
 188 /* This bit of logic seeds a wee linear congruential random number generator */
 189 /* lots of prime numbers everywhere... */
 190 static uint16_t random_value = 157;
 191
 192 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 193 {
 194   uint8_t clockbyte=0;
 195   clockbyte = TCNT1 % 256;
 196   uint8_t rval;
 197   /* MACRODOWN only works in this function */
 198   switch(id) {
 199   case 0:
 200     if (record->event.pressed) {
 201       register_code(KC_RSFT);
 202 #ifdef BACKLIGHT_ENABLE
 203       backlight_step();
 204 #endif
 205     } else {
 206       unregister_code(KC_RSFT);
 207     }
 208     break;
 209   case M_USERNAME:
 210     if (record->event.pressed) {
 211       SEND_STRING("cbbrowne");
 212     }
 213     break;
 214   case M_VERSION:
 215     if (record->event.pressed) {
 216       SEND_STRING(QMK_KEYBOARD "/" QMK_KEYMAP);
 217     }
 218     break;
 219   case M_RANDDIGIT:
 220     /* Generate, based on random number generator, a keystroke for
 221        a numeric digit chosen at random */
 222     random_value = ((random_value + randadd) * randmul) % randmod;
 223     if (record->event.pressed) {
 224       /* Here, we mix the LCRNG with low bits from one of the system
 225          clocks via XOR in the theory that this may be more random
 226          than either separately */
 227       rval = (random_value ^ clockbyte) % 10;
 228       /* Note that KC_1 thru KC_0 are a contiguous range */
 229       register_code (KC_1 + rval);
 230       unregister_code (KC_1 + rval);
 231     }
 232     break;
 233   case M_RANDLETTER:
 234     /* Generate, based on random number generator, a keystroke for
 235        a letter chosen at random */
 236     /* Here, we mix the LCRNG with low bits from one of the system
 237        clocks via XOR in the theory that this may be more random
 238        than either separately */
 239     random_value = ((random_value + randadd) * randmul) % randmod;
 240     if (record->event.pressed) {
 241       rval = (random_value ^ clockbyte) % 26;
 242       register_code (KC_A + rval);
 243       unregister_code (KC_A + rval);
 244     }
 245     break;
 246   case MACRO_UPPER:
 247     if (record->event.pressed)
 248       {
 249         layer_on(_RAISE);
 250 #ifdef BACKLIGHT_ENABLE
 251         breathing_period_set(2);
 252         breathing_pulse();
 253 #endif
 254         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 255       }
 256     else
 257       {
 258         layer_off(_RAISE);
 259         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 260       }
 261     break;
 262   case MACRO_LOWER:
 263     if (record->event.pressed)
 264       {
 265         layer_on(_LOWER);
 266 #ifdef BACKLIGHT_ENABLE
 267         breathing_period_set(2);
 268         breathing_pulse();
 269 #endif
 270         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 271       }
 272     else
 273       {
 274         layer_off(_LOWER);
 275         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 276       }
 277     break;
 278   }
 279   return MACRO_NONE;
 280 };
 281
 282 void matrix_init_user(void) {
 283   rgblight_enable();
 284   rgblight_mode(1);
 285   rgblight_sethsv(325,255,255);
 286 }
 287
 288 uint32_t layer_state_set_user(uint32_t state) {
 289   switch(biton32(state)) {
 290   case _QWERTY:
 291     rgblight_sethsv_white();
 292     break;
 293   case _LOWER:
 294     rgblight_sethsv_blue();
 295     break;
 296   case _RAISE:
 297     rgblight_sethsv_green();
 298     break;
 299   case _ADJUST:
 300     rgblight_sethsv_orange();
 301     break;
 302   case _FUNCTION:
 303     rgblight_sethsv_red();
 304     break;
 305   default:
 306     rgblight_sethsv(325,255,255);
 307     break;
 308   }
 309   return state;
 310 }