pressure13 2.0.0.0
Pressure 13 Click Driver

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

Topics

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

Functions

void pressure13_cfg_setup (pressure13_cfg_t *cfg)
 Pressure 13 configuration object setup function.
 
err_t pressure13_init (pressure13_t *ctx, pressure13_cfg_t *cfg)
 Pressure 13 initialization function.
 
err_t pressure13_read_an_pin_value (pressure13_t *ctx, uint16_t *data_out)
 Pressure 13 read AN pin value function.
 
err_t pressure13_read_an_pin_voltage (pressure13_t *ctx, float *data_out)
 Pressure 13 read AN pin voltage level function.
 
err_t pressure13_get_pressure (pressure13_t *ctx, float *data_out)
 Pressure 13 get pressure function.
 

Detailed Description

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

◆ pressure13_cfg_setup()

void pressure13_cfg_setup ( pressure13_cfg_t * cfg)

Pressure 13 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ pressure13_get_pressure()

err_t pressure13_get_pressure ( pressure13_t * ctx,
float * data_out )

Pressure 13 get pressure function.

This function reads voltage levels and converts them to proportional pressure in mBar.

Parameters
[in]ctx: Click context object. See pressure13_t object definition for detailed explanation.
[out]data_out: Output pressure.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.

◆ pressure13_init()

err_t pressure13_init ( pressure13_t * ctx,
pressure13_cfg_t * cfg )

Pressure 13 initialization function.

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

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

◆ pressure13_read_an_pin_value()

err_t pressure13_read_an_pin_value ( pressure13_t * ctx,
uint16_t * data_out )

Pressure 13 read AN pin value function.

This function reads results of AD conversion of the AN pin.

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

◆ pressure13_read_an_pin_voltage()

err_t pressure13_read_an_pin_voltage ( pressure13_t * ctx,
float * data_out )

Pressure 13 read AN pin voltage level function.

This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.

Parameters
[in]ctx: Click context object. See pressure13_t object definition for detailed explanation.
[out]data_out: Output voltage level of the analog pin [V].
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).