LED DRIVER 3 Click example on SAM E51 Curiosity Nano Evaluation Kit

Download

---

Description:

This example demonstrates RGB color (Red/Green/Blue) one by one with a 500ms delay on the LED Driver 3 click board when the switch is pressed on the SAM E51 Curiosity Nano Evaluation Kit.

Modules/Technology Used:

• Peripheral Modules
  • EIC
  • SYSTICK
  • GPIO
  • SERCOM (I2C)
  • SERCOM (USART)

Hardware Used:

• SAM E51 Curiosity Nano Evaluation Kit
• Curiosity Nano Base for Click Boards
• MikroElektronika LED Driver 3 Click

Software/Tools Used:

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

Refer Project Manifest present in harmony-manifest-success.yml under the project folder firmware/src/config/sam_e51_cnano

• Refer the Release Notes to know the MPLAB X IDE and MCC Plugin version. Alternatively, Click Here.
• Any Serial Terminal application like Tera Term terminal application.

Because Microchip regularly update tools, occasionally issue(s) could be discovered while using the newer versions of the tools. If the project doesn’t seem to work and version incompatibility is suspected, It is recommended to double-check and use the same versions that the project was tested with. To download original version of MPLAB Harmony v3 packages, refer to document How to Use the MPLAB Harmony v3 Project Manifest Feature

Setup:

• Mount SAM E51 Curiosity Nano Evaluation Kit on “CNANO56_HOST_CONN”(U3) connector of Curiosity Nano Base board
• Mount LED Driver 3 Click board on mikroBUS click 1 connector of Curiosity Nano Base board

• Connect the SAM E51 Curiosity Nano Evaluation Kit to the Host PC as a USB Device through a Type-A male to micro-B USB cable connected to Micro-B USB (Debug USB) port

  

Programming hex file:

The pre-built hex file can be programmed by following the below steps.

Steps to program the hex file

• Open MPLAB X IDE
• Close all existing projects in IDE, if any project is opened.
• Go to File -> Import -> Hex/ELF File
• In the “Import Image File” window, Step 1 - Create Prebuilt Project, Click the “Browse” button to select the prebuilt hex file.
• Select Device has “ATSAME51J20A”
• Ensure the proper tool is selected under “Hardware Tool”
• Click on Next button
• In the “Import Image File” window, Step 2 - Select Project Name and Folder, select appropriate project name and folder
• Click on Finish button
• In MPLAB X IDE, click on “Make and Program Device” Button. The device gets programmed in sometime
• Follow the steps in “Running the Demo” section below

Programming/Debugging Application Project:

• Open the project (leddriver3/firmware/sam_e51_cnano.X) in MPLAB X IDE
• Ensure “PKOB nano” is selected as hardware tool to program/debug the application
• Build the code and program the device by clicking on the “make and program” button in MPLAB X IDE tool bar
• Follow the steps in “Running the Demo” section below

Running the Demo:

• Open the Tera Term terminal application on your PC (from the Windows® Start menu by pressing the Start button)
• Set the baud rate to 115200
• Press the switch SW0 on the SAM E51 Curiosity Nano Evaluation Kit to display the RGB color (Red/Green/Blue) one by one with 500ms delay on LED Driver 3 click board
• For every switch press, the SAM E51 Curiosity Nano Evaluation Kit displays RGB.

Instructions to add led driver3 functionality to your application:

You could use this demonstration as an example to add led driver3 functionality to your MPLAB Harmony v3 based application. Follow the below steps.

1. If you haven’t downloaded the led driver3 demo yet Click Here to download, otherwise go to next step
2. Unzip the downloaded .zip file
3. From the unzipped folder leddriver3/firmware/src, copy the folder click_routines to the folder firmware/src under your MPLAB Harmony v3 application project
4. Open MPLAB X IDE
5. Open your application project
6. In the project explorer, Right click on folder Header Files
   and add a sub folder click_routines by selecting “Add Existing Items from Folders…”
   

• Click on “Add Folder…” button
  

• Select the “click_routines” folder and select “Files of Types” as Header Files
  

• Click on “Add” button to add the selected folder
  

• The led driver3 click example header files gets added to your project
  

1. In the project explorer, Right click on folder Source Files
   and add a sub folder click_routines by selecting “Add Existing Items from Folders…”
   

• Click on “Add Folder…” button
  

• Select the “click_routines” folder and select “Files of Types” as Source Files
  

• Click on “Add” button to add the selected folder
  

• The led driver3 click example source files gets added to your project
  

1. The led driver3 click example uses the I2C and Timer peripherals. The configuration of these peripherals for your application depends on the 32-bit MCU and development board you are using.

   • Configure I2C: - Add the I2C peripheral block to the MCC project graph
     • Configure I2C Pins using MCC Pin configuration Window
       The I2C configuration depends on - 32-bit MCU - 32-bit MCU development board - The socket on which you have mounted the led driver3 click board
       Example: The led driver3 click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the led driver3 click board. The I2C lines from MCU coming to this socket are from the SERCOM2 peripheral on the MCU.
       MCC Project Graph - I2C configuration
       

     MCC Pin Configurator - I2C pin configuration
     

   • Configure Timer:
     • Configure Timer peripheral block in the MCC project graph
       The Timer configuration depends on - 32-bit MCU
       Example: The led driver3 click example on SAM E51 Curiosity Nano Evaluation Kit uses SysTick timer module on the MCU to implement the time requirement of led driver3 click routines.
       MCC Project Graph - SysTick configuration
       
   • Map Generic Macros:
     • After generating the project, following the above configuration, map the generic macros used in the click routines to the Harmony PLIB APIs of the 32-bit MCU your project is running on

     • The generic macros should be mapped in the header file click_interface.h

       Example: The led driver3 click routines for the example on SAM E51 Curiosity Nano Evaluation Kit uses the following Harmony PLIB APIs

2. The click_routines folder contain an example C source file leddriver3_example.c. You could use leddriver3_example.c as a reference to add led driver3 functionality to your application.

Comments:

• Reference Training Module:
  1. Getting Started with Harmony v3 Peripheral Libraries on SAM D5x/E5x MCUs
  2. Low Power Application on SAM E54 (Arm® Cortex® M4) MCUs Using MPLAB® Harmony v3 Peripheral Libraries
  3. Getting Started with Harmony v3 Drivers on SAM E54 MCUs Using FreeRTOS
• This application demo builds and works out of box by following the instructions above in “Running the Demo” section. If you need to enhance/customize this application demo, you need to use the MPLAB Harmony v3 Software framework. Refer links below to setup and build your applications using MPLAB Harmony.
  • How to Setup MPLAB Harmony v3 Software Development Framework
  • How to Build an Application by Adding a New PLIB, Driver, or Middleware to an Existing MPLAB Harmony v3 Project
  • MPLAB Harmony v3 is also configurable through MPLAB Code Configurator (MCC). Refer to the below links for specific instructions to use MPLAB Harmony v3 with MCC.
    • Create a new MPLAB Harmony v3 project using MCC
    • Update and Configure an Existing MHC-based MPLAB Harmony v3 Project to MCC-based Project
    • Getting Started with MPLAB Harmony v3 Using MPLAB Code Configurator
    • MPLAB Code Configurator Content Manager for MPLAB Harmony v3 Projects

Revision:

• v1.6.0 - Regenerated and tested the application.
• v1.5.0 - Removed MHC support, Regenerated and tested application.
• v1.4.0 - Added MCC support, Regenerated and tested application.
• v1.3.0 - Created application example

---