ploopyco: Expose toggle scrolling as a custom keycode #23728

beaudrychase · 2024-05-16T13:44:34Z

Description

The goal of this PR is to allow users to create keymaps with both momentary and toggle control over drag scroll by mapping these functions to two separate custom keycodes. This will allow people to switch between momentary and toggle control of drag scroll through VIA, instead of having to flash new firmware with different macros set.

Types of Changes

Issues Fixed or Closed by This PR

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

drashna · 2024-05-18T06:30:53Z

Just a heads up, develop has a pretty massive rework of all of the ploopy code, to unify it into a more cohesive base. (#22967) As such, the files that you're editing no longer exist on that branch, and this change will cause merge conflicts.

I would recommend rebasing this to target develop instead.

beaudrychase · 2024-05-18T18:43:58Z

Oh sick, I hadn't seem that PR. Honestly, this was a quick and dirty PR for me to get the functionality I wanted and something to link to in this issue. I can for sure clean this up and rebase on top of that commit you linked.

keyboards/ploopyco/ploopyco.c

keyboards/ploopyco/readme.md

keyboards/ploopyco/ploopyco.h

keyboards/ploopyco/ploopyco.c

…scroll scaling.

beaudrychase · 2024-05-22T00:04:33Z

This is my first time contributing to this project; is there anything I need to do to get this merged in? @drashna I also think this PR is in a done state. @drashna thank you so much for your work on the Ploopy firmware and for taking the time to review this PR.

drashna · 2024-05-22T03:07:43Z

Generally, we want two approvals from collaborators or other exports for the PR before it's merged.

So, it's mostly a waiting game. And usually, it can take a couple of weeks. There are a lot of PRs, and we all do this in our free time.

beaudrychase · 2024-05-22T03:34:13Z

That's a sensible policy. Thank you again for all of your efforts!

beaudrychase · 2024-05-25T00:39:22Z

keyboards/ploopyco/ploopyco.c

@@ -175,7 +175,7 @@ bool process_record_kb(uint16_t keycode, keyrecord_t* record) {
    }

    if (keycode == MOMENTARY_DRAG_SCROLL) {
-        is_drag_scroll = record->event.pressed;
+        is_drag_scroll ^= 1


This was a subtle thing I wanted to change.
Behavior before this commit:

Press TOGGLE_DRAG_SCROLL and enter drag scroll mode.

Press and hold MOMENTARY_DRAG_SCROLL leaves drag scroll mode and enters mouse mode.

Release MOMENTARY_DRAG_SCROLL does nothing, the device stays in mouse mode instead of going back into drag scroll.

Behavior after this commit:

Press TOGGLE_DRAG_SCROLL and enter drag scroll mode.

Press and hold MOMENTARY_DRAG_SCROLL temporarily leaves drag scroll mode and enters mouse mode.

Release MOMENTARY_DRAG_SCROLL returns device to drag scroll mode

Press TOGGLE_DRAG_SCROLL to leave drag scroll mode.

I'm using my Adept with a button mapped to each of these keys and I think the new behavior is much more intuitive.

beaudrychase · 2024-06-09T04:25:49Z

I just read this PR: #21426
It seems like my work here won't be needed once that one is merged in since ploopyco won't have to implement drag scroll. That PR also exposes momentary and toggle versions of drag scroll as keycodes. These ploopyco will just need to define POITNING_DEVICE_MODES_ENABLE. I'd be cool with just closing this PR, it's up to y'all.

light-idea · 2024-08-11T03:10:11Z

I was just working on something similar to add custom keycodes that invert the scroll direction (for switching between Mac and Windows). Thanks for the info on the new pointing device modes.

If this does get merged, you may want to swap the momentary and toggle keycodes in ploopyco.h, so that the old and new firmware use the same keycode for toggle. It might also make sense to increment the VIA firmware version, if that would allow VIA to detect between the old and new firmware features.

beaudrychase · 2024-08-13T00:17:51Z

keyboards/ploopyco/madromys/config.h

@@ -18,6 +18,8 @@

 #pragma once

+#define VIA_FIRMWARE_VERSION 1


@light-idea Thanks for your suggestion to version bump VIA. Does this have the intended effect? I followed the commit you linked in your comment.

I was also wondering about your choice of config.h. You chose to modify .../ploopyco/trackball/rev1_005/config.h instead of .../ploopyco/trackball/config.h. I think defining it in either should have the intended effect. What considerations are there with this?

Looking it over again, it's probably supposed to go in .../keymaps/via/config.h.

But it does not seem to have the intended effect. I was hoping VIA would only show the custom keycodes supported by the current firmware version. But if I load a draft definition into VIA, it always shows the the newest firmware keycodes no matter what I have loaded on the trackball...

beaudrychase · 2024-08-13T00:21:01Z

keyboards/ploopyco/ploopyco.h

+    TOGGLE_DRAG_SCROLL,
+    MOMENTARY_DRAG_SCROLL,


@light-idea good catch with the ordering of these.

github-actions bot added the keyboard label May 16, 2024

drashna self-assigned this May 18, 2024

drashna requested review from drashna and a team May 18, 2024 06:31

beaudrychase changed the base branch from master to develop May 18, 2024 18:44

beaudrychase force-pushed the madromys-toggle-scroll-via branch from f09a037 to 5c08ade Compare May 18, 2024 19:48

beaudrychase marked this pull request as draft May 18, 2024 20:14

beaudrychase commented May 18, 2024

View reviewed changes

keyboards/ploopyco/ploopyco.c Outdated Show resolved Hide resolved

beaudrychase commented May 19, 2024

View reviewed changes

keyboards/ploopyco/ploopyco.c Outdated Show resolved Hide resolved

beaudrychase commented May 19, 2024

View reviewed changes

keyboards/ploopyco/ploopyco.c Show resolved Hide resolved

beaudrychase marked this pull request as ready for review May 19, 2024 01:49

beaudrychase commented May 19, 2024

View reviewed changes

keyboards/ploopyco/readme.md Outdated Show resolved Hide resolved

beaudrychase force-pushed the madromys-toggle-scroll-via branch 2 times, most recently from ddcf04f to e6d5b5d Compare May 19, 2024 02:22

beaudrychase changed the title ~~Exposed toggle scrolling as a key in via~~ Expose toggle scrolling as a custom keycode May 19, 2024

beaudrychase commented May 19, 2024

View reviewed changes

keyboards/ploopyco/ploopyco.h Outdated Show resolved Hide resolved

drashna requested changes May 19, 2024

View reviewed changes

keyboards/ploopyco/ploopyco.c Outdated Show resolved Hide resolved

drashna requested a review from a team May 19, 2024 04:33

github-actions bot added keymap via Adds via keymap and/or updates keyboard for via support labels May 19, 2024

beaudrychase requested a review from drashna May 19, 2024 12:57

beaudrychase changed the title ~~Expose toggle scrolling as a custom keycode~~ ploopyco: Expose toggle scrolling as a custom keycode May 19, 2024

beaudrychase commented May 19, 2024

View reviewed changes

keyboards/ploopyco/ploopyco.c Show resolved Hide resolved

Add custom keycode for TOGGLE_DRAG_SCROLL. Use integer math for drag …

c6bd882

…scroll scaling.

beaudrychase force-pushed the madromys-toggle-scroll-via branch from 0ce8dc5 to c6bd882 Compare May 20, 2024 03:02

drashna approved these changes May 20, 2024

View reviewed changes

drashna requested a review from a team May 22, 2024 03:06

MOMENTARY_DRAG_SCROLL small change

4a178ee

beaudrychase commented May 25, 2024

View reviewed changes

beaudrychase added 2 commits May 24, 2024 20:42

semicolon

2a28944

update readme

f227ea6

drashna added the awaiting review label Jul 14, 2024

added via version and swapped keycodes

8f5af28

beaudrychase commented Aug 13, 2024

View reviewed changes

whitespace

42836d3

beaudrychase commented Aug 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ploopyco: Expose toggle scrolling as a custom keycode #23728

ploopyco: Expose toggle scrolling as a custom keycode #23728

beaudrychase commented May 16, 2024 •

edited

Loading

drashna commented May 18, 2024 •

edited

Loading

beaudrychase commented May 18, 2024

beaudrychase commented May 22, 2024

drashna commented May 22, 2024

beaudrychase commented May 22, 2024

beaudrychase May 25, 2024 •

edited

Loading

beaudrychase commented Jun 9, 2024

light-idea commented Aug 11, 2024 •

edited

Loading

beaudrychase Aug 13, 2024

light-idea Aug 14, 2024

beaudrychase Aug 13, 2024

ploopyco: Expose toggle scrolling as a custom keycode #23728

Are you sure you want to change the base?

ploopyco: Expose toggle scrolling as a custom keycode #23728

Conversation

beaudrychase commented May 16, 2024 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

drashna commented May 18, 2024 • edited Loading

beaudrychase commented May 18, 2024

beaudrychase commented May 22, 2024

drashna commented May 22, 2024

beaudrychase commented May 22, 2024

beaudrychase May 25, 2024 • edited Loading

Choose a reason for hiding this comment

beaudrychase commented Jun 9, 2024

light-idea commented Aug 11, 2024 • edited Loading

beaudrychase Aug 13, 2024

Choose a reason for hiding this comment

light-idea Aug 14, 2024

Choose a reason for hiding this comment

beaudrychase Aug 13, 2024

Choose a reason for hiding this comment

beaudrychase commented May 16, 2024 •

edited

Loading

drashna commented May 18, 2024 •

edited

Loading

beaudrychase May 25, 2024 •

edited

Loading

light-idea commented Aug 11, 2024 •

edited

Loading