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: Components/lis3mdl/lis3mdl.h

Revision:: 3:088aa5839e0d

diff -r 5f95b745eedb -r 088aa5839e0d Components/lis3mdl/lis3mdl.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Components/lis3mdl/lis3mdl.h	Mon Apr 13 14:44:02 2015 +0200
@@ -0,0 +1,78 @@
+/**
+******************************************************************************
+* @file    x_cube_mems_lis3mdl.h
+* @author  AST / EST
+* @version V0.0.1
+* @date    9-December-2014
+* @brief   Header file for component LIS3MDL
+******************************************************************************
+* @attention
+*
+* <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
+*
+* Redistribution and use in source and binary forms, with or without modification,
+* are permitted provided that the following conditions are met:
+*   1. Redistributions of source code must retain the above copyright notice,
+*      this list of conditions and the following disclaimer.
+*   2. Redistributions in binary form must reproduce the above copyright notice,
+*      this list of conditions and the following disclaimer in the documentation
+*      and/or other materials provided with the distribution.
+*   3. Neither the name of STMicroelectronics nor the names of its contributors
+*      may be used to endorse or promote products derived from this software
+*      without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*
+******************************************************************************
+*/
+
+#ifndef __X_CUBE_MEMS_LIS3MDL_H
+#define __X_CUBE_MEMS_LIS3MDL_H
+
+/* Includes ------------------------------------------------------------------*/
+#include "mbed.h"
+#include "x_cube_mems_i2c.h"
+
+
+/* Classes -------------------------------------------------------------------*/
+/** Class representing a HTS221 sensor component
+ */
+class LIS3MDL
+{
+public:
+    /** Constructor
+     * @param 
+     */
+    LIS3MDL(DevI2C &i2c) : dev_i2c(i2c) {
+        LIS3MDLInitialized = 0;
+        Init();
+    };
+
+    void GetAxes(AxesRaw_TypeDef *pData);
+    void GetAxesRaw(int16_t *pData);
+    void    Init(/*HUM_TEMP_InitTypeDef *HTS221_Init*/);
+    uint8_t   ReadID(void);
+    void      RebootCmd(void);
+
+private:
+    
+    uint8_t isInitialized(void)
+    {
+        return LIS3MDLInitialized;
+    }
+    
+    DevI2C &dev_i2c;
+    uint8_t LIS3MDLInitialized;
+};
+
+#endif // __X_CUBE_MEMS_LIS3MDL_H
+