Harmony v3 Peripheral Libraries on SAM D21: Step 1

Step 1.1: Install the MPLAB® Harmony Configurator (MHC) Plug-in in the MPLAB X IDE

1

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. If you don't see it in the menu, please install MHC.

mhc_setup.png

Step 1.2: Setup MHC Plug-in Window Open in Standalone Mode

1

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

open_options.png
options_window.png

2

Go to Plugins > Window Manager and select Standalone mode. Click Apply and then click OK.

standalone_setup.png
  • 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 1.2 above shows a way to change the MHC operating mode.

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

Step 1.3: Create MPLAB Harmony v3 Project Using MPLAB X IDE

1

Select File > New Project from the main IDE menu.

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

2

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

project_creation_setup.png

If 32-Bit MPLAB Harmony 3 Project is not displayed, you will need to install MHC.

3

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

For more information on the framework downloader, see the "Download MPLAB Harmony Framework" section of the "MPLAB Harmony Configurator Overview" page.

project_path_setup.png

4

In the Project Settings window, apply the following settings:

  • 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\training\dev.
  • Folder: indicates the name of the MPLAB X .X folder. Enter "sam_d21_xpro" to create a 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_sam_d21_xpro". This is the name that will be shown from 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.
project_naming_setup.png

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.

project_naming_setup_help.png

5

Follow the steps below 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 list in Target Device in order to make it easier to locate the desired device.

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

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.

6

While the MHC tool launches, it will ask for the packages to be loaded. In the Load checkboxes list, select the csp package (by default this option is selected) and uncheck all the other packages (if any).

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

mhc_launch_step.png

7

The MHC plugin’s main window for the project will be displayed in Standalone mode, as shown in image below.

launched_mhc_view.png

8

Before proceeding, set up the compiler toolchain. Click on the Projects tab on the top left pane in MPLAB X IDE. Right click on the project name getting_started_sam_d21_xpro and go to Properties.

project_view.png

Make sure that XC32 (v2.20) is selected as the Compiler Toolchain for XC32. Click on Apply and then click on OK.

xc32_setup.png

Tool Tip: If you closed MHC accidently and would like to open it again, go to Tools > Embedded > MPLAB Harmony 3 Configurator in MPLAB X IDE.

Step 1.4: Verify Clock Settings

1

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

clock_configuration_open.png

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

2

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

clock_configuration_setup.png

Tool Tip:

  • The Clock Easy View window can be minimized by clicking minimize button, as shown below.
minimize_button.png
  • After minimizing the Clock Easy View window, you can see a small Clock Easy View tab at bottom-left in MHC, as shown below.
clock_easy_view_tab.png
  • The Clock Easy View window can be maximized by clicking maximize button or by double-clicking on Clock Easy View window, as shown below.
maximize_button.png
  • These tips apply to all other plug-in managers like Pin Configuration, DMA Configuration, Event System Configuration, and NVIC Configuration.



Next Step >

© 2019 Microchip Technology, Inc.
Notice: ARM and Cortex are the registered trademarks of ARM Limited in the EU and other countries.
Information contained on this site regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life support and/or safety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights.