附件1:Server_Api.html平台服务端接口资料44
设备的集合,通常指一组具有相同功能的设备。物联网平台为每个产品颁发全局唯一的ProductKey。
产品作为设备的集合,决定了设备所具有的功能,主要字段如下:
参数
描述
名称
产品的友好显示名称
编码
即ProductKey,全局唯一
密钥
即ProductSecret,用于一型一密的认证方案
分类
比如边缘网关、大气监测设备
节点类型
分为直连设备、网关设备、网关子设备
数据格式
数据传输格式,Json
协议
设备接入网关的协议类型,ModbusRTU、ModbusTCP、OPC-UA、BLE、SRMP
连网方式
MQTT、WiFi、蜂窝Cellular(2G/3G/4G/5G)、以太网、LoRaWAN、其它
动态注册
每台设备烧录相同的产品证书,即ProductKey和ProductSecret,云端鉴权通过后下发设备证书
固定编码
UUID相同,设备编码不同,且固定编码,则认为是全新设备
认证类型
支持DTU直传
用来描述产品信息
产品下可查看该产品所有设备、进行功能定义、版本升级、以及设备统计。
产品所具有的功能,类似于其它平台的物模型。
功能定义,多属性的数据格式,决定如何解析生成属性数据。可以从标准物模型导入。
功能定义分为两层,一个产品包含若干个模块,模块可以导入,也可以自定义模块。每个模块包含多个属性、事件、服务。
请注意,网关型产品,因为不确定会添加什么设备,因此没有功能定义。而连接网关的设备,通过配置通道,来定义如何采集数据以及解析,通道仅用于自动采集。
功能定义的主要字段如下:
产品
功能所属产品
模块
功能分组,分为默认模块和自定义模块
种类
分为属性、事件、服务
功能名称
标识
功能唯一标识,比如Temperature
访问模式
只读、读写、只写
必填
可用于服务的参数校验
数据类型
可以是基础数据类型或子设备产品。基础数据类型有小数、整数、文本。选择子设备产品时,将本产品按照子设备产品去解析
长度
文本类型的最大长度
最小值
数字类型的最小值,比如-40
最大值
数字类型的最大值,比如120
步长
数值类型的最小间隔
最大间隔
数值类型的最大间隔,超过该值时被抛弃
单位
数据的单位,比如℃
单位名称
数据单位名称,比如摄氏度
调用方式
服务的调用方式,同步sync,异步async
地址
用于解析原始数据,原始数据的第几个字节
大小
用于解析原始数据,占原始数据几个字节
交换16
用于解析原始数据,字节交换,12转21,默认为false,大端字节序
交换32
用于解析原始数据,字节交换,1234转3412,默认为false,大端字节序
掩码
读取线圈时使用
缩放因子
n*scaling+constant
常量因子
功能描述
功能定义不仅描述了产品应该具有什么属性、事件、服务,还描述了使用者应该怎么去使用。对接物联网平台的客户端,可以导出产品的物模型,根据定义好的属性和相应格式上报数据,可上报的事件以及提供的服务,都按照物模型来定义。
用于数据采集类的网关,可以根据设备关联的通道,设置采集通道,以便传感器数据能正常采集并上报至平台。
边缘网关客户端自动更新,升级管理。
对每个产品下设备进行每日统计,统计维度包括以下几点:
属性
总数
截止今天的全部设备数
活跃数
7天活跃数
30天活跃数
新增数
今天创建的设备数
7天新增数
7天内创建的设备数
30天新增数
30天内创建的设备数
注册数
今天激活或重新激活的设备数
最高在线
今天在线设备最高数量
归属于某个产品下的具体设备。物联网平台为设备颁发产品内唯一的证书DeviceName。设备可以直接连接物联网平台,也可以作为子设备通过网关连接物联网平台。
设备接入平台之前,需要通过注册和认证。接入物联网平台的设备身份注册方式有两种。
设备与云端通信携带令牌,通过设备鉴权后接入平台,后续也可进行设备注销。
设备连接平台,通过鉴权后,会得到一个token令牌。此令牌用于访问平台的各个接口。设备后续的通信均需携带令牌进行认证。当令牌过期,客户端可通过心跳机制对令牌进行更新。平台会记录每个设备使用的token,以及刷新记录。
通过使用令牌,可以防止非法设备访问,有效保护通信安全。
物联网平台支持建立设备分组,分组中可包含不同产品下的设备。通过设备组来进行跨产品管理设备。
设备接入平台之后,设备在平台的状态显示为在线,建立连接后需要一个心跳机制来保持这种状态,设备需要定时发送心跳消息到平台以保持活跃。
所有下行指令由平台下发至设备,设备与平台之间有WebSocket长连接,基于消息队列实时向终端设备推送指令。每条消息均有唯一消息标id,指令响应结果也包含下行指令携带的消息id,确保响应消息与下行指令一一对应。
设备历史记录设备上线下线等操作,按年分表。该历史不仅详细记录了平台对设备的所有操作,同时还有操作详细内容,以及操作成功状态。甚至还有追踪标识,还原整个调用链。
由于传感器子设备不能直接连接平台,或者需要拓扑关系管理,这时候设备可以作为网关子设备,连入网关,由网关代理连接平台通信。业务平台给子设备发送消息时无需感知物理物理拓扑结构。
数据流程:IotClient=>IotServer=>IotData分别是数据采集/上报,数据接收/解析/存储,数据转发三个阶段。
预定义产品模板及产品功能模板,用户可以通过产品模板快速创建新的产品信息。
该功能以阿里云IOT平台的TSL为基础(参考1),并根据实际业务场景进行扩展,用户可以通过TSL快速编辑管理产品模板功能定义、产品功能定义(包括:属性、服务、事件)。
模板名称:基于当前模板生成的产品,名称会使用模板名称。
节点类型:主要分三类,分别为网关设备、子设备、直连设备,其中网关设备不能定义功能模板(物模型)。
数据格式:目前支持Json
启用:该产品是否启用以及参与数据解析。
固定编码:用户判断自动接入的设备是否被自动注册为新设备,主要用于设备的自动身份识别,配合一物一码使用。
校验:主要用于校验TSL模板与产品关联的物模型信息之间一致性,启用状态TSL模板导入过程会强制校验当前产品模板或产品所关联的功能模板/功能定义(物属性),TSL模板中不存在的功能定义将被停用;反之TSL模板导入只新增或更新TSL模板中涉及的功能模板/功能定义。
只有子设备和直连设备可以定义功能模板,网关设备不涉及数据采集及解析,所以不能定义功能模板。
其中复制功能可以快速创建类型相同名称、标识不同的物属性。(建议:物模型的管理可以通过TSL模型管理)(参考1)
注:如果产品模板开启校验功能,TSL模板导入到功能模板(物属性)中会自动停用TSL模板中没有包含的属性。
注:创建出来的产品编码会进行调整(由于产品编码全表唯一),运维人员可以根据实际部署情况进行对产品编码进行调整。
解析规则:客户端上报到服务端的数据是字节数组,解析规则采用DynamicExpresso.Core(参考2)
转换扩展参考
data.ToUInt16()
data.ToBase64()
data.ToUInt32()
data.ToUInt64()
data.ToDateTime()
data.ToBoolean()
data.ToDouble()
data.ToStr()
data.ToHex()
接口信息(参考:附件1)
Thing-上报设备属性接口
Thing-获取设备属性接口
主要是展示当前各设备在线状态
基于产品维度的日活、7日活、30日活以及日新增、7日新增、30日新增设备总数。
编辑设备类型分组字典信息。
用户可以从产品维度和设备纬度分别设置规则策略,系统会根据用户所设置的规则策略逐一校验设备属性字段是否符合预期阀值,并将达到阀值的数据以事件的方式发送到事件队列当中。由事件队列消费端对事件消息进行处理。
名称:规则名称必填
设备信息:匹配设备的规则优先级最高。
表达式:规则判断逻辑
动作:符合规则的数据需要触发的后续操作;主要分为五类,事件通知、事件告警、事件错误、服务调用、设置属性。
数据:关联动作需要生成的消息通知模板,如发出事件报警,这里可以指定消息报警模板内容。
主要对原始监测数据、报警数据、事件数据进行第三方转发,需要第三提供相应的数据接口。
数据推送具体模型取决于监测数据上传时数据模型,接口会将相应数据转换为json字符串作为三方接口入参。
用户根据实际需要指定topic并且支持基于产品、设备、事件名称、事件类型动态分发队列。
序号
占位符号
备注
1
{productCode}
产品编号
2
{deviceCode}
设备编号
3
{eventType}
事件类型
事件推送生效
4
{name}
事件名称
备主要分为原始数据、计算修正后数据、分钟统计、15分钟统计、小时统计数据几个部分。设备上报的原始数据会经过特定的数据清洗规则进行分库、分表存储到指定库表当中,以便后续业务层系统进行使用。
主要信息包括:设备编号、主题、数据原始报文。
主要记录了各个节点的上下线信息、更新信息、令牌刷新、Socket连接等等信息。
主要记录由设备端主动发出的事件消息,主要包括报警、通知、错误日志三个方面。
对设备配置影子数据进行管理维护,可以记录设备最新的完整状态信息。
通过设备心跳将当前网关设备的实时运行状态信息上报至服务端,方便运维人员对网关设备运行状态进行实时监控。该功能主要结合星尘监控系统完成对系统的全链路监控。
应用密钥管理,可调用应用层接口,读写数据
拦截产品或设备指定动作,如上线下线,回调外方接口
重要位置点的回调函数设置,触发某个动作时,回调业务层接口,可能需要令牌验证
NewLife.IoT
Iot.Client项目主要用于主设备对子设备的数据采集工作,支持Windows,Linux64,LinuxArm等系统运行,通过ModBus等协议主设备下挂子设备通道数据采集回来并上传至IotWeb平台。
使用配置:
举例说明:当填写已创建主设备就直接填写设备的DeviceCode和DeviceSecret即可,系统会自动完成鉴权上线建立通讯,然后拉取设备对应产品属性及通道,进行数据采集及上传;如果设备未创建可以填写对应产品的ProductKey和ProductSecret,系统会自动创建产品的主设备,然后下发配置证书,修改配置文件。暂时为了系统安全,默认主设备启用状态为未启用,需要后台开启。
特别说明:为了系统通讯安全,当A设备初次鉴权成功,A设备的对应的唯一标识会进行IotClient的捆绑,此时即时别的设备拿到相同文件也无法通过鉴权。反之如果需要更换解绑,请清空唯一标识。
设备连入系统需要进行安全认证,通过IotClient的DeviceCode和DeviceSecret及唯一标识进行鉴权,通过后可进行配置属性通道信息的下载进入采集工作和数据上传工作。
检查设备可用更新信息,发现更新,执行更新,实现自动更新下发的工作。
自动更新流程,下载Zip更新包,解Zip压缩包,备份当前程序,清理Exe、Dll等文件,覆盖更新文件,升级后附加命令,验证更新,成功清理备份文件,失败异常上报,停止更新。
属性集合,事件队列
子设备拉取,设备通道创建及维护
目前支持ModbusRTU、ModbusTCP协议
如何根据协议接口,实现自定义协议
主要对第三方应用系统提供一些基础的数据查询接口服务,同时集成了一些常用数据统计数据查询接口。数据统计依赖于蚂蚁调度服务平台。
LTTB、LTOB、平均值采样、最大值采样、最小值采样
线性插值、双线性插值、拉格朗日插值
蚂蚁调度清洗数据
实时推送设备数据、设备事件、设备上下线
部署要点:
星尘主要用于应用性能监控以及节点监控,还有可能使用配置中心。