mirrors
/
blackmagic-esp32-s2
mirror of https://github.com/flipperdevices/blackmagic-esp32-s2.git
1
0
Fork 0
Code Releases Wiki Activity

[readme] Add instructions on flashing firmware from source (#8) 

Add instructions to the readme that cover: cloning the repo and submodules, setting up ESP-IDF, building from source, flashing, and basic testing.
This commit is contained in:
James Ide 2022-06-02 06:19:49 -07:00 committed by GitHub
parent 577fb87212
commit d844e41d3b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,3 +1,42 @@
# Black Magic Probe for ESP32-S2
WiFi/USB capable version of the famous Black Magic Probe debugger.
# Clone the Repository
Clone the repository with:
```shell
git clone --recursive https://github.com/flipperdevices/blackmagic-esp32-s2.git
```
You must recursively clone the submodules, which `--recursive` will do for you. When you pull new changes, be sure to run `git submodule update --init --recursive`.
# Develop with ESP-IDF
Set up ESP-IDF following [Espressif's instructions](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html). Make sure `idf.py` is in your PATH and you can successfully run the program.
## Build with ESP-IDF
In your clone of this repository, run:
```shell
idf.py build
```
> Note: the `sdkconfig` file already configures the project to target the ESP32-S2. You don't need to run `idf.py set-target esp32s2`, which will overwrite some of the necessary settings in `sdkconfig`.
## Flash with ESP-IDF
Connect the dev board to your computer with a USB cable. Find the name of the serial port device on your computer that corresponds to the dev board. See the [Flipper Zero guide] on how to connect to the dev board over USB or [Espressif's guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/establish-serial-connection.html) on how to find the port name.
Run:
```shell
idf.py -p <port> flash
```
## Test with ESP-IDF
Connect to the dev board with:
```shell
idf.py -p <port> monitor
```
You should not see errors in the logs if the firmware is installed and running correctly.