__________                        __             __   __   ___   ____ ___  _____
 /_  __/ __ \            ____ ___  / /_  ___  ____/ /  / /  |__ \ / __ \__ \|__  /
  / / / /_/ /  ______   / __ `__ \/ __ \/ _ \/ __  /  / /   __/ // / / /_/ / /_ < 
 / / / _, _/  /_____/  / / / / / / /_/ /  __/ /_/ /  / /   / __// /_/ / __/___/ / 
/_/ /_/ |_|           /_/ /_/ /_/_.___/\___/\__,_/  / /   /____/\____/____/____/  
                                                   /_/                            

---

Table of Contents
Prerequisites
Setup
Flashing
Troubleshooting
Documentation

---

Prerequisites

We strongly recommend using Linux (Ubuntu or any other flavor) for development. If this is not possible, we've created setup guides for the major operating systems.

Please choose the appropriate setup guide for your operating system:

• Linux

• Windows

• Windows Subsystem for Linux (WSL)

• MacOS

---

Setup

1. Clone this repo:

git clone https://github.com/Triton-Robotics/TR-mbed.git

At this point, you may choose to diverge from the CLI setup guide and set up an IDE instead. Check out the setup instructions for CLion or VSCode. We higly recommend CLion.

2. Configure CMake project. This should only be done once per project, or after editing any CMakeLists.txt:

cmake -S . -B cmake-build-debug -GNinja

3. Build the desired target using your IDE or via CLI:

cmake --build cmake-build-debug --target TR-TestBench -j $(nproc)

Viable targets for build are: TR-Engineer, TR-Infantry, TR-Sentry, TR-Hero, and TR-TestBench

---

Flashing STM32

1. Locate the generated executable:

   eg. The built executable for TestBench will be present in cmake-build-debug/robots/TestBench/TR-TestBench.elf

2. Flash the executable to the target device:

openocd -f board/st_nucleo_f4.cfg -c "program cmake-build-debug/robots/TestBench/TR-TestBench.elf verify reset exit"

For flashing device in WSL, see the WSL guide.

3. View serial output:

mbed-tools sterm -b 115200

---

Troubleshooting

See the Troubleshooting guide for common issues and solutions.

---

Documentation

See our generated doxygen.