smartbuck4 2.1.0.0
Topics | Functions
Smart Buck 4 Click Driver

API for configuring and manipulating Smart Buck 4 Click driver. More...

Topics

 Smart Buck 4 Registers List
 List of registers of Smart Buck 4 Click driver.
 
 Smart Buck 4 Registers Settings
 Settings for registers of Smart Buck 4 Click driver.
 
 Smart Buck 4 MikroBUS Map
 MikroBUS pin mapping of Smart Buck 4 Click driver.
 

Functions

void smartbuck4_cfg_setup (smartbuck4_cfg_t *cfg)
 Smart Buck 4 configuration object setup function.
 
err_t smartbuck4_init (smartbuck4_t *ctx, smartbuck4_cfg_t *cfg)
 Smart Buck 4 initialization function.
 
err_t smartbuck4_default_cfg (smartbuck4_t *ctx)
 Smart Buck 4 default configuration function.
 
void smartbuck4_set_r40_out (smartbuck4_t *ctx, uint8_t out_level)
 Smart Buck 4 set R40 pin state function.
 
void smartbuck4_en_r40_reg (smartbuck4_t *ctx)
 Smart Buck 4 enable 400A regulator function.
 
void smartbuck4_dis_r40_reg (smartbuck4_t *ctx)
 Smart Buck 4 disable 400A regulator function.
 
void smartbuck4_set_r60_out (smartbuck4_t *ctx, uint8_t out_level)
 Smart Buck 4 set R60 pin state function.
 
void smartbuck4_en_r60_reg (smartbuck4_t *ctx)
 Smart Buck 4 enable 600A regulator function.
 
void smartbuck4_dis_r60_reg (smartbuck4_t *ctx)
 Smart Buck 4 disable 600A regulator function.
 
err_t smartbuck4_send_command (smartbuck4_t *ctx, uint8_t addr, uint8_t data_in)
 Smart Buck 4 send command function.
 
err_t smartbuck4_disable_regulators (smartbuck4_t *ctx)
 Smart Buck 4 disable regulators function.
 

Detailed Description

API for configuring and manipulating Smart Buck 4 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ smartbuck4_cfg_setup()

void smartbuck4_cfg_setup ( smartbuck4_cfg_t * cfg)

Smart Buck 4 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ smartbuck4_default_cfg()

err_t smartbuck4_default_cfg ( smartbuck4_t * ctx)

Smart Buck 4 default configuration function.

This function executes a default configuration of Smart Buck 4 click board.

Parameters
[in]ctx: Click context object. See smartbuck4_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ smartbuck4_dis_r40_reg()

void smartbuck4_dis_r40_reg ( smartbuck4_t * ctx)

Smart Buck 4 disable 400A regulator function.

This function is used to disable 400A regulator of Smart Buck 4 click board.

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

◆ smartbuck4_dis_r60_reg()

void smartbuck4_dis_r60_reg ( smartbuck4_t * ctx)

Smart Buck 4 disable 600A regulator function.

This function is used to disable 600A regulator of Smart Buck 4 click board.

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

◆ smartbuck4_disable_regulators()

err_t smartbuck4_disable_regulators ( smartbuck4_t * ctx)

Smart Buck 4 disable regulators function.

This function is used to disable regulator output of Smart Buck 4 click board.

Parameters
[in]ctx: Click context object. See smartbuck4_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ smartbuck4_en_r40_reg()

void smartbuck4_en_r40_reg ( smartbuck4_t * ctx)

Smart Buck 4 enable 400A regulator function.

This function is used to enable 400A regulator of Smart Buck 4 click board.

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

◆ smartbuck4_en_r60_reg()

void smartbuck4_en_r60_reg ( smartbuck4_t * ctx)

Smart Buck 4 enable 600A regulator function.

This function is used to enable 600A regulator of Smart Buck 4 click board.

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

◆ smartbuck4_init()

err_t smartbuck4_init ( smartbuck4_t * ctx,
smartbuck4_cfg_t * cfg )

Smart Buck 4 initialization function.

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

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

◆ smartbuck4_send_command()

err_t smartbuck4_send_command ( smartbuck4_t * ctx,
uint8_t addr,
uint8_t data_in )

Smart Buck 4 send command function.

This function is used to send a specific command of Smart Buck 4 click board.

Parameters
[in]ctx: Click context object. See smartbuck4_t object definition for detailed explanation.
[in]addr: Specific sub-address.
[in]data_in: Data to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ smartbuck4_set_r40_out()

void smartbuck4_set_r40_out ( smartbuck4_t * ctx,
uint8_t out_level )

Smart Buck 4 set R40 pin state function.

This function is used to set R40 pin value of Smart Buck 4 click board.

Parameters
[in]ctx: Click context object. See smartbuck4_t object definition for detailed explanation.
[in]out_level: Pin output value.
Returns
Nothing.
Note
None.

◆ smartbuck4_set_r60_out()

void smartbuck4_set_r60_out ( smartbuck4_t * ctx,
uint8_t out_level )

Smart Buck 4 set R60 pin state function.

This function is used to set R60 pin value of Smart Buck 4 click board.

Parameters
[in]ctx: Click context object. See smartbuck4_t object definition for detailed explanation.
[in]out_level: Pin output value.
Returns
Nothing.
Note
None.