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.
MagRing Class Reference
Class mag_ring is intended to represent the MEMS Inertial & Environmental Nucleo Expansion Board with the same name. More...
#include <mag_ring.h>
Protected Member Functions | |
| bool | Init (void) |
| Initialize the singleton's sensors to default settings. | |
Detailed Description
Class mag_ring is intended to represent the MEMS Inertial & Environmental Nucleo Expansion Board with the same name.
The expansion board is featuring basically four IPs:
- a HTS221 Relative Humidity and Temperature Sensor
- a LIS3MDL 3-Axis Magnetometer
- a LPS25H MEMS Pressure Sensor (and Temperature Sensor)
- and a LSM6DS33 3D Acceleromenter and 3D Gyroscope
The expansion board features also a DIL 24-pin socket which makes it possible to add further MEMS adapters and other sensors (e.g. UV index).
It is intentionally implemented as a singleton because only one mag_ring at a time might be deployed in a HW component stack.
In order to get the singleton instance you have to call class method `Instance()`, e.g.:
// Inertial & Environmental expansion board singleton instance static mag_ring *<TODO>_expansion_board = mag_ring::Instance();
Definition at line 77 of file mag_ring.h.
Member Function Documentation
| bool Init | ( | void | ) | [protected] |
Initialize the singleton's sensors to default settings.
- Return values:
-
true if initialization successful, false otherwise
Definition at line 92 of file mag_ring.h.
Generated on Sat Jul 16 2022 17:11:58 by
1.7.2