lpg  2.0.0.0
Modules | Functions
LPG Click Driver

API for configuring and manipulating LPG Click driver. More...

Modules

 Lpg_map
 

Functions

void lpg_cfg_setup (lpg_cfg_t *cfg)
 LPG configuration object setup function. More...
 
err_t lpg_init (lpg_t *ctx, lpg_cfg_t *cfg)
 LPG initialization function. More...
 
err_t lpg_read_an_pin_value (lpg_t *ctx, uint16_t *data_out)
 LPG read AN pin value function. More...
 
err_t lpg_read_an_pin_voltage (lpg_t *ctx, float *data_out)
 LPG read AN pin voltage level function. More...
 

Detailed Description

API for configuring and manipulating LPG Click driver.

Function Documentation

◆ lpg_cfg_setup()

void lpg_cfg_setup ( lpg_cfg_t cfg)

LPG configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ lpg_init()

err_t lpg_init ( lpg_t ctx,
lpg_cfg_t cfg 
)

LPG initialization function.

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

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

◆ lpg_read_an_pin_value()

err_t lpg_read_an_pin_value ( lpg_t ctx,
uint16_t *  data_out 
)

LPG read AN pin value function.

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

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

◆ lpg_read_an_pin_voltage()

err_t lpg_read_an_pin_voltage ( lpg_t ctx,
float *  data_out 
)

LPG 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 lpg_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).