This project implements the Madwick attitude estimation algorithm. The focus of this repository is high quality documentation. The repo structure is:
.
├── docs # Documentation for the project
├── examples # Example usage code for PC and Arduino
├── scripts # Scripts for setup and supporting work
├── src # Source code
└── test # Test cases
The recommended order to read the documentation is
graph LR
E(SRS) --> D
D(VnV Plan) --> C
C(MG) --> B
B(MIS) --> A(VnV Report)
See INSTALL.md for details on how to install and get started with this project on your own computer.
Use the provided ./build.sh
to build a release version of attitude check.
To clean the build output run ./build.sh clean
.
To build and run unit tests, including code coverage reports run ./build.sh test
.
The Arduino examples are written for the SparkFun Razor 9dof IMU. However, the usage should be
clear for other boards. See the #include
s for the libraries you will need to install.
See CONTRIBUTING.md for details on how to contribute to this project.
This section will be updated to inform potential users of known issues and common solutions.
- Arduino doesn't like Real C++ code, other boards may not like using the ArduinoEigen library.