buck13 2.0.0.0
Public function

Functions

void buck13_cfg_setup (buck13_cfg_t *cfg)
 Config Object Initialization function.
 
BUCK13_RETVAL buck13_init (buck13_t *ctx, buck13_cfg_t *cfg)
 Initialization function.
 
void buck13_default_cfg (buck13_t *ctx)
 Click Default Configuration function.
 
void buck13_generic_transfer (buck13_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function.
 
void buck13_enable (buck13_t *ctx, uint8_t pwr_state)
 Enable Buck13 function.
 
uint16_t buck13_get_adc (buck13_t *ctx)
 Get ADC function.
 
uint16_t buck13_get_voltage (buck13_t *ctx)
 Get voltage function.
 

Detailed Description

Function Documentation

◆ buck13_cfg_setup()

void buck13_cfg_setup ( buck13_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.

◆ buck13_default_cfg()

void buck13_default_cfg ( buck13_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for Buck 13 click.

Note
Default Configuration
Buck mode : Disabled - BUCK13_DISABLE.

◆ buck13_enable()

void buck13_enable ( buck13_t * ctx,
uint8_t pwr_state )

Enable Buck13 function.

Parameters
ctxClick object.
pwr_stateEnable/disable state.

@description Enables/disables Buck13 module.

◆ buck13_generic_transfer()

void buck13_generic_transfer ( buck13_t * ctx,
uint8_t * wr_buf,
uint16_t wr_len,
uint8_t * rd_buf,
uint16_t rd_len )

Generic transfer function.

Parameters
ctxClick object.
wr_bufWrite data buffer
wr_lenNumber of byte in write data buffer
rd_bufRead data buffer
rd_lenNumber of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

◆ buck13_get_adc()

uint16_t buck13_get_adc ( buck13_t * ctx)

Get ADC function.

Parameters
ctxClick object.
Returns
Returns ADC value.
@description Get adc values from the module.

◆ buck13_get_voltage()

uint16_t buck13_get_voltage ( buck13_t * ctx)

Get voltage function.

Parameters
ctxClick object.
Returns
Returns voltage value. @description Get voltage value from the module.

◆ buck13_init()

BUCK13_RETVAL buck13_init ( buck13_t * ctx,
buck13_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.
Returns
Initialization response.
@description This function initializes all necessary pins and peripherals used for this click.