# lnagel/hass-eaton-ups-mqtt architecture

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

- Interactive diagram: https://gitdiagram.com/lnagel/hass-eaton-ups-mqtt
- Repository: https://github.com/lnagel/hass-eaton-ups-mqtt

## Overview

This is a Home Assistant integration for monitoring Eaton Network-M2/M3 UPS devices. The user configures the host and port, the integration provisions or enrols TLS client credentials, then connects to the UPS MQTT broker; MQTT updates flow through a coordinator into measurement and status entities. The README documents broad power, battery, device, and environmental monitoring, plus configurable measurement-write debouncing and diagnostics. Several runtime paths are supported by excerpts or README rather than full source inspection.

Main entry points: [`custom_components/eaton_ups_mqtt/coordinator.py`](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/coordinator.py) (Update Coordinator), [`custom_components/eaton_ups_mqtt/__init__.py`](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/__init__.py) (Entry Setup), [`custom_components/eaton_ups_mqtt/api.py`](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/api.py) (MQTT Client), [`custom_components/eaton_ups_mqtt/enrolment.py`](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/enrolment.py) (Certificate Enrolment)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Setup &amp; Security"]
  node_config["Config Flow<br/>[config_flow.py]"]
  node_certs["Certificate Handling<br/>[certificates.py]"]
  node_enrol["Certificate Enrolment<br/>[enrolment.py]"]
  node_setup_entry["Entry Setup<br/>[__init__.py]"]
end

subgraph group_transport["UPS Connection"]
  node_client["MQTT Client<br/>[api.py]"]
  node_runtime_data["Runtime Data<br/>[data.py]"]
end

subgraph group_runtime["State &amp; Entities"]
  node_coordinator["Update Coordinator<br/>[coordinator.py]"]
  node_entities["Entity Base<br/>[entity.py]"]
  node_sensors["Measurement Sensors<br/>[sensor.py]"]
  node_binary["Status Sensors<br/>[binary_sensor.py]"]
end

subgraph group_support["Operations"]
  node_diagnostics["Diagnostics<br/>[diagnostics.py]"]
end

node_user(("Home Assistant User"))
node_ha["Home Assistant"]
node_https["UPS Certificate API"]
node_ups["Eaton UPS MQTT Broker"]

node_user -->|"configures"| node_config
node_config -->|"checks connection"| node_https
node_ha -->|"sets up entry"| node_setup_entry
node_setup_entry -->|"generates credentials"| node_certs
node_setup_entry -->|"enrols client cert"| node_enrol
node_enrol -->|"hashes certificate"| node_certs
node_enrol -->|"checks and uploads"| node_https
node_setup_entry -->|"creates connection"| node_client
node_client -->|"connects and subscribes"| node_ups
node_client -->|"sends update callbacks"| node_coordinator
node_coordinator -->|"reads current data"| node_client
node_coordinator -->|"uses entry runtime"| node_runtime_data
node_setup_entry -->|"stores client and coordinator"| node_runtime_data
node_sensors -->|"extends base"| node_entities
node_binary -->|"extends base"| node_entities
node_sensors -->|"reads measurements"| node_coordinator
node_binary -->|"reads status data"| node_coordinator
node_ha -->|"requests diagnostics"| node_diagnostics
node_diagnostics -->|"reads coordinator state"| node_coordinator
node_coordinator -->|"publishes entity updates"| node_ha

