Skip to content

Latest commit

 

History

History
148 lines (98 loc) · 4.45 KB

README.md

File metadata and controls

148 lines (98 loc) · 4.45 KB
Raw

\mainpage Main Page

SPI Isolator Click

SPI Isolator Click carries the ADuM4154 5kV digital isolator optimized for a serial peripheral interface (SPI).

Click Product page

Click library

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

Software Support

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

Standard key functions :

  • Config Object Initialization function.

void spiisolator_cfg_setup ( spiisolator_cfg_t *cfg );

  • Initialization function.

SPIISOLATOR_RETVAL spiisolator_init ( spiisolator_t *ctx, spiisolator_cfg_t *cfg );

Example key functions :

  • Generic transfer function.

void spiisolator_generic_transfer ( spiisolator_t *ctx, spi_master_transfer_data_t *block );

  • Write the byte of data function.

void spiisolator_write_byte ( spiisolator_t *ctx, uint8_t reg_address, uint8_t write_cmd, uint8_t write_data );

  • Read the byte of data function.

uint8_t spiisolator_read_byte ( spiisolator_t *ctx, uint8_t reg_address, uint8_t read_cmd );

Examples Description

TThe Click is designed to run on either 3.3V or 5V power supply. It communicates with the target microcontroller over SPI interface. In this example we have used an 8x8 Click board connected to a SPI Isolator Click board.

The demo application is composed of two sections :

Application Init

Initialization driver enables - SPI, set default configuration, also write log.

void application_init ( void )
{
    log_cfg_t log_cfg;
    spiisolator_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.

    spiisolator_cfg_setup( &cfg );
    SPIISOLATOR_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    spiisolator_init( &spiisolator, &cfg );
    
    c8x8_default_cfg( &spiisolator );

    Delay_100ms( );
}

Application Task

Controls an 8x8 Click board and displays the steps on UART Terminal.

void application_task ( void )
{
    log_info( &logger, "> Display Character ..." );
    c8x8_display_byte( &spiisolator, demo_char );
    Delay_ms ( 1000 );

    log_info( &logger, "> Display String ..." );
    c8x8_display_string( &spiisolator, &demo_string[ 0 ] );
    Delay_ms ( 1000 );

    log_info( &logger, "> Display Image ON ..." );
    c8x8_display_image( &spiisolator, &demo_img_on[ 0 ] );
    Delay_ms ( 500 );

    log_info( &logger, "> Display Image OFF ..." );
    c8x8_display_image( &spiisolator, &demo_img_off[ 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.Spiisolator

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.