keyboards/handwired/xeal60/keymaps/OLED_sample/keymap.c

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