HID Data Reports

Developer Tools for X-keys

HID Data Reports

HID Data Reports are the low-level USB messages that X-keys devices use to communicate with a computer. These reports define how key presses, joystick movements, and other control inputs are sent to the host system—and how commands like backlighting are received in return. X-keys uses the standard USB HID (Human Interface Device) protocol, sending and receiving data on the HID Consumer Page for broad OS compatibility and flexible integration. This page provides access to our full report structure to help developers interface with X-keys devices on any operating system.

Download HID Data

File: PIEngineeringHIDReports.zip (v1082)

Size: 3.2 MB

Updated: April 29, 2025

Download HID Data .tar.gz

File: PIEngineeringHIDReports.tar.gz (v1082)

Size: 3.1 MB

Updated: April 29, 2025

Features

X-keys devices send Input Reports (device to OS) and receive Output Reports (OS to device).

Reports follow the USB HID class specification and use descriptors to identify functions like keyboard, mouse, and joystick.

For advanced functionality, X-keys also uses vendor-defined SPLAT messages on the HID Consumer Page, giving developers full control over features like backlighting, key states, and device settings.

These reports are readable via native USB HID drivers—no custom driver required.

Note: This setting resets each time X-keys is reconnected, so it may need to be toggled again.