jakegoodwin
/
multi-tracker
generated from TDD-Templates/cmake_cpputest_template
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity
Written for Bailey Fait. An embedded system that makes use of LoRa and compass modules to direct the modules towards eachother.
16 Commits 2 Branches 0 Tags 285 KiB
C++ 54.1%
Shell 27.6%
CMake 9.7%
C 8.6%
Go to file
jakeg00dwin cfa740209f Changed C radio source to CPP 2024-09-26 16:37:58 -07:00
.template_files Initial commit 2024-09-24 20:59:20 +00:00
build Initial commit 2024-09-24 20:59:20 +00:00
docs Initial commit 2024-09-24 20:59:20 +00:00
inc Added header guards to board_config.h file. 2024-09-26 16:37:14 -07:00
mocks Initial commit 2024-09-24 20:59:20 +00:00
src Changed C radio source to CPP 2024-09-26 16:37:58 -07:00
tests Added empty test for the Radio module. 2024-09-26 16:22:25 -07:00
.clang-format Initial commit 2024-09-24 20:59:20 +00:00
.gitignore Initial commit 2024-09-24 20:59:20 +00:00
.gitmodules Initial commit 2024-09-24 20:59:20 +00:00
CMakeLists.txt Initial commit 2024-09-24 20:59:20 +00:00
Doxyfile Updated Doxygen config file to also read *.ino files. Changed name to be project/repo name. 2024-09-24 14:06:59 -07:00
README.md Added a section for tracking dependencies. Also added instructions for using arduino IDE to program it. 2024-09-25 11:13:42 -07:00
compile_commands.json Initial commit 2024-09-24 20:59:20 +00:00
multi-tracker.ino Changed project to make use of symlinks for the INO file. 2024-09-26 16:37:36 -07:00
otto.sh Initial commit 2024-09-24 20:59:20 +00:00
setup.sh Initial commit 2024-09-24 20:59:20 +00:00

README.md

Multi-Tracker(LINX)

Description

BOM(Bill of Materials)

Building

Main Project

Using Arduino IDE

  1. Install the Arduino IDE if not installed.
  2. Using the library manager in the IDE install the dependencies.
  3. Connect the micro-controller
  4. Select your development boards version and connection under the drop-down.
  5. Click the Upload button to flash the program.

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

Resources:

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

Project Dependencies

  • RadioHead RFM9x Library
  • TinyGPS++