Collaboration diagram for LPS22HB:

Detailed Description

Macros
#define	lps22hbI2CWriteRegister(i2cp, sad, txbuf, n)
	Writes a value into a register using I2C. More...

#define	lps22hbBarometerGetAxesNumber(devp) barometerGetAxesNumber(&((devp)->baro_if))
	Return the number of axes of the BaseBarometer. More...

#define	lps22hbBarometerReadRaw(devp, axes) barometerReadRaw(&((devp)->baro_if), axes)
	Retrieves raw data from the BaseBarometer. More...

#define	lps22hbBarometerReadCooked(devp, axes) barometerReadCooked(&((devp)->baro_if), axes)
	Retrieves cooked data from the BaseBarometer. More...

#define	lps22hbBarometerSetBias(devp, bp) barometerSetBias(&((devp)->baro_if), bp)
	Set bias values for the BaseBarometer. More...

#define	lps22hbBarometerResetBias(devp) barometerResetBias(&((devp)->baro_if))
	Reset bias values for the BaseBarometer. More...

#define	lps22hbBarometerSetSensitivity(devp, sp) barometerSetSensitivity(&((devp)->baro_if), sp)
	Set sensitivity values for the BaseBarometer. More...

#define	lps22hbBarometerResetSensitivity(devp) barometerResetSensitivity(&((devp)->baro_if))
	Reset sensitivity values for the BaseBarometer. More...

#define	lps22hbThermometerGetAxesNumber(devp) thermometerGetAxesNumber(&((devp)->thermo_if))
	Return the number of axes of the BaseThermometer. More...

#define	lps22hbThermometerReadRaw(devp, axes) thermometerReadRaw(&((devp)->thermo_if), axes)
	Retrieves raw data from the BaseThermometer. More...

#define	lps22hbThermometerReadCooked(devp, axes) thermometerReadCooked(&((devp)->thermo_if), axes)
	Retrieves cooked data from the BaseThermometer. More...

#define	lps22hbThermometerSetBias(devp, bp) thermometerSetBias(&((devp)->thermo_if), bp)
	Set bias values for the BaseThermometer. More...

#define	lps22hbThermometerResetBias(devp) thermometerResetBias(&((devp)->thermo_if))
	Reset bias values for the BaseThermometer. More...

#define	lps22hbThermometerSetSensitivity(devp, sp) thermometerSetSensitivity(&((devp)->thermo_if), sp)
	Set sensitivity values for the BaseThermometer. More...

#define	lps22hbThermometerResetSensitivity(devp) thermometerResetSensitivity(&((devp)->thermo_if))
	Reset sensitivity values for the BaseThermometer. More...

Version identification
#define	EX_LPS22HB_VERSION "1.0.2"
	LPS22HB driver version string. More...

#define	EX_LPS22HB_MAJOR 1
	LPS22HB driver version major number. More...

#define	EX_LPS22HB_MINOR 0
	LPS22HB driver version minor number. More...

#define	EX_LPS22HB_PATCH 2
	LPS22HB driver version patch number. More...

#define	LPS22HB_BARO_NUMBER_OF_AXES 1U
	LPS22HB barometer subsystem characteristics. More...

#define	LPS22HB_THERMO_NUMBER_OF_AXES 1U
	LPS22HB thermometer subsystem characteristics. More...

LPS22HB communication interfaces related bit masks
#define	LPS22HB_DI_MASK 0xFF

#define	LPS22HB_DI(n) (1 << n)

#define	LPS22HB_AD_MASK 0x3F

#define	LPS22HB_AD(n) (1 << n)

#define	LPS22HB_MS (1 << 6)

#define	LPS22HB_RW (1 << 7)

#define	LPS22HB_SUB_MS (1 << 7)

LPS22HB register addresses
#define	LPS22HB_AD_INT_CFG 0x0B

#define	LPS22HB_AD_THS_P_L 0x0C

#define	LPS22HB_AD_THS_P_H 0x0D

#define	LPS22HB_AD_WHO_AM_I 0x0F

#define	LPS22HB_AD_CTRL_REG1 0x10

#define	LPS22HB_AD_CTRL_REG2 0x11

#define	LPS22HB_AD_CTRL_REG3 0x12

#define	LPS22HB_AD_FIFO_CTRL 0x14

#define	LPS22HB_AD_REF_P_XL 0x15

#define	LPS22HB_AD_REF_P_L 0x16

#define	LPS22HB_AD_REF_P_H 0x17

#define	LPS22HB_AD_RPDS_L 0x18

#define	LPS22HB_AD_RPDS_H 0x19

#define	LPS22HB_AD_RES_CONF 0x1A

#define	LPS22HB_AD_INT_SRC 0x25

#define	LPS22HB_AD_FIFO_SRC 0x26

#define	LPS22HB_AD_STATUS_REG 0x27

#define	LPS22HB_AD_PRESS_OUT_XL 0x28

