# letscontrolit/espeasy architecture

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

## Overview

ESPEasy is embedded firmware for configuring devices that read sensors and control appliances, then expose data or actions through controllers and network services. The intended workflow is configuration of tasks and controllers, plugin-driven device interaction, event/rule handling, and onward reporting or actuation. The available evidence is strongest for controller, web-configuration, and storage modules; most runtime plugin, scheduler, rules, and network wiring was not sampled, so those links are marked unverified rather than asserted.

Main entry points: [`src/src/ESPEasyCore/Controller.cpp`](https://github.com/letscontrolit/espeasy/blob/mega/src/src/ESPEasyCore/Controller.cpp) (Controller runtime), [`src/src/Globals/Plugins.h`](https://github.com/letscontrolit/espeasy/blob/mega/src/src/Globals/Plugins.h) (Task plugins), [`src/src/WebServer/ControllerPage.cpp`](https://github.com/letscontrolit/espeasy/blob/mega/src/src/WebServer/ControllerPage.cpp) (Web configuration), [`src/src/Helpers/ESPEasy_Storage.cpp`](https://github.com/letscontrolit/espeasy/blob/mega/src/src/Helpers/ESPEasy_Storage.cpp) (Settings storage)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_device["Devices and tasks"]
  node_taskplugins["Task plugins<br/>[Plugins.h]"]
  node_sensors["Sensor devices"]
  node_actuators["Appliance control"]
  node_sensoroutput["Sensor readings<br/>[Plugins.h]"]
end

subgraph group_runtime["Automation runtime"]
  node_events["Task events"]
  node_rules["Rules engine<br/>[ESPEasyRules.h]"]
  node_scheduler["Scheduler<br/>[Scheduler.h]"]
  node_rtccommand["RTC commands<br/>[RTCSRAMStorage.cpp]"]
end

subgraph group_interfaces["Configuration and integrations"]
  node_web["Web configuration<br/>[ControllerPage.cpp]"]
  node_controllers["Controller runtime<br/>[Controller.cpp]"]
  node_controllerplugins["Controller plugins<br/>[CPlugins.h]"]
  node_network["Network services"]
  node_mqtt["MQTT transport<br/>[PubSubClient.cpp]"]
end

subgraph group_state["Persistent state"]
  node_storage[("Settings storage")]
  node_layout["Storage layout<br/>[StorageLayout.h]"]
  node_rtc[("RTC SRAM<br/>[RTCSRAMStorage.cpp]")]
end

node_user(("User"))

node_user -.->|"configures"| node_web
node_web -->|"edits settings"| node_controllers
node_web -->|"uses storage"| node_storage
node_taskplugins -.->|"reads devices"| node_sensors
node_taskplugins -.->|"controls devices"| node_actuators
node_taskplugins -.->|"produces values"| node_sensoroutput
node_sensoroutput -.->|"raises events"| node_events
node_scheduler -.->|"dispatches tasks"| node_taskplugins
node_events -.->|"triggers rules"| node_rules
node_rules -.->|"acts on rules"| node_actuators
node_controllers -.->|"dispatches controllers"| node_controllerplugins
node_controllers -.->|"uses network"| node_network
node_controllerplugins -.->|"publishes messages"| node_mqtt
node_controllers -.->|"reads settings"| node_storage
node_layout -->|"defines layout"| node_storage
node_rtccommand -->|"writes slots"| node_rtc

click node_web "https://github.com/letscontrolit/espeasy/blob/mega/src/src/WebServer/ControllerPage.cpp"
click node_taskplugins "https://github.com/letscontrolit/espeasy/blob/mega/src/src/Globals/Plugins.h"
click node_sensors "https://github.com/letscontrolit/espeasy/tree/mega/lib"
click node_actuators "https://github.com/letscontrolit/espeasy/tree/mega/lib"
click node_events "https://github.com/letscontrolit/espeasy/blob/mega/src/src/DataStructs/ESPEasy_EventStruct.h"
click node_rules "https://github.com/letscontrolit/espeasy/blob/mega/src/src/ESPEasyCore/ESPEasyRules.h"
click node_scheduler "https://github.com/letscontrolit/espeasy/blob/mega/src/src/Helpers/Scheduler.h"
click node_controllers "https://github.com/letscontrolit/espeasy/blob/mega/src/src/ESPEasyCore/Controller.cpp"
click node_controllerplugins "https://github.com/letscontrolit/espeasy/blob/mega/src/src/Globals/CPlugins.h"
click node_network "https://github.com/letscontrolit/espeasy/tree/mega/src/ESPEasy/net"
click node_mqtt "https://github.com/letscontrolit/espeasy/blob/mega/lib/pubsubclient3/src/PubSubClient.cpp"
click node_storage "https://github.com/letscontrolit/espeasy/blob/mega/src/src/Helpers/ESPEasy_Storage.cpp"
click node_layout "https://github.com/letscontrolit/espeasy/blob/mega/src/src/CustomBuild/StorageLayout.h"
click node_rtc "https://github.com/letscontrolit/espeasy/blob/mega/src/ESPEasy/eeprom/Helpers/RTCSRAMStorage.cpp"
click node_rtccommand "https://github.com/letscontrolit/espeasy/blob/mega/src/src/Commands/RTCSRAMStorage.cpp"
click node_sensoroutput "https://github.com/letscontrolit/espeasy/blob/mega/src/src/Globals/Plugins.h"

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_taskplugins,node_sensors,node_actuators,node_sensoroutput,node_user toneBlue
class node_events,node_rules,node_scheduler,node_rtccommand toneAmber
class node_web,node_controllers,node_controllerplugins,node_network,node_mqtt toneMint
class node_storage,node_layout,node_rtc toneRose
```

## Components

### Devices and tasks

- [Task plugins](https://github.com/letscontrolit/espeasy/blob/mega/src/src/Globals/Plugins.h): `src/src/Globals/Plugins.h`
- [Sensor devices](https://github.com/letscontrolit/espeasy/tree/mega/lib): `lib`
- [Appliance control](https://github.com/letscontrolit/espeasy/tree/mega/lib): `lib`
- [Sensor readings](https://github.com/letscontrolit/espeasy/blob/mega/src/src/Globals/Plugins.h): `src/src/Globals/Plugins.h`

### Automation runtime

- [Task events](https://github.com/letscontrolit/espeasy/blob/mega/src/src/DataStructs/ESPEasy_EventStruct.h): `src/src/DataStructs/ESPEasy_EventStruct.h`
- [Rules engine](https://github.com/letscontrolit/espeasy/blob/mega/src/src/ESPEasyCore/ESPEasyRules.h): `src/src/ESPEasyCore/ESPEasyRules.h`
- [Scheduler](https://github.com/letscontrolit/espeasy/blob/mega/src/src/Helpers/Scheduler.h): `src/src/Helpers/Scheduler.h`
- [RTC commands](https://github.com/letscontrolit/espeasy/blob/mega/src/src/Commands/RTCSRAMStorage.cpp): `src/src/Commands/RTCSRAMStorage.cpp`

### Configuration and integrations

- [Web configuration](https://github.com/letscontrolit/espeasy/blob/mega/src/src/WebServer/ControllerPage.cpp): `src/src/WebServer/ControllerPage.cpp`
- [Controller runtime](https://github.com/letscontrolit/espeasy/blob/mega/src/src/ESPEasyCore/Controller.cpp): `src/src/ESPEasyCore/Controller.cpp`
- [Controller plugins](https://github.com/letscontrolit/espeasy/blob/mega/src/src/Globals/CPlugins.h): `src/src/Globals/CPlugins.h`
- [Network services](https://github.com/letscontrolit/espeasy/tree/mega/src/ESPEasy/net): `src/ESPEasy/net`
- [MQTT transport](https://github.com/letscontrolit/espeasy/blob/mega/lib/pubsubclient3/src/PubSubClient.cpp): `lib/pubsubclient3/src/PubSubClient.cpp`

### Persistent state

- [Settings storage](https://github.com/letscontrolit/espeasy/blob/mega/src/src/Helpers/ESPEasy_Storage.cpp): `src/src/Helpers/ESPEasy_Storage.cpp`
- [Storage layout](https://github.com/letscontrolit/espeasy/blob/mega/src/src/CustomBuild/StorageLayout.h): `src/src/CustomBuild/StorageLayout.h`
- [RTC SRAM](https://github.com/letscontrolit/espeasy/blob/mega/src/ESPEasy/eeprom/Helpers/RTCSRAMStorage.cpp): `src/ESPEasy/eeprom/Helpers/RTCSRAMStorage.cpp`

### Other components

- **User**

## Connections

- User → Web configuration: configures (evidence: `README.md`)
- Web configuration → Controller runtime: edits settings (evidence: `src/src/WebServer/ControllerPage.cpp`)
- Web configuration → Settings storage: uses storage (evidence: `src/src/WebServer/ControllerPage.cpp`)
- Task plugins → Sensor devices: reads devices
- Task plugins → Appliance control: controls devices
- Task plugins → Sensor readings: produces values (evidence: `src/src/Globals/Plugins.h`)
- Sensor readings → Task events: raises events
- Scheduler → Task plugins: dispatches tasks
- Task events → Rules engine: triggers rules
- Rules engine → Appliance control: acts on rules
- Controller runtime → Controller plugins: dispatches controllers (evidence: `src/src/ESPEasyCore/Controller.cpp`)
- Controller runtime → Network services: uses network (evidence: `src/src/ESPEasyCore/Controller.cpp`)
- Controller plugins → MQTT transport: publishes messages
- Controller runtime → Settings storage: reads settings (evidence: `src/src/ESPEasyCore/Controller.cpp`)
- Storage layout → Settings storage: defines layout (evidence: `src/src/Helpers/ESPEasy_Storage.cpp`)
- RTC commands → RTC SRAM: writes slots (evidence: `src/src/Commands/RTCSRAMStorage.cpp`)
