Developer Resources for X-keys

Programming and development should be fun. We offer these resources to make your work easier and more enjoyable. Click on a heading to go to the related page.

Download Windows SDK

PI Engineering SDK (v1074) (20.6 MB)
Updated: 2/22/2024

Software Development Kits for Windows

  • All of our USB devices follow standard HID protocol and are capable of direct interaction with your application.
  • Our SDK supports with all currently shipping X-keys devices and includes examples for C#, C++, and Visual Basic.
Go To Github

github.com/piengineering/XkeysOSX

Software Development Kits for Mac

  • Xcode workspace with two projects: one for the viewer application, and one for the Xkeys framework
Download Android SDK

Eclipse (888kb)
Updated:4/4/14

Software Development Kits for Android

  • Here you will find applications (with full source code) that we have created.
  • IDE: Eclipse
  • Check back regularly; more will be added as we further consider the Android platform.
Go To Github

github.com/piengineering/X-keys_Linux

Software Development Kits for Linux

  • Open source Linux support for X-keys Pi3 generation devices including our X-keys XK-24, XK-12 Jog & Shuttle, XK-12 Joystick, and XK-3 Foot Pedals.
  • Reads all X-keys controls and key states and includes a simple, straightforward GUI.
  • Written by Linux HID expert Alan Ott
Download HID Data

PIEngineeringHIDReports.zip (v1074) (2.67 MB)
Updated: 3/8/2024

HID Data Reports

  • HID Data Reports are USB messages used to communicate with X-keys
  • X-keys sends and receives reports on the HID Consumer Page
  • Both input (X-keys to OS) and output (OS to X-keys)
Download Integration Guide

X-keysIntegrationGuide.pdf (883 KB)

Integration Options

  • Hardware Mode
  • Software Mode with MacroWorks Software
  • Software Mode with a Custom Application