docs: add USB(JTAG) vs UART port guide for REPL usage

Add a detailed section to all three READMEs (EN, CN, JA) explaining
the difference between the USB (JTAG) and UART (COM) ports on
ESP32-S3 boards. Clarifies that the REPL CLI requires the UART port
and documents behavior when both ports are connected simultaneously.

Signed-off-by: Asklv <boironic@gmail.com>
This commit is contained in:
Asklv
2026-02-27 16:00:00 +08:00
parent 70cd1a0eb7
commit c46f78d88e
3 changed files with 87 additions and 0 deletions

View File

@@ -191,6 +191,35 @@ mimi> cron_start # start cron scheduler now
mimi> restart # reboot
```
### USB (JTAG) vs UART: Which Port for What
Most ESP32-S3 dev boards expose **two USB-C ports**. Understanding which to use is critical:
| Port | Label | Protocol | Use for |
|------|-------|----------|---------|
| **USB** | USB / JTAG | Native USB Serial/JTAG | `idf.py flash`, `idf.py monitor`, JTAG debugging |
| **COM** | UART / COM | External UART bridge (CP2102/CH340) | **REPL CLI**, serial console, `idf.py monitor` |
> **To use the REPL CLI, you must connect via the UART (COM) port**, not the USB (JTAG) port. The ESP-IDF console/REPL is configured to use UART by default (`CONFIG_ESP_CONSOLE_UART_DEFAULT=y`). The USB (JTAG) port provides secondary console output but does not support interactive REPL input reliably.
**If you have both ports connected simultaneously:**
- The USB (JTAG) port handles flash/download and provides a secondary serial output
- The UART (COM) port provides the primary interactive console for the REPL
- On macOS, both ports appear as `/dev/cu.usbmodem*` or `/dev/cu.usbserial-*` — check `ls /dev/cu.usb*` to identify them
- On Linux, USB (JTAG) typically shows as `/dev/ttyACM0` and UART as `/dev/ttyUSB0`
**Recommended workflow:**
```bash
# Flash via USB (JTAG) port
idf.py -p /dev/cu.usbmodem11401 flash
# Open REPL via UART (COM) port
idf.py -p /dev/cu.usbserial-110 monitor
# or use any serial terminal: screen, minicom, PuTTY at 115200 baud
```
## Memory
MimiClaw stores everything as plain text files you can read and edit:

View File

@@ -206,6 +206,35 @@ mimi> cron_start # 立即启动 cron 调度器
mimi> restart # 重启
```
### USB (JTAG) 与 UART哪个口做什么
大多数 ESP32-S3 开发板有 **两个 USB-C 口**,务必区分清楚:
| 端口 | 标注 | 协议 | 用途 |
|------|------|------|------|
| **USB** | USB / JTAG | 原生 USB Serial/JTAG | `idf.py flash``idf.py monitor`、JTAG 调试 |
| **COM** | UART / COM | 外置 UART 桥接芯片CP2102/CH340 | **REPL 命令行**、串口控制台、`idf.py monitor` |
> **使用 REPL 命令行必须连接 UARTCOM口**,而不是 USBJTAG口。ESP-IDF 控制台默认配置为 UART 输出(`CONFIG_ESP_CONSOLE_UART_DEFAULT=y`。USBJTAG口提供辅助串口输出但不能可靠地支持交互式 REPL 输入。
**同时连接两个口时:**
- USBJTAG口负责烧录/下载,并提供辅助串口输出
- UARTCOM口提供主要的交互式控制台用于 REPL
- macOS 下两个口都会显示为 `/dev/cu.usbmodem*``/dev/cu.usbserial-*`,用 `ls /dev/cu.usb*` 区分
- Linux 下 USBJTAG通常是 `/dev/ttyACM0`UART 通常是 `/dev/ttyUSB0`
**推荐工作流:**
```bash
# 通过 USBJTAG口烧录
idf.py -p /dev/cu.usbmodem11401 flash
# 通过 UARTCOM口打开 REPL
idf.py -p /dev/cu.usbserial-110 monitor
# 或使用任意串口工具screen、minicom、PuTTY波特率 115200
```
## 记忆
MimiClaw 把所有数据存为纯文本文件,可以直接读取和编辑:

View File

@@ -191,6 +191,35 @@ mimi> cron_start # cronスケジューラを今すぐ開始
mimi> restart # 再起動
```
### USBJTAGvs UARTどのポートで何をするか
ほとんどの ESP32-S3 開発ボードには **2つの USB-C ポート**があります。用途を正しく理解することが重要です:
| ポート | ラベル | プロトコル | 用途 |
|--------|--------|------------|------|
| **USB** | USB / JTAG | ネイティブ USB Serial/JTAG | `idf.py flash``idf.py monitor`、JTAGデバッグ |
| **COM** | UART / COM | 外部 UART ブリッジCP2102/CH340 | **REPL CLI**、シリアルコンソール、`idf.py monitor` |
> **REPL CLIを使用するには、UARTCOMポートに接続する必要があります。**USBJTAGポートではありません。ESP-IDFコンソールはデフォルトでUART出力に設定されています`CONFIG_ESP_CONSOLE_UART_DEFAULT=y`。USBJTAGポートは補助的なシリアル出力を提供しますが、対話的なREPL入力を確実にサポートしません。
**両方のポートを同時に接続している場合:**
- USBJTAGポートはフラッシュ/ダウンロードを処理し、補助シリアル出力を提供
- UARTCOMポートはREPL用のメインインタラクティブコンソールを提供
- macOS では両ポートとも `/dev/cu.usbmodem*` または `/dev/cu.usbserial-*` として表示 — `ls /dev/cu.usb*` で確認
- Linux では USBJTAGは通常 `/dev/ttyACM0`、UART は通常 `/dev/ttyUSB0`
**推奨ワークフロー:**
```bash
# USBJTAGポートでフラッシュ
idf.py -p /dev/cu.usbmodem11401 flash
# UARTCOMポートでREPLを開く
idf.py -p /dev/cu.usbserial-110 monitor
# または任意のシリアルターミナルscreen、minicom、PuTTYボーレート 115200
```
## メモリ
MimiClawはすべてのデータをプレーンテキストファイルとして保存します。直接読み取り・編集可能です