华为云用户手册

安装包部署 添加边缘应用-应用配置 部署方式选择安装包部署 添加边缘应用-软件和运行配置 安装包地址为{桶名/对象名}。 如桶名为edge-monitor,对象名为monitor-app.zip， 则安装包为edge-monitor/monitor-app.zip。 添加边缘应用-端点和部署配置同容器化部署 根据需要进行配置。 输入端点输出端点与demo中的设置对应，如monitor-app中输入与输出端点设置为input和output,则配置为： 输入端点：input。 输出端点：output。 输入输出端点是非必需配置的，当有数据流转时需要配置，如OT应用（数据处理）。 驱动类应用和IT应用一般不需要配置。 配置确认,填写基本信息 单击“确认添加”，完成应用的创建；单击"立即发布"，完成应用创建并发布新版本

DriverClient::reportScanResult 上报子设备扫描结果。 函数描述 public void reportScanResult(String eventId, ScanResultEvent scanResultEvent) throws JsonException 表12 参数说明 参数名称 类型 参数描述 eventId String 事件ID scanResultEvent ScanResultEvent 子设备扫描结果事件

DriverClient::getDeviceShadow 获取设备影子。 函数描述 public void getDeviceShadow(String requestId, ShadowGet shadowGet) throws IllegalArgumentException, JsonException 表6 参数说明 参数名称 类型 参数描述 requestId String 请求ID shadowGet ShadowGet 应获取请求

DriverClient::updateSubDevicesStatus 发送更新子设备状态事件。 函数描述 public void updateSubDevicesStatus(String eventId, UpdateSubDevicesStatusEvent statusEvent) throws JsonException 表10 参数说明 参数名称 类型 参数描述 eventId String 事件ID statusEvent UpdateSubDevicesStatusEvent 更新子设备状态事件

DriverClient::getProducts 发送获取产品事件。 函数描述 public void getProducts(String eventId, GetProductsEvent getProductsEvent) throws IllegalArgumentException, JsonException 表11 参数说明 参数名称 类型 参数描述 eventId String 事件ID getProductsEvent GetProductsEvent 获取产品事件

DriverClient::reportSubDevicesPropertiesAndDiscovery 上报子设备发现属性。 函数描述 public void reportSubDevicesPropertiesAndDiscovery(SubDevicesDiscoveryPropsReport report) 表8 参数说明 参数名称 类型 参数描述 report SubDevicesDiscoveryPropsReport 子设备发现属性数据消息体

DriverClient::syncSubDevices 发送子设备同步请求事件。 函数描述 public void syncSubDevices(String eventId, SyncSubDevicesEvent syncSubDevicesEvent) throws IllegalArgumentException, JsonException 表9 参数说明 参数名称 类型 参数描述 eventId String 事件ID syncSubDevicesEvent SyncSubDevicesEvent 同步子设备请求事件

