1
0
forked from fsfw/fsfw

Thermal: Some formatting stuff, doc to do

Need to find out how to use the thermal components
This commit is contained in:
2020-02-15 18:26:25 +01:00
parent a7964c7200
commit e15839b3a6
7 changed files with 72 additions and 38 deletions

View File

@ -3,6 +3,9 @@
#include "CoreComponent.h"
/**
* What is it. How to use
*/
class ThermalComponent: public CoreComponent {
public:
struct Parameters {
@ -15,12 +18,30 @@ public:
float heaterSwitchoff;
};
// TODO: Documentaiton ,what is NOP?
// propably Non-operational?
/**
* Non-Operational Temperatures
*/
struct NopParameters {
float lowerNopLimit;
float upperNopLimit;
};
/**
* How to use.
* @param reportingObjectId
* @param domainId
* @param temperaturePoolId
* @param targetStatePoolId
* @param currentStatePoolId
* @param requestPoolId
* @param dataSet
* @param sensor
* @param firstRedundantSensor
* @param secondRedundantSensor
* @param thermalModule
* @param parameters
* @param priority
*/
ThermalComponent(object_id_t reportingObjectId, uint8_t domainId, uint32_t temperaturePoolId,
uint32_t targetStatePoolId, uint32_t currentStatePoolId, uint32_t requestPoolId,
DataSet *dataSet, AbstractTemperatureSensor *sensor,