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.cpp@5:8bab0f419849, 2015-04-15 (annotated)

Committer:
Wolfgang Betz
Date:
Wed Apr 15 12:10:42 2015 +0200
Revision:
5:8bab0f419849
Parent:
4:566f2c41dc1d
Child:
6:8d2abd695c52
Added component LIS3MDL

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 3:088aa5839e0d 1 /**
Wolfgang Betz 4:566f2c41dc1d 2 ******************************************************************************
Wolfgang Betz 4:566f2c41dc1d 3 * @file x_nucleo_iks01a1.cpp
Wolfgang Betz 4:566f2c41dc1d 4 * @author AST / EST
Wolfgang Betz 4:566f2c41dc1d 5 * @version V0.0.1
Wolfgang Betz 4:566f2c41dc1d 6 * @date 08-October-2014
Wolfgang Betz 4:566f2c41dc1d 7 * @brief Implementation file for the X_NUCLEO_IKS01A1 singleton class
Wolfgang Betz 4:566f2c41dc1d 8 ******************************************************************************
Wolfgang Betz 4:566f2c41dc1d 9 * @attention
Wolfgang Betz 4:566f2c41dc1d 10 *
Wolfgang Betz 4:566f2c41dc1d 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
Wolfgang Betz 4:566f2c41dc1d 12 *
Wolfgang Betz 4:566f2c41dc1d 13 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 4:566f2c41dc1d 14 * are permitted provided that the following conditions are met:
Wolfgang Betz 4:566f2c41dc1d 15 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 4:566f2c41dc1d 16 * this list of conditions and the following disclaimer.
Wolfgang Betz 4:566f2c41dc1d 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 4:566f2c41dc1d 18 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 4:566f2c41dc1d 19 * and/or other materials provided with the distribution.
Wolfgang Betz 4:566f2c41dc1d 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 4:566f2c41dc1d 21 * may be used to endorse or promote products derived from this software
Wolfgang Betz 4:566f2c41dc1d 22 * without specific prior written permission.
Wolfgang Betz 4:566f2c41dc1d 23 *
Wolfgang Betz 4:566f2c41dc1d 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 4:566f2c41dc1d 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 4:566f2c41dc1d 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 4:566f2c41dc1d 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 4:566f2c41dc1d 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 4:566f2c41dc1d 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 4:566f2c41dc1d 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 4:566f2c41dc1d 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 4:566f2c41dc1d 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 4:566f2c41dc1d 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 4:566f2c41dc1d 34 *
Wolfgang Betz 4:566f2c41dc1d 35 ******************************************************************************
Wolfgang Betz 3:088aa5839e0d 36 */
Wolfgang Betz 3:088aa5839e0d 37
Wolfgang Betz 3:088aa5839e0d 38 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 3:088aa5839e0d 39 #include "mbed.h"
Wolfgang Betz 3:088aa5839e0d 40 #include "x_nucleo_iks01a1.h"
Wolfgang Betz 4:566f2c41dc1d 41 #include "hts221/hts221_class.h"
Wolfgang Betz 5:8bab0f419849 42 #include "lis3mdl/lis3mdl_class.h"
Wolfgang Betz 3:088aa5839e0d 43
Wolfgang Betz 3:088aa5839e0d 44 /* Static variables ----------------------------------------------------------*/
Wolfgang Betz 3:088aa5839e0d 45 X_NUCLEO_IKS01A1* X_NUCLEO_IKS01A1::_instance = NULL;
Wolfgang Betz 3:088aa5839e0d 46
Wolfgang Betz 4:566f2c41dc1d 47
Wolfgang Betz 3:088aa5839e0d 48 /* Methods -------------------------------------------------------------------*/
Wolfgang Betz 3:088aa5839e0d 49 /**
Wolfgang Betz 3:088aa5839e0d 50 * @brief Constructor
Wolfgang Betz 3:088aa5839e0d 51 */
Wolfgang Betz 3:088aa5839e0d 52 X_NUCLEO_IKS01A1::X_NUCLEO_IKS01A1(DevI2C *ext_i2c) : dev_i2c(ext_i2c),
Wolfgang Betz 5:8bab0f419849 53 ht_sensor(*(new HTS221(*dev_i2c))),
Wolfgang Betz 5:8bab0f419849 54 magnetometer(*(new LIS3MDL(*dev_i2c)))
Wolfgang Betz 4:566f2c41dc1d 55 #if 0 // betzw: TODO
Wolfgang Betz 3:088aa5839e0d 56 lps25h(*dev_i2c),
Wolfgang Betz 3:088aa5839e0d 57 lsm6ds0(*dev_i2c)
Wolfgang Betz 4:566f2c41dc1d 58 #endif // 0
Wolfgang Betz 3:088aa5839e0d 59 {
Wolfgang Betz 3:088aa5839e0d 60 }
Wolfgang Betz 3:088aa5839e0d 61
Wolfgang Betz 3:088aa5839e0d 62 /**
Wolfgang Betz 3:088aa5839e0d 63 * @brief Get singleton instance
Wolfgang Betz 3:088aa5839e0d 64 * @return a pointer to the singleton instance of class X_NUCLEO_IKS01A1
Wolfgang Betz 3:088aa5839e0d 65 * @param (optional) ext_i2c pointer to instance of DevI2C to be used
Wolfgang Betz 3:088aa5839e0d 66 * for communication on the expansion board.
Wolfgang Betz 3:088aa5839e0d 67 * Taken into account only on the very first call of this function.
Wolfgang Betz 3:088aa5839e0d 68 * If not provided a new DevI2C will be created with standard
Wolfgang Betz 3:088aa5839e0d 69 * configuration parameters.
Wolfgang Betz 3:088aa5839e0d 70 * The used DevI2C object gets saved in instance variable dev_i2c.
Wolfgang Betz 3:088aa5839e0d 71 */
Wolfgang Betz 3:088aa5839e0d 72 X_NUCLEO_IKS01A1* X_NUCLEO_IKS01A1::Instance(DevI2C *ext_i2c) {
Wolfgang Betz 3:088aa5839e0d 73 if(_instance == NULL) {
Wolfgang Betz 3:088aa5839e0d 74 if(ext_i2c == NULL)
Wolfgang Betz 3:088aa5839e0d 75 ext_i2c = new DevI2C(IKS01A1_PIN_I2C_SDA, IKS01A1_PIN_I2C_SCL);
Wolfgang Betz 3:088aa5839e0d 76 _instance = new X_NUCLEO_IKS01A1(ext_i2c);
Wolfgang Betz 3:088aa5839e0d 77 }
Wolfgang Betz 3:088aa5839e0d 78 return _instance;
Wolfgang Betz 3:088aa5839e0d 79 }