RomanNum3ral
/
Solaar
mirror of https://github.com/pwr-Solaar/Solaar.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: document sliding dpi and mouse gestures

This commit is contained in:
Peter F. Patel-Schneider 2021-03-18 17:39:28 -04:00
parent f7488f67c1
commit e32cf61fa8
2 changed files with 29 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/capabilities.md
View File

@ -3,7 +3,7 @@ title: Solaar Capabilities
layout: page
---
# Solaar capabilities
# Solaar Capabilities
[**Solaar**][solaar] reports on and controls [Logitech][logitech] devices
(keyboards, mice, and trackballs) that connect to your computer via a
@ -69,7 +69,7 @@ without the Unifying logo can probably only connect to the kind of receiver
that they were bought with.
## Supported features
## Supported Features
Solaar uses the HID++ protocol to pair devices to receivers and unpair
devices from receivers, and also uses the HID++ protocol to display
@ -121,10 +121,16 @@ WARNING: Updating firmware can cause a piece of hardware to become
permanently non-functional if something goes wrong with the update or the
update installs the wrong firmware.
## Rule-based Processing of HID++ Feature Notifications
## Other Solaar Capabilities
Solaar has a few capabilities that go beyond simply changing device settings.
### Rule-based Processing of HID++ Feature Notifications
Solaar can process HID++ Feature Notifications from devices to, for example,
change the speed of some thumb wheels. For more information on this capability of Solaar see
change the speed of some thumb wheels. These notifications are only sent
for actions that are set in Solaar to their HID++ setting (also known as diverted).
For more information on this capability of Solaar see
[the rules page](https://pwr-solaar.github.io/Solaar/rules). As much of rule processing
depends on X11, this capability is only when running under X11.
@ -132,6 +138,23 @@ Users can edit rules using a GUI by clicking on the `Edit Rule` button in the So
Solaar rules is an experimental feature. Significant changes might be made in response to problems.
### Sliding DPI
A few mice (such as the MX Vertical) have a button that can be used to change
the sensitivity (DPI) of the mouse by pressing the button and moving the mouse left and right.
This processing is only set up in Solaar when the DPI Sliding Adjustment setting is on and
the DPI Switch button is diverted.
### Mouse Gestures
Some mice (such as the MX Master 3) have a button that can be used to
create up/down/left/right gestures, which then are seen by the Solaar rules as
MOUSE_GESTURE notifications.
This processing is only set up in Solaar when the Mouse Gestures setting is on and
the App Switch Gesture button or MultiPlatform Gesture Button is diverted.
Mouse gestures is an experimental feature. Significant changes might be made in response to problems.
## System Tray

2
docs/rules.md
View File

@ -89,6 +89,8 @@ A `thumb_wheel_up` test is the rotation amount of a `THUMB WHEEL` upward rotatio
A `thumb_wheel_down` test is the rotation amount of a `THUMB WHEEL` downward rotation.
`lowres_wheel_up`, `lowres_wheel_down`, `hires_wheel_up`, `hires_wheel_down` are the
same but for `LOWRES WHEEL` and `HIRES WHEEL`.
A 'mouse-down' test is true for a mouse gesture mostly in the downward direction.
`mouse-up', 'mouse-left', and 'mouse-right' are the same but for gestures in the other directions.
`True` and `False` tests return True and False, respectively.
A `KeyPress` action takes a sequence of X11 key symbols and simulates a chorded keypress on the keyboard.