Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
YAccelerometer Class Reference

#include <yocto_accelerometer.h>

Inheritance diagram for YAccelerometer:
Inheritance graph
[legend]

Public Member Functions

virtual int _invokeTimedReportCallback (YMeasure value)
 
virtual int _invokeValueCallback (string value)
 
int bandwidth (void)
 
int get_bandwidth (void)
 
Y_GRAVITYCANCELLATION_enum get_gravityCancellation (void)
 
double get_xValue (void)
 
double get_yValue (void)
 
double get_zValue (void)
 
Y_GRAVITYCANCELLATION_enum gravityCancellation (void)
 
YAccelerometer * next (void)
 
YAccelerometer * nextAccelerometer (void)
 
virtual int registerTimedReportCallback (YAccelerometerTimedReportCallback callback)
 
virtual int registerValueCallback (YAccelerometerValueCallback callback)
 
int set_bandwidth (int newval)
 
int set_gravityCancellation (Y_GRAVITYCANCELLATION_enum newval)
 
int setBandwidth (int newval)
 
int setGravityCancellation (Y_GRAVITYCANCELLATION_enum newval)
 
double xValue (void)
 
double yValue (void)
 
double zValue (void)
 
 ~YAccelerometer ()
 
- 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 YAccelerometer * Find (string func)
 
static YAccelerometer * FindAccelerometer (string func)
 
static YAccelerometer * First (void)
 
static YAccelerometer * FirstAccelerometer (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)
 

Static Public Attributes

static const int BANDWIDTH_INVALID = YAPI_INVALID_INT
 
static const Y_GRAVITYCANCELLATION_enum GRAVITYCANCELLATION_INVALID = Y_GRAVITYCANCELLATION_INVALID
 
static const Y_GRAVITYCANCELLATION_enum GRAVITYCANCELLATION_OFF = Y_GRAVITYCANCELLATION_OFF
 
static const Y_GRAVITYCANCELLATION_enum GRAVITYCANCELLATION_ON = Y_GRAVITYCANCELLATION_ON
 
static const double XVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const double YVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const double ZVALUE_INVALID = YAPI_INVALID_DOUBLE
 
- Static Public Attributes inherited from YSensor
static const Y_ADVMODE_enum ADVMODE_IMMEDIATE = Y_ADVMODE_IMMEDIATE
 
static const Y_ADVMODE_enum ADVMODE_INVALID = Y_ADVMODE_INVALID
 
static const Y_ADVMODE_enum ADVMODE_PERIOD_AVG = Y_ADVMODE_PERIOD_AVG
 
static const Y_ADVMODE_enum ADVMODE_PERIOD_MAX = Y_ADVMODE_PERIOD_MAX
 
static const Y_ADVMODE_enum ADVMODE_PERIOD_MIN = Y_ADVMODE_PERIOD_MIN
 
static const string CALIBRATIONPARAM_INVALID = YAPI_INVALID_STRING
 
static const double CURRENTRAWVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const double CURRENTVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const double HIGHESTVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const string LOGFREQUENCY_INVALID = YAPI_INVALID_STRING
 
static const double LOWESTVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const string REPORTFREQUENCY_INVALID = YAPI_INVALID_STRING
 
static const double RESOLUTION_INVALID = YAPI_INVALID_DOUBLE
 
static const int SENSORSTATE_INVALID = YAPI_INVALID_INT
 
static const string UNIT_INVALID = YAPI_INVALID_STRING
 
- Static Public Attributes inherited from YFunction
static const string ADVERTISEDVALUE_INVALID = YAPI_INVALID_STRING
 
static const string FRIENDLYNAME_INVALID = YAPI_INVALID_STRING
 
static const YFUN_DESCR FUNCTIONDESCRIPTOR_INVALID = Y_FUNCTIONDESCRIPTOR_INVALID
 
static const string FUNCTIONID_INVALID = YAPI_INVALID_STRING
 
static const string HARDWAREID_INVALID = YAPI_INVALID_STRING
 
static const string LOGICALNAME_INVALID = YAPI_INVALID_STRING
 

Protected Member Functions

virtual int _parseAttr (YJSONObject *json_val)
 
 YAccelerometer (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)
 

Protected Attributes

int _bandwidth
 
Y_GRAVITYCANCELLATION_enum _gravityCancellation
 
YAccelerometerTimedReportCallback _timedReportCallbackAccelerometer
 
YAccelerometerValueCallback _valueCallbackAccelerometer
 
double _xValue
 
double _yValue
 
double _zValue
 
- Protected Attributes inherited from YSensor
Y_ADVMODE_enum _advMode
 
yCalibrationHandler _calhdl
 
string _calibrationParam
 
vector< int > _calpar
 
vector< double > _calraw
 
vector< double > _calref
 
int _caltyp
 
double _currentRawValue
 
double _currentValue
 
double _decexp
 
double _highestValue
 
double _iresol
 
