Preserve user settings and preferences with DS28EC20 and PIC32MZ2048EFH100
Future-proofing solutions with EEPROM innovation
Published Aug 23, 2023
Click board™
EEPROM 6 Click
Dev. board
Flip&Click PIC32MZ
Compiler
NECTO Studio
MCU
PIC32MZ2048EFH100
Through the strategic use of EEPROM memory, our solution addresses the challenges of data persistence and management, enabling you to focus on innovation and growth
A
A
Hardware Overview
How does it work?
EEPROM 6 Click is based on the DS28EC20, a 20Kb data EEPROM with a fully featured 1-Wire interface in a single chip from Analog Devices. The memory is organized as 80 pages of 256 bits each. In addition, the device has one page for control functions such as permanent write protection and EPROM-Emulation mode for individual 2048-bit (8-page) memory blocks. A volatile 256-bit memory page called the scratchpad acts as a buffer when writing data to the EEPROM to ensure data integrity. Data is first written to the scratchpad, from which it can be read back for verification before transferring it to the EEPROM. Each DS28EC20 has its own unalterable and unique 64-bit registration number.
The registration number guarantees unique identification and addresses the device in a multidrop 1-Wire net environment. In addition to the EEPROM, the device has a 32-byte volatile scratchpad. Writes to the EEPROM array are a two-step process. First, data is written to the scratchpad and then copied into the main array. The user can verify the data in the scratchpad before copying. The EEPROM 6 Click communicates with MCU using the 1-Wire interface, which supports a Standard and Overdrive communication speed of 15.4kbps (max) and 90kbps (max). If not explicitly set into the Overdrive mode, the DS28EC20 communicates at Standard speed. The 1-Wire communication line is
routed to the SMD jumper labeled GP SEL, which allows routing of the 1-Wire communication either to the PWM pin or the AN pin of the mikroBUS™ socket. These pins are labeled GP0 and GP1, respectively, the same as the SMD jumper positions, making the selection of the desired pin simple and straightforward. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VCC 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
Flip&Click PIC32MZ is a compact development board designed as a complete solution that brings the flexibility of add-on Click boards™ to your favorite microcontroller, making it a perfect starter kit for implementing your ideas. It comes with an onboard 32-bit PIC32MZ microcontroller, the PIC32MZ2048EFH100 from Microchip, four mikroBUS™ sockets for Click board™ connectivity, two USB connectors, LED indicators, buttons, debugger/programmer connectors, and two headers compatible with Arduino-UNO pinout. Thanks to innovative manufacturing technology,
it allows you to build gadgets with unique functionalities and features quickly. Each part of the Flip&Click PIC32MZ development kit contains the components necessary for the most efficient operation of the same board. In addition, there is the possibility of choosing the Flip&Click PIC32MZ programming method, using the chipKIT bootloader (Arduino-style development environment) or our USB HID bootloader using mikroC, mikroBasic, and mikroPascal for PIC32. This kit includes a clean and regulated power supply block through the USB Type-C (USB-C) connector. All communication
methods that mikroBUS™ itself supports are on this board, including the well-established mikroBUS™ socket, user-configurable buttons, and LED indicators. Flip&Click PIC32MZ development kit allows you to create a new application in minutes. Natively supported by Mikroe software tools, it covers many aspects of prototyping 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
Architecture
PIC32
MCU Memory (KB)
2048
Silicon Vendor
Microchip
Pin count
100
RAM (Bytes)
524288
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Click board™ Schematic
Step by step
Project assembly
Start by selecting your development board and Click board™. Begin with the Flip&Click PIC32MZ as your development board.
Software Support
Library Description
This library contains API for EEPROM 6 Click driver.
Key functions:
eprom6_write_mem- This function writes a sequential data starting of the targeted 16b register address of the targeted 16-bit register address of the DS28EC20eeprom6_read_mem- This function reads a sequential data starting from the targeted 16-bit register address of the DS28EC20.
Open Source
Code example
The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.
/*!
* @file main.c
* @brief EEPROM 6 Click Example.
*
* # Description
* This example demonstrates the use of EEPROM6 Click board by writing
* string to a memory at some specific location and then reading it back.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and performs the Click default configuration.
*
* ## Application Task
* This example shows capabilities of EEPROM 6 Click board by writting a string
* into memory location from a specific address, and then reading it back every 5 seconds.
*
* @author Nikola Citakovic
*
*/
#include "board.h"
#include "log.h"
#include "eeprom6.h"
static eeprom6_t eeprom6;
static log_t logger;
#define EEPROM6_DEMO_TEXT "MikroE - EEPROM 6 Click board"
#define EEPROM6_TEXT_ADDRESS 0x0000
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
eeprom6_cfg_t eeprom6_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.
eeprom6_cfg_setup( &eeprom6_cfg );
EEPROM6_MAP_MIKROBUS( eeprom6_cfg, MIKROBUS_1 );
if ( ONE_WIRE_ERROR == eeprom6_init( &eeprom6, &eeprom6_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( EEPROM6_ERROR == eeprom6_default_cfg ( &eeprom6 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
void application_task ( void )
{
log_printf( &logger, "Writing \"%s\" to memory address 0x%.4X\r\n",
( uint8_t * ) EEPROM6_DEMO_TEXT, EEPROM6_TEXT_ADDRESS );
eeprom6_write_mem( &eeprom6, EEPROM6_TEXT_ADDRESS, ( char * ) EEPROM6_DEMO_TEXT,
strlen ( EEPROM6_DEMO_TEXT ) );
Delay_ms ( 100 );
uint8_t read_buf[ 100 ] = { 0 };
eeprom6_read_mem ( &eeprom6, EEPROM6_TEXT_ADDRESS,read_buf,
strlen ( EEPROM6_DEMO_TEXT ) );
log_printf( &logger, "Reading \"%s\" from memory address 0x%.4X\r\n\n",
read_buf, ( uint16_t ) EEPROM6_TEXT_ADDRESS );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
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
Additional Support
Resources
Category:EEPROM
