Cyrill Zoller / X_NUCLEO_IKS01A3

..

Dependencies:   STTS751 LPS22HH LIS2MDL HTS221 LIS2DW12 LSM6DSO

Embed: (wiki syntax)

« Back to documentation index

XNucleoIKS01A3 Class Reference
Static Public Member Functions | Protected Member Functions

XNucleoIKS01A3 Class Reference

Class XNucleoIKS01A3 is intended to represent the MEMS Inertial & Environmental Nucleo Expansion Board with the same name. More...

#include <XNucleoIKS01A3.h>

Static Public Member Functions

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)
 Get singleton instance.
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)
 Get singleton instance.

Protected Member Functions

 XNucleoIKS01A3 (DevI2C *ext_i2c, PinName lsm6dso_int1, PinName lsm6dso_int2, PinName lis2dw12_int1, PinName lps22hh_int, PinName stts751_int)
 Constructor.

Detailed Description

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:

  1. a HTS221 Relative Humidity and Temperature Sensor
  2. a LPS22HH MEMS Pressure Sensor (and Temperature Sensor)
  3. a STTS751 MEMS Temperature Sensor
  4. a LIS2DW12 3D Acceleromenter
  5. a LIS2MDL 3D Magnetometer
  6. and a LSM6DSO 3D Acceleromenter 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_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.: 

 // Inertial & Environmental expansion board singleton instance
 static X_NUCLEO_IKS01A3 *<TODO>_expansion_board = X_NUCLEO_IKS01A3::Instance();

Definition at line 84 of file XNucleoIKS01A3.h.

Constructor & Destructor Documentation

XNucleoIKS01A3 ( DevI2C *  ext_i2c,
PinName  lsm6dso_int1,
PinName  lsm6dso_int2,
PinName  lis2dw12_int1,
PinName  lps22hh_int,
PinName  stts751_int 
) [protected]

Constructor.

Definition at line 50 of file XNucleoIKS01A3.cpp.

Member Function Documentation

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]

Get singleton instance.

Returns:
a pointer to the initialized singleton instance of class XNucleoIKS01A3. A return value of NULL indicates an out of memory situation.
Parameters:
[in]ext_i2c(optional) pointer to an instance of DevI2C to be used for communication on the expansion board. Defaults to NULL. Taken into account only on the very first call of one of the 'Instance' functions. If not provided a new DevI2C will be created with standard configuration parameters. The used DevI2C object gets saved in instance variable dev_i2c.
[in]lsm6dso_int1LSM6DSO INT1 pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT1 pin for LSM6DSO. Defaults to IKS01A3_PIN_LSM6DSO_INT1.
[in]lsm6dso_int2LSM6DSO INT2 pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT2 pin for LSM6DSO. Defaults to IKS01A3_PIN_LSM6DSO_INT2.
[in]lis2dw12_int1LIS2DW12 INT1 pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT1 pin for LIS2DW12. Defaults to IKS01A3_PIN_LIS2DW12_INT1.
[in]lps22hh_intLPS22HH INT pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT pin for LPS22HH. Defaults to IKS01A3_PIN_LPS22HH_INT.
[in]stts751_intSTTS751 INT pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT pin for STTS751. Defaults to IKS01A3_PIN_STTS751_INT.

Definition at line 93 of file XNucleoIKS01A3.cpp.

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 
) [static]

Get singleton instance.

Returns:
a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A3. A return value of NULL indicates an out of memory situation.
Parameters:
[in]sdaI2C data line pin. Taken into account only on the very first call of one of the 'Instance' functions. A new DevI2C will be created based on parameters 'sda' and 'scl'. The used DevI2C object gets saved in instance variable dev_i2c.
[in]sclI2C clock line pin. Taken into account only on the very first call of one of the 'Instance' functions. A new DevI2C will be created based on parameters 'sda' and 'scl'. The used DevI2C object gets saved in instance variable dev_i2c.
[in]lsm6dso_int1LSM6DSO INT1 pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT1 pin for LSM6DSO. Defaults to IKS01A3_PIN_LSM6DSO_INT1.
[in]lsm6dso_int2LSM6DSO INT2 pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT2 pin for LSM6DSO. Defaults to IKS01A3_PIN_LSM6DSO_INT2.
[in]lis2dw12_int1LIS2DW12 INT1 pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT1 pin for LIS2DW12. Defaults to IKS01A3_PIN_LIS2DW12_INT1.
[in]lps22hh_intLPS22HH INT pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT pin for LPS22HH. Defaults to IKS01A3_PIN_LPS22HH_INT.
[in]stts751_intSTTS751 INT pin. Taken into account only on the very first call of one of the 'Instance' functions. It maps the INT pin for STTS751. Defaults to IKS01A3_PIN_STTS751_INT.

Definition at line 136 of file XNucleoIKS01A3.cpp.

Generated on Tue Jul 12 2022 16:34:49 by  doxygen 1.7.2