24 lines
591 B
Markdown
24 lines
591 B
Markdown
# HyperLink_SW
|
|
|
|
Firmware for the HyperLink project.
|
|
|
|
## Build and run
|
|
|
|
This project is built using the
|
|
[ESP IDF](https://docs.espressif.com/projects/esp-idf/en/release-v5.1/esp32/index.html)
|
|
toolchain. In order to ease the build process, a custom `Dockerfile` is
|
|
provided. Any ESP IDF toolchain command can be run by replacing `idf.py` by
|
|
`./idf.sh`, e.g., `./idf.sh build`.
|
|
|
|
Before the executing the following commands, make sure the docker daemon is
|
|
running:
|
|
|
|
1. Build the project
|
|
```bash
|
|
$ ./idf.sh build
|
|
```
|
|
1. Flash the executable
|
|
```bash
|
|
$ ./idf.sh flash monitor
|
|
```
|