buck8  2.0.0.0
Functions
Public function

Functions

void buck8_cfg_setup (buck8_cfg_t *cfg)
 Config Object Initialization function. More...
 
BUCK8_RETVAL buck8_init (buck8_t *ctx, buck8_cfg_t *cfg)
 Initialization function. More...
 
void buck8_default_cfg (buck8_t *ctx)
 Click Default Configuration function. More...
 
void buck8_set_power_mode (buck8_t *ctx, uint8_t mode)
 Function settings mode. More...
 
uint8_t buck8_get_state (buck8_t *ctx)
 Function reads state of pin. More...
 

Detailed Description

Function Documentation

◆ buck8_cfg_setup()

void buck8_cfg_setup ( buck8_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.

◆ buck8_default_cfg()

void buck8_default_cfg ( buck8_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

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

Note
Defaut configuration contains:
  • Set power mode (Active)

◆ buck8_get_state()

uint8_t buck8_get_state ( buck8_t ctx)

Function reads state of pin.

Parameters
ctxClick object
Returns
State of pin
  • 1 / if the input voltage is greater than the set maximum range.
  • 0 / if the input voltage is lower than the set maximum range.

◆ buck8_init()

BUCK8_RETVAL buck8_init ( buck8_t ctx,
buck8_cfg_t cfg 
)

Initialization function.

Parameters
buck8Click object.
cfgClick configuration structure.

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

◆ buck8_set_power_mode()

void buck8_set_power_mode ( buck8_t ctx,
uint8_t  mode 
)

Function settings mode.

Parameters
ctxClick object
Note
Options:
  • Active mode
  • Sleep mode