OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::ThermoElectricAPI Class Reference

#include <ThermoElectricAPI.h>

Public Member Functions

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

Static Public Member Functions

static ThermoElectricAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static ThermoElectricAPIinstance
 

Constructor & Destructor Documentation

◆ ThermoElectricAPI()

oceandirect::api::ThermoElectricAPI::ThermoElectricAPI ( )

◆ ~ThermoElectricAPI()

virtual oceandirect::api::ThermoElectricAPI::~ThermoElectricAPI ( )
virtual

Member Function Documentation

◆ getEnable()

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

Determine if the TEC is enabled or disabled.

See also
setEnable()
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()

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

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.

◆ getInstance()

static ThermoElectricAPI * oceandirect::api::ThermoElectricAPI::getInstance ( )
static

◆ getStable()

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

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()

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

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()

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

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()

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

Enable or disable the TEC.

See also
getEnable()
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()

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

Set the current TEC temperature setpoint in degrees Celcius.

See also
getTemperatureSetpointDegreesC()
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.

◆ shutdown()

static void oceandirect::api::ThermoElectricAPI::shutdown ( )
static

Member Data Documentation

◆ instance

ThermoElectricAPI* oceandirect::api::ThermoElectricAPI::instance
staticprotected

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