# ashray-g/frc-2023-public architecture

> Architecture diagram of the GitHub repository ashray-g/frc-2023-public, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-02-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ashray-g/frc-2023-public
- Repository: https://github.com/ashray-g/frc-2023-public

## Overview

Main Components to Include:

##### Core Robot Systems
- Main subsystems:
- Double-jointed Arm System
- Vision System (AprilTag)
- Drive System (Swerve)
- Gripper System
- Intake System
- Lighting System

##### Control Layer
- Routine Manager
- Robot State Estimator
- Hardware Adapter
- Commands System

##### Optimization & Planning
- An "Optimization" component showing:
- Arm Trajectory Optimizer
- Path Planning System
- Auto Mode Planning

##### Input/Output Systems
- An "Input Devices" section showing:
- 27-key Macro Pad
- Joystick Controls
- Vision Cameras
- "Output Systems" including:
- Motor Controllers
- Sensor Feedback
- Status Lighting

- ┌─ Input Layer ─────┐    ┌─ Control Layer ──┐    ┌─ Output Layer ────┐
- Macro Pad      │ → │ - State Estimator │ → │ - Motor Control   │
- Vision Cameras │    │ - Path Planning  │    │ - Feedback System │
- ┘    └────────────────┘    └────────────────┘

##### Connection Types
- Double lines for critical paths

Key Elements to Highlight:

##### Autonomous Systems
- Relationship between:
- Path Planning
- Vision Processing
- State Estimation
- Motion Control

##### Safety Systems
- Emergency stops
- Constraint checking
- Feedback loops

##### Data Flow
- Real-time control paths
- Sensor feedback routes
- State update paths

Special Considerations:

##### Timing-Critical Components
- Real-time control loops
- Periodic update cycles
- Priority levels

##### Subsystem Integration
- How subsystems communicate
- Shared resources
- Synchronization points

##### Configuration Management
- Where constants are defined
- Tunable parameters
- Calibration points

- Line styles and their meanings
- Any special symbols or notations

- Clear hierarchical layouts
- Export to high-resolution formats

This system design should emphasize the unique features of the robot, particularly the double-jointed arm trajectory optimization, full-field AprilTag localization, and the autonomous scoring capabilities.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Main Sections
    subgraph Input
        MacroPad["27-key Macro Pad"]:::input
        JoystickCtrl["Joystick Controls"]:::input
        VisionCams["Vision Cameras"]:::input
    end

    subgraph Core["Robot Core"]
        Robot["Robot Controller"]:::core
        click Robot "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/robot/Robot.java"
        RobotState["Robot State"]:::core
        click RobotState "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/robot/RobotState.java"
        HWAdapter["Hardware Adapter"]:::core
        click HWAdapter "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/robot/HardwareAdapter.java"
    end

    subgraph Control["Control Systems"]
        RoutineMgr["Routine Manager"]:::control
        click RoutineMgr "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/behavior/RoutineManager.java"
        StateEst["Robot State Estimator"]:::control
        click StateEst "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/robot/RobotStateEstimator.java"
    end

    subgraph Optimization["Optimization & Planning"]
        ArmOpt["Arm Trajectory Optimizer"]:::opt
        click ArmOpt "https://github.com/Ashray-g/FRC-2023-Public/blob/main/arm-opt/solve.py"
        PathPlan["Path Planning System"]:::opt
        click PathPlan "https://github.com/Ashray-g/FRC-2023-Public/tree/main/src/main/deploy/pathplanner/"
        DrivePath["Drive Path Routine"]:::opt
        click DrivePath "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/behavior/routines/drive/DrivePathRoutine.java"
    end

    subgraph Subsystems["Robot Subsystems"]
        Arm["Double-jointed Arm"]:::subsystem
        click Arm "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/subsystems/Arm.java"
        ArmKin["Arm Kinematics"]:::subsystem
        click ArmKin "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/util/peninsulaCoolios/kinematics/TwoDOFKinematics.java"
        Vision["Vision System"]:::subsystem
        click Vision "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/subsystems/Vision.java"
        AprilTag["AprilTag System"]:::subsystem
        click AprilTag "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/vision/AprilTagFieldLayout.java"
        Drive["Swerve Drive"]:::subsystem
        click Drive "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/subsystems/Swerve.java"
        SwerveModule["Swerve Module"]:::subsystem
        click SwerveModule "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/util/swerveDrivers/SwerveModule.java"
        Gripper["Gripper System"]:::subsystem
        click Gripper "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/subsystems/Gripper.java"
        Intake["Intake System"]:::subsystem
        click Intake "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/subsystems/Intake.java"
        Lighting["Lighting System"]:::subsystem
        click Lighting "https://github.com/Ashray-g/FRC-2023-Public/blob/main/src/main/java/com/peninsula/frc2023/subsystems/Lighting.java"
    end

    subgraph Output["Output Systems"]
        Motors["Motor Controllers"]:::output
        Sensors["Sensor Feedback"]:::output
        StatusLights["Status Lighting"]:::output
    end

    %% Connections
    MacroPad & JoystickCtrl & VisionCams --> Robot
    Robot --> RobotState
    Robot --> HWAdapter
    RobotState --> StateEst
    HWAdapter --> RoutineMgr

    StateEst --> RoutineMgr
    RoutineMgr --> Subsystems
    
    ArmOpt --> Arm
    PathPlan --> DrivePath
    DrivePath --> Drive
    
    Vision --> AprilTag
    Drive --> SwerveModule
    Arm --> ArmKin
    
    Subsystems --> Motors
    Sensors --> StateEst
    Lighting --> StatusLights

    %% Styles
    classDef input fill:#a8d1ff,stroke:#333,stroke-width:2px
    classDef core fill:#ffb366,stroke:#333,stroke-width:2px
    classDef control fill:#90EE90,stroke:#333,stroke-width:2px
    classDef opt fill:#FFD700,stroke:#333,stroke-width:2px
    classDef subsystem fill:#FF9999,stroke:#333,stroke-width:2px
    classDef output fill:#DDA0DD,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        L1["Input Systems"]:::input
        L2["Core Systems"]:::core
        L3["Control Systems"]:::control
        L4["Optimization"]:::opt
        L5["Subsystems"]:::subsystem
        L6["Output Systems"]:::output
    end
```
