Fan Click example on SAM E51 Curiosity Nano Evaluation Kit

Download

---

Description:

This example application demonstrates DC fan control (on, off and speed control) on SAM E51 Curiosity Nano Evaluation Kit using Fan Click board

Modules/Technology Used:

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

Hardware Used:

• SAM E51 Curiosity Nano Evaluation Kit
• Curiosity Nano Base for Click Boards
• MikroElektronika Fan Click
• 5V DC Fan

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:

• 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 (apps/sam_e51_cnano/same51n_mikroe_click/fan/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” button in MPLAB X IDE tool bar
• Follow the steps in “Running the Demo” section below

Running the Demo:

• After power up, by default when the application runs, the fan is switched off.
  1. When the user presses the switch on the board, the fan is turned on at default speed.
  2. When the user presses the switch on the board for second time, the fan is run at low speed.
  3. When the user presses the switch on the board for third time, the fan is run at medium speed.
  4. When the user presses the switch on the board for fourth time, the fan is turned off.
• The above steps are repeated for subsequent switch press events
  

Instructions to add Fan functionality to your application:

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

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

1. The Fan 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 Fan click board
       Example: The Fan click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the Fan 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 Fan click example on SAM E51 Curiosity Nano Evaluation Kit uses SysTick timer module on the MCU to implement the time requirement of Fan click example.
       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 and example 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 Fan 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 fan_example.c. You could use fan_example.c as a reference to add fan 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 - Released demo application

---