ONENET设备终端接入协议3
MODBUS-TCP欢迎访问设备云门户网站http:/open.iot.10086.cn/注册用户，获取最新文档。版本号修订日期修订内容说明V1.02014.10.30新增V1.22015/8/5Dtu设备登录传输项目IDV1.32016/02/18增加接入流程例子V1.42016/07/06实现01，02，03，04功能码周期查询 通过URL获取服务IP和PORT设备定时发送心跳包通过restfull api主动下发在线命令1 说明基于modbus协议.pdf实现01, 02, 03, 04功能码周期查询。 适用于设备云定期主动发送 modbus-tcp 命令到设备查询寄存器值，设备回复寄存 器值的情况。2 名词解释项目ID：在平台注册账号后，添加新项目平台生成数字ID；Api-key：管理每个项目下资源，用于restful api鉴权。3 设备接入1 访问设备云门户注册用户，可以查看（项目ID）和master_key（api-key）；2 业务平台调用RESTFUL API新增设备，并指定如下设备属性：设备属性名说明interval设备云主动查询设备的时间间隔，单位秒auth_info设备鉴权信息，格式如下："登录报文的phone字段”:”登录报文的SVRPWD字段”3 设备上电，发送登录报文（ 52 字节）到设备云接入服务器进行鉴权，设备通过链接 http:api.heclouds.com/s?t=6&v=1 拉取服务器 IP 和 PORT，其中格式如下：HTTP情求HTTP方法Glzl请求URLhttp:/api heclouds.corTVs?t=6&v= 1电回（字符串| IP： PORT登录报文固定格式如下：（其中绿色三项为必填）报文字段固定长度说明type11字节设备类型字符串，以'0 '结尾，目前作为保留用途。name9字节设备名称字符串，以'0'结尾，目前作为保留用途。phone12字节设备通信卡号码，以'0'结尾。注册设备时作为auth_info属 性子域json对象的key，用于鉴权。svrpwd9字节服务器登录密码，以'0'结尾。注册设备时作为auth_info属 性子域json对象的value，用于鉴权。id11字节项目ID,以'0'结尾,平台申请项目时分配的项目ID字符串。4 设备登录成功后，服务器不会返回数据，如果登录失败，服务器会主动断开连接。4 数据流4.1 业务平台调用restfull api为设备新增数据流，数据流需要指定如下属性:数据流属性名说明cmd设备云为获取数据定期下发访问寄存器的命令，用十六进 制标示。如“ 83A245 ”表示二个字节的命令0X83A245。formula可选配置。对命令返回各个寄存器值的处理公式，多个公 式用分号间隔。例如:,（A0+A1）*A2",表示对命令返回的前两 个寄存器值的和再乘上第三个寄存器的值得到综合结果。 注意：公式不能与成这样（A0*A1），请去掉取外层的无效 括号，否则公式会被认为不合法，不会生效4.2 01、02命令返回结果（不支持formula属性）"起始地址":"线圈值1,线圈值乙,线圈值n" 其中，每个线圈值对应设备返回数据的一个byte 起始地址、线圈值都以10进制表示4.3 03 命令返回结果（支持 formula 属性）4.3.1 未设置 formula 属性"地址1”:”寄存器值1”, ”地址2”:”寄存器值2”,.，”地址n”:”寄存器值n” 其中，地址、寄存器值都以10 进制表示4.3.2 已设置 formula 属性"1”:”formula 计算结果 1”, "2”: "formula 计算结果 2”, . , "n”:”formula 计算结 果 n”其中，计算结果为double类型值 formula 属性可以有多个计算公式组合在一起，通过”;”隔开。1、2、n,分别表示第1、2、n个计算公式 AO、A1、An,分别表示第1、2、n个寄存器值 例如：(A0+A1)*A2 (A3-A4)/A5 + (A6+A7)%A8 + A9fA10目前 formula 支持运算符如下：+ - * / % ()f 表示前后操作数作为 uint16 ，然后合并组成 float例如 A0fA1unionuint32_t u32;float f32; u_f;u_f.u32 = (uint32_t)(uint16_t)A0)<<16)|(uint16_t)A1;u_f.f32即为f运算符运算结果4.4 04命令返回结果(不支持formula属性) “地址1” ：”寄存器值1”，”地址2” ：”寄存器值2”，”地址n” ：” 寄存器值n” 其中，地址、寄存器值都以10进制表示4.5 注意事项数据流中定时下发的命令尽量保持不同5 保持设备在线当设备处于空闲的时候，为了保持与0NENET平台的连接不断开，需要定期发送心跳包 推荐0x0000),以确保网络连接不断开。其中时间间隔须小于5分钟，推荐13分 钟。6 通过 restfull api 下发在线命令到设备区别于数据流的定时下发命令到设备，resfull api通过使用HTTP请求的方式，主动下发命令 到设备。其中,通过 restfull api 主动下发的命令，尽量与数据流中定时下发的命令保持不同。HTTP方法POSTURLhtt p:/api.heclouds.com/cmdsHTTP头部api-key:xxxx-ffff-zzzzz，必须 master keyURL参数device id = 接收该数据的MODBUS设备ID,必填。HTTP内容"cmd":”xxxxxxxx” /需要下发MODBUS设备的命令（16进制字符串）成功返回"errno": 0, "error":"succ”,"data":不超过64个字符字符串"cmd_uuid":"2302-312-FWs” 查看命令发送状态HTTP方法GETURLhtt p:/api.heclouds.com/cmds/<cmd uuid>HTTP头部api-key:xxxx-ffff-zzzzz，必须 master key成功返回"errno": 0,"error":"succ”,"data":。：设备不在线Device not online1 ：命令已创建 Command Created2 ：命令已发往设备Command Sent3 :命令发往设备失败Send Command Failed4：设备正常响应 Command Response Received5:命令执行超时 Command Response Timeout6：设备响应消息过长/ Command Response Too Large "status":1"desc":“sending”获取终端执行命令后的响应内容。HTTP方法GETURLhtt p:/api.heclouds.com/cmds/< cmd uuid >/respHTTP头部api-key:xxxx-ffff-zzzzz，必须 master keyHTTP bodyMODBUS设备响应数据（二进制）响应的HTTP状态码对应的错误信息如下400No api-key403Auth Failed404Not Found400Invalid Parameter220Command Created221Command Sent520Send Command Failed200Command Response Received432Command Response Timeout433Command Response Too Large7 接入例子 - 命令 03 读取保持寄存器（以下截图来自MODBUS协议pdf）1.利用 restfull api 创建设备POST http:/api.heclouds.com/devices HTTP/1.1 User-Agent: Fiddler注意长度和空行，建议使用fiddler 调试，会自动填充长度api-key: nCxNdCoX6eHGfergpyytu66TyuY= /*必须为 MasterKey*/ Host: api.heclouds.comContent-Length: 155"title":"12345670",/*填写 MODBUS 设备卡号*/"desc":"test modbus","private":true,"protocol":"HTTP",/*填写HTTP协议，没有专门的Modbus协议*/"auth_info":"12345670":"12345670",/*这里就是鉴权信息的卡号和密码，长度有限 制，参考登录报文格式*/"interval":20 /*命令的查询间隔*/此api没有针对modbus相关配置出错处理返回，必须仔细填写各个字段。2. 为该设备创建数据流使用 restfull api 创建，请求数据如下：POST http:/api.heclouds.com/devices/your_devid/datastreams HTTP/1.1User-Agent: FiddlerHost: api.heclouds.comContent-Length: 66api-key: nCxNdCoX6eHGfergpyytu66TyuY= /*设备对应的 key 或 masterkey*/注意长度和空行，建议使用fiddler 调试，会自动填充长度"id":"test_cmd","cmd":"1103006B00038776","interval":20CMD字段解释如下："1103006B00038776"对应的MODBUS RTU命令如下图所示： 0x11,0x03,0x0,0x6B,0x0,0x3,0x87,0x76,其中 0x87 和 0x76 存储的是 CRC16 结果 0x8776, 从Slave Address 0x11开始计算到最后一个寄存器地址（此处为0x3）。帕读保持寄存器世朗读尿机侧寺富存骼的.进制Jftia不支持v插-附乘I*列出门I】齐种塑号控制器圻支持的址尢的毎数站査询查制信息规定了亚读的寄存需起縮地址及寄存器的数僦，寄存器寻址据删址为0M®寄存器i-i&所对应的地扯分别AD-15ClUERAdd MarneSkj/fl AddrewFtiKlionStar!ng Addms HiSlwlhgLoNo. cl Poinls HNo. ol Ro site LoEmx Check (LRC<jrCRCjExampk图U.述民捽奇侔器誉呦3. 上传登录报文如前述登录报文格式,例子如下：unsigned
