北向应用
# 基础功能使用指南
北向应用包含四大模块：终端管理、平台管理、应用接入和资源概览。
# 视频教程
# 功能清单
| 序号 | 功能清单 | 功能描述 |
|---|---|---|
| 1 | 终端管理 | 对接入平台的终端设备进行精细化分类与标识管理。 |
| 2 | 终端标签管理 | 为终端设备打上标签，实现设备的灵活分组与筛选。 |
| 3 | 终端信息管理 | 提供终端设备的详细信息、状态监控与生命周期管理功能。 |
| 4 | 终端类型管理 | 对终端设备进行分类管理，定义不同的设备类型。 |
| 5 | 平台应用管理 | 对平台核心配置、终端设备、数据模型及产品信息进行统一管理。 |
| 6 | 平台管理 | 负责平台自身的系统配置、服务状态监控与维护。 |
| 7 | 平台终端 | 对接入平台的所有终端设备进行集中监控与生命周期管理。 |
| 8 | 物模型配置 | 提供物模型的创建、定义与管理功能，用于数字化描述设备的功能。 |
| 9 | 产品信息管理 | 负责产品型号的创建与管理，定义设备类型的元数据与通信规范。 |
| 10 | 应用接入管理 | 对接入平台的第三方应用进行统一的身份认证、授权与资源管理。 |
| 11 | 应用接口管理 | 对平台向北向应用提供的API接口进行管理和发布。 |
| 12 | 应用终端授权 | 对接入应用可访问的终端设备范围进行授权管理。 |
| 13 | 应用接口授权 | 对接入应用可调用的平台API接口权限进行细粒度控制。 |
| 14 | 转发规则引擎 | 提供灵活的数据转发规则配置，支持将设备数据转发至指定的第三方应用。 |
| 15 | 消息订阅管理 | 允许第三方应用订阅其关心的设备消息或平台事件。 |
| 16 | 应用资源概览 | 为管理员提供所有接入应用的状态、资源使用情况及告警信息的集中可视化视图。 |
# 终端管理
首先介绍终端管理，终端管理包含终端类型管理和终端信息管理两大功能。
# 终端标签管理
对终端信息进行归类，用户如果需要对终端信息划分多个类型进行分组，可以在这里维护终端标签。终端类型也支持配置产品的终端标签，当配置产品的终端标签后，后续同步的该产品的终端以及已同步的该产品的终端将默认配置该终端标签。该功能主要维护终端标签字典信息，在北向功能中，实施人员必须维护好终端标签数据。
# 终端信息管理
终端信息管理，主要功能有终端数据同步功能（程序自动同步，无需人员操作），该功能主要实现：将设备中的数据自动映射到终端信息中，终端编号默认为设备号，终端名称默认为设备名称，所属产品自动为设备所属产品，其余信息无法同步的，需要实施人员对数据进行修改。该管理界面还提供了导出和导入功能。导出：当操作完同步之后，终端信息的安装信息是没有的，这时候需要配置，如何批量配置，使用导出功能，对空白字段的数据进行修改。导入：当用户维护好前面导出的数据之后，再将数据导入，这样就实现了数据批量修改。也可以对终端信息进行一一维护。
重点属性说明：
终端编号：默认为设备号，后续可根据业务需求修改，不能重复。作为终端的唯一标识。
终端ID：默认生成规则为 设备地址_设备号。
按条件搜索终端信息
导出终端信息
导入设备/终端信息
将设备/终端信息填写完整点击导入
选择导入的表格
修改终端信息
用户根据终端实际情况，将终端所属类型及终端基本属性维护好，这样才能使基本数据完整，后面的业务流程需要这些基础信息。
删除终端信息
# 终端类型管理
可根据业务需求新增终端类型数据，可以在终端信息管理中配置终端的终端类型
# 平台应用管理
# 平台管理
核心功能是对平台自身及其扩展能力的配置与管理。它专注于对接入平台的第三方系统或服务（以下简称“子平台”）进行集中式的配置、注册和生命周期管理，确保平台具备灵活的扩展性和强大的集成能力。
操作步骤
登录系统，在菜单中点击 “平台管理”。
点击页面右上角 新增按钮。
填写基础信息：
- 在弹出的“新增平台配置”表单中，填写以下信息：
- 平台名称： 为该子平台起一个易于识别的名称（例如：“第三方气象数据平台”）。
- 动态库名称： 指定实现与该子平台通信的动态库文件（例如：
lib_weather_api.STD.dll）。 - 动态库版本： 填写所选动态库的版本号，用于兼容性管理。
- 启用状态： 选择是否立即启用该平台配置。
- 调试模式： 若需详细日志用于排查问题，可开启此选项。
- 自动注册： 设置是否在平台启动时自动向该子平台注册并建立连接。
- 在弹出的“新增平台配置”表单中，填写以下信息：
配置连接参数：
- 在 “平台连接参数” 区域，填写与该子平台建立数据连接所需的详细信息，通常包括URL地址、端口号、用户名、密码、通信协议等。
配置注册参数：
- 在 “平台终端注册参数” 区域，填写向该子平台注册当前系统为合法终端所需的参数，这些参数用于身份认证和管理权限的申请。
保存配置：
- 检查所有信息无误后，点击表单底部的 “保存” 按钮。
# 平台终端
负责对所有接入平台的终端设备进行统一的生命周期管理。它提供了设备的注册、认证、监控、远程配置和维护等功能，是实现万物互联的基础。主要面向设备管理员和运维工程师。
操作步骤
- 进入模块： 在主菜单中，点击 平台终端。
- 注册终端：
- 平台若为未自动注册终端则需要手动注册
- 终端下线：
- 终端设备查看、编辑、删除操作：
- 点击列表中每个设备操作下面的按钮，可以对终端设备进行操作
查看
- 点击列表中每个设备操作下面的按钮，可以对终端设备进行操作
查看
编辑 
删除 
# 物模型配置
它通过属性（Properties）、服务（Services）、事件（Events） 来数字化地描述一个设备是什么、能做什么、能上报什么。
操作步骤
- 创建物模型
- 进入 物模型配置管理 界面。
- 点击右上角的 “创建产品” 按钮。
- 在弹出的表单中，填写产品名称（如：“智能温控器”）、产品型号、所属行业、设备类型等基本信息。
- 点击 “确认” 完成创建。
- 添加属性：
- 在“属性信息”标签页下，点击 “添加属性”。
- 定义属性：
名称：当前温度，标识符：temperature，数据类型：浮点型（float），单位：°C，读写类型：只读。 - 点击 “确认” 保存。
- 添加命令：
- 切换到“命令信息”标签页，点击 “添加服务”。
- 定义服务：
名称：设置温度，标识符：set_temperature。 - 在此服务下，添加一个输入参数：
名称：目标温度，标识符：target_temp，数据类型：整型（int）。 - 点击 “确认” 保存。
# 产品信息管理
物联网平台中设备建模的核心起点，用于创建并定义一款设备产品的元数据。通过创建产品，您可以为同一类型的设备设定统一的身份标识、通信规范、数据模型与功能定义，是实现设备规模化、标准化接入与管理的基础。
操作步骤
【基础信息】
*名称(必填)：产品的自定义名称，用于在平台内标识和区分不同产品。例如：智能温控器T1。产品类型(必选)：选择产品的大类，通常与设备能力相关。例如：设备、网关、子设备等。厂商ID：该产品所属厂商的唯一标识符。例如：MANU_202401。厂商名称：该产品所属厂商的可读名称。例如：敢为科技有限公司。产品型号：产品的具体型号，通常由厂商定义。例如：GW-T100。
【通信与模型配置】
协议类型(必选)：设备与平台通信所使用的网络应用层协议。例如：MQTT 3.1.1、CoAP、HTTP、Modbus等。关联物模型(必选)：为该产品选择或创建一个物模型模板，定义设备的功能属性、服务和事件。例如：从下拉菜单选择已创建的智能空调物模型。
【高级配置】
资源空间(可选)：用于资源隔离或多租户管理，指定该产品所属的资源组或空间。通常保持默认或由管理员分配。协议插件(可选)：如果使用自定义协议，需指定实现协议解析的插件。例如：从下拉菜单选择BCDataSimu.STD.dll。绑定产品(必选)：例如：从下拉菜单选择智能家居网关。设备类型：设备的具体品类，用于更精细的分类。例如：空调、灯、传感器。设备类型编码：对应设备类型的唯一编码，可用于与外部系统对接。例如：AC001。
# 应用接入管理
应用接入管理，常见的应用有，线下ROMA，线上ROMA，其他厂商应用。对接主要围绕IoT数据接入进行展开，如应用调用IoT北向接口，IoT实时数据推送给应用。
# 应用接口管理
管理北向应用可以访问的北向接口，可以新增接口、修改、删除接口。在应用调用北向接口是，首先判断接口是否在该范围中，如果不在该范围，应用是无法调用成功的。
接口转发功能
在IoT项目中开发协议插件或扩展插件时，碰到需要暴露WebApi接口给第三方使用的场景时，常见的做法是在插件中暴露一个端口，将接口暴露出来给第三方进行调用。为了统一对外端口及鉴权安全要求，应用接口管理中可以接管该类业务需求，使用转发功能将地址进行转发。
例如：协议插件中暴露了一个接口，用于查询停车信息：
http://127.0.0.1:8008/api/protocol/event/GetParkingInfoList
在北向接口管理中配置如下：
说明：
是否转发： 选择是，表示启用转发功能。
转发地址： 填入插件中暴露的接口，此处应填入http://127.0.0.1:8008/api/protocol/event/GetParkingInfoList
请求地址： 使用转发功能时，请求地址的前缀统一使用 /customapi/，因此请求地址处应填入 /customapi/api/protocol/event/GetParkingInfoList。
配置完成后就可以使用IoTCenter的https端口进行访问了。例如：https://127.0.0.1:44380/customapi/api/protocol/event/GetParkingInfoList。
查看接口信息
修改接口
可修改启用停用接口、接口名称、请求地址、接口分组、请求方式
删除接口
# 应用接入管理
维护北向应用信息，在需要与北向应用进行对接时，在应用接入功能中添加对应应用的信息，该信息中主要包含：应用名称，应用Key，应用秘钥，是否启用等信息。在添加应用时尤其要注意应用key，应用信息创建后无法查看，只能进行修改时查看，因此要妥善保管，在上层应用没有提出需求时不要去修改。
新增应用
点击新增填写应用名称点击保存
默认配置:该功能实现对应于自动赋予所有终端，自动赋予所有北向通用接口，用于快速配置应用相关数据
查看应用
修改应用
重置密钥：重置应用密码（应用授权），应用状态：启用、停用
调试模式：是、否（打印INFO日志）。
删除应用
可以删除应用信息，删除的同时，应用无法调用北向接口，北向转发数据也会立即停止。
应用日志下载
可以下载各个应用产生的日志信息，在应用新增或修改界面，可以配置应用的调试状态，如果选择调试模式，会将Info级别的日志写入日志文件中。否则只记录Warning级别的日志，在与应用联调时，可以将调试模式开启，等待接入完成后，关闭调试模式。
# 应用终端授权
详情
应用创建后，用户可以对应用授权终端，可以按终端类型进行全选或者自定义选择。只有应用授权后的终端，应用才可看和可控可进行批量操作。
# 应用接口授权
详情
北向应用在调用接口时，如果某个接口已授权给该应用了，那么应用调用后能正常返回成功，否则会出现“该接口未授权”的提示。
访问安全组:有两种配置格式，格式1："192.168.0.0/24","fe80::/10"；格式2："169.258.0.0-169.258.0.255"，可以填某个IP或者IP段。如果填写了该IP，那么只有该IP才能访问北向接口，如果不填写，后端会以警告的日志记录调用者的IP，提示用户配置改IP。
该新增为接口授权新增，先从北向接口库中选择需要授权给应用的接口。选择后会在列表中生成新的记录，如果已经存在不会进行新增。在列表中产生的新纪录并没有保存到数据中
接口访问限制，用户可以选择继续配置请求限制次数。然后点击底部的保存按钮，提交数据到数据库中。
删除授权接口，可以将已授权的接口删除。
新增接口，点击新增选择所需接口
# 转发规则引擎
详情
北向应用需要IoT平台推送实时数据时，用户可以按产品配置转发规则，如产品为温湿度的终端，应用需要设备状态、遥测、遥信的实时值，需要在状态、遥测、遥信变化时上报数据；并且对产品属性的数据配置过滤值，如终端属性的wendu，有效值在10-100范围内，并且过滤为88的值才会进行上报。
上报类型：设备状态、遥测、遥信、终端报警事件、命令执行结果。这些项选择的目的是为应用推送实时消息，可以根据应用需求进行个性化配置。
属性上报规则：定时上报和变化上报，其中定时上报可以配置间隔时间。这两种上报规则只对遥测、遥信有效。
状态上报规则：定时上报和变化上报，其中变化上报的规则中配置的“时间间隔”为设置时间内两次状态变化间隔多久内不上报。当前上报规则只对设备状态有效。
其他规则：对产品中的遥测属性进行控制，主要包括过滤值（毛刺值），有效范围。只有符合在规则范围的实时值才会进行上报，不符合的数据会进行过滤。如果需要对某个遥测属性进行配置，可以新增属性，并配置相应的值，然后单击底部的保存按钮生效。
# 消息订阅管理
详情
消息订阅主要针对终端实时数据，应用订阅终端实时数据时，需要应用提供接收实时数据的协议地址，可以支持常见的协议如，http，https，kafka等协议。主要的实时消息有4种：终端属性变化（遥测、遥信），终端状态变化（设备状态），终端事件（如报警事件），终端命令响应。在配置消息订阅完成后，敢为根据该配置信息，转发终端的实时数据，以下为消息发送流程：
新增订阅，选择订阅所属的应用，针对所填写的内容，请参考如下填写规则。
实时数据类型：推送终端4中实时数据（状态、属性（遥测遥信）事件，命令响应）。
协议类型：上层应用接收消息采用的协议。
终端类型：推送哪些终端类型数据（所选终端类型都会推送到一个topic下）
订阅名称：该名称iot这边可以自行定义。
转发地址：上层应用提供的消息接收地址。
转发topic：对于线上roma kafka需要用到，线下ROMA https 会用到。
发地址APPId：对于线上kafka需要用到，线下ROMA https 会用到。
转转发地址KEY：对于线上kafka需要用到，线下ROMA https 会用到。
SSL证书：对于线上ROMA中的kafka接入，如果开启了MQS_SASL_SSL，需要上传证书，该证书可以向线下roma的人获取。
# 应用资源概览
作为系统资源监控的核心仪表盘，提供应用接口调用、消息推送、订阅资源分布及性能时延的全链路实时概览，支撑系统状态快速评估与资源优化决策。
详情
- 本月调用接口信息：显示接口调用总量、成功率及关联设备统计（应用/终端/北向接口总数）。
- 消息推送统计：分本日/本月时段对比推送总数、成功数及成功率。
- 订阅数统计：统计终端属性/状态/事件/命令四大类订阅数量。
- 消息推送分析：折线图展示推送总数、成功数、异常数的日/月趋势。
- 接口调用分析：折线图展示接口调用总量、成功数、异常数的日/月趋势。
- API调用时延分析：折线图呈现API平均响应时延的日/月变化，辅助定位性能瓶颈。
