OLED C Click board example on SAM E51 Curiosity Nano Evaluation Kit
Download
Description:
This example demonstrates the display capability of OLED C Click board on SAM E51 Curiosity Nano Evaluation Kit.
Modules/Technology Used:
- Peripheral Modules
- GPIO
- SERCOM (SPI)
- Core
- SPI Driver
- Legato graphics
- LE external controller
- LE SPI 4-line display driver
- Timer system service
- GFX core
- TC0
- Input system service
- Systick
Hardware Used:
- SAM E51 Curiosity Nano Evaluation Kit
- Curiosity Nano Base for Click Boards
- MikroElektronika OLED C CLICK
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
-
Mount the OLED C Click board on mikroBUS connector 1 of Curiosity Nano Base
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 (oled_c/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, when the demo is running, The OLED C Click display shows as below
Instructions to add OLED C Click display functionality to your application:
The MPLAB Harmony v3 supports adding custom display to your application using Legato (LE) External Display Controller drivers. The LE External Controller driver allows user to configure custom commands necessary for the external display.
Below are Harmony configuration for the OLED C Click
- Connect the display components as shown in the below figure
- Change Configuration of components as shown in the below figures
- SERCOM Configuration
- LE External configuration
Note : Other components’ configurations will be default
- SERCOM Configuration
- Change the width and height settings to 96 x 96 in GFX core LE block
-
Enable timer system service and core service as needed by the LE External Controller driver
Note : Configuration for TIME System service, Harmony core service and TC0 remains default
- Design graphics using MPLAB Harmony “Legato Graphics Composer”. Launch it using “Project Graph > Plugins > Legato Graphics Composer”
- Use Object Editor to edit the configuration for Input Widgets and Dispaly Widgets
-
You could use this demonstration as an example to add OLED C Click functionality to your MPLAB Harmony v3 based application. Follow the below steps.
Note: This demonstration uses a Text Field Input widget and an Image Display widget. Therefore the configurations in the Legato Graphics Composer (shown above) routines and examples (in oled_c.c and oled_c_example.c) are also based on these widgets. Users can configure and use other widgets and objects supported under Legato Graphics Composer by using this demonstration as a reference.-
If you haven’t downloaded the OLED C Click demo yet Click Here to download, otherwise go to next step
-
Unzip the downloaded .zip file
-
From the unzipped folder oled_c/firmware/src, copy the folder click_routines to the folder firmware/src under your MPLAB Harmony v3 application project
-
Open MPLAB X IDE
-
Open your 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 OLED C lick header files gets added to your 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 OLED C Click source files gets added to your project
-
- The click_routines folder contain an example C source file oled_c_example.c. You could use oled_c_example.c as a reference to add OLED C display functionality to your application.
Comments:
- Reference Training Module:
- 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.
Revision:
- v1.6.0 - Regenerated and tested the application
- v1.5.0 - Removed MHC support, regenerated and tested application.
- v1.4.0 - Released demo application