# marine-assistant/marineassistant architecture

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

## Overview

Marine Assistant is firmware for monitoring and controlling an aquarium, with Home Assistant integration and local-network operation. The documented workflow connects sensors and controllable devices to the system, which monitors conditions, controls equipment, and communicates with Home Assistant for dashboards, automations, and alerts. The repository listing contains no source excerpts, so the map reflects README-documented capabilities only; it cannot establish internal module boundaries or more detailed call flow.

Main entry points: [`Sensor-module-code`](https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code) (Marine Assistant firmware)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_monitoring["Aquarium monitoring"]
  node_sensors["Aquarium sensors"]
  node_firmware["Marine Assistant firmware"]
  node_water_monitoring["Water monitoring"]
  node_analog_sensors["Analog sensor support"]
end

subgraph group_control["Equipment control"]
  node_controlled_devices["Controlled devices"]
  node_device_control["Device control"]
end

subgraph group_integration["Home Assistant integration"]
  node_home_assistant["Home Assistant"]
  node_mqtt_integration["MQTT integration"]
  node_dashboards_automations["Dashboards and automations"]
end

node_user(("Aquarium operator"))

node_sensors -->|"provide readings"| node_firmware
node_firmware -->|"monitors conditions"| node_water_monitoring
node_firmware -->|"supports sensors"| node_analog_sensors
node_firmware -->|"controls equipment"| node_device_control
node_device_control -->|"controls devices"| node_controlled_devices
node_firmware -->|"communicates via MQTT"| node_mqtt_integration
node_mqtt_integration -->|"integrates with"| node_home_assistant
node_home_assistant -->|"configures"| node_dashboards_automations
node_user -->|"configures"| node_dashboards_automations

click node_firmware "https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code"
click node_water_monitoring "https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code"
click node_analog_sensors "https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code"
click node_device_control "https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code"
click node_mqtt_integration "https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code"

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_sensors,node_firmware,node_water_monitoring,node_analog_sensors toneBlue
class node_controlled_devices,node_device_control toneAmber
class node_home_assistant,node_mqtt_integration,node_dashboards_automations toneMint
class node_user toneIndigo
```

## Components

### Aquarium monitoring

- **Aquarium sensors**
- [Marine Assistant firmware](https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code): `Sensor-module-code`
- [Water monitoring](https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code): `Sensor-module-code`
- [Analog sensor support](https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code): `Sensor-module-code`

### Equipment control

- **Controlled devices**
- [Device control](https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code): `Sensor-module-code`

### Home Assistant integration

- **Home Assistant**
- [MQTT integration](https://github.com/marine-assistant/marineassistant/blob/main/Sensor-module-code): `Sensor-module-code`
- **Dashboards and automations**

### Other components

- **Aquarium operator**

## Connections

- Aquarium sensors → Marine Assistant firmware: provide readings (evidence: `README.md`)
- Marine Assistant firmware → Water monitoring: monitors conditions (evidence: `README.md`)
- Marine Assistant firmware → Analog sensor support: supports sensors (evidence: `README.md`)
- Marine Assistant firmware → Device control: controls equipment (evidence: `README.md`)
- Device control → Controlled devices: controls devices (evidence: `README.md`)
- Marine Assistant firmware → MQTT integration: communicates via MQTT (evidence: `README.md`)
- MQTT integration → Home Assistant: integrates with (evidence: `README.md`)
- Home Assistant → Dashboards and automations: configures (evidence: `README.md`)
- Aquarium operator → Dashboards and automations: configures (evidence: `README.md`)
