layouts/community/ergodox/videck/keymap.c

   1 #include <stdbool.h>
   2
   3 #include QMK_KEYBOARD_H
   4 #include "action_layer.h"
   5
   6 enum {
   7   BASE = 0,     // Default layer
   8   ARROWS = 1,   // Arrows and Fx keys layer
   9   MOUSE = 2,    // Mouse movement and buttons layer
  10   PARENS = 3,   // Parenthesis easy access layer
  11
  12   TD_L = 0,     // Tap dance index for left shift
  13   TD_R = 1      // Tap dance index for right shift
  14 };
  15
  16 // See the videck.png image for a visualization of the layout.
  17 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  18   [BASE] = LAYOUT_ergodox(
  19     // left hand
  20     KC_GRV,     KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_HOME,
  21     KC_EQL,     KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_END,
  22     MO(PARENS), KC_A,    KC_S,    KC_D,    KC_F,    KC_G,
  23     TD(TD_L),   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_BSPC,
  24     KC_LCTL,    KC_LALT, KC_VOLD, KC_VOLU, KC_MUTE,
  25                                                     KC_ESC,  KC_LGUI,
  26                                                              TG(MOUSE),
  27                                            KC_SPC,  KC_TAB,  TG(ARROWS),
  28     // right hand
  29     KC_PGUP, KC_6,   KC_7,    KC_8,    KC_9,   KC_0,    KC_MINS,
  30     KC_PGDN, KC_Y,   KC_U,    KC_I,    KC_O,   KC_P,    KC_BSLS,
  31              KC_H,   KC_J,    KC_K,    KC_L,   KC_SCLN, KC_QUOT,
  32     KC_DELT, KC_N,   KC_M,    KC_COMM, KC_DOT, KC_SLSH, TD(TD_R),
  33                      KC_LBRC, KC_RBRC, KC_EQL, KC_RALT, KC_RCTL,
  34     KC_APP,  KC_ESC,
  35     KC_INS,
  36     KC_SLCK, KC_ENT, KC_SPC
  37   ),
  38   [ARROWS] = LAYOUT_ergodox(
  39     // left hand
  40     KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_TRNS,
  41     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  42     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  43     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  44     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  45                                                  KC_TRNS, KC_TRNS,
  46                                                           KC_NO,
  47                                         KC_TRNS, KC_TRNS, KC_TRNS,
  48     // right hand
  49     KC_TRNS, KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,
  50     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_F12,
  51              KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_TRNS, KC_TRNS,
  52     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  53                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  54     KC_TRNS, KC_TRNS,
  55     KC_TRNS,
  56     KC_TRNS, KC_TRNS, KC_TRNS
  57   ),
  58   [MOUSE] = LAYOUT_ergodox(
  59     // left hand
  60     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  61     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  62     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  63     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  64     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  65                                                  KC_BTN3, KC_TRNS,
  66                                                           KC_TRNS,
  67                                         KC_BTN1, KC_BTN2, KC_NO,
  68     // right hand
  69     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  70     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  71              KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, KC_TRNS, KC_TRNS,
  72     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  73                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  74     KC_TRNS, KC_TRNS,
  75     KC_TRNS,
  76     KC_TRNS, KC_TRNS, KC_TRNS
  77   ),
  78   [PARENS] = LAYOUT_ergodox(
  79     // left hand
  80     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  81     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  82     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  83     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  84     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  85                                                  KC_TRNS, KC_TRNS,
  86                                                           KC_NO,
  87                                         KC_TRNS, KC_TRNS, KC_NO,
  88     // right hand
  89     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  90     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_LCBR, KC_RCBR, KC_TRNS,
  91              KC_TRNS, KC_TRNS, KC_TRNS, KC_LPRN, KC_RPRN, KC_TRNS,
  92     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_LBRC, KC_RBRC, KC_TRNS,
  93                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
  94     KC_TRNS, KC_TRNS,
  95     KC_TRNS,
  96     KC_TRNS, KC_TRNS, KC_TRNS
  97   )
  98 };
  99
 100 typedef void (*videck_tap_dance_trigger_t) (const uint16_t kc);
 101
 102 typedef struct
 103 {
 104   uint16_t kc1;
 105   uint16_t kc2;
 106   videck_tap_dance_trigger_t trigger;
 107 } videck_tap_dance_tuple_t;
 108
 109 static void videck_tap_dance_finished (qk_tap_dance_state_t *state, void *user_data) {
 110   videck_tap_dance_tuple_t *const tuple = (videck_tap_dance_tuple_t *)user_data;
 111
 112   if (state->count == 1) {
 113     register_code16 (tuple->kc1);
 114   } else if (state->count == 2) {
 115     register_code16 (tuple->kc2);
 116   }
 117 }
 118
 119 static void videck_tap_dance_reset (qk_tap_dance_state_t *state, void *user_data) {
 120   videck_tap_dance_tuple_t *const tuple = (videck_tap_dance_tuple_t *)user_data;
 121
 122   if (state->count == 1) {
 123     unregister_code16 (tuple->kc1);
 124   } else if (state->count == 2) {
 125     unregister_code16 (tuple->kc2);
 126     tuple->trigger(tuple->kc2);
 127   }
 128 }
 129
 130 static bool caps_lock_is_on;
 131
 132 // Toggles caps lock status.
 133 static void videck_caps_trigger (const uint16_t kc) {
 134   caps_lock_is_on ^= true;
 135 }
 136
 137 #define ACTION_TAP_DANCE_DOUBLE_TRIGGER(kc1, kc2, double_trigger) { \
 138     .fn = { NULL, videck_tap_dance_finished, videck_tap_dance_reset }, \
 139     .user_data = (void *)&((videck_tap_dance_tuple_t) { kc1, kc2, double_trigger }),  \
 140   }
 141
 142 qk_tap_dance_action_t tap_dance_actions[] = {
 143   [TD_L] = ACTION_TAP_DANCE_DOUBLE_TRIGGER(KC_LSFT, KC_CAPS, videck_caps_trigger),
 144   [TD_R] = ACTION_TAP_DANCE_DOUBLE_TRIGGER(KC_RSFT, KC_CAPS, videck_caps_trigger)
 145 };
 146
 147 // Runs just one time when the keyboard initializes.
 148 void matrix_init_user(void) {
 149   ergodox_led_all_set(LED_BRIGHTNESS_LO);
 150   caps_lock_is_on = false;
 151 };
 152
 153 static void indicate_using_led(const uint8_t led, const bool enabled) {
 154   if (enabled) {
 155     ergodox_right_led_on(led);
 156   } else {
 157     ergodox_right_led_off(led);
 158   }
 159 }
 160
 161 static inline void indicate_caps_lock_state(const bool enabled) {
 162   indicate_using_led(1, enabled);
 163 }
 164
 165 static inline void indicate_arrows_layer_state(const bool enabled) {
 166   indicate_using_led(2, enabled);
 167 }
 168
 169 static inline void indicate_mouse_layer_state(const bool enabled) {
 170   indicate_using_led(3, enabled);
 171 }
 172
 173 // Runs constantly in the background, in a loop.
 174 void matrix_scan_user(void) {
 175   // Check if we have shift locked.
 176   indicate_caps_lock_state(caps_lock_is_on);
 177   indicate_arrows_layer_state(IS_LAYER_ON(ARROWS));
 178   indicate_mouse_layer_state(IS_LAYER_ON(MOUSE));
 179 };