bargraph3 2.0.0.0

Functions

void bargraph3_cfg_setup (bargraph3_cfg_t *cfg)
 Config Object Initialization function.
 
BARGRAPH3_RETVAL bargraph3_init (bargraph3_t *ctx, bargraph3_cfg_t *cfg)
 Initialization function.
 
void bargraph3_default_cfg (bargraph3_t *ctx)
 Click Default Configuration function.
 
void bargraph3_generic_transfer (bargraph3_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function.
 
void bargraph3_enable (bargraph3_t *ctx, uint8_t state)
 Functions for enable the chip.
 
void bargraph3_reset (bargraph3_t *ctx)
 Functions for reset the chip.
 
void bargraph3_set_pwm (bargraph3_t *ctx, uint8_t state)
 Functions for set PWM.
 
void bargraph3_display (bargraph3_t *ctx, uint8_t ctrl, uint8_t dir, uint8_t counter)
 Displays function.
 

Detailed Description

Function Documentation

◆ bargraph3_cfg_setup()

void bargraph3_cfg_setup ( bargraph3_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.

◆ bargraph3_default_cfg()

void bargraph3_default_cfg ( bargraph3_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for BARGRAPH 3 click.

◆ bargraph3_display()

void bargraph3_display ( bargraph3_t * ctx,
uint8_t ctrl,
uint8_t dir,
uint8_t counter )

Displays function.

Parameters
ctxClick object.
ctrlLed control ( INCREASE_LED or CONTROL_ONE_LED ).
dirDisplay direction ( TOP_TO_BOTTOM or BOTTOM_TO_TOP ).
counterBarGraph display counter ( 0..5 ).

@description This function control the displey.

◆ bargraph3_enable()

void bargraph3_enable ( bargraph3_t * ctx,
uint8_t state )

Functions for enable the chip.

Parameters
ctxClick object.
stateState.

@description This function enable the chip.

◆ bargraph3_generic_transfer()

void bargraph3_generic_transfer ( bargraph3_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

◆ bargraph3_init()

BARGRAPH3_RETVAL bargraph3_init ( bargraph3_t * ctx,
bargraph3_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ bargraph3_reset()

void bargraph3_reset ( bargraph3_t * ctx)

Functions for reset the chip.

Parameters
ctxClick object.

@description This function reset the chip.

◆ bargraph3_set_pwm()

void bargraph3_set_pwm ( bargraph3_t * ctx,
uint8_t state )

Functions for set PWM.

Parameters
ctxClick object.
stateState.

@description This function set PWM.