Temperature Entity¶
- group TemperatureEntity
TemperatureClass: This entity is only available on certain modules, and provides a temperature reading in microcelsius.
-
void temperature_getValue(unsigned int *id, struct Result *result, const int index)¶
Get the modules temperature in micro-C
Returns common entity return values
- Parameters:
id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The temperature in micro-Celsius (1 == 1e-6C).
index – The index of the entity in question.
-
void temperature_getValueMin(unsigned int *id, struct Result *result, const int index)¶
Get the module’s minimum temperature in micro-C since the last power cycle.
Returns common entity return values
- Parameters:
id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The module’s minimum temperature in micro-C
index – The index of the entity in question.
-
void temperature_getValueMax(unsigned int *id, struct Result *result, const int index)¶
Get the module’s maximum temperature in micro-C since the last power cycle.
Returns common entity return values
- Parameters:
id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The module’s maximum temperature in micro-C
index – The index of the entity in question.
-
void temperature_resetEntityToFactoryDefaults(unsigned int *id, struct Result *result, const int index)¶
Resets the TemperatureClass Entity to it factory default configuration.
- Parameters:
id – ID assigned through “module_createStem”
result – Object containing aErrNone on success. Non-zero error code on failure.
index – The index of the entity in question.