Skip to content

docs: 更新文档 #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AeBoPi merged 1 commit into from
Jul 8, 2026
Merged

docs: 更新文档 #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 20 additions & 2 deletions docs/assembly.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
- 连接线：杜邦线 6 根以上
- 供电：USB-C（调试期建议）或锂电池方案（推荐 `505060-2000mAh` + TP5000，用于长期使用）

## 2. 4.2寸 + ESP32-C3 Pro mini 开发板 推荐接线
## 2. 4.2寸 + ESP32-C3 / ESP32-S3 开发板推荐接线

如果你使用推荐方案（`epd_42_wsv2_ssd1683_c3_promini`），建议按下表接线：

### ESP32-C3 Pro mini（`epd_42_wsv2_ssd1683_c3_promini`）

| ESP32-C3 | 墨水屏 |
|----------|--------|
| `GPIO4` | `CLK / SCK` |
Expand All @@ -28,6 +30,21 @@
| `3V3` | `VCC` |
| `GND` | `GND` |

### ESP32-S3 N16R8 开发板（`epd_42_wsv2_ssd1683_yd_s3_n16r8`）

如果你使用 ESP32-S3 N16R8 开发板，请按 S3 固件环境的引脚定义接线：

| ESP32-S3 | 墨水屏 |
|----------|--------|
| `GPIO12` | `CLK / SCK` |
| `GPIO11` | `DIN / MOSI` |
| `GPIO10` | `CS` |
| `GPIO9` | `DC` |
| `GPIO8` | `RST` |
| `GPIO7` | `BUSY` |
| `3V3` | `VCC` |
| `GND` | `GND` |

## 3. 供电建议

### 开发与排障
Expand Down Expand Up @@ -67,7 +84,7 @@

这样即使出现黑屏或刷新异常，也能更快判断是供电问题还是信号线问题。

## 3. 首次上电检查
## 5. 首次上电检查

首次上电建议仅使用 USB 供电，不要同时接锂电池。检查项：

Expand Down Expand Up @@ -117,6 +134,7 @@
4. **屏幕模组丝印与想象中的脚位顺序不一致**

对于 ESP32-C3 推荐方案，请重点确认：`GPIO10` ↔ 屏幕 `BUSY`。
对于 ESP32-S3 N16R8 方案，请重点确认：`GPIO7` ↔ 屏幕 `BUSY`。

## 7. 下一步

Expand Down
20 changes: 19 additions & 1 deletion docs/en/assembly.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ This guide helps you complete basic assembly in 10-20 minutes.
- 6+ dupont wires
- USB-C data cable

## 2. Recommended wiring for 4.2-inch + ESP32-C3
## 2. Recommended wiring for 4.2-inch + ESP32-C3 / ESP32-S3

If you use the recommended build (`epd_42_wsv2_ssd1683_c3_promini`), wire it like this:

### ESP32-C3 Pro mini (`epd_42_wsv2_ssd1683_c3_promini`)

| ESP32-C3 | E-paper |
|----------|---------|
| `GPIO4` | `CLK / SCK` |
Expand All @@ -28,6 +30,21 @@ If you use the recommended build (`epd_42_wsv2_ssd1683_c3_promini`), wire it lik
| `3V3` | `VCC` |
| `GND` | `GND` |

### ESP32-S3 N16R8 dev board (`epd_42_wsv2_ssd1683_yd_s3_n16r8`)

If you use the ESP32-S3 N16R8 dev board, wire it according to the S3 firmware profile:

| ESP32-S3 | E-paper |
|----------|---------|
| `GPIO12` | `CLK / SCK` |
| `GPIO11` | `DIN / MOSI` |
| `GPIO10` | `CS` |
| `GPIO9` | `DC` |
| `GPIO8` | `RST` |
| `GPIO7` | `BUSY` |
| `3V3` | `VCC` |
| `GND` | `GND` |

## 3. Power guidance

