doc: UML diagrams for the nodes

Closes #2
This commit is contained in:
adrien balleyguier
2026-04-13 08:39:05 +02:00
parent 4d87ea06b1
commit 6b6ea8f24c
3 changed files with 48 additions and 0 deletions

2
doc_resources/nodes/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*.png
*.svg

View File

@@ -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

View File

@@ -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