API for configuring and manipulating PRESS Click driver. More...

Topics
	PRESS Registers List
	List of registers of PRESS Click driver.

	PRESS Registers Settings
	Settings for registers of PRESS Click driver.

	PRESS MikroBUS Map
	MikroBUS pin mapping of PRESS Click driver.

Functions
void	press_cfg_setup (press_cfg_t *cfg)
	PRESS configuration object setup function.

err_t	press_init (press_t ctx, press_cfg_t cfg)
	PRESS initialization function.

err_t	press_default_cfg (press_t *ctx)
	PRESS default configuration function.

err_t	press_generic_write (press_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	PRESS I2C writing function.

err_t	press_generic_read (press_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	PRESS I2C reading function.

err_t	press_reg_write (press_t *ctx, uint8_t reg, uint8_t data_in)
	PRESS I2C register writing function.

err_t	press_reg_read (press_t ctx, uint8_t reg, uint8_t data_out)
	PRESS I2C register reading function.

err_t	press_sw_reset (press_t *ctx)
	PRESS software reset function.

err_t	press_config_ah_qvar (press_t *ctx, uint8_t ah_qvar_en)
	PRESS config AH and Qva function.

err_t	press_get_raw_data (press_t ctx, uint32_t press_data, uint32_t qvar_data, uint16_t temp_data)
	PRESS gets the raw data function.

err_t	press_get_measurement_data (press_t ctx, float pressure, float *temperature)
	PRESS gets the measurement data function.

err_t	press_get_ah_qvar_data (press_t ctx, float ah_qvar)
	PRESS gets the AH/Qvar data function.

Detailed Description

API for configuring and manipulating PRESS Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ press_cfg_setup()

void press_cfg_setup ( press_cfg_t * cfg )

PRESS configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See press_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ press_config_ah_qvar()

err_t press_config_ah_qvar	(	press_t *	ctx,
		uint8_t	ah_qvar_en )

PRESS config AH and Qva function.

This function performs the enable or disable AH and Qvar of the ILPS28QSW, Dual full-scale, 1260 hPa and 4060 hPa, absolute digital output barometer with Qvar detection in a water-resistant package on the PRESS Click board™.

Parameters

[in]	ctx	: Click context object. See press_t object definition for detailed explanation.
[in]	ah_qvar_en	: Config AH and Qva: `0` [PRESS_AH_QVAR_DISABLE] - AH and Qvar are disabled, `1` [PRESS_AH_QVAR_ENABLE] - AH and Qvar are enabled.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_default_cfg()

err_t press_default_cfg ( press_t * ctx )

PRESS default configuration function.

This function executes a default configuration of PRESS click board.

Parameters

[in] ctx : Click context object. See press_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ press_generic_read()

err_t press_generic_read	(	press_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

PRESS I2C reading function.

This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See press_t object definition for detailed explanation.
[in]	reg	: Start register address. See #press_reg definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_generic_write()

err_t press_generic_write	(	press_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

PRESS I2C writing function.

This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See press_t object definition for detailed explanation.
[in]	reg	: Start register address. See #press_reg definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_get_ah_qvar_data()

err_t press_get_ah_qvar_data	(	press_t *	ctx,
		float *	ah_qvar )

PRESS gets the AH/Qvar data function.

This function reads Qvar data conversion of the ILPS28QSW, Dual full-scale, 1260 hPa and 4060 hPa, absolute digital output barometer with Qvar detection in a water-resistant package on the PRESS Click board™.

Parameters

[in]	ctx	: Click context object. See press_t object definition for detailed explanation.
[out]	ah_qvar	: Qvar data ( mV ).

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_get_measurement_data()

err_t press_get_measurement_data	(	press_t *	ctx,
		float *	pressure,
		float *	temperature )

PRESS gets the measurement data function.

This function reads temperature and pressure data conversion of the ILPS28QSW, Dual full-scale, 1260 hPa and 4060 hPa, absolute digital output barometer with Qvar detection in a water-resistant package on the PRESS Click board™.

Parameters

[in]	ctx	: Click context object. See press_t object definition for detailed explanation.
[out]	pressure	: Pressure data ( mbar ).
[out]	temperature	: Temperature data ( degree Celsius ).

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_get_raw_data()

err_t press_get_raw_data	(	press_t *	ctx,
		uint32_t *	press_data,
		uint32_t *	qvar_data,
		uint16_t *	temp_data )

PRESS gets the raw data function.

This function reads the pressure, temperature and Qvar raw data of the ILPS28QSW, Dual full-scale, 1260 hPa and 4060 hPa, absolute digital output barometer with Qvar detection in a water-resistant package on the PRESS Click board™.

Parameters

[in]	ctx	: Click context object. See press_t object definition for detailed explanation.
[out]	press_data	: Pressure data.
[out]	qvar_data	: Qvar data.
[out]	temp_data	: Temperature data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_init()

err_t press_init	(	press_t *	ctx,
		press_cfg_t *	cfg )

PRESS initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See press_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See press_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_reg_read()

err_t press_reg_read	(	press_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

PRESS I2C register reading function.

This function reads a data byte from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See press_t object definition for detailed explanation.
[in]	reg	: Start register address. See #press_reg definition for detailed explanation.
[out]	data_out	: Output read data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_reg_write()

err_t press_reg_write	(	press_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

PRESS I2C register writing function.

This function writes a desired data byte to the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See press_t object definition for detailed explanation.
[in]	reg	: Register address. See #press_reg definition for detailed explanation.
[in]	data_in	: Data to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ press_sw_reset()

err_t press_sw_reset ( press_t * ctx )

PRESS software reset function.

This function performs the software reset of the ILPS28QSW, Dual full-scale, 1260 hPa and 4060 hPa, absolute digital output barometer with Qvar detection in a water-resistant package on the PRESS Click board™.

Parameters

[in] ctx : Click context object. See press_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ press_cfg_setup()

◆ press_config_ah_qvar()

◆ press_default_cfg()

◆ press_generic_read()

◆ press_generic_write()

◆ press_get_ah_qvar_data()

◆ press_get_measurement_data()

◆ press_get_raw_data()

◆ press_init()

◆ press_reg_read()

◆ press_reg_write()

◆ press_sw_reset()