Eink Click display bundle example on SAM E51 Curiosity Nano Evaluation Kit

Download

Description:

This example demonstrates the display capability of Eink click bundle board on SAM E51 Curiosity Nano Evaluation Kit.

Modules/Technology Used:

Peripheral Modules
- SYSTICK
- GPIO
- SERCOM (SPI)

Hardware Used:

SAM E51 Curiosity Nano Evaluation Kit
Curiosity Nano Base for Click Boards
MikroElektronika Eink Click Bundle Eink Click Bundle is not in production anymore, for any new design/development use the following hardware
MikroElektronika Eink Click Without Display
MikroElektronika E-Paper display 2,9” 296x128 dots
Software/Tools Used:

This project has been verified to work with the following versions of software tools:

Refer Project Manifest present in harmony-manifest-success.yml under the project folder firmware/src/config/sam_e51_cnano

Refer the Release Notes to know the MPLAB X IDE and MCC Plugin version. Alternatively, Click Here.
Any Serial Terminal application like Tera Term terminal application.

Because Microchip regularly update tools, occasionally issue(s) could be discovered while using the newer versions of the tools. If the project doesn’t seem to work and version incompatibility is suspected, It is recommended to double-check and use the same versions that the project was tested with. To download original version of MPLAB Harmony v3 packages, refer to document How to Use the MPLAB Harmony v3 Project Manifest Feature

Setup:

Connect the SAM E51 Curiosity Nano Evaluation Kit to the Host PC as a USB Device through a Type-A male to micro-B USB cable connected to Micro-B USB (Debug USB) port

Programming hex file:

The pre-built hex file can be programmed by following the below steps.

Steps to program the hex file

Open MPLAB X IDE
Close all existing projects in IDE, if any project is opened.
Go to File -> Import -> Hex/ELF File
In the “Import Image File” window, Step 1 - Create Prebuilt Project, Click the “Browse” button to select the prebuilt hex file.
Select Device has “ATSAME51J20A”
Ensure the proper tool is selected under “Hardware Tool”
Click on Next button
In the “Import Image File” window, Step 2 - Select Project Name and Folder, select appropriate project name and folder
Click on Finish button
In MPLAB X IDE, click on “Make and Program Device” Button. The device gets programmed in sometime
Follow the steps in “Running the Demo” section below

Programming/Debugging Application Project:

Open the project (eink_bundle/firmware/sam_e51_cnano.X) in MPLAB X IDE
Ensure “SAM E51 Curiosity Nano” is selected as hardware tool to program/debug the application
Build the code and program the device by clicking on the “Make and Program Device” button in MPLAB X IDE tool bar
Follow the steps in “Running the Demo” section below

Running the Demo:

After power up, when the demo is running, The Eink display shows as below

Instructions to add Eink display functionality to your application:

You could use this demonstration as an example to add Eink display functionality to your MPLAB Harmony v3 based application. Follow the below steps.

If you haven’t downloaded the Eink Click display demo yet Click Here to download, otherwise go to next step
Unzip the downloaded .zip file
From the unzipped folder eink_bundle/firmware/src, copy the folder click_routines to the folder firmware/src under your MPLAB Harmony v3 application project
Open MPLAB X IDE
Open your application project
In the project explorer, Right click on folder Header Files
and add a sub folder click_routines by selecting “Add Existing Items from Folders…”

Click on “Add Folder…” button
Select the “click_routines” folder and select “Files of Types” as Header Files
Click on “Add” button to add the selected folder
The Eink display click example header files gets added to your project

In the project explorer, Right click on folder Source Files
and add a sub folder click_routines by selecting “Add Existing Items from Folders…”

Click on “Add Folder…” button
Select the “click_routines” folder and select “Files of Types” as Source Files
Click on “Add” button to add the selected folder
The Eink display click example source files gets added to your project

The Eink display click example uses the SPI, Timer peripherals and PORT pins . The configuration of these peripherals for your application depends on the 32-bit MCU and development board you are using.
- Configure SPI: - Add the SPI peripheral block to the MCC project graph
  - Configure SPI Pins using MCC Pin configuration Window
    The SPI configuration depends on - 32-bit MCU - 32-bit MCU development board - The socket on which you have mounted the Eink click bundle board
    Example: The Eink display click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the Eink Click Bundle board. The SPI lines from MCU coming to this socket are from the SERCOM1 peripheral on the MCU.
    MCC Project Graph - SPI configuration
  MCC Pin Configurator - SPI pin configuration
- Configure Timer:
  - Configure Timer peripheral block in the MCC project graph
    The Timer configuration depends on - 32-bit MCU
    Example: The Eink display click example on SAM E51 Curiosity Nano Evaluation Kit uses SysTick timer module on the MCU to implement the time requirement of Eink display click routines.
    MCC Project Graph - SysTick configuration
- Configure PORT Pins:
  - The Eink click bundle needs three additional pins for configuration and data exchange. These parent
    - Data/Config pin
    - Busy indicator pin
    - Reset pin
  - Configure PORT pins needed by Eink click bundle in the MCC Pin Configurator
    The PORT pin configuration depends on
    - 32-bit MCU
    - 32-bit MCU development board
    - The socket on which you have mounted the Eink bundle click board
      Example: The PORT pin configuration for the Eink display click example on SAM E51 Curiosity Nano Evaluation Kit is below.
      MCC Pin Configurator - PORT pin configuration
- Map Generic Macros:
  - After generating the project, following the above configuration, map the generic macros used in the click routines to the Harmony PLIB APIs of the 32-bit MCU your project is running on
  - The generic macros should be mapped in the header file click_interface.h
    
    Example: The Eink display click routines for the example on SAM E51 Curiosity Nano Evaluation Kit uses the following Harmony PLIB APIs
The click_routines folder contain an example C source file eink_bundle_example.c. You could use eink_bundle_example.c as a reference to add Eink display functionality to your application.