Capture a screenshot from the PiKVM video stream. Returns the current screen as a JPEG image.

Get the current screen resolution of the remote machine. Useful for knowing valid coordinate ranges for mouse operations.

Type text on the remote machine using PiKVM. Handles special characters correctly via keymap conversion.

Send a key or key combination to the remote machine. Use JavaScript key codes (e.g., KeyA, Enter, ControlLeft).

Send a keyboard shortcut (multiple keys pressed simultaneously). Example: Ctrl+Alt+Delete

Move the mouse cursor to a position on the remote machine. For absolute moves, coordinates are in screen pixels (0,0 = top-left). For relative moves, deltas are clamped to -127 to 127.

Click a mouse button on the remote machine. Optionally move to a pixel position first.

Scroll the mouse wheel on the remote machine.

Start mouse coordinate calibration. Moves cursor to screen center and returns expected position. Take a screenshot after calling this to visually verify actual cursor position, then call pikvm_set_calibration with calculated factors.

Set mouse coordinate calibration factors. Calculate factors as: factorX = expected_x / actual_x, factorY = expected_y / actual_y. For example, if calibration moved cursor to expected (960, 540) but it landed at (720, 405), factors would be 960/720=1.33 and 540/405=1.33.

Get current mouse calibration state. Returns null if not calibrated.

Clear mouse calibration, reverting to uncalibrated mode.

Automatically calibrate mouse coordinates by detecting the cursor position via screenshot diffing. This is more accurate than manual calibration. Moves the mouse multiple times, compares screenshots to find the cursor, and computes calibration factors. Other tools are blocked during calibration.

Guide for capturing screenshots with pikvm_screenshot

Guide for checking screen resolution with pikvm_get_resolution

Guide for typing text with pikvm_type

Guide for sending keys with pikvm_key

Guide for sending keyboard shortcuts with pikvm_shortcut

Guide for moving the mouse with pikvm_mouse_move

Guide for clicking with pikvm_mouse_click

Guide for automatic mouse calibration with pikvm_auto_calibrate

Guide for scrolling with pikvm_mouse_scroll

Step-by-step procedure for initializing a PiKVM session

Step-by-step procedure for calibrating mouse coordinates

Step-by-step procedure for automatic mouse calibration

Step-by-step procedure for finding and clicking a UI element

Step-by-step procedure for filling in a form on screen

Step-by-step procedure for navigating a desktop environment