IoT边缘 IoTEdge-接口函数:edge.h的接口函数介绍

时间:2025-01-26 10:36:38

edge.h的接口函数介绍

所有接口函数定义的数据结构均呈现在edge_struct.h头文件中。

1. 初始化

接口描述:

int  edge_init(const char* workdir)

接口功能:

初始化sdk的工作环境,加载证书、读取配置等

表13 参数说明

参数名称

类型

参数描述

示例

workdir

workdir

初始化文件所在目录,conf目录所在的目录,conf是存放证书文件以及日志配置的目录

conf在/code/api_test/workdir目录下,就填写/code/api_test/workdir

2. 注册回调接口

接口描述:

int edge_set_callbacks(ST_MODULE_CBS* module_cbs, ST_DEVICE_CBS* device_cbs)

接口功能:

注册回调接口,登录、子设备添加、删除、设备消息、设备命令等都是异步通知的,故需要注册对应的处理函数。

表14 参数说明

参数名称

类型

参数描述

module_cbs

ST_MODULE_CBS

模块回调函数结构体

device_cbs

ST_DEVICE_CBS

设备回调函数结构体

表15 ST_MODULE_CBS模块相关的回调函数说明

参数名称

类型

参数描述

pfn_shadow_cb

FN_SHADOW_ARRIVED*

模块影子回调函数类型,模块的配置可以使该接口接收

pfn_command_cb

FN_COMMAND_ARRIVED*

发送到模块的命令的接收函数声明,

pfn_connected

FN_SDK_CONNECTED

SDK连接到边缘hub的回调函数声明

pfn_disconnected

FN_SDK_DISCONNECTED

SDK和边缘hub断链的回调函数声明

表16 ST_DEVICE_CBS子设备相关的回调函数

参数名称

类型

参数描述

pfn_device_message_cb

FN_MESSAGE_ARRIVED*

子设备消息回调

pfn_device_command_cb

FN_COMMAND_ARRIVED*

子设备命令回调

pfn_device_event_cb

FN_DEVICE_EVENT_ARRIVED*

子设备事件回调

pfn_sub_device_add_cb

FN_SUB_DEVICE_ADD_ARRIVED*

子设备添加通知回调

pfn_sub_device_deleted_cb

FN_SUB_DEVICE_DELETED_ARRIVED*

子设备删除通知回调

pfn_on_start_scan_cb

FN_START_SCAN_ARRIVED*

收到子设备扫描通知回调

pfn_device_properties_set_cb

FN_DEVICE_PROPERTIES_SET_ARRIVED*

收到子设备属性设置通知回调

pfn_device_properties_get_cb

FN_DEVICE_PROPERTIES_GET_ARRIVED*

收到子设备属性获取通知回调

pfn_device_shadow_cb

FN_DEVICE_SHADOW_ARRIVED*

收到子设备影子

support.huaweicloud.com/devg-iotedge/iotedge_devg_0055.html