pressure12 2.0.0.0

Functions

void pressure12_cfg_setup (pressure12_cfg_t *cfg)
 Config Object Initialization function.
 
err_t pressure12_init (pressure12_t *ctx, pressure12_cfg_t *cfg)
 Initialization function.
 
err_t pressure12_read_pin_adc (pressure12_t *ctx, uint16_t *data_out)
 Generic read function.
 
err_t pressure12_read_pin_voltage (pressure12_t *ctx, float *data_out)
 Generic function for read voltage.
 
err_t pressure12_get_pressure (pressure12_t *ctx, uint16_t *data_out)
 Get pressure function.
 

Detailed Description

Function Documentation

◆ pressure12_cfg_setup()

void pressure12_cfg_setup ( pressure12_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ pressure12_get_pressure()

err_t pressure12_get_pressure ( pressure12_t * ctx,
uint16_t * data_out )

Get pressure function.

Parameters
ctxClick object.
data_outPressure value [mBar].
Returns
See #err_t definition of data type.

@description This function calculates pressure value detected on the Pressure 12 click board.

◆ pressure12_init()

err_t pressure12_init ( pressure12_t * ctx,
pressure12_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.
Returns
See #err_t definition of data type. 0 - Success, (-1) - Error.

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

◆ pressure12_read_pin_adc()

err_t pressure12_read_pin_adc ( pressure12_t * ctx,
uint16_t * data_out )

Generic read function.

Parameters
ctxClick object.
data_outADC value on the pin.
Returns
See #err_t definition of data type.

@description This function reads ADC value on the pin.

◆ pressure12_read_pin_voltage()

err_t pressure12_read_pin_voltage ( pressure12_t * ctx,
float * data_out )

Generic function for read voltage.

Parameters
ctxClick object.
data_outVoltage value on the pin [V].
Returns
See #err_t definition of data type.

@description This function reads voltage value on the pin.