From aadbeca6d7d907f60e76836057527b5352e52a00 Mon Sep 17 00:00:00 2001 From: wulu Date: Thu, 1 Oct 2026 10:18:57 +0800 Subject: [PATCH] docs: unify microSD card terminology --- README.md | 4 ++-- README.zh-CN.md | 4 ++-- docs/devices.md | 4 ++-- docs/verification.md | 2 +- firmware/README.md | 2 +- firmware/targets/waveshare_epaper_397/README.md | 2 +- firmware/targets/waveshare_rlcd_42/README.md | 10 +++++----- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9dacdd7..96f601b 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,9 @@ The data source handles account sign-in and usage retrieval. Bridge sends only u | --- | --- | --- | | Waveshare AMOLED 2.16 | 480×480 AMOLED | Touchscreen, clock screensaver, auto-rotation | | M5StickS3 | 135×240 LCD | Button navigation, compact size | -| Waveshare ePaper 3.97 | 800×480 e-paper with four grayscale levels | Temperature and humidity, usage trends (SD card required) | +| Waveshare ePaper 3.97 | 800×480 e-paper with four grayscale levels | Temperature and humidity, usage trends (microSD card required) | | ESP-Mosaico | 480×480 AMOLED | Touchscreen, AI button, auto-rotation | -| Waveshare RLCD 4.2 | 400×300 monochrome reflective LCD | KEY / BOOT navigation, clock, usage trends (TF card required) | +| Waveshare RLCD 4.2 | 400×300 monochrome reflective LCD | KEY / BOOT navigation, clock, usage trends (microSD card required) | All devices support Codex / Claude usage display, retain the last usage data when disconnected, and support firmware updates over Bluetooth. See the [device guide](docs/devices.md) for a full feature comparison and control shortcuts. diff --git a/README.zh-CN.md b/README.zh-CN.md index 5cb379c..c806834 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -29,9 +29,9 @@ flowchart LR | --- | --- | --- | | Waveshare AMOLED 2.16 | 480×480 AMOLED | 触屏、时钟屏保、自动旋转 | | M5StickS3 | 135×240 LCD | 按键翻页、小尺寸 | -| Waveshare ePaper 3.97 | 800×480 四灰阶墨水屏 | 温湿度、用量趋势（需 SD 卡） | +| Waveshare ePaper 3.97 | 800×480 四灰阶墨水屏 | 温湿度、用量趋势（需 microSD 卡） | | ESP-Mosaico | 480×480 AMOLED | 触屏、AI 键、自动旋转 | -| Waveshare RLCD 4.2 | 400×300 黑白反射式 LCD | KEY / BOOT 翻页、时钟、用量趋势（需 TF 卡） | +| Waveshare RLCD 4.2 | 400×300 黑白反射式 LCD | KEY / BOOT 翻页、时钟、用量趋势（需 microSD 卡） | 所有设备均支持 Codex / Claude 用量显示、断连保留最后用量与蓝牙固件更新。完整功能对照及快捷操作见[设备说明](docs/devices.md)。 diff --git a/docs/devices.md b/docs/devices.md index d6cb7a6..3314602 100644 --- a/docs/devices.md +++ b/docs/devices.md @@ -17,7 +17,7 @@ | 摇动 / 翻转唤醒 | ✅ | — | — | ✅ | | 屏上设置页 | ✅ 亮度、自动时钟超时 | — 亮度仅 menuconfig | ✅ 刷新间隔、屏幕方向 | ✅ 亮度、自动时钟超时 | | 温湿度显示 | — | — | ✅ 时钟页 | — | -| 用量趋势（48 点 / 30 分钟） | — | — | ✅ 需 FAT SD 卡 | — | +| 用量趋势（48 点 / 30 分钟） | — | — | ✅ 需 FAT microSD 卡 | — | | 托盘/菜单栏左键切换时钟（`screen.toggle.v1`） | ✅ | — | ✅ | ✅ | | 滚轮翻页（`screen.page.v1`） | ✅ | ✅ | ✅ | ✅ | | BLE OTA（`ota.folder.v1`） | ✅ | ✅ | ✅ | ✅ | @@ -27,7 +27,7 @@ ePaper 3.97 与 ESP-Mosaico 的详细说明见 [ePaper 3.97 固件说明](../firmware/targets/waveshare_epaper_397/README.md) 与 [ESP-Mosaico 固件说明](../firmware/targets/esp_mosaico/README.md)。 -RLCD 4.2 使用 400×300 黑白反射式 LCD，提供总览、Codex / Claude 详情、趋势、时钟和设置页；竖屏仅在总览和时钟间轮换。它支持 RTC、温湿度显示、电压估算电量，以及需 FAT TF 卡的 48 点趋势。屏幕方向由设置选择，未接入 Web 烧录器。当前实机验证范围和完整操作见 [RLCD 4.2 说明](../firmware/targets/waveshare_rlcd_42/README.md)。 +RLCD 4.2 使用 400×300 黑白反射式 LCD，提供总览、Codex / Claude 详情、趋势、时钟和设置页；竖屏仅在总览和时钟间轮换。它支持 RTC、温湿度显示、电压估算电量，以及需 FAT microSD 卡的 48 点趋势。屏幕方向由设置选择，未接入 Web 烧录器。当前实机验证范围和完整操作见 [RLCD 4.2 说明](../firmware/targets/waveshare_rlcd_42/README.md)。 ## 屏幕快捷操作 diff --git a/docs/verification.md b/docs/verification.md index 40a0b32..4af5683 100644 --- a/docs/verification.md +++ b/docs/verification.md @@ -15,7 +15,7 @@ macOS 的 M5 配对、加密连接、用量和菜单操作已有验证；当前安装包的完整新用户路径，以及各目标的 macOS OTA 仍需验收。 -RLCD 4.2 已验证一块开发板的横屏主页、详情页用量显示和已绑定 Bridge 的加密重连；首次配对、OTA、竖屏/翻转、按键、传感器、音频及 TF 卡仍待实机验证。详见[目标说明](../firmware/targets/waveshare_rlcd_42/README.md)。 +RLCD 4.2 已验证一块开发板的横屏主页、详情页用量显示和已绑定 Bridge 的加密重连；首次配对、OTA、竖屏/翻转、按键、传感器、音频及 microSD 卡仍待实机验证。详见[目标说明](../firmware/targets/waveshare_rlcd_42/README.md)。 ## 性能与显示参考 diff --git a/firmware/README.md b/firmware/README.md index b5eace1..32fee33 100644 --- a/firmware/README.md +++ b/firmware/README.md @@ -70,7 +70,7 @@ eim run "idf.py -C firmware/targets/ merge-bin -o " v6.1 M5GFX 的 SPI 兼容包装位于 `targets/m5sticks3/main/m5gfx_spi_compat.c`，将未初始化的 DMA burst 值归一化为驱动默认值；升级依赖时需复核包装与实机显示。 -AMOLED 2.16 使用 16 MB Flash、Octal PSRAM、4 MB App 分区和 BSP 2.0.1，利用 QMI8658、PCF85063 与 AXP2101 实现动作唤醒、时钟和电源遥测；音频与 SD 卡未纳入产品功能。 +AMOLED 2.16 使用 16 MB Flash、Octal PSRAM、4 MB App 分区和 BSP 2.0.1，利用 QMI8658、PCF85063 与 AXP2101 实现动作唤醒、时钟和电源遥测；音频与 microSD 卡未纳入产品功能。 ## 分区表与 OTA 准备 diff --git a/firmware/targets/waveshare_epaper_397/README.md b/firmware/targets/waveshare_epaper_397/README.md index 477518d..32a9e5a 100644 --- a/firmware/targets/waveshare_epaper_397/README.md +++ b/firmware/targets/waveshare_epaper_397/README.md @@ -60,7 +60,7 @@ security prompts and physical refresh requests bypass this interval. A local redraw does not trigger a new provider fetch on the Bridge. The shared protocol currently publishes usage from the host and has no device-to-host fetch request. RTC time remains `--:--` until the stored calendar is valid. -The trend requires a mounted FAT SD card; absence is nonfatal. Samples are +The trend requires a mounted FAT microSD card; absence is nonfatal. Samples are stored every 30 minutes with up to 48 timestamped records and a replacement backup. At boot, `trend.bak` is loaded when `trend.bin` is missing or contains an invalid record. Missing intervals are not interpolated. An empty trend page remains diff --git a/firmware/targets/waveshare_rlcd_42/README.md b/firmware/targets/waveshare_rlcd_42/README.md index b569b32..87a851b 100644 --- a/firmware/targets/waveshare_rlcd_42/README.md +++ b/firmware/targets/waveshare_rlcd_42/README.md @@ -11,7 +11,7 @@ eim run "idf.py -C firmware/targets/waveshare_rlcd_42 -p flash" v6.1 Evidence level: **partial hardware**. The firmware and `test_apps/logic` compile with ESP-IDF v6.1, and the logic tests pass on a host build. On one board, the landscape Home and detail pages rendered live usage from a bonded Bridge, which reconnected with an encrypted link after -flashing. Portrait and flipped layouts, button debounce, sensors, audio, TF card, first-time +flashing. Portrait and flipped layouts, button debounce, sensors, audio, microSD card, first-time pairing and OTA have not been exercised on hardware. The device advertises as `QF-WS-S3-R42-` followed by the final two Bluetooth MAC bytes and @@ -49,7 +49,7 @@ The display uses the same SHORT / WEEK labels and used-percentage meaning as the | --- | --- | | Home | Both services stacked; SHORT and WEEK usage bars with reset countdowns and elapsed-time markers | | Codex, Claude | One service: the SHORT window in 80 px figures with its RESET countdown, then SHORT and WEEK sections each with a usage bar, elapsed-time marker and elapsed time. OVER +N% marks usage at least 5 percentage points above the elapsed fraction of the window | -| Trend | Last 24 hours from the TF card, 48 half-hour bars per service | +| Trend | Last 24 hours from the microSD card, 48 half-hour bars per service | | Clock | Time with seconds, date, SHTC3 temperature and humidity, compact usage bars | | Settings | Auto cycle, alert mode, seconds, rotation | | Alert | Full-screen inverted page once a short window reaches 95 %; NEAR LIMIT below 100 %, EXHAUSTED at 100 % | @@ -105,7 +105,7 @@ are recorded in [UPSTREAM.md](UPSTREAM.md). | I2C | SDA 13, SCL 14: PCF85063 0x51, SHTC3 0x70, ES8311 0x18 | | Keys | KEY 18, BOOT 0, active low | | Battery | GPIO4 / ADC1 channel 3 through a 1:3 divider | -| TF card | SDMMC 1-bit: CLK 38, CMD 21, D0 39 | +| microSD card | SDMMC 1-bit: CLK 38, CMD 21, D0 39 | | Speaker | I2S MCLK 16, BCLK 9, WS 45, DOUT 8; amplifier enable 46 | The ST7305 initialization sequence and pixel layout come from the Waveshare @@ -114,7 +114,7 @@ The battery percentage is a linear voltage proxy between 3.0 V and 4.12 V; the board has no fuel gauge or charger status, so the OTA battery gate is not registered (the voltage cannot distinguish battery from USB power). -The trend requires a mounted FAT TF card; absence is nonfatal. Its record format matches the +The trend requires a mounted FAT microSD card; absence is nonfatal. Its record format matches the ePaper 3.97 target: up to 48 timestamped records in `trend.bin`, with `trend.bak` used when the primary file is missing, empty, truncated, oversized, unreadable or contains an invalid record. Sampling starts only after a Bridge publication supplies a valid epoch. Until then, the trend @@ -129,7 +129,7 @@ are not used as the current time. self-heating, which this firmware does not apply until measured. - Battery percentage on battery and on USB power. - ES8311 tone level and amplifier noise. -- TF card mount, trend persistence and backup recovery. +- microSD card mount, trend persistence and backup recovery. - Pairing, reconnect, usage rendering with a real Bridge, and OTA with physical confirmation. ## Glyphs and preview