3.6.4.6 Thumbstick Click Example on SAM E51 Curiosity Nano Evaluation Kit

Download

Description

This example demonstrates the 360 degree directional movement of input device (joystick) and push button on SAM E51 Curiosity Nano Evaluation Kit using Thumbstick click board.

Modules/Technology Used

  • Peripheral Modules:
    • SYSTICK
    • GPIO
    • EIC
    • SERCOM (USART)
    • SERCOM (SPI)

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.
  • Any Serial Terminal application, such as Tera Term terminal application.

Because Microchip regularly updates tools, occasionally issue(s) could be discovered while using the newer versions of the tools. If the project does not 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 (DS90003305).

Setup

  • 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,
    1. Create Prebuilt Project,
      • Click the Browse button to select the prebuilt hex file.
      • Select Device as ATSAME51J20A.
      • Ensure the proper tool is selected under Hardware Tool and click on Next button.
    2. Select Project Name and Folder,
      • Select appropriate project name and folder and click on Finish button
  • In MPLAB X IDE, click on Make and Program Device button to program the device.
  • Follow the steps in Running the Demo section below.

Programming/Debugging Application Project

  • Open the project (sam_e51_cnano/same51n_mikroe_click/thumbstick/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

  • Position the hardware as shown in below figure.
  • Open the Tera Term terminal application on the PC (from the Windows Start menu by pressing the Start button).
  • Set the baud rate to 115200.
  • A message is printed on the terminal whenever Thumbstick's push button pressed or UP/DOWN/LEFT/RIGHT Thumbstick's 360 degree rotation is made.

Instructions to Add Thumbstick Functionality to the Application

The user could use this demonstration as an example to add Thumbstick functionality to the MPLAB Harmony v3 based application. Follow the below steps.

  1. If the user has not downloaded the Thumbstick demo yet Click Here to download, otherwise go to next step.
  2. Unzip the downloaded .zip file.
  3. From the unzipped folder thumbstick/firmware/src, copy the folder click_routines to the folder firmware/src under the MPLAB Harmony v3 application project.
  4. Open MPLAB X IDE.
  5. Open the 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...
  7. Click on Add Folder... button.
  8. Select the click_routines folder and select Files of Types as Header Files.
  9. Click on Add button to add the selected folder.
  10. The Thumbstick click example header files gets added to the project.
  11. In the project explorer, right click on folder Source Files and add a sub folder click_routines by selecting Add Existing Items from Folders...
  12. Click on Add Folder... button.
  13. Select the click_routines folder and select Files of Types as Source Files.
  14. Click on Add button to add the selected folder.
  15. The Thumbstick click example source files gets added to the project.
  16. The Thumbstick click example uses the SPI, Timer peripherals and PORT Pins. The configuration of these peripherals for the application depends on the 32-bit MCU and development board the user is using.
    • Configure SPI:
      • Add the SPI peripheral block to the MCC project graph.
      • Configure SPI Pins using MCC Pin configuration Window.
        The SPI configuration depends on:
        • 32-bit MCU
        • 32-bit MCU development board
        • The socket on which the user has mounted the Thumbstick click board

          Example: The Thumbstick click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the Thumbstick click board. The SPI lines from MCU coming to this socket are from the SERCOM1 peripheral on the MCU.

          Figure 3-20. MCC Project Graph - SPI Configuration
          Figure 3-21. MCC Pin Configurator - SPI Pin Configuration
    • Configure Thumbstick Push Button:
      • Add the EIC peripheral block to the MCC project graph.
      • Configure EIC Pins using MCC Pin configuration Window.
        The EIC configuration depends on:
        • 32-bit MCU
        • 32-bit MCU development board
        • The socket on which the user has mounted the Thumbstick click board

          Example: The Thumbstick click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the Thumbstick click board. The PA04 EIC line coming to this socket from MCU needs to be configured for the Thumbstick's push button INT pin to work.

          Figure 3-22. MCC Project Graph - EIC Configuration
          Figure 3-23. MCC Pin Configurator - EIC Pin Configuration
    • Configure Timer:
      • Configure Timer peripheral block in the MCC project graph.
        The Timer configuration depends on:
        • 32-bit MCU

          Example: The Thumbstick click example on SAM E51 Curiosity Nano Evaluation Kit uses SysTick timer module on the MCU to implement the time requirement of Thumbstick click routines.

          Figure 3-24. 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 the project is running on.
      • The generic macros should be mapped in the header file click_interface.h.
      Example: The Thumbstick click routines for the example on SAM E51 Curiosity Nano Evaluation Kit uses the following Harmony PLIB APIs.

    The click_routines folder contain an example C source file thumbstick_example.c. The user could use thumbstick_example.c as a reference to add Thumbstick functionality to the application.

Comments