3.10.7.2 File Transfer Protocol - Client Application on SAM E54 Xplained Pro Development Board
Description
FTP Client implementation using MPLAB Harmony v3 TCP/IP stack in the SAME54 microcontroller. FTP client demonstration implements an Ethernet bootloader using FTP through which it downloads an application binary from an FTP server and upgrades the firmware by self-programming.
Modules/Technology Used
- Peripheral Modules:
- NVMCTRL
- SERCOM2 (USART)
- SERCOM4 (SPI)
- Harmony Core
- SDHC
- Timer (TC0)
- Drivers:
- SD Card SPI Driver
- System Services:
- DEBUG
- Command
- File System
- Time
- Console
- Middleware libraries:
- TCP/IP Stack
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 same54_ftp_client/firmware/src/config/sam_e54_xpro.
- Refer the Release Notes to know the MPLAB X IDE and MCC Plugin version.
- Any Serial Terminal application, such as Tera Term terminal application.
- Windows command prompt
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
- Insert microSD Card in the IO1 Xplained Pro. The microSD at this client would store the application binary file which will be downloaded from the server.
- Connect the IO1 Xplained Pro to the Extension 1 of the SAM E54 Xplained Pro Evaluation Kit.
- Connect the micro USB cable from the computer to the DEBUG USB connector on the SAM E54 Xplained Pro Development Kit as shown in the below image.
- Connect the SAM E54 Xplained Pro
Evaluation Kit's Ethernet Port (Client) to Server's Ethernet Port through RJ45
cable.
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 ATSAME54P20A.
- 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(same54_ftp_bootloader/sam_e54_ftp_client/firmware/ftp_client_sam_e54_xpro.X) in MPLAB X IDE
- Ensure SAM E54 Xplained Pro is selected as hardware tool to program/debug the application
- Build the code and program the devices 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
Follow the instructions to setup FTP Server Application
FTP Client Connect
- From a terminal window application (such as Tera Term), connect to the COM port enumerated by SAM E54 Xplained Pro evaluation kit.
- Restart the application (i.e., reset the SAM E54 Xplained Pro Evaluation Kit).
- The IP address will be displayed on the
terminal once it is ready. User can connect to the FTP server
- Type ftpc connect <ip address>
- Upon successful connection, enter the
login details
- Type ftpc login <server name> <password>
- Once logged in, use ftpc get command to
download a binary from the server
- Type ftpc get -a <test.bin>
- After the binary is successfully downloaded it can be flashed to the MCU by using the boot command.
- MCU is reset after the programming is complete and test application (LED Toggles) code starts executing.
Output
Make sure the tera term baud rate to be 115200 for seeing the output properly.
Comments
- Reference Application Note: File Transfer Protocol using MPLAB Harmony v3 TCP/IP Stack (DS00004833).
- Getting Started Training Module: Getting Started with Harmony v3 Peripheral Libraries on SAM D5x/E5x MCUs
- 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