#include <ThermoElectricAPI.h>
◆ ThermoElectricAPI()
oceandirect::api::ThermoElectricAPI::ThermoElectricAPI |
( |
| ) |
|
◆ ~ThermoElectricAPI()
virtual oceandirect::api::ThermoElectricAPI::~ThermoElectricAPI |
( |
| ) |
|
|
virtual |
◆ getEnable()
virtual bool oceandirect::api::ThermoElectricAPI::getEnable |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Determine if the TEC is enabled or disabled.
- See also
- setEnable()
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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()
◆ getStable()
virtual bool oceandirect::api::ThermoElectricAPI::getStable |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Determine if the TEC has reached as stable temperature.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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. |
tecEnable | true 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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. |
temperatureDegreesCelsius | the desired setpoint in degress Celcius. |
◆ shutdown()
static void oceandirect::api::ThermoElectricAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
The documentation for this class was generated from the following file: