From 6b6ea8f24cf9b8d5c94353f71e37259321f8810f Mon Sep 17 00:00:00 2001
From: adrien balleyguier <adriendino.balleyguier@master.hes-so.ch>
Date: Mon, 13 Apr 2026 08:39:05 +0200
Subject: [PATCH] doc: UML diagrams for the nodes

Closes #2
---
 doc_resources/nodes/.gitignore            |  2 ++
 doc_resources/nodes/class_diagram.puml    | 26 +++++++++++++++++++++++
 doc_resources/nodes/sequence_diagram.puml | 20 +++++++++++++++++
 3 files changed, 48 insertions(+)
 create mode 100644 doc_resources/nodes/.gitignore
 create mode 100644 doc_resources/nodes/class_diagram.puml
 create mode 100644 doc_resources/nodes/sequence_diagram.puml

diff --git a/doc_resources/nodes/.gitignore b/doc_resources/nodes/.gitignore
new file mode 100644
index 0000000..664db10
--- /dev/null
+++ b/doc_resources/nodes/.gitignore
@@ -0,0 +1,2 @@
+*.png
+*.svg
diff --git a/doc_resources/nodes/class_diagram.puml b/doc_resources/nodes/class_diagram.puml
new file mode 100644
index 0000000..8d37050
--- /dev/null
+++ b/doc_resources/nodes/class_diagram.puml
@@ -0,0 +1,26 @@
+@startuml
+
+skinparam linestyle ortho
+left to right direction
+
+class "Supervisor" as sup{}
+class "BLE_advertiser" as ble{
+    + advertise(data)
+}
+class "Sensor" as sens{
+    + init(...)
+    + get_value()
+}
+class "Window_status" as win{}
+class "Hygrometer" as hygro{}
+class "Thermometer" as thermo{}
+class "CO2_level" as co2{}
+
+sup o-d- ble
+sup o-u- sens
+sens <|-l- win
+sens <|-u- hygro
+sens <|-u- thermo
+sens <|-r- co2
+
+@enduml
diff --git a/doc_resources/nodes/sequence_diagram.puml b/doc_resources/nodes/sequence_diagram.puml
new file mode 100644
index 0000000..136d01e
--- /dev/null
+++ b/doc_resources/nodes/sequence_diagram.puml
@@ -0,0 +1,20 @@
+@startuml
+
+skinparam sequenceMessageAlign center
+
+participant "Supervisor" as sup
+collections "Sensors" as sens
+participant "BLE_advertiser" as ble
+
+sup -> sens : get_value()
+sens --> sup : value
+sup -> ble : advertise(data)
+ble --> sup
+alt CO2 level above 400 OR windows is open
+    sup -> sup : sleep 2 minutes
+else else
+    sup -> sup : sleep for [last sleep time + 2 minutes]
+    note right : max sleep time = 30 minutes
+end
+
+@enduml