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

diff -r 4a71f1594d7d -r 5490ac2d0a10 x_nucleo_iks01a1.h
--- a/x_nucleo_iks01a1.h	Fri Jun 05 18:20:37 2015 +0200
+++ b/x_nucleo_iks01a1.h	Mon Jun 08 13:46:20 2015 +0200
@@ -49,6 +49,12 @@
 #include "lsm6ds0/lsm6ds0_class.h"
 #include "DevI2C.h"
 
+/* Macros -------------------------------------------------------------------*/
+#define CALL_METH(obj, meth, param, ret) ((obj == NULL) ?		\
+					  ((*(param) = (ret)), 0) :	\
+					  ((obj)->meth(param))		\
+					  )
+
 /* Classes -------------------------------------------------------------------*/
 /** Class X_NUCLEO_IKS01A1 is intended to represent the MEMS Inertial & Environmental 
  *  Nucleo Expansion Board with the same name.
@@ -73,27 +79,21 @@
  protected:
 	X_NUCLEO_IKS01A1(DevI2C *ext_i2c);
 
-	bool Init(void) {
-		return (Init_HT() &&
-			Init_MAG() &&
-			Init_PRESS() &&
-			Init_GYRO());
-	}
-
-	bool Init_HT(void);
-	bool Init_MAG(void);
-	bool Init_PRESS(void);
-	bool Init_GYRO(void);
+	bool Init(void);
+	bool Init_HTS221(void);
+	bool Init_LIS3MDL(void);
+	bool Init_LPS25H(void);
+	bool Init_LSM6DS0(void);
 
  public:
 	static X_NUCLEO_IKS01A1* Instance(DevI2C *ext_i2c = NULL);
 
-	DevI2C *dev_i2c;
+	DevI2C  *dev_i2c;
 
-	HTS221 &ht_sensor;
-	LIS3MDL &magnetometer;
-	LPS25H &pressure_sensor;
-	LSM6DS0 &gyroscope;
+	HTS221  *ht_sensor;
+	LIS3MDL *magnetometer;
+	LPS25H  *pressure_sensor;
+	LSM6DS0 *gyroscope;
 
  private:
 	static X_NUCLEO_IKS01A1 *_instance;