#define	LPS22HB_AD_PRESS_OUT_L 0x29

#define	LPS22HB_AD_PRESS_OUT_H 0x2A

#define	LPS22HB_AD_TEMP_OUT_L 0x2B

#define	LPS22HB_AD_TEMP_OUT_H 0x2C

#define	LPS22HB_AD_LPFP_RES 0x33

LPS22HB_INT_CFG register bits definitions
#define	LPS22HB_INT_CFG_MASK 0xFF

#define	LPS22HB_INT_CFG_PHE (1 << 0)

#define	LPS22HB_INT_CFG_PLE (1 << 1)

#define	LPS22HB_INT_CFG_LIR (1 << 2)

#define	LPS22HB_INT_CFG_DIFF_EN (1 << 3)

#define	LPS22HB_INT_CFG_RESET_AZ (1 << 4)

#define	LPS22HB_INT_CFG_AUTOZERO (1 << 5)

#define	LPS22HB_INT_CFG_RESET_ARP (1 << 6)

#define	LPS22HB_INT_CFG_AUTORIFP (1 << 7)

LPS22HB_CTRL_REG1 register bits definitions
#define	LPS22HB_CTRL_REG1_MASK 0x7F

#define	LPS22HB_CTRL_REG1_SIM (1 << 0)

#define	LPS22HB_CTRL_REG1_BDU (1 << 1)

#define	LPS22HB_CTRL_REG1_LPFP_CFG (1 << 2)

#define	LPS22HB_CTRL_REG1_LPFP_EN (1 << 3)

#define	LPS22HB_CTRL_REG1_ODR0 (1 << 4)

#define	LPS22HB_CTRL_REG1_ODR1 (1 << 5)

#define	LPS22HB_CTRL_REG1_ODR2 (1 << 6)

LPS22HB_CTRL_REG2 register bits definitions
#define	LPS22HB_CTRL_REG2_MASK 0xFD

#define	LPS22HB_CTRL_REG2_ONE_SHOT (1 << 0)

#define	LPS22HB_CTRL_REG2_SWRESET (1 << 2)

#define	LPS22HB_CTRL_REG2_I2C_DIS (1 << 3)

#define	LPS22HB_CTRL_REG2_IF_ADD_INC (1 << 4)

#define	LPS22HB_CTRL_REG2_STOP_ON_FTH (1 << 5)

#define	LPS22HB_CTRL_REG2_FIFO_EN (1 << 6)

#define	LPS22HB_CTRL_REG2_BOOT (1 << 7)

LPS22HB_CTRL_REG3 register bits definitions
#define	LPS22HB_CTRL_REG3_MASK 0xFF

#define	LPS22HB_CTRL_REG3_INT_S1 (1 << 0)

#define	LPS22HB_CTRL_REG3_INT_S2 (1 << 1)

#define	LPS22HB_CTRL_REG3_DRDY (1 << 2)

#define	LPS22HB_CTRL_REG3_F_OVR (1 << 3)

#define	LPS22HB_CTRL_REG3_F_FTH (1 << 4)

#define	LPS22HB_CTRL_REG3_F_FSS5 (1 << 5)

#define	LPS22HB_CTRL_REG3_PP_OD (1 << 6)

#define	LPS22HB_CTRL_REG3_INT_H_L (1 << 7)

LPS22HB_INT_SRC register bits definitions
#define	LPS22HB_INT_SRC_MASK 0x87

#define	LPS22HB_INT_SRC_PH (1 << 0)

#define	LPS22HB_INT_SRC_PL (1 << 1)

#define	LPS22HB_INT_SRC_IA (1 << 2)

#define	LPS22HB_INT_SRC_BOOT_STATUS (1 << 8)

Configuration options
#define	LPS22HB_USE_SPI FALSE
	LPS22HB SPI interface switch. More...

#define	LPS22HB_SHARED_SPI FALSE
	LPS22HB shared SPI switch. More...

#define	LPS22HB_USE_I2C TRUE
	LPS22HB I2C interface switch. More...

#define	LPS22HB_SHARED_I2C FALSE
	LPS22HB shared I2C switch. More...

#define	LPS22HB_USE_ADVANCED FALSE
	LPS22HB advanced configurations switch. More...

LPS22HB data structures and types.
enum	lps22hb_sad_t { LPS22HB_SAD_GND = 0x5C, LPS22HB_SAD_VCC = 0x5D }
	LPS22HB slave address. More...

enum	lps22hb_odr_t { LPS22HB_ODR_PD = 0x00, LPS22HB_ODR_1HZ = 0x10, LPS22HB_ODR_10HZ = 0x20, LPS22HB_ODR_25HZ = 0x30, LPS22HB_ODR_50HZ = 0x40, LPS22HB_ODR_75HZ = 0x50 }
	LPS22HB output data rate and bandwidth. More...

