Appearance
蓝牙遥控器模块
说明:管理蓝牙遥控器设备,支持永久、限时和循环三种类型。与普通遥控器相比,蓝牙遥控器增加 extraData JSON 字段用于存储扩展数据。
常量表
遥控器类型
| 类型 | 名称 |
|---|---|
| 1 | 永久遥控器 |
| 2 | 限时遥控器 |
| 4 | 循环遥控器 |
添加类型
| 类型 | 名称 |
|---|---|
| 1 | 蓝牙添加 |
| 2 | 网关添加 |
遥控器状态
| 状态 | 名称 |
|---|---|
| 1 | 正常 |
| 2 | 已失效 |
管理员遥控授权(remoteRight)
| 值 | 名称 |
|---|---|
| 0 | 默认否 |
| 1 | 是 |
| 2 | 否 |
是否胁迫遥控(isCoerced)
| 值 | 名称 |
|---|---|
| 0 | 默认否 |
| 1 | 是 |
| 2 | 否 |
添加蓝牙遥控器
- 接口地址
POST /api/v1/bluetooth-remote/add- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 12345 | 门锁ID |
| remoteName | string | Y | "测试蓝牙遥控器1" | 遥控器名称 |
| remoteNumber | string | Y | "123458" | 遥控器编号 |
| mac | string | N | "AA:BB:CC:DD:EE:FF" | Mac 地址 |
| remoteType | int | Y | 1 | 遥控器类型,见常量表遥控器类型 |
| addType | int | Y | 1 | 添加类型,见常量表添加类型 |
| startDate | int | N | 1717200000000 | 开始时间(毫秒时间戳),限时和循环类型必填;永久类型可传 0 |
| endDate | int | N | 1719792000000 | 结束时间(毫秒时间戳),限时和循环类型必填;永久类型可传 0 |
| weekDay | array | N | [1, 2, 3, 4, 5] | 循环时间设置(1-7,1 为星期一),循环类型可选 |
| electricQuantity | int | N | 0 | 电量 |
| firmwareInfo | object | N | {} | 固件版本信息(JSON 对象) |
| remoteUserNo | int | N | 0 | 遥控用户序号 |
| businessId | int | N | 0 | 业务平台关联 ID |
| remoteRight | int | N | 0 | 是否授权管理员遥控,见常量表管理员遥控授权 |
| isCoerced | int | N | 0 | 是否胁迫遥控,见常量表是否胁迫遥控 |
| extraData | object | N | {} | 附加数据(JSON 对象,建议不超过 1KB) |
- 返回
返回结果中 data 包含:
| 名称 | 类型 | 描述 |
|---|---|---|
| remoteId | int | 遥控器ID |
- 返回示例
json
{
"errcode": 0,
"errmsg": "none error message",
"description": "",
"data": {
"remoteId": 123
}
}检查遥控器名称是否重复
- 接口地址
POST /api/v1/bluetooth-remote/checkRemoteName- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 12345 | 门锁ID |
| remoteName | string | Y | "测试蓝牙遥控器" | 遥控器名称 |
返回
返回示例
json
{
"errcode": -3,
"errmsg": "蓝牙遥控名称已存在",
"description": "蓝牙遥控名称已存在"
}蓝牙遥控器列表
- 接口地址
GET /api/v1/bluetooth-remote/list- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 12345 | 门锁ID |
| pageNo | int | N | 1 | 页码 |
| pageSize | int | N | 20 | 每页数量 |
- 返回
返回结果中 data 包含:
| 名称 | 类型 | 描述 |
|---|---|---|
| list | array | 遥控器列表 |
| pageNo | int | 页码 |
| pageSize | int | 每页数量 |
| pages | int | 总页数 |
| total | int | 总条数 |
list 中每个元素包含:
| 名称 | 类型 | 描述 |
|---|---|---|
| id | int | 遥控器ID |
| lockId | int | 门锁ID |
| remoteName | string | 遥控器名称 |
| remoteNumber | string | 遥控器编号 |
| remoteType | int | 遥控器类型 |
| remoteTypeName | string | 遥控器类型名称 |
| addType | int | 添加类型 |
| addTypeName | string | 添加类型名称 |
| startDate | int | 开始时间(毫秒时间戳) |
| endDate | int | 结束时间(毫秒时间戳) |
| weekDay | array | 星期数组 |
| isCoerced | int | 是否胁迫 |
| extraData | object | 扩展数据 |
| status | int | 状态 |
| statusName | string | 状态名称 |
| apiUserId | int | API 用户ID |
| createTime | int | 创建时间 |
| updateTime | int | 更新时间 |
- 返回示例
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- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 12345 | 门锁ID |
| remoteId | int | Y | 123 | 遥控器ID |
| remoteName | string | N | "更新后的名称" | 遥控器名称 |
| remoteType | int | N | 1 | 遥控器类型 |
| startDate | int | N | 1717200000000 | 开始时间(毫秒时间戳) |
| endDate | int | N | 1719792000000 | 结束时间(毫秒时间戳) |
| weekDay | array | N | [1, 2, 3] | 星期数组(1-7) |
| isCoerced | int | N | 0 | 是否胁迫 |
| extraData | object | N | {} | 扩展数据(JSON 对象) |
返回
返回示例
json
{
"errcode": 0,
"errmsg": "none error message",
"description": "",
"data": {}
}蓝牙遥控器详情
- 接口地址
POST /api/v1/bluetooth-remote/detail- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| remoteId | int | Y | 123 | 遥控器ID |
- 返回
返回结果中 data 包含遥控器详细信息;lockInfo 为关联门锁信息。
lockInfo 包含:
| 名称 | 类型 | 描述 |
|---|---|---|
| lockId | int | 门锁ID |
| lockName | string | 门锁名称 |
| lockAlias | string | 锁别名 |
- 返回示例
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- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| remoteId | int | Y | 123 | 遥控器ID |
返回
返回示例
json
{
"errcode": 0,
"errmsg": "none error message",
"description": "",
"data": {}
}清空蓝牙遥控器
- 接口地址
POST /api/v1/bluetooth-remote/clear- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 12345 | 门锁ID |
- 返回
返回结果中 data 包含:
| 名称 | 类型 | 描述 |
|---|---|---|
| deletedCount | int | 删除数量 |
- 返回示例
json
{
"errcode": 0,
"errmsg": "none error message",
"description": "",
"data": {
"deletedCount": 5
}
}更新遥控器用户编号
- 接口地址
POST /api/v1/bluetooth-remote/updateRemoteUserNo- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 12345 | 门锁ID |
| remoteId | int | Y | 123 | 遥控器ID |
| remoteUserNo | int | Y | 10 | 新的用户编号 |
返回
返回示例
json
{
"errcode": 0,
"errmsg": "none error message",
"description": "",
"data": {}
}