|
| virtual int | _invokeTimedReportCallback (YMeasure value) |
| |
| virtual int | _invokeValueCallback (string value) |
| |
| double | get_signalBias (void) |
| |
| string | get_signalRange (void) |
| |
| Y_SIGNALSAMPLING_enum | get_signalSampling (void) |
| |
| string | get_signalUnit (void) |
| |
| double | get_signalValue (void) |
| |
| string | get_valueRange (void) |
| |
| YGenericSensor * | next (void) |
| |
| YGenericSensor * | nextGenericSensor (void) |
| |
| virtual int | registerTimedReportCallback (YGenericSensorTimedReportCallback callback) |
| |
| virtual int | registerValueCallback (YGenericSensorValueCallback callback) |
| |
| int | set_signalBias (double newval) |
| |
| int | set_signalRange (const string &newval) |
| |
| int | set_signalSampling (Y_SIGNALSAMPLING_enum newval) |
| |
| int | set_unit (const string &newval) |
| |
| int | set_valueRange (const string &newval) |
| |
| int | setSignalBias (double newval) |
| |
| int | setSignalRange (const string &newval) |
| |
| int | setSignalSampling (Y_SIGNALSAMPLING_enum newval) |
| |
| int | setUnit (const string &newval) |
| |
| int | setValueRange (const string &newval) |
| |
| double | signalBias (void) |
| |
| string | signalRange (void) |
| |
| Y_SIGNALSAMPLING_enum | signalSampling (void) |
| |
| string | signalUnit (void) |
| |
| double | signalValue (void) |
| |
| string | valueRange (void) |
| |
| virtual int | zeroAdjust (void) |
| |
| | ~YGenericSensor () |
| |
| 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 () |
| |
YGenericSensor Class: GenericSensor function interface
The YGenericSensor class allows you to read and configure Yoctopuce signal transducers. 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 the automatic conversion between the measured signal and the corresponding engineering unit.
Definition at line 84 of file yocto_genericsensor.h.
Retrieves a generic 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 generic sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YGenericSensor.isOnline() to test if the generic sensor is indeed online at a given time. In case of ambiguity when looking for a generic 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 generic sensor |
- Returns
- a YGenericSensor object allowing you to drive the generic sensor.
Definition at line 451 of file yocto_genericsensor.cpp.
| double YGenericSensor::get_signalBias |
( |
void |
| ) |
|
Returns the electric signal bias for zero shift adjustment. A positive bias means that the signal is over-reporting the measure, while a negative bias means that the signal is underreporting the measure.
- Returns
- a floating point number corresponding to the electric signal bias for zero shift adjustment
On failure, throws an exception or returns Y_SIGNALBIAS_INVALID.
Definition at line 334 of file yocto_genericsensor.cpp.
Returns the electric signal sampling method to use. The HIGH_RATE method uses the highest sampling frequency, without any filtering. The HIGH_RATE_FILTERED method adds a windowed 7-sample median filter. The LOW_NOISE method uses a reduced acquisition frequency to reduce noise. The LOW_NOISE_FILTERED method combines a reduced frequency with the median filter to get measures as stable as possible when working on a noisy signal.
- Returns
- a value among Y_SIGNALSAMPLING_HIGH_RATE, Y_SIGNALSAMPLING_HIGH_RATE_FILTERED, Y_SIGNALSAMPLING_LOW_NOISE and Y_SIGNALSAMPLING_LOW_NOISE_FILTERED corresponding to the electric signal sampling method to use
On failure, throws an exception or returns Y_SIGNALSAMPLING_INVALID.
Definition at line 370 of file yocto_genericsensor.cpp.
| int YGenericSensor::set_signalBias |
( |
double |
newval | ) |
|
Changes the electric signal bias for zero shift adjustment. If your electric signal reads positif when it should be zero, setup a positive signalBias of the same value to fix the zero shift.
- Parameters
-
| newval | : a floating point number corresponding to the electric signal bias for zero shift adjustment |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 309 of file yocto_genericsensor.cpp.
Changes the electric signal sampling method to use. The HIGH_RATE method uses the highest sampling frequency, without any filtering. The HIGH_RATE_FILTERED method adds a windowed 7-sample median filter. The LOW_NOISE method uses a reduced acquisition frequency to reduce noise. The LOW_NOISE_FILTERED method combines a reduced frequency with the median filter to get measures as stable as possible when working on a noisy signal.
- Parameters
-
| newval | : a value among Y_SIGNALSAMPLING_HIGH_RATE, Y_SIGNALSAMPLING_HIGH_RATE_FILTERED, Y_SIGNALSAMPLING_LOW_NOISE and Y_SIGNALSAMPLING_LOW_NOISE_FILTERED corresponding to the electric signal sampling method to use |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 408 of file yocto_genericsensor.cpp.
| int YGenericSensor::set_valueRange |
( |
const string & |
newval | ) |
|
Changes the physical value range measured by the sensor. As a side effect, the range modification may automatically modify the display resolution. Default value is "-999999.999...999999.999".
- Parameters
-
| newval | : a string corresponding to the physical value range measured by the sensor |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 282 of file yocto_genericsensor.cpp.
Retrieves a generic 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 generic sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YGenericSensor.isOnline() to test if the generic sensor is indeed online at a given time. In case of ambiguity when looking for a generic 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 generic sensor |
- Returns
- a YGenericSensor object allowing you to drive the generic sensor.
Definition at line 418 of file yocto_genericsensor.h.
Public Member Functions inherited from YSensor