Compare commits

...

2 Commits

Author SHA1 Message Date
3a380f9b97 Modify idf.sh and update README.md 2024-03-02 15:38:22 +01:00
44e38aa03d Remove sdkconfig from gitignore 2024-03-02 15:30:08 +01:00
4 changed files with 1874 additions and 33 deletions

1
.gitignore vendored
View File

@ -3,7 +3,6 @@
# https://github.com/espressif/esp-idf
build/
sdkconfig
sdkconfig.old
.idea

View File

@ -1,38 +1,23 @@
# HyperLink_SW
Firmware for the HyperLink board.
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`,
after having built the docker image.
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`.
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.
Before the executing the following commands, make sure the docker daemon is
running:
1. Build the docker image
```bash
$ sudo docker build . --tag hyperlink
```
2. Compile the project
1. Build the project
```bash
$ ./idf.sh build
```
3. Flash the executable
1. Flash the executable
```bash
$ ./idf.sh flash
$ ./idf.sh flash monitor
```
## Misc
### CLion Docker Setup
To configure the project to be built with docker in CLion, create a new docker
toolchain with the following settings:
![image](doc/CLion_docker_settings_screenshot.png)

2
idf.sh
View File

@ -35,4 +35,4 @@ done
#
docker run ${DEVICE_FLAGS} --rm --user $(id -u):${USB_GID} -v $PWD:/project -w /project -it hyperlink idf.py $@
docker build . && docker run ${DEVICE_FLAGS} --rm --user $(id -u):${USB_GID} -v $PWD:/project -w /project -it $(docker build . -q) idf.py $@

1857
sdkconfig Normal file

File diff suppressed because it is too large Load Diff