OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::LHThermoelectricAPI Class Reference

#include <LHThermoelectricAPI.h>

Public Member Functions

virtual ~LHThermoelectricAPI ()=default
 
virtual bool getTecStable (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_celcius_t getTecTemperature (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_celcius_t getTecTemperatureSetpoint (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void setTecTemperatureSetpoint (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_celcius_t celsius)
 

Constructor & Destructor Documentation

◆ ~LHThermoelectricAPI()

virtual oceandirect::api::LHThermoelectricAPI::~LHThermoelectricAPI ( )
virtualdefault

Member Function Documentation

◆ getTecStable()

virtual bool oceandirect::api::LHThermoelectricAPI::getTecStable ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getTecStable Determine if the TEC temperature is stable (not changing).

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
true if the TEC temperature is stable, false otherwise or on error.

◆ getTecTemperature()

virtual lh_celcius_t oceandirect::api::LHThermoelectricAPI::getTecTemperature ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getTecTemperature Get the current TEC temperature in Celcius.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the TEC temperature in Celcius, or 0.0 on error.

◆ getTecTemperatureSetpoint()

virtual lh_celcius_t oceandirect::api::LHThermoelectricAPI::getTecTemperatureSetpoint ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getTecTemperatureSetpoint Get the current TEC temperature setpoint in Celcius.

See also
setTecTemperatureSetpoint()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the TEC temperature setpoint in Celcius, or 0.0 on error.

◆ setTecTemperatureSetpoint()

virtual void oceandirect::api::LHThermoelectricAPI::setTecTemperatureSetpoint ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_celcius_t celsius )
virtual

.setTecTemperatureSetpoint Set the desired TEC temperature setpoint in Celcius.

See also
getTecTemperatureSetpoint()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
celsiusthe desired TEC temperature in Celcius.

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