Skim through the Repo Overview section, then jump to the bottom for a treasure hunt activity!
Repo Overview
- firmware/: The main firmware for the CTS-SAT-1 OBC, which runs on the STM32-based Onboard Computer.
- This is the most important part, by far.
- docs/: Hand-written documentation (mostly guides) for the software components of the projects.
firmware/ Organization
The firmware/ folder contains the main firmware for the CTS-SAT-1 OBC. It is organized as follows:
- Core/Inc/ has the header files (.h files) for the firmware.
- Core/Src/ has the source files (.c files) for the firmware.
- main.c is the entry point for the firmware. Do not edit it (much).
- rtos_tasks/rtos_tasks.c contains the main FreeRTOS tasks (each is a while(1) loop that takes turns with the other tasks).
- For Core/Inc/ and Core/Src/:
- Each subsystem has its own folder.
- Each C file has an associated header file with the same name.
Treasure Hunt Activity
- Find where the unit tests are stored.
- Find the documentation that explains unit tests.
- Find where the telecommand list is stored.
- Find the documentation that explains the telecommand format, with examples.
- Find the driver to deploy the deployable antenna. Find the associated telecommand.
Tips for Navigating in VS Code
- Use Ctrl+P to open a pane to type in a filename. Use arrow keys and Enter to navigate.
- Use Ctrl+Shift+F to search for a string in all files.