bool _isScal
 
bool _isScal32
 
string _logFrequency
 
double _lowestValue
 
double _offset
 
double _prevTimedReport
 
string _reportFrequency
 
double _resolution
 
double _scale
 
int _sensorState
 
YSensorTimedReportCallback _timedReportCallbackSensor
 
string _unit
 
YSensorValueCallback _valueCallbackSensor
 
- Protected Attributes inherited from YFunction
string _advertisedValue
 
u64 _cacheExpiration
 
string _className
 
std::map< string, YDataStream * > _dataStreams
 
string _func
 
YFUN_DESCR _fundescr
 
string _funId
 
string _hwId
 
string _lastErrorMsg
 
YRETCODE _lastErrorType
 
string _logicalName
 
string _serial
 
yCRITICAL_SECTION _this_cs
 
void * _userData
 
YFunctionValueCallback _valueCallbackFunction
 

Friends

YAccelerometer * yFindAccelerometer (const string &func)
 
YAccelerometer * yFirstAccelerometer (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
 

Detailed Description

YAccelerometer Class: Accelerometer 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 85 of file yocto_accelerometer.h.

Constructor & Destructor Documentation

YAccelerometer::YAccelerometer ( const string &  func)
protected

Definition at line 51 of file yocto_accelerometer.cpp.

YAccelerometer::~YAccelerometer ( )

Definition at line 65 of file yocto_accelerometer.cpp.

Member Function Documentation

int YAccelerometer::_invokeTimedReportCallback ( YMeasure  value)
virtual

Reimplemented from YSensor.

Definition at line 389 of file yocto_accelerometer.cpp.

int YAccelerometer::_invokeValueCallback ( string  value)
virtual

Reimplemented from YSensor.

Definition at line 355 of file yocto_accelerometer.cpp.

int YAccelerometer::_parseAttr ( YJSONObject *  json_val)
protectedvirtual

Reimplemented from YSensor.

Definition at line 76 of file yocto_accelerometer.cpp.

int YAccelerometer::bandwidth ( void  )
inline

Definition at line 132 of file yocto_accelerometer.h.

static YAccelerometer* YAccelerometer::Find ( string  func)
inlinestatic

Definition at line 256 of file yocto_accelerometer.h.

YAccelerometer * YAccelerometer::FindAccelerometer ( string  func)
static

Retrieves an accelerometer 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 accelerometer is online at the time it is invoked. The returned object is nevertheless valid. Use the method YAccelerometer.isOnline() to test if the accelerometer is indeed online at a given time. In case of ambiguity when looking for an accelerometer 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 accelerometer
Returns
a YAccelerometer object allowing you to drive the accelerometer.

Definition at line 304 of file yocto_accelerometer.cpp.

static YAccelerometer* YAccelerometer::First ( void  )
inlinestatic

Definition at line 280 of file yocto_accelerometer.h.

YAccelerometer * YAccelerometer::FirstAccelerometer ( void  )
static

Starts the enumeration of accelerometers currently accessible. Use the method YAccelerometer.nextAccelerometer() to iterate on next accelerometers.

Returns
a pointer to a YAccelerometer object, corresponding to the first accelerometer currently online, or a NULL pointer if there are none.

Definition at line 409 of file yocto_accelerometer.cpp.

int YAccelerometer::get_bandwidth ( void  )

Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).

Returns
an integer corresponding to the measure update frequency, measured in Hz (Yocto-3D-V2 only)

On failure, throws an exception or returns Y_BANDWIDTH_INVALID.

Definition at line 104 of file yocto_accelerometer.cpp.

Y_GRAVITYCANCELLATION_enum YAccelerometer::get_gravityCancellation ( void  )

Definition at line 239 of file yocto_accelerometer.cpp.

double YAccelerometer::get_xValue ( void  )

Returns the X component of the acceleration, as a floating point number.

Returns
a floating point number corresponding to the X component of the acceleration, as a floating point number

On failure, throws an exception or returns Y_XVALUE_INVALID.

Definition at line 159 of file yocto_accelerometer.cpp.

double YAccelerometer::get_yValue ( void  )

Returns the Y component of the acceleration, as a floating point number.

Returns
a floating point number corresponding to the Y component of the acceleration, as a floating point number

On failure, throws an exception or returns Y_YVALUE_INVALID.

Definition at line 188 of file yocto_accelerometer.cpp.

double YAccelerometer::get_zValue ( void  )

Returns the Z component of the acceleration, as a floating point number.

Returns
a floating point number corresponding to the Z component of the acceleration, as a floating point number

On failure, throws an exception or returns Y_ZVALUE_INVALID.

Definition at line 217 of file yocto_accelerometer.cpp.

Y_GRAVITYCANCELLATION_enum YAccelerometer::gravityCancellation ( void  )
inline

Definition at line 187 of file yocto_accelerometer.h.

YAccelerometer* YAccelerometer::next ( void  )
inline

