# debevv/nanomodbus architecture

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

- Interactive diagram: https://gitdiagram.com/debevv/nanomodbus
- Repository: https://github.com/debevv/nanomodbus
- Video tour (about a minute): https://gitdiagram.com/debevv/nanomodbus/video

## Overview

nanoMODBUS is a compact C99 Modbus RTU/TCP library for embedded applications. A host configures transport callbacks, creates a client or server, then client API calls exchange requests and responses while a server polls, dispatches function codes, and invokes application callbacks. The single implementation file contains protocol framing and client/server logic; the header defines the public API and configuration types. The README documents transports, roles, function-code coverage, optional CRC/flush hooks, and broadcast support. Source excerpts are partial, so internal links are limited to relationships visible in them or stated in the README.

Main entry points: [`nanomodbus.c`](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c) (Function dispatch), [`nanomodbus.h`](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h) (Application callbacks)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Public API"]
  node_api_config["Configuration API<br/>[nanomodbus.h]"]
  node_client_api["Client API<br/>[nanomodbus.h]"]
  node_server_api["Server API<br/>[nanomodbus.h]"]
end

subgraph group_protocol["Protocol Runtime"]
  node_client_ops["Client operations<br/>[nanomodbus.c]"]
  node_framing["RTU/TCP framing<br/>[nanomodbus.c]"]
  node_crc["CRC calculation<br/>[nanomodbus.c]"]
end

subgraph group_server["Server Runtime"]
  node_server_poll["Server polling<br/>[nanomodbus.c]"]
  node_function_dispatch["Function dispatch<br/>[nanomodbus.c]"]
  node_register_handlers["Register handlers<br/>[nanomodbus.c]"]
  node_bitfield_handlers["Coil handlers<br/>[nanomodbus.c]"]
  node_file_record_handlers["File records<br/>[nanomodbus.c]"]
  node_device_id_handler["Device identification<br/>[nanomodbus.c]"]
end

subgraph group_platform["Platform Boundary"]
  node_transport_callbacks["Transport callbacks<br/>[nanomodbus.h]"]
  node_server_callbacks["Application callbacks<br/>[nanomodbus.h]"]
end

node_application(("Application"))
node_user_transport["User transport"]
node_application_data[("Application data")]

node_application -->|"configures"| node_api_config
node_application -->|"calls"| node_client_api
node_application -->|"creates"| node_server_api
node_api_config -->|"sets callbacks"| node_transport_callbacks
node_transport_callbacks -->|"delegates I/O"| node_user_transport
node_client_api -->|"invokes"| node_client_ops
node_client_ops -.->|"exchanges frames"| node_framing
node_framing -.->|"reads/writes"| node_transport_callbacks
node_server_api -.->|"polls"| node_server_poll
node_server_poll -->|"dispatches"| node_function_dispatch
node_function_dispatch -->|"routes"| node_register_handlers
node_function_dispatch -->|"routes"| node_bitfield_handlers
node_function_dispatch -->|"routes"| node_file_record_handlers
node_function_dispatch -.->|"routes"| node_device_id_handler
node_server_poll -.->|"receives/sends"| node_framing
node_register_handlers -->|"invokes"| node_server_callbacks
node_bitfield_handlers -.->|"invokes"| node_server_callbacks
node_file_record_handlers -.->|"invokes"| node_server_callbacks
node_device_id_handler -.->|"invokes"| node_server_callbacks
node_server_callbacks -->|"accesses"| node_application_data
node_framing -.->|"uses"| node_crc

click node_api_config "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h"
click node_client_api "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h"
click node_server_api "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h"
click node_client_ops "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_server_poll "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_function_dispatch "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_register_handlers "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_bitfield_handlers "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_file_record_handlers "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_device_id_handler "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_framing "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_crc "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c"
click node_transport_callbacks "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h"
click node_server_callbacks "https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h"

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_config,node_client_api,node_server_api,node_user_transport toneBlue
class node_client_ops,node_framing,node_crc,node_application_data toneAmber
class node_server_poll,node_function_dispatch,node_register_handlers,node_bitfield_handlers,node_file_record_handlers,node_device_id_handler toneMint
class node_transport_callbacks,node_server_callbacks toneRose
class node_application toneIndigo
```

## Components

### Public API

- [Configuration API](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h): `nanomodbus.h`
- [Client API](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h): `nanomodbus.h`
- [Server API](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h): `nanomodbus.h`

### Protocol Runtime

- [Client operations](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`
- [RTU/TCP framing](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`
- [CRC calculation](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`

### Server Runtime

- [Server polling](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`
- [Function dispatch](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`
- [Register handlers](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`
- [Coil handlers](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`
- [File records](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`
- [Device identification](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.c): `nanomodbus.c`

### Platform Boundary

- [Transport callbacks](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h): `nanomodbus.h`
- [Application callbacks](https://github.com/debevv/nanomodbus/blob/master/nanomodbus.h): `nanomodbus.h`

### Other components

- **Application**
- **User transport**
- **Application data**

## Connections

- Application → Configuration API: configures (evidence: `README.md`)
- Application → Client API: calls (evidence: `README.md`)
- Application → Server API: creates (evidence: `nanomodbus.h`)
- Configuration API → Transport callbacks: sets callbacks (evidence: `nanomodbus.h`)
- Transport callbacks → User transport: delegates I/O (evidence: `README.md`)
- Client API → Client operations: invokes (evidence: `nanomodbus.h`)
- Client operations → RTU/TCP framing: exchanges frames (evidence: `nanomodbus.c`)
- RTU/TCP framing → Transport callbacks: reads/writes (evidence: `nanomodbus.c`)
- Server API → Server polling: polls (evidence: `nanomodbus.c`)
- Server polling → Function dispatch: dispatches (evidence: `nanomodbus.c`)
- Function dispatch → Register handlers: routes (evidence: `nanomodbus.c`)
- Function dispatch → Coil handlers: routes (evidence: `nanomodbus.c`)
- Function dispatch → File records: routes (evidence: `nanomodbus.c`)
- Function dispatch → Device identification: routes (evidence: `nanomodbus.c`)
- Server polling → RTU/TCP framing: receives/sends (evidence: `nanomodbus.c`)
- Register handlers → Application callbacks: invokes (evidence: `nanomodbus.c`)
- Coil handlers → Application callbacks: invokes (evidence: `nanomodbus.c`)
- File records → Application callbacks: invokes (evidence: `nanomodbus.c`)
- Device identification → Application callbacks: invokes (evidence: `nanomodbus.c`)
- Application callbacks → Application data: accesses (evidence: `nanomodbus.h`)
- RTU/TCP framing → CRC calculation: uses (evidence: `nanomodbus.c`)
