# solidsoils/arduino architecture

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

- Interactive diagram: https://gitdiagram.com/solidsoils/arduino
- Repository: https://github.com/solidsoils/arduino

## Overview

SolidSoils4Arduino is a .NET client library for communicating with Arduino boards over serial. The principal workflow is to establish a serial connection, create an ArduinoSession, issue protocol requests or commands, and receive parsed responses and state updates. The session brokers Firmata, I2C, and ASCII traffic; Firmata also exposes board and pin capabilities, servo control, and observable state monitors. Edges reflect the README and SOURCE INDEX references, plus sampled calls; unsampled implementation details are not assumed.

Main entry points: [`Solid.Arduino/ArduinoSession.cs`](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ArduinoSession.cs) (Arduino session), [`Solid.Arduino/Firmata/IFirmataProtocol.cs`](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/IFirmataProtocol.cs) (Firmata protocol API), [`Solid.Arduino/ObservableEventTracker.cs`](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ObservableEventTracker.cs) (Observable tracker), [`Solid.Arduino/SerialConnection.cs`](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/SerialConnection.cs) (Serial connection)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_connection["Serial connectivity"]
  node_connection_api["Connection contract"]
  node_serial["Serial connection"]
  node_enhanced["Enhanced connection"]
end

subgraph group_session["Session and routing"]
  node_session_core["Arduino session<br/>[ArduinoSession.cs]"]
end

subgraph group_protocols["Board protocols"]
  node_firmata_api["Firmata protocol API"]
  node_firmata_commands["Firmata commands<br/>[ArduinoSession.cs]"]
  node_capabilities["Board capabilities<br/>[BoardCapability.cs]"]
  node_servo["Servo protocol<br/>[IServoProtocol.cs]"]
  node_i2c_api["I2C protocol API<br/>[II2cProtocol.cs]"]
  node_ascii_api["ASCII protocol API<br/>[IStringProtocol.cs]"]
end

subgraph group_events["Responses and monitoring"]
  node_i2c_replies["I2C replies<br/>[I2cReply.cs]"]
  node_string_tracker["Received strings"]
  node_firmata_messages["Firmata messages<br/>[FirmataMessage.cs]"]
  node_firmata_events["Message events"]
  node_analog_state["Analog state<br/>[AnalogState.cs]"]
  node_digital_state["Digital port state"]
  node_analog_tracker["Analog monitors"]
  node_digital_tracker["Digital monitors"]
  node_observable_tracker["Observable tracker"]
end

node_application(("Client application"))
node_arduino(("Arduino board"))

node_application -->|"creates connection"| node_enhanced
node_enhanced -->|"uses serial port"| node_serial
node_serial -->|"implements"| node_connection_api
node_application -->|"creates session"| node_session_core
node_session_core -->|"opens and writes"| node_connection_api
node_session_core -->|"exposes protocol"| node_firmata_api
node_session_core -->|"exposes protocol"| node_i2c_api
node_session_core -->|"routes strings"| node_ascii_api
node_firmata_api -->|"defines commands"| node_firmata_commands
node_application -->|"requests board data"| node_firmata_api
node_firmata_api -->|"returns capabilities"| node_capabilities
node_firmata_api -->|"supports servo control"| node_servo
node_application -->|"requests I2C data"| node_i2c_api
node_session_core -->|"produces replies"| node_i2c_replies
node_session_core -->|"buffers messages"| node_firmata_messages
node_firmata_messages -->|"wrapped for events"| node_firmata_events
node_firmata_api -->|"reports analog state"| node_analog_state
node_firmata_api -->|"reports digital state"| node_digital_state
node_firmata_api -->|"creates monitors"| node_analog_tracker
node_firmata_api -->|"creates monitors"| node_digital_tracker
node_analog_tracker -->|"inherits tracker"| node_observable_tracker
node_digital_tracker -->|"inherits tracker"| node_observable_tracker
node_arduino -->|"sends responses"| node_session_core
node_session_core -->|"sends protocol data"| node_arduino
node_string_tracker -->|"uses tracker base"| node_observable_tracker
node_session_core -->|"tracks received strings"| node_string_tracker

