Shih-Ho Hsieh / Mbed 2 deprecated Motor_XYZ_UI_SPI_8mag_encoder_L476RG

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

MagRing Class Reference

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:

  1. a HTS221 Relative Humidity and Temperature Sensor
  2. a LIS3MDL 3-Axis Magnetometer
  3. a LPS25H MEMS Pressure Sensor (and Temperature Sensor)
  4. 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:
trueif initialization successful,
falseotherwise

Definition at line 92 of file mag_ring.h.