Skip to content

Commit 90fb0e5

Browse files
committed
Add additional notes for building on macOS
1 parent 769c66e commit 90fb0e5

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,20 @@ Alternatively, to flash a badge:
5050

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

53+
### macOS
54+
5355
> [!IMPORTANT]
5456
> 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).
5557
58+
[UTM](https://getutm.app/), using QEMU as the virtualization backend, is an effective way to build and flash the badge.
59+
60+
Before attempting to flash the badge, but after booting the badge into the bootloader, share the USB device from the host
61+
to the QEMU container using the USB devices button on the VM's frame.
62+
63+
The command to flash the badge using docker must be slightly modified on macOS:
64+
65+
docker run -it --rm --device /dev/ttyACM0:/dev/ttyUSB0 --group-add keep-groups --env "TARGET=esp32s3" -v "$(pwd)"/:/firmware matthewwilkes/esp_idf:5.2.1 deploy
66+
5667
## Contributing
5768

5869
Please install pre-commit to ensure ruff is run:

0 commit comments

Comments
 (0)