# fr3ts0n/androbd architecture

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

- Interactive diagram: https://gitdiagram.com/fr3ts0n/androbd
- Repository: https://github.com/fr3ts0n/androbd

## Overview

##### Project type and purpose
- AndrOBD is an open-source Android application (module “androbd”) that connects to a car’s OBD-II port via ELM327 adapters (Bluetooth, USB, Wi-Fi), displays live and historical engine data, and includes export and plugin-extension capabilities.
- There is also a pure-Java “library” module (with a small AWT-based desktop GUI launcher under “awt_startup”) providing the core protocol handlers, data models, conversions, and desktop UI panels.

##### File structure
- Top level:
- androbd/ — Android Studio project containing Activities, Services, layouts, menus, resources, build.gradle
- library/ — plain-Java module with core ECU/OBD data classes, protocol implementations, conversion utilities, and AWT/Swing application panels
- customisation/ — CSV templates for custom PID/conversion definitions
- plugin/ — placeholder for plugin framework extensions
- awt_startup/ — shell scripts and properties to launch the Java desktop GUI
- fastlane/, gradle/, settings.gradle etc. — CI/CD, build and distribution configuration
- Patterns: multi-module Gradle composite build; plugin architecture hooks in the Android app for extension points; service-based communication layers in Android; MVC/MVP in UI.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Android App Module
    subgraph "Android App Module (androbd)"
        direction TB
        subgraph "UI Layer"
            direction TB
            MainActivity["MainActivity"]:::ui
            ChartActivity["ChartActivity"]:::ui
            DashBoardActivity["DashBoardActivity"]:::ui
            SettingsActivity["SettingsActivity"]:::ui
            BtDeviceListActivity["BtDeviceListActivity"]:::ui
            UsbDeviceListActivity["UsbDeviceListActivity"]:::ui
        end
        subgraph "Service Layer"
            direction TB
            CommService["CommService"]:::service
            BtCommService["BtCommService"]:::service
            UsbCommService["UsbCommService"]:::service
            NetworkCommService["NetworkCommService"]:::service
        end
        PluginDataAdapter["PluginDataAdapter"]:::service
        ExportTask["ExportTask"]:::service
    end

    %% Core Library Module
    subgraph "Core Library Module (library)"
        direction TB
        subgraph "Protocol Handlers"
            direction TB
            ObdProt["ObdProt"]:::core
            ElmProt["ElmProt"]:::core
            CanProt["CanProt"]:::core
            CanProtFord["CanProtFord"]:::core
            Kw1281Prot["Kw1281Prot"]:::core
        end
        subgraph "Data Models & Conversions"
            direction TB
            ObdPid["ObdPid"]:::core
            EcuDataItem["EcuDataItem"]:::core
            EcuCodeItem["EcuCodeItem"]:::core
            LinearConversion["LinearConversion"]:::core
            HashConversion["HashConversion"]:::core
            IntConversion["IntConversion"]:::core
            NumericConversion["NumericConversion"]:::core
            BitmapConversion["BitmapConversion"]:::core
            VagConversion["VagConversion"]:::core
        end
        subgraph "Localization Resources"
            direction TB
            OBDRes["OBD codes/messages (.properties)"]:::core
            VAGRes["VAG codes/messages (.properties)"]:::core
        end
    end

    %% Customisation Templates
    CustTemplates["Customisation Templates (CSV)"]:::database

    %% External Devices & Plugins
    subgraph "External & Plugins"
        direction TB
        ELM327["ELM327 Adapter"]:::external
        DemoMode["Demo Mode"]:::external
        Plugins["Plugin Extensions"]:::external
    end

    %% Desktop App Launcher
    subgraph "Desktop App Launcher (awt_startup + GUI)"
        direction TB
        LauncherScripts["JObd.sh / JObd.bat / logging.properties"]:::service
        subgraph "AWT/Swing GUI Panels"
            direction TB
            ObdDataPanel["ObdDataPanel"]:::core
            ObdDtcPanel["ObdDtcPanel"]:::core
            VagCodeStatPanel["VagCodeStatPanel"]:::core
            ObdTestFrame["ObdTestFrame"]:::core
            VagTestFrame["VagTestFrame"]:::core
            AboutPanel["AboutPanel"]:::core
        end
    end

    %% Relationships
    MainActivity -->|"invokes"| CommService
    ChartActivity -->|"invokes"| CommService
    DashBoardActivity -->|"invokes"| CommService
    SettingsActivity -->|"invokes"| CommService
    BtDeviceListActivity -->|"invokes"| BtCommService
    UsbDeviceListActivity -->|"invokes"| UsbCommService

    CommService -->|"uses"| ObdProt
    BtCommService -->|"uses"| ObdProt
    UsbCommService -->|"uses"| ObdProt
    NetworkCommService -->|"uses"| ObdProt

    ObdProt -->|"feeds frames"| ObdPid
    ElmProt -->|"feeds frames"| ObdPid
    CanProt -->|"feeds frames"| ObdPid
    CanProtFord -->|"feeds frames"| ObdPid
    Kw1281Prot -->|"feeds frames"| VagConversion

    ObdPid -->|"delivers data"| MainActivity
    ObdPid -->|"delivers data"| ChartActivity
    EcuDataItem -->|"delivers data"| DashBoardActivity

    ObdPid -->|"passed to"| ExportTask
    ObdPid -->|"passed to"| PluginDataAdapter

    PluginDataAdapter -->|"loads"| Plugins

    CustTemplates -->|"loaded by"| ObdProt
    CustTemplates -->|"loaded by"| LinearConversion

    ELM327 -->|"connects via"| BtCommService
    ELM327 -->|"connects via"| UsbCommService
    ELM327 -->|"connects via"| NetworkCommService
    DemoMode -->|"simulated feed"| ObdProt

    LauncherScripts -->|"launches"| ObdTestFrame
    ObdTestFrame -->|"uses"| ObdDataPanel
    VagTestFrame -->|"uses"| VagCodeStatPanel

    %% Click Events
    click MainActivity "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/MainActivity.java"
    click ChartActivity "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/ChartActivity.java"
    click DashBoardActivity "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/DashBoardActivity.java"
    click SettingsActivity "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/SettingsActivity.java"
    click BtDeviceListActivity "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/BtDeviceListActivity.java"
    click UsbDeviceListActivity "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/UsbDeviceListActivity.java"
    click CommService "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/CommService.java"
    click BtCommService "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/BtCommService.java"
    click UsbCommService "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/UsbCommService.java"
    click NetworkCommService "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/NetworkCommService.java"
    click PluginDataAdapter "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/PluginDataAdapter.java"
    click ExportTask "https://github.com/fr3ts0n/androbd/blob/master/androbd/src/main/java/com/fr3ts0n/ecu/gui/androbd/ExportTask.java"
    click ObdProt "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/prot/obd/ObdProt.java"
    click ElmProt "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/prot/obd/ElmProt.java"
    click CanProt "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/prot/obd/CanProt.java"
    click CanProtFord "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/prot/obd/CanProtFord.java"
    click Kw1281Prot "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/prot/vag/Kw1281Prot.java"
    click ObdPid "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/ObdPid.java"
    click EcuDataItem "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/EcuDataItem.java"
    click EcuCodeItem "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/EcuCodeItem.java"
    click LinearConversion "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/LinearConversion.java"
    click HashConversion "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/HashConversion.java"
    click IntConversion "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/IntConversion.java"
    click NumericConversion "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/NumericConversion.java"
    click BitmapConversion "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/BitmapConversion.java"
    click VagConversion "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/VagConversion.java"
    click CustTemplates "https://github.com/fr3ts0n/androbd/blob/master/customisation/templates/cust_pids.csv"
    click CustTemplates "https://github.com/fr3ts0n/androbd/blob/master/customisation/templates/cust_conversions.csv"
    click LauncherScripts "https://github.com/fr3ts0n/androbd/blob/master/awt_startup/JObd.sh"
    click ObdDataPanel "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/gui/application/ObdDataPanel.java"
    click ObdDtcPanel "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/gui/application/ObdDtcPanel.java"
    click VagCodeStatPanel "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/gui/application/VagCodeStatPanel.java"
    click ObdTestFrame "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/gui/application/ObdTestFrame.java"
    click VagTestFrame "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/gui/application/VagTestFrame.java"
    click AboutPanel "https://github.com/fr3ts0n/androbd/blob/master/library/src/main/java/com/fr3ts0n/ecu/gui/application/AboutPanel.java"

    %% Styles
    classDef ui fill:#cce5ff,stroke:#003366
    classDef service fill:#d5f5e3,stroke:#196f3d
    classDef core fill:#fdebd0,stroke:#b9770e
    classDef database fill:#f2f3f4,stroke:#888888
    classDef external fill:#e5e7e9,stroke:#616a6b
```
