@ichipcn/hid-sdk

面向 Chrome / Edge（WebHID）键盘驱动的 SmartCloud HID 协议 SDK，也可封装进 Electron。校验 License 字符串、打开 HID 设备，并在 core、keymap、macro、lighting、magnetic、screen 六个模块上提供类型化命令 API。

安装

pnpm add @ichipcn/hid-sdk

工具链需要 Node >=18。运行时目标为 Chrome / Edge 89+（WebHID）。

用法

import { createClient } from '@ichipcn/hid-sdk'

const sdk = await createClient({ license: LICENSE_STRING })

sdk.licensedModules        // ['core', 'keymap', 'lighting']
sdk.expiresAt              // Date，不过期则为 null
sdk.hasModule('magnetic')  // false → 灰化对应 UI

const device = await sdk.requestDevice()
await device.open()         // 2.4G 用 open({ rfSettleMs: 1200 })

测试夹具在 @ichipcn/hid-sdk/testing 子路径：

import { MockHidApi, createSignedTestLicense } from '@ichipcn/hid-sdk/testing'

许可

专有软件。 见 LICENSE.md。使用本 SDK 的权利来自有效的商业合同 以及 签发给该客户、限定设备范围的 License 字符串，而不是 npm 包的 license 字段。未经两者同时具备，不得复制、再分发、再许可或在生产环境使用本 SDK。