EERAM 5V click

EERAM 5V click is a static RAM (SRAM) memory click board™ with the unique feature - it has a backup non-volatile memory array, used to store the data from the SRAM array. Since the SRAM is not able to maintain its content after the power loss, the non-volatile EEPROM backup can be a very handy addition that can be used to preserve the data, even after the power loss event. This is a very useful feature when working with critical or sensitive applications. The memory backup procedure can be executed both automatically and manually. When it is set to work in the manual mode, the onboard capacitor will act as a power source with enough power to complete the backup cycle. The power-on backup restore mode is also available, taking only about 25ms to complete.

click Product page

Click library

• Author : Jelena Milosavljevic
• Date : Jun 2021.
• Type : I2C type

Software Support

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

Standard key functions :

• eeram5v_cfg_setup Config Object Initialization function.

  void eeram5v_cfg_setup ( eeram5v_cfg_t *cfg );

• eeram5v_init Initialization function.

  err_t eeram5v_init ( eeram5v_t *ctx, eeram5v_cfg_t *cfg );

Example key functions :

• eeram5v_generic_read This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

  void eeram5v_generic_read ( eeram5v_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );

• eeram5v_status_write Status register contains settings for write protection and auto-store function. Use this function to configure them.

  void eeram5v_status_write ( eeram5v_t *ctx, uint8_t command );

• eeram5v_status_read Returns the state of the status register.

  uint8_t eeram5v_status_read ( eeram5v_t *ctx );

Example Description

This example show using EERAM click to store the data to the SRAM ( static RAM ) memory. The data is read and written by the I2C serial communication bus, and the memory cells are organized into 2048 bytes, each 8bit wide.

The demo application is composed of two sections :

Application Init

EERAM driver initialization.

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

    eeram5v_cfg_setup( &eeram5v_cfg );
    EERAM5V_MAP_MIKROBUS( eeram5v_cfg, MIKROBUS_1 );
    err_t init_flag = eeram5v_init( &eeram5v, &eeram5v_cfg );
    if ( I2C_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

Writing data to click memory and displaying the read data via UART.

void application_task ( void ) {
    log_info( &logger, "Writing MikroE to  SRAM memory, from address 0x0150:" );
    eeram5v_write( &eeram5v, 0x0150, &wr_data, 9 );
    log_info( &logger, "Reading 9 bytes of SRAM memory, from address 0x0150:" );
    eeram5v_read( &eeram5v, 0x0150, &rd_data, 9 );
    log_info( &logger, "Data read: %s", rd_data );
    Delay_ms ( 1000 );
}

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

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.