Create a New MPLAB® Harmony v3 Project Using MPLAB Code Configurator (MCC) (Peripheral Library Example)

Last modified by Microchip on 2023/12/04 17:37

Objective
- Two Ways to Use This Tutorial
- Lab Objectives
Reference Materials
- Hardware Setup
Overview
Lab Source Files and Solutions
Procedure

Objective

This tutorial shows you how to create a new MPLAB^® Harmony v3 project using MPLAB Code Configurator (MCC). This training module used SAM D5x/E5x MCUs to create an application that gets you started in developing applications using MCC on the MPLAB Harmony v3 software framework.

The application makes use of the SAM E51 Curiosity Nano Evaluation Kit.

Note: Though this application uses the SAM E51 microcontroller as an example, the general description and steps to install, configure, and generate code using MCC applies to all 32-bit PIC and SAM microcontrollers.

This application demonstrates an LED (LED0) toggle on a timeout basis and prints the LED toggling rate on the serial terminal. The periodicity of the timeout will change from 500 milliseconds to 1 second, 2 seconds, 4 seconds, and back to 500 milliseconds every time you press the switch SW0 on the SAM E51 Curiosity Nano Evaluation Kit.

The applications you create will utilize:

Real-Time Clock (RTC) PLIB to periodically sample temperature sensor data.
SERCOM (as USART), Direct Memory Access (DMA) PLIBS to print the temperature values on a COM (serial) port terminal application running on a PC.
PORT PLIB to toggle the LED.
Help develop your first MPLAB Harmony v3 application using MCC.

In the process, the lab will also demonstrate the use of callback functions.

Two Ways to Use This Tutorial

Create the project from scratch:
- Use the provided source files and step-by-step instructions below.
Use the solution project as an example:
- Build the solution project and download it to the SAM E51 Curiosity Nano Evaluation Kit Board to observe the expected behavior.

Lab Objectives

Create an MPLAB X IDE Harmony v3 project for a SAM E51 microcontroller from scratch.
Use the MCC to configure and generate Harmony v3 Peripheral Libraries code for RTC, USART, DMA, and PORT peripherals.
Use the Harmony v3 PLIB Application Programming Interfaces (APIs) to implement the application.

Reference Materials

The Curiosity Nano Evaluation series kits include an "on-board" debugger as a hardware tool to program and debug the application. No external tools are necessary to program or debug the ATSAME51J20A. For programming and debugging, the on-board debugger connects to the host PC through the USB Micro-B connector on the SAM E51 Curiosity Nano Evaluation Kit.

Hardware Setup

Hardware Connection Setup

Apart from the hardware tools listed above, the following items are required:

USB Type-A male to Micro-B male cable for programming/debugging.

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

MPLAB X IDE v6.15
MPLAB XC32 Compiler v4.30
MPLAB Code Configurator v5.3.7
- MPLAB Harmony CSP v3.18.0
- MPLAB Harmony DEV_PACKS v3.18.0

Because we regularly update our tools, occasionally you may discover an issue while using the newer versions. If you suspect that to be the case, we recommend that you double-check and use the same versions that the project was tested with.

For this lab, download the following repositories from GitHub:

CSP - The following table shows the summary of contents.

Folder	Description
apps	Example applications for CSP library components
arch	Initialization and starter code templates and data
docs	CSP library help documentation
peripheral	Peripheral library templates and configuration data

DEV_PACKS -The following table shows the summary of contents.

Folder	Description
Microchip	Peripheral register specific definitions
arm	Core specific register difinitons (CMSIS)

Use the MPLAB Harmony v3 Framework downloader to download the repositories.

Overview

This lab shows you how to create an MPLAB Harmony v3 project from scratch using MCC. It shows you how to configure and generate Harmony v3 Peripheral Libraries code for RTC, USART, DMA, and PORT peripherals. It demonstrates an LED (LED0) toggle on a timeout basis and prints the LED toggling rate on the serial terminal. The periodicity of the timeout will change from 500 milliseconds to 1 second, 2 seconds, 4 seconds, and back to 500 milliseconds every time you press the switch SW0 on the SAM E51 Curiosity Nano Evaluation Kit.

Application flow diagram — Figure 1.1 shows the flow sequence of the application task.

The application initializes clock, PORT, and other peripherals (configured through MCC) by calling the function SYS_Initialize.
The application registers callback event handlers for DMA, RTC, and External Interrupt Controller (EIC) Peripheral Libraries. The callback event handlers are called back by the peripheral libraries when the transaction completion events occur.
Note:

A callback event handler for SERCOM (as USART) is not registered as the actual USART data transfer is accomplished by the DMA. The DMA calls back the callback event handler when the DMA transfer request is completed.
The RTC peripheral is used for implementing the time period instead of the timer peripheral. This is done to demonstrate how to configure and use RTC peripherals in an application (particularly low power application).

The application checks whether the configured RTC timer period has expired and checks the previous USART transmission completed. The application prints the LED toggling rate on the serial terminal on every timer period by initiating the DMA channel transfer function DMAC_ChannelTransfer for transmitting channel. The DMA PLIB calls back the registered callback event handler when the transmission completes. Finally, the application sets a flag in the RTC callback event handler.

The application also monitors the pressing of the switch SW0; if a switch press is detected, the application changes the LED toggling rate from the default 500 milliseconds to 1 second. The application changes the LED toggling rate to 2 seconds, 4 seconds, and back to 500 milliseconds on subsequent switch press. Thus, the application cycles the LED toggling rate on every switch press.

Application state machine

Lab Source Files and Solutions

This repository contains the completed solution project for this lab. It also includes the source files needed to perform the lab following step-by-step instructions (see the "Procedure" section on this page).

Place the contents of this ZIP file in:

<Any directory of your choice>/training/
(example Directory = C:/microchip/harmony/v5.3.7)

Note:

The project location of a Harmony v3 project is independent of the location of the Harmony v3 Framework path (i.e., you need not create or place a Harmony v3 project in a relative path under the Harmony v3 framework folder). The project can be created or placed in any directory of your choice.
The point above is to be noted because when a Harmony v3 project is created, it generates all the referred source/header files and libraries (if any) under the project folder.
Both the points above contrast with the Harmony v2 project location. In Harmony v2, the project was supposed to be created in a location under the Harmony v2 framework.

Extracting the ZIP file creates the following folders:

same51n_getting_started contains the lab solution (in the firmware folder) and source files (in the dev_files folder).
- dev_files contains subfolder sam_e51_cnano containing application source files and other support files (if any) required to perform the lab.
- firmware contains the completed lab solution project. It can be directly built and downloaded on the hardware to observe expected behavior.