Commit Graph

53 Commits

Author SHA1 Message Date
danielbanariba 2e3ec225e1 docs: add a worked-through MX Master 3/3S configuration page
Users arriving from Logitech Options+ or LogiOps look for a list of behaviours
and instead have to discover that a button does nothing until its diversion is
changed, and that some things are settings with no rule at all. That split is
the usual reason a first rule appears not to fire.

Add a page that walks through one device end to end: which of its buttons can be
diverted and under what names, the settings that need no rules, a diverted button
driving a key combination, mouse gestures, and the thumb wheel — including the
integer argument to the thumb wheel tests, without which a wheel action fires far
too often to be useful.

Also covers what does not carry over from LogiOps: control ids are not used,
key names are X11 key symbols rather than evdev names, and running both daemons
against one device makes settings appear to revert at random.

Records which conditions are limited under Wayland, since actions go through
uinput and do work there, while Modifiers and Process do not.

Contents checked against an MX Master 3S on a Logi Bolt receiver.
2026-08-13 23:06:29 -06:00
Peter F. Patel-Schneider 4525704793 docs: document change to use uinput only 2026-03-08 20:58:43 -04:00
Peter F. Patel-Schneider b96d0bbe0b rules: fix debug messages for MouseClick rule 2025-11-02 21:01:33 +09:00
Peter F. Patel-Schneider 94f4c3230b rules: Device and Action rule conditions match on codename and name 2025-09-30 10:23:50 -04:00
Peter F. Patel-Schneider 089b85676f docs: update built-in rules 2024-06-01 11:59:57 -04:00
MattHag cece723ea4
docs: Improve rules documentation
- Page heading
- Fix heading levels
- Improve some names
2024-05-27 12:50:42 -04:00
MattHag faf27ca323
docs: Add headings to structure rules.md
Allow users to find relevant information without reading a
long wall of text.
2024-05-27 09:55:41 -04:00
MattHag f15a50b4b2 docs: Move screenshots into dedicated folder
Clean up docs folder.
2024-05-16 15:55:44 -04:00
Peter F. Patel-Schneider ffd66e74c2 rules: fix test for device equality 2023-11-08 10:05:53 -05:00
Peter F. Patel-Schneider 90a0408bd6 rules: add single depress and release options for rule mouse click action 2023-09-16 10:28:56 -04:00
Swapnil Devesh 0e8e052629
Documentation update to mention the gnome extension to get rules working under Wayland (#2103)
* Documentation update to mention the gnome extension to get rules working under Wayland

* Updates

* Updates
2023-08-01 07:20:52 -04:00
John Veness 7aa770ee9e
docs: Fix punctuation and language in rules.md (#2032)
* Fix punctuation and language in rules.md

Fixed a few cases of backquote mistakes, unescaped <>, and misc language typos.

Took the liberty to unitalicise the third paragraph. Obviously it's important, but an entire paragraph in italics is hard to read.

I noticed there were two slightly different paragraphs about Setting conditions, which I assume is a mistake. I don't know which is better than the other, so I simply moved them next to each other for ease of comparison and manual merging/editing.

* Fixed erroneous backquote in rules.md

Fixed a ` which should have been a <. Error introduced by myself in the first place!
2023-04-04 07:47:47 -04:00
Peter F. Patel-Schneider df746fd7f4 rules: add Device condition 2023-02-18 11:25:25 -05:00
Peter F. Patel-Schneider f9353022a9 docs: add setting value for mouse gestures 2022-12-21 08:39:42 -05:00
Peter F. Patel-Schneider 2bda897e55 docs: document KeyIsDown rule condition 2022-12-17 13:21:52 -05:00
Peter F. Patel-Schneider 3c9f2f616c docs: document parameter for thumb wheel rule tests 2022-12-11 17:27:37 -05:00
Peter F. Patel-Schneider a1b006b502 docs: update mouse gestures rules documentation 2022-12-01 21:07:03 -05:00
Peter F. Patel-Schneider 6233cdf1f0 rules: update documentation for Later rule action 2022-09-26 09:36:46 -04:00
Peter F. Patel-Schneider 619223e8be rules: add Later action 2022-09-26 09:36:46 -04:00
Peter F. Patel-Schneider 7663e204bb rules: don't check modifiers for KeyPress actions that are not clicks 2022-09-20 21:03:28 -04:00
Peter F. Patel-Schneider 1708b6edf7 docs: document Active rule condition 2022-08-23 09:18:57 -04:00
Peter F. Patel-Schneider 4349f4e154 docs: document changed Smart Shift and Mouse Gestures processing 2022-07-23 06:44:57 -04:00
Peter F. Patel-Schneider d362a24f17 doc: add information on how to find divertable key names in solaar show output 2022-07-08 06:37:16 -04:00
Peter F. Patel-Schneider c8ba397e0e rules: add depress and release options to KeyPress rule action 2022-06-21 20:23:22 -04:00
Peter F. Patel-Schneider a40b9efdca rules: add and document alternative udev rule that gives write permission to /dev/uinput 2022-05-24 09:15:15 -04:00
Peter F. Patel-Schneider 1c596a8124 rules: only one warning per inaccessible key for KeyPress action 2022-05-11 12:35:04 -04:00
Peter F. Patel-Schneider 97344c4660 rules: better determination of keycodes and handle keysym level 2022-05-08 07:26:07 -04:00
Peter F. Patel-Schneider dd1b3dc573 doc: upgrade documentation on KeyPress rule action 2022-05-04 10:59:16 -04:00
Peter F. Patel-Schneider 5a3ffe04e8 release 1.1.3rc3 2022-04-21 07:32:52 -04:00
Kian-Meng Ang 15b92a0f40
misc: Fix typos 2022-04-12 17:18:11 -04:00
Peter F. Patel-Schneider b5c6cf8d63 doc: add information on rules under Wayland and uinput permissions 2022-03-19 21:09:45 -04:00
Peter F. Patel-Schneider d9abdb2ecd docs: document rule Setting: condition 2022-03-13 09:36:04 -04:00
Vinícius f327e3ad38 logitech_receiver: split Test condition 2022-03-10 21:04:28 -05:00
Peter F. Patel-Schneider 84bdc792b7 docs: augment rule documentation 2022-03-09 09:42:16 -05:00
Peter F. Patel-Schneider 19b32f7856 doc: be clear that KeyPress rule action is for a single chorded character 2022-02-16 21:14:52 -05:00
Vinícius 7dd9609942 doc: remove outdated information about unsupported setting 2022-01-24 11:12:04 -05:00
Peter F. Patel-Schneider a09af769d0 docs: document Set rule action 2022-01-13 18:59:06 -05:00
Peter F. Patel-Schneider 0736dd3164 docs: better information on diverting keys, etc., to trigger rules 2021-11-17 20:16:10 -05:00
Peter F. Patel-Schneider d80b2b1651 docs: better information on diverting keys, etc., to trigger rules 2021-11-17 17:00:42 -05:00
Peter F. Patel-Schneider f1d896ded3 settings: use new setting method for MOUSE GESTURE setting 2021-10-22 15:51:55 -04:00
Peter F. Patel-Schneider b3c3ad02c8 doc: more documentation on mouse gestures 2021-10-07 18:47:19 -04:00
Peter F. Patel-Schneider cdc7a27c9e rules: add rule condition for process under mouse 2021-07-22 10:46:31 -04:00
Peter F. Patel-Schneider 50392da360 rules: add checks for empty process name and class 2021-07-15 10:16:16 -04:00
Karthik Nishanth 85a86ec3c5
diversion: implement pressed and released action on Key condition (#1189)
- Track `key_up` key in addition to `key_down`
- Support `pressed` or `released` action in `Key` condition
- Add radio button to KeyUI to represent `pressed` or `released`
2021-07-12 15:51:57 -04:00
ApeironTsuka 011f3f556b
rules: allow sequence of mouse moves as mouse gestures
* Add more robust mouse gesture support
- Remove existing mouse-* Test types
- Add new 'Mouse Gesture' Condition
- Implement Rule Editor UI for it
- Add support for diverted buttons
- Added diagonal mouse gesture directions

Allows you to chain multiple movements/buttons (for instance, moving the mouse up and then left) together into a single mappable gesture.

* Update docs

* Cleanup
Fix inconsistent indenting
Fix possible overwriting of built-in
Fix 'Mouse Gesture' Condition rule not starting with an initial Action field

* Make flake8 happy

* yapf

* Document no-op and make it more apparent

* Make changes to Mouse Gesture UI suggested/submitted by viniciusbm.

Co-authored-by: Apeiron <apeiron@none>
Co-authored-by: Peter F. Patel-Schneider <pfpschneider@gmail.com>
2021-07-04 08:52:38 -04:00
Peter F. Patel-Schneider 086a8252d2 docs: add new settings and rule example 2021-04-18 07:36:29 -04:00
Peter F. Patel-Schneider 64915b09f7 docs: update description of mouse gestures setting 2021-04-17 10:32:24 -04:00
Peter F. Patel-Schneider e32cf61fa8 docs: document sliding dpi and mouse gestures 2021-04-13 09:26:24 -04:00
Peter F. Patel-Schneider 8d01e28138 release 1.0.5rc2 2021-02-18 15:04:18 -05:00
Peter F. Patel-Schneider a688bfd9ec settings: add setting to divert G keys and handle in rules 2020-12-13 22:24:08 -05:00