Skip to content

Improve firmware flashing docs #174

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

Draft
gwennlbh wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Improve firmware flashing docs #174

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc0a9a6
improve firmware flashing docs
gwennlbh Jun 5, 2025
2241c4d
fix formatting blunder
gwennlbh Jun 5, 2025
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
20 changes: 19 additions & 1 deletion firmware/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To flash the firmware without admin rights, make sure your local user is part of
```bash
sudo usermod -a -G dialout $USER
```
You need to reboot your computer for this change to take effect.
You need to reboot your computer for this change to take effect, or run `newgrp dialout` to enter a shell where the group has been added to your user

The master board need to be connected to a host computer via the PROG connector, and to be powered from a DC source from 5V to 60V. The programmer is a simple USB to SERIAL adapter with line RTS and DTR accessible.

Expand Down Expand Up @@ -77,5 +77,23 @@ git submodule update --init --recursive
Then, from the `master-board/firmware` folder, you can run:

* Flash the board: `make flash`

The baud rate is assumed to be 2M by default, but the ESP32 dev board might be configured to a different rate, resulting in a timing error:

```
$ make flash
Changing baud rate to 2000000
Changed.
Configuring flash size...

A fatal error occurred: Timed out waiting for packet header
```

you can change it to e.g. 115200 with the `ESPBAUD` environment variable:

```
ESPBAUD=115200 make flash
```

* Change configurations: `make menuconfig`
* Debug the board: `make monitor`