ST » Code » 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:

a HTS221 Relative Humidity and Temperature Sensor,
a LIS3MDL 3-Axis Magnetometer,
a LPS25H MEMS Pressure Sensor, and
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.h

Revision:: 3:088aa5839e0d
Parent:: 0:0feaa2a2d9ff
Child:: 4:566f2c41dc1d

diff -r 5f95b745eedb -r 088aa5839e0d x_nucleo_iks01a1.h
--- a/x_nucleo_iks01a1.h	Mon Apr 13 11:49:53 2015 +0200
+++ b/x_nucleo_iks01a1.h	Mon Apr 13 14:44:02 2015 +0200
@@ -4,12 +4,12 @@
  * @author  AST / EST
  * @version V0.0.1
  * @date    13-April-2015
- * @brief   Header file for class X_NUCLEO_IKS01A1 representing an X-NUCLEO-IKS01A1
+ * @brief   Header file for class X_NUCLEO_IKS01A1 representing a X-NUCLEO-IKS01A1
  *          expansion board
  ******************************************************************************
  * @attention
  *
- * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
+ * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
  *
  * Redistribution and use in source and binary forms, with or without modification,
  * are permitted provided that the following conditions are met:
@@ -44,20 +44,27 @@
 #include "mbed.h"
 #include "x_nucleo_iks01a1_targets.h"
 #include "DevI2C.h"
+#include "Common/HumTemp.h"
+#include "Common/Pressure.h"
+#include "Common/Magneto.h"
+#include "Common/Imu6Axis.h"
 
 /* Classes -------------------------------------------------------------------*/
 /** Class X_NUCLEO_IKS01A1 is intended to represent the <TODO>
  *  expansion board with the same name.
  *
- *  The expansion board is featuring basically <TODO> IPs:\n
- *  -# <TODO>\n
+ *  The expansion board is featuring basically four IPs:\n
+ *  -# a HTS221 Relative Humidity and Temperature Sensor\n
+ *  -# a LIS3MDL 3-Axis Magnetometer\n
+ *  -# a LPS25H MEMS Pressure Sensor\n
+ *  -# and a LSM6DS0 3D Acceleromenter and 3D Gyroscope\n
  *
  * It is intentionally implemented as a singleton because only one
  * X_NUCLEO_IKS01A1 at a time might be deployed in a HW component stack.\n
  * In order to get the singleton instance you have to call class method `Instance()`, 
  * e.g.:
  * @code
- * // Battery expansion board singleton instance
+ * // Inertial & Environmental expansion board singleton instance
  * static X_NUCLEO_IKS01A1 *<TODO>_expansion_board = X_NUCLEO_IKS01A1::Instance();
  * @endcode
  */
@@ -71,6 +78,11 @@
 
 	DevI2C *dev_i2c;
 
+	HumTemp &ht_sensor;
+	Pressure &pressure_sensor;
+	Magneto &magnetometer;
+	Imu6Axis &gyroscope;
+
  private:
 	static X_NUCLEO_IKS01A1 *_instance;
 };