Getting Started
To help future developers to join the project, this page shares how the embedded SwarmUS team set up its development environment.
IDE
Info
This setup is not the only one that could be used and you can use your favourite tools.
Since the embedded project is written in C and C++, the SwarmUS team decided to use the CLion IDE in Linux. Furthermore, this IDE has a plug-in for the OpenOCD debugger used in the project and has a lot of support for STM32 and Xtensa MCUs that can be found on the HiveBoard. So the first step of this guide will be to download this IDE.
Attention
The CLion IDE is inherently not free. However, there is a free version for students.
Install repositories and dependencies
The embedded parts of the SwarmUS project include the HiveMind software that runs on a STM32H7 and the HiveConnect that runs on an ESP-32. Before configuring the IDE, clone both of the repositories and install and set up all the required packages as described in HiveMind's readme and HiveConnect's readme. Make sure that you can build the two repositories before moving on to building the repositories in CLion.
Once done, the next step is to configure CLion for the repository you want to work on: HiveMind or HiveConnect. Since a part of debugging is done via the serial port of the MCUs, an additional section is given to set up the logging of those channels in CLion