Jump to main content

##

# 1.10 I2C EEPROM Emulation (I2C Client)

This example application demonstrates how to use the I2C peripheral in client mode.

## Description

This example uses the I2C peripheral library in client mode and emulates an EEPROM of 512 bytes. There are two pages each of size 256 bytes. I2C client expects two bytes of memory address from the I2C host and the memory address can range from 0x00 to 0x1FF. I2C client application supports following:

Byte Write: The I2C host sends the client address, followed by two bytes of memory address. The client provides the data present at the requested memory address.

Page Write: A page write is initiated the same way as a byte write, but the I2C host can write up-to 256 bytes (1 page). If more than 256 bytes are sent by the I2C host to the I2C client, the memory address will “roll over” and previous data will be overwritten. The address “roll over” during write is from the last byte of the current page to the first byte of the same page.

Current Address Read: The internal memory address counter maintains the last address accessed during the last read or write operation, incremented by one. Once the device address with the read/write bit set to one is clocked in and acknowledged by the EEPROM, the data byte at the current address is serially clocked out. After reading the data from the current address, the I2C host sends NAK and generates a STOP condition.

Random Read: The I2C host writes the 2 byte memory address and then reads the data from that memory address. After reading the data, the I2C host sends NAK and generates a STOP condition.

Sequential Read: Sequential reads are initiated by either a current address read or a random address read. As long as the EEPROM receives an acknowledge, it will continue to increment the memory address and serially clock out sequential data bytes. When the memory address limit is reached (0x1FF), the memory address will “roll over” to 0x00 and the sequential read will continue. The sequential read operation is terminated when the I2C host sends a NAK and generates a STOP condition.

To run the application, two evaluation kits will be required - one acting as the I2C host and the other as the I2C client. The I2C host application to be used for this demo application is available under apps/i2c/master/i2c_eeprom folder. I2C host writes an array of values to the I2C client and verifies the value written by reading the values back and comparing it to the value written.

## Downloading and Building the Application

To clone or download this application from Github, go to the main page of this repository and then click Clone button to clone this repository or download as zip file.

Path of the application within the repository is apps/i2c/client/i2c_eeprom_emulation.

To build the application, refer to the following table and open the project using its IDE.

Project Name | Description
--- | ---
pic32ak_gc_curiosity.X | MPLABX project for Curiosity Platform Development Board and PIC32AK1216GC41064 General Purpose Dual In-Line Module (DIM)

## Setting Up the Hardware

The following table shows the target hardware for the application projects.

Project Name | Description
--- | ---
pic32ak_gc_curiosity.X | Curiosity Platform Development Board and PIC32AK1216GC41064 General Purpose Dual In-Line Module (DIM)

Hardware setup requires two boards, one acting as the I2C Client and the other as the I2C host.

### Setting Up Curiosity Development Board

- Insert the GP DIM on to DIM slot of Curiosity Board
- On mikroBUS header B, connect I2C SDA and I2C SCL lines with the corresponding SDA and SCL lines of the I2C host
- Connect a ground wire from Pin 8 of mikroBUS header to the ground of the I2C host board
- Connect the PKoB (J21) on the board to the computer using a USB type-C cable

## Running the Application

1. Build and program I2C EEPROM application from csp_apps_pic32ak_gc/apps/i2c/host/i2c_eeprom/ onto the evaluation kit used as I2C host
2. Build and Program I2C client application onto the evaluation kit used as I2C client
3. Run application on I2C client board and then run the application on I2C host board
4. LED on the I2C host board indicates success or failure:
   - The LED is turned ON when the value read from the I2C client matches with the written value
   - The LED is turned OFF when the value read from the I2C client did not match with the written value

Following table provides LED names on I2C host board:

Board | LED Name
--- | ---
Curiosity Platform Development Board and PIC32AK1216GC41064 General Purpose Dual In-Line Module (DIM) | LED0