generated from TDD-Templates/cmake_cpputest_template
Written for Bailey Fait. An embedded system that makes use of LoRa and compass modules to direct the modules towards eachother.
| .template_files | ||
| build | ||
| docs | ||
| inc | ||
| mocks | ||
| src | ||
| tests | ||
| .clang-format | ||
| .gitignore | ||
| .gitmodules | ||
| CMakeLists.txt | ||
| compile_commands.json | ||
| Doxyfile | ||
| LINX_SOFTWARE-COMMENTED.ino | ||
| otto.sh | ||
| README.md | ||
| setup.sh | ||
Multi-Tracker(LINX)
Description
BOM(Bill of Materials)
- adafruit feather 32U4 RFM95
- ST7789V2 1.69" LCD Display
- 24 x WS2812 RGB Ring
- BN-220 GPS
- LSM303AGR Accelerometer + Compass
Building
Main Project
To be added
Tests
Requirements:
- CppUTest 3.X
- Bash shell
echo "1" | ./otto.sh
The above command runs the automation script otto.sh that automates the
process of running tests for the project.
Documentation
Requirements:
- Doxygen
- Terminal/Shell
The project's documentation is generated through documentation comments that are held within the source files. You can use the command below to generate the documentation from terminal.
doxygen ./Doxyfile
Project Directory Overview
Below you can find a list of the root directory. The project contains the source files for arduino as well as the needed files for unit testing in the future.
tree -L 1
.
├── build
├── CMakeLists.txt
├── compile_commands.json -> ./build/compile_commands.json
├── docs
├── Doxyfile
├── inc
├── LINX_SOFTWARE-COMMENTED.ino
├── mocks
├── otto.sh
├── README.md
├── setup.sh
├── src
└── tests
6 directories, 7 files