# muki01/obd2_kline_library architecture

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

- Interactive diagram: https://gitdiagram.com/muki01/obd2_kline_library
- Repository: https://github.com/muki01/obd2_kline_library

## Overview

This is an Arduino/ESP32 library for vehicle diagnostics over K-Line. A sketch configures a protocol and initialization method, requests standard OBD-II or manufacturer-specific data, and receives decoded results through the serial bus. The architecture separates diagnostic services, protocol framing and handshakes, and byte-level hardware I/O. README-described manufacturer diagnostics are represented at their documented ECU-directory boundary because their implementations are not present in the supplied tree; relationships are limited to documented or excerpted evidence.

Main entry points: [`src/KLine_Protocol.cpp`](https://github.com/muki01/obd2_kline_library/blob/main/src/KLine_Protocol.cpp) (Protocol framing), [`src/OBD2_KLine_Core.cpp`](https://github.com/muki01/obd2_kline_library/blob/main/src/OBD2_KLine_Core.cpp) (Serial and signals), [`src/ecus/OBD2_Standard.cpp`](https://github.com/muki01/obd2_kline_library/blob/main/src/ecus/OBD2_Standard.cpp) (Standard OBD-II), [`src/ecus`](https://github.com/muki01/obd2_kline_library/tree/main/src/ecus) (Manufacturer services)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_diagnostics["Diagnostic services"]
  node_standard["Standard OBD-II<br/>[OBD2_Standard.cpp]"]
  node_manufacturer["Manufacturer services"]
end

subgraph group_protocol["Protocol handling"]
  node_api["Library entry header<br/>[OBD2_KLine.h]"]
  node_protocol["Protocol framing<br/>[KLine_Protocol.cpp]"]
end

subgraph group_transport["K-Line transport"]
  node_core["Serial and signals"]
end

subgraph group_utilities["Shared utilities"]
  node_helpers["Checksum and decoding"]
end

node_sketch(("Arduino sketch"))
node_ecu(("Vehicle ECU"))

node_sketch -->|"requests diagnostics"| node_standard
node_sketch -.->|"requests services"| node_manufacturer
node_sketch -->|"includes library"| node_api
node_standard -->|"inherits protocol API"| node_protocol
node_protocol -->|"uses byte I/O"| node_core
node_protocol -->|"verifies checksums"| node_helpers
node_core -->|"exchanges bytes"| node_ecu
node_ecu -->|"returns responses"| node_core

click node_standard "https://github.com/muki01/obd2_kline_library/blob/main/src/ecus/OBD2_Standard.cpp"
click node_manufacturer "https://github.com/muki01/obd2_kline_library/tree/main/src/ecus"
click node_api "https://github.com/muki01/obd2_kline_library/blob/main/src/OBD2_KLine.h"
click node_protocol "https://github.com/muki01/obd2_kline_library/blob/main/src/KLine_Protocol.cpp"
click node_core "https://github.com/muki01/obd2_kline_library/blob/main/src/OBD2_KLine_Core.cpp"
click node_helpers "https://github.com/muki01/obd2_kline_library/blob/main/src/KLine_Functions.cpp"

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_standard,node_manufacturer toneBlue
class node_api,node_protocol toneAmber
class node_core toneMint
class node_helpers toneRose
class node_sketch,node_ecu toneIndigo
```

## Components

### Diagnostic services

- [Standard OBD-II](https://github.com/muki01/obd2_kline_library/blob/main/src/ecus/OBD2_Standard.cpp): `src/ecus/OBD2_Standard.cpp`
- [Manufacturer services](https://github.com/muki01/obd2_kline_library/tree/main/src/ecus): `src/ecus`

### Protocol handling

- [Library entry header](https://github.com/muki01/obd2_kline_library/blob/main/src/OBD2_KLine.h): `src/OBD2_KLine.h`
- [Protocol framing](https://github.com/muki01/obd2_kline_library/blob/main/src/KLine_Protocol.cpp): `src/KLine_Protocol.cpp`

### K-Line transport

- [Serial and signals](https://github.com/muki01/obd2_kline_library/blob/main/src/OBD2_KLine_Core.cpp): `src/OBD2_KLine_Core.cpp`

### Shared utilities

- [Checksum and decoding](https://github.com/muki01/obd2_kline_library/blob/main/src/KLine_Functions.cpp): `src/KLine_Functions.cpp`

### Other components

- **Arduino sketch**
- **Vehicle ECU**

## Connections

- Arduino sketch → Standard OBD-II: requests diagnostics (evidence: `README.md`)
- Arduino sketch → Manufacturer services: requests services (evidence: `README.md`)
- Arduino sketch → Library entry header: includes library (evidence: `src/OBD2_KLine.h`)
- Standard OBD-II → Protocol framing: inherits protocol API
- Protocol framing → Serial and signals: uses byte I/O
- Protocol framing → Checksum and decoding: verifies checksums (evidence: `src/KLine_Protocol.cpp`)
- Serial and signals → Vehicle ECU: exchanges bytes (evidence: `README.md`)
- Vehicle ECU → Serial and signals: returns responses (evidence: `README.md`)
