# perseusnomit/monitor-dorm-washingmachines architecture

> Architecture diagram of the GitHub repository perseusnomit/monitor-dorm-washingmachines, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/perseusnomit/monitor-dorm-washingmachines
- Repository: https://github.com/perseusnomit/monitor-dorm-washingmachines

## Overview

##### Main Components

a. Hardware Layer (Tier 1):
- ESP32 MCU with Current Sensors (030 A)
- Sensor connections

b. Communication Layer (Tier 2):
- Raspberry Pi 3 running Mosquitto Broker
- MQTT protocol connections
- Topic structure for wash machine states

c. Application Layer (Tier 3):
- Python Service components:
- MQTT Subscriber
- Control Logic
- Flask Web Server
- Data processing units

d. Presentation Layer (Tier 4):
- Web Interface
- Client-side MQTT consumer
- Frontend components (HTML, CSS, JS)

**[Hardware Layer]**
- ↓ MQTT
**[Communication Layer]**
- ↓ MQTT
**[Application Layer]**
- ↓ HTTP/WebSocket
**[Presentation Layer]**

##### Component Relationships

- Hardware connections (thick lines)

##### Detailed Component Breakdown

ESP32 Section:
**[Current Sensor 1] → [ESP32 MCU] → [Current Sensor 2]**
- ↓
- MQTT Publisher

Raspberry Pi Section:
**[Mosquitto Broker]**
- ↓
**[Python Service]**
- MQTT Subscriber
- Control Logic
- Flask Web Server

Frontend Section:
**[Browser]**
- HTML/CSS UI
- JavaScript
- MQTT Client

##### Additional Elements

- System requirements and dependencies
- Scalability points for additional wash machines
- Critical monitoring points

##### Technical Details

- MQTT topic structure
- Database connections (MongoDB)
- Service ports and protocols
- Hardware specifications
- System service configurations

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Hardware
        ESP["ESP32 MCU"]
        CS1["Current Sensor 1"]
        CS2["Current Sensor 2"]
        CS1 --> ESP
        CS2 --> ESP
    end

    subgraph Communication
        MQTT["Mosquitto Broker"]
        MQTTHandler["MQTT Handler"]
        DataCollector["Data Collector"]
    end

    subgraph Application
        MainApp["Main Application"]
        Controller["Control Logic"]
        Config["Configuration"]
        ConfigHandler["Config Handler"]
        EmailNotif["Email Notifications"]
        AudioSystem["Audio System"]
        StartSound["Start Sound"]
        FreeSound["Free Sound"]
    end

    subgraph Frontend
        WebUI["Web Interface"]
        JSLogic["JavaScript Logic"]
        Styles["CSS Styling"]
    end

    %% Hardware to Communication
    ESP -.->|MQTT| MQTT
    MQTT -.-> MQTTHandler
    MQTTHandler --> DataCollector

    %% Application Flow
    DataCollector --> MainApp
    MainApp --> Controller
    Config --> ConfigHandler
    ConfigHandler --> MainApp
    Controller --> EmailNotif
    Controller --> AudioSystem
    AudioSystem --> StartSound
    AudioSystem --> FreeSound

    %% Frontend Integration
    MainApp --> WebUI
    WebUI --> JSLogic
    Styles --> WebUI

    %% Component Mappings
    click ESP "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/esp32_firmware/src/main.cpp"
    click MQTTHandler "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/middleware/mqttraw.py"
    click DataCollector "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/middleware/wash_collector.py"
    click MainApp "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/__init__.py"
    click Controller "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/engine/controller.py"
    click Config "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/config.yaml"
    click ConfigHandler "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/utils/configurator.py"
    click EmailNotif "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/utils/email_sender.py"
    click StartSound "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/static/audio/wash_started_sound.mp3"
    click FreeSound "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/static/audio/wash_free_sound.mp3"
    click WebUI "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/templates/index.html"
    click JSLogic "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/static/js/main.js"
    click Styles "https://github.com/perseusnomit/monitor-dorm-washingmachines/blob/main/wash_machines_monitoring_service/flaskr/static/css/style.css"

    classDef hardware fill:#gray
    classDef communication fill:#blue
    classDef application fill:#green
    classDef frontend fill:#orange
    
    class ESP,CS1,CS2 hardware
    class MQTT,MQTTHandler,DataCollector communication
    class MainApp,Controller,Config,ConfigHandler,EmailNotif,AudioSystem,StartSound,FreeSound application
    class WebUI,JSLogic,Styles frontend
```
