osd  2.0.0.0
Main Page

OSD click

OSD Click features MAX7456 single-channel monochrome OSD module with integrated EEPROM memory as well as two RCA sockets. It is used to create on-screen menus and other video overlays, such as custom graphics, company logo, time and date using 256 user-programmable characters or pictographs.

click Product page


Click library

  • Author : MikroE Team
  • Date : Jan 2020.
  • Type : SPI type

Software Support

We provide a library for the OSD 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 OSD Click driver.

Standard key functions :

  • Config Object Initialization function.

    void osd_cfg_setup ( osd_cfg_t *cfg );

  • Initialization function.

    OSD_RETVAL osd_init ( osd_t *ctx, osd_cfg_t *cfg );

  • Click Default Configuration function.

    void osd_default_cfg ( osd_t *ctx );

Example key functions :

Examples Description

This demo performs basic OSD Click functionality - write text on screen.

The demo application is composed of two sections :

Application Init

Device initialization.

void application_init ( void )
{
log_cfg_t log_cfg;
osd_cfg_t cfg;
// Logger initialization.
log_cfg.level = LOG_LEVEL_DEBUG;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
osd_cfg_setup( &cfg );
OSD_MAP_MIKROBUS( cfg, MIKROBUS_1 );
osd_init( &osd, &cfg );
osd_default_cfg( &osd );
osd_clears_char_places( &osd, 0, 0, 16, 30 );
}

Application Task

Write text on the screen, write character per 1 second in the first, seventh and fifteenth row of the screen.

void application_task ( void )
{
for ( cnt = 0; cnt < 30; cnt++ )
{
if ( HEADER_TEXT[ cnt ] != ' ' )
{
}
if ( MESSAGE_TEXT[ cnt ] != ' ' )
{
}
if ( FOOTER_TEXT[ cnt ] != ' ' )
{
}
Delay_ms( 1000 );
}
osd_clears_char_places( &osd, 0, 0, 16, 30 );
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.OSD

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.


OSD_MAP_MIKROBUS
#define OSD_MAP_MIKROBUS(cfg, mikrobus)
Definition: osd.h:55
osd_cfg_setup
void osd_cfg_setup(osd_cfg_t *cfg)
Config Object Initialization function.
MESSAGE_TEXT
const uint8_t MESSAGE_TEXT[30]
Definition: main.c:36
HEADER_TEXT
const uint8_t HEADER_TEXT[30]
Definition: main.c:34
osd_init
OSD_RETVAL osd_init(osd_t *ctx, osd_cfg_t *cfg)
Initialization function.
osd_clears_char_places
void osd_clears_char_places(osd_t *ctx, uint8_t start_x, uint8_t start_y, uint8_t end_x, uint8_t end_y)
Clears the character places function.
application_task
void application_task(void)
Definition: main.c:66
cnt
uint8_t cnt
Definition: main.c:33
osd_write_character
void osd_write_character(osd_t *ctx, uint8_t line_pos, uint8_t row_pos, uint8_t symbol)
Write character by position function.
osd_cfg_t
Click configuration structure definition.
Definition: osd.h:156
FOOTER_TEXT
const uint8_t FOOTER_TEXT[30]
Definition: main.c:38
application_init
void application_init(void)
Definition: main.c:43
osd_default_cfg
void osd_default_cfg(osd_t *ctx)
Click Default Configuration function.