# nada-ben-ali/odxtools architecture

> Architecture diagram of the GitHub repository nada-ben-ali/odxtools, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nada-ben-ali/odxtools
- Repository: https://github.com/nada-ben-ali/odxtools

## Overview

odxtools is a Python library and CLI for loading automotive ECU diagnostic descriptions in ODX/PDX form, exposing their services, and encoding or decoding diagnostic messages. The main workflow is load a database, resolve its diagnostic layers and services, then encode requests or decode requests and responses. Separate CLI capabilities support listing, browsing, finding, snooping, and comparing data. The graph reflects README workflows and source-index references; several CLI and domain subsystems are represented by their exact tree paths but were not sampled in source, so their internal wiring is omitted.

Main entry points: [`odxtools/diaglayers/diaglayer.py`](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/diaglayers/diaglayer.py) (Diagnostic layers), [`odxtools/diagservice.py`](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/diagservice.py) (Diagnostic services), [`odxtools/database.py`](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/database.py) (ODX database), [`odxtools/parameters/parameter.py`](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/parameters/parameter.py) (Parameters)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_load["Database loading"]
  node_loadfile["File loader<br/>[loadfile.py]"]
  node_database[("ODX database<br/>[database.py]")]
  node_linkresolve["ODX references<br/>[odxlink.py]"]
end

subgraph group_model["ODX diagnostic model"]
  node_diaglayer["Diagnostic layers<br/>[diaglayer.py]"]
  node_diagservice["Diagnostic services<br/>[diagservice.py]"]
  node_diagcomm["Diagnostic communications<br/>[diagcomm.py]"]
  node_request["Requests<br/>[request.py]"]
  node_response["Responses<br/>[response.py]"]
  node_singlejob["ECU jobs<br/>[singleecujob.py]"]
  node_statechart["Diagnostic state charts<br/>[statechart.py]"]
end

subgraph group_codec["Message encoding"]
  node_parameter["Parameters<br/>[parameter.py]"]
  node_encode["Encode state<br/>[encodestate.py]"]
  node_decode["Decode state<br/>[decodestate.py]"]
  node_compumethod["Value conversions<br/>[compumethod.py]"]
  node_exceptions["Validation errors<br/>[exceptions.py]"]
end

subgraph group_tools["CLI exploration"]
  node_cli["CLI dispatcher<br/>[main.py]"]
  node_browse["Browse database<br/>[browse.py]"]
  node_compare["Compare databases<br/>[compare.py]"]
  node_list["List services<br/>[list.py]"]
  node_find["Find services<br/>[find.py]"]
  node_snoop["Snoop traffic<br/>[snoop.py]"]
  node_cli_decode["Decode messages<br/>[decode.py]"]
end

node_user(("Python user"))
node_cliuser(("CLI user"))

node_user -->|"loads file"| node_loadfile
node_loadfile -.->|"builds database"| node_database
node_database -->|"contains layers"| node_diaglayer
node_diaglayer -->|"resolves references"| node_linkresolve
node_diaglayer -->|"provides services"| node_diagservice
node_diagservice -->|"uses request"| node_request
node_diagservice -->|"resolves responses"| node_response
node_diaglayer -->|"collects communications"| node_diagcomm
node_user -->|"encodes request"| node_diagservice
node_diagservice -->|"encodes parameters"| node_parameter
node_parameter -->|"updates state"| node_encode
node_parameter -->|"decodes values"| node_decode
node_parameter -.->|"converts values"| node_compumethod
node_user -->|"decodes message"| node_diaglayer
node_user -->|"decodes response"| node_response
node_cliuser -->|"runs commands"| node_cli
node_cli -.->|"dispatches browse"| node_browse
node_cli -->|"dispatches compare"| node_compare
node_cliuser -->|"lists services"| node_list
node_cliuser -->|"finds services"| node_find
node_cliuser -->|"snoops traffic"| node_snoop
node_cliuser -->|"decodes messages"| node_cli_decode
node_cli -->|"loads database"| node_database
node_browse -->|"browses contents"| node_database
node_compare -->|"compares contents"| node_database

