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:
44:d757094f6229
Parent:
42:5490ac2d0a10
Child:
46:badcff0675e8
--- a/x_nucleo_iks01a1.cpp	Mon Jun 08 13:57:32 2015 +0200
+++ b/x_nucleo_iks01a1.cpp	Mon Jun 08 15:36:36 2015 +0200
@@ -51,7 +51,8 @@
 	ht_sensor(new HTS221(*dev_i2c)),
 	magnetometer(new LIS3MDL(*dev_i2c)),
 	pressure_sensor(new LPS25H(*dev_i2c)),
-	gyroscope(new LSM6DS0(*dev_i2c))
+	gyro_lsm6ds0(new LSM6DS0(*dev_i2c)),
+	gyro_lsm6ds3(new LSM6DS3(*dev_i2c))
 { 
 }
 
@@ -85,22 +86,10 @@
 }
 
 /**
- * @brief  Initialize the singelton's sensors to default settings
- * @return true if initialization successful, false otherwise
+ * @brief  Initialize the singleton's HT sensor
  * @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_HTS221(void) {
 	uint8_t ht_id = 0;
 	HUM_TEMP_InitTypeDef InitStructure;
@@ -126,8 +115,9 @@
 }
 
 /**
- * @brief  Initialize the singelton magnetometer
- * @return true if initialization successful, false otherwise
+ * @brief  Initialize the singleton's magnetometer
+ * @retval true if initialization successful, 
+ * @retval false otherwise
  */
 bool X_NUCLEO_IKS01A1::Init_LIS3MDL(void) {
 	uint8_t m_id = 0;
@@ -157,8 +147,9 @@
 }
 
 /**
- * @brief  Initialize the singelton pressure sensor
- * @return true if initialization successful, false otherwise
+ * @brief  Initialize the singleton's pressure sensor
+ * @retval true if initialization successful, 
+ * @retval false otherwise
  */
 bool X_NUCLEO_IKS01A1::Init_LPS25H(void) {
 	uint8_t p_id = 0;
@@ -190,19 +181,21 @@
 }
 
 /**
- * @brief  Initialize the singelton gyroscope
- * @return true if initialization successful, false otherwise
+ * @brief  Initialize the singleton's LSM6DS0 gyroscope
+ * @retval true if initialization successful, 
+ * @retval false otherwise
  */
 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) ||
+	if((gyro_lsm6ds3 != NULL) ||
+	   (gyro_lsm6ds0->ReadID(&xg_id) != IMU_6AXES_OK) ||
 	   (xg_id != I_AM_LSM6DS0_XG))
 		{
-			delete gyroscope;
-			gyroscope = NULL;
+			delete gyro_lsm6ds0;
+			gyro_lsm6ds0 = NULL;
 			return true;
 		}
             
@@ -219,10 +212,49 @@
 	InitStructure.X_Y_Axis          = 1;       /* Enable */
 	InitStructure.X_Z_Axis          = 1;       /* Enable */
               
-	if(gyroscope->Init(&InitStructure) != IMU_6AXES_OK)
+	if(gyro_lsm6ds0->Init(&InitStructure) != IMU_6AXES_OK)
 		{
 			return false; 
 		}
             
 	return true;
 }
+
+/**
+ * @brief  Initialize the singleton's LSMDS3 gyroscope
+ * @retval true if initialization successful, 
+ * @retval false otherwise
+ */
+bool X_NUCLEO_IKS01A1::Init_LSM6DS3(void) {
+	IMU_6AXES_InitTypeDef InitStructure;
+	uint8_t xg_id = 0;
+
+	/* Check presence */
+	if((gyro_lsm6ds3->ReadID(&xg_id) != IMU_6AXES_OK) ||
+	   (xg_id != I_AM_LSM6DS3_XG))
+		{
+			delete gyro_lsm6ds3;
+			gyro_lsm6ds3 = NULL;
+			return true;
+		}
+            
+	/* Configure sensor */
+	InitStructure.G_FullScale      = 2000.0f; /* 2000DPS */
+	InitStructure.G_OutputDataRate = 104.0f;  /* 104HZ */
+	InitStructure.G_X_Axis         = 1;       /* Enable */
+	InitStructure.G_Y_Axis         = 1;       /* Enable */
+	InitStructure.G_Z_Axis         = 1;       /* Enable */
+        
+	InitStructure.X_FullScale      = 2.0f;    /* 2G */
+	InitStructure.X_OutputDataRate = 104.0f;  /* 104HZ */
+	InitStructure.X_X_Axis         = 1;       /* Enable */
+	InitStructure.X_Y_Axis         = 1;       /* Enable */
+	InitStructure.X_Z_Axis         = 1;       /* Enable */
+        
+	if(gyro_lsm6ds3->Init(&InitStructure) != IMU_6AXES_OK)
+		{
+			return false; 
+		}
+            
+	return true;
+}