◆ getAllTemperatures()
int oceandirect::api::TemperatureAPI::getAllTemperatures |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
double * |
buffer, |
|
|
int |
max_length |
|
) |
| |
Get the temperatures from all sensors 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. |
buffer | a buffer to receive the returned temperatures. |
max_length | the size of the buffer. |
- Returns
- the number of temperatures returned.
◆ getCount()
int oceandirect::api::TemperatureAPI::getCount |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the number of temperature sensors available in the device.
- 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 number of temperature sensors.
◆ getTemperature()
double oceandirect::api::TemperatureAPI::getTemperature |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
index |
|
) |
| |
Get the temperature of a specified sensor 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. |
index | the index of the specified sensor. |
- Returns
- the temperature of the specified sensor in degrees Celcius.
◆ getTemperatureExtreme()
double oceandirect::api::TemperatureAPI::getTemperatureExtreme |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the maximum temperature that could be returned by the sensors 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 maximum temperature in degrees Celcius.
The documentation for this class was generated from the following file: