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

Committer:
Wolfgang Betz
Date:
Mon Apr 20 11:42:38 2015 +0200
Revision:
9:b989c9bc2f3e
Parent:
4:566f2c41dc1d
Child:
52:54553fd15b50
Make X_NUCLEO_IKS01A1 compatible with all Arduino base boards

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 4:566f2c41dc1d 1 /**
Wolfgang Betz 4:566f2c41dc1d 2 ******************************************************************************
Wolfgang Betz 4:566f2c41dc1d 3 * @file x_nucleo_iks01a1_targets.h
Wolfgang Betz 4:566f2c41dc1d 4 * @author AST / EST
Wolfgang Betz 4:566f2c41dc1d 5 * @version V0.0.1
Wolfgang Betz 4:566f2c41dc1d 6 * @date 14-April-2015
Wolfgang Betz 4:566f2c41dc1d 7 * @brief This header file is intended to manage the differences between
Wolfgang Betz 4:566f2c41dc1d 8 * the different supported base-boards which might mount the
Wolfgang Betz 4:566f2c41dc1d 9 * X_NUCLEO_IKS01A1 MEMS Inertial & Environmental Nucleo Expansion Board.
Wolfgang Betz 4:566f2c41dc1d 10 ******************************************************************************
Wolfgang Betz 4:566f2c41dc1d 11 * @attention
Wolfgang Betz 4:566f2c41dc1d 12 *
Wolfgang Betz 4:566f2c41dc1d 13 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 4:566f2c41dc1d 14 *
Wolfgang Betz 4:566f2c41dc1d 15 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 4:566f2c41dc1d 16 * are permitted provided that the following conditions are met:
Wolfgang Betz 4:566f2c41dc1d 17 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 4:566f2c41dc1d 18 * this list of conditions and the following disclaimer.
Wolfgang Betz 4:566f2c41dc1d 19 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 4:566f2c41dc1d 20 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 4:566f2c41dc1d 21 * and/or other materials provided with the distribution.
Wolfgang Betz 4:566f2c41dc1d 22 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 4:566f2c41dc1d 23 * may be used to endorse or promote products derived from this software
Wolfgang Betz 4:566f2c41dc1d 24 * without specific prior written permission.
Wolfgang Betz 4:566f2c41dc1d 25 *
Wolfgang Betz 4:566f2c41dc1d 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 4:566f2c41dc1d 27 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 4:566f2c41dc1d 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 4:566f2c41dc1d 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 4:566f2c41dc1d 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 4:566f2c41dc1d 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 4:566f2c41dc1d 32 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 4:566f2c41dc1d 33 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 4:566f2c41dc1d 34 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 4:566f2c41dc1d 35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 4:566f2c41dc1d 36 *
Wolfgang Betz 4:566f2c41dc1d 37 ******************************************************************************
Wolfgang Betz 4:566f2c41dc1d 38 */
Wolfgang Betz 4:566f2c41dc1d 39
Wolfgang Betz 4:566f2c41dc1d 40 /* Define to prevent from recursive inclusion --------------------------------*/
Wolfgang Betz 4:566f2c41dc1d 41 #ifndef _X_NUCLEO_IKS01A1_TARGETS_H_
Wolfgang Betz 4:566f2c41dc1d 42 #define _X_NUCLEO_IKS01A1_TARGETS_H_
Wolfgang Betz 4:566f2c41dc1d 43
Wolfgang Betz 4:566f2c41dc1d 44 /*** I2C ***/
Wolfgang Betz 9:b989c9bc2f3e 45 /* Use Arduino I2C Connectors */
Wolfgang Betz 4:566f2c41dc1d 46 #define IKS01A1_PIN_I2C_SCL (D15)
Wolfgang Betz 4:566f2c41dc1d 47 #define IKS01A1_PIN_I2C_SDA (D14)
Wolfgang Betz 4:566f2c41dc1d 48
Wolfgang Betz 4:566f2c41dc1d 49 #endif // _X_NUCLEO_IKS01A1_TARGETS_H_