Skip to the content
2 layers20 × 50 mmVkm, the printed circuit board in 3D

Virtual KVM

Size
20 × 50 mm
Copper layers
2
Thickness
1.2 mm
Parts
32
Nets
43
Pads
145
Tracks, vias
407, 20
Pours
8
Routed
Yes
KiCad
KiCad 5 (file 20171130)
Created
8 Nov 2023
Updated
15 Jun 2026

Overview

Vkm is an open-source printed circuit board by daniel-starke, from the daniel-starke/vkvm repository on GitHub. It is a 2-layer board of 20 × 50 mm with 32 parts on 43 nets, routed with 407 tracks and 20 vias.

It is built around the AMS1117-3.3 and APM4953KC-TRG. Its parts include 11 capacitors, 8 resistors, 4 connectors, 4 switches and 3 ICs. It belongs with the STM32 boards of this library.

Main components

2

README

README.md

vkvm

Virtual Keyboard Video Mouse equipment.
This project consists of a software part which runs on the host (controller) computer and a hardware unit (periphery). The periphery is connected via HDMI and USB to the USB port at the controller. The controller uses this connection to control the connected periphery computer. Control works similar to the control of a system running within a virtual machine.
The vkvm ensures a non-intrusive connection to the periphery device. Therefore, no special drivers or software is needed at the periphery. This grants maximum compatibility and high security not found in VPN or SSH like solutions and works also before OS start-up (e.g. remote BIOS control).

txt
+------------+       +----------------------+      +---------------+
|            |  <--- | Video Capture Device | <--- |               |
| Controller |       +----------------------+      | Remote Device |
|            |  <--> | VKVM Periphery       | <--> |               |
+------------+       +----------------------+      +---------------+

Features

  • control application support for Windows and Linux
  • USB UVC capture device compatible at controller
  • USB HID boot keyboard/mouse compatible at periphery
  • easy setup and use via plug'n'play
  • cheap, small, low latency and portable design
  • supports direct video output capture of periphery or web cam based operation
  • multiple hardware variants are available to meet different hardware assembly skills and usage requirements
  • remote device access before OS startup (e.g. enter BitLocker password or set BIOS settings)

Usage

Use an available display to USB (not the other way around) converter to capture the video output of a periphery machine at the controller. See chapter example for some possible variants. Connect the VKVM hardware device to controller and periphery to control the keyboard and mouse of the periphery via the controller. The vkvm control application enables you to perform the described hardware connection on software level.
Here you choose the connected capture source and serial interface which connects the vkvm hardware. Click into the video frame to start controlling the remote device. Hit the right SHIFT and right CTRL key to return control. Alternatively, press CTRL-K without a connected capture source for blind control. This can be useful when controlling the periphery device with a connected physical monitor.
To improve periphery operation, multiple ways of inputting data from controller (paste text) are provided. Each type exists due to different compatibilities, either by applications or on OS level.
Most of the user interface is made up of icons to avoid language barriers.

Status LED of the VKVM periphery:

LEDStateMeaning
always offNo remote device connected.
LED0blinkingPower from remote device but not USB connection.
LED1always onFully connected to remote device.

Documentation

Building

Linux GCC Build Status Windows Visual Studio Build Status

The following dependencies are given.
Controller:

  • C99
  • C++11
  • FLTK 1.3.4-1
  • nanosvg (modified source included)
  • OpenGL
  • DirectShow (only on Windows)
  • libv4l2 (only on Linux)
  • lv4lconvert (only on Linux)

Periphery:

Choose the appropriate Makefile to match your target system configuration.
Windows with MinGW and GCC:

sh
make -f Makefile.mingw

Linux with GCC:

sh
make -f Makefile.linux

This creates two applications:

  • vkvm
    The actual VKVM control application.
  • keyTest
    Development tool to create the OS key code to USB key code mapping.

To build and upload the firmware (depending on the target hardware):

sh
pio run -e arduino -t upload
pio run -e vkm-b-controller -t upload
pio run -e vkm-b-periphery -t upload

Note that VKVM_LED_PWM for vkm-b-periphery can be changed in platformio.ini to any value between 0 and 65535 to adjust the brightness of the status LED.

Also note that it is possible to set upload_protocol = dfu for STM32CubeDuino in platformio.ini allowing first time programming via USB.

Open Points

  • command-line operations for instant video/serial connect and full screen switch
  • automatically reconnect last serial/video device if it re-appears and was not disconnected by user
  • alternative serial/video implementation using libusb/libuvc
  • force aspect ratio option in aspect ratio button
  • audio support
  • configurable hot keys
  • media key support (needs changes in the periphery firmware)
  • fast store and load option for capture source settings
  • option for file exchange via USB MTP (media transfer protocol)
  • option for shared network access via USB ECM (Ethernet control model)

Limitation

  • keyboard and mouse input may not work with the Arduino firmware variant due to legacy BIOS incompatibilities with the CDC interface included by Arduino
  • no OCR support (out of scope and can be done with existing screen reader applications)
  • root permissions are required for the vkvm application on Linux

Debugging

Choose the appropriate Makefile to match your target system configuration.
Windows with MinGW and GCC:

sh
make -f Makefile.mingw DEBUG=1

Linux with GCC:

sh
make -f Makefile.linux DEBUG=1

