Crate hidapi

This crate provides a rust abstraction over the features of the C library hidapi by signal11.

Usage

This crate is on crates.io and can be used by adding hidapi to the dependencies in your project’s Cargo.toml.

Example

extern crate hidapi;

use hidapi::HidApi;

fn main() {
    println!("Printing all available hid devices:");

    match HidApi::new() {
        Ok(api) => {
            for device in api.device_list() {
                println!("{:04x}:{:04x}", device.vendor_id(), device.product_id());
            }
        },
        Err(e) => {
            eprintln!("Error: {}", e);
        },
    }
}

For more usage examples, please take a look at the examples/ directory.

Feature flags

• linux-static-libusb: uses statically linked libusb backend on Linux
• linux-static-hidraw: uses statically linked hidraw backend on Linux (default)
• linux-shared-libusb: uses dynamically linked libusb backend on Linux
• linux-shared-hidraw: uses dynamically linked hidraw backend on Linux
• linux-native: talks to hidraw directly without using the hidapi C library
• illumos-static-libusb: uses statically linked libusb backend on Illumos (default)
• illumos-shared-libusb: uses statically linked hidraw backend on Illumos
• macos-shared-device: enables shared access to HID devices on MacOS
• windows-native: talks to hid.dll directly without using the hidapi C library

Linux backends

On linux the libusb backends do not support DeviceInfo::usage() and DeviceInfo::usage_page(). The hidraw backend has support for them, but it might be buggy in older kernel versions.

MacOS Shared device access

Since hidapi 0.12 it is possible to open MacOS devices with shared access, so that multiple HidDevice handles can access the same physical device. For backward compatibility this is an opt-in that can be enabled with the macos-shared-device feature flag.

Structs

DeviceInfo

Device information. Use accessors to extract information about Hid devices.

HidApi

hidapi context.

HidDevice

Enums

BusType

The underlying HID bus type.

HidError

Constants

MAX_REPORT_DESCRIPTOR_SIZE

Type Aliases

HidResult