IoT边缘网关操作手册

目录

一、 简介 1

服务端环境 1

客户端环境 1

二、 系统基本操作 2

1. 系统登录 2

2. 退出登录 7

3. 修改密码 7

4. 时间选择 8

5. 关键字搜索 9

6. 混合搜索 9

7. 导出 9

8. 批量删除 10

注意:所有的删除操作均为物理删除,不可逆!!! 10

9. 双击编辑 11

三、 网关配置 11

1. 产品定义 11

2. 物模型(设备属性、产品功能定义) 14

3. 设备管理 17

4. 协议驱动 20

5. 数据推送 23

四、 系统管理 24


1 简介

应用于对接各类数据采集设备、第三方网关,支持常用IOT对接协议。

服务端环境

部署环境:支持 Windows、Linux

客户端环境

操作系统:win10及以上版本、ios、android等

分辨率:推荐1366*768 及以上

浏览器:建议使用chrome浏览器

下载地址:https://www.google.cn/intl/zh-CN/chrome/

硬件配置:无特殊要求

2 系统基本操作

2.1 系统登录

浏览器输入服务地址https://www.xxx.com (示例:localhost:5000)(图1)。

帐号密码(Password)模式:在输入的帐号不匹配的时候会提示用户名或密码不正确!(图2)

单点登录(SingleSign-On)模式:系统本身自带一套帐号密码体系,同时支持多种常见三方认证(图4);点击相关认证图标(图3)进入第三方认证界面(图5)完成认证(图6)。

登录系统后进入系统主界面(图7)(支持自定义界面),可以概况的了解到服务器部署情况以及程序引用情况

图1

图2

图3

图4

图5

图6

图7

2.2 退出登录

点击系统右边上角图标(图8),下拉菜单中注销菜单(图9)。

图8

图9

2.3 修改密码

  • 修改密码:右上角图标 - 个人信息 - 修改密码

图13

图14

2.4 时间选择

列表页面搜索时会经常用到时间搜索条件,默认情况下系统没有指定搜索时间,直接按照主键id的倒序搜索最近的记录。

  • 时间搜索控件一般分为两个输入框体,前者为开始时间,后者为结束时间。
  • 点击时间输入框体打开日期选择控件(图15),默认是按照天的最小维度选择。点击(五月2022位置)打开(图16)年月选择界面选择年月,选择月份返回(图15)选择日期。

图15

图16

2.5 关键字搜索

关键字框架中输入需要搜索的关键字(图17),点击查询按钮

图17

2.6 混合搜索

列表页面支持混合条件搜索

图18

2.7 导出

列表页 - 高级 - 选择需要导出的数据类型(图19),默认支持Excel、Csv、Xml、Json类型数据。

图19

2.8 批量删除

  • 删除选中

