# mqtt-tools/mqttdecode architecture

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

- Interactive diagram: https://gitdiagram.com/mqtt-tools/mqttdecode
- Repository: https://github.com/mqtt-tools/mqttdecode

## Overview

mqttdecode is a command-line MQTT packet decoder. Users provide hex strings or packet data through arguments, stdin, or files; the tool decodes packets under MQTT 3.1.1 and/or 5.0 rules, reports malformed data, and presents human-readable output. The README documents input ordering, binary-file mode, protocol selection, colour, and separators. No source excerpts were available, so this map shows only documented runtime responsibilities and relationships; internal implementation boundaries are not verified.

Main entry points: [`mqttdecode`](https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode) (Packet decoder)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Decoder runtime"]
  node_inputs["Input sources"]
  node_decoder["Packet decoder"]
  node_protocols["Protocol versions"]
  node_validation["Error reporting"]
  node_formatter["Output formatter"]
end

node_user(("User"))
node_terminal["Human-readable results"]

node_user -->|"supplies data"| node_inputs
node_inputs -->|"provides packets"| node_decoder
node_decoder -->|"decodes versions"| node_protocols
node_decoder -->|"reports malformed data"| node_validation
node_decoder -->|"presents decoded packets"| node_formatter
node_protocols -->|"provides version results"| node_formatter
node_validation -->|"provides error details"| node_formatter
node_formatter -->|"prints results"| node_terminal

click node_inputs "https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode"
click node_decoder "https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode"
click node_protocols "https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode"
click node_validation "https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode"
click node_formatter "https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode"

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_inputs,node_decoder,node_protocols,node_validation,node_formatter,node_user toneBlue
class node_terminal toneIndigo
```

## Components

### Decoder runtime

- [Input sources](https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode): `mqttdecode`
- [Packet decoder](https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode): `mqttdecode`
- [Protocol versions](https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode): `mqttdecode`
- [Error reporting](https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode): `mqttdecode`
- [Output formatter](https://github.com/mqtt-tools/mqttdecode/blob/main/mqttdecode): `mqttdecode`

### Other components

- **User**
- **Human-readable results**

## Connections

- User → Input sources: supplies data (evidence: `README.md`)
- Input sources → Packet decoder: provides packets (evidence: `README.md`)
- Packet decoder → Protocol versions: decodes versions (evidence: `README.md`)
- Packet decoder → Error reporting: reports malformed data (evidence: `README.md`)
- Packet decoder → Output formatter: presents decoded packets (evidence: `README.md`)
- Protocol versions → Output formatter: provides version results (evidence: `README.md`)
- Error reporting → Output formatter: provides error details (evidence: `README.md`)
- Output formatter → Human-readable results: prints results (evidence: `README.md`)
