createSDK - 为指定设备创建独立 SDK 实例，适用于多设备场景。

createSDK(options?: SDKOptions)

版本要求:

@ray-js/lock-sdk≥1.2.0

描述

为指定设备创建独立 SDK 实例（多设备场景推荐）。

参数

参数	类型	必填	说明
		否	配置项；kind: 'fit' 创建配件实例，缺省为门锁。

返回值

类型：Promise<LockSDKInstance>

SDK 实例（门锁或配件，视 kind 而定）

引用对象

typeLockSDKInstanceSDK 实例类型（门锁与配件统一）。`destroy` / `updateConfig` 为实例闭包，其余同包顶层。

属性	类型	描述
`destroy`	() => void	销毁当前实例：注销该设备 Runtime、清理内存状态与监听（配件实例同时释放透传上报监听）。
		更新当前实例的运行时配置（仅作用于本实例对应设备）。
		获取云存服务状态（是否已购买 / 剩余天数等）。
		获取增值服务福利弹窗内容（待领取 / 自动领取的兑换券列表）。
		领取增值服务福利。
		获取 VAS 通知配置（各通知场景开关与推送方式）。
		更新 VAS 通知配置（按 key 点路径增量更新单个开关）。
		获取 VoIP 服务授权 / 推送对象信息。
		设置 VoIP 推送对象（选中接收来电的家庭成员）。
		查询手势密码状态（是否开启 + 云端密码串）。
		获取当前用户
		同步读取缓存中的当前用户（不发请求）。
		读取设备在线/休眠等综合状态。
		订阅设备在线/休眠等综合状态变化。
		取消订阅设备状态变化（须与订阅时同一 `callback` 引用）。
		读取设备某个 DP 的当前值
		判断设备是否支持某个 DP
		向设备下发 DP
		监听离线 DP 更新
		注销离线 DP 更新监听
		下发离线 DP
		获取离线 DP 列表
		获取指定 code 的离线 DP 缓存项
		判断指定离线 DP 是否仍在同步中（未推送完成）。
		分页/关键字查询用户列表。
		获取单个用户详情。
		更新用户有效期、永久标记、离线开锁等限制信息。
		打开家庭用户详情页面
		添加一个普通用户
		删除一个普通用户
		添加分享用户（蓝牙门锁）。
		更新分享用户（蓝牙门锁）。
		移除分享用户（蓝牙门锁）。
		获取分享用户列表

		触发删除用户相关的云端/设备同步流程。
		向设备下发同步开锁方式指令
		获取开锁方式详细信息
		检查是否支持短信通知
		添加密码类开锁方式。
		开始添加开锁方式
		取消进行中的添加开锁方式流程。
		更新开锁方式
		删除开锁方式。
		检测是否有未绑定的开锁方式
		获取未关联开锁方式列表
		绑定未关联开锁方式到用户
		解绑用户的开锁方式
		绑定开锁记录中未关联开锁方式到用户
		发送手机验证码
		注册开锁方式步骤监听器
		注销开锁方式步骤监听器
		获取指定开锁方式类型的引导图或视频
		创建自定义临时密码。
		删除自定义临时密码。
		更新自定义临时密码。
		获取有效临时密码列表。
		获取无效的临时密码列表
		清空无效的临时密码列表
		冻结指定自定义临时密码。
		解冻指定自定义临时密码。
		重命名临时密码名称
		保存在线不限次数密码
		删除在线不限次数密码
		获取在线不限次数密码列表
		创建离线类临时密码。
		获取离线有效密码列表
		获取离线失效密码列表
		创建临时限时密码
		创建单次临时密码
		创建动态临时密码。
		创建离线密码清空码
		获取可清除的限时密码列表
		校验当前是否允许进行（Wi-Fi）远程开锁。
		开锁
		关锁
		开启或关闭远程开/关锁功能
		获取远程开/关锁功能开启状态
		获取当前远程开/关门权限
		更新远程开/关门权限策略。
		同意远程开门请求（Wi‑Fi Pro 方案使用）。
		拒绝远程开门请求（Wi‑Fi Pro 等确认流）。
		查询语音开锁密码能力是否开启。
		关闭语音开锁密码能力。
		更新语音开锁密码。

		注册通知可刷新日志事件
		注销通知可刷新日志事件
		获取最近 2 条记录
		获取日志记录列表
		获取告警日志记录列表
		获取相册日志
		获取设备日志记录列表支持操作日志、开锁日志、关锁日志、告警日志
		获取告警未读数量。
		获取安防有效天数（设备激活以来的安防有效天数）。

		获取设备信号强度
		获取 WiFi 信号强度
		订阅 Wi‑Fi 信号变化。
		取消订阅 Wi‑Fi 信号变化。
		当前是否处于休眠态
		判断锁是否支持休眠功能
		判断休眠功能是否已启用
		打开休眠功能
		关闭休眠功能
		获取休眠时间段
		设置休眠时间段
		注册休眠状态变更事件
		注销休眠状态变更事件
		打开智能场景页面
		判断是否支持蓝牙控制
		获取时间段类型的 DP 的当前值
		更新时间段类型的 DP 的时间段
		发起近场/局域网连接设备流程。
		跳转增值服务/云存储等宿主页面。
		按产品规则校验密码复杂度。


		设置 / 开关手势密码（已存在密码时可直接开关，无需再走原生面板）。
		获取视频的实际播放地址
		是否支持媒体类能力（视频/抓拍等）。
		获取设备摄像头旋转角度
		获取设备摄像头数据
		打开本地相册
		打开回放 / 巡航监控面板
		是否支持多摄切换
		获取摄像头信息
		查询摄像头信息
		切换摄像头到指定序号
		获取当月媒体已观看次数
		设置当月媒体已观看次数
		获取最近 30 天内有相册记录的日期列表
		获取所有摄像头的信息
		获取语音文件列表
		下发语音文件到设备
		订阅语音文件下发进度
		取消订阅语音文件下发进度
		获取当前语音文件状态
		获取门铃通知服务信息
		启用门铃通知服务
		关闭门铃通知服务
		去配置门铃通知服务

		是否具备某种 `ProductCommunicationType` 能力。
		当前设备是否为纯蓝牙锁（无 Wi‑Fi / Thread 等其它通讯能力位）。
		拉取设备增值能力列表（云端）。
		同步获取设备增值能力列表
		获取设备能力
		获取待弹的 AI 月报；未启用或无报告时返回 null。
		标记 AI 月报已读（防止重复弹窗）。
		AI 数据报告是否启用（云能力 ai_data_report && 设备属性 LOCK_UNLOCK_REPORT）。
		将配件绑定到当前门锁。
		解除配件与当前门锁的绑定。
		获取当前门锁已绑定配件列表。
		获取当前门锁可绑定配件列表。
		分页查询当前分离屏动态事件列表。
		获取当前分离屏已绑定门锁列表。
		获取当前分离屏可绑定门锁列表。
		发起将指定门锁绑定到当前分离屏。
		订阅分离屏绑定门锁的结果。
		取消订阅分离屏绑定门锁的结果（须与订阅时同一引用）。
		解除指定绑定关系，并在云端解绑结果收敛后返回。
		获取当前配件已绑定门锁列表，每项含安全版本兼容性判定。
		获取当前配件可绑定门锁列表，每项含可绑定判定。
		将门锁绑定到当前配件。
		解除门锁与当前配件的绑定。
		激活已绑定的门锁设备
		配件端添加密码
		配件端启动多阶段添加开锁方式（指纹/门卡/人脸等）。
		配件端取消进行中的添加开锁方式流程。
		注册配件端添加开锁方式步骤监听器。
		注销配件端添加开锁方式步骤监听器。
		配件端更新开锁方式（仅云端）。
		配件端删除开锁方式
		获取配件下指定类型的开锁方式列表。
		发起开锁方式同步。
		获取配件蓝牙钥匙列表。
		配件端添加蓝牙钥匙。
		配件端创建永久蓝牙钥匙
		配件端创建临时蓝牙钥匙
		配件端更新临时蓝牙钥匙（改名 / 改生效期）。
		配件端删除蓝牙钥匙。
		配件端重命名蓝牙钥匙。
		获取配件下的成员（用户）列表。
		获取配件开关门记录列表
		获取当前配件在线密码列表。
		获取当前配件在线密码明细列表（保留 opModeType / 生效周期 / 手机号 / 门锁名等原始字段）。
		获取当前配件有效离线临时密码列表。
		配件端添加临时密码。
		配件端删除临时密码。
		配件端修改临时密码。
		配件端重命名临时密码。
		配件端重命名离线临时密码（仅云端）。
		配件端删除离线临时密码：生成「清空码」（仅云端）。
		重新发送临时密码短信。
		获取配件失效密码列表。
		清空配件失效密码。
		获取当前配件的动态密码（短期有效，5 分钟内可多次使用）。
		获取当前配件的一次性离线密码
		获取当前配件的时间限制离线密码
		生成「清空所有」清空码
		获取可「清空单个」的离线密码列表（至少使用过一次的时间限制离线密码）。
		判断当前配件某类离线密码是否可继续获取（整点 60 分钟内一次性密码/清空码限 10 次）。

