← Integrations

ESP-KVM with a VNC client

Turn on the VNC server and TigerVNC shows the target's screen and drives its keyboard and mouse over TLS, with the same H.264 stream as the browser.

The device has a VNC server, written by Jan Heil. A VNC client shows the target's screen and sends it the keyboard and the mouse, next to the browser console or instead of it. It is off by default.

Setting it up

  1. In the console open Settings, Video, VNC server.
  2. Set a password of up to 8 characters. That is a limit of VNC's own sign-in, so use all 8.
  3. Turn on VNC server. The port is 5900.
  4. Point the client at the device's address.

A script can ask POST /api/v1/vnc/session for a password that works once, within 60 seconds.

Clients

TigerVNC gets the same H.264 stream as the browser: 26 fps at 1080p on a JetKVM Mini. It needs a build with H.264, version 1.13 or newer (the Windows builds have it, on Linux it needs FFmpeg), and H.264 as the stream codec on the device: Settings, Video, Picture. Other clients get JPEG, about 20 fps at 1080p on the same Mini.

A client needs Tight encoding for JPEG, and VeNCrypt for TLS. These have both:

ClientRuns onPictureGet it
TigerVNCWindows, Linux, macOSH.264 or JPEGtigervnc.org
TurboVNCWindows, Linux, macOSJPEGturbovnc.org
RemminaLinuxJPEGremmina.org
AVNCAndroidJPEGF-Droid, Google Play
bVNCAndroidJPEGGoogle Play, source
MultiVNCAndroidJPEGF-Droid, Google Play

RealVNC Viewer and the screen sharing app on a Mac have no Tight encoding, so they cannot connect.

From outside

VNC is plain TCP on port 5900. It does not find its way through NAT like the browser's WebRTC does. Reach it over Tailscale or WireGuard, both built into the firmware, and keep plain VNC without TLS on your own network.

One client at a time

A new client that signs in takes over from the one before it, and a wrong password does not end the session. The console lists the VNC client with the other viewers. Clients that come over the device's own hotspot are turned away unless VNC over the hotspot is on.