keyboards/lets_split/keymaps/OLED_sample/keymap.c

   1 #include "lets_split.h"
   2 #include "bootloader.h"
   3 #include "action_layer.h"
   4 #include "eeconfig.h"
   5 #include "tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/Peripheral/TWI.h"
   6 #ifdef AUDIO_ENABLE
   7   #include "audio.h"
   8 #endif
   9
  10 extern keymap_config_t keymap_config;
  11
  12 //Following line allows macro to read current RGB settings
  13 extern rgblight_config_t rgblight_config;
  14
  15
  16 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  17 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  18 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  19 // entirely and just use numbers.
  20 #define _QWERTY 0
  21 #define _COLEMAK 1
  22 #define _DVORAK 2
  23 #define _LOWER 3
  24 #define _RAISE 4
  25 #define _ADJUST 16
  26
  27 enum custom_keycodes {
  28   QWERTY = SAFE_RANGE,
  29   COLEMAK,
  30   DVORAK,
  31   LOWER,
  32   RAISE,
  33   ADJUST,
  34   BACKLIT,
  35   RGBLED_TOGGLE,
  36   RGBLED_STEP_MODE,
  37   RGBLED_INCREASE_HUE,
  38   RGBLED_DECREASE_HUE,
  39   RGBLED_INCREASE_SAT,
  40   RGBLED_DECREASE_SAT,
  41   RGBLED_INCREASE_VAL,
  42   RGBLED_DECREASE_VAL,
  43 };
  44
  45 enum macro_keycodes {
  46   KC_SAMPLEMACRO,
  47 };
  48
  49
  50 // Fillers to make layering more clear
  51 #define _______ KC_TRNS
  52 #define XXXXXXX KC_NO
  53 //Macros
  54 #define M_SAMPLE M(KC_SAMPLEMACRO)
  55
  56 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  57
  58 /* Qwerty
  59  * ,-----------------------------------------------------------------------------------.
  60  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  61  * |------+------+------+------+------+-------------+------+------+------+------+------|
  62  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  63  * |------+------+------+------+------+------|------+------+------+------+------+------|
  64  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  65  * |------+------+------+------+------+------+------+------+------+------+------+------|
  66  * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
  67  * `-----------------------------------------------------------------------------------'
  68  */
  69 [_QWERTY] = KEYMAP( \
  70   KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC, \
  71   KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, \
  72   KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT , \
  73   ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
  74 ),
  75
  76 /* Colemak
  77  * ,-----------------------------------------------------------------------------------.
  78  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  79  * |------+------+------+------+------+-------------+------+------+------+------+------|
  80  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  81  * |------+------+------+------+------+------|------+------+------+------+------+------|
  82  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  83  * |------+------+------+------+------+------+------+------+------+------+------+------|
  84  * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
  85  * `-----------------------------------------------------------------------------------'
  86  */
  87 [_COLEMAK] = KEYMAP( \
  88   KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC, \
  89   KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT, \
  90   KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT , \
  91   ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
  92 ),
  93
  94 /* Dvorak
  95  * ,-----------------------------------------------------------------------------------.
  96  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  97  * |------+------+------+------+------+-------------+------+------+------+------+------|
  98  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  99  * |------+------+------+------+------+------|------+------+------+------+------+------|
 100  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 101  * |------+------+------+------+------+------+------+------+------+------+------+------|
 102  * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
 103  * `-----------------------------------------------------------------------------------'
 104  */
 105 [_DVORAK] = KEYMAP( \
 106   KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC, \
 107   KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH, \
 108   KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT , \
 109   ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
 110 ),
 111
 112 /* Lower
 113  * ,-----------------------------------------------------------------------------------.
 114  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 115  * |------+------+------+------+------+-------------+------+------+------+------+------|
 116  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |     |    \  |  |   |
 117  * |------+------+------+------+------+------|------+------+------+------+------+------|
 118  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |Enter |
 119  * |------+------+------+------+------+------+------+------+------+------+------+------|
 120  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 121  * `-----------------------------------------------------------------------------------'
 122  */
 123 [_LOWER] = KEYMAP( \
 124   KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC, \
 125   KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, \
 126   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______, \
 127   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
 128 ),
 129
 130 /* Raise
 131  * ,-----------------------------------------------------------------------------------.
 132  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 133  * |------+------+------+------+------+-------------+------+------+------+------+------|
 134  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 135  * |------+------+------+------+------+------|------+------+------+------+------+------|
 136  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |Enter |
 137  * |------+------+------+------+------+------+------+------+------+------+------+------|
 138  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 139  * `-----------------------------------------------------------------------------------'
 140  */
 141 [_RAISE] = KEYMAP( \
 142   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
 143   KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS, \
 144   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, _______, _______, _______, \
 145   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
 146 ),
 147
 148 /* Adjust (Lower + Raise)
 149  * ,-----------------------------------------------------------------------------------.
 150  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 151  * |------+------+------+------+------+-------------+------+------+------+------+------|
 152  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|      |      |
 153  * |------+------+------+------+------+------|------+------+------+------+------+------|
 154  * |      |      |      |      |      |      |      |      |      |      |      |      |
 155  * |------+------+------+------+------+------+------+------+------+------+------+------|
 156  * |      |      |      |      |      |             |      |      |      |      |      |
 157  * `-----------------------------------------------------------------------------------'
 158  */
 159 [_ADJUST] =  KEYMAP( \
 160   _______, RESET,   _______, M_SAMPLE, _______, _______, _______, _______, _______, _______, _______, KC_DEL, \
 161   _______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  _______, _______, \
 162   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
 163   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \
 164 )
 165
 166
 167 };
 168
 169
 170 #ifdef AUDIO_ENABLE
 171
 172 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 173 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 174 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 175 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 176 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 177 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 178 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 179 float tone_goodbye[][2]    = SONG(GOODBYE_SOUND);
 180 #endif
 181
 182 // define variables for reactive RGB
 183 bool TOG_STATUS = false;
 184 int RGB_current_mode;
 185
 186 void persistant_default_layer_set(uint16_t default_layer) {
 187   eeconfig_update_default_layer(default_layer);
 188   default_layer_set(default_layer);
 189 }
 190
 191 // Setting ADJUST layer RGB back to default
 192 void update_tri_layer_RGB(uint8_t layer1, uint8_t layer2, uint8_t layer3) {
 193   if (IS_LAYER_ON(layer1) && IS_LAYER_ON(layer2)) {
 194     rgblight_mode(RGB_current_mode);
 195     layer_on(layer3);
 196   } else {
 197     layer_off(layer3);
 198   }
 199 }
 200
 201 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 202   switch (keycode) {
 203     case QWERTY:
 204       if (record->event.pressed) {
 205         #ifdef AUDIO_ENABLE
 206           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 207         #endif
 208         persistant_default_layer_set(1UL<<_QWERTY);
 209       }
 210       return false;
 211       break;
 212     case COLEMAK:
 213       if (record->event.pressed) {
 214         #ifdef AUDIO_ENABLE
 215           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 216         #endif
 217         persistant_default_layer_set(1UL<<_COLEMAK);
 218       }
 219       return false;
 220       break;
 221     case DVORAK:
 222       if (record->event.pressed) {
 223         #ifdef AUDIO_ENABLE
 224           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 225         #endif
 226         persistant_default_layer_set(1UL<<_DVORAK);
 227       }
 228       return false;
 229       break;
 230     case LOWER:
 231       if (record->event.pressed) {
 232           //not sure how to have keyboard check mode and set it to a variable, so my work around
 233           //uses another variable that would be set to true after the first time a reactive key is pressed.
 234         if (TOG_STATUS) { //TOG_STATUS checks is another reactive key currently pressed, only changes RGB mode if returns false
 235         } else {
 236           TOG_STATUS = !TOG_STATUS;
 237           rgblight_mode(16);
 238         }
 239         layer_on(_LOWER);
 240         update_tri_layer_RGB(_LOWER, _RAISE, _ADJUST);
 241       } else {
 242         rgblight_mode(RGB_current_mode);   // revert RGB to initial mode prior to RGB mode change
 243         TOG_STATUS = false;
 244         layer_off(_LOWER);
 245         update_tri_layer_RGB(_LOWER, _RAISE, _ADJUST);
 246       }
 247       return false;
 248       break;
 249     case RAISE:
 250       if (record->event.pressed) {
 251         //not sure how to have keyboard check mode and set it to a variable, so my work around
 252         //uses another variable that would be set to true after the first time a reactive key is pressed.
 253         if (TOG_STATUS) { //TOG_STATUS checks is another reactive key currently pressed, only changes RGB mode if returns false
 254         } else {
 255           TOG_STATUS = !TOG_STATUS;
 256           rgblight_mode(15);
 257         }
 258         layer_on(_RAISE);
 259         update_tri_layer_RGB(_LOWER, _RAISE, _ADJUST);
 260       } else {
 261         rgblight_mode(RGB_current_mode);  // revert RGB to initial mode prior to RGB mode change
 262         layer_off(_RAISE);
 263         TOG_STATUS = false;
 264         update_tri_layer_RGB(_LOWER, _RAISE, _ADJUST);
 265       }
 266       return false;
 267       break;
 268     case BACKLIT:
 269       if (record->event.pressed) {
 270         register_code(KC_RSFT);
 271         #ifdef BACKLIGHT_ENABLE
 272           backlight_step();
 273         #endif
 274       } else {
 275         unregister_code(KC_RSFT);
 276       }
 277       return false;
 278       break;
 279       //led operations - RGB mode change now updates the RGB_current_mode to allow the right RGB mode to be set after reactive keys are released
 280     case RGB_MOD:
 281       if (record->event.pressed) {
 282         rgblight_mode(RGB_current_mode);
 283         rgblight_step();
 284         RGB_current_mode = rgblight_config.mode;
 285       }
 286       return false;
 287       break;
 288   }
 289   return true;
 290 }
 291
 292 void matrix_init_user(void) {
 293     #ifdef AUDIO_ENABLE
 294         startup_user();
 295     #endif
 296     RGB_current_mode = rgblight_config.mode;
 297 }
 298
 299 //SSD1306 OLED init and update loop, make sure to add #define SSD1306OLED in config.h
 300 #ifdef SSD1306OLED
 301 void matrix_master_OLED_init (void) {
 302     TWI_Init(TWI_BIT_PRESCALE_1, TWI_BITLENGTH_FROM_FREQ(1, 800000));
 303     iota_gfx_init();   // turns on the display
 304 }
 305
 306 void matrix_scan_user(void) {
 307      iota_gfx_task();  // this is what updates the display continuously
 308 }
 309 #endif
 310
 311 #ifdef AUDIO_ENABLE
 312
 313 void startup_user()
 314 {
 315     _delay_ms(20); // gets rid of tick
 316     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 317 }
 318
 319 void shutdown_user()
 320 {
 321     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 322     _delay_ms(150);
 323     stop_all_notes();
 324 }
 325
 326 void music_on_user(void)
 327 {
 328     music_scale_user();
 329 }
 330
 331 void music_scale_user(void)
 332 {
 333     PLAY_NOTE_ARRAY(music_scale, false, 0);
 334 }
 335
 336 #endif
 337
 338 /*
 339  * Macro definition
 340  */
 341 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 342 {
 343     if (!eeconfig_is_enabled()) {
 344       eeconfig_init();
 345     }
 346
 347     switch (id) {
 348       case KC_SAMPLEMACRO:
 349         if (record->event.pressed){
 350           return MACRO (I(10), T(H), T(E), T(L), T(L), T(O), T(SPACE), T(W), T(O), T(R), T(L), T(D), END);
 351         }
 352
 353     }
 354
 355     return MACRO_NONE;
 356 }