@hfd-sdk/keyboard-kit 1.0.0 → 1.1.0

package/dist/runtime.es.js

@@ -1,4 +1,4 @@
-import { k as p, c as _, x as y, l as d, o as m, a as w, m as b, r as k, s as v, p as x, t as z, w as h } from "./runtime-core.es.js";
+import { c as p, b as _, d, z as m, p as y, o as b, f as v, q as w, r as z, s as h, a as j, v as k, t as x, w as F } from "./runtime-core.es.js";
 function s(e) {
   const n = {};
   for (const [o, t] of Object.entries(e))
@@ -9,18 +9,18 @@ function a(e) {
   const n = {};
   for (const [o, t] of Object.entries(e)) {
     const r = t;
-    n[o] = r && typeof r == "object" && r.__fn__ ? c(r.body) : t;
+    n[o] = r && typeof r == "object" && r.__fn__ ? u(r.body) : t;
   }
   return n;
 }
-function c(e) {
+function u(e) {
   try {
     return new Function(`return (${e})`)();
   } catch {
     return new Function(`return function ${e}`)();
   }
 }
-function u(e) {
+function c(e) {
   return s(e);
 }
 function i(e) {
@@ -28,17 +28,19 @@ function i(e) {
 }
 export {
   p as clearInterval,
-  _ as computed,
-  y as defineCustomElement,
+  _ as clearTimeout,
+  d as computed,
+  m as defineCustomElement,
   i as deserializePreset,
-  d as nextTick,
-  m as onBeforeUnmount,
-  w as onMounted,
-  b as onScopeDispose,
-  k as ref,
-  u as serializePreset,
-  v as setInterval,
-  x as shallowRef,
-  z as toValue,
-  h as watch
+  y as nextTick,
+  b as onBeforeUnmount,
+  v as onMounted,
+  w as onScopeDispose,
+  z as ref,
+  c as serializePreset,
+  h as setInterval,
+  j as setTimeout,
+  k as shallowRef,
+  x as toValue,
+  F as watch
 };

package/dist/shared/color.d.ts

@@ -0,0 +1,5 @@
+import { RgbColor } from './types';
+/** HSV 转 RGB，h: 0-360，s/v: 0-1 */
+export declare function HSVtoRGB(h: number, s: number, v: number): RgbColor;
+/** 十六进制颜色（#rgb / #rrggbb）转 RGB */
+export declare function hexToRgb(hex: string): RgbColor;

package/dist/shared/composables/useKeySampler.d.ts

@@ -1,8 +1,8 @@
-import { KeyboardSyncConfig, KeyElementRef, RgbColor } from '../types';
+import { KeyboardConfig, KeyElementRef, RgbColor } from '../types';
 export declare function discoverKeyElements(root: HTMLElement): KeyElementRef[];
 export interface SampleKeysOptions {
     canvas: HTMLCanvasElement;
-    keyboardConfig: KeyboardSyncConfig;
+    keyboardConfig: KeyboardConfig;
     getKeyElements: () => KeyElementRef[];
 }
 export declare function sampleKeysFromCanvas(options: SampleKeysOptions): RgbColor[][] | null;

package/dist/shared/hardware/build-music-data.d.ts

@@ -1,4 +1,4 @@
-import { KeyboardSyncConfig, RgbColor } from '../types';
-export declare function getMusicGridCol(keyboardConfig: KeyboardSyncConfig, rowIndex: number, colIndex: number): number;
-export declare function createKeysRgbGrid(keyboardConfig: KeyboardSyncConfig): RgbColor[][];
-export declare function buildMusicData(keysRgb: RgbColor[][], keyboardConfig: KeyboardSyncConfig): number[];
+import { KeyboardConfig, RgbColor } from '../types';
+export declare function getMusicGridCol(keyboardConfig: KeyboardConfig, rowIndex: number, colIndex: number): number;
+export declare function createKeysRgbGrid(keyboardConfig: KeyboardConfig): RgbColor[][];
+export declare function buildMusicData(keysRgb: RgbColor[][], keyboardConfig: KeyboardConfig): number[];

package/dist/shared/keyboard-config.d.ts

@@ -0,0 +1,474 @@
+/**
+ * 键盘配置接口定义
+ */
+export interface KeyboardConfig {
+    /** 厂商ID */
+    vendorId: number;
+    /** 产品ID */
+    productId: number;
+    /** 供应商名称 */
+    supplierName: string;
+    /** 键盘名称 */
+    name: string;
+    /** 键盘名称后缀 */
+    nameSuffix?: string;
+    /** 连接方式 */
+    connectType: ConnectType;
+    /** 协议类型 默认 default 协议 */
+    protocol?: string;
+    /** 路由名称列表 */
+    routesName: AppRouteName[];
+    /** 键盘图片（腾讯桶 keyboards 目录） */
+    keyboardImg?: string;
+    /** 键盘外框图片（腾讯桶 outline 目录） */
+    keyboardOutline?: string;
+    /** 键盘类名 */
+    keyboardClassName?: string;
+    /** 键盘按键显示语言 */
+    keyboardLang?: KeyboardLang;
+    /** 其他配置 */
+    otherConfig?: otherConfig;
+    /** 自定义按键配置 */
+    customKeysConfig?: customKeysConfig;
+    /** 灯光配置 */
+    lightingConfig?: lightingConfig;
+    /** 音乐律动配置 */
+    musicConfig?: musicConfig;
+    /** 宏配置 */
+    macroConfig?: macroConfig;
+    /** 性能配置 */
+    performanceConfig?: performanceConfig;
+    /** 触发设置配置 */
+    triggerConfig?: triggerConfig;
+    /** 高级键配置 */
+    advancedKeysConfig?: advancedKeysConfig;
+    /** 点阵屏led配置 */
+    ledConfig?: ledConfig;
+    /** TFT 屏幕配置 */
+    tftConfig?: tftConfig;
+    /** 设置配置 */
+    settingsConfig?: settingsConfig;
+    /** 社区配置 */
+    communityConfig?: communityConfig;
+    /** 键盘按键布局列表 */
+    keyList: KeyboardList;
+    /** 滚轮按键配置 */
+    wheelKeys?: wheelKey[];
+}
+/** 连接方式 */
+export type ConnectType = 'USB' | '2.4G';
+/**
+ * 应用路由名称类型定义
+ * 对应 Vue Router 中定义的路由名称
+ */
+export type AppRouteName = 'home' | 'customKeys' | 'lighting' | 'macro' | 'performance' | 'advancedKeys' | 'led' | 'tft' | 'community' | 'settings' | 'profiles' | 'trigger';
+/** 键盘多种颜色列表 */
+export interface keyboardColorList {
+    /** 颜色名称 */
+    name: string;
+    /** 圆点背景颜色值 */
+    pointBg: string;
+    /** 键盘图片（腾讯桶 keyboards 目录） */
+    keyboardImg: string;
+}
+/** 键盘按键显示语言 */
+export type KeyboardLang = 'deText' | 'ptText' | 'jaText' | 'jaTextBr' | 'frText' | 'esText' | 'trText' | 'huText';
+/** 其他配置 */
+export interface otherConfig {
+    /** 是否跳转旧版驱动（旧版本打包文件放在目录 hub 下） */
+    isJumpOldDrive?: boolean;
+    /** 键盘多种颜色列表 */
+    keyboardColorList?: keyboardColorList[];
+    /** 使用说明文档（腾讯桶 docs 目录）  */
+    docsLink?: string;
+    /** 是否显示自定义图标 */
+    isShowCustomIcon?: boolean;
+}
+/** 自定义按键配置 */
+export interface customKeysConfig {
+    /** 是否有 FN 层 */
+    isShowFn?: boolean;
+    /** 是否显示普通层功能按键 */
+    isShowNormalFuncKeys?: boolean;
+    /** FN 层功能按键值列表 funcChars */
+    fnFuncIds?: number[];
+    /** FN 层禁用修改按键值 */
+    fnDisabledKeyIds?: number[];
+}
+/**
+ * 灯光配置接口定义
+ */
+export interface lightingConfig {
+    /** 灯光最小亮度 默认 1 */
+    minBrightness?: number;
+    /** 灯光最大亮度 默认 5 */
+    maxBrightness?: number;
+    /** 灯光最小速度 默认 1 */
+    minSpeed?: number;
+    /** 灯光最大速度 默认 5 */
+    maxSpeed?: number;
+    /**
+     * 追加灯光效果值列表
+     * 0x17 彩虹风车
+     * 0x18 七彩聚拢
+     * 0x19 霓虹叠影
+     * 0xfe 心动时刻
+     *  */
+    customEffect?: number[];
+    /** 是否单色灯光键盘 默认 false */
+    isSingleColor?: boolean;
+    /** 隐藏默认效果值列表 */
+    hiddenDefaultEffect?: number[];
+    /** 是否显示灯箱灯效 */
+    isShowLightBox?: boolean;
+    /** 灯箱效果列表 */
+    lightBoxList?: number[];
+    /** 是否显示灯箱灯效编辑（亮度、速度） */
+    isShowLightBoxEdit?: boolean;
+    /** 是否显示侧灯灯效 */
+    isShowSideLight?: boolean;
+    /** 侧灯效果列表 */
+    sideLightList?: number[];
+    /** 是否显示侧灯灯效编辑（亮度、速度） */
+    isShowSideLightEdit?: boolean;
+    /** 是否显示gif灯效 默认 false */
+    isShowGifEffect?: boolean;
+    /**
+     * gif灯效列表
+     * heartRateCurve_87 87键心率曲线
+     * heart_XX XX键爱心，XX值为 66、67、84、85_02（第一列突出两个按键）、87、95、99、99_ansi、100（扩展按键1-4 行）、101、102_iso、104、106、108
+     *  */
+    gifEffectIds?: string[];
+    /** 是否开启灯光同步 */
+    isEnableLightSync?: boolean;
+}
+/** 音乐律动配置 */
+export interface musicConfig {
+    /** 音乐律动版本 */
+    version: number;
+    /** 是否开启 AI 灯效 */
+    isEnableAILighting?: boolean;
+    /** 是否开启音乐律动 DIY */
+    isEnableMusicDiy?: boolean;
+    /** 最大列数偏移值 默认 0 */
+    maxColOffset?: number;
+    /** 过滤需要展示的音乐律动模式值列表，默认展示所有模式 */
+    filterMusicMode?: number[];
+    /** 按键偏移配置 */
+    keyOffset?: keyOffset[];
+    /** 圆环按键坐标配置，使用对应配列，也可以自定义坐标 */
+    ringKeyPositions?: 'ring_68' | 'ring_87' | 'ring_108' | keyPosition[][];
+    /** 火山按键坐标配置，使用对应配列，也可以自定义左/中/右山坐标 */
+    volcanoKeyPositions?: 'volcano_64' | 'volcano_84_iso' | 'volcano_87' | 'volcano_98' | volcanoMountainPositions;
+}
+/** 音乐律动按键坐标 */
+export interface keyPosition {
+    row: number;
+    col: number;
+}
+/** 火山三座山的按键坐标，每座山从底部到顶部分层，每层可指定任意按键 */
+export interface volcanoMountainPositions {
+    left: keyPosition[][];
+    middle: keyPosition[][];
+    right: keyPosition[][];
+}
+/** 按键偏移配置 */
+export interface keyOffset {
+    /** 按键名称 */
+    name: string;
+    /** 按键值 */
+    value: number;
+    /** 按键列偏移值 */
+    offsetX: number;
+}
+/** 宏配置 */
+export interface macroConfig {
+    /** 是否显示 FN 层 */
+    isShowFn?: boolean;
+    /** 是否获取最大宏空间大小 */
+    isGetMaxMacroSpaceSize?: boolean;
+}
+/** 性能配置 */
+export interface performanceConfig {
+    /** 触发行程值 */
+    triggerTripValue?: number;
+    /** 最大触发行程 */
+    maxTriggerTrip?: number;
+    /** 最小触发行程 */
+    minTriggerTrip?: number;
+    /** 触发行程步长 */
+    triggerTripStep?: number;
+    /** 最小灵敏度 默认 0.01 */
+    minSensitivity?: number;
+    /** 最大灵敏度 默认 3.3 */
+    maxSensitivity?: number;
+    /** 灵敏度值  */
+    sensitivityValue?: number;
+    /** 灵敏度步长 */
+    sensitivityStep?: number;
+    /** 是否可以切换轴体 */
+    isSwitchAxis?: boolean;
+    /** 默认轴体 */
+    defaultAxisValue?: number;
+    /** 轴体列表 */
+    axisList?: axisItem[];
+    /** 是否显示狂暴模式 */
+    isShowRampageMode?: boolean;
+    /** 模式选择列表，'default' 表示使用默认列表，也可以自定义列表 */
+    modeList?: 'default' | modeItem[];
+    /** 是否显示死区 */
+    isShowDeadZone?: boolean;
+    /** 是否开启2.4G校准 */
+    isShow24GCalibration?: boolean;
+}
+/** 轴体 */
+export interface axisItem {
+    /** 轴体名称 */
+    name: string;
+    /** 轴体值 */
+    value: number;
+    /** 轴体信息 */
+    axisInfo?: number;
+    /** 最小灵敏度 默认 0.01 */
+    minSensitivity?: number;
+    /** 最大灵敏度 默认 3.3 */
+    maxSensitivity?: number;
+    /** 灵敏度值 默认取 triggerTripValue 的值 */
+    sensitivityValue?: number;
+    /** 灵敏度步长 */
+    sensitivityStep?: number;
+}
+/** 模式 */
+export interface modeItem {
+    /** 模式名称 */
+    name: string;
+    /** 模式翻译文本 */
+    text?: string;
+    /** 触发行程值 */
+    triggerTripValue?: number;
+    /** 按下灵敏度值 */
+    downSensitivityValue?: number;
+    /** 松开灵敏度值 */
+    upSensitivityValue?: number;
+    /** 灵敏度步长 */
+    sensitivityStep?: number;
+    /** 修改按键配置 */
+    keys?: keyItem[];
+}
+/** 按键配置 */
+export interface keyItem {
+    /** 按键名称 */
+    name: string;
+    /** 按键值 */
+    value: number;
+    /** 触发行程值 */
+    triggerTripValue?: number;
+    /** 按下灵敏度值 */
+    downSensitivityValue?: number;
+    /** 松开灵敏度值 */
+    upSensitivityValue?: number;
+}
+/** 触发设置配置 */
+export interface triggerConfig {
+    /** 禁止修改触发设置的按键值列表 */
+    disabledKeyIds?: number[];
+}
+/** 高级键配置 */
+export interface advancedKeysConfig {
+    /** 高级键功能名称列表 */
+    advancedKeysList: advancedKeyName[];
+}
+/** 高级键名称 */
+export type advancedKeyName = 'RS' | 'SOCD' | 'DKS' | 'MT' | 'TGL' | 'CB' | 'END' | 'MPT';
+/** 点阵屏led配置 */
+export interface ledConfig {
+    /** 点阵屏行数 */
+    rows: number;
+    /** 点阵屏列数 */
+    cols: number;
+    /** 点阵屏 localforage 存储key */
+    localforageKey: string;
+    /** 是否显示字符模式 */
+    isShowCharMode?: boolean;
+    /** 是否显示拾音灯模式 */
+    isShowVoiceMode?: boolean;
+    /** 是否显示时间校准 */
+    isShowTimeCalibration?: boolean;
+    /** 灯光最大亮度 默认 4 */
+    maxBrightness?: number;
+}
+/** TFT 屏幕配置 */
+export interface tftConfig {
+    /** 名称（获取默认GIF时使用） */
+    name?: string;
+    /** TFT 屏幕宽度 */
+    width: number;
+    /** TFT 屏幕高度 */
+    height: number;
+    /** localforage 存储key */
+    localforageKey: string;
+    /** 内置数量 默认 1 */
+    builtInCount?: number;
+    /** 是否隐藏时间校准 */
+    hideScreenTimeCalibration?: boolean;
+    /** 是否显示 TFT 屏幕信息（CPU、GPU、天气等） */
+    isShowTftInfo?: boolean;
+}
+/** 社区配置 */
+export interface communityConfig {
+    /** 社区列表 */
+    communityList?: communityItem[];
+    /** 使用设备信息（用哪个设备信息请求社区接口，默认使用当前设备信息） */
+    communityDeviceInfo?: communityDeviceInfo;
+}
+/** 社区列表 */
+export type communityItem = 'led' | 'tft' | 'gif' | 'profile';
+/** 使用设备信息 */
+export interface communityDeviceInfo {
+    /** 使用设备产品ID */
+    deviceProductId: number;
+    /** 使用设备名称 */
+    deviceName: string;
+}
+/** 设置配置 */
+export interface settingsConfig {
+    /** 是否显示休眠模式 */
+    isShowSleepMode?: boolean;
+    /** 是否显示 tft 屏幕时间制式 */
+    isShowTftTimeMode?: boolean;
+    /** 是否显示按键响应时间 */
+    isShowKeyDelay?: boolean;
+    /** 是否显示单键唤醒 */
+    isShowSingleKeyWakeup?: boolean;
+    /** 是否显示稳定模式 */
+    isShowStabilityMode?: boolean;
+    /** 是否显示自动校准 */
+    isShowAutoCalibration?: boolean;
+    /** 是否显示回报率 */
+    isShowReportRate?: boolean;
+    /** 回报率列表 */
+    reportRateList?: number[];
+    /** 帮助链接 */
+    helpLink?: string;
+    /** 是否显示摇杆模式 */
+    isShowPushButtonMode?: boolean;
+    /** 各键盘模式的续航时间配置，按数组顺序展示 */
+    enduranceConfig?: enduranceModeItem[];
+}
+/** 单档回报率的续航配置 */
+export interface enduranceReportRateItem {
+    /** 回报率 Hz，如 1000、8000 */
+    reportRate: number;
+    /** 最小续航小时 */
+    min: number;
+    /** 最大续航小时 */
+    max: number;
+}
+/** 单个键盘模式的续航配置 */
+export interface enduranceModeItem {
+    /** 模式名称 */
+    name: string;
+    /** 模式值 */
+    value: number;
+    /** 模式翻译文本 */
+    text?: string;
+    /** 各回报率续航时间，按数组顺序展示 */
+    reportRateList: enduranceReportRateItem[];
+}
+/**
+ * 按键页面类型枚举的键名类型
+ */
+export type KeyPageTypeName = 'DEFAULT' | 'MOUSE' | 'KEYBOARD' | 'CONSUMER_KEY' | 'SYSTEM_KEY' | 'EXTRA_FUNCTION' | 'MACRO' | 'CB' | 'DKS' | 'MT' | 'TGL' | 'SOCD' | 'RS' | 'FUNC' | 'FUNC_V2' | 'END' | 'MPT';
+/**
+ * 字符配置接口定义
+ * 用于定义键盘按键的字符映射和功能配置
+ */
+export interface Character {
+    /** 字符名称 */
+    name: string;
+    /** 字符值 */
+    value?: number;
+    /** 键盘键值 */
+    key?: number;
+    /** 字符翻译文本，用于国际化显示 */
+    text?: string;
+    /** 德语翻译文本 */
+    deText?: string;
+    /** 葡萄牙语翻译文本 */
+    ptText?: string;
+    /** 日语翻译文本 */
+    jaText?: string;
+    /** 日语键帽双行显示文本，使用 \n 换行 */
+    jaTextBr?: string;
+    /** 法语翻译文本 */
+    frText?: string;
+    /** 西班牙语翻译文本 */
+    esText?: string;
+    /** 土耳其翻译语言 */
+    trText?: string;
+    /** 匈牙利语翻译文本 */
+    huText?: string;
+    /** 用户自定义按键配置页分类，指定字符所属的功能页面类型 */
+    page?: KeyPageTypeName;
+    /** 用户自定义按键配置参数1 */
+    param1?: number;
+    /** 用户自定义按键配置参数2 */
+    param2?: number;
+    /** 用户自定义按键配置参数3 */
+    param3?: number;
+    /** 按键类型（短按：1，长按：2） */
+    keyType?: 1 | 2;
+}
+/**
+ * 键盘按键配置接口定义
+ * 用于定义键盘上每个物理按键的属性和行为
+ */
+export interface KeyboardKey {
+    /** CSS 类名，用于按键的样式定制 */
+    className: string;
+    /** 按键值，按键的唯一标识数值 */
+    value: number;
+    /** 按键名称 */
+    name: string;
+    /** 字符翻译文本，用于国际化显示 */
+    text?: string;
+    /** 按键标识，对应 DOM 事件中的 key 值 */
+    key: string;
+    /** 按键码 */
+    keyCode: number;
+    /** 用户自定义按键配置，可选的字符映射 */
+    userKey?: Character;
+    /** 按键背景颜色 */
+    bgColor?: string;
+    /** 按键禁止点击修改（通常是FN层按键） */
+    disabled?: boolean;
+    /** 灯光禁用，为 true 时灯光相关功能跳过不渲染 */
+    disabledLight?: boolean;
+    /** 高级键禁用，为 true 时不能修改高级键（参考 FN 键禁用逻辑） */
+    disabledAdvanced?: boolean;
+    /** 按键图标 */
+    icon?: string;
+    /** 行程校准高度 */
+    calibrationHeight?: number;
+}
+export type KeyboardRow = KeyboardKey[];
+export type KeyboardList = KeyboardRow[];
+/** 滚轮按键配置 */
+export interface wheelKey {
+    /** 旋钮组ID（可选，默认为1保持向后兼容） */
+    wheelId?: number;
+    /** 类名 */
+    className?: string;
+    /** 滚轮按键值 */
+    value: number;
+    /** 滚轮按键名称 */
+    name: string;
+    /** 滚轮按键翻译文本 */
+    text?: string;
+    /** 动作类型 （right: 右旋转，center: 按下，left: 左旋转） */
+    action: 'right' | 'center' | 'left';
+    /** 用户自定义按键配置 */
+    userKey?: Character;
+    /** 是否禁用 */
+    disabled?: boolean;
+}

package/dist/shared/types.d.ts

@@ -1,24 +1,10 @@
+import { KeyboardConfig, KeyboardKey, KeyboardList, KeyboardRow, keyOffset, keyPosition, volcanoMountainPositions, ConnectType, musicConfig } from './keyboard-config';
 export interface RgbColor {
     r: number;
     g: number;
     b: number;
 }
-export interface KeyOffset {
-    value: number;
-    offsetX: number;
-}
-export interface KeyboardKeyMeta {
-    value: number;
-    keyCode: number;
-    name?: string;
-}
-export interface KeyboardSyncConfig {
-    keys: KeyboardKeyMeta[][];
-    musicConfig?: {
-        keyOffset?: KeyOffset[];
-        maxColOffset?: number;
-    };
-}
+export type { KeyboardConfig, KeyboardKey, KeyboardList, KeyboardRow, keyOffset, keyPosition, volcanoMountainPositions, ConnectType, musicConfig, };
 export interface KeyboardLayoutState {
     x: number;
     y: number;
@@ -82,7 +68,7 @@ export interface AiLightingInitOptions {
     importedPresets?: AiLightingPreset[];
     selectedPresetId?: string;
     defaultParams?: Partial<Record<string, AiLightingPresetParamValue>>;
-    keyboardConfig: KeyboardSyncConfig;
+    keyboardConfig: KeyboardConfig;
     device: HFDSDKDevice;
     isUSBDevice?: boolean;
     lightingVersion?: number;