Firmware Library for X-NUCLEO-IKS01A2 (MEMS Inertial & Environmental Sensors) Expansion Board
Dependencies: LPS22HB LSM6DSL LSM303AGR HTS221
Dependents: Giroscopio_main HelloWorld_IKS01A2 DuckieTownCar HelloWorld_IKS01A2 ... more
Fork of X_NUCLEO_IKS01A2 by
X-NUCLEO-IKS01A2 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-IKS01A2
MEMS Inertial & Environmental Sensors Nucleo Expansion Board.
Firmware Library
Class X_NUCLEO_IKS01A2 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 LSM303AGR 3-Axis Magnetometer and 3-Axis Accelerometer
- a LPS22HB MEMS Pressure and Temperature Sensor
- a LSM6DSL 3-Axis Accelerometer and 3-Axis 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_IKS01A2 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_IKS01A2 *mems_expansion_board = X_NUCLEO_IKS01A2::instance(D14, D15, D4, D5);
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
- Free Fall Event
- Multi Event
- Pedometer
- Single and Double Tap Events
- Tilt Event
- Wake Up Event
x_nucleo_iks01a2_targets.h@0:cad5dab2b21d, 2016-11-28 (annotated)
- Committer:
- nikapov
- Date:
- Mon Nov 28 13:16:22 2016 +0000
- Revision:
- 0:cad5dab2b21d
- Child:
- 1:bd2a01e81e6f
X_NUCLEO_IKS01A2 lib created.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
nikapov | 0:cad5dab2b21d | 1 | /** |
nikapov | 0:cad5dab2b21d | 2 | ****************************************************************************** |
nikapov | 0:cad5dab2b21d | 3 | * @file x_nucleo_iks01a2_targets.h |
nikapov | 0:cad5dab2b21d | 4 | * @author AST / EST |
nikapov | 0:cad5dab2b21d | 5 | * @version V0.0.1 |
nikapov | 0:cad5dab2b21d | 6 | * @date 9-August-2016 |
nikapov | 0:cad5dab2b21d | 7 | * @brief This header file is intended to manage the differences between |
nikapov | 0:cad5dab2b21d | 8 | * the different supported base-boards which might mount the |
nikapov | 0:cad5dab2b21d | 9 | * X_NUCLEO_IKS01A2 MEMS Inertial & Environmental Nucleo Expansion Board. |
nikapov | 0:cad5dab2b21d | 10 | ****************************************************************************** |
nikapov | 0:cad5dab2b21d | 11 | * @attention |
nikapov | 0:cad5dab2b21d | 12 | * |
nikapov | 0:cad5dab2b21d | 13 | * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> |
nikapov | 0:cad5dab2b21d | 14 | * |
nikapov | 0:cad5dab2b21d | 15 | * Redistribution and use in source and binary forms, with or without modification, |
nikapov | 0:cad5dab2b21d | 16 | * are permitted provided that the following conditions are met: |
nikapov | 0:cad5dab2b21d | 17 | * 1. Redistributions of source code must retain the above copyright notice, |
nikapov | 0:cad5dab2b21d | 18 | * this list of conditions and the following disclaimer. |
nikapov | 0:cad5dab2b21d | 19 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
nikapov | 0:cad5dab2b21d | 20 | * this list of conditions and the following disclaimer in the documentation |
nikapov | 0:cad5dab2b21d | 21 | * and/or other materials provided with the distribution. |
nikapov | 0:cad5dab2b21d | 22 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
nikapov | 0:cad5dab2b21d | 23 | * may be used to endorse or promote products derived from this software |
nikapov | 0:cad5dab2b21d | 24 | * without specific prior written permission. |
nikapov | 0:cad5dab2b21d | 25 | * |
nikapov | 0:cad5dab2b21d | 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
nikapov | 0:cad5dab2b21d | 27 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
nikapov | 0:cad5dab2b21d | 28 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
nikapov | 0:cad5dab2b21d | 29 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
nikapov | 0:cad5dab2b21d | 30 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
nikapov | 0:cad5dab2b21d | 31 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
nikapov | 0:cad5dab2b21d | 32 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
nikapov | 0:cad5dab2b21d | 33 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
nikapov | 0:cad5dab2b21d | 34 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
nikapov | 0:cad5dab2b21d | 35 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
nikapov | 0:cad5dab2b21d | 36 | * |
nikapov | 0:cad5dab2b21d | 37 | ****************************************************************************** |
nikapov | 0:cad5dab2b21d | 38 | */ |
nikapov | 0:cad5dab2b21d | 39 | |
nikapov | 0:cad5dab2b21d | 40 | /* Define to prevent from recursive inclusion --------------------------------*/ |
nikapov | 0:cad5dab2b21d | 41 | #ifndef _X_NUCLEO_IKS01A2_TARGETS_H_ |
nikapov | 0:cad5dab2b21d | 42 | #define _X_NUCLEO_IKS01A2_TARGETS_H_ |
nikapov | 0:cad5dab2b21d | 43 | |
nikapov | 0:cad5dab2b21d | 44 | /*** I2C ***/ |
nikapov | 0:cad5dab2b21d | 45 | /* Use Arduino I2C Connectors */ |
nikapov | 0:cad5dab2b21d | 46 | #define IKS01A2_PIN_I2C_SDA (D14) |
nikapov | 0:cad5dab2b21d | 47 | #define IKS01A2_PIN_I2C_SCL (D15) |
nikapov | 0:cad5dab2b21d | 48 | |
nikapov | 0:cad5dab2b21d | 49 | /* LSM6DSL INT1 */ |
nikapov | 0:cad5dab2b21d | 50 | #define IKS01A2_PIN_LSM6DSL_INT1 (D4) |
nikapov | 0:cad5dab2b21d | 51 | /* LSM6DSL INT2 */ |
nikapov | 0:cad5dab2b21d | 52 | #define IKS01A2_PIN_LSM6DSL_INT2 (D5) |
nikapov | 0:cad5dab2b21d | 53 | |
nikapov | 0:cad5dab2b21d | 54 | #endif // _X_NUCLEO_IKS01A2_TARGETS_H_ |