enum	lps22hb_lp_t { LPS22HB_LP_DISABLED = 0x00, LPS22HB_LP_ODR_9 = 0x08, LPS22HB_LP_ODR_20 = 0x0C }
	LPS22HB pressure resolution. More...

enum	lps22hb_bdu_t { LPS22HB_BDU_CONTINUOUS = 0x00, LPS22HB_BDU_BLOCKED = 0x40 }
	LPS22HB block data update. More...

enum	lps22hb_state_t { LPS22HB_UNINIT = 0, LPS22HB_STOP = 1, LPS22HB_READY = 2 }
	Driver state machine possible states. More...

typedef struct LPS22HBDriver	LPS22HBDriver
	Structure representing a LPS22HB driver. More...

#define	_lps22hb_methods_alone
	`LPS22HB` specific methods. More...

#define	_lps22hb_methods
	`LPS22HB` specific methods with inherited ones. More...

#define	_lps22hb_data
	`LPS22HBDriver` specific data. More...

Data Structures
struct	LPS22HBConfig
	LPS22HB configuration structure. More...

struct	LPS22HBVMT
	`LPS22HB` virtual methods table. More...

struct	LPS22HBDriver
	LPS22HB 2-axis barometer/thermometer class. More...

Functions
static msg_t	lps22hbI2CReadRegister (I2CDriver i2cp, lps22hb_sad_t sad, uint8_t reg, uint8_t rxbuf, size_t n)
	Reads registers value using I2C. More...

static size_t	baro_get_axes_number (void *ip)
	Return the number of axes of the BaseBarometer. More...

static msg_t	baro_read_raw (void *ip, int32_t axes[])
	Retrieves raw data from the BaseBarometer. More...

static msg_t	baro_read_cooked (void *ip, float axes[])
	Retrieves cooked data from the BaseBarometer. More...

static msg_t	baro_set_bias (void ip, float bp)
	Set bias values for the BaseBarometer. More...

static msg_t	baro_reset_bias (void *ip)
	Reset bias values for the BaseBarometer. More...

static msg_t	baro_set_sensitivity (void ip, float sp)
	Set sensitivity values for the BaseBarometer. More...

static msg_t	baro_reset_sensitivity (void *ip)
	Reset sensitivity values for the BaseBarometer. More...

static size_t	thermo_get_axes_number (void *ip)
	Return the number of axes of the BaseThermometer. More...

static msg_t	thermo_read_raw (void *ip, int32_t axes[])
	Retrieves raw data from the BaseThermometer. More...

static msg_t	thermo_read_cooked (void ip, float axis)
	Retrieves cooked data from the BaseThermometer. More...

static msg_t	thermo_set_bias (void ip, float bp)
	Set bias values for the BaseThermometer. More...

static msg_t	thermo_reset_bias (void *ip)
	Reset bias values for the BaseThermometer. More...

static msg_t	thermo_set_sensitivity (void ip, float sp)
	Set sensitivity values for the BaseThermometer. More...

static msg_t	thermo_reset_sensitivity (void *ip)
	Reset sensitivity values for the BaseThermometer. More...

void	lps22hbObjectInit (LPS22HBDriver *devp)
	Initializes an instance. More...

void	lps22hbStart (LPS22HBDriver devp, const LPS22HBConfig config)
	Configures and activates LPS22HB Complex Driver peripheral. More...

void	lps22hbStop (LPS22HBDriver *devp)
	Deactivates the LPS22HB Complex Driver peripheral. More...

Macro Definition Documentation

◆ lps22hbI2CWriteRegister

#define lps22hbI2CWriteRegister	(	i2cp,
		sad,
		txbuf,
		n
	)

Value:

i2cMasterTransmitTimeout(i2cp, sad, txbuf, n + 1, NULL, 0, \

TIME_INFINITE)

Writes a value into a register using I2C.

Precondition: The I2C interface must be initialized and the driver started.

Parameters

[in]	i2cp	pointer to the I2C interface
[in]	sad	slave address without R bit
[in]	txbuf	buffer containing sub-address value in first position and values to write
[in]	n	size of txbuf less one (not considering the first element)

Returns: the operation status.

Function Class:: Not an API, this function is for internal use only.

Definition at line 84 of file lps22hb.c.

◆ EX_LPS22HB_VERSION

#define EX_LPS22HB_VERSION "1.0.2"

LPS22HB driver version string.

Definition at line 46 of file lps22hb.h.

◆ EX_LPS22HB_MAJOR

#define EX_LPS22HB_MAJOR 1

LPS22HB driver version major number.

Definition at line 51 of file lps22hb.h.

◆ EX_LPS22HB_MINOR

#define EX_LPS22HB_MINOR 0

LPS22HB driver version minor number.

Definition at line 56 of file lps22hb.h.

◆ EX_LPS22HB_PATCH

#define EX_LPS22HB_PATCH 2

LPS22HB driver version patch number.

Definition at line 61 of file lps22hb.h.

