Jump to main content

##

# 1.3 TCP/IP TCP Server

This application demonstrates usage of MPLAB Harmony TCP API to implement a TCP echo server on port 9760.

## Description

The TCP/IP TCP 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 Server

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

Figure 1-7.Project Graph

FreeRTOS component is required for RTOS application. For bare-metal (non-RTOS) FreeRTOS component should not be selected.

TCP/IP Configuration - TCP/IP TCP 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

Figure 1-8.TCP/IP Configuration - PIC32WM_BZ6 Curiosity

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 MCC content manager available as part of the MPLAB® X IDE.

Path of the application within the repository is apps\tcpip_tcp_server\ .

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

Table 1-4.Demo Configurations
Project Name | Target Device | Development Board | Description
--- | --- | --- | ---
pic32wm_bz6_curiosity.X | PIC32WM_BZ6204 | PIC32-BZ6 Curiosity Board | TCP/IP TCP Server Application - Bare Metal
pic32wm_bz6_curiosity_freertos.X | PIC32WM_BZ6204 | PIC32-BZ6 Curiosity Board | TCP/IP TCP Server Application - FreeRTOS

## Hardware Setup- PIC32-BZ6 Curiosity Board

The target board for running the application is PIC32-BZ6 Curiosity Board.

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

Figure 1-9.PIC32-BZ6 Curiosity Board

Board Setup

- Default jumper setting of the board is shown above.
- Connect the USB Type-C cable between DEBUG USB port on the board and host PC.
- Establish a connection between the router/switch with the PIC32-BZ6 Curiosity Board through the RJ45 connector, using the Ethernet cable.

## 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 “USB Serial Device”.
3. Set baud rate as 115200 in the terminal application.
4. Build and download the application project on the target board.
5. 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 Server Test

For TCP Server test, a TCP Client application is required to run on the host computer (SocketTest, PacketSender etc).

In this demonstration, we use SocketTest utility.

- Send a TCP packet to the IP address of the hardware board, port 9760, from TCP Client application (SocketTest) running on the computer. See the following screenshot of test .
- The TCP Server running on the hardware board will echo back the message it receives. See the console screenshot of test below.