Skip to content

Commit 45c5d8f

Browse files
committed
update agent instruction
1 parent 4c5f093 commit 45c5d8f

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

CLAUDE.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,26 +53,30 @@ void loop() {
5353
}
5454
```
5555

56-
3) Visualize In Terminal (No GUI)
56+
3) Visualize In Terminal (Use only when trying to debug)
5757
- Auto‑detect port, auto‑configure from META:
5858
- `python3 tools/led_matrix_viz.py --list-ports`
5959
- `python3 tools/led_matrix_viz.py -p /dev/ttyACM? -b 115200 --stats --verbose`
6060
- If you don’t print META, pass flags: `--width/--height --input-order xy --wiring progressive --rotate ...`
6161
- Tips: `--ascii` for plain text, `--flip-x/--flip-y` for quick checks.
6262

63-
4) Build / Flash (ESP32‑S3)
64-
- In Arduino IDE: Tools → USB CDC On Boot = Enabled (prevents Serial from blocking).
63+
4) Build / Flash (ESP32‑S3) **IMPORTANT MAKE SURE TO FOLLOW**
64+
- use USB CDC On Boot = Enabled (prevents Serial from blocking) if you need to debug Serial.
6565
- Use the bundled CLI at `./bin/arduino-cli`:
6666
- First‑time setup (once):
6767
- `./bin/arduino-cli config init`
6868
- `./bin/arduino-cli core update-index`
69-
- `./bin/arduino-cli core install esp32:esp32`
69+
- Prepare the dependency for esp32
70+
- `./bin/arduino-cli config set network.connection_timeout 1000s` Increase the timeout for the big download, WARN USER this gonna take some time, possible (10-20min), so need to be patient.
71+
- `GODEBUG=http2client=0 ./bin/arduino-cli --log-level debug core install esp32:esp32` (Force HTTP/1.1 bypasses the flaky HTTP/2 path)
7072
- Compile (example: Snake):
7173
- `./bin/arduino-cli compile --fqbn esp32:esp32:esp32s3:CDCOnBoot=cdc examples/Snake`
7274
- Upload:
75+
- **IMPORTANT find the correct port by checking lsusb first**
7376
- `./bin/arduino-cli upload --fqbn esp32:esp32:esp32s3:CDCOnBoot=cdc --port /dev/ttyACM0 examples/Snake`
7477
- Monitor:
7578
- `./bin/arduino-cli monitor --port /dev/ttyACM0 --config baudrate=115200`
79+
- NOTE : you should not suggest user to use Arduino IDE to upload, they cli tool given to you should be very suffcient.
7680

7781
5) Proven Debug Workflow
7882
- Keep Serial optional: short wait, then guard prints with `if (Serial)`.
@@ -101,4 +105,3 @@ Repo Highlights
101105
DEBUGING ISSUES
102106
- when automatic upload fails, always ask for user to manual put device into bootloader mode, then wait for confirm before reflush again
103107
- MicroPython Board in FS mode is a pico device (which belong to the internal system), you should see ESP devie when you try lsusb, if not remind user to try replug in usb
104-
- if ./bin/arduino-cli core install dependency taking too long, you can extend the timeout via ./bin/arduino-cli config set network.connection_timeout 600s

0 commit comments

Comments
 (0)