Skip to content

TeamTriforceUK/triforce-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

triforce-docs

Documentation Build Status

Introduction

Repository Navigation

This repository is one of three repositories hosting the codebase for the Triforce robot. The repositories are versioned and released seperately. Links to the repositories are below.

The Triforce Control firmware (mbed OS) runs on an LPC1768 (ARM Cortex M3). The firmware is responsible for controlling the robot.

The Triforce Telemetry repository hosts firmware (FreeRTOS) for the ESP8266 WiFi chip. This microcontroller works alongside the mbed to provide telemetry functionality via an HTTP server.

The ESP8266 allows us to communicate telemetry from Triforce to connected mobile devices (tablets, laptops, mobile phones). We also control non-safety critical settings such as LED lights from the mobile device.

Documentation covering all Triforce repositories.

System Overview

Microprocessors

Device Firmware Language
LPC1768 mbed OS C++
ESP8266 FreeRTOS C

Sensors

Sensor Purpose Communication
BNO055 Orientation, direction, acceleration I2C

Development Environment

The python-sphinx package is required to build documentation. It can be installed in Ubuntu (or similar) using:

sudo apt-get install python-sphinx

We also use recommonmark for MarkDown support in Sphinx:

pip install recommonmark

Compilation

Generate HTML:

make html

Generate PDF:

make latexpdf

Contributing

We are open to any contributions in terms of ideas, suggestions, bug reports, development. Feel free to open GitHub issues regarding any contributions.

Licensing

This software is licensed under the MIT License, unless stated otherwise.