# tomermeidan/genericprotocolreader architecture

> Architecture diagram of the GitHub repository tomermeidan/genericprotocolreader, 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/tomermeidan/genericprotocolreader
- Repository: https://github.com/tomermeidan/genericprotocolreader

## Overview

GenericProtocolReader is a .NET library for reading serial-port messages into typed protocol objects, with optional checksum validation; the demo shows how a consumer supplies a protocol type. The main flow initializes message metadata, opens the port, receives and frames bytes, optionally validates them, then deserializes the message and updates the latest-value state. The excerpts establish these links but do not show all internals of framing or checksum algorithm dispatch, so those connections are left unasserted.

Main entry points: [`GenericProtocolReader/Reader/GenericReader.cs`](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Reader/GenericReader.cs) (Generic reader), [`GenericProtocolReader/Reader/MessageManager.cs`](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Reader/MessageManager.cs) (Message setup), [`GenericProtocolReader/ErrorDetection`](https://github.com/tomermeidan/genericprotocolreader/tree/main/GenericProtocolReader/ErrorDetection) (Checksum algorithms), [`GenericProtocolReader/ErrorDetection/ErrorDetectionManager.cs`](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/ErrorDetectionManager.cs) (Checksum validation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Reader runtime"]
  node_reader["Generic reader<br/>[GenericReader.cs]"]
  node_transport["Serial transport<br/>[SerialPortComm.cs]"]
  node_latest["Latest message<br/>[EventfulValue.cs]"]
end

subgraph group_protocol["Protocol metadata"]
  node_extractor["Metadata extractor"]
  node_message_manager["Message setup<br/>[MessageManager.cs]"]
  node_demo_protocol["Demo message type<br/>[DemoProtocol.cs]"]
  node_message_counter["Counter attribute"]
  node_message_properties["Message properties"]
end

subgraph group_integrity["Integrity checks"]
  node_error_manager["Checksum validation"]
  node_checksum_algorithms["Checksum algorithms"]
  node_crc_base["CRC base<br/>[CrcBase.cs]"]
  node_checksum_base["Checksum base<br/>[ChecksumBase.cs]"]
  node_block_validator["Validator contract<br/>[IBlockValidator.cs]"]
end

node_consumer(("Application"))
node_serial["Serial device"]

node_consumer -->|"configures and starts"| node_reader
node_consumer -->|"supplies message type"| node_demo_protocol
node_serial -->|"provides port"| node_transport
node_reader -->|"starts communication"| node_transport
node_reader -->|"reads message metadata"| node_extractor
node_reader -->|"requests validation"| node_error_manager
node_reader -->|"updates latest message"| node_latest
node_message_manager -->|"delegates metadata lookup"| node_extractor
node_message_manager -->|"populates properties"| node_message_properties
node_message_manager -->|"finds counter attribute"| node_message_counter
node_error_manager -->|"reads checksum settings"| node_message_properties
node_checksum_algorithms -.->|"defines CRC base"| node_crc_base
node_checksum_algorithms -.->|"defines checksum base"| node_checksum_base
node_checksum_algorithms -.->|"defines validator contract"| node_block_validator

click node_reader "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Reader/GenericReader.cs"
click node_transport "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Serial%20Protocols/SerialPortComm.cs"
click node_latest "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Utils/EventfulValue.cs"
click node_extractor "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Helpers/MessageDataExtractor.cs"
click node_message_manager "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Reader/MessageManager.cs"
click node_demo_protocol "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericDemo/DemoProtocol.cs"
click node_message_counter "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Attributes/MessageCounterAttribute.cs"
click node_message_properties "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Utils/MessageProperties.cs"
click node_error_manager "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/ErrorDetectionManager.cs"
click node_checksum_algorithms "https://github.com/tomermeidan/genericprotocolreader/tree/main/GenericProtocolReader/ErrorDetection"
click node_crc_base "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/Abstract/CrcBase.cs"
click node_checksum_base "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/Abstract/ChecksumBase.cs"
click node_block_validator "https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/Abstract/IBlockValidator.cs"

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_reader,node_transport,node_latest toneBlue
class node_extractor,node_message_manager,node_demo_protocol,node_message_counter,node_message_properties toneAmber
class node_error_manager,node_checksum_algorithms,node_crc_base,node_checksum_base,node_block_validator toneMint
class node_consumer,node_serial toneIndigo
```

## Components

### Reader runtime

- [Generic reader](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Reader/GenericReader.cs): `GenericProtocolReader/Reader/GenericReader.cs`
- [Serial transport](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Serial%20Protocols/SerialPortComm.cs): `GenericProtocolReader/Serial Protocols/SerialPortComm.cs`
- [Latest message](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Utils/EventfulValue.cs): `GenericProtocolReader/Utils/EventfulValue.cs`

### Protocol metadata

- [Metadata extractor](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Helpers/MessageDataExtractor.cs): `GenericProtocolReader/Helpers/MessageDataExtractor.cs`
- [Message setup](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Reader/MessageManager.cs): `GenericProtocolReader/Reader/MessageManager.cs`
- [Demo message type](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericDemo/DemoProtocol.cs): `GenericDemo/DemoProtocol.cs`
- [Counter attribute](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Attributes/MessageCounterAttribute.cs): `GenericProtocolReader/Attributes/MessageCounterAttribute.cs`
- [Message properties](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/Utils/MessageProperties.cs): `GenericProtocolReader/Utils/MessageProperties.cs`

### Integrity checks

- [Checksum validation](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/ErrorDetectionManager.cs): `GenericProtocolReader/ErrorDetection/ErrorDetectionManager.cs`
- [Checksum algorithms](https://github.com/tomermeidan/genericprotocolreader/tree/main/GenericProtocolReader/ErrorDetection): `GenericProtocolReader/ErrorDetection`
- [CRC base](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/Abstract/CrcBase.cs): `GenericProtocolReader/ErrorDetection/Abstract/CrcBase.cs`
- [Checksum base](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/Abstract/ChecksumBase.cs): `GenericProtocolReader/ErrorDetection/Abstract/ChecksumBase.cs`
- [Validator contract](https://github.com/tomermeidan/genericprotocolreader/blob/main/GenericProtocolReader/ErrorDetection/Abstract/IBlockValidator.cs): `GenericProtocolReader/ErrorDetection/Abstract/IBlockValidator.cs`

### Other components

- **Application**
- **Serial device**

## Connections

- Application → Generic reader: configures and starts (evidence: `README.md`)
- Application → Demo message type: supplies message type (evidence: `README.md`)
- Serial device → Serial transport: provides port (evidence: `README.md`)
- Generic reader → Serial transport: starts communication (evidence: `GenericProtocolReader/Serial Protocols/SerialPortComm.cs`)
- Generic reader → Metadata extractor: reads message metadata (evidence: `GenericProtocolReader/Reader/MessageManager.cs`)
- Generic reader → Checksum validation: requests validation (evidence: `GenericProtocolReader/Reader/GenericReader.cs`)
- Generic reader → Latest message: updates latest message (evidence: `GenericProtocolReader/Reader/GenericReader.cs`)
- Message setup → Metadata extractor: delegates metadata lookup (evidence: `GenericProtocolReader/Reader/MessageManager.cs`)
- Message setup → Message properties: populates properties (evidence: `GenericProtocolReader/Reader/MessageManager.cs`)
- Message setup → Counter attribute: finds counter attribute (evidence: `GenericProtocolReader/Reader/MessageManager.cs`)
- Checksum validation → Message properties: reads checksum settings (evidence: `GenericProtocolReader/ErrorDetection/ErrorDetectionManager.cs`)
- Checksum algorithms → CRC base: defines CRC base (evidence: `GenericProtocolReader/ErrorDetection/Crc/CrcCcitt32Validator.cs`)
- Checksum algorithms → Checksum base: defines checksum base (evidence: `GenericProtocolReader/ErrorDetection/Checksum/SumChecksum.cs`)
- Checksum algorithms → Validator contract: defines validator contract (evidence: `GenericProtocolReader/ErrorDetection/Abstract/ICrcValidator.cs`)
