Compiling & Uploading
Compiling and Uploading ProtoTracer
Section titled “Compiling and Uploading ProtoTracer”This guide walks you through the process of compiling and uploading ProtoTracer using PlatformIO.
Prerequisites
Section titled “Prerequisites”- Visual Studio Code: Download
- PlatformIO IDE: Install from the VS Code Extensions Marketplace
- Clone the Repository:
Terminal window git clone https://github.com/coelacant1/ProtoTracer.git
Supported Environments
Section titled “Supported Environments”The project supports multiple Teensy 4.0 and Teensy 4.1 configurations:
Teensy 4.0
Section titled “Teensy 4.0”| Environment | Description |
|---|---|
teensy40hub75 | HUB75 LED panels |
teensy40ws35 | WS35 LED boards |
teensy40beta | Beta Protogen configuration |
teensy40verifyrender | Render verification |
teensy40verifyhardware | Hardware verification |
Teensy 4.1
Section titled “Teensy 4.1”| Environment | Description |
|---|---|
teensy41hub75 | HUB75 LED panels |
teensy41ws35 | WS35 LED boards |
teensy41beta | Beta Protogen configuration |
teensy41verifyrender | Render verification |
teensy41verifyhardware | Hardware verification |
Compile and Upload Instructions
Section titled “Compile and Upload Instructions”1. Open the Project in PlatformIO
Section titled “1. Open the Project in PlatformIO”Launch Visual Studio Code and use File > Open Workspace to open the workspace file in the root directory of the project.
2. Select the Environment
Section titled “2. Select the Environment”In the platformio.ini file, each environment corresponds to a specific Teensy and Protogen configuration.
Click on the PlatformIO logo on the left of VS Code, or run:
pio run -e <environment_name>Replace <environment_name> with your target (e.g., teensy40hub75).
3. Modify UserConfiguration.h (if necessary)
Section titled “3. Modify UserConfiguration.h (if necessary)”Located in the Examples directory, this file allows you to customize settings such as:
- LED count and type
- Sensor enable/disable
- Animation preferences
4. Build the Project
Section titled “4. Build the Project”Click the PlatformIO Build button or use:
pio run5. Upload the Code
Section titled “5. Upload the Code”Connect your Teensy board via USB, then click PlatformIO Upload or use:
pio run -t upload -e <environment_name>6. Monitor Serial Output (Optional)
Section titled “6. Monitor Serial Output (Optional)”Open the serial monitor to view debugging information:
pio device monitorLibrary Dependencies
Section titled “Library Dependencies”The following libraries are automatically managed by PlatformIO:
- ProtoTracer
- SPI
- Wire
- EEPROM
- Adafruit Unified Sensor
- OctoWS2811
- Adafruit BNO055
- SerialTransfer
- Adafruit APDS9960 Library
- SmartMatrix
- Adafruit BusIO
- Teensy_ADC
- Adafruit SSD1306
- Adafruit seesaw Library
- Adafruit MMC56x3
Troubleshooting
Section titled “Troubleshooting”Missing Dependencies
Section titled “Missing Dependencies”PlatformIO will attempt to download libraries automatically. Ensure you’re connected to the internet during the first build.
Upload Errors
Section titled “Upload Errors”- Verify the correct Teensy board is selected
- Check that the board is properly connected
- Try pressing the reset button on the Teensy
Serial Monitor Issues
Section titled “Serial Monitor Issues”Ensure the correct COM port is selected in PlatformIO settings.
Additional Notes
Section titled “Additional Notes”- By default, the output directory is structured under
.pio/ - To add custom functionality, modify the configuration in
platformio.iniand project files
For further assistance: