# avybc/obdium architecture

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

- Interactive diagram: https://gitdiagram.com/avybc/obdium
- Repository: https://github.com/avybc/obdium

## Overview

OBDium is a desktop vehicle-diagnostics app: a user connects an ELM327 adapter (or selects local demo replay), then views live metrics, trouble codes, readiness results, graphs, and VIN details. The Tauri event bridge connects the web UI to Rust services; OBD communication and decoding feed domain-specific diagnostics, while VIN parsing queries the local VPIC SQLite database. The graph preserves documented product capabilities, but omits unverified event wiring and unsampled implementation details where the excerpts do not establish the relationship.

Main entry points: [`backend/src/obd.rs`](https://github.com/avybc/obdium/blob/main/backend/src/obd.rs) (ELM327 session), [`backend/src/bridge/events.rs`](https://github.com/avybc/obdium/blob/main/backend/src/bridge/events.rs) (Event handlers), [`backend/src/vin/parser.rs`](https://github.com/avybc/obdium/blob/main/backend/src/vin/parser.rs) (VIN parser), [`frontend/scripts/features.js`](https://github.com/avybc/obdium/blob/main/frontend/scripts/features.js) (Diagnostic panels)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Desktop interface"]
  node_frontend["App interface<br/>[main.js]"]
  node_features["Diagnostic panels<br/>[features.js]"]
  node_settings["Preferences<br/>[settings.js]"]
end

subgraph group_bridge["Tauri integration"]
  node_eventbridge["Event handlers<br/>[events.rs]"]
  node_appstate["Bridge state<br/>[mod.rs]"]
  node_runtime["App runtime<br/>[main.rs]"]
end

subgraph group_obd["OBD diagnostics"]
  node_obd["ELM327 session<br/>[obd.rs]"]
  node_commands["OBD commands<br/>[cmd.rs]"]
  node_pidmetrics["Live PID metrics<br/>[engine.rs]"]
  node_pidother["PID domains<br/>[diagnostics.rs]"]
  node_responses["Response decoding<br/>[response.rs]"]
  node_scalars["Units and values<br/>[scalar.rs]"]
  node_dtcs["Trouble-code lookup<br/>[dicts.rs]"]
  node_replay["Demo replay<br/>[replay.rs]"]
end

subgraph group_vin["VIN decoding"]
  node_vinparse["VIN parser<br/>[parser.rs]"]
  node_vinpatterns["VIN pattern matching<br/>[pattern.rs]"]
  node_vinattributes["Vehicle attributes<br/>[attributes.rs]"]
  node_vpicsqlite[("VPIC database<br/>[vpic.sqlite.xz]")]
end

node_user(("Vehicle owner"))
node_adapter{{"ELM327 adapter"}}

node_user -->|"uses"| node_frontend
node_frontend -->|"loads"| node_features
node_settings -->|"connects via"| node_features
node_runtime -->|"registers handlers"| node_eventbridge
node_eventbridge -->|"uses state"| node_appstate
node_eventbridge -->|"connects"| node_obd
node_obd -->|"communicates"| node_adapter
node_obd -->|"sends"| node_commands
node_pidmetrics -->|"queries"| node_obd
node_pidother -.->|"queries"| node_obd
node_obd -->|"decodes"| node_responses
node_pidmetrics -->|"returns values"| node_scalars
node_obd -->|"reads replay"| node_replay
node_features -.->|"requests diagnostics"| node_eventbridge
node_eventbridge -->|"decodes VIN"| node_vinparse
node_vinparse -->|"queries"| node_vpicsqlite
node_vinparse -->|"matches patterns"| node_vinpatterns
node_vinparse -->|"resolves attributes"| node_vinattributes
node_features -.->|"shows codes"| node_dtcs

click node_frontend "https://github.com/avybc/obdium/blob/main/frontend/scripts/main.js"
click node_features "https://github.com/avybc/obdium/blob/main/frontend/scripts/features.js"
click node_settings "https://github.com/avybc/obdium/blob/main/frontend/scripts/settings.js"
click node_eventbridge "https://github.com/avybc/obdium/blob/main/backend/src/bridge/events.rs"
click node_appstate "https://github.com/avybc/obdium/blob/main/backend/src/bridge/mod.rs"
click node_runtime "https://github.com/avybc/obdium/blob/main/backend/src/main.rs"
click node_obd "https://github.com/avybc/obdium/blob/main/backend/src/obd.rs"
click node_commands "https://github.com/avybc/obdium/blob/main/backend/src/cmd.rs"
click node_pidmetrics "https://github.com/avybc/obdium/blob/main/backend/src/pid/engine.rs"
click node_pidother "https://github.com/avybc/obdium/blob/main/backend/src/pid/diagnostics.rs"
click node_responses "https://github.com/avybc/obdium/blob/main/backend/src/response.rs"
click node_scalars "https://github.com/avybc/obdium/blob/main/backend/src/scalar.rs"
click node_dtcs "https://github.com/avybc/obdium/blob/main/backend/src/dicts.rs"
click node_replay "https://github.com/avybc/obdium/blob/main/backend/src/replay.rs"
click node_vinparse "https://github.com/avybc/obdium/blob/main/backend/src/vin/parser.rs"
click node_vinpatterns "https://github.com/avybc/obdium/blob/main/backend/src/vin/pattern.rs"
click node_vinattributes "https://github.com/avybc/obdium/blob/main/backend/src/vin/attributes.rs"
click node_vpicsqlite "https://github.com/avybc/obdium/blob/main/backend/data/vpic.sqlite.xz"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_frontend,node_features,node_settings toneBlue
class node_eventbridge,node_appstate,node_runtime toneAmber
class node_obd,node_commands,node_pidmetrics,node_pidother,node_responses,node_scalars,node_dtcs,node_replay toneMint
class node_vinparse,node_vinpatterns,node_vinattributes,node_vpicsqlite toneRose
class node_user,node_adapter toneIndigo
```

## Components

### Desktop interface

- [App interface](https://github.com/avybc/obdium/blob/main/frontend/scripts/main.js): `frontend/scripts/main.js`
- [Diagnostic panels](https://github.com/avybc/obdium/blob/main/frontend/scripts/features.js): `frontend/scripts/features.js`
- [Preferences](https://github.com/avybc/obdium/blob/main/frontend/scripts/settings.js): `frontend/scripts/settings.js`

### Tauri integration

- [Event handlers](https://github.com/avybc/obdium/blob/main/backend/src/bridge/events.rs): `backend/src/bridge/events.rs`
- [Bridge state](https://github.com/avybc/obdium/blob/main/backend/src/bridge/mod.rs): `backend/src/bridge/mod.rs`
- [App runtime](https://github.com/avybc/obdium/blob/main/backend/src/main.rs): `backend/src/main.rs`

### OBD diagnostics

- [ELM327 session](https://github.com/avybc/obdium/blob/main/backend/src/obd.rs): `backend/src/obd.rs`
- [OBD commands](https://github.com/avybc/obdium/blob/main/backend/src/cmd.rs): `backend/src/cmd.rs`
- [Live PID metrics](https://github.com/avybc/obdium/blob/main/backend/src/pid/engine.rs): `backend/src/pid/engine.rs`
- [PID domains](https://github.com/avybc/obdium/blob/main/backend/src/pid/diagnostics.rs): `backend/src/pid/diagnostics.rs`
- [Response decoding](https://github.com/avybc/obdium/blob/main/backend/src/response.rs): `backend/src/response.rs`
- [Units and values](https://github.com/avybc/obdium/blob/main/backend/src/scalar.rs): `backend/src/scalar.rs`
- [Trouble-code lookup](https://github.com/avybc/obdium/blob/main/backend/src/dicts.rs): `backend/src/dicts.rs`
- [Demo replay](https://github.com/avybc/obdium/blob/main/backend/src/replay.rs): `backend/src/replay.rs`

### VIN decoding

- [VIN parser](https://github.com/avybc/obdium/blob/main/backend/src/vin/parser.rs): `backend/src/vin/parser.rs`
- [VIN pattern matching](https://github.com/avybc/obdium/blob/main/backend/src/vin/pattern.rs): `backend/src/vin/pattern.rs`
- [Vehicle attributes](https://github.com/avybc/obdium/blob/main/backend/src/vin/attributes.rs): `backend/src/vin/attributes.rs`
- [VPIC database](https://github.com/avybc/obdium/blob/main/backend/data/vpic.sqlite.xz): `backend/data/vpic.sqlite.xz`

### Other components

- **Vehicle owner**
- **ELM327 adapter**

## Connections

- Vehicle owner → App interface: uses (evidence: `README.md`)
- App interface → Diagnostic panels: loads (evidence: `frontend/scripts/main.js`)
- Preferences → Diagnostic panels: connects via (evidence: `frontend/scripts/settings.js`)
- App runtime → Event handlers: registers handlers (evidence: `backend/src/main.rs`)
- Event handlers → Bridge state: uses state (evidence: `backend/src/bridge/events.rs`)
- Event handlers → ELM327 session: connects (evidence: `backend/src/bridge/events.rs`)
- ELM327 session → ELM327 adapter: communicates (evidence: `README.md`)
- ELM327 session → OBD commands: sends (evidence: `backend/src/obd.rs`)
- Live PID metrics → ELM327 session: queries (evidence: `backend/src/pid/engine.rs`)
- PID domains → ELM327 session: queries
- ELM327 session → Response decoding: decodes (evidence: `backend/src/obd.rs`)
- Live PID metrics → Units and values: returns values (evidence: `backend/src/pid/engine.rs`)
- ELM327 session → Demo replay: reads replay (evidence: `backend/src/obd.rs`)
- Diagnostic panels → Event handlers: requests diagnostics
- Event handlers → VIN parser: decodes VIN (evidence: `backend/src/bridge/events.rs`)
- VIN parser → VPIC database: queries (evidence: `backend/src/vin/parser.rs`)
- VIN parser → VIN pattern matching: matches patterns (evidence: `backend/src/vin/parser.rs`)
- VIN parser → Vehicle attributes: resolves attributes (evidence: `backend/src/vin/mod.rs`)
- Diagnostic panels → Trouble-code lookup: shows codes
