3.6.4.20 MCP25625 Click Example on SAM E51 Curiosity Nano Evaluation Kit

Description

This example demonstrates the transmitting and receiving of CAN data using the MCP25625 CAN click board and displays the transmit/receive CAN message on a serial terminal on SAM E51 Curiosity Nano Evaluation Kit using the MCP25625 Click board.

Modules/Technology Used

Peripheral Modules:
- PORT
- SERCOM (SPI)
- SYSTICK

Hardware Used

SAM E51 Curiosity Nano Evaluation Kit - 2 Units
Curiosity Nano Base for Click Boards - 2 Units
MikroElektronika MCP25625 Click - 2 Units

Note: One of the two hardware setups is required for the CAN message transmission (Setup-1) and the other for reception(Setup-2). Parallelly both the setups demonstrate CAN data transmission and reception.

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.

Because Microchip regularly updates tools, occasionally issue(s) could be discovered while using the newer versions of the tools. If the project does not 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 (DS90003305).

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.
Mount MikroElektronika MCP25625 Click over mikroBUS socket #1 on the SAM E51 Curiosity Nano Evaluation Kit (Setup-1).
Repeat the above steps with the other hardware units (Setup-2).
Short the CANH and CANL lines of one DB9 connector with the CANH and CANL line of another DB9 connector using jumper wires as shown below image.
- CANH - Pin 7 of the DB9 connector
- CANL - Pin 2 of the DB9 connector

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,
1. Create Prebuilt Project,
  - Click the Browse button to select the prebuilt hex file.
  - Select Device as ATSAME51J20A.
  - Ensure the proper tool is selected under Hardware Tool and click on Next button.
2. Select Project Name and Folder,
  - Select appropriate project name and folder and click on Finish button
In MPLAB X IDE, click on Make and Program Device button to program the device.
Follow the steps in Running the Demo section below.

Programming/Debugging Application Project

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

Note: Repeat the above Setup, Programming Hex File, Programming/Debugging Application Project on the second hardware setup (Setup-2).

Running the Demo

Open the Tera Term terminal application on the PC (from the Windows Start menu by pressing the Start button).
Set the baud rate to 115200.
Repeat the above two steps for the second hardware setup (Setup-2).
Enter a character 'a' on one Tera terminal application to initiate the CAN Message Transmit.
Enter a character 'b' on another Tera terminal application to wait for the CAN Message Receive.
In both the Tera terminal windows, the user will see the CAN message transmission and reception continuously.

Instructions to Add MCP25625 Functionality to the Application

The user could use this demonstration as an example to add MCP25625 functionality to the MPLAB Harmony v3-based application. Follow the below steps.

If the user has not downloaded the MCP25625 demo yet Click Here to download, otherwise go to the next step.
Unzip the downloaded .zip file.
From the unzipped folder mcp25625/firmware/src, copy the folder click_routines to the folder firmware/src under the MPLAB Harmony v3 application project.
Open MPLAB X IDE.
Open the 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 MCP25625 click example header files gets added to the 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 MCP25625 click example source files gets added to the project.
The MCP25625 click example uses the SPI peripheral. The configuration of this peripheral for the application depends on the 32-bit MCU and development board the user is 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 the user has mounted the MCP25625 click board
      Example: The MCP25625 click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the MCP25625 click board. The SPI lines from MCU coming to this socket are from the SERCOM1 peripheral on the MCU.
      Figure 3-67. MCC Project Graph - SPI Configuration
      
      Figure 3-68. MCC Pin Configurator - SPI Pin Configuration
- Configure PORT Pins:
  - The MCP25625 click needs three additional pins for configuration and data exchange. These parent:
    - Standby pin
    - Reset pin
  - Configure PORT pins needed by MCP25625 click in the MCC Pin Configurator.
    The PORT pin configuration depends on:
    - 32-bit MCU
    - 32-bit MCU development board
    - The socket on which the user has mounted the MCP25625 click board
      Example: The PORT pin configuration for the MCP25625 click example on SAM E51 Curiosity Nano Evaluation Kit is below.
      Figure 3-69. 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 the project is running on.
  - The generic macros should be mapped in the header file click_interface.h.
  Example: The MCP25625 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 mcp25625_example.c. The user could use mcp25625_example.c as a reference to add MCP25625 functionality to the application.