Getting Started with MPLAB® Harmony v3 Drivers on SAM D21 MCUs Using FreeRTOS™: Step 1

Last modified by Microchip on 2023/11/09 09:08

Install MPLAB® Harmony Configurator (MHC) Plugin in MPLAB X IDE

Verify that MPLAB® Harmony Configurator (MHC) is installed. 

Launch MPLAB X IDE from the Windows® Start menu. Close any projects and files that are currently open. Go to Tools > Embedded. You will see MPLAB Harmony 3 Configurator in the menu.

MPLAB Harmony 3 Configurator in the menu

If you don't see it in the menu, install MHC.

Back to Top

Setup MHC Plugin Window Open in Native Mode

Go to Tools > Options. You will see the Options window open.

Tools > Options

Tools > Options

Go to Plugins and select the Native Netbeans option from the Window Manager menu. Click Apply and then click OK.

Going to Plugins and select the Native Netbeans option

When you launch MHC for the first time, it displays a prompt asking for the mode in which you would like to use MHC.

  • Standalone mode (as a separate window)
  • Native mode (as an embedded window in MPLAB X)
    Standalone mode is the default mode.

MHC will launch in the operating mode selected the first time, every time you launch MHC. Step 2 above shows a way to change the MHC operating mode.

For this lab, MHC is configured to operate in Native mode.

Back to Top

Create MPLAB Harmony v3 Project Using MPLAB X IDE

Select File > New Project from the main IDE menu. 

Close all existing opened projects before you start creating a new project.

In the Categories pane of the New Project dialog, select Microchip Embedded. In the Projects pane, select 32-bit MPLAB Harmony 3 Project, then click Next

Categories pane of the New Project dialog

If 32-bit MPLAB Harmony 3 Project is not displayed, install MHC.

Browse to the folder you downloaded the framework to in the Framework Path edit box. If you haven't done this, or want to download it to a different folder, click the Launch Content Manager button, then click Next

For more information on the framework downloader, see the "MPLAB® Harmony v3 Software Framework" page.

Manage framework

In the Project Settings window, apply the following settings: 

  • Location
    • Location indicates the path to the root folder of the new project. All project files will be placed inside this folder. The project location can be any valid path, for example, C:\microchip\harmony\v3\harmony_projects.
  • Folder
    • Folder indicates the name of the MPLABX.X folder. Enter "drivers_freertos_sam_d21_xpro" to create a drivers_freertos_sam_d21_xpro.X folder.
    • This must be a valid directory name for your operating system.
  • Name
    • Enter the project’s logical name as "getting_started_drivers_freertos_sam_d21_xpro". This is the name that will be shown within the MPLAB X IDE.

The Path box is read-only. It will update as you make changes to the other entries.

Click Next to proceed to Configuration Settings.

Clicking Next to proceed to Configuration Settings

Clicking on the Show Visual Help button will open a help window providing a detailed description of the various fields in the Project Settings window.

New Project Wizard Help

Follow the steps to set the project’s Configuration Settings.

  • Name
    • Enter the configuration name as "sam_d21_xpro".
  • Target Device
    • Select ATSAMD21J18A as the target device.

You can select the Device Family or enter a partial device name to filter the Target Device list in order to make it easier to locate the desired device.

After selecting the target device, click Finish to launch the MHC.

Clicking Finish to launch the MHC

The New Project Wizard opens a Configuration Database Setup window to allow you to review the packages that will be used by the current project.

Click Launch to launch the MHC tool with the selected packages. 

Clicking Launch to launch the MHC tool with the selected packages

The MHC plugin’s main window for the project will be displayed. 

MHC plugin’s main window

Before proceeding, set up the compiler toolchain. Click on the Projects tab on the top left pane. Right-click on the project name getting_started_drivers_freertos_sam_d21_xpro and go to Properties

Clicking on the Projects tab on the top left pane

Select Connected Hardware Tool as SAM D21 Xplained Pro. Make sure that XC32 (v2.50) is selected as the Compiler Toolchain for XC32. Click on Apply and then click on OK

Selecting Connected Hardware Tool as SAM D21 Xplained Pro

​If you closed MHC accidentlly and would like to open it again, go to Tools > Embedded > MPLAB Harmony 3 Configurator.

In the future, if you want to open the completed MHC configuration, press MHC > Loadstate > .xmlfile (firmware > src > config > sam_d21_xpro > sam_d21_xpro.xml).

Back to Top

Verify Clock Settings

Launch Clock Easy View by going to the Tools menu of the MHC tab and then select Clock Configuration.

Clock Easy View

A new window, Clock Easy View, is opened inside MHC.

In the Clock Easy View window, verify that the Main Clock is set to 48 MHz.

Clock Easy View window

Double-click on the Clock Easy View tab to maximize/minimize the window.

Back to Top