2.5 KiB

Raw Blame History

Multi-Tracker(LINX)

Description

BOM(Bill of Materials)

Configuration

The project can be configured to use a variety of hardware or differnt development boards based on the selected hardware.

You can add or change this inside the inc/board_config.h file.

Building

Main Project

Using Arduino IDE

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

If you're developing on a Windows machine or another operating system that doesn't recognize symlinks(symbolic links) then you will need to copy the src/main.cpp to the project's root directory as multi-tracker.ino.

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:

feather-32u4-radio

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++

2.5 KiB Raw Blame History