Store user preferences, schedule settings, and custom configurations with M95M04 and STM32F446ZE
Storing brilliance with EEPROM
Published Aug 24, 2023
Click board™
EEPROM 5 Click
Dev Board
UNI-DS v8
Compiler
NECTO Studio
MCU
STM32F446ZE
Ensure that your critical data remains intact even during power outages or system shutdowns, and provide seamless continuity for your applications
A
A
Hardware Overview
How does it work?
EEPROM 5 Click is based on the M95M04, the electrically erasable programmable memory organized as 524288 x 8 bits accessed through the SPI interface from STMicroelectronics. The M95M04 benefit from a wide power supply range of 1.8V to 5.5V and 40 years of data retention, combining their unprecedented data storage with excellent energy efficiency. It is characterized by high reliability, lasting one billion full-memory read-write cycles capable of writing 512 Bytes in 5ms. With a 4Mbit capacity, it allows the capture and storage of more data through the serial SPI bus. It enables equipment such as smart meters to intensify data logging to manage grids more effectively and provide more user-friendly billing. This Click board™ also provides high-density non-volatile storage for persistent data such as
application code, calibration tables, and user parameters and for intensive data logging. EEPROM 5 Click communicates with MCU using the SPI serial interface that supports the two most common modes, SPI Mode 0 and 3, with a maximum SPI frequency of 10 MHz. In addition to the SPI communication, the EEPROM 5 Click has two additional pins for the Write Protection and HOLD function routed to the PWM and RST pins of the mikroBUS™ socket. The HOLD pin, labeled as HLD routed to the RST pin of the mikroBUS™ socket, can pause the serial communication with the M95M04 without deselecting the device. In Normal operation, the M95M04 is kept selected for the whole duration of the Hold condition. Deselecting the device while it is in the HOLD condition has the effect of resetting the device
state. On the other side, the configurable Write Protection function, labeled as WP routed to the PWM pin of the mikroBUS™ socket, allows the user to freeze the size of the area of memory that is protected against Write instructions (as specified by the values in the BP1 and BP0 bits of the STATUS register). This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the PWR SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. Also, this Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used, as a reference, for further development.
Features overview
Development board
UNI-DS v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports a wide range of microcontrollers, such as different STM32, Kinetis, TIVA, CEC, MSP, PIC, dsPIC, PIC32, and AVR MCUs regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over WiFi. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, UNI-DS v8 provides a fluid and immersive working experience, allowing access anywhere and under any
circumstances at any time. Each part of the UNI-DS v8 development board contains the components necessary for the most efficient operation of the same board. An advanced integrated CODEGRIP programmer/debugger module offers many valuable programming/debugging options, including support for JTAG, SWD, and SWO Trace (Single Wire Output)), and seamless integration with the Mikroe software environment. Besides, it also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector. Communication options such as USB-UART, USB
HOST/DEVICE, CAN (on the MCU card, if supported), and Ethernet is also included. In addition, it also has the well-established mikroBUS™ standard, a standardized socket for the MCU card (SiBRAIN standard), and two display options for the TFT board line of products and character-based LCD. UNI-DS v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.
Microcontroller Overview
MCU Card / MCU
Type
8th Generation
Architecture
ARM Cortex-M4
MCU Memory (KB)
512
Silicon Vendor
STMicroelectronics
Pin count
144
RAM (Bytes)
131072
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Schematic
Step by step
Project assembly
Start by selecting your development board and Click board™. Begin with the UNI-DS v8 as your development board.
Track your results in real time
Application Output
After pressing the "FLASH" button on the left-side panel, it is necessary to open the UART terminal to display the achieved results. By clicking on the Tools icon in the right-hand panel, multiple different functions are displayed, among which is the UART Terminal. Click on the offered "UART Terminal" icon.
Once the UART terminal is opened, the window takes on a new form. At the top of the tab are two buttons, one for adjusting the parameters of the UART terminal and the other for connecting the UART terminal. The tab's lower part is reserved for displaying the achieved results. Before connecting, the terminal has a Disconnected status, indicating that the terminal is not yet active. Before connecting, it is necessary to check the set parameters of the UART terminal. Click on the "OPTIONS" button.
In the newly opened UART Terminal Options field, we check if the terminal settings are correct, such as the set port and the Baud rate of UART communication. If the data is not displayed properly, it is possible that the Baud rate value is not set correctly and needs to be adjusted to 115200. If all the parameters are set correctly, click on "CONFIGURE".
The next step is to click on the "CONNECT" button, after which the terminal status changes from Disconnected to Connected in green, and the data is displayed in the Received data field.
Software Support
Library Description
This library contains API for EEPROM 5 Click driver.
Key functions:
eeprom5_set_hold- Enable hold operation functioneeprom5_read_memory- Read EEPROM memory functioneeprom5_write_memory- Write EEPROM memory function
Open Source
Code example
This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.
/*!
* @file main.c
* @brief EEPROM5 Click example
*
* # Description
* This is an example that demonstrates the use of the EEPROM 5 Click board.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initialization driver enables SPI, also write log.
*
* ## Application Task
* In this example, we write and then read data from EEPROM memory.
* Results are being sent to the Usart Terminal where you can track their changes.
* All data logs write on USB uart changes approximately for every 3 sec.
*
* @author Stefan Ilic
*
*/
#include "board.h"
#include "log.h"
#include "eeprom5.h"
static eeprom5_t eeprom5;
static log_t logger;
static uint8_t demo_data[ 9 ] = { 'M', 'i', 'k', 'r', 'o', 'E', 13 ,10 , 0 };
static uint8_t read_data[ 9 ] = { 0 };
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
eeprom5_cfg_t eeprom5_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.
eeprom5_cfg_setup( &eeprom5_cfg );
EEPROM5_MAP_MIKROBUS( eeprom5_cfg, MIKROBUS_1 );
err_t init_flag = eeprom5_init( &eeprom5, &eeprom5_cfg );
if ( SPI_MASTER_ERROR == init_flag )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
log_printf( &logger, " - - - - - - - - - - - \r\n" );
log_printf( &logger, " Disabling HOLD \r\n" );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
eeprom5_set_hold( &eeprom5, EEPROM5_HOLD_DISABLE );
Delay_ms ( 100 );
log_printf( &logger, " Disabling Write Protection \r\n" );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
eeprom5_set_write_protect( &eeprom5, EEPROM5_WRITE_PROTECT_DISABLE );
Delay_ms ( 100 );
log_info( &logger, " Application Task " );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
}
void application_task ( void )
{
eeprom5_enable_memory_write( &eeprom5, EEPROM5_WRITE_MEMORY_ENABLE );
Delay_ms ( 10 );
eeprom5_write_memory( &eeprom5, 14, demo_data, 9 );
log_printf( &logger, " Write data : %s ", demo_data );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
Delay_ms ( 100 );
eeprom5_read_memory( &eeprom5, 14, read_data, 9 );
log_printf( &logger, " Read data : %s ", read_data );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
}
int main ( void )
{
/* Do not remove this line or clock might not be set correctly. */
#ifdef PREINIT_SUPPORTED
preinit();
#endif
application_init( );
for ( ; ; )
{
application_task( );
}
return 0;
}
// ------------------------------------------------------------------------ END
/*!
* @file main.c
* @brief EEPROM5 Click example
*
* # Description
* This is an example that demonstrates the use of the EEPROM 5 Click board.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initialization driver enables SPI, also write log.
*
* ## Application Task
* In this example, we write and then read data from EEPROM memory.
* Results are being sent to the Usart Terminal where you can track their changes.
* All data logs write on USB uart changes approximately for every 3 sec.
*
* @author Stefan Ilic
*
*/
#include "board.h"
#include "log.h"
#include "eeprom5.h"
static eeprom5_t eeprom5;
static log_t logger;
static uint8_t demo_data[ 9 ] = { 'M', 'i', 'k', 'r', 'o', 'E', 13 ,10 , 0 };
static uint8_t read_data[ 9 ] = { 0 };
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
eeprom5_cfg_t eeprom5_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.
eeprom5_cfg_setup( &eeprom5_cfg );
EEPROM5_MAP_MIKROBUS( eeprom5_cfg, MIKROBUS_1 );
err_t init_flag = eeprom5_init( &eeprom5, &eeprom5_cfg );
if ( SPI_MASTER_ERROR == init_flag )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
log_printf( &logger, " - - - - - - - - - - - \r\n" );
log_printf( &logger, " Disabling HOLD \r\n" );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
eeprom5_set_hold( &eeprom5, EEPROM5_HOLD_DISABLE );
Delay_ms ( 100 );
log_printf( &logger, " Disabling Write Protection \r\n" );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
eeprom5_set_write_protect( &eeprom5, EEPROM5_WRITE_PROTECT_DISABLE );
Delay_ms ( 100 );
log_info( &logger, " Application Task " );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
}
void application_task ( void )
{
eeprom5_enable_memory_write( &eeprom5, EEPROM5_WRITE_MEMORY_ENABLE );
Delay_ms ( 10 );
eeprom5_write_memory( &eeprom5, 14, demo_data, 9 );
log_printf( &logger, " Write data : %s ", demo_data );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
Delay_ms ( 100 );
eeprom5_read_memory( &eeprom5, 14, read_data, 9 );
log_printf( &logger, " Read data : %s ", read_data );
log_printf( &logger, " - - - - - - - - - - - \r\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
}
int main ( void )
{
/* Do not remove this line or clock might not be set correctly. */
#ifdef PREINIT_SUPPORTED
preinit();
#endif
application_init( );
for ( ; ; )
{
application_task( );
}
return 0;
}
// ------------------------------------------------------------------------ END
