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/Components/lsm6ds3/lsm6ds3_class.h	Mon Jun 08 18:04:19 2015 +0200
+++ b/Components/lsm6ds3/lsm6ds3_class.h	Wed Jun 10 16:44:54 2015 +0200
@@ -53,7 +53,8 @@
 	/** Constructor
 	 * @param i2c device I2C to be used for communication
 	 */
-        LSM6DS3(DevI2C &i2c) : GyroSensor(), MotionSensor(), dev_i2c(i2c) {
+        LSM6DS3(DevI2C &i2c, PinName irq_pin) : GyroSensor(), MotionSensor(), 
+		dev_i2c(i2c), free_fall(irq_pin) {
 	}
 	
 	/** Destructor
@@ -137,6 +138,27 @@
 	IMU_6AXES_StatusTypeDef Get_Status_Free_Fall_Detection(uint8_t *status) {
 		return LSM6DS3_Get_Status_Free_Fall_Detection(status);
 	}
+	
+	/** Attach a function to call when a free fall is detected
+	 *
+	 *  @param fptr A pointer to a void function, or 0 to set as none
+	 */
+	void Attach_Free_Fall_Detection_IRQ(void (*fptr)(void)) {
+		free_fall.mode(PullNone); /* be precise about pin mode */
+		free_fall.rise(fptr);
+	}
+
+	/** Enable Free Fall IRQ
+	 */
+	void Enable_Free_Fall_Detection_IRQ(void) {
+		free_fall.enable_irq();
+	}
+
+	/** Disable free Fall IRQ
+	 */
+	void Disable_Free_Fall_Detection_IRQ(void) {
+		free_fall.disable_irq();
+	}
 
  protected:
 	/*** Methods ***/
@@ -171,7 +193,7 @@
 	 */
 	void LSM6DS3_IO_ITConfig(void)
 	{
-		/* To be implemented */
+		/* done in constructor */
 	}
 
 	/**
@@ -227,6 +249,9 @@
 	/*** Instance Variables ***/
 	/* IO Device */
 	DevI2C &dev_i2c;
+
+	/* Free Fall Detection IRQ */
+	InterruptIn free_fall;
 };
 
 #endif // __LSM6DS3_CLASS_H