Skip to content

开始使用

环境要求

  • Web环境:本SDK需要在localhost或https环境下使用
  • Electron环境:可直接使用,无环境限制
  • 浏览器支持:理论上支持所有谷歌内核浏览器(Chrome, Edge等)

安装

目前不支持npm包导入。

引入

直接通过文件引入。

示例

js
// service.js

// 导入HSDK
import { HSDK } from '../assets/lib/sdk/index';

// 创建HSDK对象
const service = new HSDK({
  filters: [{ usagePage: 0xff00, usage: 0x01 }],
});

export default service;

连接键盘

js
// 导入service
import service from "./service";

// 获取设备列表
const devices = await service.getDevices();

// 选择一个设备连接
const ret = await service.connectDevice(devices[0].id);

事件类型

js
export enum DEVICE_EVENT {
  DEVICE_CONNECT = 'DEVICE_CONNECT', // 设备连接
  DEVICE_DISCONNECT = 'DEVICE_DISCONNECT', // 设备断开
  DEVICE_UPDATE_REQUEST_DEVICE_STATUS = 'DEVICE_UPDATE_REQUEST_DEVICE_STATUS', // 更新请求设备状态
}

键盘插入事件

js
// 导入service
import service from "./service";

// 监听键盘插入事件
service.on(DEVICE_EVENT.DEVICE_CONNECT, () => {
  console.log('键盘插入事件');
});

键盘拔出事件

js
// 导入service
import service from "./service";

// 监听键盘拔出事件
service.on(DEVICE_EVENT.DEVICE_DISCONNECT, () => {
  console.log('键盘拔出事件');
});