typeDpValueDP 点值联合类型 / Union of primitive DP payload values

string | boolean | number

enumRemotePermissionType

枚举值	实际值	描述
`RemotePermissionType.EVERY_ONE`	`everyOne`	所有人都可以
`RemotePermissionType.ADMINS_ONLY`	`adminsOnly`	仅管理员可以
`RemotePermissionType.NO_ONE`	`noOne`	所有人都不可以

enumProductCommunicationType

枚举值	实际值	描述
`ProductCommunicationType.WIFI`	`0`	-
`ProductCommunicationType.CABLE`	`1`	-
`ProductCommunicationType.GPRS`	`2`	-
`ProductCommunicationType.NB_IOT`	`3`	-
`ProductCommunicationType.BLUETOOTH`	`10`	-
`ProductCommunicationType.BLE_MESH`	`11`	-
`ProductCommunicationType.ZIGBEE`	`12`	-
`ProductCommunicationType.INFRARED`	`13`	-
`ProductCommunicationType.SUBPIECES`	`14`	-
`ProductCommunicationType.SIGMESH`	`15`	-
`ProductCommunicationType.MCU`	`16`	-
`ProductCommunicationType.TY_SMESH`	`17`	-
`ProductCommunicationType.ZWAVE`	`18`	-
`ProductCommunicationType.PL_MESH`	`19`	-
`ProductCommunicationType.CAT1`	`20`	-
`ProductCommunicationType.BEACON`	`21`	-
`ProductCommunicationType.CAT4`	`22`	-
`ProductCommunicationType.CAT10`	`23`	-
`ProductCommunicationType.LTE_CATM`	`24`	-
`ProductCommunicationType.THREAD`	`25`	-

