Refactor CDH RTOS Codebase

[GrahamDrive]

Pull Request: Refactor CDH RTOS Codebase

Hello everyone,

If you're listed as a reviewer, it means either you contributed input or this change impacts your task.

Note: The terms "Thread" and "Task" are used interchangeably.

Problem

@Koloss0 pointed out that the CDH RTOS codebase is currently convoluted, as all the code resides in the main function of the project board. This structure makes it challenging for new members to navigate and understand the code when assigned to specific tasks within a given thread.

Solution

To address this, we’ve refactored the code by separating the threads from the main file into their own dedicated files. The code has been organized into a new directory structure, as shown below:

The top-level directory is named app, which contains both Inc and Src folders. These folders house various files as follows:

• bdot_algorithm
  Contains all application code related to the B Dot Algorithm, which the ADCS will work on.

• command_handling
  Contains application code for handling CAN messages and commands.

• deployment_tasks
  Contains application code related to deploying the antenna and other deployables on the satellite.

• rtc
  Contains tasks related to the Real-Time Clock (RTC).

• task_control
  Contains tasks for interacting with other tasks, such as starting timed tasks and retrieving the number of tasks.

• telemetry_handling
  Contains code for telemetry handling tasks.

• unit_tests
  Contains unit tests for the various peripherals.

Next Steps

Merging will not occur until testing with physical hardware is also complete.

[GrahamDrive]

Not a fan of these externs if people have suggestions lmk.

[Koloss0]

Looks good. I wrote down my thoughts on some minor things:

• consider renaming to App/
• what is the void *argument for?
• it's a matter of style, but 90% of what's in the .h files could be moved to the .c files (i.e. includes and externs). But psychologically I understand the desire to put dependencies in one file and implementation in the other. Personally I just put as much as I can in the implementation file until I get an error.
• People using STM32IDE will have to refresh their file explorer to see the new directory. (just letting you know)
• This PR includes a .vs/ directory into the NUCLEO project jsyk.
• Also some CMake files in the NUCLEO project. Not sure if that's on purpose.
• Looks like the build directory isn't in the gitignore of the NUCLEO project.

[GrahamDrive]

Idk why those CMAKES are even there I didn't modify or build that project.

[GrahamDrive]

Couldn't easily get rid of CMAKES giving up for this pull request.

[Koloss0]

😂 I understand your pain. You have to do it in a very specific way since it's already been committed. I'll see if I can remember how.

[Koloss0]

@GrahamDrive Fixed everything. I rebased the branch and deleted all the unnecessary commits so your branch will be out of sync and you'll have to do a reset.

This will reset to before the rebase. Note, all history proceeding it will be deleted, as well as any uncommitted changes.
git reset --hard be54371

You can then pull.
git pull

Now you might get an error like this. This is because Git behaves weirdly sometimes with capitalization.

error: The following untracked working tree files would be overwritten by merge:
        cdh-tsat-stm32project-board/App/Inc/bdot_algorithm.h
        cdh-tsat-stm32project-board/App/Inc/command_handling.h
        cdh-tsat-stm32project-board/App/Inc/deployment_tasks.h
        cdh-tsat-stm32project-board/App/Inc/rtc.h
        cdh-tsat-stm32project-board/App/Inc/task_control.h
        cdh-tsat-stm32project-board/App/Inc/telemetry_handling.h
        cdh-tsat-stm32project-board/App/Inc/unit_tests.h
        cdh-tsat-stm32project-board/App/Src/bdot_algorithm.c
        cdh-tsat-stm32project-board/App/Src/command_handling.c
        cdh-tsat-stm32project-board/App/Src/deployment_tasks.c
        cdh-tsat-stm32project-board/App/Src/rtc.c
        cdh-tsat-stm32project-board/App/Src/task_control.c
        cdh-tsat-stm32project-board/App/Src/telemetry_handling.c
        cdh-tsat-stm32project-board/App/Src/unit_tests.c
Please move or remove them before you merge.
Aborting

To fix it, delete the app/ folder from your file explorer. Then pull again.

Unfortunately, I think this error will likely occur for anyone who updates to the new folder name. So they will have to use the fix above as well.

[GrahamDrive]

Awesome thanks @Koloss0!