Skip to content

Add additional notes for building on macOS #219

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

Open
nic0lette wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add additional notes for building on macOS #219

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90fb0e5
Add additional notes for building on macOS
nic0lette Aug 17, 2025
057f0ac
Update IDF version + location.
nic0lette Aug 25, 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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,20 @@ Alternatively, to flash a badge:

where /dev/ttyACM0 is the device's endpoint. This value is correct on Linux.

### macOS

> [!IMPORTANT]
> On macOS, Docker does not have access to the host's USB devices. You will need to use a different method to flash the badge, such as [using the web flasher](flasher/README.md).

[UTM](https://getutm.app/), using QEMU as the virtualization backend, is an effective way to build and flash the badge.

Before attempting to flash the badge, but after booting the badge into the bootloader, share the USB device from the host
to the QEMU container using the USB devices button on the VM's frame.

The command to flash the badge using docker must be slightly modified on macOS:

docker run -it --rm --device /dev/ttyACM0:/dev/ttyUSB0 --group-add keep-groups --env "TARGET=esp32s3" -v "$(pwd)"/:/firmware ghcr.io/emfcamp/esp_idf:v5.2.1 deploy

## Contributing

Please install pre-commit to ensure ruff is run:
Expand Down
Loading