HID Terminal

The HID Terminal plugin is a powerful tool designed for direct low-level communication with Human Interface Devices (HID). HID devices, such as keyboards, mice, and card readers, operate over USB or Bluetooth and share unique properties. The HID Terminal plugin leverages these properties to provide a streamlined and efficient way to interact with HID devices.

Capabilities

Required

org.jancy.io.usb
 Required for low-level IO operations on USB endpoints.

Basic Setup

  1. In IO Ninja, click the “New Session” dropdown and select a new “HID” session
_images/hid-getting-started-1.png
  1. From the “Device:” dropdown menu, select the HID device you want to communicate with.
_images/hid-getting-started-2.png
  1. Click the “Open” button, to the right of the device selection dropdown.
_images/hid-getting-started-3.png
  1. In the “Control” pane, send and receive as needed to communicate with your HID device.
_images/hid-getting-started-4.png
  1. Adjust settings as needed via the “Settings” button (see “Settings” section below for details)

Output & Feature Requests

With HID devices, output reports are used to send immediate commands, such as setting LED states, typically transmitted over an interrupt OUT endpoint for real-time control, while feature reports are employed for configuration, status queries, or extended device-specific functions, exchanged over the control endpoint via requests, allowing bidirectional communication for settings that are less time-critical. IO Ninja employs a “Control” pane that lets you select HID output and feature reports, receive current values, and alter the values of individual properties.

_images/hid-output-feature-reports.png

Settings

_images/hid-settings.png
Setting Description Default
Device The HID device to be monitored.  
Read mode Specify the HID input report mode. Useful as a bypass for devices that don’t allow reading of HID communications. See available options. Normal (read)
Read block size (B) The size of each individual read block submitted to the underlying transport. 4KB
RX buffer size (B) The full size of the incoming data (RX) buffer. Affects read throughput. 16KB

Read Mode Options

Mode Description
Normal (read) Read the HID device communications normally.
Disabled (don’t read) Disable reading of the HID device communications.