Add documentation, cleanup

This commit is contained in:
2022-09-17 15:45:48 +02:00
parent bbdd612209
commit 828964bf8f
17 changed files with 215 additions and 121 deletions

View File

@@ -0,0 +1,17 @@
@startuml
start
:Initialization;
if (Mapping exists) then (yes)
:Load mapping;
else (no)
:Generate mapping;
endif
:Enter fan control loop;
:Load Fan Curves;
stop
@enduml

25
app/doc/Class.plantuml Normal file
View File

@@ -0,0 +1,25 @@
@startuml
interface Fan {
{abstract} void PWM(int percent)
{abstract} int RPM()
}
interface Sensor {
{abstract} int value()
{abstract} string name()
}
class HwmonFan {
}
Fan <|-- HwmonFan
Sensor <|-- HwmonSensor
Sensor <|-- NvidiaSensor
HwmonFan - Sensor
HwmonFan -- PwmControl
@enduml

View File

@@ -0,0 +1,7 @@
@startuml
actor User as usr
participant Interface as if
@enduml