click node_connection_api "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ISerialConnection.cs"
click node_serial "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/SerialConnection.cs"
click node_enhanced "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/EnhancedSerialConnection.cs"
click node_session_core "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ArduinoSession.cs"
click node_firmata_api "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/IFirmataProtocol.cs"
click node_firmata_commands "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ArduinoSession.cs"
click node_capabilities "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/BoardCapability.cs"
click node_servo "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/Servo/IServoProtocol.cs"
click node_i2c_api "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/I2c/II2cProtocol.cs"
click node_i2c_replies "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/I2c/I2cReply.cs"
click node_ascii_api "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/IStringProtocol.cs"
click node_string_tracker "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ReceivedStringTracker.cs"
click node_firmata_messages "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/FirmataMessage.cs"
click node_firmata_events "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/FirmataMessageEventArgs.cs"
click node_analog_state "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/AnalogState.cs"
click node_digital_state "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/DigitalPortState.cs"
click node_analog_tracker "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/AnalogStateTracker.cs"
click node_digital_tracker "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/DigitalStateTracker.cs"
click node_observable_tracker "https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ObservableEventTracker.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_connection_api,node_serial,node_enhanced,node_application toneBlue
class node_session_core toneAmber
class node_firmata_api,node_firmata_commands,node_capabilities,node_servo,node_i2c_api,node_ascii_api toneMint
class node_i2c_replies,node_string_tracker,node_firmata_messages,node_firmata_events,node_analog_state,node_digital_state,node_analog_tracker,node_digital_tracker,node_observable_tracker toneRose
class node_arduino toneIndigo
```

## Components

### Serial connectivity

- [Connection contract](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ISerialConnection.cs): `Solid.Arduino/ISerialConnection.cs`
- [Serial connection](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/SerialConnection.cs): `Solid.Arduino/SerialConnection.cs`
- [Enhanced connection](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/EnhancedSerialConnection.cs): `Solid.Arduino/EnhancedSerialConnection.cs`

### Session and routing

- [Arduino session](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ArduinoSession.cs): `Solid.Arduino/ArduinoSession.cs`

### Board protocols

- [Firmata protocol API](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/IFirmataProtocol.cs): `Solid.Arduino/Firmata/IFirmataProtocol.cs`
- [Firmata commands](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ArduinoSession.cs): `Solid.Arduino/ArduinoSession.cs`
- [Board capabilities](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/BoardCapability.cs): `Solid.Arduino/Firmata/BoardCapability.cs`
- [Servo protocol](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/Servo/IServoProtocol.cs): `Solid.Arduino/Firmata/Servo/IServoProtocol.cs`
- [I2C protocol API](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/I2c/II2cProtocol.cs): `Solid.Arduino/I2c/II2cProtocol.cs`
- [ASCII protocol API](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/IStringProtocol.cs): `Solid.Arduino/IStringProtocol.cs`

### Responses and monitoring

- [I2C replies](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/I2c/I2cReply.cs): `Solid.Arduino/I2c/I2cReply.cs`
- [Received strings](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ReceivedStringTracker.cs): `Solid.Arduino/ReceivedStringTracker.cs`
- [Firmata messages](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/FirmataMessage.cs): `Solid.Arduino/Firmata/FirmataMessage.cs`
- [Message events](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/FirmataMessageEventArgs.cs): `Solid.Arduino/Firmata/FirmataMessageEventArgs.cs`
- [Analog state](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/AnalogState.cs): `Solid.Arduino/Firmata/AnalogState.cs`
- [Digital port state](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/DigitalPortState.cs): `Solid.Arduino/Firmata/DigitalPortState.cs`
- [Analog monitors](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/AnalogStateTracker.cs): `Solid.Arduino/Firmata/AnalogStateTracker.cs`
- [Digital monitors](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/Firmata/DigitalStateTracker.cs): `Solid.Arduino/Firmata/DigitalStateTracker.cs`
- [Observable tracker](https://github.com/solidsoils/arduino/blob/master/Solid.Arduino/ObservableEventTracker.cs): `Solid.Arduino/ObservableEventTracker.cs`

### Other components

- **Client application**
- **Arduino board**

## Connections

- Client application → Enhanced connection: creates connection
- Enhanced connection → Serial connection: uses serial port (evidence: `Solid.Arduino/EnhancedSerialConnection.cs`)
- Serial connection → Connection contract: implements (evidence: `Solid.Arduino/SerialConnection.cs`)
- Client application → Arduino session: creates session
- Arduino session → Connection contract: opens and writes (evidence: `Solid.Arduino/ArduinoSession.cs`)
- Arduino session → Firmata protocol API: exposes protocol (evidence: `Solid.Arduino/ArduinoSession.cs`)
- Arduino session → I2C protocol API: exposes protocol (evidence: `Solid.Arduino/ArduinoSession.cs`)
- Arduino session → ASCII protocol API: routes strings (evidence: `Solid.Arduino/ArduinoSession.cs`)
- Firmata protocol API → Firmata commands: defines commands (evidence: `Solid.Arduino/Firmata/IFirmataProtocol.cs`)
- Client application → Firmata protocol API: requests board data
- Firmata protocol API → Board capabilities: returns capabilities (evidence: `Solid.Arduino/Firmata/IFirmataProtocol.cs`)
- Firmata protocol API → Servo protocol: supports servo control (evidence: `Solid.Arduino/ArduinoSession.cs`)
- Client application → I2C protocol API: requests I2C data
- Arduino session → I2C replies: produces replies (evidence: `Solid.Arduino/ArduinoSession.cs`)
- Arduino session → Firmata messages: buffers messages (evidence: `Solid.Arduino/ArduinoSession.cs`)
- Firmata messages → Message events: wrapped for events (evidence: `Solid.Arduino/Firmata/FirmataMessageEventArgs.cs`)
- Firmata protocol API → Analog state: reports analog state (evidence: `Solid.Arduino/Firmata/IFirmataProtocol.cs`)
- Firmata protocol API → Digital port state: reports digital state (evidence: `Solid.Arduino/Firmata/IFirmataProtocol.cs`)
- Firmata protocol API → Analog monitors: creates monitors (evidence: `Solid.Arduino/Firmata/IFirmataProtocol.cs`)
- Firmata protocol API → Digital monitors: creates monitors (evidence: `Solid.Arduino/Firmata/IFirmataProtocol.cs`)
- Analog monitors → Observable tracker: inherits tracker (evidence: `Solid.Arduino/Firmata/AnalogStateTracker.cs`)
- Digital monitors → Observable tracker: inherits tracker (evidence: `Solid.Arduino/Firmata/DigitalStateTracker.cs`)
- Arduino board → Arduino session: sends responses
- Arduino session → Arduino board: sends protocol data (evidence: `Solid.Arduino/ArduinoSession.cs`)
- Received strings → Observable tracker: uses tracker base (evidence: `Solid.Arduino/ReceivedStringTracker.cs`)
- Arduino session → Received strings: tracks received strings (evidence: `Solid.Arduino/ArduinoSession.cs`)
