Add documentation, cleanup
This commit is contained in:
17
app/doc/ApplicationStart.plantuml
Normal file
17
app/doc/ApplicationStart.plantuml
Normal 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
25
app/doc/Class.plantuml
Normal 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
|
||||
7
app/doc/InteractiveMapping.plantuml
Normal file
7
app/doc/InteractiveMapping.plantuml
Normal file
@@ -0,0 +1,7 @@
|
||||
@startuml
|
||||
actor User as usr
|
||||
participant Interface as if
|
||||
|
||||
|
||||
|
||||
@enduml
|
||||
Reference in New Issue
Block a user