◆ LPS22HB_BARO_NUMBER_OF_AXES

#define LPS22HB_BARO_NUMBER_OF_AXES 1U

LPS22HB barometer subsystem characteristics.

Note: Sensitivity is expressed as hPa/LSB whereas hPa stand for hectopascal.; Bias is expressed as hPa.

Definition at line 72 of file lps22hb.h.

◆ LPS22HB_THERMO_NUMBER_OF_AXES

#define LPS22HB_THERMO_NUMBER_OF_AXES 1U

LPS22HB thermometer subsystem characteristics.

Note: Sensitivity is expressed as �C/LSB.; Bias is expressed as �C.

Definition at line 85 of file lps22hb.h.

◆ LPS22HB_USE_SPI

#define LPS22HB_USE_SPI FALSE

LPS22HB SPI interface switch.

If set to TRUE the support for SPI is included.

Note: The default is FALSE.

Definition at line 217 of file lps22hb.h.

◆ LPS22HB_SHARED_SPI

#define LPS22HB_SHARED_SPI FALSE

LPS22HB shared SPI switch.

If set to TRUE the device acquires SPI bus ownership on each transaction.

Note: The default is FALSE. Requires SPI_USE_MUTUAL_EXCLUSION.

Definition at line 227 of file lps22hb.h.

◆ LPS22HB_USE_I2C

#define LPS22HB_USE_I2C TRUE

LPS22HB I2C interface switch.

If set to TRUE the support for I2C is included.

Note: The default is TRUE.

Definition at line 236 of file lps22hb.h.

◆ LPS22HB_SHARED_I2C

#define LPS22HB_SHARED_I2C FALSE

LPS22HB shared I2C switch.

If set to TRUE the device acquires I2C bus ownership on each transaction.

Note: The default is FALSE. Requires I2C_USE_MUTUAL_EXCLUSION.

Definition at line 246 of file lps22hb.h.

◆ LPS22HB_USE_ADVANCED

#define LPS22HB_USE_ADVANCED FALSE

LPS22HB advanced configurations switch.

If set to TRUE more configurations are available.

Note: The default is FALSE.

Definition at line 255 of file lps22hb.h.

◆ _lps22hb_methods_alone

#define _lps22hb_methods_alone

LPS22HB specific methods.

Note: No methods so far, just a common ancestor interface.

Definition at line 414 of file lps22hb.h.

◆ _lps22hb_methods

#define _lps22hb_methods

Value:

_base_object_methods \

_lps22hb_methods_alone

LPS22HB specific methods with inherited ones.

Definition at line 419 of file lps22hb.h.

◆ _lps22hb_data

#define _lps22hb_data

Value:

  /* Driver state.*/                                                        \
  lps22hb_state_t           state;                                          \
  /* Current configuration data.*/                                          \
  const LPS22HBConfig       *config;                                        \
  /* Barometer subsystem axes number.*/                                     \
  size_t                    baroaxes;                                       \
  /* Barometer subsystem current sensitivity.*/                             \
  float                     barosensitivity;                                \
  /* Barometer subsystem current bias .*/                                   \
  float                     barobias;                                       \
  /* Thermometer subsystem axes number.*/                                   \
  size_t                    thermoaxes;                                     \
  /* Thermometer subsystem current sensitivity.*/                           \
  float                     thermosensitivity;                              \
  /* Thermometer subsystem current bias.*/                                  \
  float                     thermobias;

LPS22HBDriver specific data.

Definition at line 435 of file lps22hb.h.

◆ lps22hbBarometerGetAxesNumber

#define lps22hbBarometerGetAxesNumber ( devp ) barometerGetAxesNumber(&((devp)->baro_if))

Return the number of axes of the BaseBarometer.

Parameters

[in] devp pointer to LPS22HBDriver.

Returns: the number of axes.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 480 of file lps22hb.h.

◆ lps22hbBarometerReadRaw

#define lps22hbBarometerReadRaw	(	devp,
		axes
	)	barometerReadRaw(&((devp)->baro_if), axes)

Retrieves raw data from the BaseBarometer.

Note: This data is retrieved from MEMS register without any algebraical manipulation.; The axes array must be at least the same size of the BaseBarometer axes number.

Parameters

[in]	devp	pointer to `LPS22HBDriver`.
[out]	axes	a buffer which would be filled with raw data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 501 of file lps22hb.h.

◆ lps22hbBarometerReadCooked

#define lps22hbBarometerReadCooked	(	devp,
		axes
	)	barometerReadCooked(&((devp)->baro_if), axes)

Retrieves cooked data from the BaseBarometer.

Note: This data is manipulated according to the formula cooked = (raw * sensitivity) - bias.; Final data is expressed as hPa.; The axes array must be at least the same size of the BaseBarometer axes number.

Parameters

[in]	devp	pointer to `LPS22HBDriver`.
[out]	axes	a buffer which would be filled with cooked data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 523 of file lps22hb.h.

