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

x_nucleo_iks01a1.h@15:472cf58b9c11, 2015-05-27 (annotated)

Committer:
Wolfgang Betz
Date:
Wed May 27 11:56:24 2015 +0200
Revision:
15:472cf58b9c11
Parent:
8:d49db2c9d9c1
Child:
42:5490ac2d0a10
Refine board's component types

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 0:0feaa2a2d9ff 1 /**
Wolfgang Betz 0:0feaa2a2d9ff 2 ******************************************************************************
Wolfgang Betz 0:0feaa2a2d9ff 3 * @file x_nucleo_iks01a1.h
Wolfgang Betz 0:0feaa2a2d9ff 4 * @author AST / EST
Wolfgang Betz 0:0feaa2a2d9ff 5 * @version V0.0.1
Wolfgang Betz 0:0feaa2a2d9ff 6 * @date 13-April-2015
Wolfgang Betz 3:088aa5839e0d 7 * @brief Header file for class X_NUCLEO_IKS01A1 representing a X-NUCLEO-IKS01A1
Wolfgang Betz 0:0feaa2a2d9ff 8 * expansion board
Wolfgang Betz 0:0feaa2a2d9ff 9 ******************************************************************************
Wolfgang Betz 0:0feaa2a2d9ff 10 * @attention
Wolfgang Betz 0:0feaa2a2d9ff 11 *
Wolfgang Betz 3:088aa5839e0d 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 0:0feaa2a2d9ff 13 *
Wolfgang Betz 0:0feaa2a2d9ff 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 0:0feaa2a2d9ff 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 0:0feaa2a2d9ff 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 0:0feaa2a2d9ff 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 0:0feaa2a2d9ff 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 0:0feaa2a2d9ff 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 0:0feaa2a2d9ff 20 * and/or other materials provided with the distribution.
Wolfgang Betz 0:0feaa2a2d9ff 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 0:0feaa2a2d9ff 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 0:0feaa2a2d9ff 23 * without specific prior written permission.
Wolfgang Betz 0:0feaa2a2d9ff 24 *
Wolfgang Betz 0:0feaa2a2d9ff 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 0:0feaa2a2d9ff 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 0:0feaa2a2d9ff 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 0:0feaa2a2d9ff 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 0:0feaa2a2d9ff 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 0:0feaa2a2d9ff 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 0:0feaa2a2d9ff 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 0:0feaa2a2d9ff 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 0:0feaa2a2d9ff 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 0:0feaa2a2d9ff 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 0:0feaa2a2d9ff 35 *
Wolfgang Betz 0:0feaa2a2d9ff 36 ******************************************************************************
Wolfgang Betz 0:0feaa2a2d9ff 37 */
Wolfgang Betz 0:0feaa2a2d9ff 38
Wolfgang Betz 0:0feaa2a2d9ff 39 /* Define to prevent from recursive inclusion --------------------------------*/
Wolfgang Betz 0:0feaa2a2d9ff 40 #ifndef __X_NUCLEO_IKS01A1_H
Wolfgang Betz 0:0feaa2a2d9ff 41 #define __X_NUCLEO_IKS01A1_H
Wolfgang Betz 0:0feaa2a2d9ff 42
Wolfgang Betz 0:0feaa2a2d9ff 43 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 0:0feaa2a2d9ff 44 #include "mbed.h"
Wolfgang Betz 0:0feaa2a2d9ff 45 #include "x_nucleo_iks01a1_targets.h"
Wolfgang Betz 15:472cf58b9c11 46 #include "hts221/hts221_class.h"
Wolfgang Betz 15:472cf58b9c11 47 #include "lis3mdl/lis3mdl_class.h"
Wolfgang Betz 15:472cf58b9c11 48 #include "lps25h/lps25h_class.h"
Wolfgang Betz 15:472cf58b9c11 49 #include "lsm6ds0/lsm6ds0_class.h"
Wolfgang Betz 0:0feaa2a2d9ff 50 #include "DevI2C.h"
Wolfgang Betz 0:0feaa2a2d9ff 51
Wolfgang Betz 0:0feaa2a2d9ff 52 /* Classes -------------------------------------------------------------------*/
Wolfgang Betz 4:566f2c41dc1d 53 /** Class X_NUCLEO_IKS01A1 is intended to represent the MEMS Inertial & Environmental
Wolfgang Betz 4:566f2c41dc1d 54 * Nucleo Expansion Board with the same name.
Wolfgang Betz 0:0feaa2a2d9ff 55 *
Wolfgang Betz 3:088aa5839e0d 56 * The expansion board is featuring basically four IPs:\n
Wolfgang Betz 3:088aa5839e0d 57 * -# a HTS221 Relative Humidity and Temperature Sensor\n
Wolfgang Betz 3:088aa5839e0d 58 * -# a LIS3MDL 3-Axis Magnetometer\n
Wolfgang Betz 3:088aa5839e0d 59 * -# a LPS25H MEMS Pressure Sensor\n
Wolfgang Betz 3:088aa5839e0d 60 * -# and a LSM6DS0 3D Acceleromenter and 3D Gyroscope\n
Wolfgang Betz 0:0feaa2a2d9ff 61 *
Wolfgang Betz 0:0feaa2a2d9ff 62 * It is intentionally implemented as a singleton because only one
Wolfgang Betz 0:0feaa2a2d9ff 63 * X_NUCLEO_IKS01A1 at a time might be deployed in a HW component stack.\n
Wolfgang Betz 0:0feaa2a2d9ff 64 * In order to get the singleton instance you have to call class method `Instance()`,
Wolfgang Betz 0:0feaa2a2d9ff 65 * e.g.:
Wolfgang Betz 0:0feaa2a2d9ff 66 * @code
Wolfgang Betz 3:088aa5839e0d 67 * // Inertial & Environmental expansion board singleton instance
Wolfgang Betz 0:0feaa2a2d9ff 68 * static X_NUCLEO_IKS01A1 *<TODO>_expansion_board = X_NUCLEO_IKS01A1::Instance();
Wolfgang Betz 0:0feaa2a2d9ff 69 * @endcode
Wolfgang Betz 0:0feaa2a2d9ff 70 */
Wolfgang Betz 0:0feaa2a2d9ff 71 class X_NUCLEO_IKS01A1
Wolfgang Betz 0:0feaa2a2d9ff 72 {
Wolfgang Betz 0:0feaa2a2d9ff 73 protected:
Wolfgang Betz 0:0feaa2a2d9ff 74 X_NUCLEO_IKS01A1(DevI2C *ext_i2c);
Wolfgang Betz 0:0feaa2a2d9ff 75
Wolfgang Betz 8:d49db2c9d9c1 76 bool Init(void) {
Wolfgang Betz 8:d49db2c9d9c1 77 return (Init_HT() &&
Wolfgang Betz 8:d49db2c9d9c1 78 Init_MAG() &&
Wolfgang Betz 8:d49db2c9d9c1 79 Init_PRESS() &&
Wolfgang Betz 8:d49db2c9d9c1 80 Init_GYRO());
Wolfgang Betz 8:d49db2c9d9c1 81 }
Wolfgang Betz 8:d49db2c9d9c1 82
Wolfgang Betz 8:d49db2c9d9c1 83 bool Init_HT(void);
Wolfgang Betz 8:d49db2c9d9c1 84 bool Init_MAG(void);
Wolfgang Betz 8:d49db2c9d9c1 85 bool Init_PRESS(void);
Wolfgang Betz 8:d49db2c9d9c1 86 bool Init_GYRO(void);
Wolfgang Betz 8:d49db2c9d9c1 87
Wolfgang Betz 0:0feaa2a2d9ff 88 public:
Wolfgang Betz 0:0feaa2a2d9ff 89 static X_NUCLEO_IKS01A1* Instance(DevI2C *ext_i2c = NULL);
Wolfgang Betz 0:0feaa2a2d9ff 90
Wolfgang Betz 0:0feaa2a2d9ff 91 DevI2C *dev_i2c;
Wolfgang Betz 0:0feaa2a2d9ff 92
Wolfgang Betz 15:472cf58b9c11 93 HTS221 &ht_sensor;
Wolfgang Betz 15:472cf58b9c11 94 LIS3MDL &magnetometer;
Wolfgang Betz 15:472cf58b9c11 95 LPS25H &pressure_sensor;
Wolfgang Betz 15:472cf58b9c11 96 LSM6DS0 &gyroscope;
Wolfgang Betz 3:088aa5839e0d 97
Wolfgang Betz 0:0feaa2a2d9ff 98 private:
Wolfgang Betz 0:0feaa2a2d9ff 99 static X_NUCLEO_IKS01A1 *_instance;
Wolfgang Betz 0:0feaa2a2d9ff 100 };
Wolfgang Betz 0:0feaa2a2d9ff 101
Wolfgang Betz 0:0feaa2a2d9ff 102 #endif /* __X_NUCLEO_IKS01A1_H */