Getting Started with Harmony v3 Peripheral Libraries on SAM D21 MCUs

Last modified by Microchip on 2023/11/10 11:01

Warning: This tutorial uses the old Harmony configuration tool (MPLAB® Harmony Configurator (MHC)). New Harmony projects should use the MPLAB Code Configurator (MCC) instead.

 

Objective

MPLAB Harmony v3 is a flexible, fully-integrated, embedded software development framework for 32-bit microcontrollers (MCUs) and microprocessors (MPUs). MPLAB Harmony v3 includes the MPLAB Harmony Configurator (MHC) tool, a set of modular Peripheral Libraries (PLIBs), drivers, system services, middleware, and numerous example applications, all of which are designed to help you quickly and easily develop powerful and efficient embedded software for Microchip’s 32-bit PIC® and SAM devices.

This tutorial shows you how to use MHC to create an application that gets you started in developing applications on SAM D21 MCUs using the MPLAB Harmony v3 software framework.

The application makes use of the SAM D21 Xplained Pro Evaluation Kit and I/O1 Xplained Pro Extension Kit (sold separately).

The application reads the current room temperature from the temperature sensor on the I/O1 Xplained Pro Extension. The temperature read is displayed on a serial console periodically every 500 milliseconds. The periodicity of the temperature values displayed on the serial console is changed to one second, two seconds, four seconds, and back to 500 milliseconds every time you press the switch SW0 on the SAM D21 Xplained Pro Evaluation Kit. Also, an LED0 is toggled every time the temperature is displayed on the serial console.

The application you create will utilize:

  • SERCOM (as I²C) PLIB to read the temperature from a temperature sensor
  • Real-Time Clock (RTC) PLIB to periodically sample temperature sensor data
  • SERCOM (as Universal Synchronous Asynchronous Receiver Transmitter (USART)) and 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
  • External Interrupt Controller (EIC) PLIB to change the periodicity of temperature sensor data read using SWITCH press event

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

Two ways to use this tutorial

  1. Create the project from scratch:
    • Use the provided source files and step-by-step instructions below
  2. Use the solution project as an example:
    • Build the solution project and program it to the SAM D21 Xplained Pro Evaluation Kit Board to observe the expected behavior

Back to Top

Lab Objectives

  1. Create an MPLAB X Integrated Development Environment (IDE) Harmony v3 project for a SAM D21 microcontroller from scratch.
  2. Use MHC to configure and generate Harmony v3 PLIBs code for RTC, I²C, USART, DMA, EIC, and PORT peripherals.
  3. Use the Harmony v3 PLIB Application Programming Interfaces (APIs) to implement the application.

Materials

Reference Materials

About

Purchase

Tool

The Xplained Pro series evaluation kits include an on-board Embedded Debugger (EDBG). No external tools are necessary to program or debug the ATSAMD21J18A. For programming and debugging, the EDBG connects to the host PC through the USB Micro-B connector on the SAM D21 Xplained Pro Evaluation Kit.

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 and debugging.
Hardware setup

Figure: Hardware Setup

Software Tools

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

  • MPLAB X IDE v5.25
  • MPLAB XC32 Compiler v2.20
  • MPLAB Harmony CSP v3.5.2
  • MPLAB Harmony DEV_PACKS v3.5.0
  • MHC v3.3.3
  • MPLAB Harmony Configurator Plugin v3.3.1

Because we regularly update our tools, occasionally you may discover some issues while using the newer versions. If you suspect that to be the case, we recommend that you 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
FolderDescription
appsExample applications for CSP library components
archInitialization and starter code templates and data
docsCSP library help documentation
peripheralPLIB templates and configuration data
  • DEV_PACKS: The following table shows the summary of contents
FolderDescription
MicrochipPeripheral register specific definitions
armCore Specific Register Definitions (CMSIS)
  • MHC: The following table shows the summary of contents
