From 2bda897e555f931b367bbcddad7271f4c186b279 Mon Sep 17 00:00:00 2001 From: "Peter F. Patel-Schneider" Date: Thu, 15 Dec 2022 13:25:28 -0500 Subject: [PATCH] docs: document KeyIsDown rule condition --- docs/rules.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/rules.md b/docs/rules.md index 9dd7c43d..c2564fad 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -73,7 +73,7 @@ notification is their string argument. `Report` conditions are if true if the report number in the current notification is their integer argument. -`Key` conditions are true if the Logitech name of the last diverted key or button pressed is their +`Key` conditions are true if the Logitech name of the current **diverted** key or button being pressed is their string argument. Alternatively, if the argument is a list `[name, action]` where `action` is either `'pressed'` or `'released'`, the key down or key up events of `name` argument are matched, respectively. Logitech key and button names are shown in the `Key/Button Diversion` @@ -81,6 +81,9 @@ setting. These names are also shown in the output of `solaar show` in the 'repr section. Only keys or buttons that have 'divertable' in their report can be diverted. Some keyboards have Gn, Mn, or MR keys, which are diverted using the 'Divert G Keys' setting. +`KeyIsDown` conditions are true if the **diverted** key or button that is their string argument is currently down. +Note that this only works for **diverted** keys or buttons, including diverted Gn, Mn, and MR keys. + Solaar can also create special notifications in response to mouse movements on some mice. Setting `Key/Button Diversion` for a key or button causes the key or button to create a `Mouse Gesture` notification for the period that the key or button is depressed.