Move documentation out of source tree

This commit is contained in:
2022-09-27 00:12:36 +02:00
parent 289c55b78c
commit df943620d6
4 changed files with 0 additions and 0 deletions

View File

@@ -0,0 +1,17 @@
@startuml
start
:Initialization;
if (Config exists) then (yes)
:Load config;
else (no)
:Do first-start initialization;
endif
:Load Fan Curves;
:Enter fan control loop;
stop
@enduml

71
doc/Class.plantuml Normal file
View File

@@ -0,0 +1,71 @@
@startuml
interface Sensor {
+ {abstract} int Value()
}
class LMSensor {
- Identifier: string
+ int Value()
}
class GPUSensor {
+ int Value()
}
class HWMONFan {
- Identifier: string
- RPMSensor: Sensor
- PWMControl: PWMControl
+ int RPM()
+ void PWM(value: int)
}
class PWMControl {
+ void PWM(value: int)
+ int PWM()
}
class LMSensorsFacade
{
+ List<Sensor> RPMSensors()
+ List<Sensor> TemperatureSensors()
}
class GPUSensorsFacade
{
+ List<Sensor> TemperatureSensors()
}
class SensorManager
{
- LMSensorsFacade
- GPUSensorsFacade
+ List<Sensor> RPMSensors()
+ List<Sensor> TemperatureSensors()
}
class FanGenerator
{
+ FanList FindFans(List<RPMSensor>, List<PWMControl>)
}
HWMONFan -- Sensor
HWMONFan -- PWMControl
Sensor <|-- LMSensor
Sensor <|-- GPUSensor
SensorManager - Sensor
LMSensor -- LMSensorsFacade
GPUSensor -- GPUSensorsFacade
LMSensorsFacade -- SensorManager
GPUSensorsFacade -- SensorManager
FanGenerator - HWMONFan
FanGenerator - SensorManager
FanGenerator - PWMControl
@enduml

View File

@@ -0,0 +1,23 @@
@startuml
participant main
participant LMSensorsFacade as lms
participant GPUSensor as gpus
participant PWMControlFactory as pwmfc
main -> lms: RPMSensors()
main <-- lms: vector<Sensor>
main -> lms: TemperatureSensors()
main <-- lms: vector<Sensor>
main -> gpus: GPUSensor()
main <-- gpus: Sensor
note right
Add GPUSensor to list
of temperature sensors
end note
main -> pwmfc: PWMControllers()
main <-- pwmfc: vector<PWMControl>
@enduml

View File

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