keyboards/xd75/keymaps/cbbrowne/keymap.c

   1 /* Copyright 2017 REPLACE_WITH_YOUR_NAME
   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 ALTBSP ALT_T(KC_BSPC)
  66
  67 /* More modifiers for QCENT2... */
  68 #define PALT MT(KC_RALT, KC_P)
  69 #define SCTL MT(KC_RCTL, KC_SCLN)
  70 #define SSHF MT(KC_RSFT, KC_SLSH)
  71
  72 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  73
  74 /* QWERTY - MIT ENHANCED / GRID COMPATIBLE
  75  * .---------------------------------------------------------------------------------------------------------------------- 2u ------------.
  76  * | `      | 1      | 2      | 3      | 4      | 5      | 6      | 7      | 8      | 9      | 0      | -      | =      | XXXXXX . BACKSP |
  77  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
  78  * | TAB    | Q      | W      | E      | R      | T      | Y      | U      | I      | O      | P      | [      | ]      | \      | DEL    |
  79  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
  80  * | ESC    | A      | S      | D      | F      | G      | H      | J      | K      | L      | ;      | '      | XXXXXX . ENTER  | PG UP  |
  81  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
  82  * | LSHIFT | Z      | X      | C      | V      | B      | N      | M      | ,      | .      | /      | XXXXXX . RSHIFT | UP     | PG DN  |
  83  * |--------+--------+--------+--------+--------+- 2u ------------+--------+--------+--------+--------+-----------------+--------+--------|
  84  * | BRITE  | LCTRL  | LALT   | LGUI   | RAISE  | XXXXXX . SPACE  | LOWER  | RGUI   | RALT   | RCTRL  | FN     | LEFT   | DOWN   | RIGHT  |
  85  * '--------------------------------------------------------------------------------------------------------------------------------------'
  86  */
  87
  88   /* layout for centred keypad + qwerty...
  89
  90 |ESC| 1 | 2 | 3 | 4 | 5 | ? | ? | ? | ? | 6 | 7 | 8 | 9 | 0 |
  91 |TAB| q | w | e | r | t | ? | ? | ? | ? | y | u | i | o | p |
  92 |CTL| a | s | d | f | g | ? | ? | ? | ? | h | j | k | l | ; |
  93 |SHF| z | x | c | v | b | ? | ? | ? | ? | n | m | , | . | / |
  94 |ALT|LED|   |   |   |   |   |   |   |   |   |   |   |   |   |
  95
  96
  97
  98
  99 keys needing to be assigned:
 100 11 - KC_TAB - tab
 101 52 - ROT_LED - rotate LED
 102 15 - KC_LALT - Left ALT
 103    - KC_LGUI  - this is the windows/command key, which I think I do not use...
 104    - M_LOWER - switch to LOWER layer
 105    - KC_SPC - space
 106    - M_UPPER - switch to UPPER layer, maybe unneeded for 15x5
 107    - KC_LEFT - famous arrows
 108    - KC_DOWN - famous arrows
 109    - KC_UP - famous arrows
 110    - KC_RIGHT - famous arrows
 111    - KC_ENT - enter
 112    - KC_GRV - leftwards quote
 113    - KC_QUOT - rightwards quote
 114    - KC_BSPC - backspace
 115    - KC_ESC
 116
 117 Missing still...
 118    KC_LBRC and KC_LCBR
 119    KC_RBRC and KC_RCBR
 120
 121   */
 122
 123    [_QWERTY] = { /* QWERTY, with keypad in the centre */
 124      { KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,   KC_EQL, KC_MINS, RESET,   KC_6,    KC_7,    KC_8,    KC_9,    KC_0, KC_BSPC },
 125      { 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, KC_PLUS },
 126      { KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,   KC_4,    KC_5,   KC_MINS, KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, CTLENTER },
 127      { KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,   KC_1,    KC_2,   KC_BSLS, KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SHIFTQUOTE },
 128      { KC_TAB,  FUNCTION, MRAISE,  FUNCTION, MRAISE, KC_SPC,  KC_0,  KC_MINS, KC_SPC, KC_SPC,  MLOWER, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT }
 129    },
 130
 131 /* LOWER
 132  * .---------------------------------------------------------------------------------------------------------------------- 2u ------------.
 133  * |        | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    | F11    | F12    | XXXXXX .        |
 134  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 135  * |        | !      | @      | #      | $      | %      | ^      | &      | *      | (      | )      |        |        |        | INS    |
 136  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
 137  * |        | F1     | F2     | F3     | F4     | F5     | F6     | _      | +      | {      | }      | |      | XXXXXX .        |        |
 138  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
 139  * |        | F7     | F8     | F9     | F10    | F11    | F12    |        |        |        |        | XXXXXX .        |        |        |
 140  * |--------+--------+--------+--------+--------+- 2u ------------+--------+--------+--------+--------+-----------------+--------+--------|
 141  * |        |        |        |        |        | XXXXXX .        |        |        |        |        |        |        |        |        |
 142  * '--------------------------------------------------------------------------------------------------------------------------------------'
 143  */
 144
 145  [_LOWER] = { /* LOWERED */
 146    { ___T___, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,  _______, _______, _______, KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11 },
 147   { ___T___, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, _______, _______, _______, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_INS   },
 148    { ___T___, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,  _______, _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, _______ },
 149    { _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______, ___T___, ___T___, _______ },
 150   { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______  },
 151  },
 152
 153 /* RAISED
 154  * .---------------------------------------------------------------------------------------------------------------------- 2u ------------.
 155  * |        | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    | F11    | F12    | XXXXXX .        |
 156  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 157  * |        | 1      | 2      | 3      | 4      | 5      | 6      | 7      | 8      | 9      | 0      |        |        |        | INS    |
 158  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
 159  * |        | F1     | F2     | F3     | F4     | F5     | F6     | -      | =      | [      | ]      | \      | XXXXXX .        |        |
 160  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
 161  * |        | F7     | F8     | F9     | F10    | F11    | F12    |        |        |        |        | XXXXXX .        |        |        |
 162  * |--------+--------+--------+--------+--------+- 2u ------------+--------+--------+--------+--------+-----------------+--------+--------|
 163  * |        |        |        |        |        | XXXXXX .        |        |        |        |        |        |        |        |        |
 164  * '--------------------------------------------------------------------------------------------------------------------------------------'
 165  */
 166
 167  [_RAISE] = { /* RAISED */
 168   { KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   _______, _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  ___T___ },
 169   { KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    _______, _______, KC_7,    KC_8,    KC_9,    KC_0,    _______, _______, KC_INS   },
 170   { KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   _______, _______, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS, ___T___, ___T___ },
 171   { KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______, ___T___, ___T___, _______, _______  },
 172   { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______  },
 173  },
 174
 175 /* FUNCTION
 176  * .---------------------------------------------------------------------------------------------------------------------- 2u ------------.
 177  * | NUM LK | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    | F11    | F12    | XXXXXX .        |
 178  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 179  * | SCR LK | F13    | F14    | F15    | F16    | F17    | F18    | F19    | F20    | F21    | F22    | F23    | F24    | PAUSE  | PR SCR |
 180  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
 181  * | CAP LK | MS BT5 | MS BT4 | MS BT3 | MS BT2 | SLOW M | FAST M | NEXT   | VOL+   | VOL-   | PLAY   |        | XXXXXX .        | WHEEL+ |
 182  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
 183  * | RGB TG | RGB MD | RGB HI | RGB HD | RGB SI | RGB SD | RGB VI | RGB VD | BL TOG | BL INC | BL DEC | XXXXXX .        | MOUS Un | WHEEL- |
 184  * |--------+--------+--------+--------+--------+-- 2u -----------+--------+--------+--------+--------+-----------------+--------+--------|
 185  * | RESET  |        | QWERTY | COLEMK | DVORAK | XXXXXX . MS BT1 |        |        |        |        |        | MOUS L | MOUS D | MOUS R |
 186  * '--------------------------------------------------------------------------------------------------------------------------------------'
 187  */
 188
 189  [_FUNCTION] = { /* FUNCTION */
 190   { 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,  ___T___, ___T___  },
 191   { 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  },
 192   { 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  },
 193   { 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  },
 194   { RESET  , _______, DF(_QWERTY), DF(_QWERTY), DF(_QWERTY), KC_BTN1, KC_BTN1, _______, _______, _______, _______, _______, KC_MS_L, KC_MS_D, KC_MS_R  },
 195  },
 196 };
 197
 198 /* This bit of logic seeds a wee linear congruential random number generator */
 199 /* lots of prime numbers everywhere... */
 200 static uint16_t random_value = 157;
 201
 202 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 203 {
 204   uint8_t clockbyte=0;
 205   clockbyte = TCNT1 % 256;
 206   uint8_t rval;
 207   /* MACRODOWN only works in this function */
 208   switch(id) {
 209   case 0:
 210     if (record->event.pressed) {
 211       register_code(KC_RSFT);
 212 #ifdef BACKLIGHT_ENABLE
 213       backlight_step();
 214 #endif
 215     } else {
 216       unregister_code(KC_RSFT);
 217     }
 218     break;
 219   case M_USERNAME:
 220     if (record->event.pressed) {
 221       SEND_STRING("cbbrowne");
 222     }
 223     break;
 224   case M_VERSION:
 225     if (record->event.pressed) {
 226       SEND_STRING(QMK_KEYBOARD "/" QMK_KEYMAP "@");
 227       //      SEND_STRING(QMK_VERSION "@" QMK_BUILDDATE);
 228     }
 229     break;
 230   case M_RANDDIGIT:
 231     /* Generate, based on random number generator, a keystroke for
 232        a numeric digit chosen at random */
 233     random_value = ((random_value + randadd) * randmul) % randmod;
 234     if (record->event.pressed) {
 235       /* Here, we mix the LCRNG with low bits from one of the system
 236          clocks via XOR in the theory that this may be more random
 237          than either separately */
 238       rval = (random_value ^ clockbyte) % 10;
 239       /* Note that KC_1 thru KC_0 are a contiguous range */
 240       register_code (KC_1 + rval);
 241       unregister_code (KC_1 + rval);
 242     }
 243     break;
 244   case M_RANDLETTER:
 245     /* Generate, based on random number generator, a keystroke for
 246        a letter chosen at random */
 247     /* Here, we mix the LCRNG with low bits from one of the system
 248        clocks via XOR in the theory that this may be more random
 249        than either separately */
 250     random_value = ((random_value + randadd) * randmul) % randmod;
 251     if (record->event.pressed) {
 252       rval = (random_value ^ clockbyte) % 26;
 253       register_code (KC_A + rval);
 254       unregister_code (KC_A + rval);
 255     }
 256     break;
 257   case MACRO_UPPER:
 258     if (record->event.pressed)
 259       {
 260         layer_on(_RAISE);
 261 #ifdef BACKLIGHT_ENABLE
 262         breathing_period_set(2);
 263         breathing_pulse();
 264 #endif
 265         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 266       }
 267     else
 268       {
 269         layer_off(_RAISE);
 270         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 271       }
 272     break;
 273   case MACRO_LOWER:
 274     if (record->event.pressed)
 275       {
 276         layer_on(_LOWER);
 277 #ifdef BACKLIGHT_ENABLE
 278         breathing_period_set(2);
 279         breathing_pulse();
 280 #endif
 281         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 282       }
 283     else
 284       {
 285         layer_off(_LOWER);
 286         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 287       }
 288     break;
 289   }
 290   return MACRO_NONE;
 291 };