Initial release. Mbed library for VL53L1CB
MotionSensor Class Reference
An abstract class for an Accelerometer. More...
#include <MotionSensor.h>
Inherits Component.
Public Member Functions | |
virtual int | get_x_axes (int32_t *p_data)=0 |
Get current accelerometer linear acceleration X/Y/Z-axes values in standard data units [mg]. | |
virtual int | get_x_axes_raw (int16_t *p_data)=0 |
Get current accelerometer raw data X/Y/Z-axes values in device sepcific LSB units. | |
virtual int | get_x_sensitivity (float *pf_data)=0 |
Get accelerometer's current sensitivity [mg/LSB]. | |
virtual int | get_x_odr (float *pf_data)=0 |
Get accelerometer's current output data rate [Hz]. | |
virtual int | set_x_odr (float odr)=0 |
Set accelerometer's output data rate. | |
virtual int | get_x_fs (float *pf_data)=0 |
Get accelerometer's full scale value i.e. min/max measurable value [g]. | |
virtual int | set_x_fs (float fs)=0 |
Set accelerometer's full scale value i.e. min/max measurable value. | |
virtual | ~MotionSensor () |
Destructor. | |
virtual int | init (void *init)=0 |
Initializing the component. | |
virtual int | read_id (uint8_t *id)=0 |
Getting the ID of the component. |
Detailed Description
An abstract class for an Accelerometer.
Definition at line 56 of file MotionSensor.h.
Constructor & Destructor Documentation
virtual ~MotionSensor | ( | ) | [virtual] |
Destructor.
Definition at line 123 of file MotionSensor.h.
Member Function Documentation
virtual int get_x_axes | ( | int32_t * | p_data ) | [pure virtual] |
Get current accelerometer linear acceleration X/Y/Z-axes values in standard data units [mg].
- Parameters:
-
[out] p_data Pointer to where to store linear accelerations to. p_data must point to an array of (at least) three elements, where: p_data[0] corresponds to X-axis, p_data[1] corresponds to Y-axis, and p_data[2] corresponds to Z-axis.
- Returns:
- 0 in case of success, an error code otherwise
virtual int get_x_axes_raw | ( | int16_t * | p_data ) | [pure virtual] |
Get current accelerometer raw data X/Y/Z-axes values in device sepcific LSB units.
- Parameters:
-
[out] p_data Pointer to where to store accelerometer raw data to. p_data must point to an array of (at least) three elements, where: p_data[0] corresponds to X-axis, p_data[1] corresponds to Y-axis, and p_data[2] corresponds to Z-axis.
- Returns:
- 0 in case of success, an error code otherwise
virtual int get_x_fs | ( | float * | pf_data ) | [pure virtual] |
Get accelerometer's full scale value i.e. min/max measurable value [g].
- Parameters:
-
[out] pf_data Pointer to where the accelerometer full scale value is stored to
- Returns:
- 0 in case of success, an error code otherwise
virtual int get_x_odr | ( | float * | pf_data ) | [pure virtual] |
Get accelerometer's current output data rate [Hz].
- Parameters:
-
[out] pf_data Pointer to where the accelerometer output data rate is stored to
- Returns:
- 0 in case of success, an error code otherwise
virtual int get_x_sensitivity | ( | float * | pf_data ) | [pure virtual] |
Get accelerometer's current sensitivity [mg/LSB].
- Parameters:
-
[out] pf_data Pointer to where the accelerometer's sensitivity is stored to
- Returns:
- 0 in case of success, an error code otherwise
virtual int init | ( | void * | init ) | [pure virtual, inherited] |
Initializing the component.
- Parameters:
-
[in] init pointer to device specific initalization structure.
- Return values:
-
0 in case of success, an error code otherwise.
Implemented in VL53L1X.
virtual int read_id | ( | uint8_t * | id ) | [pure virtual, inherited] |
Getting the ID of the component.
- Parameters:
-
[out] id pointer to an allocated variable to store the ID into.
- Return values:
-
0 in case of success, an error code otherwise.
Implemented in VL53L1X.
virtual int set_x_fs | ( | float | fs ) | [pure virtual] |
Set accelerometer's full scale value i.e. min/max measurable value.
- Parameters:
-
[in] fs New full scale value for accelerometer in [g]
- Returns:
- 0 in case of success, an error code otherwise
virtual int set_x_odr | ( | float | odr ) | [pure virtual] |
Set accelerometer's output data rate.
- Parameters:
-
[in] odr New value for accelerometer's output data rate in [Hz]
- Returns:
- 0 in case of success, an error code otherwise
Generated on Tue Jul 12 2022 20:07:15 by 1.7.2