public_git
/
pikvm
mirror of https://github.com/pikvm/pikvm.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update

This commit is contained in:
Maxim Devaev 2023-10-26 19:51:15 +03:00
parent db69a0c6b0
commit 6f148ffe14
1 changed files with 22 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/mouse_jiggler.md
View File

@ -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:
<img src="mouse_jiggler_menu.png" width="400"/>
@ -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...`<br>*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
```