boost11  2.1.0.0
Modules | Functions
Boost 11 Click Driver

API for configuring and manipulating Boost 11 Click driver. More...

Modules

 Boost 11 Registers List
 List of registers of Boost 11 Click driver.
 
 Boost 11 Registers Settings
 Settings for registers of Boost 11 Click driver.
 
 Boost 11 MikroBUS Map
 MikroBUS pin mapping of Boost 11 Click driver.
 

Functions

void boost11_cfg_setup (boost11_cfg_t *cfg)
 Boost 11 configuration object setup function. More...
 
err_t boost11_init (boost11_t *ctx, boost11_cfg_t *cfg)
 Boost 11 initialization function. More...
 
void boost11_active_mode (boost11_t *ctx)
 Boost 11 enable function. More...
 
void boost11_standby_mode (boost11_t *ctx)
 Boost 11 disable function. More...
 
err_t boost11_read_an_pin_value (boost11_t *ctx, uint16_t *data_out)
 Boost 11 read AN pin value function. More...
 
err_t boost11_read_an_pin_voltage (boost11_t *ctx, float *data_out)
 Boost 11 read AN pin voltage level function. More...
 
err_t boost11_set_vref (boost11_t *ctx, float vref)
 Boost 11 set vref function. More...
 

Detailed Description

API for configuring and manipulating Boost 11 Click driver.

Function Documentation

◆ boost11_active_mode()

void boost11_active_mode ( boost11_t ctx)

Boost 11 enable function.

This function activates the boost operating mode.

Parameters
[in]ctx: Click context object. See boost11_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ boost11_cfg_setup()

void boost11_cfg_setup ( boost11_cfg_t cfg)

Boost 11 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ boost11_init()

err_t boost11_init ( boost11_t ctx,
boost11_cfg_t cfg 
)

Boost 11 initialization function.

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

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

◆ boost11_read_an_pin_value()

err_t boost11_read_an_pin_value ( boost11_t ctx,
uint16_t *  data_out 
)

Boost 11 read AN pin value function.

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

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

◆ boost11_read_an_pin_voltage()

err_t boost11_read_an_pin_voltage ( boost11_t ctx,
float *  data_out 
)

Boost 11 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 boost11_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).

◆ boost11_set_vref()

err_t boost11_set_vref ( boost11_t ctx,
float  vref 
)

Boost 11 set vref function.

This function sets the voltage reference for Boost 11 click driver.

Parameters
[in]ctx: Click context object. See boost11_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 boost11_init is 3.3V.

◆ boost11_standby_mode()

void boost11_standby_mode ( boost11_t ctx)

Boost 11 disable function.

This function sets the standby operating mode.

Parameters
[in]ctx: Click context object. See boost11_t object definition for detailed explanation.
Returns
Nothing.
Note
None.