OneNET平台HTTP推送服务接入
在使用OneNET平台时,如果我们自己开发应用,基本上会有获取设备的上下线信息以及设备上传的数据点的需求。
为了满足上述的需求,我们有以下两种方法:
使用OneNET的HTTP RESTful API轮询获取设备上下线状态以及数据点
使用OneNET提供的数据推送的服务,实时推送设备上下线状态以及数据点至自己的服务器。
本篇我主要讲解OneNET平台的多协议产品如何使用HTTP推送服务。其中我在文章演示时的后台开发语言使用python
官方文档
平台提供数据推送功能,可以将平台作为客户端,将相关信息以HTTP/HTTPS请求的方式,发送给应用服务器。
其中,相关信息包括:
- 设备新增数据点消息
- 设备上下线消息
- 设备对于下行命令的应答信息(仅限NB设备)
平台发起的HTTP请求主要包括:
- GET:用于用户所配置的URL有效性验证
- POST:用于推送新增数据点消息、设备上下线消息以及设备对于下行命令的应答信息
推送服务提供数据过滤功能,用户可以以数据流模板为过滤条件,过滤掉例如设备的频繁的周期性上报等大量时间不敏感数据,只推送用户自己关心的实时性要求较高的数据。
推送功能提供数据压缩的功能,用户可以设置数据量以及时间的压缩方式,将一定时间内的一定量的多包单信息报文,合并成为一包包含多条信息的json数据,可以大大减少应用服务器的处理压力。
OneNET配置演示
下面,我们直接进行演示,这里我基于Modbus协议的产品(其它协议使用方法是一样的)进行演示。
服务配置指南
点击OneNET控制台左侧列表的"数据推送\HTTP推送"
消息推送的控制页面如下
接下来,我们首先添加一条全局推送。
启动web服务
添加全局推送就是要添加一个支持OneNET相应开发规则的URL,首先我们先准备一个能正常访问的URL,比如我这里的:
http://IP:8001/he/data/push/global
**一定要先确保该URL链接能 正常访问、正常访问、正常访问! **
我此时的python源码为:
from flask import Flask
from flask import request
import hashlib
import base64
app = Flask(__name__)
# OneNET全局推送链接
@app.route("/he/data/push/global", methods=['GET'])
def he_data_push_global():
return 'Hello IOT'
if __name__ == '__main__':
app.run(host='0.0.0.0', debug=True,port = 8001)
点击"添加全局推送"
填写相关的信息:
URL:http://IP:8001/he/data/push/global
Token:token
消息加密方式:明文模式
数据推送:全部数据流
然后点击"添加"按钮,此时OneNET会弹出如下信息:
大概的意思是"鉴权失败,验证Token失败"。同时,当你点击"添加"按钮后,你可以看到你填写的URL会接收到如下一个请求:
GET /onenet?msg=LeoTAq&signature=/7hXrr3IpM538Z1uHvxSlA==&nonce=B0k7pDoe
开发指南
可以看到URL后面携带了三个参数msg
、signature
、nonce
,好了,这就要涉及到OneNET URL验证的问题了。
在使用推送服务时,OneNET作为客户端,而用户的第三方应用是作为服务器,第三方应用需要支持URL验证以及数据接收两部分服务。
用户在配置页面完成配置并点击“添加”时,OneNET平台会向填写URL地址发送HTTP GET请求进行URL验证,请求形式示例如下:
http://url?msg=xxx&nonce=xxx&signature=xxx
其中,url为用户在页面配置时填写的URL,nonce
、msg
、signature
用于URL及token
的验证
token验证过程如下:
- 将配置页面中配置的token与URL中的nonce、msg的值计算MD5,并且编码为Base64字符串值
- 将上一步中Base64字符串值通过URL Decode计算后的值与请求参数signature的值进行对比,如果相等则表示token验证成功
- 如果token验证成功,返回msg参数值,表示URL验证通过。
但是,还有一点,OneNET作了特别说明:
如果用户不想验证token,可以选择跳过MD5计算过程,直接返回msg参数值
也就是说,只要你的URL返回请求中的msg值,那就说明URL验证通过。我们先不对token进行校验,我们简单一点,直接获取并返回URL中的msg参数。流程跑通之后,我们再研究token验证的问题。
如下,我修改了服务端的Python代码:
@app.route("/he/data/push/global", methods=['GET'])
def he_data_push_global():
msg = request.args.get('msg') or None
signature = request.args.get('signature') or None
nonce = request.args.get('nonce') or None
if not all([msg, signature, nonce]):
return 'invalid parameter'
return msg
然后再点击"添加"按钮,
此时可以看到,全局推送URL添加成功。
数据推送的内容
设备上下线信息
设备新增数据点消息
OneNET平台以HTTP POST请求形式向第三方平台URL地址推送数据,第三方平台接收到数据后需要返回 HTTP 200,否则OneNET会认为此次推送无效并重试。
推送数据相关信息以JSON串的形式置于HTTP请求中的body部分,其中各个字段的含义如下:
既然OneNET是以POST形式推送数据,那么我们就得在我们服务器指定的URL支持POST连接,我修改服务器端代码如下:
@app.route("/he/data/push/global", methods=['GET', 'POST'])
def he_data_push_global():
if request.method == 'POST':
print('**** Receive Post Data *****')
data = request.data.decode('utf-8')
print(data)
return 'POST SUCCESS'
msg = request.args.get('msg') or None
signature = request.args.get('signature') or None
nonce = request.args.get('nonce') or None
if not all([msg, signature, nonce]):
return 'invalid parameter'
return msg
服务端没有做什么内容,只是打印输出POST传递过来的Body数据。