click node_config "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/config_flow.py"
click node_certs "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/certificates.py"
click node_enrol "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/enrolment.py"
click node_setup_entry "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/__init__.py"
click node_client "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/api.py"
click node_runtime_data "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/data.py"
click node_coordinator "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/coordinator.py"
click node_entities "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/entity.py"
click node_sensors "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/sensor.py"
click node_binary "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/binary_sensor.py"
click node_diagnostics "https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/diagnostics.py"

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_config,node_certs,node_enrol,node_setup_entry,node_user toneBlue
class node_client,node_runtime_data toneAmber
class node_coordinator,node_entities,node_sensors,node_binary,node_https toneMint
class node_diagnostics toneRose
class node_ha,node_ups toneIndigo
```

## Components

### Setup & Security

- [Config Flow](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/config_flow.py): `custom_components/eaton_ups_mqtt/config_flow.py`
- [Certificate Handling](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/certificates.py): `custom_components/eaton_ups_mqtt/certificates.py`
- [Certificate Enrolment](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/enrolment.py): `custom_components/eaton_ups_mqtt/enrolment.py`
- [Entry Setup](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/__init__.py): `custom_components/eaton_ups_mqtt/__init__.py`

### UPS Connection

- [MQTT Client](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/api.py): `custom_components/eaton_ups_mqtt/api.py`
- [Runtime Data](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/data.py): `custom_components/eaton_ups_mqtt/data.py`

### State & Entities

- [Update Coordinator](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/coordinator.py): `custom_components/eaton_ups_mqtt/coordinator.py`
- [Entity Base](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/entity.py): `custom_components/eaton_ups_mqtt/entity.py`
- [Measurement Sensors](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/sensor.py): `custom_components/eaton_ups_mqtt/sensor.py`
- [Status Sensors](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/binary_sensor.py): `custom_components/eaton_ups_mqtt/binary_sensor.py`

### Operations

- [Diagnostics](https://github.com/lnagel/hass-eaton-ups-mqtt/blob/main/custom_components/eaton_ups_mqtt/diagnostics.py): `custom_components/eaton_ups_mqtt/diagnostics.py`

### Other components

- **Home Assistant User**
- **Home Assistant**
- **UPS Certificate API**
- **Eaton UPS MQTT Broker**

## Connections

- Home Assistant User → Config Flow: configures (evidence: `README.md`)
- Config Flow → UPS Certificate API: checks connection (evidence: `custom_components/eaton_ups_mqtt/config_flow.py`)
- Home Assistant → Entry Setup: sets up entry (evidence: `custom_components/eaton_ups_mqtt/__init__.py`)
- Entry Setup → Certificate Handling: generates credentials (evidence: `custom_components/eaton_ups_mqtt/__init__.py`)
- Entry Setup → Certificate Enrolment: enrols client cert (evidence: `custom_components/eaton_ups_mqtt/__init__.py`)
- Certificate Enrolment → Certificate Handling: hashes certificate (evidence: `custom_components/eaton_ups_mqtt/enrolment.py`)
- Certificate Enrolment → UPS Certificate API: checks and uploads (evidence: `custom_components/eaton_ups_mqtt/enrolment.py`)
- Entry Setup → MQTT Client: creates connection (evidence: `custom_components/eaton_ups_mqtt/__init__.py`)
- MQTT Client → Eaton UPS MQTT Broker: connects and subscribes (evidence: `custom_components/eaton_ups_mqtt/api.py`)
- MQTT Client → Update Coordinator: sends update callbacks (evidence: `custom_components/eaton_ups_mqtt/coordinator.py`)
- Update Coordinator → MQTT Client: reads current data (evidence: `custom_components/eaton_ups_mqtt/coordinator.py`)
- Update Coordinator → Runtime Data: uses entry runtime (evidence: `custom_components/eaton_ups_mqtt/coordinator.py`)
- Entry Setup → Runtime Data: stores client and coordinator (evidence: `custom_components/eaton_ups_mqtt/__init__.py`)
- Measurement Sensors → Entity Base: extends base (evidence: `custom_components/eaton_ups_mqtt/sensor.py`)
- Status Sensors → Entity Base: extends base (evidence: `custom_components/eaton_ups_mqtt/binary_sensor.py`)
- Measurement Sensors → Update Coordinator: reads measurements (evidence: `custom_components/eaton_ups_mqtt/sensor.py`)
- Status Sensors → Update Coordinator: reads status data (evidence: `custom_components/eaton_ups_mqtt/binary_sensor.py`)
- Home Assistant → Diagnostics: requests diagnostics (evidence: `custom_components/eaton_ups_mqtt/diagnostics.py`)
- Diagnostics → Update Coordinator: reads coordinator state (evidence: `custom_components/eaton_ups_mqtt/diagnostics.py`)
- Update Coordinator → Home Assistant: publishes entity updates (evidence: `custom_components/eaton_ups_mqtt/coordinator.py`)
