# 2729stormrobotics/scoutingradar2023 architecture

> Architecture diagram of the GitHub repository 2729stormrobotics/scoutingradar2023, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/2729stormrobotics/scoutingradar2023
- Repository: https://github.com/2729stormrobotics/scoutingradar2023

## Overview

##### Main Components
- Mobile Application UI & Navigation:
- MainActivity with different fragments such as ConfigureScoutingFragment, PermissionsFragment, SettingsFragment, MatchRecordFragment, and scouting/fragments for Objective, Subjective, and Pit scouting.
- Navigation components (see /res/navigation/nav_graph.xml) that manage transitions between screens.
- Data Management Layer:
- AppDatabase along with DAO classes for various data types (objective, subjective, and pit scouting data).
- Data utilities like CSVCreator, DataUtils, and StringDecoder that handle data formatting and processing.
- Communication Modules:
- Bluetooth Handling: Classes like BluetoothReader and BluetoothServer indicate that data transfer via Bluetooth is supported.
- Data Import/Export Fragments and associated ViewModels (ExportDataFragment/ExportViewModel, ImportDataFragment/ImportViewModel) are used for consolidating and transferring collected data via CSV or QR codes.
- Configuration and Analytics:
- The configuration system relying on an external configuration file (uploadable into the app for setting up scouting modes) as described in the README.
- An analytics part exists outside the Android module (in the analytics directory) which includes Python scripts used to process and analyze time-based data (especially for objective scouting).

##### Out Relationships and Data Flow
- Data Management services (showing how user interactions trigger database operations through Repositories and DAOs).
- Communication modules (Bluetooth components) to illustrate data exchange between devices.
- UI triggers → ViewModels → Repositories/DAO → AppDatabase.
- Bluetooth server/client interactions to reflect two-way data transfers.
- Data export/import via designated fragments.

##### Architectural Patterns and Design Principles
- The structure suggests an MVVM or a Fragment-based architecture common in Android apps—with clear separation between UI (fragments/activities), business logic (ViewModels), and the data layer (Room or SQLite based database with DAOs).
- The use of separate modules for objectives versus subjective versus pit scouting shows a clear modular breakdown of functionality.
- Communication (Bluetooth) and configurability enhance the extensibility and separation of concerns within the app.

##### Technologies, Frameworks, and Tools
- Android SDK with specific layouts, fragments, and activities managed through Android Studio.
- Gradle build system (multiple build.gradle files).
- Likely a database framework (such as Room) given the structure of AppDatabase and DAOs.
- For data analysis, external Python scripts (Tableau Prep Builder flow integration indicated in README) and CSV exporting (use of CSVCreator).
- Bluetooth APIs for data transfer.

