From 6f148ffe14fd7b09a874abbba3debc783ccda4c2 Mon Sep 17 00:00:00 2001 From: Maxim Devaev Date: Thu, 26 Oct 2023 19:51:15 +0300 Subject: [PATCH] update --- docs/mouse_jiggler.md | 46 +++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/docs/mouse_jiggler.md b/docs/mouse_jiggler.md index 8b7481aa..125ae411 100644 --- a/docs/mouse_jiggler.md +++ b/docs/mouse_jiggler.md @@ -6,7 +6,25 @@ It is very useful when some lengthy process is going on on the target host (for example, installing software), and the user needs to monitor it with his side vision, without having to move the mouse manually to avoid the screensaver. -To enable the Jiggler, it is enough to activate the switch in the Web UI: + +----- +## Enabling the Jiggler +To enable the Jiggler, it is required to allow some config lines to `/etc/kvmd/override.yaml`: + +```yaml +kvmd: + hid: + jiggler: + enabled: true +``` + +... and restart KVMD: + +```console +[root@pikvm ~]# systemctl restart kvmd +``` + +After that, it will be available in the Web UI for activation: @@ -14,7 +32,7 @@ To enable the Jiggler, it is enough to activate the switch in the Web UI: ----- ## Description of the algorithm -If the Jiggler is enabled, then PiKVM counts down the time that has elapsed since the last user input: +When the Jiggler is active, PiKVM counts down the time that has elapsed since the last user input: that is, any action with the keyboard or mouse. If there have been no actions for more than **60 seconds**, the Jiggler performs a mouse movement and waits another 60 seconds until the next iteration. @@ -23,30 +41,10 @@ The Jiggler supports both [mouse modes](mouse.md): absolute and relative. **Movement patterns are deterministic:** * **Absolute:** `(-100, -100), wait, (100, 100), wait...`
*The coordinates are converted depending on the screen resolution.* -* **Relative:** `(-10, -10), wait, (10, 10), wait...`. +* **Relative:** `(-10, -10), wait, (10, 10), wait...` -The Jiggler works on the PiKVM side, even if the web interface was closed. +The Jiggler works on the PiKVM device side, even if the Web UI was closed. An important feature of the Jigger is that it does not interfere with normal user work. If the user is actively interacting with the keyboard and mouse, Jiggler will not introduce its interference until it notices that the period of inactivity has exceeded the threshold of 60 seconds. - - ------ -## Disabling the Jiggler - -If PiKVM is used in a corporate network, an administrator who considers it undesirable to use the Jiggler by users, -the PiKVM admin can disable this feature completely. This can be done by adding the following lines to `/etc/kvmd/override.yaml`: - -```yaml -kvmd: - hid: - jiggler: - enabled: false -``` - -Restart KVMD is required: - -```console -[root@pikvm ~]# systemctl restart kvmd -```