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
Diff: XNucleoIKS01A3.h
- Revision:
- 5:463962d6f485
- Parent:
- 0:cbbff52ff25a
diff -r 40a48140855d -r 463962d6f485 XNucleoIKS01A3.h --- a/XNucleoIKS01A3.h Mon Jun 03 09:25:14 2019 +0000 +++ b/XNucleoIKS01A3.h Wed Jul 24 14:20:51 2019 +0000 @@ -58,7 +58,7 @@ ) /* Classes -------------------------------------------------------------------*/ -/** Class XNucleoIKS01A3 is intended to represent the MEMS Inertial & Environmental +/** Class XNucleoIKS01A3 is intended to represent the MEMS Inertial & Environmental * Nucleo Expansion Board with the same name. * * The expansion board is featuring basically four IPs:\n @@ -70,30 +70,30 @@ * -# and a LSM6DSO 3D Acceleromenter and 3D Gyroscope\n * * 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). + * 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.\n - * In order to get the singleton instance you have to call class method `Instance()`, + * In order to get the singleton instance you have to call class method `Instance()`, * e.g.: * @code * // Inertial & Environmental expansion board singleton instance * static X_NUCLEO_IKS01A3 *<TODO>_expansion_board = X_NUCLEO_IKS01A3::Instance(); * @endcode */ -class XNucleoIKS01A3 -{ - protected: +class XNucleoIKS01A3 { +protected: XNucleoIKS01A3(DevI2C *ext_i2c, PinName lsm6dso_int1, PinName lsm6dso_int2, PinName lis2dw12_int1, PinName lps22hh_int, PinName stts751_int); - ~XNucleoIKS01A3(void) { + ~XNucleoIKS01A3(void) + { /* should never be called */ error("Trial to delete XNucleoIKS01A3 singleton!\n"); } - public: - static XNucleoIKS01A3* instance(DevI2C *ext_i2c = NULL, PinName lsm6dso_int1 = IKS01A3_PIN_LSM6DSO_INT1, PinName lsm6dso_int2 = IKS01A3_PIN_LSM6DSO_INT2, PinName lis2dw12_int1 = IKS01A3_PIN_LIS2DW12_INT1, PinName lps22hh_int = IKS01A3_PIN_LPS22HH_INT, PinName stts751_int = IKS01A3_PIN_STTS751_INT); - static XNucleoIKS01A3* instance(PinName sda, PinName scl, PinName lsm6dso_int1 = IKS01A3_PIN_LSM6DSO_INT1, PinName lsm6dso_int2 = IKS01A3_PIN_LSM6DSO_INT2, PinName lis2dw12_int1 = IKS01A3_PIN_LIS2DW12_INT1, PinName lps22hh_int = IKS01A3_PIN_LPS22HH_INT, PinName stts751_int = IKS01A3_PIN_STTS751_INT); +public: + static XNucleoIKS01A3 *instance(DevI2C *ext_i2c = NULL, PinName lsm6dso_int1 = IKS01A3_PIN_LSM6DSO_INT1, PinName lsm6dso_int2 = IKS01A3_PIN_LSM6DSO_INT2, PinName lis2dw12_int1 = IKS01A3_PIN_LIS2DW12_INT1, PinName lps22hh_int = IKS01A3_PIN_LPS22HH_INT, PinName stts751_int = IKS01A3_PIN_STTS751_INT); + static XNucleoIKS01A3 *instance(PinName sda, PinName scl, PinName lsm6dso_int1 = IKS01A3_PIN_LSM6DSO_INT1, PinName lsm6dso_int2 = IKS01A3_PIN_LSM6DSO_INT2, PinName lis2dw12_int1 = IKS01A3_PIN_LIS2DW12_INT1, PinName lps22hh_int = IKS01A3_PIN_LPS22HH_INT, PinName stts751_int = IKS01A3_PIN_STTS751_INT); DevI2C *dev_i2c; @@ -104,7 +104,7 @@ LSM6DSOSensor *acc_gyro; STTS751Sensor *t_sensor; - private: +private: static XNucleoIKS01A3 *_instance; };