# hayk678/scada-alarms architecture

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

- Interactive diagram: https://gitdiagram.com/hayk678/scada-alarms
- Repository: https://github.com/hayk678/scada-alarms

## Overview

This is a SCADA alarm-monitoring application: plant signals (or simulated alarms) enter a Kafka-based pipeline, active alarms are deduplicated and stored, and users can query, acknowledge, and receive live alarm updates. The excerpts establish the connector, processor, API, and simulator behavior. The OPC UA server and frontend are represented from the tree; their runtime connections are not verified by sampled source.

Main entry points: [`processing/alarm_processor.py`](https://github.com/hayk678/scada-alarms/blob/master/processing/alarm_processor.py) (Alarm Processor), [`backend/main.py`](https://github.com/hayk678/scada-alarms/blob/master/backend/main.py) (Alarms API), [`opcua-server/server.py`](https://github.com/hayk678/scada-alarms/blob/master/opcua-server/server.py) (OPC UA Server), [`connector/opcua_connector.py`](https://github.com/hayk678/scada-alarms/blob/master/connector/opcua_connector.py) (OPC UA Connector)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_sources["Signal Sources"]
  node_plant["Plant Signals<br/>[server.py]"]
  node_opcua["OPC UA Server<br/>[server.py]"]
  node_simulator["Alarm Simulator<br/>[simulator.py]"]
end

subgraph group_ingestion["Alarm Ingestion"]
  node_connector["OPC UA Connector<br/>[opcua_connector.py]"]
  node_kafka["Kafka Topic"]
end

subgraph group_processing["Alarm Processing"]
  node_processor["Alarm Processor<br/>[alarm_processor.py]"]
  node_dedup["Alarm Deduplication<br/>[alarm_processor.py]"]
  node_schema["Alarm Schema<br/>[schema.sql]"]
  node_postgres[("Alarm Database")]
  node_redis["Live Alarm Channel"]
end

subgraph group_access["User Access"]
  node_api["Alarms API<br/>[main.py]"]
  node_frontend["Web Interface<br/>[index.html]"]
end

node_operator(("Operator"))

node_plant -->|"publishes signals"| node_opcua
node_opcua -.->|"provides signals"| node_connector
node_connector -->|"publishes alarms"| node_kafka
node_simulator -->|"publishes alarms"| node_kafka
node_kafka -->|"delivers messages"| node_processor
node_processor -->|"checks duplicates"| node_dedup
node_processor -->|"writes batches"| node_postgres
node_processor -->|"publishes live alarms"| node_redis
node_api -->|"queries and updates"| node_postgres
node_api -->|"subscribes to alarms"| node_redis
node_operator -.->|"uses"| node_frontend
node_operator -->|"requests alarm data"| node_api

click node_plant "https://github.com/hayk678/scada-alarms/blob/master/opcua-server/server.py"
click node_opcua "https://github.com/hayk678/scada-alarms/blob/master/opcua-server/server.py"
click node_simulator "https://github.com/hayk678/scada-alarms/blob/master/simulator/simulator.py"
click node_connector "https://github.com/hayk678/scada-alarms/blob/master/connector/opcua_connector.py"
click node_processor "https://github.com/hayk678/scada-alarms/blob/master/processing/alarm_processor.py"
click node_dedup "https://github.com/hayk678/scada-alarms/blob/master/processing/alarm_processor.py"
click node_schema "https://github.com/hayk678/scada-alarms/blob/master/processing/schema.sql"
click node_api "https://github.com/hayk678/scada-alarms/blob/master/backend/main.py"
click node_frontend "https://github.com/hayk678/scada-alarms/blob/master/frontend/index.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_plant,node_opcua,node_simulator toneBlue
class node_connector,node_kafka toneAmber
class node_processor,node_dedup,node_schema,node_postgres,node_redis toneMint
class node_api,node_frontend toneRose
class node_operator toneIndigo
```

## Components

### Signal Sources

- [Plant Signals](https://github.com/hayk678/scada-alarms/blob/master/opcua-server/server.py): `opcua-server/server.py`
- [OPC UA Server](https://github.com/hayk678/scada-alarms/blob/master/opcua-server/server.py): `opcua-server/server.py`
- [Alarm Simulator](https://github.com/hayk678/scada-alarms/blob/master/simulator/simulator.py): `simulator/simulator.py`

### Alarm Ingestion

- [OPC UA Connector](https://github.com/hayk678/scada-alarms/blob/master/connector/opcua_connector.py): `connector/opcua_connector.py`
- **Kafka Topic**

### Alarm Processing

- [Alarm Processor](https://github.com/hayk678/scada-alarms/blob/master/processing/alarm_processor.py): `processing/alarm_processor.py`
- [Alarm Deduplication](https://github.com/hayk678/scada-alarms/blob/master/processing/alarm_processor.py): `processing/alarm_processor.py`
- [Alarm Schema](https://github.com/hayk678/scada-alarms/blob/master/processing/schema.sql): `processing/schema.sql`
- **Alarm Database**
- **Live Alarm Channel**

### User Access

- [Alarms API](https://github.com/hayk678/scada-alarms/blob/master/backend/main.py): `backend/main.py`
- [Web Interface](https://github.com/hayk678/scada-alarms/blob/master/frontend/index.html): `frontend/index.html`

### Other components

- **Operator**

## Connections

- Plant Signals → OPC UA Server: publishes signals (evidence: `opcua-server/server.py`)
- OPC UA Server → OPC UA Connector: provides signals
- OPC UA Connector → Kafka Topic: publishes alarms (evidence: `connector/opcua_connector.py`)
- Alarm Simulator → Kafka Topic: publishes alarms (evidence: `simulator/simulator.py`)
- Kafka Topic → Alarm Processor: delivers messages (evidence: `processing/alarm_processor.py`)
- Alarm Processor → Alarm Deduplication: checks duplicates (evidence: `processing/alarm_processor.py`)
- Alarm Processor → Alarm Database: writes batches (evidence: `processing/alarm_processor.py`)
- Alarm Processor → Live Alarm Channel: publishes live alarms (evidence: `processing/alarm_processor.py`)
- Alarms API → Alarm Database: queries and updates (evidence: `backend/main.py`)
- Alarms API → Live Alarm Channel: subscribes to alarms (evidence: `backend/main.py`)
- Operator → Web Interface: uses
- Operator → Alarms API: requests alarm data (evidence: `backend/main.py`)
