# famouspotatoes1/can-dbc architecture

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

- Interactive diagram: https://gitdiagram.com/famouspotatoes1/can-dbc
- Repository: https://github.com/famouspotatoes1/can-dbc

## Overview

DBC-CAN is a JavaScript/TypeScript library for parsing and editing CAN DBC files, decoding and encoding CAN frames, and writing DBC output. The main workflow is a consumer loading a DBC file into the library’s data model, where parsed definitions become messages, signals, and related metadata; consumers can then inspect or modify that model, use CAN frame operations, or write it back out. Parser and CAN internals are shown where the supplied excerpts support them; several documented capabilities are represented at their owning module without inferring unsampled call details.

Main entry points: [`src/dbc/dbc.ts`](https://github.com/famouspotatoes1/can-dbc/blob/main/src/dbc/dbc.ts) (DBC management), [`src/can/can.ts`](https://github.com/famouspotatoes1/can-dbc/blob/main/src/can/can.ts) (Frame encode/decode), [`src/dbc/types.ts`](https://github.com/famouspotatoes1/can-dbc/blob/main/src/dbc/types.ts) (DBC data model), [`src/index.ts`](https://github.com/famouspotatoes1/can-dbc/blob/main/src/index.ts) (Public exports)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_public["Library API and DBC model"]
  node_api["Public exports<br/>[index.ts]"]
  node_dbc["DBC management<br/>[dbc.ts]"]
  node_model["DBC data model<br/>[types.ts]"]
end

subgraph group_parse["DBC parsing"]
  node_parser["Line parser<br/>[dbcParser.ts]"]
  node_grammar["Grammar parser<br/>[parser.ts]"]
  node_helpers["Parse helpers<br/>[parserHelpers.ts]"]
end

subgraph group_can["CAN frame operations"]
  node_can["Frame encode/decode<br/>[can.ts]"]
  node_bits["Bit utilities<br/>[BitUtils.ts]"]
end

subgraph group_write["DBC output"]
  node_writer["DBC writer<br/>[writer.ts]"]
end

node_consumer(("Library consumer"))
node_dbcfile["DBC file"]
node_filesystem["Filesystem"]

node_consumer -->|"uses"| node_api
node_api -->|"exports"| node_dbc
node_api -->|"exports"| node_can
node_consumer -->|"loads or edits"| node_dbc
node_dbc -->|"reads"| node_dbcfile
node_dbc -->|"parses lines"| node_parser
node_parser -->|"parses text"| node_grammar
node_grammar -->|"uses helpers"| node_helpers
node_parser -->|"updates data"| node_model
node_dbc -->|"manages data"| node_model
node_consumer -->|"decodes or encodes"| node_can
node_can -->|"reads definitions"| node_model
node_can -->|"uses bit operations"| node_bits
node_consumer -->|"writes data"| node_dbc
node_dbc -->|"constructs output"| node_writer
node_writer -->|"serializes data"| node_model
node_writer -->|"writes file"| node_filesystem
node_filesystem -->|"stores output"| node_dbcfile

click node_api "https://github.com/famouspotatoes1/can-dbc/blob/main/src/index.ts"
click node_dbc "https://github.com/famouspotatoes1/can-dbc/blob/main/src/dbc/dbc.ts"
click node_model "https://github.com/famouspotatoes1/can-dbc/blob/main/src/dbc/types.ts"
click node_parser "https://github.com/famouspotatoes1/can-dbc/blob/main/src/parser/dbcParser.ts"
click node_grammar "https://github.com/famouspotatoes1/can-dbc/blob/main/src/parser/parser.ts"
click node_helpers "https://github.com/famouspotatoes1/can-dbc/blob/main/src/parser/parserHelpers.ts"
click node_can "https://github.com/famouspotatoes1/can-dbc/blob/main/src/can/can.ts"
click node_bits "https://github.com/famouspotatoes1/can-dbc/blob/main/src/can/BitUtils.ts"
click node_writer "https://github.com/famouspotatoes1/can-dbc/blob/main/src/dbc/writer.ts"

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_api,node_dbc,node_model toneBlue
class node_parser,node_grammar,node_helpers toneAmber
class node_can,node_bits toneMint
class node_writer toneRose
class node_consumer,node_dbcfile,node_filesystem toneIndigo
```

## Components

### Library API and DBC model

- [Public exports](https://github.com/famouspotatoes1/can-dbc/blob/main/src/index.ts): `src/index.ts`
- [DBC management](https://github.com/famouspotatoes1/can-dbc/blob/main/src/dbc/dbc.ts): `src/dbc/dbc.ts`
- [DBC data model](https://github.com/famouspotatoes1/can-dbc/blob/main/src/dbc/types.ts): `src/dbc/types.ts`

### DBC parsing

- [Line parser](https://github.com/famouspotatoes1/can-dbc/blob/main/src/parser/dbcParser.ts): `src/parser/dbcParser.ts`
- [Grammar parser](https://github.com/famouspotatoes1/can-dbc/blob/main/src/parser/parser.ts): `src/parser/parser.ts`
- [Parse helpers](https://github.com/famouspotatoes1/can-dbc/blob/main/src/parser/parserHelpers.ts): `src/parser/parserHelpers.ts`

### CAN frame operations

- [Frame encode/decode](https://github.com/famouspotatoes1/can-dbc/blob/main/src/can/can.ts): `src/can/can.ts`
- [Bit utilities](https://github.com/famouspotatoes1/can-dbc/blob/main/src/can/BitUtils.ts): `src/can/BitUtils.ts`

### DBC output

- [DBC writer](https://github.com/famouspotatoes1/can-dbc/blob/main/src/dbc/writer.ts): `src/dbc/writer.ts`

### Other components

- **Library consumer**
- **DBC file**
- **Filesystem**

## Connections

- Library consumer → Public exports: uses (evidence: `README.md`)
- Public exports → DBC management: exports (evidence: `src/index.ts`)
- Public exports → Frame encode/decode: exports (evidence: `src/index.ts`)
- Library consumer → DBC management: loads or edits (evidence: `README.md`)
- DBC management → DBC file: reads (evidence: `src/dbc/dbc.ts`)
- DBC management → Line parser: parses lines (evidence: `src/dbc/dbc.ts`)
- Line parser → Grammar parser: parses text (evidence: `src/parser/dbcParser.ts`)
- Grammar parser → Parse helpers: uses helpers (evidence: `src/parser/parser.ts`)
- Line parser → DBC data model: updates data (evidence: `src/parser/dbcParser.ts`)
- DBC management → DBC data model: manages data (evidence: `src/dbc/dbc.ts`)
- Library consumer → Frame encode/decode: decodes or encodes (evidence: `README.md`)
- Frame encode/decode → DBC data model: reads definitions (evidence: `src/can/can.ts`)
- Frame encode/decode → Bit utilities: uses bit operations (evidence: `src/can/can.ts`)
- Library consumer → DBC management: writes data (evidence: `README.md`)
- DBC management → DBC writer: constructs output (evidence: `src/dbc/dbc.ts`)
- DBC writer → DBC data model: serializes data (evidence: `src/dbc/writer.ts`)
- DBC writer → Filesystem: writes file (evidence: `src/dbc/writer.ts`)
- Filesystem → DBC file: stores output
