# patric1304/water-quality-iot-project architecture

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

- Interactive diagram: https://gitdiagram.com/patric1304/water-quality-iot-project
- Repository: https://github.com/patric1304/water-quality-iot-project

## Overview

The product is an IoT water-quality monitoring system. Its primary workflow samples pH, TDS, turbidity, and temperature on a Raspberry Pi, publishes readings through AWS IoT Core and Lambda, stores and analyzes them in Django, then serves a dashboard and alert history. The ML branch trains an LSTM autoencoder and uses its exported model for inference; Lambda also applies the documented alert decision matrix and can notify through SNS. Relationships for cloud services and unsampled dashboard behavior follow the README; source excerpts provide the Pi, backend, and ML implementation evidence.

Main entry points: [`backend/monitor/views.py`](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/views.py) (Reading API), [`pi/main.py`](https://github.com/patric1304/water-quality-iot-project/blob/main/pi/main.py) (Reading loop), [`lambda/handler.py`](https://github.com/patric1304/water-quality-iot-project/blob/main/lambda/handler.py) (Ingestion and alerts), [`backend/monitor/ml_inference.py`](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/ml_inference.py) (Anomaly inference)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_edge["Edge sensing"]
  node_ph["pH sensor<br/>[ph.py]"]
  node_tds["TDS sensor<br/>[tds.py]"]
  node_turbidity["Turbidity sensor<br/>[turbidity.py]"]
  node_temperature["Temperature sensor<br/>[temperature.py]"]
  node_pi_loop["Reading loop<br/>[main.py]"]
end

subgraph group_cloud["Cloud ingestion"]
  node_iot["IoT Core"]
  node_lambda["Ingestion and alerts<br/>[handler.py]"]
end

subgraph group_backend["Backend monitoring"]
  node_api["Reading API<br/>[views.py]"]
  node_api_routes["API routes<br/>[urls.py]"]
  node_api_auth["API key auth<br/>[authentication.py]"]
  node_reading_model[("Reading records<br/>[models.py]")]
  node_serializer["Reading serializer<br/>[serializers.py]"]
end

subgraph group_ml["Anomaly detection"]
  node_inference["Anomaly inference<br/>[ml_inference.py]"]
  node_features["Feature engineering"]
  node_trainer["Model training<br/>[train_model.py]"]
  node_model_assets["Exported model assets<br/>[model.onnx]"]
end

subgraph group_presentation["Dashboard and alerts"]
  node_dashboard["Web dashboard<br/>[dashboard.html]"]
  node_sns["Amazon SNS"]
end

node_operator(("Water operator"))
node_recipients(("Email and SMS recipients"))

node_pi_loop -->|"reads"| node_ph
node_pi_loop -->|"reads"| node_tds
node_pi_loop -->|"reads"| node_turbidity
node_pi_loop -->|"reads"| node_temperature
node_pi_loop -->|"publishes readings"| node_iot
node_iot -->|"triggers"| node_lambda
node_lambda -->|"posts reading"| node_api
node_api_routes -->|"routes requests"| node_api
node_api -->|"checks write access"| node_api_auth
node_api -->|"serializes readings"| node_serializer
node_api -->|"reads and writes"| node_reading_model
node_api -->|"runs inference"| node_inference
node_inference -->|"engineers features"| node_features
node_trainer -->|"engineers training data"| node_features
node_trainer -.->|"exports model"| node_model_assets
node_inference -.->|"loads model assets"| node_model_assets
node_lambda -->|"publishes alerts"| node_sns
node_sns -->|"sends notifications"| node_recipients
node_operator -->|"views status"| node_dashboard
node_dashboard -.->|"requests readings"| node_api
node_operator -->|"queries reading data"| node_api

click node_ph "https://github.com/patric1304/water-quality-iot-project/blob/main/pi/sensors/ph.py"
click node_tds "https://github.com/patric1304/water-quality-iot-project/blob/main/pi/sensors/tds.py"
click node_turbidity "https://github.com/patric1304/water-quality-iot-project/blob/main/pi/sensors/turbidity.py"
click node_temperature "https://github.com/patric1304/water-quality-iot-project/blob/main/pi/sensors/temperature.py"
click node_pi_loop "https://github.com/patric1304/water-quality-iot-project/blob/main/pi/main.py"
click node_lambda "https://github.com/patric1304/water-quality-iot-project/blob/main/lambda/handler.py"
click node_api "https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/views.py"
click node_api_routes "https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/urls.py"
click node_api_auth "https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/authentication.py"
click node_reading_model "https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/models.py"
click node_serializer "https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/serializers.py"
click node_inference "https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/ml_inference.py"
click node_features "https://github.com/patric1304/water-quality-iot-project/blob/main/ml/feature_engineering.py"
click node_trainer "https://github.com/patric1304/water-quality-iot-project/blob/main/ml/train_model.py"
click node_model_assets "https://github.com/patric1304/water-quality-iot-project/blob/main/ml/model.onnx"
click node_dashboard "https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/templates/monitor/dashboard.html"

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_ph,node_tds,node_turbidity,node_temperature,node_pi_loop toneBlue
class node_iot,node_lambda toneAmber
class node_api,node_api_routes,node_api_auth,node_reading_model,node_serializer toneMint
class node_inference,node_features,node_trainer,node_model_assets toneRose
class node_dashboard,node_sns,node_operator,node_recipients toneIndigo
```

## Components

### Edge sensing

- [pH sensor](https://github.com/patric1304/water-quality-iot-project/blob/main/pi/sensors/ph.py): `pi/sensors/ph.py`
- [TDS sensor](https://github.com/patric1304/water-quality-iot-project/blob/main/pi/sensors/tds.py): `pi/sensors/tds.py`
- [Turbidity sensor](https://github.com/patric1304/water-quality-iot-project/blob/main/pi/sensors/turbidity.py): `pi/sensors/turbidity.py`
- [Temperature sensor](https://github.com/patric1304/water-quality-iot-project/blob/main/pi/sensors/temperature.py): `pi/sensors/temperature.py`
- [Reading loop](https://github.com/patric1304/water-quality-iot-project/blob/main/pi/main.py): `pi/main.py`

### Cloud ingestion

- **IoT Core**
- [Ingestion and alerts](https://github.com/patric1304/water-quality-iot-project/blob/main/lambda/handler.py): `lambda/handler.py`

### Backend monitoring

- [Reading API](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/views.py): `backend/monitor/views.py`
- [API routes](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/urls.py): `backend/monitor/urls.py`
- [API key auth](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/authentication.py): `backend/monitor/authentication.py`
- [Reading records](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/models.py): `backend/monitor/models.py`
- [Reading serializer](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/serializers.py): `backend/monitor/serializers.py`

### Anomaly detection

- [Anomaly inference](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/ml_inference.py): `backend/monitor/ml_inference.py`
- [Feature engineering](https://github.com/patric1304/water-quality-iot-project/blob/main/ml/feature_engineering.py): `ml/feature_engineering.py`
- [Model training](https://github.com/patric1304/water-quality-iot-project/blob/main/ml/train_model.py): `ml/train_model.py`
- [Exported model assets](https://github.com/patric1304/water-quality-iot-project/blob/main/ml/model.onnx): `ml/model.onnx`

### Dashboard and alerts

- [Web dashboard](https://github.com/patric1304/water-quality-iot-project/blob/main/backend/monitor/templates/monitor/dashboard.html): `backend/monitor/templates/monitor/dashboard.html`
- **Amazon SNS**

### Other components

- **Water operator**
- **Email and SMS recipients**

## Connections

- Reading loop → pH sensor: reads (evidence: `pi/main.py`)
- Reading loop → TDS sensor: reads (evidence: `pi/main.py`)
- Reading loop → Turbidity sensor: reads (evidence: `pi/main.py`)
- Reading loop → Temperature sensor: reads (evidence: `pi/main.py`)
- Reading loop → IoT Core: publishes readings (evidence: `README.md`)
- IoT Core → Ingestion and alerts: triggers (evidence: `README.md`)
- Ingestion and alerts → Reading API: posts reading (evidence: `README.md`)
- API routes → Reading API: routes requests (evidence: `backend/monitor/urls.py`)
- Reading API → API key auth: checks write access (evidence: `backend/monitor/views.py`)
- Reading API → Reading serializer: serializes readings (evidence: `backend/monitor/views.py`)
- Reading API → Reading records: reads and writes (evidence: `backend/monitor/views.py`)
- Reading API → Anomaly inference: runs inference (evidence: `backend/monitor/views.py`)
- Anomaly inference → Feature engineering: engineers features (evidence: `backend/monitor/ml_inference.py`)
- Model training → Feature engineering: engineers training data (evidence: `ml/train_model.py`)
- Model training → Exported model assets: exports model
- Anomaly inference → Exported model assets: loads model assets
- Ingestion and alerts → Amazon SNS: publishes alerts (evidence: `README.md`)
- Amazon SNS → Email and SMS recipients: sends notifications (evidence: `README.md`)
- Water operator → Web dashboard: views status (evidence: `README.md`)
- Web dashboard → Reading API: requests readings
- Water operator → Reading API: queries reading data (evidence: `README.md`)
