Visit the STMicroelectronics website to obtain the latest IDE. The download page can be found here. Navigate to the Get Software section and choose the appropriate download for your operating system.
If you have never used Git you will probably need to Install it first. If you are using Windows you will want to open Git Bash, for Mac and Linux you can just open a terminal session.
Once you have your terminal session open navigate to a folder you wish you download the repository too. For example:
cd ~/Documents/Git
Once you are in the desired directory, use the following command to download the repository:
git clone https://github.com/KaiserEngineering/digital_dash_firmware.git
Note that the full project is not downloaded yet. The submodules still need to be downloaded.
Navigate to the repository folder that was just created. Use the git submodule init
command to initialize the submodules. This will only need to be performed the first time you clone the new project. Next, type git submodule update
to get the latest submodule changes. This should be done every time you open the project to ensure the latest firmware is being used.
git submodule init
git submodule update
With the development environment installed and the repository downloaded the code is ready to be compiled. Open STM32CubeIDE and navigate to file->import.... Expand the General folder and select Existing Projects into Workspace and click Next.
In the Select Root Directory input select Browse and select the repository that was downloaded in the previous steps. After selecting the project repository you should see the digital-dash-firmware
project, select it, and hit Finish to import the project.
Right-click on the top-level project (in this case digital-dash-firmware) and select Build Project. There should be no errors while compiling the project.
After successfully being compiled the hex file will be in the project output folder, for example, a debug build will be:
digital-dash-firmware\Debug\digital-dash-firmware.hex
If a release build is compiled:
digital-dash-firmware\Release\digital-dash-firmware.hex
Copy the digital-dash-firmware.hex
file to the boot directory of the Digital Dash. On boot, the Digital Dash will search for the hex file and reflash the board if present.