# xiaoshuai

**Repository Path**: plusboy/xiaoshuai

## Basic Information

- **Project Name**: xiaoshuai
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-28
- **Last Updated**: 2026-01-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

根据代码结构和文件信息，这是一个基于 ESP-IDF（Espressif IoT Development Framework）的嵌入式物联网（IoT）固件项目，主要实现了 OTA（Over-The-Air）升级、网页服务器和 Wi-Fi 管理三大功能模块。以下是该项目的 README.md 内容：

---

# Xiaoshuai IoT 固件项目

该项目是一个基于 ESP32 的嵌入式固件项目，支持 OTA 升级、网页配置以及 Wi-Fi 管理功能。适用于物联网设备的远程更新和配置管理。

## 功能特性

- **OTA 升级**：支持通过 HTTP 接口上传固件并进行远程升级。
- **网页服务器**：提供 Web 界面用于查看设备状态和配置网络。
- **Wi-Fi 管理**：支持 AP（热点）和 STA（客户端）模式，可保存 Wi-Fi 配置。

## 项目结构

- `src/`：主源码目录
  - `app_main.c`：程序入口，初始化组件。
  - `ota_manager.c/h`：OTA 升级管理模块。
  - `web_server.c/h`：HTTP 服务器模块，提供 Web 接口。
  - `wifi_manager.c/h`：Wi-Fi 连接与配置管理模块。
- `CMakeLists.txt`：构建配置文件。
- `sdkconfig`：ESP-IDF SDK 配置文件。
- `platformio.ini`：PlatformIO 配置文件（如适用）。

## 编译与部署

请确保已安装 ESP-IDF 开发环境。使用以下命令编译和烧录：

```bash
idf.py build
idf.py flash
idf.py monitor
```

## 使用说明

1. 设备启动后，进入 Wi-Fi 配置流程。
2. 通过 Web 界面访问设备状态和进行 OTA 升级。
3. 固件版本信息可通过接口查询。

## 接口说明

- `GET /`：首页，显示设备状态。
- `GET /ota`：OTA 升级状态页。
- `POST /ota/upload`：接收 OTA 固件上传。
- `POST /ota/update`：触发固件更新。
- `GET /wifi`：Wi-Fi 配置页面。
- `POST /wifi/connect`：连接指定 Wi-Fi。

## 状态码

- `OTA_STATE_IDLE`：空闲状态。
- `OTA_STATE_DOWNLOADING`：正在下载固件。
- `OTA_STATE_VERIFYING`：正在校验固件。
- `OTA_STATE_READY`：固件已准备好，等待更新。
- `OTA_STATE_ERROR`：发生错误。

## 版本信息

- 固件版本：`FIRMWARE_VERSION`
- 构建时间：`BUILD_DATE`

## 开源协议

该项目使用 Apache-2.0 协议。详见 LICENSE 文件。

---

如需进一步开发或调试，请参考 ESP-IDF 官方文档：[ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/)