# aicitizens/powerplay-btc architecture

> Architecture diagram of the GitHub repository aicitizens/powerplay-btc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aicitizens/powerplay-btc
- Repository: https://github.com/aicitizens/powerplay-btc

## Overview

##### Project type and purpose
- This is an Android-based robotics application built on the FIRST Tech Challenge (FTC) SDK, augmented with the Road Runner motion-planning library, plus a small standalone simulation app (MeepMeepTesting). Its purpose is to demonstrate trajectory generation and robot control on an FTC control hub or phone, and to allow quick simulation of those trajectories.

##### File structure
- Top-level modules:
- FtcRobotController: the official FTC Android app (UI, hardware abstraction, OpMode registration)
- TeamCode: user-written robot code (OpModes, drive libraries, utilities)
- MeepMeepTesting: standalone Java simulation harness for Road Runner trajectories
- Build orchestration: Gradle multi-module project: root build.gradle, settings.gradle includes the three modules
- Third-party libs:
- Road Runner (in TeamCode)
- Vuforia.jar + TensorFlow Lite models (in FtcRobotController/src/main/assets + libs)
- FTC Analytics, WirelessP2p, other AAR dependencies
- Patterns: plugin style—TeamCode is a plug-in to the Android controller; OpModes are discovered via annotation processing; separation of concerns between hardware drivers, motion planning, and high-level autonomous/teleop code.

##### README for additional insights
- Confirms this is the “Road Runner Quickstart” example
- Instructs how to clone, build in Android Studio, and tweak multidex/proguard
- Points to online documentation for deeper details

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Build Modules"
        Gradle["Root Gradle"]:::external
        FtcMod["FtcRobotController\nModule"]:::android
        TeamMod["TeamCode\nModule"]:::usercode
        SimMod["MeepMeepTesting\nModule"]:::simulation
    end
    Gradle -.-> FtcMod
    Gradle -.-> TeamMod
    Gradle -.-> SimMod

    subgraph "Android App (FTC Controller)"
        FRManifest["AndroidManifest.xml"]:::android
        FtcRegister["FtcOpModeRegister"]:::android
        FtcActivity["FtcRobotControllerActivity"]:::android
        Assets["Vision Assets\n(.tflite, .xml)"]:::external
        Libs["Embedded Libraries\nVuforia, WirelessP2P, Analytics"]:::external
    end

    subgraph "TeamCode Plugin"
        subgraph "Drive Library"
            DriveConst["DriveConstants"]:::usercode
            SampleDrive["SampleMecanumDrive"]:::usercode
            StandardLocalizer["StandardTrackingWheelLocalizer"]:::usercode
            TwoWheelLocalizer["TwoWheelTrackingWheelLocalizer"]:::usercode
        end
        subgraph "OpModes"
            OpModes["Drive OpModes\n(autonomous, teleop)"]:::usercode
        end
        subgraph "Trajectory Framework"
            SeqBuilder["TrajectorySequenceBuilder"]:::usercode
            SeqRunner["TrajectorySequenceRunner"]:::usercode
        end
        subgraph "Utilities"
            Util["IMU Utils, Dashboard, Logging"]:::usercode
        end
        subgraph "Hardware Abstraction"
            ModHardware["ModdedHardware"]:::usercode
            Modules["Hardware Modules"]:::usercode
        end
    end

    subgraph "Robot Hardware"
        Motors["Motor Controllers"]:::hardware
        Sensors["Sensors"]:::hardware
        Camera["Camera"]:::hardware
    end

    subgraph "Simulation App"
        SimEntry["MeepMeepTesting.java"]:::simulation
    end

    %% Runtime arrows
    OpModes -->|"uses"| SampleDrive
    OpModes -->|"calls"| SeqBuilder
    SeqBuilder --> SeqRunner
    SampleDrive -->|"generates commands"| ModHardware
    ModHardware -->|"sends PWM/CAN"| Motors
    Sensors -->|"data"| ModHardware
    ModHardware -->|"HAL callbacks"| OpModes
    Camera -->|"image feed"| Assets
    Assets -->|"vision pipeline"| FtcRegister
    FtcRegister -->|"selects/registers"| OpModes

    SimEntry -->|"imports"| SampleDrive
    SimEntry -->|"simulates paths"| SeqRunner

    %% Build-time arrows
    TeamMod --> FtcMod

    click FtcMod "https://github.com/aicitizens/powerplay-btc/tree/master/FtcRobotController/"
    click FRManifest "https://github.com/aicitizens/powerplay-btc/blob/master/FtcRobotController/src/main/AndroidManifest.xml"
    click FtcRegister "https://github.com/aicitizens/powerplay-btc/blob/master/FtcRobotController/src/main/java/org/firstinspires/ftc/robotcontroller/internal/FtcOpModeRegister.java"
    click FtcActivity "https://github.com/aicitizens/powerplay-btc/blob/master/FtcRobotController/src/main/java/org/firstinspires/ftc/robotcontroller/internal/FtcRobotControllerActivity.java"
    click Assets "https://github.com/aicitizens/powerplay-btc/tree/master/FtcRobotController/src/main/assets"
    click Libs "https://github.com/aicitizens/powerplay-btc/tree/master/FtcRobotController/libs"
    click TeamMod "https://github.com/aicitizens/powerplay-btc/tree/master/TeamCode/"
    click DriveConst "https://github.com/aicitizens/powerplay-btc/blob/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/drive/DriveConstants.java"
    click SampleDrive "https://github.com/aicitizens/powerplay-btc/blob/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/drive/SampleMecanumDrive.java"
    click StandardLocalizer "https://github.com/aicitizens/powerplay-btc/blob/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/drive/StandardTrackingWheelLocalizer.java"
    click TwoWheelLocalizer "https://github.com/aicitizens/powerplay-btc/blob/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/drive/TwoWheelTrackingLocalizer.java"
    click OpModes "https://github.com/aicitizens/powerplay-btc/tree/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/drive/opmode/"
    click SeqBuilder "https://github.com/aicitizens/powerplay-btc/tree/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/trajectorysequence/"
    click SeqRunner "https://github.com/aicitizens/powerplay-btc/tree/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/trajectorysequence/"
    click Util "https://github.com/aicitizens/powerplay-btc/tree/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/util/"
    click ModHardware "https://github.com/aicitizens/powerplay-btc/tree/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/drive/robo9u/ModdedHardware/"
    click Modules "https://github.com/aicitizens/powerplay-btc/tree/master/TeamCode/src/main/java/org/firstinspires/ftc/teamcode/drive/robo9u/Modules/"
    click SimMod "https://github.com/aicitizens/powerplay-btc/tree/master/MeepMeepTesting/"
    click SimEntry "https://github.com/aicitizens/powerplay-btc/blob/master/MeepMeepTesting/src/main/java/com/example/meepmeeptesting/MeepMeepTesting.java"

    classDef android fill:#AED6F1,stroke:#2980B9,color:#000
    classDef usercode fill:#A9DFBF,stroke:#27AE60,color:#000
    classDef external fill:#D5D8DC,stroke:#99A3A4,color:#000
    classDef hardware fill:#F9E79F,stroke:#B7950B,color:#000
    classDef simulation fill:#F5B7B1,stroke:#C0392B,color:#000
```
