Appearance
锁基本信息
说明:主要对锁的基本信息进行操作,例如选择锁、开关门、删除锁、获取锁支持功能、远程开锁、设置锁支持功能等。
选择锁(对锁进行蓝牙操作前调用)
- 调用方法
javascript
const result = await plugin.selectLock(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| accountInfo | AccountInfo | Y | accountInfo | 账号信息 |
| lockId | Number | Y | 500 | 锁ID |
- 返回
返回结果遵循 Result 方法的统一返回结构。
开关门
- 调用方法
javascript
const result = await plugin.openDoor(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| accountInfo | AccountInfo | Y | accountInfo | 账号信息 |
| type | String | Y | "open" | 开门方式 |
| disconnect | Boolean | N | false | 操作后是否断开连接,默认不断开 |
- 返回
返回结果遵循 Result 方法的统一返回结构。
删除锁
- 调用方法
javascript
const result = await plugin.deleteLock(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| accountInfo | AccountInfo | Y | accountInfo | 账号信息 |
- 返回
返回结果遵循 Result 方法的统一返回结构。
获取锁支持功能
- 调用方法
javascript
const result = await plugin.getLockSupportFeatures(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| accountInfo | AccountInfo | Y | accountInfo | 账号信息 |
| lockId | Number | Y | 500 | 锁 Id |
- 返回
返回结果遵循 Result 方法的统一返回结构,data 中包含以下所有功能字段,0 代表不支持,1 代表支持:
| 名称 | 类型 | 描述 |
|---|---|---|
| password | Number | 是否支持密码 |
| icCard | Number | 是否支持 IC 卡 |
| fingerprint | Number | 是否支持指纹 |
| fingerVein | Number | 是否支持指静脉 |
| palmVein | Number | 是否支持掌静脉 |
| d3Face | Number | 是否支持 3D 人脸 |
| qrCode | Number | 是否支持二维码 |
| bluetoothRemoteControl | Number | 是否支持蓝牙遥控器 |
| wirelessKey | Number | 是否支持无线钥匙 |
| gatewayUnlock | Number | 是否支持网关开锁 |
| lockCommand | Number | 是否支持闭锁指令 |
| firmwareUpgrade | Number | 是否支持固件升级设置指令 |
| passwordIssue | Number | 是否支持密码下发 |
| cardIssue | Number | 是否支持卡片下发 |
| fingerprintIssue | Number | 是否支持指纹下发 |
| fingerVeinIssue | Number | 是否支持指静脉下发 |
| palmVeinIssue | Number | 是否支持掌静脉下发 |
| d3FaceIssue | Number | 是否支持 3D 人脸下发 |
| lockFreeze | Number | 是否支持冻结/解冻锁 |
| readAdminPassword | Number | 是否支持读取管理员密码 |
| passwordManagement | Number | 是否支持密码管理功能 |
| passwordWithDelete | Number | 是否支持密码带删除功能 |
| remoteUnlock | Number | 是否支持配置远程开锁 |
| autoLock | Number | 是否支持自动闭锁设置 |
| antiPrySwitch | Number | 是否支持防撬开关配置 |
| resetSwitch | Number | 是否支持重置键配置 |
| lockSwitch | Number | 是否支持反锁功能配置 |
| lockSound | Number | 是否支持语音提示管理 |
| languageSetting | Number | 是否支持语言设置 |
| realTimeClock | Number | 是否支持实时时钟 |
| wifi | Number | 是否支持 WIFI |
| videoIntercom | Number | 是否支持可视对讲 |
| cyclePassword | Number | 是否支持循环密码 |
| cycleFingerprintCard | Number | 是否支持循环指纹/卡 |
| doubleAuthentication | Number | 是否支持双重认证 |
| openDirection | Number | 是否支持开门方向设置 |
| proximitySensing | Number | 是否支持接近感应 |
| doorStatus | Number | 是否支持门磁状态 |
| wiredDoorMagnet | Number | 是否支持有线门磁 |
| wirelessDoorMagnet | Number | 是否支持无线门磁 |
| doorNotClosedAlarm | Number | 是否支持门未关报警 |
| unlockReminder | Number | 是否支持开锁提醒 |
| wirelessKeyboard | Number | 是否支持无线键盘 |
| lightingTime | Number | 是否支持照明灯时间配置 |
| passageMode | Number | 是否支持常开模式 |
| hotelLockCardSystem | Number | 是否支持酒店锁卡系统 |
| appUnlockOnline | Number | 是否支持 APP 开锁需联网 |
| bluetoothBroadcast | Number | 是否支持蓝牙广播 |
| attendance | Number | 是否支持考勤 |
| motorTorsion | Number | 是否支持电机扭力 |
| stayWarn | Number | 是否支持逗留警告 |
| abnormalWarn | Number | 是否支持异常警告 |
| isSupportIris | Number | 是否支持虹膜识别 |
| isSupportCatEye | Number | 是否支持猫眼 |
| deviceEnMultiLanguage | Number | 是否支持设备支持的多国语言 |
| isNoSupportedBlueBroadcast | Number | 是否不支持蓝牙广播 |
| isSupportAutoLight | Number | 是否支持自动亮屏 |
| isSupportBackupBattery | Number | 是否支持备用电池 |
| isSupportForcedOpen | Number | 是否支持胁迫开门 |
| isSupportOpen | Number | 是否支持开门器开锁 |
| isSupportPush | Number | 是否支持推送 |
| offlinePasswordEncryption | Number | 是否支持密码算法 |
| offlinePasswordNumMax | Number | 是否支持离线密码最大个数 |
远程开锁
- 调用方法
javascript
const result = await plugin.remoteUnLock(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| uid | Number | Y | 123 | 用户id |
| lockId | Number | Y | 500 | 锁 Id |
- 返回
返回结果遵循 Result 方法的统一返回结构。
设置锁支持功能
- 调用方法
javascript
const result = await plugin.updateSupportFunctionsWithParams(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| accountInfo | AccountInfo | Y | accountInfo | 账号信息 |
| featureBit | Number | Y | 29 | 功能对应位 |
| data | Number | Object | N | 10 | 功能对应参数(带参数时使用) |
| withParams | Boolean | Y | true | 是否携带参数;带参数时使用data传递,不带参数时使用featureEnable控制开关 |
| featureEnable | Number | N | 1 | 开关;1-开、0-关(不带参数时使用) |
- 返回
返回结果遵循 Result 方法的统一返回结构。
功能位定义
| 功能昵称 | 对应位值 | 值描述 | 是否需要传递参数 |
|---|---|---|---|
| 自动闭锁 | 29 | 0:关闭,其他值:延时秒数 | Y |
| 锁提示音 | 33 | 0:关闭,其他值:音量值(1-5) | Y |
| 常开模式 | 50 | 见常开模式对应参数结构 | Y |
| 远程开锁 | 28 | - | N |
| 防撬报警 | 30 | - | N |
| 重置键配置 | 31 | - | N |
参数结构定义
自动闭锁参数示例
javascript
// 选择锁
await plugin.selectLock(...)
const params = {
accountInfo: this.accountInfo,
featureBit: 29,
data: Number(10), // 延时10秒
withParams: true
}
// 更新设置
const result = await plugin.updateSupportFunctionsWithParams(params)锁提示音参数示例
javascript
// 选择锁
await plugin.selectLock(...)
const params = {
accountInfo: this.accountInfo,
featureBit: 33,
data: Number(5), // 声音调至5档
withParams: true
}
// 更新设置
const result = await plugin.updateSupportFunctionsWithParams(params)常开模式参数结构
| 名称 | 类型 | 描述 |
|---|---|---|
| passageMode | Number | 0:关闭,1:打开 |
| startDate | Number | 开始时间,分钟数,例如480代表8:00 |
| endDate | Number | 结束时间,分钟数,例如1080代表18:00 |
| isAllDay | Number | 是否全天,0:否,1:是 |
| weekDay | Array<Number> | [1,2,3,4,5,6,7];表示周一至周日启用 |
| autoUnlock | Number | 自动开锁,0:关闭,1:开启 |
常开模式参数示例
javascript
// 选择锁
await plugin.selectLock(...)
// 构造参数
const passageMode = 1 // 打开常开模式
const startDate = 480 // 开始时间 8:00
const endDate = 1080 // 结束时间 18:00
const isAllDay = 0 // 不是全天
const weekDay = [1, 2, 3] // 表示周一、周二、周三启用
const autoUnlock = 1 // 启用自动开锁
// 构造参数
const params = {
accountInfo: this.accountInfo,
featureBit: 50,
data: {
passageMode: passageMode,
startDate: startDate,
endDate: endDate,
isAllDay: isAllDay,
weekDay: weekDay,
autoUnlock: autoUnlock
},
withParams: true
}
// 更新设置
const result = await plugin.updateSupportFunctionsWithParams(params)防撬报警参数示例
javascript
// 选择锁
await plugin.selectLock(...)
const params = {
accountInfo: this.accountInfo,
featureBit: 30, // 注意:防撬报警的位值是30,不是33
featureEnable: 1, // 1-开,0-关
withParams: false
}
// 更新设置
const result = await plugin.updateSupportFunctionsWithParams(params)
// 其他非参数功能同理,调整`featureBit`和`featureEnable`即可