Skip to content

扩展功能操作(ic卡、指纹、人脸、遥控、掌静脉)

说明:主要对扩展功能进行操作,例如注册、修改、删除扩展功能(ic卡、指纹、人脸、遥控、掌静脉),以及获取相关列表等。

注册、修改、删除、删除全部

  • 调用方法
javascript
const result = await plugin.registerExtendedProducts(params)
  • 参数说明

通用参数

名称类型是否必需示例描述
typeStringY"card"功能类型:['card','fingerprint','face','remote','palmVein'] 其中一个
keyIdStringY"key123"钥匙 ID
uidStringY"123"用户uid
userCountLimitNumberY65535使用次数限制,0xFFFF 表示不限次数
operateNumberY0操作类型:0: 注册, 1: 修改, 2: 删除, 3: 删除全部
isAdminNumberY0是否管理员:1 表示是,0 表示否
isForceNumberY0是否胁迫:1 表示是,0 表示否
isRoundNumberY0是否循环:1 表示是,0 表示否
weekDayArray<Number>Y[1,2,4]循环周期,默认传入空数组[],0-6 置位分别代表周日-周六;例如:循环星期一、星期二、星期四,对应为:[1,2,4]
startDateNumberY1609459200000生效日期,时间戳,永久则填0
endDateNumberY1609545600000失效日期,时间戳,永久则填0
startTimeStringY"00:00"生效时间,例如:'00:00'
endTimeStringY"23:59"失效时间,例如:'23:59'

IC卡相关参数(type 为 'card' 时需要)

名称类型是否必需示例描述
cardIdNumberN100卡片Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
cardNumberNumberN1卡片序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
cardNameStringN"我的卡片"卡片名称
cardTypeNumberN1卡片类型:1:永久,2:期限,4:循环
cardUserNoNumberN1卡UserNo(选填)

指纹相关参数(type 为 'fingerprint' 时需要)

名称类型是否必需示例描述
fingerprintIdNumberN100指纹Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
fingerprintNumberNumberN1指纹序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
fingerprintNameStringN"我的指纹"指纹名称
fingerprintTypeNumberN1指纹类型:1:永久,2:期限,4:循环
fingerprintUserNoNumberN1指纹UserNo(选填)
deleteTypeNumberN1删除方式:1:通过APP走蓝牙删除,必需先通过APP蓝牙删除后再调用该接口;2:通过网关或WiFi锁删除,如果是WiFi锁或有连接网关,则可以传2,直接调用该接口从锁里删除指纹

人脸相关参数(type 为 'face' 时需要)

名称类型是否必需示例描述
faceIdNumberN100人脸Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
faceNumberNumberN1人脸序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
faceNameStringN"我的人脸"人脸名称
faceTypeNumberN1人脸类型:1:永久,2:期限,4:循环
faceUserNoNumberN1人脸UserNo(选填)

掌静脉相关参数(type 为 'palmVein' 时需要)

名称类型是否必需示例描述
palmVeinIdNumberN100掌静脉Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
palmVeinNumberNumberN1掌静脉序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
palmVeinNameStringN"我的掌静脉"掌静脉名称
palmVeinTypeNumberN1掌静脉类型:1:永久,2:期限,4:循环
palmVeinUserNoNumberN1掌静脉UserNo(选填)

遥控相关参数(type 为 'remote' 时需要)

名称类型是否必需示例描述
remoteIdNumberN100遥控Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
remoteNumberNumberN1遥控序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能
remoteNameStringN"我的遥控"遥控名称
remoteTypeNumberN1遥控类型:1:永久,2:期限,4:循环
remoteUserNoNumberN1遥控UserNo(选填)
  • 返回

返回结果遵循 Result 方法的统一返回结构

注意:收到锁版提示后,将卡片放置读卡器

取消操作

  • 调用方法
javascript
const result = await plugin.registerExtendedProductsCancel(params)
  • 参数说明
名称类型是否必需示例描述
typeStringY"card"功能类型:['card','fingerprint','face','remote','palmVein']
keyIdStringY"key123"钥匙 ID
uidStringY"123"用户uid
  • 返回

返回结果遵循 Result 方法的统一返回结构

获取IC卡列表

  • 调用方法
javascript
const result = await plugin.getIcCardList(params)
  • 参数说明
名称类型是否必需示例描述
lockIdStringY"500"锁id
pageNoStringN"1"页码
pageSizeStringN"10"每页显示数
  • 返回

返回结果遵循 Result 方法的统一返回结构,data 中包含:

json
{
  "list": [],
  "pageNo": 1,
  "pageSize": 10,
  "pages": 0,
  "total": 0
}

获取指纹列表

  • 调用方法
javascript
const result = await plugin.getFingerprintList(params)
  • 参数说明
名称类型是否必需示例描述
lockIdStringY"500"锁id
pageNoStringN"1"页码
pageSizeStringN"10"每页显示数
  • 返回

返回结果遵循 Result 方法的统一返回结构,data 中包含:

json
{
  "list": [],
  "pageNo": 1,
  "pageSize": 10,
  "pages": 0,
  "total": 0
}

获取人脸列表

  • 调用方法
javascript
const result = await plugin.getFaceList(params)
  • 参数说明
名称类型是否必需示例描述
lockIdStringY"500"锁id
pageNoStringN"1"页码
pageSizeStringN"10"每页显示数
  • 返回

返回结果遵循 Result 方法的统一返回结构,data 中包含:

json
{
  "list": [],
  "pageNo": 1,
  "pageSize": 10,
  "pages": 0,
  "total": 0
}

获取掌静脉列表

  • 调用方法
javascript
const result = await plugin.getPalmVeinList(params)
  • 参数说明
名称类型是否必需示例描述
lockIdStringY"500"锁id
pageNoStringN"1"页码
pageSizeStringN"10"每页显示数
  • 返回

返回结果遵循 Result 方法的统一返回结构,data 中包含:

json
{
  "list": [],
  "pageNo": 1,
  "pageSize": 10,
  "pages": 0,
  "total": 0
}

获取遥控列表

  • 调用方法
javascript
const result = await plugin.getRemoteList(params)
  • 参数说明
名称类型是否必需示例描述
lockIdStringY"500"锁id
pageNoStringN"1"页码
pageSizeStringN"10"每页显示数
  • 返回

返回结果遵循 Result 方法的统一返回结构,data 中包含:

json
{
  "list": [],
  "pageNo": 1,
  "pageSize": 10,
  "pages": 0,
  "total": 0
}

物联网设备通信协议文档