stepup  2.0.0.0
Functions
Public function

Functions

void stepup_cfg_setup (stepup_cfg_t *cfg)
 Config Object Initialization function. More...
 
STEPUP_RETVAL stepup_init (stepup_t *ctx, stepup_cfg_t *cfg)
 Initialization function. More...
 
void stepup_default_cfg (stepup_t *ctx, uint16_t out_value)
 Click Default Configuration function. More...
 
void stepup_generic_transfer (stepup_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
void stepup_mod_set (stepup_t *ctx, uint8_t pin_state)
 Mod Pin set function. More...
 
void stepup_en_set (stepup_t *ctx, uint8_t pin_state)
 En Pin set function. More...
 
uint8_t stepup_set_config (stepup_t *ctx, uint16_t config)
 En Pin set function. More...
 
uint8_t stepup_set_out (stepup_t *ctx, uint16_t out_value)
 Setting output value. More...
 
float stepup_get_percent (uint16_t out_value)
 Calculate ouput value in percent. More...
 

Detailed Description

Function Documentation

◆ stepup_cfg_setup()

void stepup_cfg_setup ( stepup_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ stepup_default_cfg()

void stepup_default_cfg ( stepup_t ctx,
uint16_t  out_value 
)

Click Default Configuration function.

Parameters
ctxClick object.
out_valueOutput value (range : 0 to 4095)

This function executes default configuration for Step Up click.

◆ stepup_en_set()

void stepup_en_set ( stepup_t ctx,
uint8_t  pin_state 
)

En Pin set function.

Parameters
ctxClick object.
pin_stateEN pin state (0 for LOW and 1 for HIGH)

This function sets the EN pin state

◆ stepup_generic_transfer()

void stepup_generic_transfer ( stepup_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

Generic SPI transfer, for sending and receiving packages

◆ stepup_get_percent()

float stepup_get_percent ( uint16_t  out_value)

Calculate ouput value in percent.

Parameters
ctxClick object.
out_valueOutput value (range : 0 to 4095)
Returns
output value in percent (range : 0% to 100%)

This function calculates ouput value in percent

◆ stepup_init()

STEPUP_RETVAL stepup_init ( stepup_t ctx,
stepup_cfg_t cfg 
)

Initialization function.

Parameters
stepupClick object.
cfgClick configuration structure.

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

◆ stepup_mod_set()

void stepup_mod_set ( stepup_t ctx,
uint8_t  pin_state 
)

Mod Pin set function.

Parameters
ctxClick object.
pin_stateMOD pin state (0 for LOW and 1 for HIGH)

This function sets the MOD pin state

◆ stepup_set_config()

uint8_t stepup_set_config ( stepup_t ctx,
uint16_t  config 
)

En Pin set function.

Parameters
ctxClick object.
configCommand word configuration bits
Returns
0 for correct input value
1 for incorrect input value

This function sets first 4 bits in command word

◆ stepup_set_out()

uint8_t stepup_set_out ( stepup_t ctx,
uint16_t  out_value 
)

Setting output value.

Parameters
ctxClick object.
out_valueOutput value (range : 0 to 4095)
Returns
0 for correct input value
1 for incorrect input value

This function sets output value

Note
Value of 0 means that output is at 100%, value of 4095 means that output is at 0%