add README

This commit is contained in:
Kinchin Fong 2023-09-10 13:33:51 +08:00
parent 4284d54e6f
commit 5ba4f50482
2 changed files with 27 additions and 0 deletions

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# 开发说明
## 开发环境
1. Windows
2. PlatformIO + VSCode
3. Python3.8 及以上版本
## 文件介绍
`src` 中的源文件与 `include` 中的头文件一一对应。
- main.cpp: 入口函数
- VFileSystem: 文件系统接口
- DataRecorder: 数据读写接口
- ConfigManager: 配置项接口
- InterSerial: 与 STM32 通讯的串口功能
## 固件烧录流程
1. 在 PlatformIO 中打开项目并等待依赖库加载完成
2. 进入 `tools` 目录,并用 Python 运行 `init_fs.py`
3. 设备上电,按 boot 和 reset 进入 boot 模式
4. 点击侧边栏的 PlatformIO 工具,在 `PROJECT TASKS` 选项卡下,点击 `esp32-s2-sensor-recorder` -> `Platform` -> `Upload Filesystem Image` 等待文件系统上传完成
5. 编译并上传代码固件
6. 手动 reset

View File

@ -2,6 +2,7 @@
int ConfigManager::Init(VFileSystem* fs)
{
this->fs = fs;
return 0;
}