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