1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
// **************************************************************************
// Copyright (c) 2015 Osspial All Rights Reserved.
//
// This file is part of hidapi-rs, based on hidapi_rust by Roland Ruckerbauer.
// *************************************************************************
//! This crate provides a rust abstraction over the features of the C library
//! hidapi by [signal11](https://github.com/libusb/hidapi).
//!
//! # Usage
//!
//! This crate is [on crates.io](https://crates.io/crates/hidapi) and can be
//! used by adding `hidapi` to the dependencies in your project's `Cargo.toml`.
//!
//! # Example
//!
//! ```rust,no_run
//! 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.
mod error;
mod ffi;
use cfg_if::cfg_if;
use libc::wchar_t;
use std::ffi::CStr;
use std::ffi::CString;
use std::fmt;
use std::fmt::Debug;
use std::sync::Mutex;
pub use error::HidError;
cfg_if! {
if #[cfg(all(feature = "linux-native", target_os = "linux"))] {
//#[cfg_attr(docsrs, doc(cfg(all(feature = "linux-native", target_os = "linux"))))]
mod linux_native;
use linux_native::HidApiBackend;
} else if #[cfg(all(feature = "windows-native", target_os = "windows"))] {
//#[cfg_attr(docsrs, doc(cfg(all(feature = "windows-native", target_os = "windows"))))]
mod windows_native;
use windows_native::HidApiBackend;
} else if #[cfg(hidapi)] {
mod hidapi;
use hidapi::HidApiBackend;
} else {
compile_error!("No backend selected");
}
}
// Automatically implement the top trait
cfg_if! {
if #[cfg(target_os = "windows")] {
#[cfg_attr(docsrs, doc(cfg(target_os = "windows")))]
mod windows;
use windows::GUID;
/// A trait with the extra methods that are available on Windows
trait HidDeviceBackendWindows {
/// Get the container ID for a HID device
fn get_container_id(&self) -> HidResult<GUID>;
}
trait HidDeviceBackend: HidDeviceBackendBase + HidDeviceBackendWindows + Send {}
impl<T> HidDeviceBackend for T where T: HidDeviceBackendBase + HidDeviceBackendWindows + Send {}
} else if #[cfg(target_os = "macos")] {
#[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
mod macos;
/// A trait with the extra methods that are available on macOS
trait HidDeviceBackendMacos {
/// Get the location ID for a [`HidDevice`] device.
fn get_location_id(&self) -> HidResult<u32>;
/// Check if the device was opened in exclusive mode.
fn is_open_exclusive(&self) -> HidResult<bool>;
}
trait HidDeviceBackend: HidDeviceBackendBase + HidDeviceBackendMacos + Send {}
impl<T> HidDeviceBackend for T where T: HidDeviceBackendBase + HidDeviceBackendMacos + Send {}
} else {
trait HidDeviceBackend: HidDeviceBackendBase + Send {}
impl<T> HidDeviceBackend for T where T: HidDeviceBackendBase + Send {}
}
}
pub type HidResult<T> = Result<T, HidError>;
pub const MAX_REPORT_DESCRIPTOR_SIZE: usize = 4096;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum InitState {
NotInit,
Init { enumerate: bool },
}
static INIT_STATE: Mutex<InitState> = Mutex::new(InitState::NotInit);
fn lazy_init(do_enumerate: bool) -> HidResult<()> {
let mut init_state = INIT_STATE.lock().unwrap();
match *init_state {
InitState::NotInit => {
#[cfg(all(libusb, not(target_os = "freebsd")))]
if !do_enumerate {
// Do not scan for devices in libusb_init()
// Must be set before calling it.
// This is needed on Android, where access to USB devices is limited
unsafe { ffi::libusb_set_option(std::ptr::null_mut(), 2) }
}
// Initialize the HID
#[cfg(hidapi)]
if unsafe { ffi::hid_init() } == -1 {
return Err(HidError::InitializationError);
}
#[cfg(all(target_os = "macos", feature = "macos-shared-device"))]
unsafe {
ffi::macos::hid_darwin_set_open_exclusive(0)
}
*init_state = InitState::Init {
enumerate: do_enumerate,
}
}
InitState::Init { enumerate } => {
if enumerate != do_enumerate {
panic!("Trying to initialize hidapi with enumeration={}, but it is already initialized with enumeration={}.", do_enumerate, enumerate)
}
}
}
Ok(())
}
/// `hidapi` context.
///
/// The `hidapi` C library is lazily initialized when creating the first instance,
/// and never deinitialized. Therefore, it is allowed to create multiple `HidApi`
/// instances.
///
/// Each instance has its own device list cache.
pub struct HidApi {
device_list: Vec<DeviceInfo>,
}
impl HidApi {
/// Create a new hidapi context.
///
/// Will also initialize the currently available device list.
///
/// # Panics
///
/// Panics if hidapi is already initialized in "without enumerate" mode
/// (i.e. if `new_without_enumerate()` has been called before).
pub fn new() -> HidResult<Self> {
lazy_init(true)?;
let mut api = HidApi {
device_list: Vec::with_capacity(8),
};
api.add_devices(0, 0)?;
Ok(api)
}
/// Create a new hidapi context, in "do not enumerate" mode.
///
/// This is needed on Android, where access to USB device enumeration is limited.
///
/// # Panics
///
/// Panics if hidapi is already initialized in "do enumerate" mode
/// (i.e. if `new()` has been called before).
pub fn new_without_enumerate() -> HidResult<Self> {
lazy_init(false)?;
Ok(HidApi {
device_list: Vec::new(),
})
}
/// Refresh devices list and information about them (to access them use
/// `device_list()` method)
/// Identical to `reset_devices()` followed by `add_devices(0, 0)`.
pub fn refresh_devices(&mut self) -> HidResult<()> {
self.reset_devices()?;
self.add_devices(0, 0)?;
Ok(())
}
/// Reset devices list. Intended to be used with the `add_devices` method.
pub fn reset_devices(&mut self) -> HidResult<()> {
self.device_list.clear();
Ok(())
}
/// Indexes devices that match the given VID and PID filters.
/// 0 indicates no filter.
pub fn add_devices(&mut self, vid: u16, pid: u16) -> HidResult<()> {
self.device_list
.append(&mut HidApiBackend::get_hid_device_info_vector(vid, pid)?);
Ok(())
}
/// Returns iterator containing information about attached HID devices
/// that have been indexed, either by `refresh_devices` or `add_devices`.
pub fn device_list(&self) -> impl Iterator<Item = &DeviceInfo> {
self.device_list.iter()
}
/// Open a HID device using a Vendor ID (VID) and Product ID (PID).
///
/// When multiple devices with the same vid and pid are available, then the
/// first one found in the internal device list will be used. There are however
/// no guarantees, which device this will be.
pub fn open(&self, vid: u16, pid: u16) -> HidResult<HidDevice> {
let dev = HidApiBackend::open(vid, pid)?;
Ok(HidDevice::from_backend(Box::new(dev)))
}
/// Open a HID device using a Vendor ID (VID), Product ID (PID) and
/// a serial number.
pub fn open_serial(&self, vid: u16, pid: u16, sn: &str) -> HidResult<HidDevice> {
let dev = HidApiBackend::open_serial(vid, pid, sn)?;
Ok(HidDevice::from_backend(Box::new(dev)))
}
/// The path name be determined by inspecting the device list available with [HidApi::devices()](struct.HidApi.html#method.devices)
///
/// Alternatively a platform-specific path name can be used (eg: /dev/hidraw0 on Linux).
pub fn open_path(&self, device_path: &CStr) -> HidResult<HidDevice> {
let dev = HidApiBackend::open_path(device_path)?;
Ok(HidDevice::from_backend(Box::new(dev)))
}
/// Open a HID device using libusb_wrap_sys_device.
#[cfg(libusb)]
pub fn wrap_sys_device(&self, sys_dev: isize, interface_num: i32) -> HidResult<HidDevice> {
let device = unsafe { ffi::hid_libusb_wrap_sys_device(sys_dev, interface_num) };
if device.is_null() {
match HidApiBackend::check_error() {
Ok(err) => Err(err),
Err(e) => Err(e),
}
} else {
let dev = hidapi::HidDevice::from_raw(device);
Ok(HidDevice::from_backend(Box::new(dev)))
}
}
/// Get the last non-device specific error, which happened in the underlying hidapi C library.
/// To get the last device specific error, use [`HidDevice::check_error`].
///
/// The `Ok()` variant of the result will contain a [HidError::HidApiError](enum.HidError.html).
///
/// When `Err()` is returned, then acquiring the error string from the hidapi C
/// library failed. The contained [HidError](enum.HidError.html) is the cause, why no error could
/// be fetched.
#[cfg(hidapi)]
#[deprecated(since = "2.2.3", note = "use the return values from the other methods")]
pub fn check_error(&self) -> HidResult<HidError> {
HidApiBackend::check_error()
}
}
#[allow(dead_code)]
#[derive(Clone, PartialEq)]
enum WcharString {
String(String),
#[cfg_attr(all(feature = "linux-native", target_os = "linux"), allow(dead_code))]
Raw(Vec<wchar_t>),
None,
}
impl From<WcharString> for Option<String> {
fn from(val: WcharString) -> Self {
match val {
WcharString::String(s) => Some(s),
_ => None,
}
}
}
/// The underlying HID bus type.
#[repr(C)]
#[derive(Copy, Clone, Debug)]
pub enum BusType {
Unknown = 0x00,
Usb = 0x01,
Bluetooth = 0x02,
I2c = 0x03,
Spi = 0x04,
}
/// Device information. Use accessors to extract information about Hid devices.
///
/// Note: Methods like `serial_number()` may return None, if the conversion to a
/// String failed internally. You can however access the raw hid representation of the
/// string by calling `serial_number_raw()`
#[derive(Clone)]
pub struct DeviceInfo {
path: CString,
vendor_id: u16,
product_id: u16,
serial_number: WcharString,
release_number: u16,
manufacturer_string: WcharString,
product_string: WcharString,
#[allow(dead_code)]
usage_page: u16,
#[allow(dead_code)]
usage: u16,
interface_number: i32,
bus_type: BusType,
}
impl DeviceInfo {
pub fn path(&self) -> &CStr {
&self.path
}
pub fn vendor_id(&self) -> u16 {
self.vendor_id
}
pub fn product_id(&self) -> u16 {
self.product_id
}
/// Try to call `serial_number_raw()`, if None is returned.
pub fn serial_number(&self) -> Option<&str> {
match self.serial_number {
WcharString::String(ref s) => Some(s),
_ => None,
}
}
pub fn serial_number_raw(&self) -> Option<&[wchar_t]> {
match self.serial_number {
WcharString::Raw(ref s) => Some(s),
_ => None,
}
}
pub fn release_number(&self) -> u16 {
self.release_number
}
/// Try to call `manufacturer_string_raw()`, if None is returned.
pub fn manufacturer_string(&self) -> Option<&str> {
match self.manufacturer_string {
WcharString::String(ref s) => Some(s),
_ => None,
}
}
pub fn manufacturer_string_raw(&self) -> Option<&[wchar_t]> {
match self.manufacturer_string {
WcharString::Raw(ref s) => Some(s),
_ => None,
}
}
/// Try to call `product_string_raw()`, if None is returned.
pub fn product_string(&self) -> Option<&str> {
match self.product_string {
WcharString::String(ref s) => Some(s),
_ => None,
}
}
pub fn product_string_raw(&self) -> Option<&[wchar_t]> {
match self.product_string {
WcharString::Raw(ref s) => Some(s),
_ => None,
}
}
/// Usage page is not available on linux libusb backends
#[cfg(not(all(libusb, target_os = "linux")))]
pub fn usage_page(&self) -> u16 {
self.usage_page
}
/// Usage is not available on linux libusb backends
#[cfg(not(all(libusb, target_os = "linux")))]
pub fn usage(&self) -> u16 {
self.usage
}
pub fn interface_number(&self) -> i32 {
self.interface_number
}
pub fn bus_type(&self) -> BusType {
self.bus_type
}
/// Use the information contained in `DeviceInfo` to open
/// and return a handle to a [HidDevice](struct.HidDevice.html).
///
/// By default the device path is used to open the device.
/// When no path is available, then vid, pid and serial number are used.
/// If both path and serial number are not available, then this function will
/// fail with [HidError::OpenHidDeviceWithDeviceInfoError](enum.HidError.html#variant.OpenHidDeviceWithDeviceInfoError).
///
/// Note, that opening a device could still be done using [HidApi::open()](struct.HidApi.html#method.open) directly.
pub fn open_device(&self, hidapi: &HidApi) -> HidResult<HidDevice> {
if !self.path.as_bytes().is_empty() {
hidapi.open_path(self.path.as_c_str())
} else if let Some(sn) = self.serial_number() {
hidapi.open_serial(self.vendor_id, self.product_id, sn)
} else {
Err(HidError::OpenHidDeviceWithDeviceInfoError {
device_info: Box::new(self.clone()),
})
}
}
}
impl fmt::Debug for DeviceInfo {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("HidDeviceInfo")
.field("vendor_id", &self.vendor_id)
.field("product_id", &self.product_id)
.finish()
}
}
/// Trait which the different backends must implement
trait HidDeviceBackendBase {
#[cfg(hidapi)]
fn check_error(&self) -> HidResult<HidError>;
fn write(&self, data: &[u8]) -> HidResult<usize>;
fn read(&self, buf: &mut [u8]) -> HidResult<usize>;
fn read_timeout(&self, buf: &mut [u8], timeout: i32) -> HidResult<usize>;
fn send_feature_report(&self, data: &[u8]) -> HidResult<()>;
fn get_feature_report(&self, buf: &mut [u8]) -> HidResult<usize>;
fn set_blocking_mode(&self, blocking: bool) -> HidResult<()>;
fn get_device_info(&self) -> HidResult<DeviceInfo>;
fn get_manufacturer_string(&self) -> HidResult<Option<String>>;
fn get_product_string(&self) -> HidResult<Option<String>>;
fn get_serial_number_string(&self) -> HidResult<Option<String>>;
fn get_report_descriptor(&self, buf: &mut [u8]) -> HidResult<usize>;
fn get_indexed_string(&self, _index: i32) -> HidResult<Option<String>> {
Err(HidError::HidApiError {
message: "get_indexed_string: not supported".to_string(),
})
}
}
pub struct HidDevice {
inner: Box<dyn HidDeviceBackend>,
}
impl Debug for HidDevice {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("HidDevice").finish_non_exhaustive()
}
}
impl HidDevice {
fn from_backend(inner: Box<dyn HidDeviceBackend>) -> Self {
Self { inner }
}
}
// Methods that use the backend
impl HidDevice {
/// Get the last error, which happened in the underlying hidapi C library.
///
/// The `Ok()` variant of the result will contain a [HidError::HidApiError](enum.HidError.html).
///
/// When `Err()` is returned, then acquiring the error string from the hidapi C
/// library failed. The contained [HidError](enum.HidError.html) is the cause, why no error could
/// be fetched.
#[cfg(hidapi)]
#[deprecated(since = "2.2.3", note = "use the return values from the other methods")]
pub fn check_error(&self) -> HidResult<HidError> {
self.inner.check_error()
}
/// Write an Output report to a HID device.
///
/// The first byte of `data` must contain the Report ID. For
/// devices which only support a single report, this must be set
/// to 0x0. The remaining bytes contain the report data. Since
/// the Report ID is mandatory, calls to `write()` will always
/// contain one more byte than the report contains. For example,
/// if a hid report is 16 bytes long, 17 bytes must be passed to
/// `write()`, the Report ID (or 0x0, for devices with a
/// single report), followed by the report data (16 bytes). In
/// this example, the length passed in would be 17.
/// `write()` will send the data on the first OUT endpoint, if
/// one exists. If it does not, it will send the data through
/// the Control Endpoint (Endpoint 0).
///
/// If successful, returns the actual number of bytes written.
pub fn write(&self, data: &[u8]) -> HidResult<usize> {
self.inner.write(data)
}
/// Read an Input report from a HID device.
///
/// Input reports are returned to the host through the 'INTERRUPT IN'
/// endpoint. The first byte will contain the Report number if the device
/// uses numbered reports.
///
/// If successful, returns the actual number of bytes read.
pub fn read(&self, buf: &mut [u8]) -> HidResult<usize> {
self.inner.read(buf)
}
/// Read an Input report from a HID device with timeout.
///
/// Input reports are returned to the host through the 'INTERRUPT IN'
/// endpoint. The first byte will contain the Report number if the device
/// uses numbered reports. Timeout measured in milliseconds, set -1 for
/// blocking wait.
///
/// If successful, returns the actual number of bytes read.
pub fn read_timeout(&self, buf: &mut [u8], timeout: i32) -> HidResult<usize> {
self.inner.read_timeout(buf, timeout)
}
/// Send a Feature report to the device.
///
/// Feature reports are sent over the Control endpoint as a
/// Set_Report transfer. The first byte of `data` must contain the
/// 'Report ID'. For devices which only support a single report, this must
/// be set to 0x0. The remaining bytes contain the report data. Since the
/// 'Report ID' is mandatory, calls to `send_feature_report()` will always
/// contain one more byte than the report contains. For example, if a hid
/// report is 16 bytes long, 17 bytes must be passed to
/// `send_feature_report()`: 'the Report ID' (or 0x0, for devices which
/// do not use numbered reports), followed by the report data (16 bytes).
/// In this example, the length passed in would be 17.
///
/// If successful, returns the actual number of bytes written.
pub fn send_feature_report(&self, data: &[u8]) -> HidResult<()> {
self.inner.send_feature_report(data)
}
/// Get a feature report from a HID device.
///
/// Set the first byte of `buf` to the 'Report ID' of the report to be read.
/// Upon return, the first byte will still contain the Report ID, and the
/// report data will start in `buf[1]`.
///
/// If successful, returns the number of bytes read plus one for the report ID (which is still
/// in the first byte).
pub fn get_feature_report(&self, buf: &mut [u8]) -> HidResult<usize> {
self.inner.get_feature_report(buf)
}
/// Set the device handle to be in blocking or in non-blocking mode. In
/// non-blocking mode calls to `read()` will return immediately with an empty
/// slice if there is no data to be read. In blocking mode, `read()` will
/// wait (block) until there is data to read before returning.
/// Modes can be changed at any time.
pub fn set_blocking_mode(&self, blocking: bool) -> HidResult<()> {
self.inner.set_blocking_mode(blocking)
}
/// Get The Manufacturer String from a HID device.
pub fn get_manufacturer_string(&self) -> HidResult<Option<String>> {
self.inner.get_manufacturer_string()
}
/// Get The Manufacturer String from a HID device.
pub fn get_product_string(&self) -> HidResult<Option<String>> {
self.inner.get_product_string()
}
/// Get The Serial Number String from a HID device.
pub fn get_serial_number_string(&self) -> HidResult<Option<String>> {
self.inner.get_serial_number_string()
}
/// Get a string from a HID device, based on its string index.
pub fn get_indexed_string(&self, index: i32) -> HidResult<Option<String>> {
self.inner.get_indexed_string(index)
}
/// Get a report descriptor from a HID device
///
/// User has to provide a preallocated buffer where the descriptor will be copied to.
/// It is recommended to use a preallocated buffer of [`MAX_REPORT_DESCRIPTOR_SIZE`] size.
pub fn get_report_descriptor(&self, buf: &mut [u8]) -> HidResult<usize> {
self.inner.get_report_descriptor(buf)
}
/// Get [`DeviceInfo`] from a HID device.
pub fn get_device_info(&self) -> HidResult<DeviceInfo> {
self.inner.get_device_info()
}
}