38 lines
1.0 KiB
Markdown
38 lines
1.0 KiB
Markdown
# HyperLink_SW
|
|
|
|
Firmware for the HyperLink board.
|
|
|
|
## 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`,
|
|
after having built the docker image.
|
|
|
|
As the docker container has to be able to access the serial device for flashing,
|
|
some configuration may have to take place.
|
|
Make sure the `USB_GUID` and `USB_DEV` in `idf.py` have the correct values.
|
|
|
|
1. Build the docker image
|
|
```bash
|
|
$ sudo docker build . --tag hyperlink
|
|
```
|
|
|
|
2. Compile the project
|
|
```bash
|
|
$ ./idf.sh build
|
|
```
|
|
|
|
3. Flash the executable
|
|
```bash
|
|
$ ./idf.sh flash
|
|
```
|
|
|
|
## Misc
|
|
|
|
### CLion Docker Setup
|
|
|
|
To configure the project to be built with docker in CLion, create a new docker
|
|
toolchain with the following settings:
|
|
|
|
 |