IoT服务
  1. Opcua
IoT服务
  • Opcua
    • 初始化OPC-UA Server信息，如IP、端口、标识等信息
      POST
    • 新增OPC-UA Server信息，如IP、端口、标识等信息
      POST
    • 更新OPC-UA Server信息，如IP、端口、标识等信息
      POST
    • 删除OPC-UA Server信息
      POST
    • 获取OPC-UA Server信息，如IP、端口、标识等信息
      POST
    • 添加基于opc-ua的发布订阅监测项
      POST
    • 将订阅监测信息更新到缓存中，不存在则添加
      POST
    • 删除opc-ua的发布订阅监测项，可先通过query-pub-sub查询相应的监测项后再删除
      POST
    • 修改opc-ua的发布订阅监测项，可先通过/api/v1/opc-ua/query-pub-sub查询相应的监测项后再修改
      POST
    • 查询opc-ua的发布订阅监测项
      POST
    • 添加指标对应的opc-ua监测点
      POST
    • 修改指标对应的opc-ua监测点，可先通过/api/v1/opc-ua/query-communication查询相应的监测点后再修改
      POST
    • 删除指标对应的opc-ua监测点，可先通过/api/v1/opc-ua/query-communication查询相应的监测点后再修改
      POST
    • 查询指标对应的opc-ua监测点，若参数为空，则查询该租户下所有的监测点信息
      POST
    • 查询指标对应的opc-ua监测点，用于项目配置平台显示
      POST
    • 初始化指标对应的opc-ua监测点，根据输入的监测点数据，删除系统中多余的监测点，如果输入的监测点已存在则更新，不存在则新增。
      POST
    • 初始化指标对应的opc-ua监测点,如果存在则全部删除后再添加
      POST
    • 导出opc-ua配置信息，包含设备、指标、OPC节点等配置，将配置信息转换成excel并下载
      POST
    • 导入opcua配置，将配置项按照模板文件格式整理后导入到系统中
      POST
    • 将OpcUaPubSub中所有节点添加订阅
      POST
    • 添加订阅，连接opcua服务地址并添加节点订阅，配置文件中的PublishingInterval可设置订阅频率，不设置则为0
      POST
    • 读取节点数据，连接opcua服务地址读取指定的节点数据
      POST
    • 往节点写入数据，连接opcua服务地址并将数据写入到节点中，可通过read-node查看是否写入成功
      POST
    • 将iot服务的心跳写入到opcua服务端，Nodevalue可为空，默认值为当前时刻的秒数
      POST
    • 往节点写入数据-批量下发
      POST
    • 同步opc server遥测数据，将同一租户下同步策略名称一致的批量同步到系统中
      POST
    • 查询opcua服务心跳是否正常，判断结果存储在缓存中。
      POST
    • 定时监测opcua服务心跳数据是否正常并将判断结果保存到缓存中，结果通过接口/api/v1/opc-ua/opc-heart-beat接口查看
      POST
  • Telemetry
    • 查询设备指标在指定时间段内的时间序列数据，可根据排序方式OrderBy按时间排序
    • 查询设备指标在指定时间段内的时间序列数据,按时间倒序排序
    • 批量查询多个设备指标的时间序列数据
    • 根据设备编码和指标名获取最新实测数据
    • 根据设备编码和指标名获取离指定时间点最近的实测数据
    • 以结构化的数据格式通过消息队列批量保存或更新实测数据
  • Asset
    • 获取父资产的下的所有子资产信息
    • 获取子资产信息
    • 获取资产指标属性
    • 获取资产指标属性的最新时刻值
    • 查询资产指标属性在指定时间段内的时间序列数据，可根据排序方式OrderBy按时间排序
    • 分页获取资产信息列表，包含子设备和子资产
    • 添加一条资产信息
    • 批量添加资产信息，每个资产的Attribute属性不需要一致
    • 批量添加资产信息，每个资产的Attribute属性的key必须保持一致
    • 更新一条资产信息
    • 根据资产ID获取资产详细信息
    • 批量删除资产
    • 构建资产、设备之间的从属关系
    • 批量构建资产、设备之间的从属关系
    • 删除资产、设备之间的从属关系
  • Auth
    • 启用租户的IoT功能【内部接口】
  • ControlCmd
    • 获取控制指令配置列表【内部使用】
    • 新增控制指令配置【内部使用】
    • 更新控制指令配置【内部使用】
    • 删除控制指令配置【内部使用】
    • 获取控制指令下达记录【内部使用】
    • 获取控制指令后馈记录【内部使用】
    • 下达控制指令【内部使用】
  • Data
    • 清洗数据查询
    • 获取清洗数据
    • 查询清洗数据
    • 更新清洗数据信息 注：升级后改为调用OnlineProcessedDatas/Save接口
    • 添加清洗数据信息 Add online processed data
    • 保存清洗数据
    • 修改最新的Tag
    • 更新设备的数据清洗标签
    • 添加或更新清洗数据信息-目前仅提供给清洗算法使用，升级后改为调用Save接口
    • 修改清洗数据-目前仅提供给清洗算法使用，升级后改为调用Save接口
    • 仿真在线数据
    • 仿真在线数据
    • [内部接口]保存实测数据
    • [内部接口]保存实测数据
    • [内部接口]从Redis中获取最新的实测数据
    • [内部接口]获取reids中存储的opc相关表信息
    • [内部接口]表名OpcUaPubSubNotify、OpcUaPubSub、OpcUaCommunication添加redis
    • [内部接口]保存清洗数据到iot 注：此接口为升级后的保存清洗数据接口
    • 缓存清洗数据和源数据
  • Device
    • 根据设备ID查询设备指标信息
    • 分页查询指定设备类型的不包含指标信息的设备信息列表并排序
    • 分页查询指定设备类型和属性的设备信息列表并排序
    • 分页查询设备信息列表
    • 根据设备ID查询设备详情
    • 根据设备IDs批量查询设备详情(多线程)
    • 查询指定设备的指定属性
    • 增加一个设备
    • 批量添加设备，每个设备的Attribute属性的key不需要保持一致，返回新增的设备id和名称
    • 批量导入设备，每个设备的Attribute属性的key必须保持一致，返回错误信息列表，若没有错误则返回null
    • 更新一个设备信息
    • 根据设备ID列表批量删除设备
    • 添加或者更新设备自定义属性
    • 批量添加或更新设备的属性值
  • DeviceMaintenance
    • 增加设备维护记录
    • 根据维护记录Id删除设备维护记录
    • 根据设备Id或者资产Id，删除其对应的所有维护记录
    • 修改设备维护信息
    • 根据设备Id、资产Id来查询最新的维修保养信息
    • 查询一批设备/资产的指定时间范围内的维保信息（如果传的时间为空则查询所有历史的）
  • HistoricalDataSearch
    • 历史数据查询
    • 历史数据查询，基于分布式对象数据库查询模拟数据
    • 查询模拟结果或实测数据的最新数据
    • 历史数据搜索记录查询
    • 历史数据搜索记录
    • 保存历史数据搜索记录
    • 另存历史数据搜索记录
    • 删除历史数据搜索记录
    • 历史数据excel下载
  • Integration
    • 批量导入资产设备指标excel文件,用于初始化指定模板方案的资产设备指标等系统配置信息，需提前根据实际模板模型将表格补充完整
    • 导出资产设备指标excel文件
    • 获取模板方案模型的输入输出点位映射关系
    • 通过设备、指标、检索实测指标与模型输出点位映射关系以及实测指标与模型边界点位映射关系
    • 保存模型输出点位映射关系【内部接口】
    • 保存模型输入点位映射关系【内部接口】
    • 删除输入点位映射关系
  • IotGroup
    • 增加分组配置【内部接口】
    • 修改分组配置【内部接口】
    • 删除分组配置，包括下面的所有子孙分组和关联信息【内部接口】
    • 根据分组id获取分组配置，包括所有子孙分组【内部接口】
    • 获取根分组配置【内部接口】
    • 增加分组和资产设备关联信息【内部接口】
    • 批量增加分组和资产设备关联信息【内部接口】
    • 获取分组和资产设备关联信息【内部接口】
    • 删除分组和资产设备关联信息【内部接口】
    • 删除租户下所有分组和资产设备关联信息【内部接口】
    • 根据分组id获取所有子孙分组配置及其关联的iot实体信息【内部接口】
    • 获取所有的设备分组与设备的关系【内部接口】
  • Mqtt
    • 根据数据Id删除MQTT的配置信息
    • 导入MQTT配置
    • 获取MQTT配置
  • NetRequest
    • 获取多个设备指标详情
    • 获取租户下的所有的指标数据
    • 批量增加设备指标信息 batch add device indicators
    • 通过指标编码列表（indicator）批量获取指标信息 Get indicator by code
    • 初始化设备指标信息，先删除旧的，重新批量新增 init device indicators，delete old data，add new data
    • 根据模型点位id获取模型点位的详细信息
    • 根据TemplateId列表删除资产/设备与模型点位之间的映射关系 Delete mapping relation between asset/device and model point by TemplateIds
    • 添加资产/设备与模型点位之间的映射关系 Add mapping relation between asset/device and model point
    • /api/app/net-request/model-boundary-config-list/{templateId}
    • /api/app/net-request/model-boundary-config
    • 获取指标点位与模型数据映射数据
    • 根据Id获取模型点位信息
    • 添加模型点位数据类型与设备指标之间的映射关系 Add mapping relation between model point data type and device indicator
    • 更新模型点位数据类型与设备指标之间的映射关系 Update mapping relations between model point data type and device indicator
    • 添加模型点位数据类型与设备指标之间的映射关系 Add mapping relation between model point data type and device indicator
  • TelemetryMockData
    • 上传mock数据的excel表
    • 将mock数据作为遥感数据写入设备，一次往当前时刻的未来时间Mock所有的模板数据，定时频率为Mock的时间长度
    • 将mock数据作为遥感数据写入设备，一次只写入当前时刻的数据
    • 将mock数据作为实测数据写入设备，一次只写入当前时刻的数据，匹配小时和分钟
  1. Opcua

