Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@
## [Unreleased]

### 新增
- **M5Burner 小白教程与 SD 配置模板**:新增 `docs/m5burner-quick-start.md` 和 `config.ini.example`,明确 M5Burner 烧录后优先用手机配网、离线使用操作、SD 卡根目录/文件名/格式要求,避免误建 `config.ini.txt` 或放错目录
- **设备端 WiFi 配网页(SoftAP 热点 + captive portal)**:换 WiFi 不再依赖电脑/脚本/改代码——屏幕二维码页长按 B(或开机无凭据自动进入、串口 `#WIFIAP`)开启热点 `PaperColor-XXXXXX`,手机连上后浏览器自动弹出配置页,选 WiFi 输密码即完成;支持在线扫描周边 WiFi、实时连接状态轮询;凭据 NVS+SD 双写(NVS 优先级低,`#CFGDONE` 脚本全量写仍以 SD 为准并清 NVS);配网成功自动校时(NTP + HTTP 兜底)后 10 秒自动退出收摊
- `platformio.ini` 新增 `ricmoo/QRCode` 依赖(配网页面绘制连接地址二维码,手机扫码直达)
- **天气多城市**:config.ini 新增 `weather_lat` / `weather_lon` / `weather_city`(默认北京);日历页天气卡显示城市名;`write_config.py` 支持可选 `weather.txt`(lat= / lon= / city= 每行一条)
- **WiFi 重连失败自动重试**:待机唤醒后重连失败 → 30 秒后自动重试(热点晚开/切换中场景),连上后立即拉智谱额度
- `#POLL` 命令与 `#WX` 同路径:WiFi 未连先重连再触发
- **`card_manager.py` 考点卡片 Web 管理器**:浏览器编辑 cards/chNN.json → 保存 → 一键串口上传设备 SD(`py -3 card_manager.py`,零第三方依赖,上传后重启设备生效)
- README 更换实机照片(待机页大图 + 七页实拍画廊)

