1.6 TCP/IP UDP Client

This application demonstrates usage of MPLAB Harmony UDP API to implement a UDP client that establishes TCP/IP connection to a UDP server, on port 9760.

Description

The TCP/IP UDP Client application is based on MPLAB® Harmony 3 TCP/IP Stack.

The Harmony TCP/IP stack is a collection of different network protocols.

The source files of Harmony 3 TCP/IP stack is available here.

The demo is created with MPLAB X IDE and MCC plugin.

MCC Project Graph - TCP/IP UDP Client

The following Project Graph shows the Harmony components included in the TCP/IP UDP Client demo application.

Figure 1-19. Project Graph

TCP/IP Configuration - TCP/IP UDP Client

The TCP/IP modules enabled for the demo is shown in the TCP/IP Configuration Overview

More details of TCP/IP Configuration plugin is available here

Figure 1-20. TCP/IP Configuration - Gigabit Ethernet MAC (GMAC0)

The Ethernet interface in the above configuration use 1 Gbps internal GMAC peripheral and Gigabit Ethernet PHY Transceiver KSZ9131.

Figure 1-21. TCP/IP Configuration - 10/100 Ethernet MAC (GMAC1)

The Ethernet interface in the above configuration use 10/100 Mbps internal GMAC peripheral and Ethernet PHY Transceiver KSZ8081.

The Application Layer modules enabled in the demo are as follows:

  • Application Layer Modules
    • DHCP Client to discover the IPv4 address from the nearest DHCP Server.
    • DNS Client provides DNS resolution capabilities to the stack.

The Ethernet interface in this demo use internal GMAC peripheral and Gigabit Ethernet PHY Transceiver KSZ9131.

Downloading and Building the application

To clone or download this application from Github, go to the main page of this repository and then click Clone button to clone this repository or download as zip file.

This content can also be downloaded using content manager by following these instructions.

Path of the application within the repository is apps\tcpip_udp_client\firmware .

To build the application, refer to the following list of demo configurations and open the project using MPLAB X IDE.

Table 1-7. Demo Configurations
Project NameTarget DeviceDevelopment BoardDescription
sam_a7g5_ek_GMAC0.XSAMA7G54SAMA7G54-EKTCP/IP UDP Client Application with Gigabit Ethernet - Bare Metal
sam_a7g5_ek_GMAC0_freertos.XSAMA7G54SAMA7G54-EKTCP/IP UDP Client Application with Gigabit Ethernet - FreeRTOS
sam_a7g5_ek_GMAC1.XSAMA7G54SAMA7G54-EKTCP/IP UDP Client Application with 10/100 Ethernet - Bare Metal
sam_a7g5_ek_GMAC1_freertos.XSAMA7G54SAMA7G54-EKTCP/IP UDP Client Application with 10/100 Ethernet - FreeRTOS

Hardware Setup

The target board for running the application is SAMA7G54-EK.

This section provides essential hardware configuration of this target board to run TCP/IP applications.

Figure 1-22. SAMA7G54-EK

Board Setup

To set up the hardware, refer to the section Board Setup in SAMA7G54-EK User Guide.

  • For Gigabit Ethernet connection, connect Ethernet cable between RJ45 socket (J5) and router/switch/computer.
  • For 10/100 Ethernet connection, connect Ethernet cable between RJ45 socket (J6) and router/switch/computer.

Setting up at91bootstrap loader

To load the application binary onto the target device, we need to use at91bootstrap loader.

Refer to the at91bootstrap loader documentation for details on how to configure and run/debug the application using MPLABX and booting application using an SD Card.

Running the Application

  1. Open a terminal application on the host computer (like Hyper-terminal or Tera Term).
  2. Configure the terminal application for serial port connected to JLink CDC UART Port.
  3. Set baud rate as 115200 in the terminal application.
  4. Build and download the application project on the target board.
  5. For 1000 Mbps operation, ensure connection from Gigabit(1000Mbps) capable network socket of a router/switch/computer to socket J5 on the board. For 10/100 Mbps operation, connect to socket J6.
  6. Verify the TCP/IP Stack initialization console messages.

GMAC0 - Console Start up

GMAC1 - Console Start up

If DHCP client is enabled in the demonstration, wait for the DHCP server to assign an IP address for the development board.

This will be printed on the console. Otherwise, the default static IP address will be assigned to the board.

UDP Client Test

For UDP Client test, a UDP Server application is required to run on the host computer.

In this demonstration, we use PacketSender utility configured as UDP server.

Application commands for this demo are : setopt, getopt and sendudp.

  • setopt : Set the UDP packet options like destination IP address, destination port and message to send
  • getopt : Readback the current settings
  • sendudp : Send the UDP packet
See the following screenshot of Console with UDP Client Commands, for the test with Gigabit Ethernet GMAC0.

See the following screenshot of UDP Server (PacketSender) receiving message from UDP Client.