Migrate aria application to legato - mchpgfx/legato.docs GitHub Wiki
This guide describes the basic steps necessary to migrate a Aria graphics library based application to use the MGS Harmony libary.
This guide uses the SAM E70 Xplained Ultra Evaluation Kit connected to a WVGA display. You will build a simple application that displays an image and touch button. It starts with the creation of a new MPLAB® project and finishes with a graphics application equivalent to legato_quickstart.
The demonstration will render the following image on the display:
Who should use this guide
This guide is intended for developers who want to migrate an Aria-based application to Legato.
This guide will remove an existing Aria Graphics Libary Component and replace it with the MGS Harmony Library component. It will also make appropriate connections to associated display driver dependencies.
This application will be flashed on the SAM E70 Xplained Ultra Evaluation Kit.
What this guide contains
You will build a simple application that displays an image and touch button. It starts with an existing Aria-based application and finishes with a Legato-graphics application equivalent to legato_quickstart. Here are the primary steps to migrate:
- Create a new project and configure clock for SAME70
- Create MPLAB® Harmony v3 Project using MPLAB® X IDE
- Verify Clock Settings
- Configure Harmony components for graphics middleware and drivers
- Configure pins for external graphics communication
- Generate Code
- Add application code to project
- Build, program and observe outputs
Materials you will need
Documentation | Description |
---|---|
SAM E70 Xplained Ultra User's Guide | User Guide with Schematics |
High-Performance WQVGA Display Module with maXTouch® Information Sheet | Display Information Sheet |
Hardware | Description |
---|---|
SAM E70 Xplained Ultra Evaluation Kit | Development Board |
WQVGA Display Module (AC320005-4). | High-Performance 4.3" WQVGA Display Module |
WQVGA Display Module from MEB II | Alternative High-Performance 4.3" WQVGA Display Module if an MEB-II board is available |
Standard USB A to micro-B cable | PC debugging connector. |
NOTE: The SAM E70 Xplained Ultra Evaluation Kit includes an on-board Embedded Debugger (EDBG), which requires no additional hardware to get started. For programming/debugging, the EDBG connects to the host PC through the USB micro-B connector on the SAM E70 Xplained Ultra Evaluation Kit.
Hardware Setup
SAM E70 Xplained Ultra Evaluation Kit is connected to the display using the display ribbon cable. Programming is a board to PC link using a standard USB A to micro-B cable. The connection, illustrated below, provides power and debug communication.
The board and display are powered by a Micro B – USB A cable from PC to the “USB Debug” port on the SAM E70 Xplained Ultra Evaluation Kit.
Software | Description | Install |
---|---|---|
MPLAB® X Integrated Development Environment | v5.15 or later | Install MPLAB® IDE |
MPLAB® XC32/32++ C Compiler | v2.20 or later | Install Compiler |
MPLAB® Harmony 3 | v3.5 or later | Install Harmony v3 |
NOTE: This project has been verified to work with the following versions of software tools: MPLAB® X IDE v5.20, MPLAB® XC32 Compiler v2.20, MPLAB® Harmony v3.6.0
NOTE: 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 use the same versions that the project was tested with.
To get started with this tutorial, you should:
- Install MHC
- Configure Hardware
- Run MPLABX
-
Install MHC To install MHC, follow the Harmony V3 MHC installation guide. Upon completion, proceed to Configure Hardware steps below.
-
Configure Hardware
SAM E70 Xplained Ultra board configuration is simply a board to PC connection using a standard USB A to micro-B cable. The connection provides power and debug communication. The connection is illustrated in the image below:
Configure the 4.3” WQVGA Display
- Disconnect the ribbon cable that connects the display to the interposer board. The board is for the MEB 2 only, and not used on the SAM E70 Xplained Ultra kit.
- Release the ribbon cable from the interposer board.
- Release the black clamp on the E70’s J2 connector and turn the display over.
- Insert the ribbon cable into J2 and close the clamp.
The board and display are powered by a Micro B – USB A cable from PC to the “Debug USB” port on the E70 board.
- Run MPLABX
Launch the MPLAB® X IDE. From the File pull-down menu, select Open Project. This will display the Open Project dialog window. Navigate to to C:<YourHarmonyRoot3\gfx\apps\aria_quickstart\firmware Select aria_qs_e70_xu_tm4301b.X and click Open.
- Launch MHC
- Remove Aria Graphics Library component
Select the Aria Graphics Library component, click X to remove
Select Yes when prompted "Are you sure you want to decativate these components?".
Select the GFX Core component, click X to remove.
Select the LCC Display Driver component, click X to remove.
Add MGS Harmony Library component to the project graph view. Under Available Components expand Graphics/Middleware and select Legato.
Connect MGS Harmony Library component to LE LCC Display Driver component. Right click Display Driver on the MGS Harmony Library component. Under Satisfiers, select LE LCC.
Select Yes when prompted "Are you sure you want to activate these components?".
Connect MGS Harmony Library component to PDA TM4301B component. Right click Graphics Display on the MGS Harmony Library component. Under Satisfiers, select PDA TM4301B.
Connect LE LCC component to SMC component. Right click SMC_SC on the LE LCC component. Under Satisfiers, select SMC.
Configure backlight settings for the LE LCC component. Set Peripheral, Instance and Channel as illustrated below:
Connect LE LCC component to TMR 1 component. Right click TMR on the LE LCC component. Under Satisfiers, select TC1.
Configure channel0 settings for the TMR component. Enable Channel 0 and set Operating Mode as illustrated below:
The completed project view is illustrated below:
- Before generating code, click the Save icon as shown below.
-
Save the configuration in its default location when prompted.
-
Click on the Code Generate button as shown below to start generating code.
- Click on the Generate button in the Generate Project window, keeping the default settings as shown below. If prompted for saving the configuration, click Save.
MHC will include all the MPLAB® Harmony library files and generate the code based on the MHC selections. The generated code would add files and folders to your Harmony project.
- Clean and build your application by clicking on the Clean and Build button as shown below.
- Program your application to the device, by clicking on the Make and Program button as shown below.
Review the following before you migrate your app from earlier versions of the MPLAB® Harmony Graphics Suite 2.06:
-
See Versions and Dependencies to understand the MPLAB® Harmony version underlying each version of the MPLAB® Harmony Graphics and to review guidelines for targeting your apps successfully.
-
Review Application Compatibility to find out about runtime and retargeting changes that might affect your app and how to handle them.
-
Review What's Obsolete or Deprecated in the suite to determine any types or members in your code that have been made obsolete, and the recommended alternatives.
-
See What's New for descriptions of new features that you may want to add to your app.