#include <ThermoElectric.h>
Inherits NetOceanDirect::ManagedObject< ThermoElectricAPI >.
◆ ThermoElectric() [1/2]
ThermoElectric::ThermoElectric |
( |
| ) |
|
|
protected |
◆ ThermoElectric() [2/2]
ThermoElectric::ThermoElectric |
( |
ThermoElectricAPI * | instance | ) |
|
◆ ~ThermoElectric()
virtual NetOceanDirect::ThermoElectric::~ThermoElectric |
( |
| ) |
|
|
inlinevirtual |
◆ getEnable()
bool ThermoElectric::getEnable |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Returns true if the Thermo-Electric Cooler (TEC) on a given device has been enabled.
- See also
- setEnable()
- Parameters
-
- Returns
- true if the TEC is enabled otherwise it would be false.
◆ getFanEnable()
bool ThermoElectric::getFanEnable |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Returns true if the Thermo-Electric Cooler (TEC) fan on a given device has been enabled.
- Parameters
-
- Returns
- true if the TEC fan is enabled otherwise it would be false.
◆ getInstance()
◆ getStable()
bool ThermoElectric::getStable |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Returns true if the Thermo-Electric Cooler (TEC) on a given device has reached the the setpoint temperature and is not changing.
- Parameters
-
- Returns
- true if the TEC temperature is stable otherwise it would be false.
◆ getTemperatureDegreesC()
double ThermoElectric::getTemperatureDegreesC |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Reads the current temperature of the Thermo-Electric Cooler (TEC) on a given device (not the setpoint).
- Parameters
-
- Returns
- the TEC's current temperature, in degrees Celsius
◆ getTemperatureSetpointDegreesC()
float ThermoElectric::getTemperatureSetpointDegreesC |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Reads the setpoint temperature of the Thermo-Electric Cooler (TEC) on a given device.
- See also
- setTemperatureSetpointDegreesC()
- Parameters
-
- Returns
- the TEC's setpoint temperature, in degrees Celsius
◆ setEnable()
void ThermoElectric::setEnable |
( |
long | deviceID, |
|
|
int% | errorCode, |
|
|
bool | tecEnable ) |
Enables/disables the Thermo-Electric Cooler (TEC) on the given device.
- See also
- getEnable()
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | tecEnable | new TEC enable state - if false, TEC will be disabled - otherwise, TEC will be enabled |
◆ setTemperatureSetpointDegreesC()
void ThermoElectric::setTemperatureSetpointDegreesC |
( |
long | deviceID, |
|
|
int% | errorCode, |
|
|
double | temperatureDegreesCelsius ) |
Sets the Thermo-Electric Cooler (TEC) setpoint on the given device, which is the target temperature it will try to reach
- See also
- getTemperatureSetpointDegreesC()
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | temperatureDegreesCelsius | the new setpoint, in degrees Celsius |
◆ tec
The documentation for this class was generated from the following files: