Skip to content

蓝牙遥控器模块

说明:管理蓝牙遥控器设备,支持永久、限时和循环三种类型。与普通遥控器相比,蓝牙遥控器增加 extraData JSON 字段用于存储扩展数据。

常量表

遥控器类型

类型名称
1永久遥控器
2限时遥控器
4循环遥控器

添加类型

类型名称
1蓝牙添加
2网关添加

遥控器状态

状态名称
1正常
2已失效

管理员遥控授权(remoteRight)

名称
0默认否
1
2

是否胁迫遥控(isCoerced)

名称
0默认否
1
2

添加蓝牙遥控器

  • 接口地址
POST /api/v1/bluetooth-remote/add
  • 参数说明
名称类型是否必需示例描述
lockIdintY12345门锁ID
remoteNamestringY"测试蓝牙遥控器1"遥控器名称
remoteNumberstringY"123458"遥控器编号
macstringN"AA:BB:CC:DD:EE:FF"Mac 地址
remoteTypeintY1遥控器类型,见常量表遥控器类型
addTypeintY1添加类型,见常量表添加类型
startDateintN1717200000000开始时间(毫秒时间戳),限时和循环类型必填;永久类型可传 0
endDateintN1719792000000结束时间(毫秒时间戳),限时和循环类型必填;永久类型可传 0
weekDayarrayN[1, 2, 3, 4, 5]循环时间设置(1-7,1 为星期一),循环类型可选
electricQuantityintN0电量
firmwareInfoobjectN{}固件版本信息(JSON 对象)
remoteUserNointN0遥控用户序号
businessIdintN0业务平台关联 ID
remoteRightintN0是否授权管理员遥控,见常量表管理员遥控授权
isCoercedintN0是否胁迫遥控,见常量表是否胁迫遥控
extraDataobjectN{}附加数据(JSON 对象,建议不超过 1KB)
  • 返回

返回结果中 data 包含:

名称类型描述
remoteIdint遥控器ID
  • 返回示例
json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {
    "remoteId": 123
  }
}

检查遥控器名称是否重复

  • 接口地址
POST /api/v1/bluetooth-remote/checkRemoteName
  • 参数说明
名称类型是否必需示例描述
lockIdintY12345门锁ID
remoteNamestringY"测试蓝牙遥控器"遥控器名称
  • 返回

  • 返回示例

json
{
  "errcode": -3,
  "errmsg": "蓝牙遥控名称已存在",
  "description": "蓝牙遥控名称已存在"
}

蓝牙遥控器列表

  • 接口地址
GET /api/v1/bluetooth-remote/list
  • 参数说明
名称类型是否必需示例描述
lockIdintY12345门锁ID
pageNointN1页码
pageSizeintN20每页数量
  • 返回

返回结果中 data 包含:

名称类型描述
listarray遥控器列表
pageNoint页码
pageSizeint每页数量
pagesint总页数
totalint总条数

list 中每个元素包含:

名称类型描述
idint遥控器ID
lockIdint门锁ID
remoteNamestring遥控器名称
remoteNumberstring遥控器编号
remoteTypeint遥控器类型
remoteTypeNamestring遥控器类型名称
addTypeint添加类型
addTypeNamestring添加类型名称
startDateint开始时间(毫秒时间戳)
endDateint结束时间(毫秒时间戳)
weekDayarray星期数组
isCoercedint是否胁迫
extraDataobject扩展数据
statusint状态
statusNamestring状态名称
apiUserIdintAPI 用户ID
createTimeint创建时间
updateTimeint更新时间
  • 返回示例
json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {
    "list": [
      {
        "id": 123,
        "lockId": 12345,
        "remoteName": "测试蓝牙遥控器1",
        "remoteNumber": "123458",
        "remoteType": 1,
        "remoteTypeName": "永久遥控器",
        "addType": 1,
        "addTypeName": "蓝牙添加",
        "startDate": 0,
        "endDate": 0,
        "weekDay": [],
        "isCoerced": 0,
        "extraData": {
          "deviceModel": "BT-Remote-001",
          "manufacturer": "XHJ"
        },
        "status": 1,
        "statusName": "正常",
        "apiUserId": 1001,
        "createTime": 1717200000000,
        "updateTime": 1717200000000
      }
    ],
    "pageNo": 1,
    "pageSize": 20,
    "pages": 1,
    "total": 1
  }
}

更新蓝牙遥控器

  • 接口地址
POST /api/v1/bluetooth-remote/update
  • 参数说明
名称类型是否必需示例描述
lockIdintY12345门锁ID
remoteIdintY123遥控器ID
remoteNamestringN"更新后的名称"遥控器名称
remoteTypeintN1遥控器类型
startDateintN1717200000000开始时间(毫秒时间戳)
endDateintN1719792000000结束时间(毫秒时间戳)
weekDayarrayN[1, 2, 3]星期数组(1-7)
isCoercedintN0是否胁迫
extraDataobjectN{}扩展数据(JSON 对象)
  • 返回

  • 返回示例

json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {}
}

蓝牙遥控器详情

  • 接口地址
POST /api/v1/bluetooth-remote/detail
  • 参数说明
名称类型是否必需示例描述
remoteIdintY123遥控器ID
  • 返回

返回结果中 data 包含遥控器详细信息;lockInfo 为关联门锁信息。

lockInfo 包含:

名称类型描述
lockIdint门锁ID
lockNamestring门锁名称
lockAliasstring锁别名
  • 返回示例
json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {
    "id": 123,
    "lockId": 12345,
    "remoteName": "测试蓝牙遥控器1",
    "remoteNumber": "123458",
    "remoteType": 1,
    "remoteTypeName": "永久遥控器",
    "addType": 1,
    "addTypeName": "蓝牙添加",
    "startDate": 0,
    "endDate": 0,
    "weekDay": [],
    "isCoerced": 0,
    "extraData": {
      "deviceModel": "BT-Remote-001",
      "manufacturer": "XHJ"
    },
    "status": 1,
    "statusName": "正常",
    "apiUserId": 1001,
    "createTime": 1717200000000,
    "updateTime": 1717200000000,
    "lockInfo": {
      "lockId": 12345,
      "lockName": "测试门锁",
      "lockAlias": "前门"
    }
  }
}

删除蓝牙遥控器

  • 接口地址
POST /api/v1/bluetooth-remote/delete
  • 参数说明
名称类型是否必需示例描述
remoteIdintY123遥控器ID
  • 返回

  • 返回示例

json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {}
}

清空蓝牙遥控器

  • 接口地址
POST /api/v1/bluetooth-remote/clear
  • 参数说明
名称类型是否必需示例描述
lockIdintY12345门锁ID
  • 返回

返回结果中 data 包含:

名称类型描述
deletedCountint删除数量
  • 返回示例
json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {
    "deletedCount": 5
  }
}

更新遥控器用户编号

  • 接口地址
POST /api/v1/bluetooth-remote/updateRemoteUserNo
  • 参数说明
名称类型是否必需示例描述
lockIdintY12345门锁ID
remoteIdintY123遥控器ID
remoteUserNointY10新的用户编号
  • 返回

  • 返回示例

json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {}
}

物联网设备通信协议文档