docs: 新增项目级 README,补充快速开始与配网说明

This commit is contained in:
Wang Beihong
2026-03-05 12:44:37 +08:00
parent 7261022611
commit 3cf8f5c628

48
README.md Normal file
View File

@@ -0,0 +1,48 @@
# BotanicalBuddy
基于 ESP-IDF 的植物助手项目,当前已集成 **Wi-Fi 配网组件wifi-connect**,支持手机连接设备热点后通过网页完成路由器配置。
## 功能特性
- 长按按键进入配网模式
- 设备开启 SoftAP`ESP32-xxxxxx`+ Captive Portal
- 手机访问 `http://192.168.4.1` 完成 Wi-Fi 配置
- 支持清除已保存 Wi-Fi 参数并重新配网
- 串口中文状态日志,便于调试和现场维护
## 目录结构
- `main/`:应用入口(`app_main`
- `components/wifi-connect/`:配网组件实现与文档
- `README.md`:组件说明
- `USER_GUIDE.md`:用户操作手册
- `QUICK_POSTER.md`:张贴版快速指引
- `BLOG.md`:博客草稿
## 开发环境
- Linux
- ESP-IDF `v5.5.2`(建议)
- Python 与 ESP-IDF 工具链按官方方式安装
## 快速开始
1. 配置并编译
- `idf.py set-target esp32`
- `idf.py build`
2. 烧录并查看日志
- `idf.py -p /dev/ttyUSB0 flash monitor`
3. 配网
- 长按设备按键进入配网模式
- 手机连接 `ESP32-xxxxxx`
- 打开 `http://192.168.4.1`
- 选择路由器并输入密码提交
## 当前状态
项目已完成第一版配网闭环:
- 配网入口
- 路由连接
- 状态显示
- 清除配置
- 中文日志与文档