ST / X_NUCLEO_IKS01A1

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

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   MultiTech_Dragonfly_2015_ATT_Gov_Solutions_Hackathon_Example HelloWorld_IKS01A1 LoRaWAN-test-10secs ServoMotorDemo ... more

Fork of X_NUCLEO_IKS01A1 by ST Expansion SW Team

X-NUCLEO-IKS01A1 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-IKS01A1 MEMS Inertial & Environmental Sensors Nucleo Expansion Board.

Firmware Library

Class X_NUCLEO_IKS01A1 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 LIS3MDL 3-Axis Magnetometer,
  3. a LPS25H MEMS Pressure Sensor, and
  4. a LSM6DS0 3D Accelerometer 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 X_NUCLEO_IKS01A1 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 X_NUCLEO_IKS01A1 *sensors_expansion_board = X_NUCLEO_IKS01A1::Instance();


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: x_nucleo_iks01a1.cpp

Revision:
73:e5b028bdd350
Parent:
72:79a2a64c9b2f
Child:
92:d1c67d482bad
--- a/x_nucleo_iks01a1.cpp	Thu Sep 03 10:46:55 2015 +0200
+++ b/x_nucleo_iks01a1.cpp	Thu Sep 03 13:17:36 2015 +0200
@@ -62,9 +62,11 @@
 
 /**
  * @brief     Get singleton instance
- * @return    a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A1
+ * @return    a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A1.
+ *            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. 
+ *            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
  *            configuration parameters.
@@ -72,6 +74,8 @@
  * @param[in] ff_irq_pin (optional) PinName of the pin associated to asynchronous 
  *            (i.e. interrupt based) free fall detection in case a LSM6DS3 3D 
  *            Acceleromenter and 3D Gyroscope is mounted on top of the DIL 24-pin socket.
+ *            Defaults to IKS01A1_PIN_FF.
+ *            Taken into account only on the very first call of one of the 'Instance' functions.
  *            A value of 'NC' will avoid instantiation of the LSM6DS3 even if present.
  */
 X_NUCLEO_IKS01A1* X_NUCLEO_IKS01A1::Instance(DevI2C *ext_i2c, PinName ff_irq_pin) {
@@ -95,7 +99,8 @@
 
 /**
  * @brief     Get singleton instance
- * @return    a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A1
+ * @return    a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A1.
+ *            A return value of NULL indicates an out of memory situation.
  * @param[in] sda I2C data line pin.
  *            Taken into account only on the very first call of one of the 'Instance' functions.
  *            A new DevI2C will be created based on parameters 'sda' and 'scl'.
@@ -107,6 +112,8 @@
  * @param[in] ff_irq_pin (optional) PinName of the pin associated to asynchronous 
  *            (i.e. interrupt based) free fall detection in case a LSM6DS3 3D 
  *            Acceleromenter and 3D Gyroscope is mounted on top of the DIL 24-pin socket.
+ *            Defaults to NC.
+ *            Taken into account only on the very first call of one of the 'Instance' functions.
  *            A value of 'NC' will avoid instantiation of the LSM6DS3 even if present.
  */
 X_NUCLEO_IKS01A1* X_NUCLEO_IKS01A1::Instance(PinName sda, PinName scl, PinName ff_irq_pin) {