Link Search Menu Expand Document

USB UART Click example on SAM E51 Curiosity Nano Evaluation Kit

Download

Description:

This example demonstrates the reading of a character and displays it on a serial terminal on SAM E51 Curiosity Nano Evaluation Kit using USB UART Click board.

Modules/Technology Used:

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

Hardware Used:

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:

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 (apps/sam_e51_cnano/same51n_mikroe_click/usb_uart/firmware/sam_e51_cnano.X) in MPLAB X IDE
  • Ensure “SAM E51 Curiosity 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 Device” 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

  • Now, open another Tera Term terminal application on your PC and Set the baud rate to 115200 to test MikroElektronika USB UART Click.

  • Goto Setup -> Terminal and enable Local echo

  • For every key press, the entered key is printed on terminal.

Instructions to add USB UART functionality to your application:

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

  1. If you haven’t downloaded the USB UART demo yet Click Here to download, otherwise go to next step
  2. Unzip the downloaded .zip file
  3. From the unzipped folder usb_uart/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 USB UART 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 USB UART click example source files gets added to your project

  1. The USB UART click example uses the USART peripheral. The configuration of this peripheral for your application depends on the 32-bit MCU and development board you are using.

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

      MCC Pin Configurator - USART pin 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 USB UART 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 usb_uart_example.c. You could use usb_uart_example.c as a reference to add USB UART functionality to your application.

Comments:

Revision:

  • v1.6.0 - Regenerated and tested the application
  • v1.5.0 - Removed MHC support, Regenerated and tested application.
  • v1.4.0 - Updated USB UART click interface APIs, Added MCC support, Regenerated and tested application.
  • v1.3.0 - Created application example


Copyright © 2020 Microchip Technology.