键盘SDK文档

由于浏览器安全机制问题在调用sdk时候需要走的是hid协议，所以在最开始需要进行浏览器授权，授权成功后才能调用sdk。

开始

引入

pnpm add  @sparklinkplayjoy/sdk-keyboard

搭建项目

项目引用

1. 引入

import Keyboard from '@sparklinkplayjoy/sdk-keyboard'
const vendorId = 00 // you vid 
const productId = 00 // you pid 
const ServiceKeyboard = new Keyboard({
  configs: [{ vendorId, productId, usagePage: 65440, usage: 1 }],
  usage: 1,
  usagePage: 65440,
});

2. 获取授权

// 得到当前的设置列表
const devices = await ServiceKeyboard.getDevices()

3. 初始化设备

// 从当前设备列表中获取其中一个设备
const { id } = devices[0]
const result = await ServiceKeyboard.init(id)

4. 监听hid拔插事件

services.on("usbChange", (data) => {
          const { device } = data;

          if (data.type === 'disconnect' || data.type === 'isUpgrading_disconnect') {
          }
          if (data.type === 'connect' || (data.type === 'isUpgrading_connect' && data.reconnect)) {
            if (device?.collections?.length) {
              try {
                const targetCollection = device.collections.find(
                  (collection) => collection.usage === 1 && collection.usagePage === 0xffb0,
                );

                if (targetCollection) {
                 
                }
              } catch (error) {
                
              }
            } 
          }
        });

services.off('usbChange',listener) // 移除监听