typeWeek周重复位图：下标 0–6 对应周日–周六，0 不生效 1 生效

export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];

enumUserType

枚举值	实际值	描述
`UserType.ADMIN`	`10`	管理员
`UserType.MEMBER`	`20`	普通成员
`UserType.UNKNOW`	`30`	匿名
`UserType.SHARE`	`40`	分享成员
`UserType.OWNER`	`50`	家庭拥有者

合法值

`SDKOptions.logLevel`

值	说明	最低版本
`off`	-	-
`error`	-	-
`warn`	-	-
`info`	-	-
`debug`	-	-
`trace`	-	-

`SDKOptions.kind`

值	说明	最低版本
`lock`	-	-
`fit`	-	-
`screen`	-	-

`UpdateConfigParams.logLevel`

值	说明	最低版本
`off`	-	-
`error`	-	-
`warn`	-	-
`info`	-	-
`debug`	-	-
`trace`	-	-

`UpdateConfigParams.kind`

值	说明	最低版本
`lock`	-	-
`fit`	-	-
`screen`	-	-

`DeviceStatus.type`

值	说明	最低版本
`offline`	-	-
`online`	-	-
`sleep`	-	-

`DeviceStatus.onlineTypes`

值	说明	最低版本
`local`	-	-
`cloud`	-	-
`ble`	-	-
`localMatter`	-	-
`yuChannel`	-	-
`unknown`	-	-

`Week`

值	说明	最低版本
`0`	-	-
`1`	-	-

`UserInfo.unlockDetails.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`UserType`

值	说明	最低版本
`10`	管理员	-
`20`	普通成员	-
`30`	匿名	-
`40`	分享成员	-
`50`	家庭拥有者	-

`EffectiveConfig.repeat`

值	说明	最低版本
`none`	-	-
`week`	-	-

`AddSharedUserParams.effectiveType`

值	说明	最低版本
`once`	-	-
`permanent`	-	-
`limit`	-	-

`UpdateSharedUserParams.effectiveType`

值	说明	最低版本
`once`	-	-
`permanent`	-	-
`limit`	-	-

`StartAddUnlockMethodParams.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`CancelAddUnlockMethodParams.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`BindUnlockMethodParams.unlockList.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`BindUnlockMethodFromLogParams.unlockList.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`RemotePermissionType`

值	说明	最低版本
`everyOne`	所有人都可以	-
`adminsOnly`	仅管理员可以	-
`noOne`	所有人都不可以	-

`GetLockLogListParams.logCategories`

值	说明	最低版本
`operation`	-	-
`unlock_record`	-	-
`close_record`	-	-
`alarm_record`	-	-

`OpenSceneOptions.executorRange`

值	说明	最低版本
`unlock`	-	-
`lock`	-	-

`OpenSceneOptions.abilities`

值	说明	最低版本
`backHome`	-	-
`alarm`	-	-
`geographyArrive`	-	-
`geographyLeave`	-	-
`bleGeofence`	-	-
`siriUnlock`	-	-
`siriLock`	-	-

`GotoServiceParams.tab`

值	说明	最低版本
`cloudStorage`	-	-
`AI`	-	-
`voip`	-	-

`GotoPlaybackParams.tabs`

值	说明	最低版本
`local`	-	-
`cloud`	-	-

`ProductCommunicationType`

值	说明	最低版本
`0`	-	-
`1`	-	-
`2`	-	-
`3`	-	-
`10`	-	-
`11`	-	-
`12`	-	-
`13`	-	-
`14`	-	-
`15`	-	-
`16`	-	-
`17`	-	-
`18`	-	-
`19`	-	-
`20`	-	-
`21`	-	-
`22`	-	-
`23`	-	-
`24`	-	-
`25`	-	-

`FitStartAddUnlockMethodParams.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`FitCancelAddUnlockMethodParams.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`GetFitUnlockMethodListParams.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`AddFitTempPwdParams.type`

值	说明	最低版本
`once`	-	-
`limit`	-	-

示例代码

门锁多设备各建实例

import { createSDK } from '@ray-js/lock-sdk';
const a = await createSDK({ deviceId: 'devA' });
const b = await createSDK({ deviceId: 'devB' });
await a.openDoor();

配件实例

const fit = await createSDK({ deviceId: 'devFit', kind: 'fit' });