ESP8266/ESP32 配置管理器（ConfigManager）安装与使用教程

ESP8266/ESP32 配置管理器（ConfigManager）安装与使用教程

ConfigManager ESP8266 Wifi connection and configuration manager. 项目地址: https://gitcode.com/gh_mirrors/co/ConfigManager

一、项目目录结构及介绍

ConfigManager 是一个专为 ESP8266 和 ESP32 设计的WiFi连接和配置管理库。以下是一个典型的项目目录结构：

ConfigManager
├── data                 # 存放SPIFFS中使用的静态资源，如网页配置界面文件
│   └── index.html       # 示例的配置页面
├── examples             # 示例代码目录
│   ├── ...
├── library.json         # 库的元数据配置文件
├── library.properties   # 另一种形式的库元数据
├── platformio.ini       # 平台IO构建配置文件
├── README.md            # 项目说明文档
├── src                  # 主要源码目录
│   └── ConfigManager.h  # 核心头文件
└── ...

• data 目录存放了用于访问点（AP）模式下服务的网页配置文件。
• examples 包含了使用此库的示例工程，帮助快速上手。
• src/ConfigManager.h 是主要的头文件，包含了所有接口声明。

二、项目启动文件介绍

虽然项目没有一个单一的“启动文件”，但在使用这个库时，你的项目的 main.ino 或 main.cpp 就成为了实际的启动点。在这些启动文件中，关键步骤包括引入库、定义配置结构体、初始化配置管理器，并在 setup() 函数中进行必要的设置，在 loop() 中调用库的循环处理函数。例如：

#include <ConfigManager.h>

struct Config {
    // 用户自定义配置项
};

void setup() {
    Config config;
    ConfigManager configManager;
    
    // 设置AP信息、添加参数、初始化等操作
    configManager.setAPName("MyAccessPoint");
    configManager.begin(config);
}

void loop() {
    configManager.loop();
}

三、项目的配置文件介绍

代码中的配置

配置不是通过独立的配置文件来管理，而是通过在Arduino编译的程序内定义结构体来实现的。在上述例子中，Config 结构体定义了设备的配置参数。此外，项目依赖于 ArduinoJson 库来序列化和解析JSON配置，其版本需为6。

外部资源配置

对于用户界面相关的配置，如HTML配置页面，它们存储在 data 目录下。这些文件在设备运行时被上传到SPIFFS（嵌入式文件系统），从而可以通过Web服务器访问。这意味着任何对配置UI的修改，都需要更新 data/index.html 文件并通过IDE上传至设备的文件系统。

缓存与存储配置

配置数据通常保存在EEPROM或基于项目设置的其他存储介质中。通过调用库提供的 save() 方法，可以将当前配置写入存储。初始化和保存过程中，开发者需要明确指定哪些配置项可读、可写，这通过在 addParameter 方法中设定来完成。

总结来说，ConfigManager项目通过特定的代码结构和流程而不是传统配置文件来管理和应用配置，确保ESP8266和ESP32设备能便捷地进行无线网络配置和内部参数管理。

ConfigManager ESP8266 Wifi connection and configuration manager. 项目地址: https://gitcode.com/gh_mirrors/co/ConfigManager