qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

keymap.c (15961B)


      1 /* Copyright 2019 Takuya Urakawa (dm9records.com)
      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 
     17 #include QMK_KEYBOARD_H
     18 
     19 
     20 enum plaid_layers {
     21   _QWERTY,
     22   _COLEMAK,
     23   _DVORAK,
     24   _LOWER,
     25   _RAISE,
     26   _PLOVER,
     27   _ADJUST
     28 };
     29 
     30 enum plaid_keycodes {
     31   PLOVER = SAFE_RANGE,
     32   EXT_PLV,
     33   LED_1,
     34   LED_2,
     35   LED_3,
     36   LED_4,
     37   LED_5,
     38   LED_6,
     39   LED_7,
     40   LED_8,
     41   LED_9,
     42   LED_0
     43 };
     44 
     45 #define LOWER MO(_LOWER)
     46 #define RAISE MO(_RAISE)
     47 
     48 #define QWERTY PDF(_QWERTY)
     49 #define COLEMAK PDF(_COLEMAK)
     50 #define DVORAK PDF(_DVORAK)
     51 
     52 // array of keys considered modifiers for led purposes
     53 const uint16_t modifiers[] = {
     54     KC_LCTL,
     55     KC_RCTL,
     56     KC_LALT,
     57     KC_RALT,
     58     KC_LSFT,
     59     KC_RSFT,
     60     KC_LGUI,
     61     KC_RGUI,
     62     LOWER,
     63     RAISE
     64 };
     65 
     66 //Setup consts for LED modes
     67 #define LEDMODE_ON 1 //always on
     68 #define LEDMODE_OFF 0 //always off
     69 #define LEDMODE_MODS 2 //On with modifiers
     70 #define LEDMODE_BLINKIN 3 //blinkinlights - % chance toggle on keypress
     71 #define LEDMODE_KEY 4 //On with any keypress, off with key release
     72 #define LEDMODE_ENTER 5 // On with enter key
     73 
     74 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     75 
     76 /* Qwerty
     77  * ,-----------------------------------------------------------------------------------.
     78  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
     79  * |------+------+------+------+------+-------------+------+------+------+------+------|
     80  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
     81  * |------+------+------+------+------+------|------+------+------+------+------+------|
     82  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
     83  * |------+------+------+------+------+------+------+------+------+------+------+------|
     84  * | Ctrl | RAlt | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
     85  * `-----------------------------------------------------------------------------------'
     86  */
     87 [_QWERTY] = LAYOUT_ortho_4x12(
     88     KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
     89     KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
     90     KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT ,
     91     KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
     92 ),
     93 
     94 /* Colemak
     95  * ,-----------------------------------------------------------------------------------.
     96  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
     97  * |------+------+------+------+------+-------------+------+------+------+------+------|
     98  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
     99  * |------+------+------+------+------+------|------+------+------+------+------+------|
    100  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
    101  * |------+------+------+------+------+------+------+------+------+------+------+------|
    102  * | Ctrl | RAlt | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
    103  * `-----------------------------------------------------------------------------------'
    104  */
    105 [_COLEMAK] = LAYOUT_ortho_4x12(
    106     KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC,
    107     KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT,
    108     KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT ,
    109     KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
    110 ),
    111 
    112 /* Dvorak
    113  * ,-----------------------------------------------------------------------------------.
    114  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
    115  * |------+------+------+------+------+-------------+------+------+------+------+------|
    116  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
    117  * |------+------+------+------+------+------|------+------+------+------+------+------|
    118  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
    119  * |------+------+------+------+------+------+------+------+------+------+------+------|
    120  * | Ctrl | RAlt | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
    121  * `-----------------------------------------------------------------------------------'
    122  */
    123 [_DVORAK] = LAYOUT_ortho_4x12(
    124     KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC,
    125     KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH,
    126     KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT ,
    127     KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
    128 ),
    129 
    130 /* Lower
    131  * ,-----------------------------------------------------------------------------------.
    132  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
    133  * |------+------+------+------+------+-------------+------+------+------+------+------|
    134  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
    135  * |------+------+------+------+------+------|------+------+------+------+------+------|
    136  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
    137  * |------+------+------+------+------+------+------+------+------+------+------+------|
    138  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
    139  * `-----------------------------------------------------------------------------------'
    140  */
    141 [_LOWER] = LAYOUT_ortho_4x12(
    142     KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC,
    143     KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE,
    144     _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END,  _______,
    145     _______, _______, _______, _______, _______, _______, _______, _______,    KC_MNXT,    KC_VOLD, KC_VOLU, KC_MPLY
    146 ),
    147 
    148 /* Raise
    149  * ,-----------------------------------------------------------------------------------.
    150  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
    151  * |------+------+------+------+------+-------------+------+------+------+------+------|
    152  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
    153  * |------+------+------+------+------+------|------+------+------+------+------+------|
    154  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
    155  * |------+------+------+------+------+------+------+------+------+------+------+------|
    156  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
    157  * `-----------------------------------------------------------------------------------'
    158  */
    159 [_RAISE] = LAYOUT_ortho_4x12(
    160     KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC,
    161     KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS,
    162     _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______,
    163     _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
    164 ),
    165 
    166 /* Plover layer (http://opensteno.org)
    167  * ,-----------------------------------------------------------------------------------.
    168  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
    169  * |------+------+------+------+------+-------------+------+------+------+------+------|
    170  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
    171  * |------+------+------+------+------+------|------+------+------+------+------+------|
    172  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
    173  * |------+------+------+------+------+------+------+------+------+------+------+------|
    174  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
    175  * `-----------------------------------------------------------------------------------'
    176  */
    177 
    178 [_PLOVER] = LAYOUT_ortho_4x12(
    179     KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   ,
    180     XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC,
    181     XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
    182     EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX
    183 ),
    184 
    185 /* Adjust (Lower + Raise)
    186  * ,-----------------------------------------------------------------------------------.
    187  * |Reset |      |      |      |      |      |      |      |      |      |      |  Del |
    188  * |------+------+------+------+------+-------------+------+------+------+------+------|
    189  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
    190  * |------+------+------+------+------+------|------+------+------+------+------+------|
    191  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
    192  * |------+------+------+------+------+------+------+------+------+------+------+------|
    193  * |      |      |      |      |      |             |      |      |      |      |      |
    194  * `-----------------------------------------------------------------------------------'
    195  */
    196 [_ADJUST] = LAYOUT_ortho_4x12(
    197     QK_BOOT,LED_1, LED_2, LED_3, LED_4, LED_5,LED_6, LED_7, LED_8, LED_9, LED_0,KC_DEL ,
    198     _______, _______, MU_NEXT, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______,
    199     _______, AU_PREV, AU_NEXT, MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______,
    200     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
    201 )
    202 
    203 
    204 };
    205 
    206 //Setup config struct for LED
    207 typedef union {
    208   uint32_t raw;
    209   struct {
    210     uint8_t  red_mode :8;
    211     uint8_t  green_mode :8;
    212   };
    213 } led_config_t;
    214 led_config_t led_config;
    215 
    216 //Set leds to saved state during powerup
    217 void keyboard_post_init_user(void) {
    218   // set LED pin modes
    219   gpio_set_pin_output(LED_RED);
    220   gpio_set_pin_output(LED_GREEN);
    221 
    222   // Call the post init code.
    223   led_config.raw = eeconfig_read_user();
    224 
    225   if(led_config.red_mode == LEDMODE_ON) {
    226       gpio_write_pin_high(LED_RED);
    227   }
    228 
    229   if(led_config.green_mode == LEDMODE_ON) {
    230       gpio_write_pin_high(LED_GREEN);
    231   }
    232 }
    233 
    234 void eeconfig_init_user(void) {  // EEPROM is getting reset! 
    235   led_config.raw = 0;
    236   led_config.red_mode = LEDMODE_ON;
    237   led_config.green_mode = LEDMODE_MODS;
    238       eeconfig_update_user(led_config.raw);
    239   eeconfig_update_user(led_config.raw);
    240 }
    241 
    242 layer_state_t layer_state_set_user(layer_state_t state) {
    243   return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
    244 }
    245 
    246 void led_keypress_update(uint8_t led, uint8_t led_mode, uint16_t keycode, keyrecord_t *record) {
    247     switch (led_mode) {
    248       case LEDMODE_MODS:
    249         for (int i=0;i<ARRAY_SIZE(modifiers);i++) {
    250           if(keycode==modifiers[i]) {
    251             if (record->event.pressed) {
    252               gpio_write_pin_high(led);
    253             }
    254             else {
    255               gpio_write_pin_low(led);
    256             }
    257           }
    258         }
    259         break;
    260       case LEDMODE_BLINKIN:
    261         if (record->event.pressed) {
    262           if(rand() % 2 == 1) {
    263             if(rand() % 2 == 0) {
    264               gpio_write_pin_low(led);
    265             }
    266             else {
    267               gpio_write_pin_high(led);
    268             }
    269           }
    270         }
    271         break;
    272       case LEDMODE_KEY:
    273         if (record->event.pressed) {
    274           gpio_write_pin_high(led);
    275           return;
    276         }
    277         else {
    278           gpio_write_pin_low(led);
    279           return;
    280         }
    281         break;
    282       case LEDMODE_ENTER:
    283         if (keycode==KC_ENT) {
    284           gpio_write_pin_high(led);
    285         }
    286         else {
    287           gpio_write_pin_low(led);
    288         }
    289         break;
    290 
    291     }
    292 }
    293 
    294 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
    295   /* If the either led mode is keypressed based, call the led updater
    296      then let it fall through the keypress handlers. Just to keep 
    297      the logic out of this procedure */
    298   if (led_config.red_mode >= LEDMODE_MODS && led_config.red_mode <= LEDMODE_ENTER) {
    299       led_keypress_update(LED_RED, led_config.red_mode, keycode, record);
    300   }
    301   if (led_config.green_mode >= LEDMODE_MODS && led_config.green_mode <= LEDMODE_ENTER) {
    302       led_keypress_update(LED_GREEN, led_config.green_mode, keycode, record);
    303   }
    304   switch (keycode) {
    305     case PLOVER:
    306       if (record->event.pressed) {
    307         layer_off(_RAISE);
    308         layer_off(_LOWER);
    309         layer_off(_ADJUST);
    310         layer_on(_PLOVER);
    311         if (!eeconfig_is_enabled()) {
    312             eeconfig_init();
    313         }
    314         eeconfig_read_keymap(&keymap_config);
    315         keymap_config.nkro = 1;
    316         eeconfig_update_keymap(&keymap_config);
    317       }
    318       return false;
    319       break;
    320     case EXT_PLV:
    321       if (record->event.pressed) {
    322         layer_off(_PLOVER);
    323       }
    324       return false;
    325       break;
    326     case LED_1:
    327       if (record->event.pressed) {
    328         if (led_config.red_mode==LEDMODE_ON) {
    329             led_config.red_mode=LEDMODE_OFF;
    330             gpio_write_pin_low(LED_RED);
    331         }
    332         else {
    333             led_config.red_mode=LEDMODE_ON;
    334             gpio_write_pin_high(LED_RED);
    335         }
    336       }
    337       eeconfig_update_user(led_config.raw);
    338       return false;
    339       break;
    340     case LED_2:
    341       if (record->event.pressed) {
    342         if (led_config.green_mode==LEDMODE_ON) {
    343             led_config.green_mode=LEDMODE_OFF;
    344             gpio_write_pin_low(LED_GREEN);
    345         }
    346         else {
    347             led_config.green_mode=LEDMODE_ON;
    348             gpio_write_pin_high(LED_GREEN);
    349         }
    350       }
    351       eeconfig_update_user(led_config.raw);
    352       return false;
    353       break;
    354     case LED_3:
    355       led_config.red_mode=LEDMODE_MODS;
    356       eeconfig_update_user(led_config.raw);
    357       return false;
    358       break;
    359     case LED_4:
    360       led_config.green_mode=LEDMODE_MODS;
    361       eeconfig_update_user(led_config.raw);
    362       return false;
    363       break;
    364     case LED_5:
    365       led_config.red_mode=LEDMODE_BLINKIN;
    366       eeconfig_update_user(led_config.raw);
    367       return false;
    368       break;
    369     case LED_6:
    370       led_config.green_mode=LEDMODE_BLINKIN;
    371       eeconfig_update_user(led_config.raw);
    372       return false;
    373       break;
    374     case LED_7:
    375       led_config.red_mode=LEDMODE_KEY;
    376       eeconfig_update_user(led_config.raw);
    377       return false;
    378       break;
    379     case LED_8:
    380       led_config.green_mode=LEDMODE_KEY;
    381       eeconfig_update_user(led_config.raw);
    382       return false;
    383       break;
    384     case LED_9:
    385       led_config.red_mode=LEDMODE_ENTER;
    386       eeconfig_update_user(led_config.raw);
    387       return false;
    388       break;
    389     case LED_0:
    390       led_config.green_mode=LEDMODE_ENTER;
    391       eeconfig_update_user(led_config.raw);
    392       return false;
    393       break;
    394   }
    395   return true;
    396 }