Skip to main content
Ctrl+K
Polar Robotics Documentation - Home Polar Robotics Documentation - Home

Training

  • Git and GitHub
  • Windows Subsystem for Linux
  • Docker
  • Development Environment Setup - Windows
  • Flashing Code to a Robot
  • Pairing and Connecting Controllers
  • Programming CYOA Training
  • Documentation Repository Setup

Meta-Documentation

  • Programming Style Guide
  • Documentation Style Guide
  • Git and GitHub Guidelines
  • Sphinx

High-Level Robot Documentation

  • Bot Types
  • Robot Components and Subsystems

Codebase

  • Codebase Documentation Portal
    • main.cpp
    • PolarRobotics.h
    • Drive.cpp
    • Drive.h
    • DriveMecanum.cpp
    • DriveMecanum.h
    • depairingStation.cpp
    • getAddress.cpp
    • pairing.cpp
    • pairing.h
    • builtInLED.cpp
    • builtInLED.h
    • Center.cpp
    • Center.h
    • Kicker.cpp
    • Kicker.h
    • KickerOld.cpp
    • KickerOld.h
    • Lights.cpp
    • Lights.h
    • Lineman.h
    • MecanumCenter.cpp
    • MecanumCenter.h
    • MotorControl.cpp
    • MotorControl.h
    • QuarterbackBase.cpp
    • QuarterbackBase.h
    • Quarterback.cpp
    • Quarterback.h
    • QuarterbackTurret.cpp
    • QuarterbackTurret.h
    • Robot.h
    • BotTypes.cpp
    • BotTypes.h
    • ConfigManager.cpp
    • ConfigManager.h
    • Debouncer.cpp
    • Debouncer.h
    • DriveParameters.h
    • MotorTypes.cpp
    • MotorTypes.h
    • Pair.h
    • PrintSerial.cpp
    • PrintSerial.h
    • ReadBotInfo.cpp
    • WriteBotInfo.cpp

Hardware Documentation

  • AMT10 Encoders
  • ESP32
  • Falcon 500 Motor
  • NEO Vortex Motors
  • Pulse Width Modulation
  • Sabertooth 2x25
  • Sabertooth 2x32
  • Old Tackle Sensors (Rev3)
  • New Tackle Sensors (Rev4)
  • The UART Protocol
  • Robot Wiring Diagrams

Data Acquisition

  • Installing FileZilla
  • Raspberry Pi SSH
  • Router Setup
  • Comma Separated Values
  • Serial Monitor Program
  • .md

Codebase Documentation Portal

Codebase Documentation Portal#

Main

  • main.cpp
  • PolarRobotics.h

Drive

  • Drive.cpp
  • Drive.h
  • DriveMecanum.cpp
  • DriveMecanum.h

Pairing

  • depairingStation.cpp
  • getAddress.cpp
  • pairing.cpp
  • pairing.h

Robot

  • builtInLED.cpp
  • builtInLED.h
  • Center.cpp
  • Center.h
  • Kicker.cpp
  • Kicker.h
  • KickerOld.cpp
  • KickerOld.h
  • Lights.cpp
  • Lights.h
  • Lineman.h
  • MecanumCenter.cpp
  • MecanumCenter.h
  • MotorControl.cpp
  • MotorControl.h
  • QuarterbackBase.cpp
  • QuarterbackBase.h
  • Quarterback.cpp
  • Quarterback.h
  • QuarterbackTurret.cpp
  • QuarterbackTurret.h
  • Robot.h

Utilities

  • BotTypes.cpp
  • BotTypes.h
  • ConfigManager.cpp
  • ConfigManager.h
  • Debouncer.cpp
  • Debouncer.h
  • DriveParameters.h
  • MotorTypes.cpp
  • MotorTypes.h
  • Pair.h
  • PrintSerial.cpp
  • PrintSerial.h
  • ReadBotInfo.cpp
  • WriteBotInfo.cpp

previous

Robot Components and Subsystems

next

main.cpp

By Polar Robotics Documentation Team

© Copyright 2025, Polar Robotics Documentation Team.