Definition at line 267 of file yocto_accelerometer.h.

YAccelerometer * YAccelerometer::nextAccelerometer ( void  )

Continues the enumeration of accelerometers started using yFirstAccelerometer().

Returns
a pointer to a YAccelerometer object, corresponding to an accelerometer currently online, or a NULL pointer if there are no more accelerometers to enumerate.

Definition at line 399 of file yocto_accelerometer.cpp.

int YAccelerometer::registerTimedReportCallback ( YAccelerometerTimedReportCallback  callback)
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.

Parameters
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 376 of file yocto_accelerometer.cpp.

int YAccelerometer::registerValueCallback ( YAccelerometerValueCallback  callback)
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.

Parameters
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 336 of file yocto_accelerometer.cpp.

int YAccelerometer::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 136 of file yocto_accelerometer.cpp.

int YAccelerometer::set_gravityCancellation ( Y_GRAVITYCANCELLATION_enum  newval)

Definition at line 261 of file yocto_accelerometer.cpp.

int YAccelerometer::setBandwidth ( int  newval)
inline

Definition at line 146 of file yocto_accelerometer.h.

int YAccelerometer::setGravityCancellation ( Y_GRAVITYCANCELLATION_enum  newval)
inline

Definition at line 191 of file yocto_accelerometer.h.

double YAccelerometer::xValue ( void  )
inline

Definition at line 158 of file yocto_accelerometer.h.

double YAccelerometer::yValue ( void  )
inline

Definition at line 170 of file yocto_accelerometer.h.

double YAccelerometer::zValue ( void  )
inline

Definition at line 182 of file yocto_accelerometer.h.

Friends And Related Function Documentation

YAccelerometer* yFindAccelerometer ( const string &  func)
friend

Retrieves an accelerometer 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 accelerometer is online at the time it is invoked. The returned object is nevertheless valid. Use the method YAccelerometer.isOnline() to test if the accelerometer is indeed online at a given time. In case of ambiguity when looking for an accelerometer 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 accelerometer
Returns
a YAccelerometer object allowing you to drive the accelerometer.

Definition at line 317 of file yocto_accelerometer.h.

YAccelerometer* yFirstAccelerometer ( void  )
friend

Starts the enumeration of accelerometers currently accessible. Use the method YAccelerometer.nextAccelerometer() to iterate on next accelerometers.

Returns
a pointer to a YAccelerometer object, corresponding to the first accelerometer currently online, or a NULL pointer if there are none.

Definition at line 328 of file yocto_accelerometer.h.

Member Data Documentation

int YAccelerometer::_bandwidth
protected

Definition at line 93 of file yocto_accelerometer.h.

Y_GRAVITYCANCELLATION_enum YAccelerometer::_gravityCancellation
protected

Definition at line 97 of file yocto_accelerometer.h.

YAccelerometerTimedReportCallback YAccelerometer::_timedReportCallbackAccelerometer
protected

Definition at line 99 of file yocto_accelerometer.h.

YAccelerometerValueCallback YAccelerometer::_valueCallbackAccelerometer
protected

Definition at line 98 of file yocto_accelerometer.h.

double YAccelerometer::_xValue
protected

Definition at line 94 of file yocto_accelerometer.h.

double YAccelerometer::_yValue
protected

Definition at line 95 of file yocto_accelerometer.h.

double YAccelerometer::_zValue
protected

Definition at line 96 of file yocto_accelerometer.h.

const int YAccelerometer::BANDWIDTH_INVALID = YAPI_INVALID_INT
static

Definition at line 115 of file yocto_accelerometer.h.

const Y_GRAVITYCANCELLATION_enum YAccelerometer::GRAVITYCANCELLATION_INVALID = Y_GRAVITYCANCELLATION_INVALID
static

Definition at line 121 of file yocto_accelerometer.h.

const Y_GRAVITYCANCELLATION_enum YAccelerometer::GRAVITYCANCELLATION_OFF = Y_GRAVITYCANCELLATION_OFF
static

Definition at line 119 of file yocto_accelerometer.h.

const Y_GRAVITYCANCELLATION_enum YAccelerometer::GRAVITYCANCELLATION_ON = Y_GRAVITYCANCELLATION_ON
static

Definition at line 120 of file yocto_accelerometer.h.

const double YAccelerometer::XVALUE_INVALID = YAPI_INVALID_DOUBLE
static

Definition at line 116 of file yocto_accelerometer.h.

const double YAccelerometer::YVALUE_INVALID = YAPI_INVALID_DOUBLE
static

Definition at line 117 of file yocto_accelerometer.h.

const double YAccelerometer::ZVALUE_INVALID = YAPI_INVALID_DOUBLE
static

Definition at line 118 of file yocto_accelerometer.h.

The documentation for this class was generated from the following files:

yoctopuce_altimeter
Author(s): Anja Sheppard
autogenerated on Mon Jun 10 2019 15:49:13