#include <yocto_gyro.h>
Public Member Functions | |
virtual int | _invokeGyroCallbacks (int qtIndex, double qtValue) |
virtual int | _invokeTimedReportCallback (YMeasure value) |
virtual int | _invokeValueCallback (string value) |
virtual int | _loadAngles (void) |
virtual int | _loadQuaternion (void) |
int | bandwidth (void) |
int | get_bandwidth (void) |
virtual double | get_heading (void) |
virtual double | get_pitch (void) |
virtual double | get_quaternionW (void) |
virtual double | get_quaternionX (void) |
virtual double | get_quaternionY (void) |
virtual double | get_quaternionZ (void) |
virtual double | get_roll (void) |
double | get_xValue (void) |
double | get_yValue (void) |
double | get_zValue (void) |
YGyro * | next (void) |
YGyro * | nextGyro (void) |
virtual int | registerAnglesCallback (YAnglesCallback callback) |
virtual int | registerQuaternionCallback (YQuatCallback callback) |
virtual int | registerTimedReportCallback (YGyroTimedReportCallback callback) |
virtual int | registerValueCallback (YGyroValueCallback callback) |
int | set_bandwidth (int newval) |
int | setBandwidth (int newval) |
double | xValue (void) |
double | yValue (void) |
double | zValue (void) |
~YGyro () | |
Public Member Functions inherited from YSensor | |
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 () | |
Public Member Functions inherited from YFunction | |
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 () |
Static Public Member Functions | |
static YGyro * | Find (string func) |
static YGyro * | FindGyro (string func) |
static YGyro * | First (void) |
static YGyro * | FirstGyro (void) |
Static Public Member Functions inherited from YSensor | |
static YSensor * | Find (string func) |
static YSensor * | FindSensor (string func) |
static YSensor * | First (void) |
static YSensor * | FirstSensor (void) |
Static Public Member Functions inherited from YFunction | |
static void | _ClearCache (void) |
static YFunction * | Find (string func) |
static YFunction * | FindFunction (string func) |
static YFunction * | First (void) |
static YFunction * | FirstFunction (void) |
Protected Member Functions | |
virtual int | _parseAttr (YJSONObject *json_val) |
YGyro (const string &func) | |
Protected Member Functions inherited from YSensor | |
YSensor (const string &func) | |
Protected Member Functions inherited from YFunction | |
YRETCODE | _buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg) |
string | _escapeAttr (const string &changeval) |
YRETCODE | _getDescriptor (YFUN_DESCR &fundescr, string &errMsg) |
YRETCODE | _getDevice (YDevice *&dev, string &errMsg) |
YRETCODE | _load_unsafe (int msValidity) |
YRETCODE | _nextFunction (string &hwId) |
int | _parse (YJSONObject *j) |
YRETCODE | _setAttr (string attrname, string newvalue) |
YFunction (const string &func) | |
Friends | |
YGyro * | yFindGyro (const string &func) |
YGyro * | yFirstGyro (void) |
Additional Inherited Members | |
Static Protected Member Functions inherited from YFunction | |
static void | _AddToCache (const string &classname, const string &func, YFunction *obj) |
static YFunction * | _FindFromCache (const string &classname, const string &func) |
static void | _UpdateTimedReportCallbackList (YFunction *func, bool add) |
static void | _UpdateValueCallbackList (YFunction *func, bool add) |
Static Protected Attributes inherited from YFunction | |
static std::map< string, YFunction * > | _cache |
YGyro Class: Gyroscope 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 262 of file yocto_gyro.h.
|
protected |
Definition at line 238 of file yocto_gyro.cpp.
YGyro::~YGyro | ( | ) |
Definition at line 266 of file yocto_gyro.cpp.
|
virtual |
Definition at line 834 of file yocto_gyro.cpp.
|
virtual |
Reimplemented from YSensor.
Definition at line 552 of file yocto_gyro.cpp.
|
virtual |
Reimplemented from YSensor.
Definition at line 518 of file yocto_gyro.cpp.
|
virtual |
Definition at line 599 of file yocto_gyro.cpp.
|
virtual |
Definition at line 562 of file yocto_gyro.cpp.
|
protectedvirtual |
Reimplemented from YSensor.
Definition at line 277 of file yocto_gyro.cpp.
|
inline |
Definition at line 320 of file yocto_gyro.h.
|
inlinestatic |
Definition at line 564 of file yocto_gyro.h.
|
static |
Retrieves a gyroscope for a given identifier. The identifier can be specified using several formats:
This function does not require that the gyroscope is online at the time it is invoked. The returned object is nevertheless valid. Use the method YGyro.isOnline() to test if the gyroscope is indeed online at a given time. In case of ambiguity when looking for a gyroscope 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.
func | : a string that uniquely characterizes the gyroscope |
Definition at line 467 of file yocto_gyro.cpp.
|
inlinestatic |
Definition at line 588 of file yocto_gyro.h.
|
static |
Starts the enumeration of gyroscopes currently accessible. Use the method YGyro.nextGyro() to iterate on next gyroscopes.
Definition at line 874 of file yocto_gyro.cpp.
int YGyro::get_bandwidth | ( | void | ) |
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
On failure, throws an exception or returns Y_BANDWIDTH_INVALID.
Definition at line 302 of file yocto_gyro.cpp.
|
virtual |
Returns the estimated heading angle, based on the integration of gyroscopic measures combined with acceleration and magnetic field measurements. The axis corresponding to the heading can be mapped to any of the device X, Y or Z physical directions using methods of the class YRefFrame.
Definition at line 683 of file yocto_gyro.cpp.
|
virtual |
Returns the estimated pitch angle, based on the integration of gyroscopic measures combined with acceleration and magnetic field measurements. The axis corresponding to the pitch angle can be mapped to any of the device X, Y or Z physical directions using methods of the class YRefFrame.
Definition at line 666 of file yocto_gyro.cpp.
|
virtual |
Returns the w component (real part) of the quaternion describing the device estimated orientation, based on the integration of gyroscopic measures combined with acceleration and magnetic field measurements.
Definition at line 698 of file yocto_gyro.cpp.
|
virtual |
Returns the x component of the quaternion describing the device estimated orientation, based on the integration of gyroscopic measures combined with acceleration and magnetic field measurements. The x component is mostly correlated with rotations on the roll axis.
Definition at line 714 of file yocto_gyro.cpp.
|
virtual |
Returns the y component of the quaternion describing the device estimated orientation, based on the integration of gyroscopic measures combined with acceleration and magnetic field measurements. The y component is mostly correlated with rotations on the pitch axis.
Definition at line 730 of file yocto_gyro.cpp.
|
virtual |
Returns the x component of the quaternion describing the device estimated orientation, based on the integration of gyroscopic measures combined with acceleration and magnetic field measurements. The x component is mostly correlated with changes of heading.
Definition at line 746 of file yocto_gyro.cpp.
|
virtual |
Returns the estimated roll angle, based on the integration of gyroscopic measures combined with acceleration and magnetic field measurements. The axis corresponding to the roll angle can be mapped to any of the device X, Y or Z physical directions using methods of the class YRefFrame.
Definition at line 649 of file yocto_gyro.cpp.
double YGyro::get_xValue | ( | void | ) |
Returns the angular velocity around the X axis of the device, as a floating point number.
On failure, throws an exception or returns Y_XVALUE_INVALID.
Definition at line 358 of file yocto_gyro.cpp.
double YGyro::get_yValue | ( | void | ) |
Returns the angular velocity around the Y axis of the device, as a floating point number.
On failure, throws an exception or returns Y_YVALUE_INVALID.
Definition at line 388 of file yocto_gyro.cpp.
double YGyro::get_zValue | ( | void | ) |
Returns the angular velocity around the Z axis of the device, as a floating point number.
On failure, throws an exception or returns Y_ZVALUE_INVALID.
Definition at line 418 of file yocto_gyro.cpp.
|
inline |
Definition at line 575 of file yocto_gyro.h.
YGyro * YGyro::nextGyro | ( | void | ) |
Continues the enumeration of gyroscopes started using yFirstGyro().
Definition at line 864 of file yocto_gyro.cpp.
|
virtual |
Registers a callback function that will be invoked each time that the estimated device orientation has changed. The call frequency is typically around 95Hz during a move. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.
callback | : the callback function to invoke, or a NULL pointer. The callback function should take four arguments: the YGyro object of the turning device, and the floating point values of the three angles roll, pitch and heading in degrees (as floating-point numbers). |
Definition at line 808 of file yocto_gyro.cpp.
|
virtual |
Registers a callback function that will be invoked each time that the estimated device orientation has changed. The call frequency is typically around 95Hz during a move. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.
callback | : the callback function to invoke, or a NULL pointer. The callback function should take five arguments: the YGyro object of the turning device, and the floating point values of the four components w, x, y and z (as floating-point numbers). |
Definition at line 767 of file yocto_gyro.cpp.
|
virtual |
Registers the callback function that is invoked on every periodic timed notification. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.
callback | : the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and an YMeasure object describing the new advertised value. |
Definition at line 539 of file yocto_gyro.cpp.
|
virtual |
Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.
callback | : the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value. |
Definition at line 499 of file yocto_gyro.cpp.
int YGyro::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.
newval | : an integer corresponding to the measure update frequency, measured in Hz (Yocto-3D-V2 only) |
On failure, throws an exception or returns a negative error code.
Definition at line 334 of file yocto_gyro.cpp.
|
inline |
Definition at line 334 of file yocto_gyro.h.
|
inline |
Definition at line 347 of file yocto_gyro.h.
|
inline |
Definition at line 360 of file yocto_gyro.h.
|
inline |
Definition at line 373 of file yocto_gyro.h.
|
friend |
Retrieves a gyroscope for a given identifier. The identifier can be specified using several formats:
This function does not require that the gyroscope is online at the time it is invoked. The returned object is nevertheless valid. Use the method YGyro.isOnline() to test if the gyroscope is indeed online at a given time. In case of ambiguity when looking for a gyroscope 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.
func | : a string that uniquely characterizes the gyroscope |
Definition at line 625 of file yocto_gyro.h.
|
friend |
Starts the enumeration of gyroscopes currently accessible. Use the method YGyro.nextGyro() to iterate on next gyroscopes.
Definition at line 636 of file yocto_gyro.h.
|
protected |
Definition at line 285 of file yocto_gyro.h.
|
protected |
Definition at line 290 of file yocto_gyro.h.
|
protected |
Definition at line 270 of file yocto_gyro.h.
|
protected |
Definition at line 286 of file yocto_gyro.h.
|
protected |
Definition at line 287 of file yocto_gyro.h.
|
protected |
Definition at line 276 of file yocto_gyro.h.
|
protected |
Definition at line 277 of file yocto_gyro.h.
|
protected |
Definition at line 278 of file yocto_gyro.h.
|
protected |
Definition at line 279 of file yocto_gyro.h.
|
protected |
Definition at line 280 of file yocto_gyro.h.
|
protected |
Definition at line 289 of file yocto_gyro.h.
|
protected |
Definition at line 288 of file yocto_gyro.h.
|
protected |
Definition at line 275 of file yocto_gyro.h.
|
protected |
Definition at line 274 of file yocto_gyro.h.
|
protected |
Definition at line 281 of file yocto_gyro.h.
|
protected |
Definition at line 282 of file yocto_gyro.h.
|
protected |
Definition at line 271 of file yocto_gyro.h.
|
protected |
Definition at line 283 of file yocto_gyro.h.
|
protected |
Definition at line 272 of file yocto_gyro.h.
|
protected |
Definition at line 284 of file yocto_gyro.h.
|
protected |
Definition at line 273 of file yocto_gyro.h.
|
static |
Definition at line 306 of file yocto_gyro.h.
|
static |
Definition at line 307 of file yocto_gyro.h.
|
static |
Definition at line 308 of file yocto_gyro.h.
|
static |
Definition at line 309 of file yocto_gyro.h.