### Development and debugging
Expand Down Expand Up @@ -119,6 +136,7 @@ Check these first:
4. **the module silk labels do not match your assumed pin order**

For the recommended ESP32-C3 build, the critical path is: `GPIO10` ↔ display `BUSY`.
For the ESP32-S3 N16R8 build, the critical path is: `GPIO7` ↔ display `BUSY`.

## 6. Next Step

Expand Down
17 changes: 16 additions & 1 deletion docs/en/hardware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ The most recommended and best-supported combination today is:
To accommodate different developers, we provide pre-compiled firmware in our Releases for various boards and screens. The main supported MCUs include:
1. **ESP32-C3 Pro mini**: Compact size, native USB CDC (firmware suffix typically contains `c3_promini`).
2. **ESP32-C3 Standard Board**: Features a dedicated serial chip (like CH340) for more stable serial debugging (firmware suffix typically contains `c3_std`).
3. **ESP32-WROOM-32E**: The classic standard ESP32 development board (firmware suffix typically contains `wroom32e`).
3. **ESP32-S3 N16R8 dev board**: A 4.2-inch option for larger Flash / PSRAM builds (firmware environment: `epd_42_wsv2_ssd1683_yd_s3_n16r8`).
4. **ESP32-WROOM-32E**: The classic standard ESP32 development board (firmware suffix typically contains `wroom32e`).

Why the **4.2-inch screen** paired with the **ESP32-C3 series** is recommended as the first choice:
- screenshots and product docs are centered on the 4.2-inch version
Expand Down Expand Up @@ -85,6 +86,20 @@ The current pin definitions are implemented in: `firmware/src/config.h`
| Config button | `GPIO9` |
| LED | `GPIO3` |

### ESP32-S3 N16R8 profile

| Function | Pin |
|----------|-----|
| MOSI | `GPIO11` |
| SCK | `GPIO12` |
| CS | `GPIO10` |
| DC | `GPIO9` |
| RST | `GPIO8` |
| BUSY | `GPIO7` |
| Lithium battery ADC | `GPIO4` |
| Config button | `GPIO0` |
| Onboard RGB LED | `GPIO48` |

### ESP32-WROOM32E profile

| Function | Pin |
Expand Down
17 changes: 16 additions & 1 deletion docs/hardware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
为了方便不同开发者，我们在 Release 中提供了适配多种开发板的预编译固件。主要支持以下主控：
1. **ESP32-C3 Pro mini**：体积小巧，原生 USB CDC（固件后缀常带 `c3_promini`）。
2. **ESP32-C3 标准板**：带独立串口芯片（如 CH340），串口调试更稳定（固件后缀常带 `c3_std`）。
3. **ESP32-WROOM-32E**：经典的 ESP32 标准开发板（固件后缀常带 `wroom32e`）。
3. **ESP32-S3 N16R8 开发板**：适合需要更大 Flash / PSRAM 的 4.2 寸方案（固件环境为 `epd_42_wsv2_ssd1683_yd_s3_n16r8`）。
4. **ESP32-WROOM-32E**：经典的 ESP32 标准开发板（固件后缀常带 `wroom32e`）。

推荐以 **4.2 寸屏幕** 搭配 **ESP32-C3 系列开发板** 作为首选方案的原因：
- 资料、文档、配置页预览都优先围绕 4.2寸版本展开
Expand Down Expand Up @@ -84,6 +85,20 @@
| 配置按键 | `GPIO9` |
| LED | `GPIO3` |

### ESP32-S3 N16R8 Profile

| 功能 | 引脚 |
|------|------|
| MOSI | `GPIO11` |
| SCK | `GPIO12` |
| CS | `GPIO10` |
| DC | `GPIO9` |
| RST | `GPIO8` |
| BUSY | `GPIO7` |
| 锂电池 ADC | `GPIO4` |
| 配置按键 | `GPIO0` |
| 板载 RGB LED | `GPIO48` |

### ESP32-WROOM32E Profile

| 功能 | 引脚 |
Expand Down
Loading