Firmware Library for X-NUCLEO-IKS01A3 (MEMS Inertial & Environmental Sensors) Expansion Board

Dependencies:   STTS751 LPS22HH LIS2MDL HTS221 LIS2DW12 LSM6DSO

Dependents:   ELEC35XR-2019 ELEC35XR-2019_SEM calculate PMK2020_6DOrientation_LIS2DW12_IKS01A3_full_os ... more

X-NUCLEO-IKS01A3 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-IKS01A3 MEMS Inertial & Environmental Sensors Nucleo Expansion Board.

Firmware Library

Class X_NUCLEO_IKS01A3 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 LIS2MDL 3-Axis Magnetometer
  3. a LIS2DW12 3-Axis Accelerometer
  4. a LPS22HH MEMS Pressure and Temperature Sensor
  5. a LSM6DSO 3-Axis Accelerometer and 3-Axis Gyroscope
  6. a STTS751 MEMS Temperature Sensor

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_IKS01A3 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 XNucleoIKS01A3 *mems_expansion_board = XNucleoIKS01A3::instance(D14, D15, D4, D5, A3, D6, A4);


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_iks01a3_targets.h

Committer:
cparata
Date:
2 months ago
Revision:
6:8f4fffc54c3d
Parent:
5:463962d6f485

File content as of revision 6:8f4fffc54c3d:

/**
  ******************************************************************************
  * @file    x_nucleo_iks01a3_targets.h
  * @author  SRA
  * @version V1.0.0
  * @date    5-March-2019
  * @brief   This header file is intended to manage the differences between
  *          the different supported base-boards which might mount the
  *          X_NUCLEO_IKS01A3 MEMS Inertial & Environmental Nucleo Expansion Board.
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; COPYRIGHT(c) 2019 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.
  *
  ******************************************************************************
  */

/* Define to prevent from recursive inclusion --------------------------------*/
#ifndef _X_NUCLEO_IKS01A3_TARGETS_H_
#define _X_NUCLEO_IKS01A3_TARGETS_H_

/*** I2C ***/
/* Use Arduino I2C Connectors */
#define IKS01A3_PIN_I2C_SDA         (D14)
#define IKS01A3_PIN_I2C_SCL         (D15)

/* LSM6DSO INT1 */
#define IKS01A3_PIN_LSM6DSO_INT1     (D4)
/* LSM6DSO INT2 */
#define IKS01A3_PIN_LSM6DSO_INT2     (D5)
/* LIS2DW12 INT1 */
#define IKS01A3_PIN_LIS2DW12_INT1    (A3)
/* LPS22HH INT */
#define IKS01A3_PIN_LPS22HH_INT      (D6)
/* STTS751 INT */
#define IKS01A3_PIN_STTS751_INT      (A4)

#endif // _X_NUCLEO_IKS01A3_TARGETS_H_