DeviceHidBinding

import { DeviceHidBinding } from "destack:device/binding";

Hid binding family.

language/library/src/device/binding/hid.ds:99:187

1export interface DeviceHidBinding {2    listHidDevices(query: &'a readonly HidDeviceQuery): Result<HidDevice[], HostError>;3    openHidDevice(id: &'a readonly string): Result<HidDeviceHandle, HostError>;4    closeHidDevice(device: HidDeviceHandle): Result<void, HostError>;5    readHidDescriptor(device: HidDeviceHandle): Result<uint8[], HostError>;6    readHidReport(device: HidDeviceHandle, maxBytes: uint32, timeoutNs?: uint64 | undefined): Result<HidReport, HostError>;7    writeHidReport(device: HidDeviceHandle, reportId: uint8, bytes: &'a readonly [uint8]): Result<uint32, HostError>;8    readHidFeature(device: HidDeviceHandle, reportId: uint8, maxBytes: uint32): Result<uint8[], HostError>;9    writeHidFeature(device: HidDeviceHandle, reportId: uint8, bytes: &'a readonly [uint8]): Result<void, HostError>;10}

Members

listHidDevices(query: &'a readonly HidDeviceQuery): Result<HidDevice[], HostError>: List HID devices.
openHidDevice(id: &'a readonly string): Result<HidDeviceHandle, HostError>: Open one HID device.
closeHidDevice(device: HidDeviceHandle): Result<void, HostError>: Close one HID device.
readHidDescriptor(device: HidDeviceHandle): Result<uint8[], HostError>: Read the HID report descriptor.
readHidReport(device: HidDeviceHandle, maxBytes: uint32, timeoutNs?: uint64 | undefined): Result<HidReport, HostError>: Read one HID input report.
writeHidReport(device: HidDeviceHandle, reportId: uint8, bytes: &'a readonly [uint8]): Result<uint32, HostError>: Write one HID output report.
readHidFeature(device: HidDeviceHandle, reportId: uint8, maxBytes: uint32): Result<uint8[], HostError>: Read one HID feature report.
writeHidFeature(device: HidDeviceHandle, reportId: uint8, bytes: &'a readonly [uint8]): Result<void, HostError>: Write one HID feature report.