|
| virtual int | _invokeTimedReportCallback (YMeasure value) |
| |
| virtual int | _invokeValueCallback (string value) |
| |
| int | bandwidth (void) |
| |
| int | get_bandwidth (void) |
| |
| double | get_xValue (void) |
| |
| double | get_yValue (void) |
| |
| double | get_zValue (void) |
| |
| YMagnetometer * | next (void) |
| |
| YMagnetometer * | nextMagnetometer (void) |
| |
| virtual int | registerTimedReportCallback (YMagnetometerTimedReportCallback callback) |
| |
| virtual int | registerValueCallback (YMagnetometerValueCallback callback) |
| |
| int | set_bandwidth (int newval) |
| |
| int | setBandwidth (int newval) |
| |
| double | xValue (void) |
| |
| double | yValue (void) |
| |
| double | zValue (void) |
| |
| | ~YMagnetometer () |
| |
| 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 () |
| |
YMagnetometer Class: Magnetometer function interface
The YSensor class is the parent class for all Yoctopuce sensors. It can be used to read the current value and unit of any sensor, read the min/max value, configure autonomous recording frequency and access recorded data. It also provide a function to register a callback invoked each time the observed value changes, or at a predefined interval. Using this class rather than a specific subclass makes it possible to create generic applications that work with any Yoctopuce sensor, even those that do not yet exist. Note: The YAnButton class is the only analog input which does not inherit from YSensor.
Definition at line 77 of file yocto_magnetometer.h.
Retrieves a magnetometer 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 magnetometer is online at the time it is invoked. The returned object is nevertheless valid. Use the method YMagnetometer.isOnline() to test if the magnetometer is indeed online at a given time. In case of ambiguity when looking for a magnetometer 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 magnetometer |
- Returns
- a YMagnetometer object allowing you to drive the magnetometer.
Definition at line 265 of file yocto_magnetometer.cpp.
| int YMagnetometer::set_bandwidth |
( |
int |
newval | ) |
|
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only). When the frequency is lower, the device performs averaging.
- Parameters
-
| newval | : an integer corresponding to the measure update frequency, measured in Hz (Yocto-3D-V2 only) |
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 132 of file yocto_magnetometer.cpp.
Retrieves a magnetometer 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 magnetometer is online at the time it is invoked. The returned object is nevertheless valid. Use the method YMagnetometer.isOnline() to test if the magnetometer is indeed online at a given time. In case of ambiguity when looking for a magnetometer 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 magnetometer |
- Returns
- a YMagnetometer object allowing you to drive the magnetometer.
Definition at line 299 of file yocto_magnetometer.h.
Public Member Functions inherited from YSensor