The macro VKVM_TRACE can be defined to create the serial trace file vkvm.log during runtime. The GAWK script script/prot-dec.awk is able to decode this file into a human readable format. The macro can be enabled by passing TRACE=1 to Gnumake.

To debug the periphery firmware run:

sh
pio debug -e vkm-b-periphery
pio run -e vkm-b-periphery -t upload -t nobuild
pio debug  -e vkm-b-periphery --interface=gdb -- -x .pioinit

The HID reports on the periphery device can be traced using Wireshark (see description).

In Linux it is also possible to read and analyze the HID reports with the following command:

sh
cat /sys/kernel/debug/<dev>/events

This shows how the Linux HID driver interprets the HID reports.

License

See LICENSE.

Contributions

No content contributions are accepted. Please file a bug report or feature request instead.
This decision was made in consideration of the used license.

Parts

32
QtyValueFootprintReferences
9100nCapacitor_SMD:C_0603_1608MetricC1, C2, C3, C4, C5, C6, C8, C9, C10
410kResistor_SMD:R_0603_1608MetricR3, R4, R7, R8
4SW_PushButton_Switch_SMD:SW_SPST_TL3342SW1, SW2, SW3, SW4
210uCapacitor_Tantalum_SMD:CP_EIA-3216-10_Kemet-IC7, C11
22.2kResistor_SMD:R_0603_1608MetricR5, R6
25.1kResistor_SMD:R_0603_1608MetricR1, R2
2Conn_01x04Connector_PinHeader_2.54mm:PinHeader_1x04_P2.54mm_VerticalJ2, J3
2STM32F042F6PxPackage_SO:TSSOP-20_4.4x6.5mm_P0.65mmU1, U2
1AMS1117-3.3Package_TO_SOT_SMD:SOT-223-3_TabPin2U3
1APM4953KC-TRGPackage_SO:SOP-8_3.9x4.9mm_P1.27mmQ1
1MountingHoleMountingHole:MountingHole_3.2mm_M3_DIN965_PadH1
1USB_AConnector_USB:USB_A_TH_AM90J4
1USB_C_ReceptacleConnector_USB:USB_C_HRO_TYPE_C_31_M_12J1

More from daniel-starke/vkvm

2
  • 2 layers18.5 × 35.8 mmVkm, the printed circuit board in 3D

    Vkm

    daniel-starke/vkvm

    Virtual KVM

    35 parts3
  • 2 layers18.3 × 36.1 mmSer, the printed circuit board in 3D

    Ser

    daniel-starke/vkvm

    Virtual KVM

    14 parts3

Similar boards

  • 2 layers290.1 × 130 mmPro V2, the printed circuit board in 3D

    Pro V2

    kata0510/Lily58

    6×4+4keys column-staggered split keyboard.

    312 parts2.3k
  • 2 layers26.2 × 45.5 mmPL18 multiprotocol, the printed circuit board in 3D

    PL18 multiprotocol

    pascallanger/DIY-Multiprotocol-TX-Module

    Multiprotocol TX Module (or MULTI-Module) is a 2.4GHz transmitter module which controls many different receivers and models.

    24 parts1.9kGPL-3.0
  • 4 layers99 × 53.3 mmPSLab, the printed circuit board in 3D

    PSLab

    fossasia/pslab-hardware

    PSLab Hardware Design and Schematics https://pslab.io

    199 parts1.7kApache-2.0
  • 4 layers85 × 56 mmPslab mini, the printed circuit board in 3D

    Pslab mini

    fossasia/pslab-mini-hardware

    PSLab Mini Hardware https://pslab.io

    182 parts1.2kApache-2.0
  • 4 layers100 × 54 mm32Bit shift register, the printed circuit board in 3D

    32Bit shift register

    MaltWhiskey/Mega-Cube

    16x16x16 PL9823 Cube with Teensy 4.0 and FlexIO driver

    64 parts766
  • 2 layers44.2 × 29.3 mmI2c tiny usb, the printed circuit board in 3D

    I2c tiny usb

    harbaum/I2C-Tiny-USB

    Cheap and simple I²C to USB interface

    27 parts454
  • 2 layers78 × 60 mmIce viz, the printed circuit board in 3D

    Ice viz

    muni-works/vcad

    BRep CAD kernel in Rust/WASM

    44 parts442Apache-2.0
  • 2 layers59.1 × 99.9 mmCheap FOCer 2 60mm, the printed circuit board in 3D

    Cheap FOCer 2 60mm

    shamansystems/Cheap-FOCer-2

    Low-Cost Motor Controller based on the VESC 6

    193 parts407

Questions

How big is the Vkm PCB?

It measures 20 × 50 mm and has 2 copper layers, 1.2 mm thick.

What parts does the Vkm use?

32 parts, built around the AMS1117-3.3 and APM4953KC-TRG. The full list of its parts is on this page, with links to each part's symbol and footprint where PCBKit's library has them.

Where can I download the Vkm KiCad files?

From the daniel-starke/vkvm repository on GitHub, at the commit this page was made from: the board is hw/vkm-b/vkm.kicad_pcb. PCBKit opens the board in the browser, with nothing to install.

Can I use the Vkm design in my own project?

Its repository states no licence, so its author keeps all rights: ask daniel-starke before reusing the design.