◆ lps22hbBarometerSetBias

#define lps22hbBarometerSetBias	(	devp,
		bp
	)	barometerSetBias(&((devp)->baro_if), bp)

Set bias values for the BaseBarometer.

Note: Bias must be expressed as hPa.; The bias buffer must be at least the same size of the BaseBarometer axes number.

Parameters

[in]	devp	pointer to `LPS22HBDriver`.
[in]	bp	a buffer which contains biases.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 540 of file lps22hb.h.

◆ lps22hbBarometerResetBias

#define lps22hbBarometerResetBias ( devp ) barometerResetBias(&((devp)->baro_if))

Reset bias values for the BaseBarometer.

Note: Default biases value are obtained from device datasheet when available otherwise they are considered zero.

Parameters

[in] devp pointer to LPS22HBDriver.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 555 of file lps22hb.h.

◆ lps22hbBarometerSetSensitivity

#define lps22hbBarometerSetSensitivity	(	devp,
		sp
	)	barometerSetSensitivity(&((devp)->baro_if), sp)

Set sensitivity values for the BaseBarometer.

Note: Sensitivity must be expressed as hPa/LSB.; The sensitivity buffer must be at least the same size of the BaseBarometer axes number.

Parameters

[in]	devp	pointer to `LPS22HBDriver`.
[in]	sp	a buffer which contains sensitivities.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 572 of file lps22hb.h.

◆ lps22hbBarometerResetSensitivity

#define lps22hbBarometerResetSensitivity ( devp ) barometerResetSensitivity(&((devp)->baro_if))

Reset sensitivity values for the BaseBarometer.

Note: Default sensitivities value are obtained from device datasheet.

Parameters

[in] devp pointer to LPS22HBDriver.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 586 of file lps22hb.h.

◆ lps22hbThermometerGetAxesNumber

#define lps22hbThermometerGetAxesNumber ( devp ) thermometerGetAxesNumber(&((devp)->thermo_if))

Return the number of axes of the BaseThermometer.

Parameters

[in] devp pointer to LPS22HBDriver.

Returns: the number of axes.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 598 of file lps22hb.h.

◆ lps22hbThermometerReadRaw

#define lps22hbThermometerReadRaw	(	devp,
		axes
	)	thermometerReadRaw(&((devp)->thermo_if), axes)

Retrieves raw data from the BaseThermometer.

Note: This data is retrieved from MEMS register without any algebraical manipulation.; The axes array must be at least the same size of the BaseThermometer axes number.

Parameters

[in]	devp	pointer to `LPS22HBDriver`.
[out]	axes	a buffer which would be filled with raw data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 619 of file lps22hb.h.

◆ lps22hbThermometerReadCooked

#define lps22hbThermometerReadCooked	(	devp,
		axes
	)	thermometerReadCooked(&((devp)->thermo_if), axes)

Retrieves cooked data from the BaseThermometer.

Note: This data is manipulated according to the formula cooked = (raw * sensitivity) - bias.; Final data is expressed as °C.; The axes array must be at least the same size of the BaseThermometer axes number.

Parameters

[in]	devp	pointer to `LPS22HBDriver`.
[out]	axes	a buffer which would be filled with cooked data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 641 of file lps22hb.h.

◆ lps22hbThermometerSetBias

#define lps22hbThermometerSetBias	(	devp,
		bp
	)	thermometerSetBias(&((devp)->thermo_if), bp)

Set bias values for the BaseThermometer.

Note: Bias must be expressed as °C.; The bias buffer must be at least the same size of the BaseThermometer axes number.

Parameters

[in]	devp	pointer to `LPS22HBDriver`.
[in]	bp	a buffer which contains biases.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 658 of file lps22hb.h.

◆ lps22hbThermometerResetBias

#define lps22hbThermometerResetBias ( devp ) thermometerResetBias(&((devp)->thermo_if))

Reset bias values for the BaseThermometer.

Note: Default biases value are obtained from device datasheet when available otherwise they are considered zero.

Parameters

[in] devp pointer to LPS22HBDriver.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 673 of file lps22hb.h.

◆ lps22hbThermometerSetSensitivity

#define lps22hbThermometerSetSensitivity	(	devp,
		sp
	)	thermometerSetSensitivity(&((devp)->thermo_if), sp)

Set sensitivity values for the BaseThermometer.

Note: Sensitivity must be expressed as °C/LSB.; The sensitivity buffer must be at least the same size of the BaseThermometer axes number.

Parameters

[in]	devp	pointer to `LPS22HBDriver`.
[in]	sp	a buffer which contains sensitivities.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 690 of file lps22hb.h.

◆ lps22hbThermometerResetSensitivity

#define lps22hbThermometerResetSensitivity ( devp ) thermometerResetSensitivity(&((devp)->thermo_if))

Reset sensitivity values for the BaseThermometer.

Note: Default sensitivities value are obtained from device datasheet.