添加指标对应的opc-ua监测点

POST
/api/v1/opc-ua/add-communication
Opcua
关键词：OPCUA、监测点、添加
使用场景：在定时同步OPC数据时，需要获取监测点信息中的节点名称、时间模式、时间步长分批次同步数据入库，在接入OPC数据前需提前配置opc监测点；
配置信息包含中IndicatorId/Node保证唯一，IndicatorId可通过查询模型映射服务获取
输入：opc-ua监测点列表
输出：是否成功

请求参数

Authorization
在 Header 添加参数
Authorization
，其值为在 Bearer 之后拼接 Token
示例：
Authorization: Bearer ********************
Body 参数application/json
array of:
indicatorId
string <uuid>
可选
设备指标Id，对应着设备-指标，可通过查询映射服务获取
nodeName
string  | null 
可选
节点名称，如:主线静压式液位
node
string  | null 
可选
节点检测项，如:ns=2;s=Z3\Test\TestWL.PV
unit
string  | null 
单位,如:m³/s
可选
dataType
enum<integer> <int32>
可选
0-BoolValue
1-DateTimeValue
2-DblValue
3-LongValue
4-StrValue
5-FloatValue
6-UInt32Value
7-UInt16Value
8-Int32Value
9-Int16Value
枚举值:
0123456789
decimalPlaces
integer <int32>
小数点数,默认为2
可选
timeProcessingMode
enum<integer> <int32> | enum<null> 
可选
时间处理模式：秒、分、小时、默认原始值,不做处理
枚举值:
0123
isOpenSync
boolean 
可选
是否启用同步，同步则根据时间步长定时调用同步接口，默认不同步
period
integer <int32> | null 
可选
时间步长，IsOpenSync为true，则需要设置时间步长
opcFlag
string  | null 
可选
标识,OpcUaConfig表的OpcFlag
isRealData
boolean 
可选
是否是实时数据，若为实时数据，则该节点自动添加订阅
subKey
string  | null 
可选
subkey为设备名称|检测指标|tenantid,如：测试水厂出厂|ceshi_1_shuichang_flow|3a0d4cc8-9a68-1658-ae5e-e6c969eb66ea
示例
[
    {
        "indicatorId": "234d31af-d293-e107-54a4-f2725c9d969e",
        "nodeName": "主线流量",
        "node": "ns=2;s=Z3\\Test\\TestFlow.PV",
        "unit": "m³/s",
        "dataType": 2,
        "decimalPlaces": 2,
        "timeProcessingMode": 1,
        "isOpenSync": true,
        "period": 5,
        "opcFlag": "OPCTest",
        "isRealData": true,
        "subKey": "测试水厂出厂|ceshi_1_shuichang_flow|3a0d4cc8-9a68-1658-ae5e-e6c969eb66ea"
    }   
]

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://online-products.dhichina.cn/gateway/iot-service/api/v1/opc-ua/add-communication' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "indicatorId": "234d31af-d293-e107-54a4-f2725c9d969e",
        "nodeName": "主线流量",
        "node": "ns=2;s=Z3\\Test\\TestFlow.PV",
        "unit": "m³/s",
        "dataType": 2,
        "decimalPlaces": 2,
        "timeProcessingMode": 1,
        "isOpenSync": true,
        "period": 5,
        "opcFlag": "OPCTest",
        "isRealData": true,
        "subKey": "测试水厂出厂|ceshi_1_shuichang_flow|3a0d4cc8-9a68-1658-ae5e-e6c969eb66ea"
    }   
]'

返回响应

🟢200成功
text/plain
Success
Body
boolean 
可选
示例
true
上一页
查询opc-ua的发布订阅监测项
下一页
修改指标对应的opc-ua监测点，可先通过/api/v1/opc-ua/query-communication查询相应的监测点后再修改
Built with