3.6.4.2 Heart Rate 9 Click Example on SAM E51 Curiosity Nano Evaluation Kit
Description
This example demonstrates the reading of Heart Rate and displays it on a serial terminal on SAM E51 Curiosity Nano Evaluation Kit using Heart Rate 9 Click board.
Modules/Technology Used
- Peripheral Modules:
- EIC
- SYSTICK
- 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.
- 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.
- 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,
- 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.
- Select Project Name and Folder,
- Select appropriate project name and folder and click on Finish button
- Create Prebuilt Project,
- 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/heartrate9/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 the PC (from the Windows Start menu by pressing the Start button).
- Set the baud rate to 115200.
- Keep the finger on Pulse Detection
Indicator as shown here.Note: Cover the Heart Rate Sensor by placing the finger on Pulse Detection Indicator as shown below.
- Press the switch SW0 on the SAM
E51 Curiosity Nano Evaluation Kit to print the Heart Rate.
- For every switch press, the SAM E51 Curiosity Nano Evaluation Kit prints the Heart Rate.
Instructions to Add Heart Rate Functionality to the Application
The user could use this demonstration as an example to add Heart Rate functionality to the MPLAB Harmony v3 based application. Follow the below steps.
- If the user has not downloaded the Heart Rate 9 demo yet Click Here to download, otherwise go to next step.
- Unzip the downloaded .zip file.
- From the unzipped folder heartrate9/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, tight 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 Heart Rate 9 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 Heart Rate 9 click example source files gets added to the project.
- The Heart Rate 9 click example uses the
USART 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 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 the
user has mounted the Heart Rate 9 click board
Example: The Heart Rate 9 click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the Heart Rate 9 click board. The USART lines from MCU coming to this socket are from the SERCOM4 peripheral on the MCU.
Figure 3-8. MCC Project Graph - USART Configuration Figure 3-9. MCC Pin Configurator - USART Pin Configuration
- Configure Heart Rate 9 Click
Reset Pin:
- Configure Heart Rate 9 Click
Reset Pin using MCC Pin configuration Window.The Reset Pin configuration depends on:
- The socket on which the
user has mounted the Heart Rate 9 click board.
Example: The Heart Rate 9 click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the Heart Rate 9 click board. The Reset Pin line from the Heart Rate 9 Click coming to this socket is PA07 on the MCU.
Figure 3-10. MCC Pin Configurator - Reset Pin Configuration
- The socket on which the
user has mounted the Heart Rate 9 click board.
- Configure Heart Rate 9 Click
Reset Pin using MCC Pin configuration Window.
- Configure Timer:
- Configure Timer peripheral
block in the MCC project graph.The Timer configuration depends on:
- 32-bit MCU
Example: The Heart Rate 9 click example on SAM E51 Curiosity Nano Evaluation Kit uses SysTick timer module on the MCU to implement the time requirement of Heart Rate 9 click routines.
Figure 3-11. MCC Project Graph - SysTick Configuration
- 32-bit MCU
- Configure Timer peripheral
block in the MCC project graph.
- 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 Heart Rate 9 click routines for the example on SAM E51 Curiosity Nano Evaluation Kit uses the following Harmony PLIB APIs.Note:Define the value of CLICK_HEARTRATE9_USART_READ_BUFFER_SIZE same as USART_READ_BUFFER_SIZE defined in the respective USART PLIB '.c' file.
The click_routines folder contain an example C source file heartrate9_example.c. The user could use heartrate9_example.c as a reference to add Heart Rate 9 functionality to the application.
- Configure USART:
Comments
- Reference Training Module:
- This application demo builds and
works out of box by following the instructions above in Running the Demo
section. If the user needs to enhance/customize this application demo, should use the
MPLAB Harmony v3 Software framework. Refer links below to setup and build the
applications using MPLAB Harmony.
- How to Setup MPLAB Harmony v3 Software Development Framework (DS90003232).
- How to Build an Application by Adding a New PLIB, Driver, or Middleware to an Existing MPLAB Harmony v3 Project (DS90003253).
- Video - How to Set up the Tools Required to Get Started with MPLAB® Harmony v3 and 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