API for configuring and manipulating Barometer 5 Click driver. More...

Topics
	Barometer 5 Command List
	List of commands of Barometer 5 Click driver.

	Barometer 5 Registers Settings
	Settings for registers of Barometer 5 Click driver.

	Barometer 5 MikroBUS Map
	MikroBUS pin mapping of Barometer 5 Click driver.

	Barometer5_cmd

Functions
void	barometer5_cfg_setup (barometer5_cfg_t *cfg)
	Barometer 5 configuration object setup function.

err_t	barometer5_init (barometer5_t ctx, barometer5_cfg_t cfg)
	Barometer 5 initialization function.

err_t	barometer5_default_cfg (barometer5_t *ctx)
	Barometer 5 default configuration function.

err_t	barometer5_generic_write (barometer5_t ctx, uint8_t reg, uint8_t tx_buf, uint8_t tx_len)
	Barometer 5 I2C writing function.

err_t	barometer5_generic_read (barometer5_t ctx, uint8_t reg, uint8_t rx_buf, uint8_t rx_len)
	Barometer 5 I2C reading function.

err_t	barometer5_set_command (barometer5_t *ctx, uint8_t cmd)
	Barometer 5 set command function.

err_t	barometer5_set_ratio (barometer5_t *ctx, uint8_t temp_ratio, uint8_t press_ratio)
	Barometer 5 set data ratio function.

err_t	barometer5_sw_reset (barometer5_t *ctx)
	Barometer 5 software reset function.

err_t	barometer5_get_calibration_data (barometer5_t *ctx)
	Barometer 5 get calibration data function.

err_t	barometer5_get_raw_data (barometer5_t ctx, uint32_t temp_data, uint32_t *press_data)
	Barometer 5 get raw data function.

err_t	barometer5_get_temperature (barometer5_t ctx, float temperature)
	Barometer 5 get temperature data function.

err_t	barometer5_get_pressure (barometer5_t ctx, float pressure)
	Barometer 5 get pressure data function.

err_t	barometer5_calculate_altitude (barometer5_t ctx, float altitude)
	Barometer 5 calculate altitude function.

err_t	barometer5_get_data (barometer5_t ctx, float temperature, float *pressure)
	Barometer 5 get data function.

Detailed Description

API for configuring and manipulating Barometer 5 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

◆ barometer5_calculate_altitude()

err_t barometer5_calculate_altitude	(	barometer5_t *	ctx,
		float *	altitude )

Barometer 5 calculate altitude function.

This function read pressure and temperature data and calculate altitude data, depending on the temperature and pressure data, function calculates altitude in meters of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

[in]	ctx	: Click context object. See barometer5_t object definition for detailed explanation.
[out]	altitude	: Altitude data in meters.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Executes a ADC conversion delay of the 20 milliseconds.

◆ barometer5_cfg_setup()

void barometer5_cfg_setup ( barometer5_cfg_t * cfg )

Barometer 5 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ barometer5_default_cfg()

err_t barometer5_default_cfg ( barometer5_t * ctx )

Barometer 5 default configuration function.

This function executes a default configuration of Barometer 5 click board.

Parameters

[in] ctx : Click context object. See barometer5_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.

◆ barometer5_generic_read()

err_t barometer5_generic_read	(	barometer5_t *	ctx,
		uint8_t	reg,
		uint8_t *	rx_buf,
		uint8_t	rx_len )

Barometer 5 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 barometer5_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	rx_buf	: Output read data.
[in]	rx_len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ barometer5_generic_write()

err_t barometer5_generic_write	(	barometer5_t *	ctx,
		uint8_t	reg,
		uint8_t *	tx_buf,
		uint8_t	tx_len )

Barometer 5 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 barometer5_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	tx_buf	: Data to be written.
[in]	tx_len	: Number of bytes to be written.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ barometer5_get_calibration_data()

err_t barometer5_get_calibration_data ( barometer5_t * ctx )

Barometer 5 get calibration data function.

This function read and store calibration data of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Executes a ADC conversion delay of the 10 milliseconds.

◆ barometer5_get_data()

err_t barometer5_get_data	(	barometer5_t *	ctx,
		float *	temperature,
		float *	pressure )

Barometer 5 get data function.

This function read temperature and pressure data, convert temperature data to the degree Celsius and pressure data to the mbar of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Executes a ADC conversion delay of the 10 milliseconds.

◆ barometer5_get_pressure()

err_t barometer5_get_pressure	(	barometer5_t *	ctx,
		float *	pressure )

Barometer 5 get pressure data function.

This function read pressure data and convert to the mbar of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

[in]	ctx	: Click context object. See barometer5_t object definition for detailed explanation.
[out]	pressure	: Pressure in mbar.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Executes a ADC conversion delay of the 10 milliseconds.

◆ barometer5_get_raw_data()

err_t barometer5_get_raw_data	(	barometer5_t *	ctx,
		uint32_t *	temp_data,
		uint32_t *	press_data )

Barometer 5 get raw data function.

This function read raw temperature and pressure data of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

[in]	ctx	: Click context object. See barometer5_t object definition for detailed explanation.
[out]	temp_data	: Raw temperature data.
[out]	press_data	: Raw pressure data.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Executes a ADC conversion delay of the 20 milliseconds.

◆ barometer5_get_temperature()

err_t barometer5_get_temperature	(	barometer5_t *	ctx,
		float *	temperature )

Barometer 5 get temperature data function.

This function read temperature data and convert to the degree Celsius of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

[in]	ctx	: Click context object. See barometer5_t object definition for detailed explanation.
[out]	temperature	: Temperature in degree Celsius.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Executes a ADC conversion delay of the 10 milliseconds.

◆ barometer5_init()

err_t barometer5_init	(	barometer5_t *	ctx,
		barometer5_cfg_t *	cfg )

Barometer 5 initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ barometer5_set_command()

err_t barometer5_set_command	(	barometer5_t *	ctx,
		uint8_t	cmd )

Barometer 5 set command function.

This function writes a desired command of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

[in]	ctx	: Click context object. See barometer5_t object definition for detailed explanation.
[in]	cmd	: Desired command.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ barometer5_set_ratio()

err_t barometer5_set_ratio	(	barometer5_t *	ctx,
		uint8_t	temp_ratio,
		uint8_t	press_ratio )

Barometer 5 set data ratio function.

This function sets data ratio of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

[in]	ctx	: Click context object. See barometer5_t object definition for detailed explanation.
[in]	temp_ratio	: Determines oversampling ratio for temperature measurement.
[in]	press_ratio	: Determines oversampling ration for pressure measurement.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ barometer5_sw_reset()

err_t barometer5_sw_reset ( barometer5_t * ctx )

Barometer 5 software reset function.

This function performs a software reset of the MS5637 Low Voltage Barometric Pressure Sensor
on the Barometer 5 click board™.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Executes a reset - reload delay of the 3 milliseconds.

Topics

Functions

Detailed Description

Function Documentation

◆ barometer5_calculate_altitude()

◆ barometer5_cfg_setup()

◆ barometer5_default_cfg()

◆ barometer5_generic_read()

◆ barometer5_generic_write()

◆ barometer5_get_calibration_data()

◆ barometer5_get_data()

◆ barometer5_get_pressure()

◆ barometer5_get_raw_data()

◆ barometer5_get_temperature()

◆ barometer5_init()

◆ barometer5_set_command()

◆ barometer5_set_ratio()

◆ barometer5_sw_reset()