Inherits NetOceanDirect::ManagedObject< ThermoElectricAPI >.
|
bool | getEnable (long deviceID, int% errorCode) |
|
bool | getFanEnable (long deviceID, int% errorCode) |
|
float | getSetpoint (long deviceID, int% errorCode) |
|
bool | getStable (long deviceID, int% errorCode) |
|
double | readTemperatureDegreesC (long deviceID, int% errorCode) |
|
void | setEnable (long deviceID, int% errorCode, unsigned char tecEnable) |
|
void | setFanEnable (long deviceID, int% errorCode, bool fanEnable) |
|
void | setTemperatureSetpointDegreesC (long deviceID, int% errorCode, double temperatureDegreesCelsius) |
|
| ManagedObject (ThermoElectricAPI *instance) |
|
ThermoElectricAPI * | GetInstance () |
|
|
ThermoElectricAPI * | m_Instance |
|
◆ getEnable()
bool ThermoElectric::getEnable |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Returns true if the Thermo-Electric Cooler (TEC) on a given device has been enabled.
- 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.
◆ getSetpoint()
float ThermoElectric::getSetpoint |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Reads the setpoint temperature of the Thermo-Electric Cooler (TEC) on a given device.
- Parameters
-
- Returns
- the TEC's setpoint temperature, in degrees Celsius
◆ 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.
◆ readTemperatureDegreesC()
double ThermoElectric::readTemperatureDegreesC |
( |
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
◆ setEnable()
void ThermoElectric::setEnable |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
unsigned char |
tecEnable |
|
) |
| |
Enables/disables the Thermo-Electric Cooler (TEC) on the given device.
- 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 zero, TEC will be disabled - otherwise, TEC will be enabled |
◆ setFanEnable()
void ThermoElectric::setFanEnable |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
bool |
fanEnable |
|
) |
| |
Enables/disables the Thermo-Electric Cooler (TEC) fan on the given device.
- 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] | fanEnable | new TEC fan enable state - if false, TEC fan will be disabled - otherwise, TEC fan 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
- 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 |
The documentation for this class was generated from the following files: