# alarmouseuepg2023/embedded architecture

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

- Interactive diagram: https://gitdiagram.com/alarmouseuepg2023/embedded
- Repository: https://github.com/alarmouseuepg2023/embedded

## Overview

Alarmouse is an ESP32 alarm-device project with supporting Wi-Fi connectivity and MQTT-message queuing. Its visible device workflow handles sensor and RF-control events, changes alarm state, and drives an alarm output; Wi-Fi supports credential provisioning and reconnection. The README provides no detailed architecture, and the main sketch was not excerpted, so its orchestration and connections to helper libraries cannot be verified. Edges below reflect only shown calls, inheritance, or hardware interactions.

Main entry points: [`libs/WiFiConnection/WiFiConnection.cpp`](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/WiFiConnection/WiFiConnection.cpp) (Wi-Fi setup), [`libs/AlarmouseDevice/AlarmouseDevice.cpp`](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/AlarmouseDevice/AlarmouseDevice.cpp) (Device state), [`libs/ConnectionManager/ConnectionManager.cpp`](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/ConnectionManager/ConnectionManager.cpp) (Reconnect policy), [`libs/MQTTPublishTaskQueue/MQTTPublishTaskQueue.cpp`](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/MQTTPublishTaskQueue/MQTTPublishTaskQueue.cpp) (MQTT publish queue)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_device["Alarm Device"]
  node_device_logic["Device state"]
end

subgraph group_network["Wi-Fi Connectivity"]
  node_connection_manager["Reconnect policy"]
  node_wifi["Wi-Fi setup<br/>[WiFiConnection.cpp]"]
  node_preferences[("Credential storage<br/>[WiFiConnection.cpp]")]
end

subgraph group_messaging["Message Queue"]
  node_message_queue["MQTT publish queue"]
end

subgraph group_hardware["Hardware Helpers"]
  node_debounce["Input debounce<br/>[Debounce.cpp]"]
  node_pinout["ESP32 pin constants<br/>[ESP32Pinout.h]"]
end

node_operator(("RF control"))
node_sensor(("Sensor input"))
node_alarm_output(("Alarm output"))
node_wifi_service["ESP32 Wi-Fi"]
node_freertos_queue["FreeRTOS queue"]

node_sensor -->|"interrupts"| node_device_logic
node_operator -->|"toggles state"| node_device_logic
node_device_logic -->|"drives output"| node_alarm_output
node_wifi -->|"inherits policy"| node_connection_manager
node_connection_manager -->|"calls connect"| node_wifi
node_wifi -->|"connects, provisions"| node_wifi_service
node_wifi -->|"reads, writes credentials"| node_preferences
node_message_queue -->|"enqueues, dequeues"| node_freertos_queue

click node_device_logic "https://github.com/alarmouseuepg2023/embedded/blob/master/libs/AlarmouseDevice/AlarmouseDevice.cpp"
click node_connection_manager "https://github.com/alarmouseuepg2023/embedded/blob/master/libs/ConnectionManager/ConnectionManager.cpp"
click node_wifi "https://github.com/alarmouseuepg2023/embedded/blob/master/libs/WiFiConnection/WiFiConnection.cpp"
click node_preferences "https://github.com/alarmouseuepg2023/embedded/blob/master/libs/WiFiConnection/WiFiConnection.cpp"
click node_message_queue "https://github.com/alarmouseuepg2023/embedded/blob/master/libs/MQTTPublishTaskQueue/MQTTPublishTaskQueue.cpp"
click node_debounce "https://github.com/alarmouseuepg2023/embedded/blob/master/libs/Debounce/Debounce.cpp"
click node_pinout "https://github.com/alarmouseuepg2023/embedded/blob/master/libs/Pinout/ESP32Pinout.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_device_logic toneBlue
class node_connection_manager,node_wifi,node_preferences toneAmber
class node_message_queue toneMint
class node_debounce,node_pinout,node_freertos_queue toneRose
class node_operator,node_sensor,node_alarm_output,node_wifi_service toneIndigo
```

## Components

### Alarm Device

- [Device state](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/AlarmouseDevice/AlarmouseDevice.cpp): `libs/AlarmouseDevice/AlarmouseDevice.cpp`

### Wi-Fi Connectivity

- [Reconnect policy](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/ConnectionManager/ConnectionManager.cpp): `libs/ConnectionManager/ConnectionManager.cpp`
- [Wi-Fi setup](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/WiFiConnection/WiFiConnection.cpp): `libs/WiFiConnection/WiFiConnection.cpp`
- [Credential storage](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/WiFiConnection/WiFiConnection.cpp): `libs/WiFiConnection/WiFiConnection.cpp`

### Message Queue

- [MQTT publish queue](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/MQTTPublishTaskQueue/MQTTPublishTaskQueue.cpp): `libs/MQTTPublishTaskQueue/MQTTPublishTaskQueue.cpp`

### Hardware Helpers

- [Input debounce](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/Debounce/Debounce.cpp): `libs/Debounce/Debounce.cpp`
- [ESP32 pin constants](https://github.com/alarmouseuepg2023/embedded/blob/master/libs/Pinout/ESP32Pinout.h): `libs/Pinout/ESP32Pinout.h`

### Other components

- **RF control**
- **Sensor input**
- **Alarm output**
- **ESP32 Wi-Fi**
- **FreeRTOS queue**

## Connections

- Sensor input → Device state: interrupts (evidence: `libs/AlarmouseDevice/AlarmouseDevice.cpp`)
- RF control → Device state: toggles state (evidence: `libs/AlarmouseDevice/AlarmouseDevice.cpp`)
- Device state → Alarm output: drives output (evidence: `libs/AlarmouseDevice/AlarmouseDevice.cpp`)
- Wi-Fi setup → Reconnect policy: inherits policy
- Reconnect policy → Wi-Fi setup: calls connect (evidence: `libs/ConnectionManager/ConnectionManager.cpp`)
- Wi-Fi setup → ESP32 Wi-Fi: connects, provisions (evidence: `libs/WiFiConnection/WiFiConnection.cpp`)
- Wi-Fi setup → Credential storage: reads, writes credentials (evidence: `libs/WiFiConnection/WiFiConnection.cpp`)
- MQTT publish queue → FreeRTOS queue: enqueues, dequeues (evidence: `libs/MQTTPublishTaskQueue/MQTTPublishTaskQueue.cpp`)
