3.6.4.8 Fan Click Example on SAM E51 Curiosity Nano Evaluation Kit

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 (I²C)
- 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.
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 (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 the Application

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

If the user has not downloaded the Fan example demo yet Click Here to download, otherwise go to next step.
Unzip the downloaded .zip file.
From the unzipped folder fan/firmware/src, copy the folder click_routines to the folder firmware/src under the MPLAB Harmony v3 application project.
Open MPLAB X IDE.
Open the application project.
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 the project.
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 the project.
The Fan click example uses the I²C and Timer peripherals . The configuration of these peripherals for the application depends on the 32-bit MCU and development board the user is using.
- Configure I²C:
  - Add the I²C peripheral block to the MCC project graph.
  - Configure I²C Pins using MCC Pin configuration Window.
    The I²C configuration depends on:
    - 32-bit MCU
    - 32-bit MCU development board
    - The socket on which the user has 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 I²C lines from MCU coming to this socket are from the SERCOM2 peripheral on the MCU.
      Figure 3-27. MCC Project Graph - I²C Configuration
      
      Figure 3-28. MCC Pin Configurator - I²C 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.
      Figure 3-29. 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 the 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.
The click_routines folder contain an example C source file fan_example.c. The user could use fan_example.c as a reference to add fan functionality to the application.