an.tsouchlos/hyperlink-sw
1
0
Fork 0
Code Issues Pull Requests 1 Actions Projects Releases Wiki Activity
Firmware for the HyperLink board.
8 Commits 5 Branches 0 Tags 180 KiB
C++ 72.9%
HTML 18.1%
Shell 4.5%
CMake 3.4%
Dockerfile 1.1%
da6a2d9d28
Go to file
Andreas Tsouchlos da6a2d9d28 Add nanofmt as submodule
2023-09-11 01:10:06 +02:00
components Add nanofmt as submodule 2023-09-11 01:10:06 +02:00
doc Add CLion conf instructions to README.md 2023-08-25 13:49:50 +02:00
main Add nanofmt as submodule 2023-09-11 01:10:06 +02:00
res Add first version of setup.html 2023-09-11 00:58:32 +02:00
.gitignore Add build dirs to gitignore 2023-09-10 23:23:56 +02:00
.gitmodules Add nanofmt as submodule 2023-09-11 01:10:06 +02:00
CMakeLists.txt Add helloworld project; Add Dockerfile and idf.sh; Update README.md 2023-08-25 12:16:18 +02:00
Dockerfile Add helloworld project; Add Dockerfile and idf.sh; Update README.md 2023-08-25 12:16:18 +02:00
idf.sh Modify idf.sh to automatically detect serial devices and GID 2023-08-28 22:36:59 +02:00
LICENSE Initial commit 2023-08-24 19:15:09 +00:00
README.md Add CLion conf instructions to README.md 2023-08-25 13:49:50 +02:00

README.md

HyperLink_SW

Firmware for the HyperLink board.

Build and run

This project is built using the ESP IDF 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

    $ sudo docker build . --tag hyperlink

  2. Compile the project

    $ ./idf.sh build

  3. Flash the executable

    $ ./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:

image