# hid 库模块帮助文档

## hid 成员列表 <a id="hid" href="#hid">&#x23;</a>

USB HID 通信接口

### hid.device() <a id="hid.device" href="#hid.device">&#x23;</a>
[返回对象:hiddeviceObject](#hiddeviceObject)

### hid.device(path) <a id="hid.device" href="#hid.device">&#x23;</a>
打开设备返回句柄,参数为each迭代器返回的deviceInfo.path

### hid.device(vendorId,productId,serialNumber) <a id="hid.device" href="#hid.device">&#x23;</a>
打开设备返回句柄

## hid.device 成员列表 <a id="hid.device" href="#hid.device">&#x23;</a>

### hid.device.each() <a id="hid.device.each" href="#hid.device.each">&#x23;</a>
[返回对象:hidapideviceInfoObject](#hidapideviceInfoObject)

### hid.device.each(vid,pid) <a id="hid.device.each" href="#hid.device.each">&#x23;</a>

```aardio
for deviceInfo in hid.device.each() {

}
```

## hidapideviceInfoObject 成员列表 <a id="hidapideviceInfoObject" href="#hidapideviceInfoObject">&#x23;</a>

### hidapideviceInfoObject.interfaceNumber <a id="hidapideviceInfoObject.interfaceNumber" href="#hidapideviceInfoObject.interfaceNumber">&#x23;</a>
接口编号

### hidapideviceInfoObject.manufacturerString <a id="hidapideviceInfoObject.manufacturerString" href="#hidapideviceInfoObject.manufacturerString">&#x23;</a>
制造商,字符串

### hidapideviceInfoObject.path <a id="hidapideviceInfoObject.path" href="#hidapideviceInfoObject.path">&#x23;</a>
设备路径

### hidapideviceInfoObject.productId <a id="hidapideviceInfoObject.productId" href="#hidapideviceInfoObject.productId">&#x23;</a>
产品ID

### hidapideviceInfoObject.productString <a id="hidapideviceInfoObject.productString" href="#hidapideviceInfoObject.productString">&#x23;</a>
产品,字符串

### hidapideviceInfoObject.releaseNumber <a id="hidapideviceInfoObject.releaseNumber" href="#hidapideviceInfoObject.releaseNumber">&#x23;</a>
设备版本号

### hidapideviceInfoObject.serialNumber <a id="hidapideviceInfoObject.serialNumber" href="#hidapideviceInfoObject.serialNumber">&#x23;</a>
序列号

### hidapideviceInfoObject.usage <a id="hidapideviceInfoObject.usage" href="#hidapideviceInfoObject.usage">&#x23;</a>
使用ID

### hidapideviceInfoObject.usagePage <a id="hidapideviceInfoObject.usagePage" href="#hidapideviceInfoObject.usagePage">&#x23;</a>
使用页

### hidapideviceInfoObject.vendorId <a id="hidapideviceInfoObject.vendorId" href="#hidapideviceInfoObject.vendorId">&#x23;</a>
厂商ID

## hiddeviceObject 成员列表 <a id="hiddeviceObject" href="#hiddeviceObject">&#x23;</a>

### hiddeviceObject.close() <a id="hiddeviceObject.close" href="#hiddeviceObject.close">&#x23;</a>
关闭对象

### hiddeviceObject.errorMessage() <a id="hiddeviceObject.errorMessage" href="#hiddeviceObject.errorMessage">&#x23;</a>
返回错误信息

### hiddeviceObject.getFeatureReport() <a id="hiddeviceObject.getFeatureReport" href="#hiddeviceObject.getFeatureReport">&#x23;</a>
读功能报告,可选使用参数@1指定缓冲区长度

### hiddeviceObject.getIndexedString() <a id="hiddeviceObject.getIndexedString" href="#hiddeviceObject.getIndexedString">&#x23;</a>
获取索引字符串,可选使用参数@1指定缓冲区长度

### hiddeviceObject.getManufacturerString() <a id="hiddeviceObject.getManufacturerString" href="#hiddeviceObject.getManufacturerString">&#x23;</a>
读制造商字符串,可选使用参数@1指定缓冲区长度

### hiddeviceObject.getProductString() <a id="hiddeviceObject.getProductString" href="#hiddeviceObject.getProductString">&#x23;</a>
获取产品字符串,可选使用参数@1指定缓冲区长度

### hiddeviceObject.getSerialNumberString() <a id="hiddeviceObject.getSerialNumberString" href="#hiddeviceObject.getSerialNumberString">&#x23;</a>
获取序列号字符串,可选使用参数@1指定缓冲区长度

### hiddeviceObject.read() <a id="hiddeviceObject.read" href="#hiddeviceObject.read">&#x23;</a>
读数据,可选使用参数@1指定缓冲区长度

### hiddeviceObject.readTimeout() <a id="hiddeviceObject.readTimeout" href="#hiddeviceObject.readTimeout">&#x23;</a>
读数据,参数@1指定毫秒单位的超时值,  
可选使用参数@1指定缓冲区长度

### hiddeviceObject.sendFeatureReport(数据,长度,报告ID) <a id="hiddeviceObject.sendFeatureReport" href="#hiddeviceObject.sendFeatureReport">&#x23;</a>
写功能报告,除参数@1以外其他参数为可选参数

### hiddeviceObject.setNonblocking(true) <a id="hiddeviceObject.setNonblocking" href="#hiddeviceObject.setNonblocking">&#x23;</a>
启用非阻塞模式

### hiddeviceObject.write(数据,长度,报告ID) <a id="hiddeviceObject.write" href="#hiddeviceObject.write">&#x23;</a>
写数据,除参数@1以外其他参数为可选参数
