c10x10rgb 2.0.0.0
Public function

Functions

void c10x10rgb_cfg_setup (c10x10rgb_cfg_t *cfg, drv_logic_t logic_zero, drv_logic_t logic_one)
 Config Object Initialization function.
 
C10X10RGB_RETVAL c10x10rgb_init (c10x10rgb_t *ctx, c10x10rgb_cfg_t *cfg)
 Initialization function.
 
void c10x10rgb_write_data (c10x10rgb_t *ctx, uint32_t w_data)
 Write data function.
 
void c10x10rgb_fill_screen (c10x10rgb_t *ctx, uint32_t screen_color)
 Fill screen function.
 
uint32_t c10x10rgb_make_color (uint8_t red, uint8_t green, uint8_t blue, uint8_t brightness)
 Make color function.
 
void c10x10rgb_display_image (c10x10rgb_t *ctx, const uint32_t *demo_image)
 Display image function.
 
void c10x10rgb_display_byte (c10x10rgb_t *ctx, c10x10rgb_byte_t *data_obj)
 Display byte function.
 
void c10x10rgb_display_string (c10x10rgb_t *ctx, c10x10rgb_byte_t *data_obj, uint8_t len, uint16_t speed_ms)
 Display string function.
 
void c10x10rgb_demo_rainbow (c10x10rgb_t *ctx, uint8_t brightness, uint16_t speed_ms)
 Demo rainbow function.
 

Detailed Description

Function Documentation

◆ c10x10rgb_cfg_setup()

void c10x10rgb_cfg_setup ( c10x10rgb_cfg_t * cfg,
drv_logic_t logic_zero,
drv_logic_t logic_one )

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.

◆ c10x10rgb_demo_rainbow()

void c10x10rgb_demo_rainbow ( c10x10rgb_t * ctx,
uint8_t brightness,
uint16_t speed_ms )

Demo rainbow function.

Parameters
c10x10rgbClick object.
brightnessBrightness value.
speed_msMillisecond speed value.

@description This function displays a "rainbow" on the display.

◆ c10x10rgb_display_byte()

void c10x10rgb_display_byte ( c10x10rgb_t * ctx,
c10x10rgb_byte_t * data_obj )

Display byte function.

Parameters
c10x10rgbClick object.
data_objData object pointer.

@description This function displays the specified byte.

◆ c10x10rgb_display_image()

void c10x10rgb_display_image ( c10x10rgb_t * ctx,
const uint32_t * demo_image )

Display image function.

Parameters
c10x10rgbClick object.
demo_imageDemo image address.

@description This function displays an image from the specified demo_image address.

◆ c10x10rgb_display_string()

void c10x10rgb_display_string ( c10x10rgb_t * ctx,
c10x10rgb_byte_t * data_obj,
uint8_t len,
uint16_t speed_ms )

Display string function.

Parameters
c10x10rgbClick object.
data_objData object pointer.
lenLength value (up to 18 characters).
speed_msMillisecond speed value.

@description This function displays the specified string.

◆ c10x10rgb_fill_screen()

void c10x10rgb_fill_screen ( c10x10rgb_t * ctx,
uint32_t screen_color )

Fill screen function.

Parameters
c10x10rgbClick object.
screen_colorScreen color value.

@description This function fills the whole display with the value: { screen_color }.

◆ c10x10rgb_init()

C10X10RGB_RETVAL c10x10rgb_init ( c10x10rgb_t * ctx,
c10x10rgb_cfg_t * cfg )

Initialization function.

Parameters
c10x10rgbClick object.
cfgClick configuration structure.

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

◆ c10x10rgb_make_color()

uint32_t c10x10rgb_make_color ( uint8_t red,
uint8_t green,
uint8_t blue,
uint8_t brightness )

Make color function.

Parameters
redRed color value.
greenGreen color value.
blueBlue color value.
brightnessBrightness value.

@description This function creates a color based on the input color and brightness parameters.

◆ c10x10rgb_write_data()

void c10x10rgb_write_data ( c10x10rgb_t * ctx,
uint32_t w_data )

Write data function.

Parameters
c10x10rgbClick object.
w_dataWrite data.

@description This function writes data to the click module using the GPIO protocol.