TOP Contributors

  1. MIKROE (2752 codes)
  2. Alcides Ramos (372 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (118 codes)
  5. Bugz Bensce (90 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (139064 times)
  2. FAT32 Library (71594 times)
  3. Network Ethernet Library (56989 times)
  4. USB Device Library (47330 times)
  5. Network WiFi Library (43006 times)
  6. FT800 Library (42297 times)
  7. GSM click (29777 times)
  8. mikroSDK (27874 times)
  9. PID Library (26858 times)
  10. microSD click (26129 times)
Libstock prefers package manager

Package Manager

We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]

< Back
mikroSDK Library

OSD Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.11

mikroSDK Library: 2.0.0.0

Category: OSD

Downloaded: 209 times

Not followed.

License: MIT license  

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.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "OSD Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "OSD Click" changes.

Do you want to report abuse regarding "OSD Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


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.

osd_click.png

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 :

  • osd_cfg_setup Config Object Initialization function.

    void osd_cfg_setup ( osd_cfg_t *cfg ); 
  • osd_init Initialization function.

    err_t osd_init ( osd_t *ctx, osd_cfg_t *cfg );
  • osd_default_cfg Click Default Configuration function.

    void osd_default_cfg ( osd_t *ctx );

Example key functions :

  • osd_clear_display_memory This function clears display memory.

    void osd_clear_display_memory( osd_t *ctx );
  • osd_insert_custom_char This function writes custom character.

    void osd_insert_custom_char( osd_t *ctx, uint8_t chr_address, uint8_t custom_char );
  • osd_enable_video_buffer This function enables video buffer.

    void osd_enable_video_buffer( osd_t *ctx );

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.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    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 );
    log_info( &logger, " Application Task " );
}

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 )
{
    log_printf( &logger, "\r\n Writing characters on the screen...\r\n" );
    for ( uint8_t cnt = 0; cnt < 30; cnt++ )
    {
        if ( HEADER_TEXT[ cnt ] != ' ' )
        {
            osd_write_character( &osd, 1, cnt, HEADER_TEXT[ cnt ] );
        }

        if ( MESSAGE_TEXT[ cnt ] != ' ' )
        {
            osd_write_character( &osd, 7, cnt, MESSAGE_TEXT[ cnt ] );
        }

        if ( FOOTER_TEXT[ cnt ] != ' ' )
        {
            osd_write_character( &osd, 14, cnt, FOOTER_TEXT[ cnt ] );
        }

        Delay_ms ( 1000 );
    }

    log_printf( &logger, " Clear display\r\n" );
    osd_clears_char_places( &osd, 0, 0, 16, 30 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    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.


ALSO FROM THIS AUTHOR

GPS click - L10 - Examples

0

Simple example which demonstrates usage of the GPS Click board with QUECTEL GPS module.
It displays a map of the world on the TFT and shows the location of the GPS module on it.
Also it displays current coordinates of GPS receiver.

[Learn More]

Compass 6 Click

0

Compass 6 Click is a compact add-on board perfect for implementation in applications such as an electronic compass. This board features the HSCDTD008A, a high-sensitivity geomagnetic sensor from ALPS Alpine.

[Learn More]

LED Flash 3 Click

0

LED Flash 3 Click is a compact add-on board representing a powerful flash/torch solution. This board features the KTD2691, an inductor-less, single-flash LED driver from Kinetic Technologies. It includes one current source that can drive up to 1.5A of LED flash current or up to 376mA of torch current.

[Learn More]