ST / X_NUCLEO_IKS01A3

Firmware Library for X-NUCLEO-IKS01A3 (MEMS Inertial & Environmental Sensors) Expansion Board

Dependencies:   STTS751 LPS22HH LIS2MDL HTS221 LIS2DW12 LSM6DSO

Dependents:   ELEC35XR-2019 ELEC35XR-2019_SEM calculate IKS01A3 ... more

X-NUCLEO-IKS01A3 MEMS Inertial & Environmental Sensor Nucleo Expansion Board Firmware Package

Introduction

This firmware package includes Components Device Drivers and Board Support Package for STMicroelectronics' X-NUCLEO-IKS01A3 MEMS Inertial & Environmental Sensors Nucleo Expansion Board.

Firmware Library

Class X_NUCLEO_IKS01A3 is intended to represent the MEMS inertial & environmental sensors expansion board with the same name.

The expansion board is basically featuring four IPs:

  1. a HTS221 Relative Humidity and Temperature Sensor,
  2. a LIS2MDL 3-Axis Magnetometer
  3. a LIS2DW12 3-Axis Accelerometer
  4. a LPS22HH MEMS Pressure and Temperature Sensor
  5. a LSM6DSO 3-Axis Accelerometer and 3-Axis Gyroscope
  6. a STTS751 MEMS Temperature Sensor

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 X_NUCLEO_IKS01A3 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.:

// Sensors expansion board singleton instance
static XNucleoIKS01A3 *mems_expansion_board = XNucleoIKS01A3::instance(D14, D15, D4, D5, A3, D6, A4);


Furthermore, library ST_INTERFACES contains all abstract classes which together constitute the common API to which all existing and future ST components will adhere to.

Example Applications

Diff: XNucleoIKS01A3.cpp

Revision:
5:463962d6f485
Parent:
3:90c874c6a9f6
--- a/XNucleoIKS01A3.cpp	Mon Jun 03 09:25:14 2019 +0000
+++ b/XNucleoIKS01A3.cpp	Wed Jul 24 14:20:51 2019 +0000
@@ -33,8 +33,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  ******************************************************************************
-*/ 
-    
+*/
+
 /* Includes ------------------------------------------------------------------*/
 #include "mbed.h"
 #include "XNucleoIKS01A3.h"
@@ -54,13 +54,13 @@
     pt_sensor(new LPS22HHSensor(dev_i2c, LPS22HH_I2C_ADD_H, lps22hh_int)),
     acc_gyro(new LSM6DSOSensor(dev_i2c, LSM6DSO_I2C_ADD_H, lsm6dso_int1, lsm6dso_int2)),
     t_sensor(new STTS751Sensor(dev_i2c, STTS751_1xxxx_ADD_7K5, stts751_int))
-{ 
-  ht_sensor->init(NULL);
-  magnetometer->init(NULL);
-  accelerometer->init(NULL);
-  pt_sensor->init(NULL);
-  acc_gyro->init(NULL);
-  t_sensor->init(NULL);
+{
+    ht_sensor->init(NULL);
+    magnetometer->init(NULL);
+    accelerometer->init(NULL);
+    pt_sensor->init(NULL);
+    acc_gyro->init(NULL);
+    t_sensor->init(NULL);
 }
 
 /**
@@ -68,7 +68,7 @@
  * @return    a pointer to the initialized singleton instance of class XNucleoIKS01A3.
  *            A return value of NULL indicates an out of memory situation.
  * @param[in] ext_i2c (optional) pointer to an instance of DevI2C to be used
- *            for communication on the expansion board. 
+ *            for communication on the expansion board.
  *            Defaults to NULL.
  *            Taken into account only on the very first call of one of the 'Instance' functions.
  *            If not provided a new DevI2C will be created with standard
@@ -90,13 +90,16 @@
  *            Taken into account only on the very first call of one of the 'Instance' functions.
  *            It maps the INT pin for STTS751. Defaults to IKS01A3_PIN_STTS751_INT.
  */
-XNucleoIKS01A3 *XNucleoIKS01A3::instance(DevI2C *ext_i2c, PinName lsm6dso_int1, PinName lsm6dso_int2, PinName lis2dw12_int1, PinName lps22hh_int, PinName stts751_int) {
-    if(_instance == NULL) {
-        if(ext_i2c == NULL)
+XNucleoIKS01A3 *XNucleoIKS01A3::instance(DevI2C *ext_i2c, PinName lsm6dso_int1, PinName lsm6dso_int2, PinName lis2dw12_int1, PinName lps22hh_int, PinName stts751_int)
+{
+    if (_instance == NULL) {
+        if (ext_i2c == NULL) {
             ext_i2c = new DevI2C(IKS01A3_PIN_I2C_SDA, IKS01A3_PIN_I2C_SCL);
+        }
 
-        if(ext_i2c != NULL)
+        if (ext_i2c != NULL) {
             _instance = new XNucleoIKS01A3(ext_i2c, lsm6dso_int1, lsm6dso_int2, lis2dw12_int1, lps22hh_int, stts751_int);
+        }
     }
 
     return _instance;
@@ -130,12 +133,14 @@
  *            Taken into account only on the very first call of one of the 'Instance' functions.
  *            It maps the INT pin for STTS751. Defaults to IKS01A3_PIN_STTS751_INT.
  */
-XNucleoIKS01A3 *XNucleoIKS01A3::instance(PinName sda, PinName scl, PinName lsm6dso_int1, PinName lsm6dso_int2, PinName lis2dw12_int1, PinName lps22hh_int, PinName stts751_int) {
-    if(_instance == NULL) {
+XNucleoIKS01A3 *XNucleoIKS01A3::instance(PinName sda, PinName scl, PinName lsm6dso_int1, PinName lsm6dso_int2, PinName lis2dw12_int1, PinName lps22hh_int, PinName stts751_int)
+{
+    if (_instance == NULL) {
         DevI2C *ext_i2c = new DevI2C(sda, scl);
 
-        if(ext_i2c != NULL)
+        if (ext_i2c != NULL) {
             _instance = new XNucleoIKS01A3(ext_i2c, lsm6dso_int1, lsm6dso_int2, lis2dw12_int1, lps22hh_int, stts751_int);
+        }
     }
 
     return _instance;