Parameters

[in] devp pointer to LPS22HBDriver.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 704 of file lps22hb.h.

Typedef Documentation

◆ LPS22HBDriver

typedef struct LPS22HBDriver LPS22HBDriver

Structure representing a LPS22HB driver.

Definition at line 301 of file lps22hb.h.

Enumeration Type Documentation

◆ lps22hb_sad_t

enum lps22hb_sad_t

LPS22HB slave address.

Enumerator
LPS22HB_SAD_GND	Slave Address when SA0 is to GND
LPS22HB_SAD_VCC	Slave Address when SA0 is to VCC

Definition at line 306 of file lps22hb.h.

◆ lps22hb_odr_t

enum lps22hb_odr_t

LPS22HB output data rate and bandwidth.

Enumerator
LPS22HB_ODR_PD	Power down.
LPS22HB_ODR_1HZ	Output data rate 1 Hz.
LPS22HB_ODR_10HZ	Output data rate 10 Hz.
LPS22HB_ODR_25HZ	Output data rate 25 Hz.
LPS22HB_ODR_50HZ	Output data rate 50 Hz.
LPS22HB_ODR_75HZ	Output data rate 75 Hz.

Definition at line 314 of file lps22hb.h.

◆ lps22hb_lp_t

enum lps22hb_lp_t

LPS22HB pressure resolution.

Enumerator
LPS22HB_LP_DISABLED	LP Filter disabled.
LPS22HB_LP_ODR_9	LP Filter enabled. Cut-off ORD/9.
LPS22HB_LP_ODR_20	LP Filter enabled. Cut-off ORD/20.

Definition at line 326 of file lps22hb.h.

◆ lps22hb_bdu_t

enum lps22hb_bdu_t

LPS22HB block data update.

Enumerator
LPS22HB_BDU_CONTINUOUS	Block data continuously updated.
LPS22HB_BDU_BLOCKED	Block data updated after reading.

Definition at line 335 of file lps22hb.h.

◆ lps22hb_state_t

enum lps22hb_state_t

Driver state machine possible states.

Enumerator
LPS22HB_UNINIT	Not initialized.
LPS22HB_STOP	Stopped.
LPS22HB_READY	Ready.

Definition at line 343 of file lps22hb.h.

Function Documentation

◆ lps22hbI2CReadRegister()

static msg_t lps22hbI2CReadRegister	(	I2CDriver *	i2cp,
		lps22hb_sad_t	sad,
		uint8_t	reg,
		uint8_t *	rxbuf,
		size_t	n
	)

static

Reads registers value using I2C.

Precondition: The I2C interface must be initialized and the driver started.

Parameters

[in]	i2cp	pointer to the I2C interface
[in]	sad	slave address without R bit
[in]	reg	first sub-register address
[out]	rxbuf	pointer to an output buffer
[in]	n	number of consecutive register to read

Returns: the operation status.

Function Class:: Not an API, this function is for internal use only.

Definition at line 63 of file lps22hb.c.

References i2cMasterTransmitTimeout(), and TIME_INFINITE.

Referenced by baro_read_raw(), and thermo_read_raw().

Here is the call graph for this function:

◆ baro_get_axes_number()

static size_t baro_get_axes_number ( void * ip )

static

Return the number of axes of the BaseBarometer.

Parameters

[in] ip pointer to BaseBarometer interface.

Returns: the number of axes.

Definition at line 96 of file lps22hb.c.

References LPS22HB_BARO_NUMBER_OF_AXES.

◆ baro_read_raw()

static msg_t baro_read_raw	(	void *	ip,
		int32_t	axes[]
	)

static

Retrieves raw data from the BaseBarometer.

Note: This data is retrieved from MEMS register without any algebraical manipulation.; The axes array must be at least the same size of the BaseBarometer axes number.

Parameters

[in]	ip	pointer to `BaseBarometer` interface.
[out]	axes	a buffer which would be filled with raw data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Definition at line 118 of file lps22hb.c.

References I2C_READY, i2cAcquireBus(), i2cStart(), LPS22HB_READY, lps22hbI2CReadRegister(), objGetInstance, osalDbgAssert, and osalDbgCheck.

Referenced by baro_read_cooked().

Here is the call graph for this function:

◆ baro_read_cooked()

static msg_t baro_read_cooked	(	void *	ip,
		float	axes[]
	)

static

Retrieves cooked data from the BaseBarometer.

Note: This data is manipulated according to the formula cooked = (raw * sensitivity) - bias.; Final data is expressed as hPa.; The axes array must be at least the same size of the BaseBarometer axes number.

Parameters

[in]	ip	pointer to `BaseBarometer` interface.
[out]	axes	a buffer which would be filled with cooked data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Definition at line 170 of file lps22hb.c.

References baro_read_raw(), LPS22HB_READY, objGetInstance, osalDbgAssert, and osalDbgCheck.

Here is the call graph for this function:

