OPC_AGENT V1.0 API 开发文档

一、HTTP 接口部分

1.获取当前系统的版本信息

GET /api/system
响应:
@string   SDK_VERSION          opc_sdk 的版本号
@string   SDK_BUILD            opc sdk 的编译日期
@string   AGENT_VERSION        agent 的版本号
@string   AGENT_BUILD          agent 的编译日期
@int      restful_port         http 的端口
@int      socket_port          socket 的端口
@string   opc_server_ip        opc 服务器的ip
@string   opc_service_name     opc服务器的名字
@string   opc_service_classid  opc服务器的classid

2.请求认证当前的token

POST /api/auth
Body:
@string   token                请求的token
响应: None 

3.获取系统中所有的点位

GET  /api/tags/all
响应: 
[
   @string 点位的名称
] 

4.查询指定项下的属性

GET  /api/tags/children/branch
Query:
@string    parent_tag          父节点的名称,不传默认为根节点  
响应:
@string    parent_tag          父节点名称,为空是根节点
@list      children            @string,  子属性的名称

4.查询指定项下的子节点

GET  /api/tags/children/leaf
Query:
@string    parent_tag          父节点的名称,不传默认为根节点 
响应:
@string    parent_tag          父节点名称,为空是根节点
@list      children            @string,  子属性的名称 

5.读取某个点位的数据

GET  /api/tags/read
Query:
@string    tag                节点的名称 
响应:
@string   name      节点名称
@bool     success   节点是否存在
@string   type      节点数据类型
@int      quality   节点质量
@int      timestamp 节点时间戳
@~        value     节点的值

6.批量读取点位数据

POST  /api/tags/read
Body:
@list     tags      @string 节点的名称 
响应:
[
   @string   name      节点名称
   @bool     success   节点是否存在
   @string   type      节点数据类型
   @int      quality   节点质量
   @int      timestamp 节点时间戳
   @~        value     节点的值
]