Skip to content

Latest commit

 

History

History
147 lines (100 loc) · 4.72 KB

README.md

File metadata and controls

147 lines (100 loc) · 4.72 KB
Raw

\mainpage Main Page

AlphaNum G click

AlphaNum click is a simple solution for adding 14-segment alphanumeric display to your device. The board carries two TLC5926 16-bit Constant-Current LED sink Drivers

click Product page

Click library

  • Author : Stefan Ilic
  • Date : Jun 2021.
  • Type : SPI type

Software Support

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

Standard key functions :

  • alphanumg_cfg_setup Config Object Initialization function.
void alphanumg_cfg_setup ( alphanumg_cfg_t *cfg );
  • alphanumg_init Initialization function.
err_t alphanumg_init ( alphanumg_t *ctx, alphanumg_cfg_t *cfg );

Example key functions :

  • alphanumg_write_character This function displays characters on the left and right LED segments.
void alphanumg_write_character ( alphanumg_t *ctx, uint8_t left_char, uint8_t right_char );
  • alphanumg_write_number This function displays numbers on the left and right LED segments.
void alphanumg_write_number ( alphanumg_t *ctx, uint8_t left_char, uint8_t right_char );

Example Description

This example showcases the initialization and configuration of the logger and click modules and shows how to display characters and numbers on both LED segments of the click.

The demo application is composed of two sections :

Application Init

This function initializes and configures the logger and click modules.

void application_init ( void ) {
    log_cfg_t log_cfg;  /**< Logger config object. */
    alphanumg_cfg_t alphanumg_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.

    alphanumg_cfg_setup( &alphanumg_cfg );
    ALPHANUMG_MAP_MIKROBUS( alphanumg_cfg, MIKROBUS_1 );
    err_t init_flag  = alphanumg_init( &alphanumg, &alphanumg_cfg );
    if ( SPI_MASTER_ERROR == init_flag ) {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

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

Application Task

This function sets the time interval at which the symbols are displayed on the LED segments and shows a few characters and numbers.

void application_task ( void ) {
    alphanumg_set_display_interval( &alphanumg, 1000 );

    alphanumg_write_character( &alphanumg, 'M', 'E' );
    alphanumg_write_character( &alphanumg, '@', '?' );

    alphanumg_write_number( &alphanumg, 0,  1 );
    alphanumg_write_number( &alphanumg, 1,  2 );
    alphanumg_write_number( &alphanumg, 2,  3 );
    alphanumg_write_number( &alphanumg, 3,  4 );
}

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.AlphaNumG

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.