node-hid:开创 Node 访问 USB & Bluetooth HID 先河?

大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发!

什么是 node-hid

node-hid 用于从 Node.js 访问 USB 和蓝牙 HID 设备。

node-hid 目前支持 Node.js v10 及更高版本,当然开发者依然可以使用旧版本。 一般来说,node-hid 会尝试为最常见的平台、Node 和 Electron 版本提供预构建的本机库二进制文件。

node-hid 支持的平台、架构和 Node 版本如下:

  • Windows x86 (32-bit)
  • Windows x64 (64-bit)
  • Mac OSX 10.9+
  • Linux x64
  • Linux x86
  • Linux ARM / Raspberry Pi / Various SBC
  • Linux ARM64 / Various SBC
  • Linux MIPSel
  • Linux PPC64

当然,node-hid 也尽力去做到跨平台,感兴趣的开发可以持续保持关注。

目前 node-hid 在Github上通过 MIT 协议开源,有 1.4k 的star、20.3k 的项目依赖量,妥妥的前端优质开源项目。

如何使用 node-hid

列举设备

以下示例列出所有连接的 HID 设备:

var HID = require('node-hid');
var devices = await HID.devicesAsync();

devices 包含一组对象,每个对象对应每个可用的 HID 设备,比如:供应商 ID 和产品 ID,其唯一标识设备以及打开特定设备所需的路径。

await HID.devicesAsync();
{ vendorId: 10168,
    productId: 493,
    path: 'IOService:/AppleACPIPl...HIDDevice@14210000,0',
    serialNumber: '20002E8C',
    manufacturer: 'ThingM',
    product: 'blink(1) mk2',
    release: 2,
    interface: -1,
    usagePage: 65280,
    usage: 1 },
  { vendorId: 1452,
    productId: 610,
    path: 'IOService:/AppleACPIPl...Keyboard@14400000,0',
    serialNumber: '',
    manufacturer: 'Apple Inc.',
    product: 'Apple Internal Keyboard / Trackpad',
    release: 549,
    interface: -1,
    usagePage: 1,
    usage: 6 },
    <and more>

打开设备

在读取或写入设备之前,必须将其打开。使用先前调用 HID.devices() 返回的列表中的路径:

var device = new HID.HID(path);

或打开与 VID/PID 对匹配的第一个设备:

var device = new HID.HID(vid, pid);

device 变量包含设备的句柄,如果打开设备时发生错误,则会抛出异常。

node-hid 设备是一个 EventEmitter, 虽然与 Readable 和 Writable 流共享一些方法名称和使用模式,但不是流,并且语义有所不同。 例如,device.write 不接受编码或回调参数,并且 device.pause 不执行与 Read.pause 相同的操作,也没有管道方法。

从设备列表中选择设备

如果需要过滤 HID.devices() 列表,可以使用标准 Javascript 数组技术:

var devices = HID.devices();
var deviceInfo = devices.find(function (d) {
  var isTeensy = d.vendorId === 0x16c0 && d.productId === 0x0486;
  return isTeensy && d.usagePage === 0xffab && d.usage === 0x200;
});
if (deviceInfo) {
  var device = new HID.HID(deviceInfo.path);
  // ... use device
}

还可以通过传递 VID 和 PID 来查找目标设备:

//return all the devices that match specified VID and PID
var devices = HID.devices(0x16c0, 0x0486);

从设备读取数据

要接收 FEATURE 报告,可以使用 device.getFeatureReport()。 要接收 INPUT 报告,可以使用 device.on("data",...)。node-hid 是一个 EventEmitter,从设备读取是通过注册“data”事件处理程序来执行:

device.on('data', function (data) {});

还可以通过如下方式侦听错误:

device.on('error', function (err) {});

要获取 FEATURE 信息可以如下设置:

var buf = device.getFeatureReport(reportId, reportLength);

需要注意的几个点:

  • 通过 device.on("data") 读取是异步的
  • 通过 device.getFeatureReport() 的读取是同步的
  • 要删除事件处理程序,请使用 device.close() 关闭设备
  • 当还没有数据处理程序或不存在数据处理程序时,根本不会读取数据,没有缓冲区。

写入设备

要发送 FEATURE 报告,可以使用 device.sendFeatureReport()。而发送 OUTPUT 报告,可以使用 device.write()。

所有写入都是同步的。

ReportId 是发送到 device.sendFeatureReport() 或 device.write() 的数组的第一个字节,这意味着该数组应该比报告大一个字节。 如果设备不使用编号报告,请将第一个字节设置为 0x00。

device.write([0x00, 0x01, 0x01, 0x05, 0xff, 0xff]);
device.sendFeatureReport([0x01, 'c', 0, 0xff, 0x33, 0x00, 70, 0, 0]);

需要注意的是:

  • 必须发送所选 OUTPUT 或 FEATURE 的确切字节数。
  • device.write() 和 device.sendFeatureReport() 都返回写入的字节数 + 1。
  • 对于使用报告 ID 的设备,要 write() 或 sendFeatureReport() 的数组的第一个字节必须是报告 ID。

参考资料

https://github.com/node-hid/node-hid#node-hid---access-usb-hid-devices-from-nodejs

https://www.youtube.com/watch?v=eggQgjk3qjc

原文链接:,转发请注明来源!