API for configuring and manipulating Pressure 18 Click driver. More...

Topics
	Pressure 18 Registers List
	List of registers of Pressure 18 Click driver.

	Pressure 18 Registers Settings
	Settings for registers of Pressure 18 Click driver.

	Pressure 18 MikroBUS Map
	MikroBUS pin mapping of Pressure 18 Click driver.

Functions
void	pressure18_cfg_setup (pressure18_cfg_t *cfg)
	Pressure 18 configuration object setup function.

void	pressure18_drv_interface_selection (pressure18_cfg_t *cfg, pressure18_drv_t drv_sel)
	Pressure 18 driver interface setup function.

err_t	pressure18_init (pressure18_t ctx, pressure18_cfg_t cfg)
	Pressure 18 initialization function.

err_t	pressure18_default_cfg (pressure18_t *ctx)
	Pressure 18 default configuration function.

err_t	pressure18_generic_write (pressure18_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	Pressure 18 data writing function.

err_t	pressure18_generic_read (pressure18_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	Pressure 18 data reading function.

err_t	pressure18_write_register (pressure18_t *ctx, uint8_t reg, uint8_t data_in)
	Pressure 18 write register function.

err_t	pressure18_read_register (pressure18_t ctx, uint8_t reg, uint8_t data_out)
	Pressure 18 read register function.

err_t	pressure18_check_communication (pressure18_t *ctx)
	Pressure 18 check communication function.

uint8_t	pressure18_get_int_pin (pressure18_t *ctx)
	Pressure 18 get int pin function.

err_t	pressure18_soft_reset (pressure18_t *ctx)
	Pressure 18 soft reset function.

err_t	pressure18_read_data (pressure18_t ctx, float pressure, float *temperature)
	Pressure 18 read data function.

Detailed Description

API for configuring and manipulating Pressure 18 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

◆ pressure18_cfg_setup()

void pressure18_cfg_setup ( pressure18_cfg_t * cfg )

Pressure 18 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ pressure18_check_communication()

err_t pressure18_check_communication ( pressure18_t * ctx )

Pressure 18 check communication function.

This function checks communication by reading and verifying the chip ID value.

Parameters

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

Returns

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

Note: None.

◆ pressure18_default_cfg()

err_t pressure18_default_cfg ( pressure18_t * ctx )

Pressure 18 default configuration function.

This function executes a default configuration of Pressure 18 click board.

Parameters

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

◆ pressure18_drv_interface_selection()

void pressure18_drv_interface_selection	(	pressure18_cfg_t *	cfg,
		pressure18_drv_t	drv_sel )

Pressure 18 driver interface setup function.

This function sets a serial driver interface which will be used further in the click driver.

Parameters

[out]	cfg	: Click configuration structure. See pressure18_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See pressure18_drv_t object definition for detailed explanation.

Returns: Nothing.

Note: This driver selection should be call before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

◆ pressure18_generic_read()

err_t pressure18_generic_read	(	pressure18_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

Pressure 18 data reading function.

This function reads a desired number of data bytes starting from the selected register.

Parameters

[in]	ctx	: Click context object. See pressure18_t object definition for detailed explanation.
[in]	reg	: Start register address.
[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.

◆ pressure18_generic_write()

err_t pressure18_generic_write	(	pressure18_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

Pressure 18 data writing function.

This function writes a desired number of data bytes starting from the selected register.

Parameters

[in]	ctx	: Click context object. See pressure18_t object definition for detailed explanation.
[in]	reg	: Start register address.
[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.

◆ pressure18_get_int_pin()

uint8_t pressure18_get_int_pin ( pressure18_t * ctx )

Pressure 18 get int pin function.

This function returns the INT pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ pressure18_init()

err_t pressure18_init	(	pressure18_t *	ctx,
		pressure18_cfg_t *	cfg )

Pressure 18 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ pressure18_read_data()

err_t pressure18_read_data	(	pressure18_t *	ctx,
		float *	pressure,
		float *	temperature )

Pressure 18 read data function.

This function reads the sensor measurements data: pressure in Pascals and temperature in Celsius.

Parameters

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

Returns

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

Note: None.

◆ pressure18_read_register()

err_t pressure18_read_register	(	pressure18_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

Pressure 18 read register function.

This function reads data from the selected register.

Parameters

[in]	ctx	: Click context object. See pressure18_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

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

Note: None.

◆ pressure18_soft_reset()

err_t pressure18_soft_reset ( pressure18_t * ctx )

Pressure 18 soft reset function.

This function performs the software reset feature.

Parameters

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

Returns

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

Note: None.

◆ pressure18_write_register()

err_t pressure18_write_register	(	pressure18_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

Pressure 18 write register function.

This function writes a desired data to the selected register.

Parameters

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

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ pressure18_cfg_setup()

◆ pressure18_check_communication()

◆ pressure18_default_cfg()

◆ pressure18_drv_interface_selection()

◆ pressure18_generic_read()

◆ pressure18_generic_write()

◆ pressure18_get_int_pin()

◆ pressure18_init()

◆ pressure18_read_data()

◆ pressure18_read_register()

◆ pressure18_soft_reset()

◆ pressure18_write_register()