首先在列表页面中勾选需要删除的数据(图21),点击高级 - 删除选中 功能,可以执行批量删除。

  • 删除全部(慎用

相当于对当前表执行 Truncate 操作,直接清空当前表全部数据。

注意:所有的删除操作均为物理删除,不可逆!!!

图20

图21

2.9 双击编辑

列表页记录均支持双击编辑功能。

3 网关配置

3.1 产品定义

点击 网关配置 - 产品定义菜单(图22),进入产品定义列表页面(图23)。

图22

图23

新增/编辑产品信息页面(图25)。点击 列表页左上角新增按钮、 列表记录 - 编辑或双击记录行可以进入信息编辑表单页面(图24)。

图24

图25

3.1.1 主要字段

  • 名称:产品名称
  • 编码:产品的唯一编码
  • 协议:标识当前产品使用的那种硬件对接协议,数据来源于“协议驱动”配置中的信息。
  • 校验:启用状态表示TSL模型编辑物模型时完全保证产品物属性和TSL完全一致,产品原先不在TSL模型文件中的属性会被自动停用。停用状态表示TSL模型编辑物模型时只保证产品中TSL模型中包含的属性保持一致,其他的属性不做校验并保持原状。

3.1.2 关联信息

  • 设备数量:当前产品下对接的全部设备总量,点击数值可以进行详细设备列表信息页面(图26)。
  • 功能定义:定义的产品的物模型信息列表(图27)。
  • TSL:采集阿里TSL为基础,进行一定扩展支持一些系统特殊功能
  • 功能发布:物模型属性发生变更后需要重新发布物模型,设备采集端会根据发布后的物模型配置对数据进行解析(图28)。
  • 规则策略:自定义数据解析处理逻辑,一般用于对采集数据的高级解析处理(如:阀值预警事件、数据的自定义解析规则等)。
  • 日志:产品信息操作审计日志。

图26

图27

图28

3.2 物模型(设备属性、产品功能定义)

用户首先给产品定义好物模型,后续在创建产品关联设备的时候服务会自动将设备所属产品的物模型中的属性、服务自动转换为对应的设备属性和设备服务两类数据。

如果用户是先用户产品绑定的设备后创建的物模型或是后期物模型的设备发生变化,针对产品级别的可以在产品列表页使用“功能发布”功能,将变更的属性批量发布到下辖的所有设备;如果只是针对单个设备的属性/服务变化,可以在设备列表页进行单独的属性、服务发布。

点击 网关配置 - 产品定义菜单(图22),进入产品定义列表页面(图23),点击物模型(图28-1)点击新增或编辑按钮进入物模型编辑页面(图28-2)。

图28-1

图28-2

3.2.1 主要字段

  • 产品:物模型所属产品编号
  • 设备:所属设备编号
  • 种类:分为属性、事件、服务三种类型
  • 名称:属性/事件/服务名称
  • 标识:属性唯一标识
  • 启用:该属性/服务/事件是否生效
  • 访问模式:针对属性采集设备的数据读写限制,决定了连接设备时使用的数据读写模式。
  • 类型:属性字段类型如:int32 、int16、double等等
  • 长度:属性字段数据在读取时截取的字节长度
  • 步长:之数据解析完成后的数据精度,如:数据20.11 步长0.1那数据最终存储为20.1;步长0.01那数据最终存储20.11。
  • 点位地址:属性字段数据在读取的数据流位置
  • 解析规则:采用DynamicExpresso.Core(nuget 参考资料地址:https://github.com/dynamicexpresso/DynamicExpresso)模板引擎,入参为属性数据Data;如果想要将数据转为整型 Data.ToInt32();
  • 交换16:属性字节大小端解析顺序,如:12转21,默认false大端
  • 交换32:属性字节大小端解析顺序,如:1234转3412,默认false大端
  • 缩放因子:不能是0,默认1,n*scaling+constant
  • 常量因子:默认0,n*scaling+constan
  • 事件类型:分为info/alert/error三类
  • 调用方式:服务的调用方式,同步sync/异步async
  • 调用方法:分别为EventPropertyMethod.Post、ServicePropertyMethod.Get、ServicePropertyMethod.Set
  • 入参:服务数据/事件数据生效,定义触发服务或事件时候传入的默认参数
  • 出参:事件数据生效,定义触发该事件时发送的通知信息模板

3.3 设备管理

点击 网关配置 - 产品定义菜单(图29),进入产品定义列表页面(图30)。


图29

图30

新增/编辑设备管理页面(图31)。点击列表页左上角新增按钮、 设备管理列表 - 编辑或双击记录行可以进入信息编辑表单页面(图32)。

图31

图32

3.3.1 主要字段

  • 名称:设备名称
  • 编码:设备在系统中的唯一标识编码
  • 产品:隶属产品信息,影响想到设备驱动、物模型、数据自定义解析等信息的初始化。
  • 启用:标识当前设备是否生效
  • 数据上报模式:主要分为变更上报、总是上报、绝不上报三种模式,可以根据业务对采集数据的需求自行判断;变更上报顾名思义设备在对比采集到的前后数据,只有当数据发生变化才想服务端进行数据上报;总是上报即设备按照固定的周期采集到的数据全部上报服务端;绝不上报即设备只是采集数据但不向服务端进行数据上报。
  • 属性上报间隔:设置设备物模型属性数据上报的间隔周期。无论属性数据是否发生变化只要达到上报周期,程序会自动将当前设备采集的数据进行上报。注:-1表示不进行属性上报,默认每隔60秒上报一次。
  • 采集间隔:设备对数据的采集频率,默认时间1秒间隔。
  • 驱动参数:支持xml/json格式,用户可以将一些采集终端需要用到的驱动配置信息通过该字段存储下发。

3.3.2 关联功能

  • 设备历史:设备上/下线、状态变更、设备的属性上报信息和数据上报信息的操作/变更审核日志。
  • 设备属性:继承自创建设备时候选择的产品信息所关联的产品功能定义(物模型),后期产品功能定义发生变化,需要对新增/修改的功能定义进行发布操作
  • 设备数据:记录设备采集到明细数据,进入设备列表(图33)默认是不展示相关数据,需要手工选择原始数据间隔,并进行二次查询。

图33

  • 设备事件:主要记录设备事件信息,事件分为三种类型事件 普通事件、预警事件、错误事件。
  • 设备服务:为设备指定服务属性,一般用于网关控制子设备,向客户端发送新的参数配置。
  • 设备规则:功能同产品的“设备规则”功能,但是设备定义的规则优先级高于产品定义的规则。

3.4 协议驱动

用户可以根据实际接入设备的情况有选择的加载需要的设备驱动,除了使用NewLife.IOT的开源驱动协议,同时用户可以根据NewLife.IOT 的IDriver接口自行扩展自定义驱动协议以实现设备数据的接入。

点击 网关配置 - 产品定义菜单(图34),进入产品定义列表页面(图35)。

图34

图35

新增/编辑协议驱动页面(图36)。点击列表页左上角新增按钮、 协议驱动列表 - 编辑或双击记录行可以进入信息编辑表单页面(图37)。

图36

图37

3.4.1 主要字段

  • 名称:协议名称
  • 类型:插件语言类型(支持:.net、javascript、Lua)
  • 默认参数:插件的默认启动参数,支持数据格式为xml(图37)

其他字段:类名、文件、版本等,程序在上传插件后自动完成填充。注:插件上传需要注意插件文件包需要使用zip压缩格式。

3.5 数据推送

图38

图39

3.5.1 主要字段

  • 名称:推送配置名称
  • 推送方式:推送方式目前支持HTTP/MQTT两种方案
  • 重试次数:推送失败重试次数,超过次数数据会自动被丢弃
  • 服务器地址:MQTT 服务器地址,HTTP 接口地址
  • 帐号:MQTT 模式生效,mqtt 认证帐号
  • 密码:MQTT 模式生效,mqtt 认证密码
  • 数据类型:类型分为 采集数据事件数据 两种类型
  • 事件类型:针对事件数据主要分为 消息、预警、错误 三种类型
  • 消息主题:针对MQTT的topic 配置,用户可以自定义topic内容,目前支持根据以下四个占位符定义
    • {productCode} 产品编号
    • {deviceCode} 设备编号
    • {name} 属性名称
    • {eventType} 事件类型 info、error、alert(事件数据生效)
  • 启用状态:配置是否生效

4 系统管理

相关资料可以参考魔方项目介绍:https://newlifex.com/cube

作者:郗 发布:2022-05-18 15:57:08 浏览:1,073)