代码解析 代码解释使用ModuleSDK开发应用集成ModuleSDK进行数据处理。 AppClient类有以下几个关键方法（具体参考JavaDoc）。 createFromEnv(): AppClient创建时由此方法自动获取环境变量。 setBusMessageCallback(): 设置总线消息回调，用于对设备上报的数据进行处理 sendBusMessage(): 向总线发送消息，用于将处理后的设备数据发送到总线 callDeviceCommand(): 调用设备命令 getDevicesInfo(): 查询设备状态 MonitorApp代码解析 片段一 privatestaticfinalString INPUT = "input";public static final String OUTPUT = "output"; 定义输入和输出的端点，关于取值需要需在创建应用版本的inputs参数中定义,创建应用时输入端点与输出端点以及数据流转规则的配置与此是对应的。例如此处定义了输入端点为“input”，输出端点为“output”，则创建应用时的端点和软件配置输入端点需要配置为input，输出端点需要配置为output。 应用部署后还需要设置数据流转规则后，决定数据的流向。 /** * 电机设备的产品ID */ public static final String MOTOR_PRODUCT_ID = "60988d94aa3bcc02c0200667"; 单击设备的产品ID,需要在IoTDA设备接入创建产品时获取。 片段二 private AppClient appClient;publicMonitorApp() throws GeneraException {appClient = AppClient.createFromEnv();} 定义并创建AppClient， AppClient.createFromEnv()创建其配置参数将会自动从边缘节点环境中获取，数据的传输将会依赖AppClient。 片段三 publicvoidstart() throws GeneraException {//设置回调，打开客户端appClient.setBusMessageCallback(INPUT, this);//设置收到设备数据的回调appClient.open();} appClient在接收到数据后的处理动作需要用户定义，具体操作是设置回调。 这里设置回调方法并传入输入端点后，appClient将会开启并启动一个监听器监听输入端点的数据传输，接收到设备经过hub发来的数据后会调用回调进行数据处理。 片段四 public void onMessageReceived(BusMessage busMessage) {try { if (busMessage.getProductId().equals(MOTOR_PRODUCT_ID)) { //马达设备状态错误时对马达进行重启 MotorData motorData = JsonUtil.fromJson( JsonUtil.toJson(busMessage.getServices().get(0).getProperties()), MotorData.class); if (motorData.getStatus().equals("error")) { Command command = new Command(busMessage.getDeviceId(),"power", "power_control", "restart" ); appClient.callDeviceCommand(command, FIVE_SECOND); } } else { //其他设备数据发布到总线 appClient.sendBusMessage(OUTPUT, busMessage);}} catch (Exception e) {System.out.println(e.getMessage());}} onMessageReceived(BusMessage busMessage)是前面设置回调具体的回调函数，它是BusMessageCallback接口的方法，MonitorApp要实现BusMessageCallback接口并实现此方法，AppClient通过设置的输入端口input监听到设备发送数据时调用此方法进行数据处理，用户关于设备发送的数据的处理逻辑在此方法内实现，处理后的数据通过设置的输出端口output发送经过hub发送到云端。 appClient.callDeviceCommand(command, FIVE_SECOND)是示例演示应用在接收到设备传来的error信号后，向设备发送秒后重启命令。 父主题： 集成ModuleSDK进行数据处理

DcClient::setPointsCallback 设置点位相关处理方法回调，实现下行点位获取、点位设置的处理。 函数描述 public void setPointsCallback(PointsCallback pointsCallback) 表2 参数说明 参数名称 类型 参数描述 pointsCallback PointsCallback 点位回调类实例 表3 PointsCallback回调接口说明 回调接口 参数描述 PointsSetRsp onPointSet(String requestId, PointsSetReq pointsSetReq) 点位设置回调 PointsGetRsp onPointGet(String requestId, PointsGetReq pointsGetReq) 点位获取回调

InnerClient::startModuleShadow 启动模块影子，设置收到影子回调并触发获取影子动作，该函数适用于AppClient、DriverClient、DcDriver。 函数描述 public void startModuleShadow(ModuleShadowNotificationCallback callback) throws IllegalArgumentException

InnerClient::setConnectionStatusChangeCallback 设置连接状态变化回调，用于MQTT连接状态改变时进行相应的处理，该函数适用于AppClient、DriverClient、DcDriver。 public void setConnectionStatusChangeCallback(ConnectionStatusChangeCallback callback)

生成可执行文件 需要Linux开发环境，可利用CLion远程调试或者将工程打包到Linux服务器上编译生成可执行文件 编译生成可执行文件(MyCApp)，可以通过CLion之间编译生成，也可以通过在Linux服务器上通过命令行生成。 下面提供在Linux服务器使用命令行生成的方法。 cmake -DCMAKE_BUILD_TYPE=Debug -G "CodeBlocks - Unix Makefiles" ./-- The C compiler identification is GNU 4.8.5-- Detecting C compiler ABI info-- Detecting C compiler ABI info - done-- Check for working C compiler: /usr/bin/cc - skipped-- Detecting C compile features-- Detecting C compile features - done-- Configuring done-- Generating done-- Build files have been written to: /home/MyCApp makeConsolidate compiler generated dependencies of target MyCApp[100%] Built target MyCApp 可以在目录下找到生成的可执行文件，即MyCApp。 父主题： 开发指导

内部架构 模块SDK用于开发运行在边缘节点中的应用，包括数据处理应用（简称应用，例如数据清洗）和协议驱动（简称驱动，例如EdgeAccess）。 图1 边缘设备接入和应用开发能力架构图 部署在边缘节点中的第三方应用和第三方驱动使用模块SDK进行开发。 图2 模块SDK调用流程图 基本调用流程如图2所示。 基于ModuleSDK-C开发应用实现数据的云边同步，主要分为开发和使用两个部分。 开发操作 开发说明 SDK应用的开发 按照SDK提供的Demo进行自定义应用开发。 SDK应用的使用 将应用打包上传至华为云，部署到节点。连接子设备查看应用工作情况。 ModuleSDK-C提供了以下头文件，用户可根据需求引用相应的头文件： 头文件 说明 edge.h 实现基本的回调函数和接口函数 edge_daemon.h 实现所有证书、鉴权相关接口 edge_driver.h 驱动模块，用于开发驱动接入设备，驱动需实现网关回调函数 edge_error.h 错误码定义 edge_struct.h 所有可能使用到的头文件定义 edge_dc_driver.h 数采驱动模块，用于开发数采驱动接入点位数据，驱动需实现相关回调函数 父主题： 集成ModuleSDK(C)

协议转换(驱动应用) 驱动提供子设备管理和数据上报功能。 子设备管理功能包括子设备增删和配置子设备数据采集协议。设备的增删有两种形式，一是在云端增删，通过集成驱动SDK，可以接收到北向应用管理子设备的回调，即北向应用通过IoTEdge创建/删除设备时，自定义驱动应用可以接收到事件回调，在边侧进行设备接入及协议解析。二是在本地增删，自定义驱动应用也提供本地页面进行设备管理，驱动应用通过SDK上报设备添加/删除通知到云端IoTEdge，将边侧的设备管理操作同步到云端。 数据上报功能可以将设备状态和设备数据上报到云端。 驱动提供本地Portal对子设备进行管理，包括子设备数据采集协议相关配置；驱动将设备状态和设备数据上报到云端。 本地Portal增删设备时，通过子设备发现事件上报增删的设备，IoT Edge在云侧增删设备，增删的设备信息通过子设备增删事件通知到驱动 北向应用NA提供设备管理界面，调用IoTEdge接口增删设备，通过子设备增删事件通知到驱动。 北向应用在增加设备时指定设备数据采集协议相关配置。 父主题： 架构介绍

使用场景 场景挑战 设备采集的数据信息量庞大但只需部分有效数据。部署在节点下的设备需要在本地判断情况以及时进行控制。 设备使用的协议不能接入边缘计算。 节点下的IT子系统众多，接入时不便于管理，配置繁琐。子系统采集的数据需要传输到用户的北向应用。 解决方案 通过开发集成ModuleSDK的应用，您可以： 使用ModuleSDK提供的AppClient开发OT应用对需要上传到云端的信息进行过滤上传。OT应用可以在本地对设备进行命令的下发。 使用ModuleSDK提供的DriverClient开发驱动应用进行协议转换。 使用ModuleSDK提供的ItClient开发IT应用实现子系统与云端配置的自动同步，也可以实现云端对子系统的配置管理。云端可以通过IT应用实现对子系统数据的采集。

如何使用 OT应用使用步骤： 1. 将创建好的应用部署到节点。部署请参照应用部署。 2. 添加设备进行测试（添加设备请参考设备接入边缘节点）。 可以利用MQTT.fx软件模拟设备接入调试。 驱动应用使用步骤： 1. 将创建好的应用部署到节点。部署请参照应用部署。 2. 添加网关。 3. 添加设备进行测试（添加设备请参考设备接入边缘节点）。 可以利用Modbus Slave软件模拟设备接入调试。 IT应用使用步骤： 1.注册节点，绑定工业资源包。 2.创建API网关。 3.将apigw系统组件和创建的应用部署到节点。 4.使用postman进行调试验证。 父主题： 开发指导

简介 为解决用户自定义处理设备数据以及自定义协议设备快速接入IOT平台的诉求，IoT边缘提供ModuleSDK，用户可通过集成SDK让设备以及设备数据快速上云。IoT边缘平台应用功能有自定义处理设备数据（即数据处理），自定义协议设备快速接入（即协议解析），IT子系统接入(即IT应用)，并且支持容器化部署和安装包部署的方式。 集成ModuleSDK开发的应用被称为插件应用，其最终将被通过云部署到边缘节点。 集成ModuleSDK的应用分为： OT应用：数据处理类型的应用，实现了总线回调接口，IoT边缘云服务为OT应用提供总线对接能力、设备反向控制（命令）能力。 驱动应用：协议转换类型的应用，可将使用自定义协议的设备接入边缘计算。 IT应用：实现工业子系统接入的应用，实现了对子系统配置同步、反向调用接口、以及数据采集能力。 集成了SDK的应用称为插件，华为云市场提供了插件上架功能。您可以将开发的集成了SDK的应用上传到华为云市场来获取收益，也可以在华为云市场下载使用第三方插件。

操作场景 开发应用驱动集成ModuleSDK进行OT数采。（此示例以采集OPCUA为示例） 在节点部署集成了ModuleSDK应用驱动。 配置好数据源模板（可自定义）。 在平台进行数据源配置，以及点位配置，下发。 集成ModuleSDK应用驱动对平台下发的配置进行处理。 通过下发信息获取数据源连接，以及点位信息进行数据周期采集。 最后运用ModuleSDK的客户端进行点位数据进行周期上报。 父主题： 集成ModuleSDK进行OT数采

ItClient::patchJson 发送PATCH json请求。 函数描述 public String patchJson(String uri, String body) throws HttpException, CryptException, AuthException 表7 参数说明 参数名称 类型 参数描述 uri String 请求uri body String 请求消息体 headers Header[] 请求头部

ItClient::postJson 发送POST json请求。 函数描述 public String postJson(String uri, String body, Header[] headers) throws HttpException, CryptException, AuthException 表4 参数说明 参数名称 类型 参数描述 uri String 请求uri body String 请求消息体 headers Header[] 请求头部

ItClient::putJson 发送PUT json请求。 函数描述 public String putJson(String uri, String body) throws HttpException, CryptException, AuthException 表6 参数说明 参数名称 类型 参数描述 uri String 请求uri body String 请求消息体 headers Header[] 请求头部

安装包部署-SDK应用日志 通过”安装包”部署的SDK应用可以下述方式查看日志。 进入/var/IoTEdge/downloaded-job/run目录. cd /var/IoTEdge/downloaded-job/run 找到相应的安装包目录，找到myapp_running.log查看日志。 可以看到SDK应用启动的日志如下 通过用MQTT设备模拟器发送数据，可以看到SDK处理相应的消息日志。

内部架构 表1 通用接口 接口 说明 IModuleShadowCallback 模块影子回调，实现对影子通知的处理 IPointsCallback 点位处理回调，实现点位的读写操作 IConnectionStatusChangeCallback 连接状态变化回调接口，用于MQTT连接状态改变时的处理 表2 提供的类 类 说明 DcClient 数采客户端，用于开发数采驱动接入点位数据，驱动需实现相关回调函数 父主题： 集成ModuleSDK(C#)

场景说明 开发应用驱动集成ModuleSDK进行OT数采。（此示例以采集OPCUA为示例） 在节点部署集成了ModuleSDK应用驱动。 配置好数据源模板（可自定义）。 在平台进行数据源配置，以及点位配置下发。 集成ModuleSDK应用驱动对平台下发的配置进行处理。 通过下发信息获取数据源连接，以及点位信息进行数据周期采集。 最后运用ModuleSDK的客户端进行点位数据周期上报。 父主题： 集成ModuleSDK进行数据采集

安装包部署 添加边缘应用-应用配置 部署方式选择安装包部署 添加边缘应用-软件和运行配置 ”安装包地址”为{桶名/对象名}。 如桶名为edge-monitor，对象名为monitor-app.zip， 则安装包为edge-monitor/monitor-app.zip。 添加边缘应用-端点和部署配置同容器化部署 根据需要进行配置。 输入端点输出端点与demo中的设置对应，如monitor-app中输入与输出端点设置为input和output,则配置为： 输入端点：input。 输出端点：output。 输入输出端点是非必需配置的，当有数据流转时需要配置，如OT应用（数据处理）。 驱动类应用和IT应用一般不需要配置。 建议直接勾选“立即发布”，方便后面直接部署应用的时候，能够获取到最新版本。

如何使用 OT应用使用步骤： 将创建好的应用部署到节点。部署请参照应用部署。 添加设备进行测试（添加设备请参考设备接入边缘节点）。 可以利用MQTT.fx软件模拟设备接入调试。 驱动应用使用步骤： 将创建好的应用部署到节点。部署请参照应用部署。 添加网关。 添加设备进行测试（添加设备请参考设备接入边缘节点）。 可以利用Modbus Slave软件模拟设备接入调试。 IT应用使用步骤： 注册节点，绑定工业资源包。 创建API网关。 将apigw系统组件和创建的应用部署到节点。 使用postman进行调试验证。 父主题： 开发指导

接口格式 OneAccess 同步事件回调接口的请求方式为POST，数据编码为UTF-8，数据格式为JSON。 如果应用系统接收事件回调的URL为 https://{app_domain}/callback，当OneAccess的企业发生组织机构或用户变动时，OneAccess将发生变动的业务数据推送至该回调地址。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token}，可参考表1中的安全令牌。 请求参数 表1 请求参数 参数 参数类型 描述 nonce String 随机数，与timestamp结合使用，用于防止请求重放攻击。 timestamp Integer 时间戳，与nonce结合使用，用于防止请求重放攻击。 eventType String 事件类型，参见事件类型列表。 data String 消息体，当未开启加密时，发送明文的消息体；当开启加密时，发送加密的消息体，需要解密得到消息内容，解密后有random、msg二个字段，其中msg即为明文消息内容。 signature String 消息签名，当未开启签名时，签名信息为空字符串；当开启签名时，生成签名信息，signature计算结合企业应用填写的签名密钥(signatureSaltValue)、请求中的timestamp、nonce、加密的消息体。 响应参数 表2 响应参数 参数 参数类型 描述 code String 返回code码，200表示成功，失败错误码请参考公共返回码。 message String 处理出错时的错误原因说明。 data String 返回的消息体。不同的业务回调要求返回不同内容，比如回复空串，或者要求的业务数据。 当未开启加密时，返回明文的消息体。 当开启加密时，返回加密的消息体，需要解密得到消息内容，解密后有random、msg二个字段，其中msg即为明文消息内容。 请求示例 未启用消息签名和加密的请求示例： {"nonce": "123456","timestamp": 1783610513,"eventType": "eventType","data": "明文的消息","signature": ""} 启用消息签名和加密的请求示例： {"nonce": "123456","timestamp": 1783610513,"eventType": "eventType","data": "1ojvw2WPvW7LijxS8UvISr8pdDP+rXpPbcLGOmIBNbWetRg7IP0vdhkl","signature": "111108bb8e6dbce3c9671d6fdb69d15066227608"} 响应示例 状态码：200 请求成功 未启用消息签名和加密的响应示例： {"code": "200","message": "success","data": "明文的消息"} 启用消息签名和加密的响应示例： {"code": "200","message": "success","data": "P+rXpWetRg7IP0vdhVgkVwSoZBJeQwY2zhROsJq/HJ+q6tp1qhl9L1+c"}

请求示例 启用消息签名和加密的请求示例： {"nonce": "AmgjjEAJbrMzWmUw","timestamp": 15093849585,"eventType": "DELETE_ORGANIZATION ","data": "6lrHydJIXEWxQhUa3UqsXHWsDZ5LTAo/xU3zhjq9H3syCuFYDYKg==","signature": "K08yDiTEc094KoccOY+VYLQFxxQ="} 请求包体data解密后的JSON字符串格式： {"id": "6c5bb468-14b2-4183-baf2-06d523e03bd3"}

请求示例 启用消息签名和加密的请求示例： {"nonce": "AmgjjEAJbrMzWmUw","timestamp": 15093849585,"eventType": "UPDATE_USER","data": "6lu6gxrHydJIXEQhUa3UqsXHWsDZ5LTAo/xU3zhjq9H3syCuFYDYKg==","signature": "K08yDiTEc094KoccOY+VYLQFxxQ="} 请求包体data解密后的JSON字符串格式。 根据请求的用户ID参数更新用户信息，将变更的用户属性发送给企业应用。 {"id": "c3a26dd3-27a0-4dec-a2ac-ce211e10....","username": "zhangs","name": "张三2","mobile": "1867237....","email": "454205....@qq.com","extAttr1": "value","extAttr2": "value"}

请求参数 表1 请求参数 参数 固定参数 参数类型 描述 id 是 String(50) 企业应用的用户ID。 username 是 String(100) 用户名。 name 否 String(40) 用户姓名 firstName 否 String(20) 名字。 middleName 否 String(20) 中间名。 lastName 否 String(20) 姓氏。 organizationId 否 String 组织机构ID。 mobile 否 String 手机号。 email 否 String 邮箱地址。 disabled 是 Boolean 是否禁用，true表示禁用状态，fasle表示启用（未禁用）。 extAttr1 否 -- 扩展属性1，企业扩展的用户属性，以实际情况为准。 extAttr2 否 -- 扩展属性2，企业扩展的用户属性，以实际情况为准。