1.9 TCP/IP TCP and UDP Client Server
The TCP/IP TCP & UDP Client Server configuration demonstrates creating a network client and a network server that uses both TCP and UDP socket APIs respectively.
Description
The TCP/IP TCP and UDP Client Server 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 TCP and UDP Client Server
The following Project Graph shows the Harmony components included in the TCP/IP TCP and UDP Client Server demo application.
FreeRTOS component is required for an RTOS application.
TCP/IP Configuration - TCP/IP TCP and UDP Client Server
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
The Application Layer modules enabled in the demo are as follows:
- Application Layer Modules
- ANNOUNCE to discover the Microchip devices within a local network.
- DHCP Client to discover the IPv4 address from the nearest DHCP Server.
- DNS Client provides DNS resolution capabilities to the stack.
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_client_server\firmware
To build the application, refer to the following list of demo configurations and open the project using MPLAB X IDE.
| Project Name | Target Device | Development Board | Description |
|---|---|---|---|
| pic32cz_ca70_curiosity_ultra_freertos.X | PIC32CZ2051CA70144 | PIC32CZ CA70 Curiosity Ultra + LAN8720 PHY Daughter Board | TCP/IP TCP and UDP Client Server Application - FreeRTOS |
Hardware Setup - PIC32CZ CA70 Curiosity Ultra
The target board for running the application is PIC32CZ CA70 Curiosity Ultra.
This section provides essential hardware configuration of this target board to run TCP/IP applications.
Board Setup
To set up the hardware, refer to the PIC32CZ CA70 Curiosity Ultra User's Guide.
- Default jumper setting of the board is shown above.
- Connect the micro USB cable between DEBUG USB port on the board and host PC.
- Establish a connection between the router/switch with the PIC32CZ CA70 Curiosity Ultra board through the RJ45 connector, using the Ethernet cable.
Running the Application
- Open a terminal application on the host computer (like Hyper-terminal or Tera Term).
- Configure the terminal application for serial virtual COM port.
- Set baud rate as 115200 in the terminal application.
- Build and download the application project on the target board.
- Verify the TCP/IP Stack initialization console messages.
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.
By entering the command netinfo, the response is obtained as shown above.
TCP and UDP Client Server Test
The application can create 4 separate connections, each one running in its own thread:
- TCP client connection
- TCP server connection
- UDP client connection
- UDP server connection
Each connection has its own set of commands.
Commands can open or close the sockets, send messages from socket, display the received messages, configure the sockets etc.
help command will display the available application commands.
Hence, TCP and UDP Client & Server tests can be performed by using these commands using your preferred networking tools on the PC side ( SocketTest, netcat, Packet Sender, Hercules, python scripts, etc )