OceanDirect  2.4.0
OceanDirect C++/C API
oceandirect::api::ThermoElectricAPI Class Reference

Public Member Functions

bool getEnable (long deviceID, int *errorCode)
 
bool getFanEnable (long deviceID, int *errorCode)
 
bool getStable (long deviceID, int *errorCode)
 
float getTemperatureDegreesC (long deviceID, int *errorCode)
 
float getTemperatureSetpointDegreesC (long deviceID, int *errorCode)
 
void setEnable (long deviceID, int *errorCode, unsigned char tecEnable)
 
void setTemperatureSetpointDegreesC (long deviceID, int *errorCode, float temperatureDegreesCelsius)
 

Static Public Member Functions

static ThermoElectricAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ getEnable()

bool oceandirect::api::ThermoElectricAPI::getEnable ( long  deviceID,
int *  errorCode 
)

Determine if the TEC is enabled or disabled.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
true if the TEC is enabled, false otherwise.

◆ getFanEnable()

bool oceandirect::api::ThermoElectricAPI::getFanEnable ( long  deviceID,
int *  errorCode 
)

Determine if the TEC fan is enabled.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
true if the TEC fan is enabled, false otherwise.

◆ getStable()

bool oceandirect::api::ThermoElectricAPI::getStable ( long  deviceID,
int *  errorCode 
)

Determine if the TEC has reached as stable temperature.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
true if the TEC temperature is stable, false otherwise.

◆ getTemperatureDegreesC()

float oceandirect::api::ThermoElectricAPI::getTemperatureDegreesC ( long  deviceID,
int *  errorCode 
)

Read the current TEC temperature in degrees Celcius.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the temperature in degrees Celcius.

◆ getTemperatureSetpointDegreesC()

float oceandirect::api::ThermoElectricAPI::getTemperatureSetpointDegreesC ( long  deviceID,
int *  errorCode 
)

Get the current TEC setpoint in degrees Celcius

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the TEC setpoint inf degrees Celcius.

◆ setEnable()

void oceandirect::api::ThermoElectricAPI::setEnable ( long  deviceID,
int *  errorCode,
unsigned char  tecEnable 
)

Enable or disable the TEC.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
tecEnabletrue to enable the TEC, false to disabel the TEC.

◆ setTemperatureSetpointDegreesC()

void oceandirect::api::ThermoElectricAPI::setTemperatureSetpointDegreesC ( long  deviceID,
int *  errorCode,
float  temperatureDegreesCelsius 
)

Set the current TEC temperature setpoint in degrees Celcius.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
temperatureDegreesCelsiusthe desired setpoint in degress Celcius.

The documentation for this class was generated from the following file: