eeram2 2.0.0.0
Main Page

EERAM 2 click

EERAM 2 Click is a standalone serial SRAM memory that includes shadow non-volatile backup. EERAM uses a small external capacitor to provide the energy needed to move the contents of the SRAM to the non-volatile cells when system power is lost.

click Product page


Click library

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

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    ‍void eeram2_cfg_setup ( eeram2_cfg_t *cfg );

    - Initialization function.

    ‍EERAM2_RETVAL eeram2_init ( eeram2_t *ctx, eeram2_cfg_t *cfg );

    Example key functions :

  • Set On-hold status function.

    ‍void eeram2_set_on_hold_status ( eeram2_t *ctx, uint8_t en_hold );

    - Set command function.

    ‍void eeram2_set_command ( eeram2_t *ctx, uint8_t command );

  • Set write status function.

    ‍void eeram2_set_write_status ( eeram2_t *ctx, uint8_t en_write );

    Examples Description

‍This example demonstrates the use of EERAM 2 click board.

The demo application is composed of two sections :

Application Init

‍Initialization driver enables - SPI.

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
EERAM2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
eeram2_init( &eeram2, &cfg );
Delay_ms ( 100 );
Delay_ms ( 100 );
}
#define EERAM2_HOLD_DISABLE
Definition eeram2.h:138
#define EERAM2_WRITE_ENABLE
Definition eeram2.h:147
#define EERAM2_MAP_MIKROBUS(cfg, mikrobus)
Definition eeram2.h:67
void eeram2_cfg_setup(eeram2_cfg_t *cfg)
Config Object Initialization function.
void eeram2_set_on_hold_status(eeram2_t *ctx, uint8_t en_hold)
Set On-hold status function.
EERAM2_RETVAL eeram2_init(eeram2_t *ctx, eeram2_cfg_t *cfg)
Initialization function.
void eeram2_set_write_status(eeram2_t *ctx, uint8_t en_write)
Set write status function.
void application_init(void)
Definition main.c:37
Click configuration structure definition.
Definition eeram2.h:205

Application Task

‍Writes a desired number of bytes to the memory and then verifies if it is written correctly by reading from the same memory location and displaying its content on the USB UART.

void application_task ( void )
{
check_status = eeram2_write_continuous( &eeram2, 0x00543210, &demo_data[ 0 ], 9 );
if ( check_status == EERAM2_ERROR )
{
log_printf( &logger, " ERROR Writing \r\n" );
log_printf( &logger, "--------------------\r\n" );
for ( ; ; );
}
log_printf( &logger, " Writing... \r\n" );
log_printf( &logger, "--------------------\r\n" );
Delay_ms ( 100 );
check_status = eeram2_read_continuous( &eeram2, 0x00543210, &read_data[ 0 ], 9 );
if ( check_status == EERAM2_ERROR )
{
log_printf( &logger, " Reading ERROR \r\n" );
log_printf( &logger, "--------------------\r\n" );
for ( ; ; );
}
log_printf( &logger, " Read data : %s", read_data );
log_printf( &logger, "--------------------\r\n" );
Delay_ms ( 1000 );
}
#define EERAM2_ERROR
Definition eeram2.h:166
uint8_t eeram2_read_continuous(eeram2_t *ctx, uint32_t reg, uint8_t *p_rx_data, uint8_t n_bytes)
Continuous read the data into SRAM function.
uint8_t eeram2_write_continuous(eeram2_t *ctx, uint32_t reg, uint8_t *p_tx_data, uint8_t n_bytes)
Continuous write the data into SRAM function.
void application_task(void)
Definition main.c:68

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

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.