TB3232

How to Setup MPLAB Harmony v3 Software Development

Framework

Introduction

MPLAB

®

Harmony v3 is a software development framework consisting of compatible and inter-operational modules,

such as peripheral libraries (PLIBs), drivers, system services, middleware and third-party libraries. The software

development framework comes with a GUI tool, MPLAB Harmony Configurator (MHC), which provides an easy way

to enable, configure, and use various MPLAB Harmony modules.

Table of Contents

Introduction.....................................................................................................................................................1

1. Description.............................................................................................................................................. 3

2. References..............................................................................................................................................6

3. Revision History...................................................................................................................................... 7

The Microchip Website...................................................................................................................................8

Product Change Notification Service..............................................................................................................8

Customer Support.......................................................................................................................................... 8

Microchip Devices Code Protection Feature.................................................................................................. 8

Legal Notice................................................................................................................................................... 8

DS90003232C-page 2

Follow these steps to setup and use the MPLAB Harmony v3 software development framework:

1. Download and Install MPLAB

2. Run the installer and follow the instructions prompted on the screen.

3. To download and install the MPLAB Harmony v3 Configurator (MHC) plugin, follow these steps:

TB3232

DS90003232C-page 3

4. MPLAB Harmony v3 contents are grouped in multiple packages, which are available for download in the

– dev_packs: This repository contains all the device-related information in the form of Atmel pack

Description Files (ATDF) of the devices (both PIC

and SAM) which are supported in MPLAB Harmony

– csp: This repository contains the MPLAB Harmony v3 Chip Support Package (CSP). The CSP supports

the initialization of Microchip 32-bit SAM and PIC microcontroller and microprocessor devices. It provides

Application Program Interfaces (APIs) to develop simple applications that control peripheral hardware

with minimal external dependencies.

– core: This repository provides drivers and services with simple to use abstractions of peripherals and

shared resources on Microchip 32-bit SAM and PIC devices. Drivers and services may also provide

advanced capabilities, such as buffer queuing, peripheral sharing, and RTOS support.

– gfx: The graphics repository contains the files for the MPLAB Harmony Graphics Suite, quick-start

applications, drivers, tools, libraries, and templates.

TB3232

DS90003232C-page 4

Harmony GitHub repository mentioned above for details.

– Using the MPLAB Harmony v3 Content Manager: To download any MPLAB Harmony v3 package,

from MPLAB X IDE, select Tools > Embedded > MPLAB Harmony 3 Content Manager and follow the

steps on the screen to copy (clone) the repositories to a selected folder on the user’s computer. Refer to

MPLAB Harmony v3 Configurator Overview for more details.

– Manually cloning from GitHub: To manually clone a repository, follow the instructions available at:

https://help.github.com/en/articles/cloning-a-repository.

Note:  After all the required MPLAB Harmony v3 repositories are cloned, these repositories must be in

the same folder as shown in the following figure.

5. Creating a MPLAB Harmony v3 Project: After the required MPLAB Harmony v3 repositories are available in

Note:  All MPLAB Harmony v3 projects are standalone, which can be created at any location on the computer

(irrespective of H3 repositories location), and ported to any other computer.

TB3232

DS90003232C-page 5

• For additional information on MPLAB Harmony v3, visit the following Microchip website:

https://www.microchip.com/mplab/mplab-harmony

https://microchipdeveloper.com/harmony3:start

• GitHub help is available at https://help.github.com/

• Getting started with Git (version control) is available at https://git-scm.com/book/en/v2/Getting-Started-About-

Version-Control

TB3232

DS90003232C-page 6

Revision C - 04/2020

TB3232

DS90003232C-page 7

The Microchip Website

and information easily available to customers. Some of the content available includes:

• Product Support – Data sheets and errata, application notes and sample programs, design resources, user’s

guides and hardware support documents, latest software releases and archived software

• General Technical Support – Frequently Asked Questions (FAQs), technical support requests, online

discussion groups, Microchip design partner program member listing

• Business of Microchip – Product selector and ordering guides, latest Microchip press releases, listing of

seminars and events, listings of Microchip sales offices, distributors and factory representatives

Product Change Notification Service

Microchip’s product change notification service helps keep customers current on Microchip products. Subscribers will

receive email notification whenever there are changes, updates, revisions or errata related to a specified product

• Embedded Solutions Engineer (ESE)

• Technical Support

Customers should contact their distributor, representative or ESE for support. Local sales offices are also available to

help customers. A listing of sales offices and locations is included in this document.

Technical support is available through the website at: http://www.microchip.com/support

Microchip Devices Code Protection Feature

Note the following details of the code protection feature on Microchip devices:

• Microchip products meet the specification contained in their particular Microchip Data Sheet.

• Microchip believes that its family of products is one of the most secure families of its kind on the market today,

when used in the intended manner and under normal conditions.

protection does not mean that we are guaranteeing the product as “unbreakable.”

Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection

features of our products. Attempts to break Microchip’s code protection feature may be a violation of the Digital

Millennium Copyright Act. If such acts allow unauthorized access to your software or other copyrighted work, you

may have a right to sue for relief under that Act.

Legal Notice

Information contained in this publication 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

TB3232

DS90003232C-page 8

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

TB3232

DS90003232C-page 9