buck14 2.0.0.0
Public function

Functions

void buck14_cfg_setup (buck14_cfg_t *cfg)
 Config Object Initialization function.
 
BUCK14_RETVAL buck14_init (buck14_t *ctx, buck14_cfg_t *cfg)
 Initialization function.
 
void buck14_default_cfg (buck14_t *ctx)
 Click Default Configuration function.
 
void buck14_generic_write (buck14_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void buck14_generic_read (buck14_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
void buck14_power_ctrl (buck14_t *ctx, uint8_t state)
 Set power ctrl function.
 
void buck14_power_sync (buck14_t *ctx, uint8_t state)
 Set power sync function.
 
uint8_t buck14_power_good (buck14_t *ctx)
 Get power good function.
 
uint8_t buck14_salert (buck14_t *ctx)
 Get alert function.
 
uint8_t buck14_check_mfr_id (buck14_t *ctx)
 Fucntion for checking manufacturer id.
 
void buck14_reset (buck14_t *ctx)
 Reset function.
 
uint16_t buc14_read_vout (buck14_t *ctx)
 Read Vout function.
 
uint8_t buc14_write_vout (buck14_t *ctx, float vout)
 Set Vout function.
 

Detailed Description

Function Documentation

◆ buc14_read_vout()

uint16_t buc14_read_vout ( buck14_t * ctx)

Read Vout function.

Parameters
ctxClick object.

@description This function reads output V.

◆ buc14_write_vout()

uint8_t buc14_write_vout ( buck14_t * ctx,
float vout )

Set Vout function.

Parameters
ctxClick object.
voutValue to set on output V.

@description This function sets output V.

◆ buck14_cfg_setup()

void buck14_cfg_setup ( buck14_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.

◆ buck14_check_mfr_id()

uint8_t buck14_check_mfr_id ( buck14_t * ctx)

Fucntion for checking manufacturer id.

Parameters
ctxClick object.

@description This function gets manufacturer id.

◆ buck14_default_cfg()

void buck14_default_cfg ( buck14_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for Buck14 click.

◆ buck14_generic_read()

void buck14_generic_read ( buck14_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ buck14_generic_write()

void buck14_generic_write ( buck14_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ buck14_init()

BUCK14_RETVAL buck14_init ( buck14_t * ctx,
buck14_cfg_t * cfg )

Initialization function.

Parameters
buck14Click object.
cfgClick configuration structure.

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

◆ buck14_power_ctrl()

void buck14_power_ctrl ( buck14_t * ctx,
uint8_t state )

Set power ctrl function.

Parameters
ctxClick object.
stateValue of pin to be set.

@description This function sets state of the power control pin on cs.

◆ buck14_power_good()

uint8_t buck14_power_good ( buck14_t * ctx)

Get power good function.

Parameters
ctxClick object.

@description This function gets state of the power good pin on an.

◆ buck14_power_sync()

void buck14_power_sync ( buck14_t * ctx,
uint8_t state )

Set power sync function.

Parameters
ctxClick object.
stateValue of pin to be set.

@description This function sets state of the sync pin on pwm.

◆ buck14_reset()

void buck14_reset ( buck14_t * ctx)

Reset function.

Parameters
ctxClick object.

@description This function for reseting device power.

◆ buck14_salert()

uint8_t buck14_salert ( buck14_t * ctx)

Get alert function.

Parameters
ctxClick object.

@description This function gets state of the alert pin on int.