rgbdriver  2.0.0.0
Functions

Functions

void rgbdriver_cfg_setup (rgbdriver_cfg_t *cfg)
 Config Object Initialization function. More...
 
RGBDRIVER_RETVAL rgbdriver_init (rgbdriver_t *ctx, rgbdriver_cfg_t *cfg)
 Initialization function. More...
 
RGBDRIVER_RETVAL rgbdriver_default_cfg (rgbdriver_t *ctx)
 Click Default Configuration function. More...
 
void rgbdriver_generic_write (rgbdriver_t *ctx, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void rgbdriver_set_rgb_color (rgbdriver_t *ctx, uint8_t red, uint8_t green, uint8_t blue)
 Function set RGB color. More...
 
void rgbdriver_set_color (rgbdriver_t *ctx, uint32_t color)
 Function set color. More...
 
void rgbdriver_shut_down (rgbdriver_t *ctx)
 Shut down function. More...
 

Detailed Description

Function Documentation

◆ rgbdriver_cfg_setup()

void rgbdriver_cfg_setup ( rgbdriver_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.

◆ rgbdriver_default_cfg()

RGBDRIVER_RETVAL rgbdriver_default_cfg ( rgbdriver_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for RGB Driver click.

◆ rgbdriver_generic_write()

void rgbdriver_generic_write ( rgbdriver_t ctx,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

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

@description This function writes data to the desired register.

◆ rgbdriver_init()

RGBDRIVER_RETVAL rgbdriver_init ( rgbdriver_t ctx,
rgbdriver_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ rgbdriver_set_color()

void rgbdriver_set_color ( rgbdriver_t ctx,
uint32_t  color 
)

Function set color.

Parameters
ctxClick object.
colorRed led.

@description This function sets the color.

Note
Set color: RED, GREEN, BLUE, YELLOW, WHITE, PURPLE, ORANGE and OFF.

◆ rgbdriver_set_rgb_color()

void rgbdriver_set_rgb_color ( rgbdriver_t ctx,
uint8_t  red,
uint8_t  green,
uint8_t  blue 
)

Function set RGB color.

Parameters
ctxClick object.
redRed led.
greenGreen led.
blueBlue led.

@description This function sets the color of the rgb LEDs through the parameters for red, green and blue.

◆ rgbdriver_shut_down()

void rgbdriver_shut_down ( rgbdriver_t ctx)

Shut down function.

Parameters
ctxClick object.

@description This function shut down device.