README.md
FIRM

Filtered Inertial Rotation Module

FIRM is a project by the NCSU High Powered Rocketry Club to develop a flight computer for high powered rockets. The flight computer is designed to provide accurate attitude and position data during flight using an array of sensors and advanced filtering algorithms.

It is also designed to be modular and easily adaptable to different rocket configurations and mission requirements. The project will also have a custom PCB design to integrate all the components into a compact and lightweight package suitable for high-speed flight.

Hardware Components

The components used in this project include:




  
Part Number
  
Description
  
Datasheet Link




  
ICM-45686
  
6 Axis IMU
  
<![CDATA[]]>Datasheet<![CDATA[]]>


  
STM32F405RGT6
  
Microcontroller
  
<![CDATA[]]>Datasheet<![CDATA[]]>


  
MMC5983MA
  
Magnetometer
  
<![CDATA[]]>Datasheet<![CDATA[]]>


  
BMP581
  
Pressure Sensor
  
<![CDATA[]]>Datasheet<![CDATA[]]>




Project Setup

To set up the project, follow these steps (assuming you have Git/Github Desktop, and <![CDATA[]]>uv<![CDATA[]]> installed):


Clone the repository:


git clone https://github.com/NCSU-High-Powered-Rocketry-Club/FIRM.git



Download the STM32CubeCLT from the <![CDATA[]]>STMicroelectronics website<![CDATA[]]> and install it on your machine.
Install the <![CDATA[]]>STM32 VS Code Extension<![CDATA[]]>.
Open the STM32 folder of the repo in VS Code and use the extension to import the folder with the
"Import CMake project" button.
Configure your workspace by accepting the default settings from the pop-up messages in VS Code.
Click the "Build" button on the bottom status bar to build the project.
Run uv sync.
Run uv run pre-commit install to set up the git hook for automatic code formatting, using clang-format.


KiCad Files

The KiCad files are located in the KiCad directory. To open the project, open the FIRM.kicad_pro file using KiCad.

Custom symbols, footprints, and 3D models

We have a custom library for symbols, footprints, and 3D models.

You can find the symbols under KiCad/symbols. Every individual component's symbol should go into its respective directory, e.g. the ICM-45686's symbol goes under sensors/. You must also add that symbol to the project library, e.g. in KiCad/symbols/sensors.kicad_sym (i.e. open Symbol Editor, enter the "sensors" library, then click "File" > "Import" > "Symbol" to add the new symbol to the project library).

You can find the footprints under KiCad/footprints. Every individual component footprint should go into its respective directory, e.g. the ICM-45686's footprint goes under sensors.pretty/.

3D models go under KiCad/3dmodels. The 3D models are then assigned to the footprints using the Footprint Editor in KiCad.

Building the project

If you are using STM32CubeIDE, you can build the project by clicking on the hammer icon or by going to Project > Build All.

Third party licenses

Contains FATFS changes from <![CDATA[]]>https://github.com/MathewMorrow/STM32-SD-Logging-DMA<![CDATA[]]> (MIT Licensed)