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

• Hello World
• Sensors Reader

--- a/x_nucleo_iks01a1.cpp	Wed Jun 10 18:03:42 2015 +0200
+++ b/x_nucleo_iks01a1.cpp	Mon Jun 15 10:28:49 2015 +0200
@@ -57,14 +57,14 @@
 }
 
 /**
- * @brief  Get singleton instance
- * @return a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A1
- * @param  (optional) ext_i2c pointer to instance of DevI2C to be used
- *         for communication on the expansion board. 
- *         Taken into account only on the very first call of this function.
- *         If not provided a new DevI2C will be created with standard
- *         configuration parameters.
- *         The used DevI2C object gets saved in instance variable dev_i2c.
+ * @brief     Get singleton instance
+ * @return    a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A1
+ * @param[in] ext_i2c (optional) pointer to an instance of DevI2C to be used
+ *            for communication on the expansion board. 
+ *            Taken into account only on the very first call of this function.
+ *            If not provided a new DevI2C will be created with standard
+ *            configuration parameters.
+ *            The used DevI2C object gets saved in instance variable dev_i2c.
  */
  X_NUCLEO_IKS01A1* X_NUCLEO_IKS01A1::Instance(DevI2C *ext_i2c) {
 	if(_instance == NULL) {