网关模块

说明：主要对网关进行一些基础操作，例如添加网关、获取网关列表、更新网关、检查网关名称、获取网关关联的锁、获取网关详情、删除网关、批量关联网关锁等。

常量表

网关类型

类型	名称
1	G1(Wi-Fi)
2	G2(Wi-Fi)
3	G3(有线)
4	G4(4G)
5	MQTT(Wi-Fi)
6	MQTT(有线)

添加网关

• 接口地址

POST /api/v1/gateway/add

• 参数说明

名称	类型	是否必需	示例	描述
gatewayName	string	Y	"我的网关"	网关名称
gatewayMac	string	Y	"00:00:00:00:00:01"	网关MAC地址
model	string	Y/N	"G2"	产品型号 [MQTT网关]必填
serialNumber	string	Y	"0000000000000000"	网关序列号 [MQTT网关]可以使用mac地址代替
gatewayType	int	Y	1	网关类型，看常量表网关类型
version	string	Y	"1.0.0"	网关当前版本
gatewayJson	object	Y	{}	网关透传json对象凭证，必填
networkName	string	Y/N	"XinHongJia"	WiFi名称，WIFI 必填
networkMac	string	Y/N	"00:00:00:00:00:00"	WiFi-MAC地址，WIFI 必填
firmwareInfo	object	N	{}	固件信息

• 返回

返回结果中 data 包含：

名称	类型	描述
gatewayId	int	网关ID

• 返回示例

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

网关列表

• 接口地址

POST /api/v1/gateway/list

• 参数说明

名称	类型	是否必需	示例	描述
pageNo	int	N	1	页码
pageSize	int	N	20	每页数量

• 返回

返回结果中 data 包含：

名称	类型	描述
list	array	网关列表
pageNo	int	页码
pageSize	int	每页数量
pages	int	总页数
total	int	总条数

• 返回示例

{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {
    "list": [
      {
        "serialNumber": "0000000000000000",
        "gatewayMac": "00:00:00:00:00:02",
        "gatewayName": "G2（WI-FI）网关",
        "gatewayType": 1,
        "networkName": "XinHongJia",
        "networkMac": "00:00:00:00:00:00",
        "lockNum": 0,
        "isOnline": 0,
        "version": null,
        "gatewayId": 12,
        "mqttUsername": "",
        "gatewayJson": {
          "secret": ""
        }
      }
    ],
    "pageNo": 1,
    "pageSize": 20,
    "pages": 1,
    "total": 2
  }
}

更新网关

• 接口地址

POST /api/v1/gateway/update

• 参数说明

名称	类型	是否必需	示例	描述
gatewayId	int	Y	12	网关ID
gatewayName	string	N	"我的网关"	网关名称
version	string	N	"1.0.0"	网关版本

• 返回

• 返回示例

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

检查网关名称是否重复

• 接口地址

POST /api/v1/gateway/checkGatewayName

• 参数说明

名称	类型	是否必需	示例	描述
gatewayName	string	Y	"我的网关"	网关名称

• 返回

• 返回示例

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

获取网关关联的锁

• 接口地址

POST /api/v1/gateway/listByLock

• 参数说明

名称	类型	是否必需	示例	描述
gatewayId	int	Y	12	网关ID
pageNo	int	N	1	页码
pageSize	int	N	10	每页数量

• 返回

返回结果中 data 包含：

名称	类型	描述
list	array	锁列表
pageNo	int	页码
pageSize	int	每页数量
pages	int	总页数
total	int	总条数

list 中每个元素包含：

名称	类型	描述
lockId	int	锁ID
lockAlias	string	锁别名
gatewayRssi	int	网关与锁之间信号强度，0最强 ~ -100无信号

• 返回示例

{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {
    "list": [
      {
        "lockId": 500,
        "lockAlias": "家庭锁",
        "gatewayRssi": -100
      }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "pages": 1,
    "total": 0
  }
}

网关详情

• 接口地址

POST /api/v1/gateway/detail

• 参数说明

名称	类型	是否必需	示例	描述
gatewayId	int	Y	12	网关ID

• 返回

返回结果中 data 包含网关详细信息。

• 返回示例

{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {
    "serialNumber": "0000000000000000",
    "gatewayMac": "00:00:00:00:00:02",
    "gatewayName": "G2（WI-FI）网关",
    "gatewayType": 1,
    "networkName": "XinHongJia",
    "networkMac": "00:00:00:00:00:00",
    "lockNum": 0,
    "isOnline": 0,
    "version": null,
    "gatewayId": 12,
    "mqttUsername": "",
    "gateway": {
      "secret": ""
    }
  }
}

删除网关

• 接口地址

POST /api/v1/gateway/delete

• 参数说明

名称	类型	是否必需	示例	描述
gatewayId	int	Y	12	网关ID
isForce	int	Y	0	是否强制删除：0-否 1-是

• 返回

• 返回示例

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

批量关联网关锁

• 接口地址

POST /api/v1/gateway/scanDevice

• 参数说明

名称	类型	是否必需	示例	描述
gatewayId	int	Y	12	网关ID
devices	array	Y	[]	设备列表

devices 数组中每个元素包含：

名称	类型	是否必需	示例	描述
mac	string	Y	"AA:BB:CC:DD:EE:FF"	锁设备的蓝牙 MAC 地址，格式如 "AA:BB:CC:DD:EE:FF"
rssi	integer	Y	-45	信号强度（RSSI），通常为负数，如 -45

• 返回

• 返回示例

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