◆ baro_set_bias()

static msg_t baro_set_bias	(	void *	ip,
		float *	bp
	)

static

Set bias values for the BaseBarometer.

Note: Bias must be expressed as hPa.; The bias buffer must be at least the same size of the BaseBarometer axes number.

Parameters

[in]	ip	pointer to `BaseBarometer` interface.
[in]	bp	a buffer which contains biases.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Definition at line 205 of file lps22hb.c.

References LPS22HB_READY, MSG_OK, objGetInstance, osalDbgAssert, and osalDbgCheck.

◆ baro_reset_bias()

static msg_t baro_reset_bias ( void * ip )

static

Reset bias values for the BaseBarometer.

Note: Default biases value are obtained from device datasheet when available otherwise they are considered zero.

Parameters

[in] ip pointer to BaseBarometer interface.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 231 of file lps22hb.c.

References LPS22HB_READY, MSG_OK, objGetInstance, osalDbgAssert, and osalDbgCheck.

◆ baro_set_sensitivity()

static msg_t baro_set_sensitivity	(	void *	ip,
		float *	sp
	)

static

Set sensitivity values for the BaseBarometer.

Note: Sensitivity must be expressed as hPa/LSB.; The sensitivity buffer must be at least the same size of the BaseBarometer axes number.

Parameters

[in]	ip	pointer to `BaseBarometer` interface.
[in]	sp	a buffer which contains sensitivities.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 259 of file lps22hb.c.

References LPS22HB_READY, MSG_OK, objGetInstance, osalDbgAssert, and osalDbgCheck.

◆ baro_reset_sensitivity()

static msg_t baro_reset_sensitivity ( void * ip )

static

Reset sensitivity values for the BaseBarometer.

Note: Default sensitivities value are obtained from device datasheet.

Parameters

[in] ip pointer to BaseBarometer interface.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 284 of file lps22hb.c.

References LPS22HB_READY, MSG_OK, objGetInstance, osalDbgAssert, and osalDbgCheck.

◆ thermo_get_axes_number()

static size_t thermo_get_axes_number ( void * ip )

static

Return the number of axes of the BaseThermometer.

Parameters

[in] ip pointer to BaseThermometer interface.

Returns: the number of axes.

Definition at line 307 of file lps22hb.c.

References LPS22HB_THERMO_NUMBER_OF_AXES.

◆ thermo_read_raw()

static msg_t thermo_read_raw	(	void *	ip,
		int32_t	axes[]
	)

static

Retrieves raw data from the BaseThermometer.

Note: This data is retrieved from MEMS register without any algebraical manipulation.; The axes array must be at least the same size of the BaseThermometer axes number.

Parameters

[in]	ip	pointer to `BaseThermometer` interface.
[out]	axes	a buffer which would be filled with raw data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Definition at line 329 of file lps22hb.c.

References I2C_READY, i2cAcquireBus(), i2cStart(), LPS22HB_READY, lps22hbI2CReadRegister(), objGetInstance, osalDbgAssert, and osalDbgCheck.

Referenced by thermo_read_cooked().

Here is the call graph for this function:

◆ thermo_read_cooked()

static msg_t thermo_read_cooked	(	void *	ip,
		float *	axis
	)

static

Retrieves cooked data from the BaseThermometer.

Note: This data is manipulated according to the formula cooked = (raw * sensitivity) - bias.; Final data is expressed as °C.; The axes array must be at least the same size of the BaseThermometer axes number.

Parameters

[in]	ip	pointer to `BaseThermometer` interface.
[out]	axis	a buffer which would be filled with cooked data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Definition at line 383 of file lps22hb.c.

References LPS22HB_READY, objGetInstance, osalDbgAssert, osalDbgCheck, and thermo_read_raw().

Here is the call graph for this function:

◆ thermo_set_bias()

static msg_t thermo_set_bias	(	void *	ip,
		float *	bp
	)

static

Set bias values for the BaseThermometer.

Note: Bias must be expressed as °C.; The bias buffer must be at least the same size of the BaseThermometer axes number.

Parameters

[in]	ip	pointer to `BaseThermometer` interface.
[in]	bp	a buffer which contains biases.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 415 of file lps22hb.c.

References LPS22HB_READY, MSG_OK, objGetInstance, osalDbgAssert, and osalDbgCheck.

◆ thermo_reset_bias()

static msg_t thermo_reset_bias ( void * ip )

static

Reset bias values for the BaseThermometer.

Note: Default biases value are obtained from device datasheet when available otherwise they are considered zero.

Parameters

[in] ip pointer to BaseThermometer interface.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 442 of file lps22hb.c.

References LPS22HB_READY, MSG_OK, objGetInstance, osalDbgAssert, and osalDbgCheck.

◆ thermo_set_sensitivity()

static msg_t thermo_set_sensitivity	(	void *	ip,
		float *	sp
	)

static

Set sensitivity values for the BaseThermometer.