click node_loadfile "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/loadfile.py"
click node_database "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/database.py"
click node_linkresolve "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/odxlink.py"
click node_diaglayer "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/diaglayers/diaglayer.py"
click node_diagservice "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/diagservice.py"
click node_diagcomm "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/diagcomm.py"
click node_request "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/request.py"
click node_response "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/response.py"
click node_singlejob "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/singleecujob.py"
click node_statechart "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/statechart.py"
click node_parameter "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/parameters/parameter.py"
click node_encode "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/encodestate.py"
click node_decode "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/decodestate.py"
click node_compumethod "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/compumethods/compumethod.py"
click node_exceptions "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/exceptions.py"
click node_cli "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/main.py"
click node_browse "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/browse.py"
click node_compare "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/compare.py"
click node_list "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/list.py"
click node_find "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/find.py"
click node_snoop "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/snoop.py"
click node_cli_decode "https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/decode.py"

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_loadfile,node_database,node_linkresolve,node_user,node_cliuser toneBlue
class node_diaglayer,node_diagservice,node_diagcomm,node_request,node_response,node_singlejob,node_statechart toneAmber
class node_parameter,node_encode,node_decode,node_compumethod,node_exceptions toneMint
class node_cli,node_browse,node_compare,node_list,node_find,node_snoop,node_cli_decode toneRose
```

## Components

### Database loading

- [File loader](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/loadfile.py): `odxtools/loadfile.py`
- [ODX database](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/database.py): `odxtools/database.py`
- [ODX references](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/odxlink.py): `odxtools/odxlink.py`

### ODX diagnostic model

- [Diagnostic layers](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/diaglayers/diaglayer.py): `odxtools/diaglayers/diaglayer.py`
- [Diagnostic services](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/diagservice.py): `odxtools/diagservice.py`
- [Diagnostic communications](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/diagcomm.py): `odxtools/diagcomm.py`
- [Requests](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/request.py): `odxtools/request.py`
- [Responses](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/response.py): `odxtools/response.py`
- [ECU jobs](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/singleecujob.py): `odxtools/singleecujob.py`
- [Diagnostic state charts](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/statechart.py): `odxtools/statechart.py`

### Message encoding

- [Parameters](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/parameters/parameter.py): `odxtools/parameters/parameter.py`
- [Encode state](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/encodestate.py): `odxtools/encodestate.py`
- [Decode state](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/decodestate.py): `odxtools/decodestate.py`
- [Value conversions](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/compumethods/compumethod.py): `odxtools/compumethods/compumethod.py`
- [Validation errors](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/exceptions.py): `odxtools/exceptions.py`

### CLI exploration

- [CLI dispatcher](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/main.py): `odxtools/cli/main.py`
- [Browse database](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/browse.py): `odxtools/cli/browse.py`
- [Compare databases](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/compare.py): `odxtools/cli/compare.py`
- [List services](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/list.py): `odxtools/cli/list.py`
- [Find services](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/find.py): `odxtools/cli/find.py`
- [Snoop traffic](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/snoop.py): `odxtools/cli/snoop.py`
- [Decode messages](https://github.com/nada-ben-ali/odxtools/blob/main/odxtools/cli/decode.py): `odxtools/cli/decode.py`

### Other components

- **Python user**
- **CLI user**

## Connections

- Python user → File loader: loads file (evidence: `README.md`)
- File loader → ODX database: builds database
- ODX database → Diagnostic layers: contains layers (evidence: `odxtools/database.py`)
- Diagnostic layers → ODX references: resolves references (evidence: `odxtools/diaglayers/diaglayer.py`)
- Diagnostic layers → Diagnostic services: provides services (evidence: `odxtools/diaglayers/diaglayer.py`)
- Diagnostic services → Requests: uses request (evidence: `odxtools/diagservice.py`)
- Diagnostic services → Responses: resolves responses (evidence: `odxtools/diagservice.py`)
- Diagnostic layers → Diagnostic communications: collects communications (evidence: `odxtools/diaglayers/diaglayer.py`)
- Python user → Diagnostic services: encodes request (evidence: `README.md`)
- Diagnostic services → Parameters: encodes parameters (evidence: `odxtools/diagservice.py`)
- Parameters → Encode state: updates state (evidence: `odxtools/parameters/parameter.py`)
- Parameters → Decode state: decodes values (evidence: `odxtools/parameters/parameter.py`)
- Parameters → Value conversions: converts values
- Python user → Diagnostic layers: decodes message (evidence: `README.md`)
- Python user → Responses: decodes response (evidence: `README.md`)
- CLI user → CLI dispatcher: runs commands (evidence: `README.md`)
- CLI dispatcher → Browse database: dispatches browse
- CLI dispatcher → Compare databases: dispatches compare (evidence: `odxtools/cli/main.py`)
- CLI user → List services: lists services (evidence: `README.md`)
- CLI user → Find services: finds services (evidence: `README.md`)
- CLI user → Snoop traffic: snoops traffic (evidence: `README.md`)
- CLI user → Decode messages: decodes messages (evidence: `README.md`)
- CLI dispatcher → ODX database: loads database (evidence: `odxtools/cli/main.py`)
- Browse database → ODX database: browses contents (evidence: `odxtools/cli/browse.py`)
- Compare databases → ODX database: compares contents (evidence: `odxtools/cli/compare.py`)
