Skip to content

Commit

Permalink
[Keymap] Jonavin userspace encoder alt tab scrolling (qmk#14979)
Browse files Browse the repository at this point in the history 
Co-authored-by: Jonavin <=>
  • Loading branch information
@Jonavin
Jonavin authored Oct 30, 2021
1 parent 28120c1 commit 5334e08
Show file tree
Hide file tree
Showing 8 changed files with 271 additions and 165 deletions.
4 changes: 2 additions & 2 deletions keyboards/mechwild/obe/keymaps/jonavin/keymap.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Base */
[_BASE] = LAYOUT(
KC_MUTE, KC_GESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSLS, KC_DEL,
KC_TSTOG,KC_GESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSLS, KC_DEL,
KC_PGUP, KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSPC,
KC_PGDN, TT(_RAISE), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
KC_LSFTCAPSWIN,KC_Z, KC_X, KC_C, KC_V, KC_B, LT(_LOWER,KC_B), KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_SFTUP,KC_RSFT,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, MO(_FN1), KC_RAISESPC, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
),
[_FN1] = LAYOUT(
KC_NO, KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_TRNS, KC_INS,
KC_MUTE, KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_TRNS, KC_INS,
KC_HOME, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_PSCR, KC_SLCK, KC_PAUS, KC_NO, KC_NO, KC_NO, RESET,
KC_END, KC_CAPS, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_TRNS,
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_TRNS, KC_NLCK, KC_NO, KC_NO, KC_NO, KC_NO, KC_PGUP, KC_TRNS,
Expand Down
4 changes: 4 additions & 0 deletions keyboards/mechwild/obe/keymaps/jonavin/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Features
- left spacebar Backspace
- add double tap of Left Shift to toggle Caps Lock
- Up arrow is also Shift when held
- Pushing the encoder switches the default encoder scroll between volume control and Alt-Tab


rules.mk OPTIONS - Active features from userspace
Expand Down Expand Up @@ -46,5 +47,8 @@ EMOTICON_ENABLE
INVERT_NUMLOCK_INDICATOR
- inverts the Num lock indicator, LED is on when num lokc is off

ALTTAB_SCROLL_ENABLE
- bind KS_TSTOG to a different key to change how this toggle happens

## All layers diagram
![image](https://user-images.githubusercontent.com/71780717/137356366-6b23c71b-9499-473e-a1e3-c65644135fc6.png)
2 changes: 2 additions & 0 deletions keyboards/mechwild/obe/keymaps/jonavin/rules.mk
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ STARTUP_NUMLOCK_ON = yes
ENCODER_DEFAULTACTIONS_ENABLE = yes
EMOTICON_ENABLE = yes
INVERT_NUMLOCK_INDICATOR = yes

ALTTAB_SCROLL_ENABLE = yes
177 changes: 17 additions & 160 deletions users/jonavin/jonavin.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,171 +95,21 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
} // timeout_threshold = 0 will disable timeout
}

#endif // IDLE_TIMEOUT_ENABLE

#if defined(ALTTAB_SCROLL_ENABLE) || defined(IDLE_TIMEOUT_ENABLE) // timer features
__attribute__((weak)) void matrix_scan_keymap(void) {}

void matrix_scan_user(void) {
timeout_tick_timer();
#ifdef ALTTAB_SCROLL_ENABLE
encoder_tick_alttabscroll();
#endif
#ifdef IDLE_TIMEOUT_ENABLE
timeout_tick_timer();
#endif
matrix_scan_keymap();
}
#endif // IDLE_TIMEOUT_ENABLE


#ifdef ENCODER_ENABLE
#ifndef DYNAMIC_KEYMAP_LAYER_COUNT
#define DYNAMIC_KEYMAP_LAYER_COUNT 4 //default in case this is not already defined elsewhere
#endif
#ifndef ENCODER_DEFAULTACTIONS_INDEX
#define ENCODER_DEFAULTACTIONS_INDEX 0 // can select encoder index if there are multiple encoders
#endif

void encoder_action_volume(bool clockwise) {
if (clockwise)
tap_code(KC_VOLU);
else
tap_code(KC_VOLD);
}

void encoder_action_mediatrack(bool clockwise) {
if (clockwise)
tap_code(KC_MEDIA_NEXT_TRACK);
else
tap_code(KC_MEDIA_PREV_TRACK);
}

void encoder_action_navword(bool clockwise) {
if (clockwise)
tap_code16(LCTL(KC_RGHT));
else
tap_code16(LCTL(KC_LEFT));
}

void encoder_action_navpage(bool clockwise) {
if (clockwise)
tap_code16(KC_PGUP);
else
tap_code16(KC_PGDN);
}

// LAYER HANDLING
uint8_t selected_layer = 0;

uint8_t get_selected_layer(void) {
return selected_layer;
}

void encoder_action_layerchange(bool clockwise) {
if (clockwise) {
if(selected_layer < (DYNAMIC_KEYMAP_LAYER_COUNT - 1)) {
selected_layer ++;
layer_move(selected_layer);
}
} else {
if (selected_layer > 0) {
selected_layer --;
layer_move(selected_layer);
}
}
}

#ifdef RGB_MATRIX_ENABLE
void encoder_action_rgb_speed(bool clockwise) {
if (clockwise)
rgb_matrix_increase_speed_noeeprom();
else
rgb_matrix_decrease_speed_noeeprom();
}
void encoder_action_rgb_hue(bool clockwise) {
if (clockwise)
rgb_matrix_increase_hue_noeeprom();
else
rgb_matrix_decrease_hue_noeeprom();
}
void encoder_action_rgb_saturation(bool clockwise) {
if (clockwise)
rgb_matrix_increase_sat_noeeprom();
else
rgb_matrix_decrease_sat_noeeprom();
}
void encoder_action_rgb_brightness(bool clockwise) {
if (clockwise)
rgb_matrix_increase_val_noeeprom();
else
rgb_matrix_decrease_val_noeeprom();
}
void encoder_action_rgb_mode(bool clockwise) {
if (clockwise)
rgb_matrix_step_noeeprom();
else
rgb_matrix_step_reverse_noeeprom();
}
#elif defined(RGBLIGHT_ENABLE)
void encoder_action_rgb_speed(bool clockwise) {
if (clockwise)
rgblight_increase_speed_noeeprom();
else
rgblight_decrease_speed_noeeprom();
}
void encoder_action_rgb_hue(bool clockwise) {
if (clockwise)
rgblight_increase_hue_noeeprom();
else
rgblight_decrease_hue_noeeprom();
}
void encoder_action_rgb_saturation(bool clockwise) {
if (clockwise)
rgblight_increase_sat_noeeprom();
else
rgblight_decrease_sat_noeeprom();
}
void encoder_action_rgb_brightness(bool clockwise) {
if (clockwise)
rgblight_increase_val_noeeprom();
else
rgblight_decrease_val_noeeprom();
}
void encoder_action_rgb_mode(bool clockwise) {
if (clockwise)
rgblight_step_noeeprom();
else
rgblight_step_reverse_noeeprom();
}
#endif // RGB_MATRIX_ENABLE || RGBLIGHT_ENABLE
#endif // ENCODER_ENABLE

#if defined(ENCODER_ENABLE) && defined(ENCODER_DEFAULTACTIONS_ENABLE) // Encoder Functionality

__attribute__((weak)) bool encoder_update_keymap(uint8_t index, bool clockwise) { return true; }

bool encoder_update_user(uint8_t index, bool clockwise) {
if (!encoder_update_keymap(index, clockwise)) { return false; }
if (index != ENCODER_DEFAULTACTIONS_INDEX) {return true;} // exit if the index doesn't match
uint8_t mods_state = get_mods();
if (mods_state & MOD_BIT(KC_LSFT) ) { // If you are holding L shift, encoder changes layers
encoder_action_layerchange(clockwise);
} else if (mods_state & MOD_BIT(KC_RSFT) ) { // If you are holding R shift, Page up/dn
unregister_mods(MOD_BIT(KC_RSFT));
encoder_action_navpage(clockwise);
register_mods(MOD_BIT(KC_RSFT));
} else if (mods_state & MOD_BIT(KC_LCTL)) { // if holding Left Ctrl, navigate next/prev word
encoder_action_navword(clockwise);
} else if (mods_state & MOD_BIT(KC_LALT)) { // if holding Left Alt, change media next/prev track
encoder_action_mediatrack(clockwise);
} else {
switch(get_highest_layer(layer_state)) {
case _FN1:
#ifdef IDLE_TIMEOUT_ENABLE
timeout_update_threshold(clockwise);
#endif
break;
default:
encoder_action_volume(clockwise); // Otherwise it just changes volume
break;
}
}
return false;
}
#endif // ENCODER_ENABLE

#endif // ALTTAB_SCROLL_ENABLE or IDLE_TIMEOUT_ENABLE

// PROCESS KEY CODES
__attribute__ ((weak)) bool process_record_keymap(uint16_t keycode, keyrecord_t *record) { return true; }
Expand Down Expand Up @@ -326,6 +176,13 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
break;
#endif // EMOTICON_ENABLE

#ifdef ALTTAB_SCROLL_ENABLE
case KC_TSTOG:
if (record->event.pressed) encoder_toggle_alttabscroll();
else unregister_code16(keycode);
break;
#endif // ALTTAB_SCROLL_ENABLE

default:
if (record->event.pressed) {
#ifdef RGB_MATRIX_ENABLE
Expand Down
8 changes: 8 additions & 0 deletions users/jonavin/jonavin.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ enum custom_user_keycodes {
EMO_JOY, // (^o^)
EMO_TEARS, // (T_T)

KC_TSTOG, // Tab Scroll Toggle

NEW_SAFE_RANGE // new safe range for keymap level custom keycodes
};

Expand Down Expand Up @@ -91,6 +93,12 @@ enum custom_user_keycodes {
void encoder_action_rgb_brightness(bool clockwise);
void encoder_action_rgb_mode(bool clockwise);
#endif // RGB_MATRIX_ENABLE / RGBLIGHT_ENABLE

#ifdef ALTTAB_SCROLL_ENABLE
void encoder_action_alttabscroll(bool clockwise);
void encoder_toggle_alttabscroll(void);
void encoder_tick_alttabscroll(void);
#endif // ALTTAB_SCROLL_ENABLE
#endif // ENCODER_ENABLE


Expand Down
Loading

0 comments on commit 5334e08

Please sign in to comment.