Note: Sensitivity must be expressed as °C/LSB.; The sensitivity buffer must be at least the same size of the BaseThermometer axes number.

Parameters

[in]	ip	pointer to `BaseThermometer` interface.
[in]	sp	a buffer which contains sensitivities.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 471 of file lps22hb.c.

References LPS22HB_READY, MSG_OK, objGetInstance, osalDbgAssert, and osalDbgCheck.

◆ thermo_reset_sensitivity()

static msg_t thermo_reset_sensitivity ( void * ip )

static

Reset sensitivity values for the BaseThermometer.

Note: Default sensitivities value are obtained from device datasheet.

Parameters

[in] ip pointer to BaseThermometer interface.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 497 of file lps22hb.c.

References LPS22HB_READY, MSG_OK, objGetInstance, osalDbgAssert, and osalDbgCheck.

◆ lps22hbObjectInit()

void lps22hbObjectInit ( LPS22HBDriver * devp )

Initializes an instance.

Parameters

[out] devp pointer to the LPS22HBDriver object

Function Class:: Initializer, this function just initializes an object and can be invoked before the kernel is initialized.

Definition at line 543 of file lps22hb.c.

References LPS22HBDriver::vmt.

◆ lps22hbStart()

void lps22hbStart	(	LPS22HBDriver *	devp,
		const LPS22HBConfig *	config
	)

Configures and activates LPS22HB Complex Driver peripheral.

Parameters

[in]	devp	pointer to the `LPS22HBDriver` object
[in]	config	pointer to the `LPS22HBConfig` object

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 565 of file lps22hb.c.

References LPS22HB_READY, LPS22HB_STOP, osalDbgAssert, and osalDbgCheck.

◆ lps22hbStop()

void lps22hbStop ( LPS22HBDriver * devp )

Deactivates the LPS22HB Complex Driver peripheral.

Parameters

[in] devp pointer to the LPS22HBDriver object

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 659 of file lps22hb.c.

References i2cAcquireBus(), i2cStart(), LPS22HB_READY, LPS22HB_STOP, osalDbgAssert, and osalDbgCheck.

Here is the call graph for this function:

Detailed Description

Macros

Version identification

LPS22HB communication interfaces related bit masks

LPS22HB register addresses

LPS22HB_INT_CFG register bits definitions

LPS22HB_CTRL_REG1 register bits definitions

LPS22HB_CTRL_REG2 register bits definitions

LPS22HB_CTRL_REG3 register bits definitions

LPS22HB_INT_SRC register bits definitions

Configuration options

LPS22HB data structures and types.

Data Structures

Functions

Macro Definition Documentation

◆ lps22hbI2CWriteRegister

◆ EX_LPS22HB_VERSION

◆ EX_LPS22HB_MAJOR

◆ EX_LPS22HB_MINOR

◆ EX_LPS22HB_PATCH

◆ LPS22HB_BARO_NUMBER_OF_AXES

◆ LPS22HB_THERMO_NUMBER_OF_AXES

◆ LPS22HB_USE_SPI

◆ LPS22HB_SHARED_SPI

◆ LPS22HB_USE_I2C

◆ LPS22HB_SHARED_I2C

◆ LPS22HB_USE_ADVANCED

◆ _lps22hb_methods_alone

◆ _lps22hb_methods

◆ _lps22hb_data

◆ lps22hbBarometerGetAxesNumber

◆ lps22hbBarometerReadRaw

◆ lps22hbBarometerReadCooked

◆ lps22hbBarometerSetBias

◆ lps22hbBarometerResetBias

◆ lps22hbBarometerSetSensitivity

◆ lps22hbBarometerResetSensitivity

◆ lps22hbThermometerGetAxesNumber

◆ lps22hbThermometerReadRaw

◆ lps22hbThermometerReadCooked

◆ lps22hbThermometerSetBias

◆ lps22hbThermometerResetBias

◆ lps22hbThermometerSetSensitivity

◆ lps22hbThermometerResetSensitivity

Typedef Documentation

◆ LPS22HBDriver

Enumeration Type Documentation

◆ lps22hb_sad_t

◆ lps22hb_odr_t

◆ lps22hb_lp_t

◆ lps22hb_bdu_t

◆ lps22hb_state_t

Function Documentation

◆ lps22hbI2CReadRegister()

◆ baro_get_axes_number()

◆ baro_read_raw()

◆ baro_read_cooked()

◆ baro_set_bias()

◆ baro_reset_bias()

◆ baro_set_sensitivity()

◆ baro_reset_sensitivity()

◆ thermo_get_axes_number()

◆ thermo_read_raw()

◆ thermo_read_cooked()

◆ thermo_set_bias()

◆ thermo_reset_bias()

◆ thermo_set_sensitivity()

◆ thermo_reset_sensitivity()

◆ lps22hbObjectInit()

◆ lps22hbStart()

◆ lps22hbStop()