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 IKS01A3 ... 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:
- a HTS221 Relative Humidity and Temperature Sensor,
- a LIS2MDL 3-Axis Magnetometer
- a LIS2DW12 3-Axis Accelerometer
- a LPS22HH MEMS Pressure and Temperature Sensor
- a LSM6DSO 3-Axis Accelerometer and 3-Axis Gyroscope
- 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
- Hello World
- 6D Orientation Recognition with LIS2DW12
- 6D Orientation Recognition with LSM6DSO
- Free Fall Event with LSM6DSO
- Pedometer with LSM6DSO
- Single and Double Tap Events with LSM6DSO
- Temperature Limit with STTS751
- Tilt Event with LSM6DSO
- Wake Up Event with LIS2DW12
- Wake Up Event with LSM6DSO
x_nucleo_iks01a3_targets.h@14:aea924ef2645, 2020-10-29 (annotated)
- Committer:
- cparata
- Date:
- Thu Oct 29 14:01:33 2020 +0000
- Revision:
- 14:aea924ef2645
- Parent:
- 5:463962d6f485
Update LSM6DSO library
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
cparata | 0:cbbff52ff25a | 1 | /** |
cparata | 0:cbbff52ff25a | 2 | ****************************************************************************** |
cparata | 0:cbbff52ff25a | 3 | * @file x_nucleo_iks01a3_targets.h |
cparata | 0:cbbff52ff25a | 4 | * @author SRA |
cparata | 0:cbbff52ff25a | 5 | * @version V1.0.0 |
cparata | 0:cbbff52ff25a | 6 | * @date 5-March-2019 |
cparata | 5:463962d6f485 | 7 | * @brief This header file is intended to manage the differences between |
cparata | 0:cbbff52ff25a | 8 | * the different supported base-boards which might mount the |
cparata | 0:cbbff52ff25a | 9 | * X_NUCLEO_IKS01A3 MEMS Inertial & Environmental Nucleo Expansion Board. |
cparata | 0:cbbff52ff25a | 10 | ****************************************************************************** |
cparata | 0:cbbff52ff25a | 11 | * @attention |
cparata | 0:cbbff52ff25a | 12 | * |
cparata | 0:cbbff52ff25a | 13 | * <h2><center>© COPYRIGHT(c) 2019 STMicroelectronics</center></h2> |
cparata | 0:cbbff52ff25a | 14 | * |
cparata | 0:cbbff52ff25a | 15 | * Redistribution and use in source and binary forms, with or without modification, |
cparata | 0:cbbff52ff25a | 16 | * are permitted provided that the following conditions are met: |
cparata | 0:cbbff52ff25a | 17 | * 1. Redistributions of source code must retain the above copyright notice, |
cparata | 0:cbbff52ff25a | 18 | * this list of conditions and the following disclaimer. |
cparata | 0:cbbff52ff25a | 19 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
cparata | 0:cbbff52ff25a | 20 | * this list of conditions and the following disclaimer in the documentation |
cparata | 0:cbbff52ff25a | 21 | * and/or other materials provided with the distribution. |
cparata | 0:cbbff52ff25a | 22 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
cparata | 0:cbbff52ff25a | 23 | * may be used to endorse or promote products derived from this software |
cparata | 0:cbbff52ff25a | 24 | * without specific prior written permission. |
cparata | 0:cbbff52ff25a | 25 | * |
cparata | 0:cbbff52ff25a | 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
cparata | 0:cbbff52ff25a | 27 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
cparata | 0:cbbff52ff25a | 28 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
cparata | 0:cbbff52ff25a | 29 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
cparata | 0:cbbff52ff25a | 30 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
cparata | 0:cbbff52ff25a | 31 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
cparata | 0:cbbff52ff25a | 32 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
cparata | 0:cbbff52ff25a | 33 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
cparata | 0:cbbff52ff25a | 34 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
cparata | 0:cbbff52ff25a | 35 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
cparata | 0:cbbff52ff25a | 36 | * |
cparata | 0:cbbff52ff25a | 37 | ****************************************************************************** |
cparata | 5:463962d6f485 | 38 | */ |
cparata | 0:cbbff52ff25a | 39 | |
cparata | 0:cbbff52ff25a | 40 | /* Define to prevent from recursive inclusion --------------------------------*/ |
cparata | 0:cbbff52ff25a | 41 | #ifndef _X_NUCLEO_IKS01A3_TARGETS_H_ |
cparata | 0:cbbff52ff25a | 42 | #define _X_NUCLEO_IKS01A3_TARGETS_H_ |
cparata | 0:cbbff52ff25a | 43 | |
cparata | 0:cbbff52ff25a | 44 | /*** I2C ***/ |
cparata | 0:cbbff52ff25a | 45 | /* Use Arduino I2C Connectors */ |
cparata | 0:cbbff52ff25a | 46 | #define IKS01A3_PIN_I2C_SDA (D14) |
cparata | 0:cbbff52ff25a | 47 | #define IKS01A3_PIN_I2C_SCL (D15) |
cparata | 0:cbbff52ff25a | 48 | |
cparata | 0:cbbff52ff25a | 49 | /* LSM6DSO INT1 */ |
cparata | 0:cbbff52ff25a | 50 | #define IKS01A3_PIN_LSM6DSO_INT1 (D4) |
cparata | 0:cbbff52ff25a | 51 | /* LSM6DSO INT2 */ |
cparata | 0:cbbff52ff25a | 52 | #define IKS01A3_PIN_LSM6DSO_INT2 (D5) |
cparata | 0:cbbff52ff25a | 53 | /* LIS2DW12 INT1 */ |
cparata | 0:cbbff52ff25a | 54 | #define IKS01A3_PIN_LIS2DW12_INT1 (A3) |
cparata | 0:cbbff52ff25a | 55 | /* LPS22HH INT */ |
cparata | 0:cbbff52ff25a | 56 | #define IKS01A3_PIN_LPS22HH_INT (D6) |
cparata | 0:cbbff52ff25a | 57 | /* STTS751 INT */ |
cparata | 0:cbbff52ff25a | 58 | #define IKS01A3_PIN_STTS751_INT (A4) |
cparata | 0:cbbff52ff25a | 59 | |
cparata | 0:cbbff52ff25a | 60 | #endif // _X_NUCLEO_IKS01A3_TARGETS_H_ |