pressure19 2.0.0.0
Pressure 19 Click Driver

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

Topics

 Pressure 19 Registers Settings
 Settings for registers of Pressure 19 Click driver.
 
 Pressure 19 MikroBUS Map
 MikroBUS pin mapping of Pressure 19 Click driver.
 

Functions

void pressure19_cfg_setup (pressure19_cfg_t *cfg)
 Pressure 19 configuration object setup function.
 
void pressure19_drv_interface_selection (pressure19_cfg_t *cfg, pressure19_drv_t drv_sel)
 Pressure 19 driver interface setup function.
 
err_t pressure19_init (pressure19_t *ctx, pressure19_cfg_t *cfg)
 Pressure 19 initialization function.
 
err_t pressure19_read_raw_adc (pressure19_t *ctx, uint16_t *raw_adc)
 Pressure 19 read raw ADC value function.
 
err_t pressure19_read_voltage (pressure19_t *ctx, float *voltage)
 Pressure 19 read voltage level function.
 
err_t pressure19_set_vref (pressure19_t *ctx, float vref)
 Pressure 19 set vref function.
 
err_t pressure19_get_pressure (pressure19_t *ctx, uint16_t *pressure)
 Pressure 19 get pressure function.
 

Detailed Description

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

◆ pressure19_cfg_setup()

void pressure19_cfg_setup ( pressure19_cfg_t * cfg)

Pressure 19 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See pressure19_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ pressure19_drv_interface_selection()

void pressure19_drv_interface_selection ( pressure19_cfg_t * cfg,
pressure19_drv_t drv_sel )

Pressure 19 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 pressure19_cfg_t object definition for detailed explanation.
[in]drv_sel: Driver interface selection. See pressure19_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.

◆ pressure19_get_pressure()

err_t pressure19_get_pressure ( pressure19_t * ctx,
uint16_t * pressure )

Pressure 19 get pressure function.

This function reads the output voltage and converts it to pressure in mBar.

Parameters
[in]ctx: Click context object. See pressure19_t object definition for detailed explanation.
[out]pressure: Pressure [mBar].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered reference voltage. On 3V3 systems the maximal pressure read is about 2110 mBar.

◆ pressure19_init()

err_t pressure19_init ( pressure19_t * ctx,
pressure19_cfg_t * cfg )

Pressure 19 initialization function.

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

Parameters
[out]ctx: Click context object. See pressure19_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See pressure19_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ pressure19_read_raw_adc()

err_t pressure19_read_raw_adc ( pressure19_t * ctx,
uint16_t * raw_adc )

Pressure 19 read raw ADC value function.

This function reads raw ADC value.

Parameters
[in]ctx: Click context object. See pressure19_t object definition for detailed explanation.
[out]raw_adc: Output ADC result.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ pressure19_read_voltage()

err_t pressure19_read_voltage ( pressure19_t * ctx,
float * voltage )

Pressure 19 read voltage level function.

This function reads raw ADC value and converts it to proportional voltage level.

Parameters
[in]ctx: Click context object. See pressure19_t object definition for detailed explanation.
[out]voltage: Output voltage level [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered reference voltage.

◆ pressure19_set_vref()

err_t pressure19_set_vref ( pressure19_t * ctx,
float vref )

Pressure 19 set vref function.

This function sets the voltage reference for Pressure 19 click driver.

Parameters
[in]ctx: Click context object. See pressure19_t object definition for detailed explanation.
[in]vref: Reference voltage (volts).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The default voltage reference set with pressure19_init is 3.3V.