Jump to main content

##

# 1.19 SPI Client Read Write

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

## Description

This example uses the SPI peripheral library in client mode and allows reading and writing data from/to its internal buffer by a SPI host.

The SPI host writes data by sending a write command followed by two bytes of memory address followed by the data to be written.

< WR_CMD > < ADDR_MSB > < ADDR_LSB > < DATA0 > … < DATA n >

The SPI client asserts the Busy line to indicate to the SPI host that it is busy. Once ready, the SPI client de-asserts the Busy line. Once the SPI client is ready, the SPI host reads the data by sending read command followed by two bytes of memory address and the number of bytes to read.

< RD_CMD > < ADDR_MSB > < ADDR_LSB > < NUM_BYTES >

The SPI client responds by sending the data at the requested memory address. The SPI host compares the sent data with the received data and repeats the test if it matches.

## 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. This content can also be downloaded using content manager by following these instructions.

Path of the application within the repository is apps/spi/client/spi_write_read.

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

## 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

## Setting Up Curiosity Platform Development Board

- To run this demo two Curiosity Platform Development Board are required. One will be programmed as SPI host and other will be programmed as SPI client.
- Connect a PIC32AK1216GC41064 General Purpose Dual In-Line Module (DIM) to the J1 header of Curiosity Board.
- Connect Pin P81, P83, P85, P87 of mikroBUS header A on SPI host to Pin P81, P83, P85, P87 respectively of mikroBUS header A on SPI client
  - P81 - SPI Chip Select
  - P83 - SCK
  - P85 - SDI
  - P87 - SDO
- Connect P79 of mikroBUS header A on SPI host to P79 of mikroBUS header A on SPI client which is configured as GPIO and serves as the client busy pin.
- Connect the Debug USB port on the board to the computer using a micro USB cable

## Running the Application

1. Build and Program the SPI host application project using its IDE. Path of the SPI Host application within the repository is apps/spi/host/spi_write_read_test_app
2. Build and Program the SPI client application project using its IDE
3. On the SPI host board, press switch to start reading and writing data
4. LED on SPI host board indicates the success or failure:
   - LED is turned ON when the data read from the SPI client matches with the data written
   - LED is turned OFF when the data read from the SPI client does not match with the data written
   Following table provides the Switch and LED names:

   Board | Switch Name | LED Name
   --- | --- | ---
   Curiosity Platform Development Board | S1 | LED1