第二十四篇： API文件介绍

H在开发

  介绍：API介绍应用程序编程接口，它是一组定义了不同软件组件之间交互的规则和协议，用于在应用程序之间进行通信和数据交换。通过API，开发人员可以访问和使用其他软件、服务或库的功能，而无需了解其内部实现细节。API可以用于构建应用程序、网站、操作系统和其他软件，以实现各种功能和服务。

在我们自动生成的代码的文件夹中，有这个文档的介绍

这个文档非常的使用，我们可以直观的知道文件的用途。

重要文件解读：
1. gizwits_product.c文件
该文件为用户相关处理函数以及平台相关硬件初始化， 如串口、 定时器等， 同时包含据采集 userHandle()函数和数据点初始化 userInit()函数。
2.gizwits_product.h
该文件为 gizwits_product.c 的头文件， 如 HARDWARE_VERSIONSOFTWARE_VERSION。
4.gizwits_protocol.c
该文件为 SDK API 接口函数定义文件。
5.gizwits_protocol.h
该文件为 gizwits_protocol.c 对应头文件,相关 API 的接口**均在此文件中。
6. 其他文件
a)User/main.c

MCU 程序入口函数所在文件,入口函数为 main(void)，我们主要编程的代码在主函数。

API介绍：

Void gizwitsdInt（void）函数：

       Gizwits协议初始接口，我们调用改函数可以完成Gizwits协议初始化（包括定时器和串口初始化）。

Void gizwitsSetMode（uint8_tmode）函数：

       gizwitsSetMode（WIFI_RESET_MODE）， 恢复模组出厂配置接口， 调用会清空所有配置参数， 恢复到出厂默认配置。

gizwitsSetMode（WIFI_SOFTAP_MODE）或gizwitsSetMode（ WIFI_AIRLINK_MODE），配置模式切换接口， 支持

SoftAP 和 AirLink 模式。gizwitsSetMode（ WIFI_SOFTAP_MODE） 时配置模组进入 SoftAp 模式，

  gizwitsSetMode（WIFI_AIRLINK_MODE）配置模组进入 AirLink 模式。

gizwitsSetMode（WIFI_PRODUCTION_TEST），模组进入产测模式。

gizwitsSetMode（WIFI_NINABLE_MODE ）， 模组进入可绑定模式， 可绑定时间为

NINABLETIME(gizwits_protocol.h中**)， 默认为 0，表示模组永久可绑定。

void gizwitsGetNTP(void)函数:

获取 NTP 时间接口。用户调用该接口可以获取当前网络时间， MCU 发起请求， 模组回复后将产生 WIFI_NTP事件， 用户可在 gizwitsEventProcess 函数中进行相应处理。

voidgizwitsHandle(dataPoint_t *dataPoint)函数：

参数dataPoint[in]:用户设备数据点。

该函数中完成了相应协议数据的处理及数据上报的等相关操作。

int8_tgizwitsEventProcess(eventInfo_t *info, uint8_t *data,uint32_t len)函数：

参数info[in]:事件队列

参数data[in]:数据

参数 len[in]:数据长度

用户数据处理函数,包括 wifi 状态更新事件和控制事件。

a) Wifi 状态更新事件

WIFI_开头的事件为 wifi状态更新事件， data 参数仅在 WIFI_RSSI 有效， data 值为

RSSI 值,数据类型为 uint8_t， 取值范围 0~7。

b) 控制事件

与数据点相关,本版本代码会打印相关事件信息，相关数值也一并打印输出， 用户

只需要做命令的具体执行即可。

int32_tgizwitsPassthroughData(uint8_t *data, uint32_t len)函数：

参数data[in]:数据

参数 len[in]:数据长度

用户调用该接口可以完成私有协议数据的上报

       总结：本章提供了一些重要的文件和API函数的解读。其中，gizwits_product.c文件包含了用户相关的处理函数和平台相关的硬件初始化；gizwits_protocol.c文件定义了SDK API接口函数；其他文件包括用户主程序入口函数和一些其他文件。API函数中，gizwitsdInit()用于进行Gizwits协议的初始化；gizwitsSetMode()用于配置模组的工作模式；gizwitsGetNTP()用于获取当前网络时间；gizwitsHandle()用于处理设备数据点的相关协议数据和数据上报；gizwitsEventProcess()用于处理WiFi状态更新事件和控制事件；gizwitsPassthroughData()用于上报私有协议数据。通过对这些文件和API函数的理解和使用，可以进行相应的开发工作。