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:
42:5490ac2d0a10
Parent:
24:92cc9c6e4b2b
Child:
44:d757094f6229
--- a/x_nucleo_iks01a1.cpp	Fri Jun 05 18:20:37 2015 +0200
+++ b/x_nucleo_iks01a1.cpp	Mon Jun 08 13:46:20 2015 +0200
@@ -48,10 +48,10 @@
  * @brief  Constructor
  */
 X_NUCLEO_IKS01A1::X_NUCLEO_IKS01A1(DevI2C *ext_i2c) : dev_i2c(ext_i2c),
-	ht_sensor(*(new HTS221(*dev_i2c))),
-	magnetometer(*(new LIS3MDL(*dev_i2c))),
-	pressure_sensor(*(new LPS25H(*dev_i2c))),
-	gyroscope(*(new LSM6DS0(*dev_i2c)))
+	ht_sensor(new HTS221(*dev_i2c)),
+	magnetometer(new LIS3MDL(*dev_i2c)),
+	pressure_sensor(new LPS25H(*dev_i2c)),
+	gyroscope(new LSM6DS0(*dev_i2c))
 { 
 }
 
@@ -85,31 +85,43 @@
 }
 
 /**
+ * @brief  Initialize the singelton's sensors to default settings
+ * @return true if initialization successful, false otherwise
+ * @retval true if initialization successful, 
+ * @retval false otherwise
+ */
+bool X_NUCLEO_IKS01A1::Init(void) {
+	return (Init_HTS221() &&
+		Init_LIS3MDL() &&
+		Init_LPS25H() &&
+		Init_LSM6DS0());
+}
+
+/**
  * @brief  Initialize the singelton HT sensor
  * @return true if initialization successful, false otherwise
  */
-bool X_NUCLEO_IKS01A1::Init_HT(void) {
+bool X_NUCLEO_IKS01A1::Init_HTS221(void) {
 	uint8_t ht_id = 0;
 	HUM_TEMP_InitTypeDef InitStructure;
 
+	/* Check presence */
+	if((ht_sensor->ReadID(&ht_id) != HUM_TEMP_OK) ||
+	   (ht_id != I_AM_HTS221))
+		{
+			delete ht_sensor;
+			ht_sensor = NULL;
+			return true;
+		}
+	
 	/* Configure sensor */
 	InitStructure.OutputDataRate = HTS221_ODR_12_5Hz;
 
-	if(ht_sensor.Init(&InitStructure) != HUM_TEMP_OK)
+	if(ht_sensor->Init(&InitStructure) != HUM_TEMP_OK)
 		{
 			return false;
 		}
       
-	if(ht_sensor.ReadID(&ht_id) != HUM_TEMP_OK)
-		{
-			return false;
-		}
-	
-	if(ht_id != I_AM_HTS221)
-		{
-			return false;
-		}
-
 	return true;
 }
 
@@ -117,31 +129,30 @@
  * @brief  Initialize the singelton magnetometer
  * @return true if initialization successful, false otherwise
  */
-bool X_NUCLEO_IKS01A1::Init_MAG(void) {
+bool X_NUCLEO_IKS01A1::Init_LIS3MDL(void) {
 	uint8_t m_id = 0;
 	MAGNETO_InitTypeDef InitStructure;
 
+	/* Check presence */
+	if((magnetometer->ReadID(&m_id) != MAGNETO_OK) ||
+	   (m_id != I_AM_LIS3MDL_M))
+		{
+			delete magnetometer;
+			magnetometer = NULL;
+			return true;
+		}
+      
 	/* Configure sensor */
 	InitStructure.M_FullScale = LIS3MDL_M_FS_4;
 	InitStructure.M_OperatingMode = LIS3MDL_M_MD_CONTINUOUS;
 	InitStructure.M_XYOperativeMode = LIS3MDL_M_OM_HP;
 	InitStructure.M_OutputDataRate = LIS3MDL_M_DO_80;
 
-	if(magnetometer.Init(&InitStructure) != MAGNETO_OK)
+	if(magnetometer->Init(&InitStructure) != MAGNETO_OK)
 		{
 			return false;
 		}
       
-	if(magnetometer.ReadID(&m_id) != MAGNETO_OK)
-		{
-			return false;
-		}
-      
-	if(m_id != I_AM_LIS3MDL_M)
-		{
-			return false;
-		}
-
 	return true;
 }
 
@@ -149,10 +160,19 @@
  * @brief  Initialize the singelton pressure sensor
  * @return true if initialization successful, false otherwise
  */
-bool X_NUCLEO_IKS01A1::Init_PRESS(void) {
+bool X_NUCLEO_IKS01A1::Init_LPS25H(void) {
 	uint8_t p_id = 0;
 	PRESSURE_InitTypeDef InitStructure;
 	
+	/* Check presence */
+	if((pressure_sensor->ReadID(&p_id) != PRESSURE_OK) ||
+	   (p_id != I_AM_LPS25H))
+		{
+			delete pressure_sensor;
+			pressure_sensor = NULL;
+			return true;
+		}
+            
 	/* Configure sensor */
 	InitStructure.OutputDataRate = LPS25H_ODR_1Hz;
 	InitStructure.BlockDataUpdate = LPS25H_BDU_CONT;
@@ -161,21 +181,11 @@
 	InitStructure.PressureResolution = LPS25H_P_RES_AVG_32;
 	InitStructure.TemperatureResolution = LPS25H_T_RES_AVG_16;
         
-	if(pressure_sensor.Init(&InitStructure) != PRESSURE_OK)
+	if(pressure_sensor->Init(&InitStructure) != PRESSURE_OK)
 		{
 			return false;
 		}
             
-	if(pressure_sensor.ReadID(&p_id) != PRESSURE_OK)
-		{
-			return false;
-		}
-            
-	if(p_id != I_AM_LPS25H)
-		{
-			return false;
-		}
-
 	return true;
 }
 
@@ -183,10 +193,19 @@
  * @brief  Initialize the singelton gyroscope
  * @return true if initialization successful, false otherwise
  */
-bool X_NUCLEO_IKS01A1::Init_GYRO(void) {
+bool X_NUCLEO_IKS01A1::Init_LSM6DS0(void) {
 	IMU_6AXES_InitTypeDef InitStructure;
 	uint8_t xg_id = 0;
 
+	/* Check presence */
+	if((gyroscope->ReadID(&xg_id) != IMU_6AXES_OK) ||
+	   (xg_id != I_AM_LSM6DS0_XG))
+		{
+			delete gyroscope;
+			gyroscope = NULL;
+			return true;
+		}
+            
 	/* Configure sensor */
 	InitStructure.G_FullScale       = 2000.0f; /* 2000DPS */
 	InitStructure.G_OutputDataRate  = 119.0f;  /* 119HZ */
@@ -200,20 +219,10 @@
 	InitStructure.X_Y_Axis          = 1;       /* Enable */
 	InitStructure.X_Z_Axis          = 1;       /* Enable */
               
-	if(gyroscope.Init(&InitStructure) != IMU_6AXES_OK)
+	if(gyroscope->Init(&InitStructure) != IMU_6AXES_OK)
 		{
 			return false; 
 		}
             
-	if(gyroscope.ReadID(&xg_id) != IMU_6AXES_OK)
-		{
-			return false;
-		}
-            
-	if(xg_id != I_AM_LSM6DS0_XG)
-		{
-			return false;
-		}
-
 	return true;
 }