File/FolderDescription
docHelp documentation and licenses for libraries used
np_templatesNew Project templates for supported toolchains
*.jarJava implementations of MHC modules
mhc.jarMain Java executable (run: java -jar mhc.jar -h)
runmhc.batWindows cmd batch file to run standalone MHC Graphical User Interface (GUI)

Back to Top

Overview

This lab shows you how to create an MPLAB Harmony v3 project from scratch, configure, and generate Harmony v3 PLIBs code for RTC, I²C, USART, DMA, and PORT peripherals. It periodically demonstrates the reading of temperature sensor values from the temperature sensor available on the I/O1 Xplained Pro Extension kit and displays it on a serial console. The periodicity of temperature sampling is changed for every switch press event. Every time the temperature is displayed on the serial console, an LED is toggled.

The application initializes clock, PORT, and other peripherals (configured through MHC) by calling the function SYS_Initialize.

The application registers callback event handlers for SERCOM (as I²C), DMA, RTC, and EIC PLIBs. The callback event handlers are called back by the PLIBs 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.
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 applications).

The application checks whether the configured RTC timer period has expired. On every timer period expiration, the application calls the function SERCOM2_I2C_WriteRead to submit a temperature sensor read request to the I²C PLIB. The I²C PLIB calls back the registered callback event handler when the latest temperature value is read from the sensor. The application sets a flag in the I²C callback event handler.

flow sequence of the application task

Figure: Flow sequence of the application task.

The application checks the temperature read complete flag to submit a written request to the DMA to print the latest temperature value (in a formatted message) onto the serial console over the USART interface.

The application also monitors the pressing of the switch SW0. If a switch press is detected, the application changes the temperature sampling rate from the default 500 milliseconds to one second. On subsequent switch press, the application changes the temperature sampling rate to two seconds, four seconds, and back to 500 milliseconds. The application cycles the temperature sampling rate on every switch press, as shown in the figure below.

App led running sequence

Figure: App led running sequence

The application also toggles user LED0 every time the latest temperature value is displayed on the serial console.

Back to Top

Lab Source Files and Solutions

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

The contents of this ZIP file need to be placed in the below folder:

<Any directory of your choice>/
(example Directory = C:/microchip/harmony/v3)

Note:

  1. The project location of a Harmony v3 project is independent of the location of the Harmony Framework path (i.e., you don't need to 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.
  2. The point above is true because when created, a Harmony v3 project generates all the referred source and header files and libraries (if any) under the project folder.
  3. Both points above contrast with Harmony v2 project location. In Harmony v2, the project was supposed to be created in a location under the Harmony framework.

ZIP

Extracting the ZIP file creates the following folders:

  • The samd21_getting_started folder contains the lab solution (in the firmware folder) and source files (in the dev_files folder)
    • The dev_files folder contains subfolder sam_d21_xpro containing application source files and other support files (if any) required to perform the lab (see "Procedure" section below)
    • The firmware folder contains the completed lab solution project. It can be directly built and programmed on the hardware to observe expected behavior

Back to Top

Procedure

All steps must be completed before you will be ready to build, download, and run the application.

Lab Index

Step 1: Create project and configure the SAM D21

  • Install the MPLAB Harmony Configurator (MHC) Plugin in MPLAB X IDE
  • Create MPLAB Harmony v3 Project Using MPLAB X IDE
  • Verify Clock Settings

Step 2: Configure I²C, USART and RTC Peripheral Libraries

  • Configure RTC Peripheral Library
  • Configure I²C Peripheral Library and I²C Pins
  • Configure USART Peripheral Library and USART Pins
  • Configure DMA Peripheral Library

Step 3: Configure Pins for Switch and LED

  • Configure Switch Button Pin with EIC to Generate an Interrupt
  • Configure LED Pin
  • Rename the Default Main File

Step 4: Generate Code
Step 5: Add Application Code to the Project
Step 6: Build, Program, and Observe the Outputs

Back to Top