Skip to content

Latest commit

 

History

History
205 lines (151 loc) · 6.23 KB

README.md

File metadata and controls

205 lines (151 loc) · 6.23 KB
Raw

\mainpage Main Page

OLED B Click

OLED B Click carries a 96 x 39px blue monochrome passive matrix OLED display. The display is bright, has a wide viewing angle and low power consumption.

Click Product page

Click library

  • Author : MikroE Team
  • Date : Feb 2023.
  • Type : I2C/SPI type

Software Support

We provide a library for the OLEDB 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 from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for OLEDB Click driver.

Standard key functions :

  • oledb_cfg_setup Config Object Initialization function.
void oledb_cfg_setup ( oledb_cfg_t *cfg );
  • oledb_init Initialization function.
err_t oledb_init ( oledb_t *ctx, oledb_cfg_t *cfg );

Example key functions :

  • oledb_display_picture This function allows user to display picture for on the screen.
void oledb_display_picture( oledb_t *ctx, oledb_resources_t *pic );
  • oledb_clear_display This function clears SSD1306 controller display.
void oledb_clear_display( oledb_t *ctx );
  • oledb_write_string This function writes a text string from the selected position in a 5x7 or 6x8 font size.
void oledb_write_string( oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t *data_in );

Example Description

This example demonstrates the use (control) of the OLED B display.

The demo application is composed of two sections :

Application Init

Configures the microcontroller for communication and initializes the Click board to default state.

void application_init ( void ) {
    log_cfg_t log_cfg;  /**< Logger config object. */
    oledb_cfg_t oledb_cfg;  /**< Click config object. */

    /** 
     * 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.
    oledb_cfg_setup( &oledb_cfg );
    OLEDB_MAP_MIKROBUS( oledb_cfg, MIKROBUS_1 );
    err_t init_flag  = oledb_init( &oledb, &oledb_cfg );
    if ( ( I2C_MASTER_ERROR == init_flag ) || ( SPI_MASTER_ERROR == init_flag ) ) 
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );
        for ( ; ; );
    }

    oledb_default_cfg ( &oledb );
    log_info( &logger, " Application Task " );
}

Application Task

This section contains the main program that is executed showing a practical example on how to use the implemented functions.

void application_task ( void ) {
    oledb_clear_display( &oledb );
    Delay_ms ( 100 );

    oledb_write_string( &oledb, OLEDB_FONT_6X8, 0, 0, "     MIKROE     " );
    oledb_write_string( &oledb, OLEDB_FONT_6X8, 1, 0, "  OLED B Click  " );
    oledb_write_string( &oledb, OLEDB_FONT_6X8, 2, 0, "  with SSD1306  " );
    oledb_write_string( &oledb, OLEDB_FONT_6X8, 3, 0, "   controller   " );
    oledb_write_string( &oledb, OLEDB_FONT_6X8, 4, 0, "  TEST EXAMPLE  " );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    
    oledb_write_string( &oledb, OLEDB_FONT_6X8, 0, 0, " TEXT SCROLL EXAMPLE " );
    oledb_write_string( &oledb, OLEDB_FONT_6X8, 4, 0, " TEXT SCROLL EXAMPLE " );
    Delay_ms ( 1000 );
    
    oledb_scroll_right( &oledb, 4, 0 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    oledb_stop_scroll( &oledb );
    
    oledb_clear_display( &oledb );
    Delay_ms ( 100 );
    
    oledb_display_picture( &oledb, oledb_img_mikroe );
    Delay_ms ( 500 );
    oledb_send_cmd( &oledb, OLEDB_INVERTDISPLAY );
    Delay_ms ( 500 );
    oledb_send_cmd( &oledb, OLEDB_NORMALDISPLAY );
    Delay_ms ( 500 );
    oledb_send_cmd( &oledb, OLEDB_INVERTDISPLAY );
    Delay_ms ( 500 );
    oledb_send_cmd( &oledb, OLEDB_NORMALDISPLAY );
    Delay_ms ( 300 );

    for ( uint8_t contrast = 0xAF; contrast > 0x00; contrast-- ) 
    {
        oledb_set_contrast( &oledb, contrast );
        Delay_ms ( 5 );
    }

    for ( uint8_t contrast = 0x00; contrast < 0xAF; contrast++ ) 
    {
        oledb_set_contrast( &oledb, contrast );
        Delay_ms ( 5 );
    }

    oledb_scroll_left( &oledb, 0, 4 );
    Delay_ms ( 1000 );
    oledb_stop_scroll( &oledb );

    oledb_scroll_right( &oledb, 0, 4 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    oledb_stop_scroll( &oledb );
    
    oledb_scroll_left( &oledb, 0, 4 );
    Delay_ms ( 1000 );
    oledb_stop_scroll( &oledb );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.OLEDB

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. UART terminal is available in all MikroElektronika compilers.