layouts/community/ortho_4x12/mindsound/keymap.c

   1 #include QMK_KEYBOARD_H
   2
   3 #ifdef BACKLIGHT_ENABLE
   4 #include "flicker.h"
   5 #endif
   6
   7 extern keymap_config_t keymap_config;
   8
   9 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  10 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  11 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  12 // entirely and just use numbers.
  13
  14 enum planck_layers {
  15   _QWERTY,
  16   _LOWER,
  17   _RAISE,
  18   _ADJUST
  19 };
  20
  21 // keycodes custom to this keymap:
  22 enum planck_keycodes {
  23   QWERTY = SAFE_RANGE,
  24   BL_FLICKER
  25 };
  26
  27 // flicker state:
  28 #ifdef BACKLIGHT_ENABLE
  29 bool flicker_enable = true;
  30 bool flicker_isdown = false;
  31 const uint8_t flicker_min_levels = 2;
  32 const uint8_t flicker_max_levels = 7;
  33 uint8_t flicker_restore_level = 0;
  34 #endif
  35
  36 // Fillers to make layering more clear
  37 #define _______ KC_TRNS
  38 #define XXXXXXX KC_NO
  39
  40 #define LOWER MO(_LOWER)
  41 #define RAISE MO(_RAISE)
  42
  43 // mod tap definitions:
  44 #define CTRL_ESC MT(MOD_LCTL, KC_ESC)
  45 #define HYPR_SPC MT(MOD_HYPR, KC_SPC)
  46
  47 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  48
  49 /* Qwerty
  50  * ,-----------------------------------------------------------------------------------.
  51  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  52  * |------+------+------+------+------+-------------+------+------+------+------+------|
  53  * | Ctrl |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  | '    |
  54  * |------+------+------+------+------+------|------+------+------+------+------+------|
  55  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  56  * |------+------+------+------+------+------+------+------+------+------+------+------|
  57  * | Esc  | Del  | GUI  | Alt  |Lower |HyprSp|Space |Raise | Left | Down |  Up  |Right |
  58  * `-----------------------------------------------------------------------------------'
  59  */
  60 [_QWERTY] = LAYOUT_ortho_4x12(
  61   KC_TAB,   KC_Q,    KC_W,    KC_E,    KC_R,  KC_T,     KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC, \
  62   CTRL_ESC, KC_A,    KC_S,    KC_D,    KC_F,  KC_G,     KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, \
  63   KC_LSFT,  KC_Z,    KC_X,    KC_C,    KC_V,  KC_B,     KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT , \
  64   KC_MPLY,  KC_DEL,  KC_LGUI, KC_LALT, LOWER, HYPR_SPC, KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT  \
  65 ),
  66
  67
  68 /* Lower
  69  * ,-----------------------------------------------------------------------------------.
  70  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
  71  * |------+------+------+------+------+-------------+------+------+------+------+------|
  72  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
  73  * |------+------+------+------+------+------|------+------+------+------+------+------|
  74  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
  75  * |------+------+------+------+------+------+------+------+------+------+------+------|
  76  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
  77  * `-----------------------------------------------------------------------------------'
  78  */
  79 [_LOWER] = LAYOUT_ortho_4x12(
  80   KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC, \
  81   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE, \
  82   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END,  _______, \
  83   _______, _______, _______, _______, _______, _______, _______, _______,    KC_MNXT,    KC_VOLD, KC_VOLU, KC_MPLY  \
  84 ),
  85
  86
  87 /* Raise
  88  * ,-----------------------------------------------------------------------------------.
  89  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
  90  * |------+------+------+------+------+-------------+------+------+------+------+------|
  91  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
  92  * |------+------+------+------+------+------|------+------+------+------+------+------|
  93  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
  94  * |------+------+------+------+------+------+------+------+------+------+------+------|
  95  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
  96  * `-----------------------------------------------------------------------------------'
  97  */
  98 [_RAISE] = LAYOUT_ortho_4x12(
  99   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
 100   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS, \
 101   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______, \
 102   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY  \
 103 ),
 104
 105
 106 /* Adjust (Lower + Raise)
 107  * ,-----------------------------------------------------------------------------------.
 108  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 109  * |------+------+------+------+------+-------------+------+------+------+------+------|
 110  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|      |      |      |      |      |
 111  * |------+------+------+------+------+------|------+------+------+------+------+------|
 112  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 113  * |------+------+------+------+------+------+------+------+------+------+------+------|
 114  * |      |      |      |      |      |             |      |Clicky|ClkDn |ClkUp |ClkRst|
 115  * `-----------------------------------------------------------------------------------'
 116  */
 117 [_ADJUST] = LAYOUT_ortho_4x12(
 118   _______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL,                  \
 119   _______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, _______, _______, _______, _______, _______,                 \
 120   _______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, BL_TOGG, BL_DEC,  BL_INC,  BL_FLICKER,                 \
 121   _______, _______, _______, _______, _______, _______, _______, _______, CLICKY_TOGGLE, CLICKY_DOWN, CLICKY_UP, CLICKY_RESET \
 122 ),
 123
 124 }; // end keymaps
 125
 126 // if backlighting is enabled, configure it on boot
 127 #ifdef BACKLIGHT_ENABLE
 128 void matrix_init_user(void) {
 129   // set to max
 130   backlight_level(BACKLIGHT_LEVELS);
 131   flicker_restore_level = get_backlight_level();
 132
 133   // if breathing happens to be compiled in, turn it off
 134 #ifdef BACKLIGHT_BREATHING
 135   breathing_disable();
 136 #endif
 137 }
 138 #endif
 139
 140 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 141 {
 142   return MACRO_NONE;
 143 };
 144
 145 void persistant_default_layer_set(uint16_t default_layer) {
 146   eeconfig_update_default_layer(default_layer);
 147   default_layer_set(default_layer);
 148 }
 149
 150 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 151
 152   // handle the _ADJUST layer and custom keycodes:
 153   switch (keycode) {
 154     case LOWER:
 155       if (record->event.pressed) {
 156         layer_on(_LOWER);
 157         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 158       } else {
 159         layer_off(_LOWER);
 160         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 161       }
 162       return false;
 163       break;
 164     case RAISE:
 165       if (record->event.pressed) {
 166         layer_on(_RAISE);
 167         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 168       } else {
 169         layer_off(_RAISE);
 170         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 171       }
 172       return false;
 173       break;
 174 #ifdef BACKLIGHT_ENABLE
 175     case BL_FLICKER:
 176       if (record->event.pressed) {
 177         flicker_toggle();
 178       }
 179       return false;
 180       break;
 181 #endif
 182   } // end switch case over custom keycodes
 183
 184 #ifdef BACKLIGHT_ENABLE
 185   if (flicker_enable) {
 186     if (record->event.pressed) {
 187       flicker_keydown();
 188     } else {
 189       flicker_keyup();
 190     }
 191   }
 192 #endif
 193
 194   return true;
 195 }
 196
 197 void encoder_update(bool clockwise) {
 198   if (clockwise) {
 199     register_code(KC_VOLU);
 200     unregister_code(KC_VOLU);
 201   } else {
 202     register_code(KC_VOLD);
 203     unregister_code(KC_VOLD);
 204   }
 205 }
 206
 207 // flicker implementation:
 208 #ifdef BACKLIGHT_ENABLE
 209 void flicker_toggle(void) {
 210   flicker_enable = !flicker_enable;
 211 }
 212
 213 void flicker_keydown(void) {
 214   // guard condition: only set the level to restore if the flicker is NOT already down
 215   if (!flicker_isdown) {
 216     flicker_restore_level = get_backlight_level();
 217     flicker_isdown = true;
 218   }
 219
 220   // calculate a random flicker level between min and max
 221   uint8_t flicker_level = (rand() % (flicker_max_levels - flicker_min_levels)) + flicker_min_levels;
 222   uint8_t level_to_set = flicker_level <= flicker_restore_level ? flicker_restore_level - flicker_level : 0;
 223   backlight_level(level_to_set);
 224 }
 225
 226 void flicker_keyup(void) {
 227   backlight_level(flicker_restore_level);
 228   flicker_isdown = false;
 229 }
 230 #endif