IotWebConf 开源项目教程

IotWebConf 开源项目教程

IotWebConfESP8266/ESP32 non-blocking WiFi/AP web configuration Arduino library项目地址:https://gitcode.com/gh_mirrors/io/IotWebConf

1. 项目的目录结构及介绍

IotWebConf 项目的目录结构清晰，便于理解和使用。以下是主要的目录和文件介绍：

• examples/: 包含多个示例项目，展示了如何使用 IotWebConf 进行设备配置。

  • IotWebConf01Minimal: 最简单的示例，展示了基本配置。
  • IotWebConf02SeparatePage: 展示如何将配置页面分离。
  • IotWebConf03Actions: 展示如何添加自定义动作。
  • IotWebConf04UpdateServer: 展示如何实现固件更新服务器。
  • IotWebConf05Advanced: 展示高级配置选项。

• src/: 包含 IotWebConf 的核心库文件。

  • IotWebConf.h: 主头文件，包含库的主要类和函数声明。
  • IotWebConf.cpp: 主实现文件，包含库的主要功能实现。
  • IotWebConf.cpp*: 其他辅助文件，包含特定功能的实现。

• extras/: 包含额外的资源文件，如图片和文档。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

IotWebConf 项目的启动文件主要是 examples/ 目录下的示例项目。每个示例项目都有一个 *.ino 文件，这是 Arduino 的草图文件，用于编写和上传代码到设备。

以 examples/IotWebConf01Minimal/IotWebConf01Minimal.ino 为例，该文件包含了以下主要部分：

• 包含头文件: 引入 IotWebConf 库和其他必要的库。

  #include <IotWebConf.h>
  

• 定义参数: 定义设备配置的参数，如 WiFi SSID 和密码。

  const char thingName[] = "testThing";
  const char wifiInitialApPassword[] = "password";
  

• 初始化对象: 创建 IotWebConf 对象并初始化。

  IotWebConf iotWebConf(thingName, &dnsServer, &server, wifiInitialApPassword);
  

• 设置函数: 定义设备启动时的设置函数。

  void setup() {
    Serial.begin(115200);
    iotWebConf.init();
    server.on("/", handleRoot);
    server.onNotFound(handleNotFound);
  }
  

• 主循环函数: 定义设备运行时的主循环函数。

  void loop() {
    iotWebConf.doLoop();
  }
  

3. 项目的配置文件介绍

IotWebConf 项目的配置文件主要是 src/ 目录下的 IotWebConf.h 和 IotWebConf.cpp。这些文件包含了库的主要类和函数实现。

• IotWebConf.h: 定义了 IotWebConf 类和相关结构体，如配置参数、网络配置等。

  class IotWebConf
  {
  public:
    IotWebConf(const char* thingName, DNSServer* dnsServer, WebServer* server, const char* initialApPassword);
    void init();
    void doLoop();
    // 其他成员函数和变量
  };
  

• IotWebConf.cpp: 实现了 IotWebConf 类的成员函数，如初始化、循环处理、网络配置等。

  void IotWebConf::init() {
    // 初始化代码
  }
  
  void IotWebConf::doLoop() {
    // 循环处理代码
  }
  

通过这些配置文件，开发者可以了解和自定义 IotWebConf 库的行为和功能。

IotWebConfESP8266/ESP32 non-blocking WiFi/AP web configuration Arduino library项目地址:https://gitcode.com/gh_mirrors/io/IotWebConf