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 088aa5839e0d -r 566f2c41dc1d x_nucleo_iks01a1.h
--- a/x_nucleo_iks01a1.h	Mon Apr 13 14:44:02 2015 +0200
+++ b/x_nucleo_iks01a1.h	Tue Apr 14 15:32:06 2015 +0200
@@ -45,13 +45,15 @@
 #include "x_nucleo_iks01a1_targets.h"
 #include "DevI2C.h"
 #include "Common/HumTemp.h"
+#if 0 // betzw: TODO
 #include "Common/Pressure.h"
 #include "Common/Magneto.h"
 #include "Common/Imu6Axis.h"
+#endif 
 
 /* Classes -------------------------------------------------------------------*/
-/** Class X_NUCLEO_IKS01A1 is intended to represent the <TODO>
- *  expansion board with the same name.
+/** Class X_NUCLEO_IKS01A1 is intended to represent the MEMS Inertial & Environmental 
+ *  Nucleo Expansion Board with the same name.
  *
  *  The expansion board is featuring basically four IPs:\n
  *  -# a HTS221 Relative Humidity and Temperature Sensor\n
@@ -79,9 +81,11 @@
 	DevI2C *dev_i2c;
 
 	HumTemp &ht_sensor;
+#if 0 // betzw: TODO
 	Pressure &pressure_sensor;
 	Magneto &magnetometer;
 	Imu6Axis &gyroscope;
+#endif // 0
 
  private:
 	static X_NUCLEO_IKS01A1 *_instance;