You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pikvm/docs/mouse_jiggler.md

54 lines
2.0 KiB
Markdown

7 months ago
# Mouse Jiggler
The mouse jiggler is a feature used to simulate the movement of a computer mouse.
It prevents sleep mode, standby mode or the screensaver from activating.
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.
7 months ago
-----
## Enabling the Jiggler
To enable the Jiggler, it is mandatory that you update to the latest version and it is required to allow some config lines to `/etc/kvmd/override.yaml`:
7 months ago
Please note: `active: true` will allow jiggler to activate after a reboot, if you do not want this, remove this line.
7 months ago
```yaml
kvmd:
hid:
jiggler:
enabled: true
active: true
7 months ago
```
... and restart KVMD:
```console
[root@pikvm ~]# systemctl restart kvmd
```
After that, it will be available in the Web UI for activation:
7 months ago
<img src="mouse_jiggler_menu.png" width="400"/>
-----
## Description of the algorithm
7 months ago
When the Jiggler is active, PiKVM counts down the time that has elapsed since the last user input:
7 months ago
that is, any action with the keyboard or mouse. If there have been no actions for more than **60 seconds**,
7 months ago
the Jiggler performs a mouse movement and waits another 60 seconds until the next iteration.
The Jiggler supports both [mouse modes](mouse.md): absolute and relative.
7 months ago
**Movement patterns are deterministic:**
* **Absolute:** `(-100, -100), wait, (100, 100), wait...`<br>*The coordinates are converted depending on the screen resolution.*
7 months ago
* **Relative:** `(-10, -10), wait, (10, 10), wait...`
7 months ago
7 months ago
The Jiggler works on the PiKVM device side, even if the Web UI was closed.
7 months ago
An important feature of the Jiggler is that it does not interfere with normal user work.
7 months ago
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.