matrixrgb  2.0.0.0
Main Page

Matrix RGB click

Matrix RGB click is a mikroBUS™ add-on board powered by a 32-bit FT900 MCU designed specifically for powering 16x32 RGB LED matrices.

click Product page


Click library

  • Author : MikroE Team
  • Date : dec 2019.
  • Type : SPI type

Software Support

We provide a library for the MatrixRGB Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for MatrixRGB Click driver.

Standard key functions :

  • Config Object Initialization function.

    void matrixrgb_cfg_setup ( matrixrgb_cfg_t *cfg );

  • Initialization function.

    MATRIXRGB_RETVAL matrixrgb_init ( matrixrgb_t *ctx, matrixrgb_cfg_t *cfg );

  • Click Pattern Settings ( Default Configuration ) function.

    void matrixrgb_pattern_settings ( matrixrgb_t *ctx, uint8_t pattern_type, uint16_t pattern_delay_us );

Example key functions :

  • Set Power

    void matrixrgb_set_power ( matrixrgb_t *ctx, uint8_t power_state );

  • Set Brightness

    void matrixrgb_set_brightness ( matrixrgb_t *ctx, uint8_t brightness );

  • Write Pixel

    uint8_t matrixrgb_write_pixel ( matrixrgb_t *ctx, uint16_t x, uint16_t y, uint16_t color );

Examples Description

This application is used for powering 16x32 RGB LED matrices.

The demo application is composed of two sections :

Application Init

Initializes driver, reset device and initializes firmware depend on pattern used alongside with fonts

void application_init ( void )
{
log_cfg_t log_cfg;
matrixrgb_font_t font_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
MATRIXRGB_MAP_MIKROBUS( cfg, MIKROBUS_1 );
matrixrgb_init( &matrixrgb, &cfg );
matrixrgb_device_reset( &matrixrgb );
matrixrgb_set_power( &matrixrgb, 1 );
Delay_ms ( 1000 );
font_cfg.p_font = Arial9x9;
font_cfg.color = 0xFFFF;
matrixrgb_set_font ( &matrixrgb, &font_cfg );
matrixrgb_fill_screen( &matrixrgb, 0xFFFF );
Delay_ms ( 1000 );
}

Application Task

Test of panel brightnes, draws red cross on the panel using pixel write function, writes text on panel using write text function and finaly displays image on the panel.

{
uint16_t test;
// Brightness Test
for ( test = 5; test < 50; test++ )
{
matrixrgb_set_brightness( &matrixrgb, test );
Delay_ms ( 50 );
}
for ( test = 50; test > 5; test-- )
{
matrixrgb_set_brightness( &matrixrgb, test );
Delay_ms ( 50 );
}
// Pixel Write Test
matrixrgb_fill_screen( &matrixrgb, 0x0000 );
for ( test = 0; test < 32; test++ )
{
matrixrgb_write_pixel( &matrixrgb, test, test, 0xF100 );
Delay_ms ( 100 );
}
for ( test = 32; test > 0; test-- )
{
matrixrgb_write_pixel( &matrixrgb, 32 - test, test, 0xF100 );
Delay_ms ( 100 );
}
//Text Write Test
matrixrgb_fill_screen( &matrixrgb, 0x0000 );
matrixrgb_write_text( &matrixrgb, "RGB", 6, 5 );
matrixrgb_write_text( &matrixrgb, "Demo", 4, 20 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
// Image Test
matrixrgb_draw_image( &matrixrgb, &mikroe_logo_32x32_bmp[ 0 ] );
Delay_ms ( 1000 );
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.MatrixRGB

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


matrixrgb_font_t::color
uint16_t color
Definition: matrixrgb.h:133
matrixrgb_write_pixel
uint8_t matrixrgb_write_pixel(matrixrgb_t *ctx, uint16_t x, uint16_t y, uint16_t color)
Write Pixel.
MATRIXRGB_MAP_MIKROBUS
#define MATRIXRGB_MAP_MIKROBUS(cfg, mikrobus)
Definition: matrixrgb.h:68
matrixrgb_draw_image
void matrixrgb_draw_image(matrixrgb_t *ctx, const uint8_t *device_img)
Draw Image on Panel.
matrixrgb_pattern_settings
void matrixrgb_pattern_settings(matrixrgb_t *ctx, uint8_t pattern_type, uint16_t pattern_delay_us)
Click Pattern settings ( Default Configuration ) function.
MATRIXRGB_FONT_HORIZONTAL
#define MATRIXRGB_FONT_HORIZONTAL
Definition: matrixrgb.h:92
matrixrgb_device_reset
void matrixrgb_device_reset(matrixrgb_t *ctx)
Hard reset of the Matrix RGB click.
matrixrgb_set_font
void matrixrgb_set_font(matrixrgb_t *ctx, matrixrgb_font_t *font_cfg)
Set Font Function.
matrixrgb_set_brightness
void matrixrgb_set_brightness(matrixrgb_t *ctx, uint8_t brightness)
Set Brightness.
matrixrgb_set_power
void matrixrgb_set_power(matrixrgb_t *ctx, uint8_t power_state)
Set Power.
matrixrgb_init
MATRIXRGB_RETVAL matrixrgb_init(matrixrgb_t *ctx, matrixrgb_cfg_t *cfg)
Initialization function.
MATRIXRGB_PATTERN_1_MAP_6MM
#define MATRIXRGB_PATTERN_1_MAP_6MM
Definition: matrixrgb.h:102
application_task
void application_task()
Definition: main.c:78
matrixrgb_font_t::orientation
uint8_t orientation
Definition: matrixrgb.h:134
matrixrgb_cfg_t
Click configuration structure definition.
Definition: matrixrgb.h:183
matrixrgb_write_text
uint8_t matrixrgb_write_text(matrixrgb_t *ctx, char *text, uint16_t x, uint16_t y)
Writes Text.
application_init
void application_init(void)
Definition: main.c:37
matrixrgb_font_t
Click ctx object definition.
Definition: matrixrgb.h:131
matrixrgb_fill_screen
void matrixrgb_fill_screen(matrixrgb_t *ctx, uint16_t color)
Fill Screen.
matrixrgb_cfg_setup
void matrixrgb_cfg_setup(matrixrgb_cfg_t *cfg)
Config Object Initialization function.
matrixrgb_font_t::p_font
uint8_t * p_font
Definition: matrixrgb.h:132