Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more
Fork of
ST_INTERFACES
by 
Davide Aliprandi
GyroSensor Class Reference
An abstract class for a Gyroscope. More...
#include <GyroSensor.h>
Inherits Component.
Public Member Functions | |
| virtual int | get_g_axes (int32_t *p_data)=0 |
| Get current gyroscope angular rate X/Y/Z-axes values in standard data units [mdps]. | |
| virtual int | get_g_axes_raw (int16_t *p_data)=0 |
| Get current gyroscope raw data X/Y/Z-axes values in device sepcific LSB units. | |
| virtual int | get_g_sensitivity (float *pf_data)=0 |
| Get gyroscope's current sensitivity [mdps/LSB]. | |
| virtual int | get_g_odr (float *pf_data)=0 |
| Get gyroscope's current output data rate [Hz]. | |
| virtual int | set_g_odr (float odr)=0 |
| Set gyroscope's output data rate. | |
| virtual int | get_g_fs (float *pf_data)=0 |
| Get gyroscope's full scale value i.e. min/max measurable value [dps]. | |
| virtual int | set_g_fs (float fs)=0 |
| Set gyroscope's full scale value i.e. min/max measurable value. | |
| virtual | ~GyroSensor () |
| 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 a Gyroscope.
Definition at line 56 of file GyroSensor.h.
Constructor & Destructor Documentation
| virtual ~GyroSensor | ( | ) | [virtual] |
Destructor.
Definition at line 123 of file GyroSensor.h.
Member Function Documentation
| virtual int get_g_axes | ( | int32_t * | p_data ) | [pure virtual] |
Get current gyroscope angular rate X/Y/Z-axes values in standard data units [mdps].
- Parameters:
-
[out] p_data Pointer to where to store angular rates 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_g_axes_raw | ( | int16_t * | p_data ) | [pure virtual] |
Get current gyroscope raw data X/Y/Z-axes values in device sepcific LSB units.
- Parameters:
-
[out] p_data Pointer to where to store gyroscope 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_g_fs | ( | float * | pf_data ) | [pure virtual] |
Get gyroscope's full scale value i.e. min/max measurable value [dps].
- Parameters:
-
[out] pf_data Pointer to where the gyroscope full scale value is stored to
- Returns:
- 0 in case of success, an error code otherwise
| virtual int get_g_odr | ( | float * | pf_data ) | [pure virtual] |
Get gyroscope's current output data rate [Hz].
- Parameters:
-
[out] pf_data Pointer to where the gyroscope output data rate is stored to
- Returns:
- 0 in case of success, an error code otherwise
| virtual int get_g_sensitivity | ( | float * | pf_data ) | [pure virtual] |
Get gyroscope's current sensitivity [mdps/LSB].
- Parameters:
-
[out] pf_data Pointer to where the gyroscope'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.
| 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.
| virtual int set_g_fs | ( | float | fs ) | [pure virtual] |
Set gyroscope's full scale value i.e. min/max measurable value.
- Parameters:
-
[in] fs New full scale value for gyroscope in [dps]
- Returns:
- 0 in case of success, an error code otherwise
| virtual int set_g_odr | ( | float | odr ) | [pure virtual] |
Set gyroscope's output data rate.
- Parameters:
-
[in] odr New value for gyroscope's output data rate in [Hz]
- Returns:
- 0 in case of success, an error code otherwise
Generated on Tue Jul 12 2022 18:43:53 by
1.7.2