3d7dcc286e
* Add indexer * Add python and get_env.py * Add submodules: recursive * Fix build.yml * fix upload * Upgrade nodejs action |
||
---|---|---|
.github/workflows | ||
components | ||
main | ||
scripts | ||
.clang-format | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
CMakeLists.txt | ||
LICENSE | ||
README.md | ||
partitions.csv | ||
sdkconfig |
README.md
Black Magic Probe for ESP32-S2
WiFi/USB capable version of the famous Black Magic Probe debugger.
Clone the Repository
Clone the repository with:
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 v4.4 following Espressif's instructions. 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:
idf.py build
Note: the
sdkconfig
file already configures the project to target the ESP32-S2. You don't need to runidf.py set-target esp32s2
, which will overwrite some of the necessary settings insdkconfig
.
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 on how to find the port name.
Run:
idf.py -p <port> flash
Test with ESP-IDF
Connect to the dev board with:
idf.py -p <port> monitor
You should not see errors in the logs if the firmware is installed and running correctly.
Web interface development
Web interface is located in components/svelte-portal
and written in Svelte. To build it, you need to install Node.js and run npm install
in components/svelte-portal
directory. Then you can run npm run dev
to start development server or npm run build
to build production version.
Typical workflow is to fix the board's IP address in components/svelte-portal/src/App.svelte
and then run npm run dev
. After that, you can open http://localhost:5000
in your browser and see changes in the web interface in real time with live reload.
When you're done, you need to run npm run build
, idf.py build
and then idf.py -p <port> flash
. You can then open http://blackmagic.local
in your browser and see the changes in the web interface.