Go to the source code of this file.
Classes | |
| class | YTemperature |
Macros | |
| #define | _Y_SENSORTYPE_ENUM |
| #define | Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
| #define | Y_SIGNALUNIT_INVALID (YAPI_INVALID_STRING) |
| #define | Y_SIGNALVALUE_INVALID (YAPI_INVALID_DOUBLE) |
Typedefs | |
| typedef void(* | YTemperatureTimedReportCallback) (YTemperature *func, YMeasure measure) |
| typedef void(* | YTemperatureValueCallback) (YTemperature *func, const string &functionValue) |
Enumerations | |
| enum | Y_SENSORTYPE_enum { Y_SENSORTYPE_DIGITAL = 0, Y_SENSORTYPE_TYPE_K = 1, Y_SENSORTYPE_TYPE_E = 2, Y_SENSORTYPE_TYPE_J = 3, Y_SENSORTYPE_TYPE_N = 4, Y_SENSORTYPE_TYPE_R = 5, Y_SENSORTYPE_TYPE_S = 6, Y_SENSORTYPE_TYPE_T = 7, Y_SENSORTYPE_PT100_4WIRES = 8, Y_SENSORTYPE_PT100_3WIRES = 9, Y_SENSORTYPE_PT100_2WIRES = 10, Y_SENSORTYPE_RES_OHM = 11, Y_SENSORTYPE_RES_NTC = 12, Y_SENSORTYPE_RES_LINEAR = 13, Y_SENSORTYPE_RES_INTERNAL = 14, Y_SENSORTYPE_INVALID = -1 } |
Functions | |
| YTemperature * | yFindTemperature (const string &func) |
| YTemperature * | yFirstTemperature (void) |
Macro Definition Documentation
| #define _Y_SENSORTYPE_ENUM |
Definition at line 58 of file yocto_temperature.h.
| #define Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
Definition at line 80 of file yocto_temperature.h.
| #define Y_SIGNALUNIT_INVALID (YAPI_INVALID_STRING) |
Definition at line 79 of file yocto_temperature.h.
| #define Y_SIGNALVALUE_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 78 of file yocto_temperature.h.
Typedef Documentation
| typedef void(* YTemperatureTimedReportCallback) (YTemperature *func, YMeasure measure) |
Definition at line 56 of file yocto_temperature.h.
| typedef void(* YTemperatureValueCallback) (YTemperature *func, const string &functionValue) |
Definition at line 54 of file yocto_temperature.h.
Enumeration Type Documentation
| enum Y_SENSORTYPE_enum |
Definition at line 59 of file yocto_temperature.h.
Function Documentation
|
inline |
Retrieves a temperature sensor for a given identifier. The identifier can be specified using several formats:
- FunctionLogicalName
- ModuleSerialNumber.FunctionIdentifier
- ModuleSerialNumber.FunctionLogicalName
- ModuleLogicalName.FunctionIdentifier
- ModuleLogicalName.FunctionLogicalName
This function does not require that the temperature sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YTemperature.isOnline() to test if the temperature sensor is indeed online at a given time. In case of ambiguity when looking for a temperature sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
- Parameters
-
func : a string that uniquely characterizes the temperature sensor
- Returns
- a YTemperature object allowing you to drive the temperature sensor.
Definition at line 408 of file yocto_temperature.h.
|
inline |
Starts the enumeration of temperature sensors currently accessible. Use the method YTemperature.nextTemperature() to iterate on next temperature sensors.
- Returns
- a pointer to a YTemperature object, corresponding to the first temperature sensor currently online, or a NULL pointer if there are none.
Definition at line 419 of file yocto_temperature.h.