Written for Bailey Fait. An embedded system that makes use of LoRa and compass modules to direct the modules towards eachother.

Go to file

jakeg00dwin 7fbb685e30 Updated the readme with instructions and details.		2024-09-24 14:22:46 -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	Initial commit	2024-09-24 20:59:20 +00:00
mocks	Initial commit	2024-09-24 20:59:20 +00:00
src	Initial commit	2024-09-24 20:59:20 +00:00
tests	Initial commit	2024-09-24 20:59:20 +00: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
LINX_SOFTWARE-COMMENTED.ino	Added the source code from the client to root dir.	2024-09-24 14:08:41 -07:00
README.md	Updated the readme with instructions and details.	2024-09-24 14:22:46 -07:00
compile_commands.json	Initial commit	2024-09-24 20:59:20 +00: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

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