1 方案介绍

室内各传感器的数据都汇总到室内机上，室内机通过小区局域网直连物业管理一体机，即边缘服务器。传感器产生的报警事件由室内机上报到边缘服务器。边缘服务生成物模型事件并同步到物联网平台

2 接口说明

室内机对接边缘服务器，访问10070端口。

边缘服务器访问室内机的端口由设备厂商自定义，定义后固定不变。

所有HTTP 报文的首部信息中，不能带有Connection: Keep-Alive字段，可以设置为Connection:Close。

物业管理一体机，以下简称“边缘服务器”。

3 服务接口

3.1 服务检测

调用此接口检查服务是否可用。

URL：http://[边缘服务器IP 或 室内机IP]:[端口]/alarm/ping
Method：GET
Content-Type：application/json

说明

服务启动后开始监听端口数据，当收到ping消息后，立刻回复pong，以表示服务状态正常，否则无消息返回。

请求参数

无。

返回参数

示例

正常返回示例

{
    "code": 0,
    "message": "pong"
}

3.2 建立连接

室内机向边缘服务器发送连接请求。

URL：http://[边缘服务器IP]:[端口]/alarm/connect
Method：POST
Content-Type：application/json

说明

前置条件：

室内机先预置安全密钥（RSA公钥），再进行连接。

建立连接交互流程：

1. 室内机携带下面的请求参数向边缘服务器发起连接请求。

2. 边缘服务器校验IP参数是否已经配置，如未配置，拒绝连接请求。设备信息配置需要预先在云端配置好，并部署到边缘。

3. 如果配置校验通过，边缘服务器返回成功消息给室内机。响应消息中包含一个有效的token。

4. 边缘服务器向室内机发送“服务检测”ping请求，室内机返回pong消息给边缘服务器，连接建立完成。

5. 如果室内机没有收到成功消息和token，等待一分钟后，再次发起连接请求。

connect请求里，如果参数encrypted为1，那么参数ciphertext的内容为使用RSA公钥加密的密文。下面是生成密文和发送密文的方法：

1. 室内机先随机生成一个长度为16字节的AES Secret Key，再使用预置的RSA公钥对AESSecret Key进行加密，把生成的密文发送给边缘服务器。

2. 边缘服务器使用RSA私钥解密出AES Secret Key并保存，在后续通信中，用它对数据进行加解密。

3. 连接建立成功后，室内机发送的数据都使用AES Secret Key进行加密，室内机收到的数据也是使用AES Secret Key加密的。

说明：

RSA的加密模式为：ECB；填充模式为：PKCS1Padding。（JAVA为：RSA/ECB/PKCS1Padding）

AES长度128位，加密模式为：ECB；填充模式为：PKCS7Padding。（JAVA为：AES/ECB/PKCS5Padding）

限制

调用该接口的每秒请求数（QPS）最大限制为10。

请求参数

返回参数

示例

请求示例

{
    "version": "2021-01-01",
    "protocol": "2021-01-01",
    "sn": "123456789",
    "vendor": "DEV",
    "model": "DEV-HW-210",
    "time": 1589472000,
    "ip": "192.168.1.128",
    "mac": "00-16-EA-AE-3D-40",
    "port": 10000,
    "keepalive": 30,
    "encrypted": 1,
    "ciphertext": "hlbtFix0/wrcca8SqUcy+5Q8J76xOM29fp4itQhstZhAQRRi+RITQPupSSnrZCXAGzPHYUdbKWijcMa0FGwAoPqw4m0Mot1HT3qKxMBHTvSGuOEayozZJMj18FL0tceGZ2V5BxkethBDsRTfn2qaDEMCaS9+go0dqj1aP0IjrYg="
}

正常返回示例

{
    "code": 0,
    "message": "success",
    "data":{
        "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
    }
}

3.3 心跳保活

室内机向边缘服务器定期发送心跳消息，以确保消息通道的连通性，维持设备的在线状态。

URL：http://[边缘服务器IP]:[端口]/alarm/keepalive
Method：POST
Content-Type：application/json

说明

建立连接后，服务器会向客户端颁发一个token，心跳消息中需要携带此token。当发送心跳时，返回token无效，那么需要重新建立连接，获取有效token。

成功时，返回的消息体中包含一个时间参数，可以用来同步双方时间。

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

返回参数

示例

请求示例

{
    "version": "2021-01-01",
    "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
}

正常返回示例

{
    "code": 0,
    "message": "success",
    "data":{
        "time": "1591069176000"
    }
}

3.4 上报防区信息和状态

室内机上报主机下的防区信息和防区状态给边缘服务器。

URL：http://[边缘服务器IP]:[端口]/alarm/reportZoneInfo
Method：POST
Content-Type：application/json

说明

每次建立连接后，上报一次防区信息和状态。当防区信息或状态变化时，立即上报实时的防区信息和状态。

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

加密的

返回参数

示例

请求示例

{
    "version":"2021-01-01",
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "zoneInfo":[
        {
            "zoneID":"01",
            "zoneDeviceType":1,
            "zoneState":1
        },
        {
            "zoneID":"02",
            "zoneDeviceType":3,
            "zoneState":2
        }
    ]
}

加密的

{
    "version":"2021-01-01",
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "ciphertext":"ewogICAgJ2EiJzoiYiIKfQ=="
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

3.5 设置防区布防状态

边缘服务器对室内机下的指定防区进行设防或撤防操作。

URL：http://[室内机IP]:[端口]/alarm/setZoneAlertState
Method：POST
Content-Type：application/json

说明

可以对一个或多个防区进行布防或撤防操作。

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

加密的

返回参数

示例

请求示例

{
    "version":"2021-01-01",
    "zoneInfo":[
        {
            "zoneID":"01",
            "zoneState":1,
            "time":"1591069176000"
        },
        {
            "zoneID":"02",
            "zoneState":2,
            "time":"1591069176000"
        }
    ]
}

加密的

{
    "version":"2021-01-01",
    "ciphertext":"ewogICAgJ2EiJzoiYiIKfQ=="
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

3.6 防区报警

室内机发送防区设备报警信息给边缘服务器。

URL：http://[边缘服务器IP]:[端口]/alarm/reportAlarm
Method：POST
Content-Type：application/json

说明

当防区设备触发报警时，根据报警触发规则，室内机上报报警信息给边缘服务器。

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

加密的

返回参数

示例

请求示例

{
    "version":"2021-01-01",
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "alarmInfo":[
        {
            "zoneID":"01"
        },
        {
            "zoneID":"02",
            "alarmTime":"1591069176000"
        }
    ]
}

加密的

{
    "version":"2021-01-01",
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "ciphertext":"ewogICAgJ2EiJzoiYiIKfQ=="
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

附录

探测器类型

1.SOS紧急按钮
2.红外
3.门磁
4.窗磁
5.瓦斯
6.烟雾
7.水浸
8.震动
9.气压