|
| virtual int | _invokeTimedReportCallback (YMeasure value) |
| |
| virtual int | _invokeValueCallback (string value) |
| |
| string | command (void) |
| |
| string | get_command (void) |
| |
| Y_SENSORTYPE_enum | get_sensorType (void) |
| |
| string | get_signalUnit (void) |
| |
| double | get_signalValue (void) |
| |
| virtual int | loadThermistorResponseTable (vector< double > &tempValues, vector< double > &resValues) |
| |
| YTemperature * | next (void) |
| |
| YTemperature * | nextTemperature (void) |
| |
| virtual int | registerTimedReportCallback (YTemperatureTimedReportCallback callback) |
| |
| virtual int | registerValueCallback (YTemperatureValueCallback callback) |
| |
| Y_SENSORTYPE_enum | sensorType (void) |
| |
| int | set_command (const string &newval) |
| |
| virtual int | set_ntcParameters (double res25, double beta) |
| |
| int | set_sensorType (Y_SENSORTYPE_enum newval) |
| |
| virtual int | set_thermistorResponseTable (vector< double > tempValues, vector< double > resValues) |
| |
| int | set_unit (const string &newval) |
| |
| int | setCommand (const string &newval) |
| |
| int | setSensorType (Y_SENSORTYPE_enum newval) |
| |
| int | setUnit (const string &newval) |
| |
| string | signalUnit (void) |
| |
| double | signalValue (void) |
| |
| | ~YTemperature () |
| |
| virtual double | _applyCalibration (double rawValue) |
| |
| virtual double | _decodeAvg (int dw) |
| |
| virtual YMeasure | _decodeTimedReport (double timestamp, vector< int > report) |
| |
| virtual double | _decodeVal (int w) |
| |
| virtual string | _encodeCalibrationPoints (vector< double > rawValues, vector< double > refValues) |
| |
| virtual int | _parserHelper (void) |
| |
| Y_ADVMODE_enum | advMode (void) |
| |
| virtual int | calibrateFromPoints (vector< double > rawValues, vector< double > refValues) |
| |
| string | calibrationParam (void) |
| |
| double | currentRawValue (void) |
| |
| double | currentValue (void) |
| |
| Y_ADVMODE_enum | get_advMode (void) |
| |
| string | get_calibrationParam (void) |
| |
| double | get_currentRawValue (void) |
| |
| double | get_currentValue (void) |
| |
| virtual YDataLogger * | get_dataLogger (void) |
| |
| double | get_highestValue (void) |
| |
| string | get_logFrequency (void) |
| |
| double | get_lowestValue (void) |
| |
| virtual YDataSet | get_recordedData (s64 startTime, s64 endTime) |
| |
| string | get_reportFrequency (void) |
| |
| double | get_resolution (void) |
| |
| int | get_sensorState (void) |
| |
| string | get_unit (void) |
| |
| double | highestValue (void) |
| |
| virtual bool | isSensorReady (void) |
| |
| virtual int | loadCalibrationPoints (vector< double > &rawValues, vector< double > &refValues) |
| |
| string | logFrequency (void) |
| |
| double | lowestValue (void) |
| |
| YSensor * | next (void) |
| |
| YSensor * | nextSensor (void) |
| |
| virtual int | registerTimedReportCallback (YSensorTimedReportCallback callback) |
| |
| virtual int | registerValueCallback (YSensorValueCallback callback) |
| |
| string | reportFrequency (void) |
| |
| double | resolution (void) |
| |
| int | sensorState (void) |
| |
| int | set_advMode (Y_ADVMODE_enum newval) |
| |
| int | set_calibrationParam (const string &newval) |
| |
| int | set_highestValue (double newval) |
| |
| int | set_logFrequency (const string &newval) |
| |
| int | set_lowestValue (double newval) |
| |
| int | set_reportFrequency (const string &newval) |
| |
| int | set_resolution (double newval) |
| |
| int | setAdvMode (Y_ADVMODE_enum newval) |
| |
| int | setCalibrationParam (const string &newval) |
| |
| int | setHighestValue (double newval) |
| |
| int | setLogFrequency (const string &newval) |
| |
| int | setLowestValue (double newval) |
| |
| int | setReportFrequency (const string &newval) |
| |
| int | setResolution (double newval) |
| |
| virtual int | startDataLogger (void) |
| |
| virtual int | stopDataLogger (void) |
| |
| string | unit (void) |
| |
| | ~YSensor () |
| |
| void | _clearDataStreamCache () |
| |
| string | _decode_json_string (const string &json) |
| |
| string | _download (const string &url) |
| |
| YDataStream * | _findDataStream (YDataSet &dataset, const string &def) |
| |
| string | _get_json_path (const string &json, const string &path) |
| |
| vector< string > | _json_get_array (const string &json) |
| |
| string | _json_get_key (const string &json, const string &data) |
| |
| string | _json_get_string (const string &json) |
| |
| int | _parseEx (yJsonStateMachine &j) |
| |
| string | _parseString (yJsonStateMachine &j) |
| |
| string | _request (const string &request) |
| |
| string | _requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context) |
| |
| void | _throw (YRETCODE errType, string errMsg) |
| |
| YRETCODE | _upload (const string &path, const string &content) |
| |
| YRETCODE | _uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context) |
| |
| string | advertisedValue (void) |
| |
| void | clearCache () |
| |
| string | describe (void) |
| |
| string | errMessage (void) |
| |
| string | errorMessage (void) |
| |
| YRETCODE | errorType (void) |
| |
| YRETCODE | errType (void) |
| |
| YFUN_DESCR | functionDescriptor (void) |
| |
| string | get_advertisedValue (void) |
| |
| string | get_errorMessage (void) |
| |
| YRETCODE | get_errorType (void) |
| |
| virtual string | get_friendlyName (void) |
| |
| YFUN_DESCR | get_functionDescriptor (void) |
| |
| string | get_functionId (void) |
| |
| string | get_hardwareId (void) |
| |
| string | get_hubSerial () |
| |
| string | get_logicalName (void) |
| |
| YModule * | get_module (void) |
| |
| void * | get_userData (void) |
| |
| bool | isOnline (void) |
| |
| YRETCODE | load (int msValidity) |
| |
| virtual string | loadAttribute (string attrName) |
| |
| string | logicalName (void) |
| |
| YModule * | module (void) |
| |
| virtual int | muteValueCallbacks (void) |
| |
| YFunction * | next (void) |
| |
| YFunction * | nextFunction (void) |
| |
| virtual int | registerValueCallback (YFunctionValueCallback callback) |
| |
| int | set_advertisedValue (const string &newval) |
| |
| int | set_logicalName (const string &newval) |
| |
| void | set_userData (void *data) |
| |
| int | setAdvertisedValue (const string &newval) |
| |
| int | setLogicalName (const string &newval) |
| |
| void | setUserData (void *data) |
| |
| virtual int | unmuteValueCallbacks (void) |
| |
| void * | userData (void) |
| |
| virtual | ~YFunction () |
| |
YTemperature Class: Temperature function interface
The Yoctopuce class YTemperature allows you to read and configure Yoctopuce temperature sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, to access the autonomous datalogger. This class adds the ability to configure some specific parameters for some sensors (connection type, temperature mapping table).
Definition at line 93 of file yocto_temperature.h.
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 316 of file yocto_temperature.cpp.
| int YTemperature::set_ntcParameters |
( |
double |
res25, |
|
|
double |
beta |
|
) |
| |
|
virtual |
Configures NTC thermistor parameters in order to properly compute the temperature from the measured resistance. For increased precision, you can enter a complete mapping table using set_thermistorResponseTable. This function can only be used with a temperature sensor based on thermistors.
- Parameters
-
| res25 | : thermistor resistance at 25 degrees Celsius |
| beta | : Beta value |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 424 of file yocto_temperature.cpp.
Changes the temperature sensor type. This function is used to define the type of thermocouple (K,E...) used with the device. It has no effect if module is using a digital sensor or a thermistor. Remember to call the saveToFlash() method of the module if the modification must be kept.
- Parameters
-
| newval | : a value among Y_SENSORTYPE_DIGITAL, Y_SENSORTYPE_TYPE_K, Y_SENSORTYPE_TYPE_E, Y_SENSORTYPE_TYPE_J, Y_SENSORTYPE_TYPE_N, Y_SENSORTYPE_TYPE_R, Y_SENSORTYPE_TYPE_S, Y_SENSORTYPE_TYPE_T, Y_SENSORTYPE_PT100_4WIRES, Y_SENSORTYPE_PT100_3WIRES, Y_SENSORTYPE_PT100_2WIRES, Y_SENSORTYPE_RES_OHM, Y_SENSORTYPE_RES_NTC, Y_SENSORTYPE_RES_LINEAR and Y_SENSORTYPE_RES_INTERNAL corresponding to the temperature sensor type |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 176 of file yocto_temperature.cpp.
| int YTemperature::set_thermistorResponseTable |
( |
vector< double > |
tempValues, |
|
|
vector< double > |
resValues |
|
) |
| |
|
virtual |
Records a thermistor response table, in order to interpolate the temperature from the measured resistance. This function can only be used with a temperature sensor based on thermistors.
- Parameters
-
| tempValues | : array of floating point numbers, corresponding to all temperatures (in degrees Celcius) for which the resistance of the thermistor is specified. |
| resValues | : array of floating point numbers, corresponding to the resistance values (in Ohms) for each of the temperature included in the first argument, index by index. |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 459 of file yocto_temperature.cpp.
| int YTemperature::set_unit |
( |
const string & |
newval | ) |
|
Changes the measuring unit for the measured temperature. That unit is a string. If that strings end with the letter F all temperatures values will returned in Fahrenheit degrees. If that String ends with the letter K all values will be returned in Kelvin degrees. If that string ends with the letter C all values will be returned in Celsius degrees. If the string ends with any other character the change will be ignored. Remember to call the saveToFlash() method of the module if the modification must be kept. WARNING: if a specific calibration is defined for the temperature function, a unit system change will probably break it.
- Parameters
-
| newval | : a string corresponding to the measuring unit for the measured temperature |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 110 of file yocto_temperature.cpp.
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.
Public Member Functions inherited from YSensor