`node-hid` 使用教程

本教程将引导您了解 node-hid 开源项目，该库用于通过 Node.js 访问和控制 USB 和蓝牙 HID（人机交互设备）。

1. 项目目录结构及介绍

在 node-hid 的根目录中，主要的文件和目录包括：

• lib/ - 包含项目的核心 JavaScript 代码和 C++ 绑定。

  • hid.js - 提供 Node.js 中的 HID 设备接口。
  • index.js - 入口文件，导出 hid 模块。
  • binding.gyp - 用于构建过程的配置文件。
  • _binding/** - 编译后的 C++ 绑定。

• test/ - 测试用例和脚本。

• examples/ - 示例代码，展示如何使用库的基本功能。

• README.md - 项目说明和安装指南。

• package.json - 项目的元数据，包括依赖、版本等信息。

2. 项目的启动文件介绍

在 node-hid 中，启动文件主要是指从 Node.js 环境中引入 hid 模块并调用其方法的脚本。例如，您可以创建一个名为 main.js 的文件来初始化和操作 HID 设备：

// 引入 hid 模块
const HID = require('hid');

// 列出所有可用的 HID 设备
HID.list((err, devices) => {
  if (err) throw err;
  console.log('Available HID devices:', devices);
});

// 打开特定 VID:PID 的设备
const device = new HID.HID(1234, 5678); // 替换为实际的 VID:PID
device.open();
console.log(`Opened device: ${device.productString}`);

// 发送数据
const data = Buffer.from([0x1B, 0x00]);
device.write(data);

// 监听数据
device.on('data', (data) => {
  console.log('Received data:', data.toString('hex'));
});

// 关闭设备
device.close();
console.log('Device closed');

运行这个脚本需要确保已正确安装 node-hid 并执行 node main.js。

3. 项目的配置文件介绍

node-hid 本身没有特定的全局配置文件。不过，在您的应用中，您可以创建自己的配置文件来存储设备参数或设置，如 VID、PID、报告 ID 或其他特定于设备的数据。例如，可以创建一个 config.json 文件：

{
  "deviceId": {
    "vendorId": 1234,
    "productId": 5678,
    "interface": 0
  },
  "reports": {
    "outputReportId": 1,
    "inputReportId": 2
  }
}

然后在你的 Node.js 脚本中，读取这些配置以初始化和操作设备：

const fs = require('fs');
const JSON5 = require('json5'); // 为了处理注释和非严格 JSON

// 读取配置
const config = JSON5.parse(fs.readFileSync('./config.json', 'utf8'));

// 使用配置打开设备
const device = new HID.HID(config.deviceId.vendorId, config.deviceId.productId, config.deviceId.interface);

请注意，这个 config.json 文件并不是 node-hid 项目的一部分，而是您自己应用程序中的实现方式。对于更复杂的应用场景，还可以考虑使用环境变量或外部配置管理库来管理配置。

完成上述步骤后，您应该能够成功地集成和利用 node-hid 库来操控 USB 和蓝牙 HID 设备了。如果有任何问题或需要进一步的帮助，请查阅项目官方文档或在GitHub上提交问题。