keyboards/ergodox/keymaps/osx_whiskey_tango_foxtrot_capslock/keymap.c

   1 /*
   2  * This is built out of frustration with OSX / Sierra caps lock delay.
   3  * Fake it till you make it!
   4  */
   5
   6 #include "ergodox.h"
   7 #include "debug.h"
   8 #include "action_layer.h"
   9 #include "timer.h"
  10
  11 #define BASE 0 // default layer
  12 #define SYMB 1 // symbols
  13 #define MDIA 2 // media keys
  14
  15 #define BLINK_BASE  150U // timer threshold for blinking on MDIA layer
  16
  17 typedef enum onoff_t {OFF, ON} onoff;
  18
  19 #define caps_led_on  ergodox_right_led_2_on
  20 #define caps_led_off ergodox_right_led_2_off
  21
  22 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  23 /* Keymap 0: Basic layer
  24  *
  25  * ,--------------------------------------------------.           ,--------------------------------------------------.
  26  * | Esc    |   1  |   2  |   3  |   4  |   5  |   6  |           |   `  |   7  |   8  |   9  |   0  |   -  |   =    |
  27  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  28  * | Tab    |   Q  |   W  |   E  |   R  |   T  |   [  |           |   ]  |   Y  |   U  |   I  |   O  |   P  |   \    |
  29  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  30  * | CapsL  |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   "    |
  31  * |--------+------+------+------+------+------| ~L1  |           |  ~L1 |------+------+------+------+------+--------|
  32  * | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
  33  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  34  *   | Ctrl | Opt  | Cmd  | Left | Right|                                       | Down | Up   | Ctrl | Cmd  | Opt  |
  35  *   `----------------------------------'                                       `----------------------------------'
  36  *                                        ,-------------.       ,-------------.
  37  *                                        |      | L1   |       | Alt  | Ctrl   ]
  38  *                                 ,------|------|------|       |------+--------+------.
  39  *                                 |      |      | Home |       | PgUp |        |      |
  40  *                                 |Backsp| Del  |------|       |------|  Enter | Spc  |
  41  *                                 |      |      | End  |       | PgDn |        |      |
  42  *                                 `--------------------'       `----------------------'
  43  */
  44
  45     [BASE] = KEYMAP(  // layer 0 : default
  46         // left hand
  47         KC_ESC,     KC_1,     KC_2,    KC_3,    KC_4,    KC_5,    KC_6,
  48         KC_TAB,     M(KC_Q),  M(KC_W), M(KC_E), M(KC_R), M(KC_T), KC_LBRC,
  49         M(KC_CAPS), M(KC_A),  M(KC_S), M(KC_D), M(KC_F), M(KC_G),
  50         KC_LSFT,    M(KC_Z),  M(KC_X), M(KC_C), M(KC_V), M(KC_B), KC_FN0,
  51         KC_LCTL,    KC_LALT,  KC_LGUI, KC_LEFT, KC_RGHT,
  52                                                          KC_TRNS, KC_FN1,
  53                                                                   KC_HOME,
  54                                                 KC_BSPC, KC_DEL,  KC_END,
  55         // right hand
  56         KC_GRV,     KC_7,     KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,
  57         KC_RBRC,    M(KC_Y),  M(KC_U), M(KC_I), M(KC_O), M(KC_P), KC_BSLS,
  58                     M(KC_H),  M(KC_J), M(KC_K), M(KC_L), KC_SCLN, KC_QUOT,
  59         KC_FN0,     M(KC_N),  M(KC_M), KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,
  60                               KC_DOWN, KC_UP,   KC_RCTL, KC_RGUI, KC_RALT,
  61         KC_RALT,    KC_RCTL,
  62         KC_PGUP,
  63         KC_PGDN,    KC_ENT,   KC_SPC
  64     ),
  65 /* Keymap 1: Symbol Layer
  66  *
  67  * ,--------------------------------------------------.           ,--------------------------------------------------.
  68  * |   `    |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |           |      |  F7  |  F8  |  F9  |  F10 |  F11 |   F12  |
  69  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  70  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
  71  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  72  * |        |      |      |      |      |      |------|           |------|      |      |      |      |      |        |
  73  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  74  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
  75  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  76  *   |      |      |      |      |      |                                       |      |      |      |      |      |
  77  *   `----------------------------------'                                       `----------------------------------'
  78  *                                        ,-------------.       ,-------------.
  79  *                                        |   L0 |  L2  |       |      |      |
  80  *                                 ,------|------|------|       |------+------+------.
  81  *                                 |      |      |      |       |      |      |      |
  82  *                                 |      |      |------|       |------|      |      |
  83  *                                 |      |      |      |       |      |      |      |
  84  *                                 `--------------------'       `--------------------'
  85  */
  86 // SYMBOLS
  87     [SYMB] = KEYMAP(
  88        // left hand
  89        KC_GRV ,KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_F6,
  90        KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
  91        KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
  92        KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
  93                KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
  94                                                KC_FN3, KC_FN2,
  95                                                        KC_TRNS,
  96                                        KC_TRNS,KC_TRNS,KC_TRNS,
  97        // right hand
  98        KC_TRNS, KC_F7,   KC_F8,  KC_F9,   KC_F10,  KC_F11,  KC_F12,
  99        KC_TRNS, KC_TRNS, KC_TRNS,KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 100                 KC_TRNS, KC_TRNS,KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 101        KC_TRNS, KC_TRNS, KC_TRNS,KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 102                          KC_TRNS,KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 103        KC_TRNS, KC_TRNS,
 104        KC_TRNS,
 105        KC_TRNS, KC_TRNS, KC_TRNS
 106     ),
 107 /* Keymap 2: Media and tenkey
 108  *
 109  * ,--------------------------------------------------.           ,--------------------------------------------------.
 110  * |  BOOTL |      | Mute | Vol- | Vol+ | F14  | F15  |           |      |      | NumLk|   /  |  *   |  -   |        |
 111  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 112  * |        |      |      |      |      |      |      |           |      |      |  7   |  8   |  9   |  +   |        |
 113  * |--------+------+------+------+------+------|      |           |      |------+-----+-------+------+------+--------|
 114  * |        |      |      |      |      |      |------|           |------|      |  4   |  5   |  6   |  +   |        |
 115  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 116  * |        |      |      |      |      |      |      |           |      |      |  1   |  2   |  3   | Enter|        |
 117  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 118  *   |      |      |      |      |      |                                       |  0   |  0   |  .   | Enter|      |
 119  *   `----------------------------------'                                       `----------------------------------'
 120  *                                        ,-------------.       ,-------------.
 121  *                                        |  L1  |      |       |      |      |
 122  *                                 ,------|------|------|       |------+------+------.
 123  *                                 |      |      |      |       |      |      |      |
 124  *                                 |      |      |------|       |------|      |      |
 125  *                                 |      |      |      |       |      |      |      |
 126  *                                 `--------------------'       `--------------------'
 127  */
 128     // MEDIA AND TENKEY
 129     [MDIA] = KEYMAP(
 130        KC_NO,   KC_NO,   KC_MUTE, KC_VOLD, KC_VOLU, KC_F14,  KC_F15,
 131        KC_TRNS, KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 132        KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 133        KC_TRNS, KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 134        KC_TRNS, KC_TRNS, KC_TRNS, KC_NO,   KC_NO,
 135                                                     KC_FN4,  KC_NO,
 136                                                              KC_TRNS,
 137                                            KC_TRNS, KC_TRNS, KC_TRNS,
 138        // right hand
 139        KC_NO,   KC_NO,   KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS, KC_NO,
 140        KC_NO,   KC_NO,   KC_P7,   KC_P8,   KC_P9,   KC_PPLS, KC_NO,
 141                 KC_NO,   KC_P4,   KC_P5,   KC_P6,   KC_PPLS, KC_NO,
 142        KC_NO,   KC_NO,   KC_P1,   KC_P2,   KC_P3,   KC_PENT, KC_NO,
 143                          KC_P0,   KC_P0,   KC_PDOT, KC_PENT, KC_NO,
 144        KC_NO,   KC_NO,
 145        KC_TRNS,
 146        KC_TRNS, KC_TRNS, KC_TRNS
 147     ),
 148 };
 149
 150 const uint16_t PROGMEM fn_actions[] = {
 151     ACTION_LAYER_MOMENTARY(SYMB),               // FN0 - Momentary Layer 1 (Symbols)
 152     ACTION_LAYER_ON(SYMB,ON_RELEASE),           // FN1 - Enable Layer 1 (Symbols)
 153     ACTION_LAYER_ON(MDIA,ON_RELEASE),           // FN2 - Enable Layer 2 (Media)
 154     ACTION_LAYER_OFF(SYMB,ON_RELEASE),          // FN3 - Disable Layer 1 (Symbols)
 155     ACTION_LAYER_OFF(MDIA,ON_RELEASE),          // FN4 - Disable Layer 2 (MMedia)
 156     ACTION_LAYER_MOMENTARY(MDIA)                // FN5 - Momentary Layer 2 (Mdia)
 157 };
 158
 159
 160 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 161     static onoff caps_state = OFF;
 162     switch(id) {
 163     case KC_CAPS:
 164         if (record->event.pressed) {
 165             // Toggle caps state;
 166             if (caps_state == OFF) {
 167                 // Turn it on then!
 168                 caps_led_on();
 169                 caps_state = ON;
 170             } else {
 171                 caps_led_off();
 172                 caps_state = OFF;
 173             }
 174         }
 175         break;
 176     default:
 177         if (record->event.pressed) {
 178             bool shifted = false;
 179             if (caps_state == ON && get_mods() == 0) {
 180                 register_code(KC_LSFT);
 181                 shifted = true;
 182             }
 183             register_code(id);
 184             if(shifted) {
 185                 unregister_code(KC_LSFT);
 186             }
 187         } else {
 188             unregister_code(id);
 189         }
 190         break;
 191     }
 192     return MACRO_NONE;
 193 };
 194
 195 // Runs just one time when the keyboard initializes.
 196 void matrix_init_user(void) {
 197
 198 }
 199 // Runs constantly in the background, in a loop.
 200 void matrix_scan_user(void) {
 201     uint8_t layer = biton32(layer_state);
 202
 203     static onoff board_led_state = OFF;
 204     static uint16_t dt = 0;
 205     static uint8_t oldlayer = 0;
 206
 207     if(oldlayer != layer) {
 208         // Layer was just toggled.
 209         if(layer == BASE) {
 210             ergodox_board_led_off();
 211             board_led_state = OFF;
 212         } else {
 213             ergodox_board_led_on();
 214             board_led_state = ON;
 215         }
 216     } else if (layer >= MDIA) {
 217         // We need to do blinking.
 218         if(timer_elapsed(dt) > BLINK_BASE) {
 219             // toggle
 220             dt = timer_read();
 221             if(board_led_state == OFF) {
 222                 ergodox_board_led_on();
 223                 board_led_state = ON;
 224             } else {
 225                 ergodox_board_led_off();
 226                 board_led_state = OFF;
 227             }
 228         }
 229     }
 230     oldlayer = layer;
 231 }