### 修复
- **开机不上网修复**:`setup()` 末尾按已存凭据置 `wifiReconnectPending`,开机即自动连 WiFi 并校时(此前开机只进待机、等唤醒才连);无任何凭据则自动进入配网模式
- **RTC 日期不同步**:SNTP(UDP123) 在 iPhone 热点下不可靠 → 日期停在旧值。新增 HTTP Date 兜底校准(`fetchHttpTimeSync` 拉 www.baidu.com 响应头 → settimeofday + 写回 RTC 芯片),开机/待机唤醒 SNTP 后兜底执行,实测 RTC=真实日期
- 新增 `#TIME` 诊断命令:对比系统 `time()` 与 RTC 芯片当前值
- `verify_audit.py` 增强:`ser.write` 加 `write_timeout` 防 USB 卡死无限阻塞 + 异常捕获与明确提示(light sleep 后需物理重插 USB)
Expand Down
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,9 @@ flowchart LR
1. 下载 [M5Burner](https://m5stack.com/pages/m5burner) → 右上角登录 M5Stack 社区账号
2. 左下角 **USER CUSTOM** → 搜索 **PaperColor**(PaperColor eInk Desk Terminal)(类别 paper · 作者 DrDavid)→ Burn
3. 或点 **Share Burn** 输入分享码:`uqzYX4i61TQriRrU`
4. 烧录完成后,**不需要先创建 TF 卡文件**:设备无 WiFi 凭据时会自动显示配网说明,按屏幕提示用手机连接 `PaperColor-XXXXXX`,打开 `http://192.168.4.1` 完成配置

> 首次使用需向设备 SD 卡写入 `/config.ini`(WiFi + token),见下方「配置」。
> M5Burner 只负责烧录固件,不会自动读取电脑 WiFi。普通用户请优先使用手机配网;SD 卡 `config.ini` 是备用配置方式,详见 [`docs/m5burner-quick-start.md`](docs/m5burner-quick-start.md)。

### 1. 环境

Expand All @@ -224,7 +225,29 @@ USB-C 直连即可。PaperColor 板载按键、麦克风、扬声器、SD、温

### 3. 配置

编辑 `src/main.cpp` 顶部的集中配置区:
**WiFi 三种配法,推荐 A(全程只用手机,无需电脑/无需改代码):**

**A. 手机配网(SoftAP 热点 + 网页配置)**

1. 进入配网模式(任选其一):
- 开机检测到从未配置过 WiFi → **自动进入**配网模式
- 二维码页(第 6 页)**长按 B**
- 串口发送 `#WIFIAP`
2. 屏幕显示热点名 + 网址二维码 → 手机连接热点 `PaperColor-XXXXXX`(开放网络)
3. 手机浏览器会自动弹出配置页(或手动打开 `http://192.168.4.1`)→ 可点"重新扫描附近WiFi"→ 选择家里 WiFi → 输密码 → **保存并连接**
4. 设备自动连接;成功后屏幕提示并**10 秒后自动退出**配网模式,手机自动回连家里 WiFi

> 凭据双写:NVS(设备内部)+ SD `/config.ini`(`wifi_ssid=` / `wifi_pass=` 行,与脚本配置互通)。配网成功即自动校时(NTP + HTTP 兜底)。

完整小白教程:[`docs/m5burner-quick-start.md`](docs/m5burner-quick-start.md)。如果用 SD 卡备用方式,请复制 [`config.ini.example`](config.ini.example) 到 SD 卡根目录并改名为 `config.ini`。

**B. 编译期写入**(下述 `WIFI_SSID` / `WIFI_PASS`)

**C. 电脑脚本**(下述 `write_config.py`,插上 USB 自动跟随电脑 WiFi)

---

编译期方式:编辑 `src/main.cpp` 顶部的集中配置区:

```cpp
#define WIFI_SSID "你的WiFi"
Expand All @@ -251,6 +274,7 @@ pio run -j 1 -t upload --upload-port COM4

- 短按 A/B 翻页,长按 A/B 触发功能
- **长按 C = 全局语音命令**
- **二维码页长按 B = WiFi 配网模式**(换 WiFi/改密码不用重烧固件)
- 5 分钟无操作自动进待机页,任意键唤醒

---
Expand Down
19 changes: 19 additions & 0 deletions config.ini.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# PaperColor WiFi 配置示例
# 复制本文件到 SD 卡根目录,并重命名为 config.ini。
# Windows 请确认文件不是 config.ini.txt。

use_wifi=true
wifi_ssid=你的WiFi名称
wifi_pass=你的WiFi密码

# 可选:第二、第三组 WiFi
# wifi_ssid2=备用WiFi
# wifi_pass2=备用WiFi密码
# wifi_ssid3=手机热点
# wifi_pass3=手机热点密码

# 可选:智谱 Coding Plan
# zhipu_cookie=你的token

# 可选:语音转文字
# sf_api_key=你的key
58 changes: 58 additions & 0 deletions docs/m5burner-quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# M5Burner 小白上手教程

## 先记住一件事

烧录完成后,**不需要先在 TF/microSD 卡上建文件才能配置 WiFi**。最简单的方法是用手机配网:

1. 设备开机。如果没有保存过 WiFi,设备会自动显示 WiFi 配网说明。
2. 手机连接设备屏幕显示的热点,例如 `PaperColor-XXXXXX`。
3. 如果手机提示“此网络无互联网”,选择“继续连接/保持连接”。
4. 扫描设备上的二维码,或在手机浏览器打开 `http://192.168.4.1`。
5. 选择家里的 WiFi,输入密码,点击“保存并连接”。
6. 等待设备显示连接成功。约 10 秒后设备关闭临时热点,手机再切回家里的 WiFi。

没有自动弹出网页时,直接打开 `http://192.168.4.1`。以后要重新配置 WiFi,进入二维码页并长按 B。

## 只想离线使用

在设备的 WiFi 配网页面,**短按 C 键**选择“离线使用”。设备会记住这个选择,以后开机直接进入本地模式,不再反复打开配网页面。

离线模式仍可使用日历、内置考点、SD 卡内容、传感器和本地语音;天气、新闻、网络时间和云端服务需要 WiFi。以后进入二维码页长按 B 即可重新配置。

## 使用 SD 卡文件配置(备用方法)

只有需要通过文件配置时,才使用此方法:

1. 将 SD 卡格式化为 FAT32。
2. 在 SD 卡**根目录**放置一个文件,文件名必须是 `config.ini`。
3. 可以复制仓库中的 [`config.ini.example`](../config.ini.example) 作为模板。
4. Windows 需要打开“显示文件扩展名”,确认文件不是 `config.ini.txt`。
5. 至少填写以下两行,然后保存、弹出 SD 卡、插入设备并重启:

```ini
use_wifi=true
wifi_ssid=你的WiFi名称
wifi_pass=你的WiFi密码
```

SSID 和密码必须替换成实际内容。文件不能叫 `wifi.ini`、`config.txt`,也不能放在 `config/` 子目录中。

## SD 卡内容目录

SD 卡不是烧录固件的必要条件,但自定义内容需要它:

```text
SD卡根目录/
├── config.ini
├── cards/ # 自定义考点卡片
├── qr/ # png / jpg / bmp 二维码图片
├── voice/ # 语音文件
├── todo.txt # 语音待办文字
└── reminders.txt # 定时提醒
```

SD 卡没有插好时,设备仍可使用手机配网和内置功能;只是无法读取这些自定义文件。

## M5Burner 说明

M5Burner 只负责烧录固件,不会自动读取电脑 WiFi,也不会替用户生成 SD 卡上的 `config.ini`。烧录后请优先使用上面的手机配网流程。
1 change: 1 addition & 0 deletions platformio.ini
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ lib_deps =
m5stack/M5GFX @ ^0.2.7
bblanchon/ArduinoJson @ ^7.0.0
adafruit/Adafruit NeoPixel @ ^1.10.0
ricmoo/QRCode @ ^0.0.1
Loading
Loading