##### Elements
- Labels for every major component such as UI Components, Data Management Layer, Communication Modules, and Analytics/Configuration.
- The UI and the business logic (ViewModels and Repositories).
- The business logic with the Database and external transfer modules.
- External configuration and analytics processes.
- User interface elements (activities, fragments)
- Data storage elements (database and DAO components)
- Transfer mechanisms (Bluetooth and QR Code exchange modules)
- External artifacts (analytics scripts and configuration files).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "User Interface Layer"
        UI_MainActivity["MainActivity"]:::ui
        UI_Configure["ConfigureScoutingFragment"]:::ui
        UI_Permissions["PermissionsFragment"]:::ui
        UI_Settings["SettingsFragment"]:::ui
        UI_MatchRecord["MatchRecordFragment"]:::ui
        UI_Objective["ObjectiveMatchFragment"]:::ui
        UI_Subjective["SubjectiveMatchFragment"]:::ui
        UI_Pit["PitScoutFragment"]:::ui
        UI_Nav["Navigation (nav_graph.xml)"]:::ui
    end

    %% Data Management Layer
    subgraph "Data Management Layer"
        DM_AppDatabase["AppDatabase"]:::data
        DM_CSV["CSVCreator"]:::data
        DM_DataUtils["DataUtils"]:::data
        DM_StringDecoder["StringDecoder"]:::data

        subgraph "Objective Scouting"
            DM_ObjectiveDAO["ObjectiveMatchDao"]:::data
            DM_ObjectiveRepo["ObjectiveRepository"]:::data
        end

        subgraph "Subjective Scouting"
            DM_SubjectiveDAO["SubjectiveMatchDao"]:::data
            DM_SubjectiveRepo["SubjectiveRepository"]:::data
        end

        subgraph "Pit Scouting"
            DM_PitDAO["PitScoutDao"]:::data
            DM_PitRepo["PitRepository"]:::data
        end
    end

    %% Communication Modules
    subgraph "Communication Modules"
        Comm_BTReader["BluetoothReader"]:::comm
        Comm_BTServer["BluetoothServer"]:::comm

        subgraph "Data Import/Export"
            Comm_ExportFragment["ExportDataFragment"]:::comm
            Comm_ExportViewModel["ExportViewModel"]:::comm
            Comm_ImportFragment["ImportDataFragment"]:::comm
            Comm_ImportViewModel["ImportViewModel"]:::comm
        end
    end

    %% Configuration and Analytics
    subgraph "Configuration and Analytics"
        Config_File["Configuration File (external)"]:::config
        Analytics_Script["Analytics (time_data_breakdown.py)"]:::config
    end

    %% Connections among UI components
    UI_MainActivity -->|"navigates to"| UI_Configure
    UI_MainActivity -->|"navigates to"| UI_Permissions
    UI_MainActivity -->|"navigates to"| UI_Settings
    UI_MainActivity -->|"navigates to"| UI_MatchRecord
    UI_MainActivity -->|"controls"| UI_Nav

    %% UI triggering specific scouting fragments
    UI_Nav -->|"loads"| UI_Objective
    UI_Nav -->|"loads"| UI_Subjective
    UI_Nav -->|"loads"| UI_Pit

    %% UI to Data Management Layer flows
    UI_Objective -->|"sends data to"| DM_ObjectiveRepo
    UI_Subjective -->|"sends data to"| DM_SubjectiveRepo
    UI_Pit -->|"sends data to"| DM_PitRepo

    %% Data Repositories to DAOs and Database
    DM_ObjectiveRepo -->|"queries"| DM_ObjectiveDAO
    DM_ObjectiveDAO -->|"accesses"| DM_AppDatabase

    DM_SubjectiveRepo -->|"queries"| DM_SubjectiveDAO
    DM_SubjectiveDAO -->|"accesses"| DM_AppDatabase

    DM_PitRepo -->|"queries"| DM_PitDAO
    DM_PitDAO -->|"accesses"| DM_AppDatabase

    %% Data utilities involvement
    DM_ObjectiveRepo -->|"formats CSV via"| DM_CSV
    DM_CSV -->|"exports data to"| Analytics_Script

    %% UI interactions with Communication Modules
    UI_Configure -->|"triggers export"| Comm_ExportFragment
    UI_Configure -->|"triggers import"| Comm_ImportFragment
    UI_MainActivity -->|"initiates Bluetooth"| Comm_BTReader
    UI_MainActivity -->|"initiates Bluetooth"| Comm_BTServer

    %% Import/Export component interactions
    Comm_ExportFragment -->|"uses"| Comm_ExportViewModel
    Comm_ImportFragment -->|"uses"| Comm_ImportViewModel

    %% Bluetooth two-way communication
    Comm_BTReader <-->|"data exchange"| Comm_BTServer

    %% Configuration influences
    Config_File -->|"configures"| UI_MainActivity
    Config_File -->|"adjusts"| DM_AppDatabase

    %% Styles for node types
    classDef ui fill:#ffcccc,stroke:#333,stroke-width:2px;
    classDef data fill:#add8e6,stroke:#333,stroke-width:2px;
    classDef comm fill:#ccffcc,stroke:#333,stroke-width:2px;
    classDef config fill:#e6ccff,stroke:#333,stroke-width:2px;

    %% Click Events for UI Layer
    click UI_MainActivity "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/MainActivity.java"
    click UI_Configure "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/ConfigureScoutingFragment.java"
    click UI_Permissions "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/PermissionsFragment.java"
    click UI_Settings "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/SettingsFragment.java"
    click UI_MatchRecord "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/homefragment/MatchRecordFragment.java"
    click UI_Objective "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/scoutingfragments/ObjectiveMatchFragment.java"
    click UI_Subjective "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/scoutingfragments/SubjectiveMatchFragment.java"
    click UI_Pit "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/scoutingfragments/PitScoutFragment.java"
    click UI_Nav "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/res/navigation/nav_graph.xml"

    %% Click Events for Data Management Layer
    click DM_AppDatabase "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/AppDatabase.java"
    click DM_CSV "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/CSVCreator.java"
    click DM_DataUtils "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/DataUtils.java"
    click DM_StringDecoder "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/StringDecoder.java"
    click DM_ObjectiveDAO "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/objective/ObjectiveMatchDao.java"
    click DM_ObjectiveRepo "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/objective/ObjectiveRepository.java"
    click DM_SubjectiveDAO "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/subjective/SubjectiveMatchDao.java"
    click DM_SubjectiveRepo "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/subjective/SubjectiveRepository.java"
    click DM_PitDAO "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/pit/PitScoutDao.java"
    click DM_PitRepo "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/database/pit/PitRepository.java"

    %% Click Events for Communication Modules
    click Comm_BTReader "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/BluetoothReader.java"
    click Comm_BTServer "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/BluetoothServer.java"
    click Comm_ExportFragment "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/dbfragments/ExportDataFragment.java"
    click Comm_ExportViewModel "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/dbfragments/ExportViewModel.java"
    click Comm_ImportFragment "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/dbfragments/ImportDataFragment.java"
    click Comm_ImportViewModel "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/ScoutingRadar2022/app/src/main/java/org/stormroboticsnj/scoutingradar2022/dbfragments/ImportViewModel.java"

    %% Click Events for Configuration and Analytics
    click Config_File "https://github.com/2729stormrobotics/scoutingradar2023/tree/main/configuration"
    click Analytics_Script "https://github.com/2729stormrobotics/scoutingradar2023/blob/main/analytics/time_data_breakdown.py"
```
