Documentation

This commit is contained in:
2022-09-28 08:37:41 +02:00
parent 05b35a9cea
commit a81e8c31ee

View File

@@ -1,4 +1,6 @@
@startuml @startuml
package sensor {
interface Sensor { interface Sensor {
+ {abstract} int Value() + {abstract} int Value()
} }
@@ -13,24 +15,6 @@ class GPUSensor {
+ int Value() + int Value()
} }
class HWMONFan {
- string Label
- Sensor RPMSensor
- PWMControl PWMControl
+ int RPM()
+ void PWMPercent(int value)
}
class PWMControl {
+ void PWMPercent(int value)
+ int PWM()
}
class PWMControlFacade {
+ List<PWMControl> PWMControls()
}
class LMSensorsFacade class LMSensorsFacade
{ {
+ List<Sensor> RPMSensors() + List<Sensor> RPMSensors()
@@ -50,6 +34,18 @@ class SensorManager
+ List<Sensor> RPMSensors() + List<Sensor> RPMSensors()
+ List<Sensor> TemperatureSensors() + List<Sensor> TemperatureSensors()
} }
}
package fan
{
class HWMONFan {
- string Label
- Sensor RPMSensor
- PWMControl PWMControl
+ int RPM()
+ void PWMPercent(int value)
}
class FanGenerator class FanGenerator
{ {
@@ -77,6 +73,19 @@ class FanController
+ void StartFanControlLoop() + void StartFanControlLoop()
} }
}
package pwm
{
class PWMControl {
+ void PWMPercent(int value)
+ int PWM()
}
class PWMControlFacade {
+ List<PWMControl> PWMControls()
}
}
class ConfigManager class ConfigManager
{ {
@@ -85,9 +94,9 @@ class ConfigManager
HWMONFan -- Sensor HWMONFan -- Sensor
HWMONFan -- PWMControl HWMONFan -- PWMControl
HWMONFan - FanCurve HWMONFan -- FanCurve
PWMControl -- PWMControlFacade PWMControlFacade -- PWMControl
Sensor <|-- LMSensor Sensor <|-- LMSensor
Sensor <|-- GPUSensor Sensor <|-- GPUSensor
@@ -99,13 +108,12 @@ GPUSensor -- GPUSensorsFacade
LMSensorsFacade -- SensorManager LMSensorsFacade -- SensorManager
GPUSensorsFacade -- SensorManager GPUSensorsFacade -- SensorManager
FanGenerator - HWMONFan FanGenerator -- HWMONFan
FanGenerator - SensorManager FanGenerator -- SensorManager : uses >
FanGenerator - PWMControl FanGenerator -- PWMControlFacade : uses >
Sensor - FanCurve Sensor - FanCurve
FanCurve -- FanStep FanCurve -- FanStep
FanCurve -- SensorAggregateFunction
FanController -- FanCurve FanCurve -- FanController
@enduml @enduml