AnyCloud Example: TCP Client

This code example demonstrates the implementation of a TCP client with PSoC® 6 MCU and CYW43xxx connectivity devices. The example establishes a connection with a remote TCP server and based on the command received from the TCP server, turns the user LED ON or OFF. Additionally, this code example can be configured to bring up the Wi-Fi device either in STA interface or in Soft AP interface mode.

This example uses the Wi-Fi middleware core library of the AnyCloud SDK. This library enables Wi-Fi-based application development by bundling together various other libraries - FreeRTOS, Wi-Fi Host Driver (WHD), lwIP TCP/IP stack, Mbed TLS, and Cypress Secure Sockets. The Cypress Secure Sockets library provides an easy-to-use API by abstracting the network stack (lwIP) and the security stack (Mbed TLS).

Provide feedback on this code example.

Requirements

• ModusToolbox® software v2.2

  Note: This code example version requires ModusToolbox software version 2.2 or later and is not backward compatible with v2.1 or older versions. If you cannot move to ModusToolbox v2.2, use the latest compatible version of this example: latest-v1.X.

• Board Support Package (BSP) minimum required version: 2.0.0

• Programming Language: C

• Associated Parts: All PSoC® 6 MCU parts with SDIO, CYW43012, CYW4343W

Supported Toolchains (make variable 'TOOLCHAIN')

• GNU Arm® Embedded Compiler v9.3.1 (GCC_ARM) - Default value of TOOLCHAIN
• IAR C/C++ compiler v8.42.2 (IAR)

Supported Kits (make variable 'TARGET')

• PSoC 6 Wi-Fi BT Prototyping Kit (CY8CPROTO-062-4343W) - Default value of TARGET
• PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WIFI-BT)
• PSoC 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)
• PSoC 62S1 Wi-Fi BT Pioneer Kit (CYW9P62S1-43438EVB-01)
• PSoC 62S1 Wi-Fi BT Pioneer Kit (CYW9P62S1-43012EVB-01)
• Rapid IoT Connect Platform RP01 Feather Kit (CYSBSYSKIT-01)
• Rapid IoT Connect Developer Kit (CYSBSYSKIT-DEV-01)

Hardware Setup

This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly.

Note: The PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WIFI-BT) ship with KitProg2 installed. ModusToolbox software requires KitProg3. Before using this code example, make sure that the board is upgraded to KitProg3. The tool and instructions are available in the Firmware Loader GitHub repository. If you do not upgrade, you will see an error like "unable to find CMSIS-DAP device" or "KitProg firmware is out of date".

Software Setup

• Install a terminal emulator if you don't have one. Instructions in this document use Tera Term.

• Install a Python Interpreter if you don't have one. This code example is tested using Python 3.7.7.

Using the Code Example

Create the project and open it using one of the following:

In Eclipse IDE for ModusToolbox

1. Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox Application). This launches the Project Creator tool.

2. Pick a kit supported by the code example from the list shown in the Project Creator - Choose Board Support Package (BSP) dialog.

   When you select a supported kit, the example is reconfigured automatically to work with the kit. To work with a different supported kit later, use the Library Manager to choose the BSP for the supported kit. You can use the Library Manager to select or update the BSP and firmware libraries used in this application. To access the Library Manager, click the link from the Quick Panel.

   You can also just start the application creation process again and select a different kit.

   If you want to use the application for a kit not listed here, you may need to update the source files. If the kit does not have the required resources, the application may not work.

3. In the Project Creator - Select Application dialog, choose the example by enabling the checkbox.

4. Optionally, change the suggested New Application Name.

5. Enter the local path in the Application(s) Root Path field to indicate where the application needs to be created.

   Applications that can share libraries can be placed in the same root path.

6. Click Create to complete the application creation process.

For more details, see the Eclipse IDE for ModusToolbox User Guide (locally available at {ModusToolbox install directory}/ide_{version}/docs/mt_ide_user_guide.pdf).

In Command-line Interface (CLI)

ModusToolbox provides the Project Creator as both a GUI tool and a command line tool to easily create one or more ModusToolbox applications. See the "Project Creator Tools" section of the ModusToolbox User Guide for more details.

Alternatively, you can manually create the application using the following steps:

1. Download and unzip this repository onto your local machine, or clone the repository.

2. Open a CLI terminal and navigate to the application folder.

   On Linux and macOS, you can use any terminal application. On Windows, open the modus-shell app from the Start menu.

   Note: The cloned application contains a default BSP file (TARGET_xxx.mtb) in the deps folder. Use the Library Manager (make modlibs command) to select and download a different BSP file, if required. If the selected kit does not have the required resources or is not supported, the application may not work.

3. Import the required libraries by executing the make getlibs command.

Various CLI tools include a -h option that prints help information to the terminal screen about that tool. For more details, see the ModusToolbox User Guide (locally available at {ModusToolbox install directory}/docs_{version}/mtb_user_guide.pdf).

In Third-party IDEs

1. Follow the instructions from the In Command-line Interface (CLI) section to create the application, and import the libraries using the make getlibs command.

2. Export the application to a supported IDE using the make <ide> command.

   For a list of supported IDEs and more details, see the "Exporting to IDEs" section of the ModusToolbox User Guide (locally available at {ModusToolbox install directory}/docs_{version}/mtb_user_guide.pdf.

3. Follow the instructions displayed in the terminal to create or import the application as an IDE project.

Operation

1. Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.

2. The kit can be configured to run either as Wi-Fi STA interface mode or in AP interface mode. The interface mode is configured using the USE_AP_INTERFACE macro defined in the tcp_client.c file. Based on the desired interface mode, do the following:

   Kit in STA mode (Default Interface):

   1. Set the USE_AP_INTERFACE macro to '0'. This is the default mode.

   2. Modify the WIFI_SSID, WIFI_PASSWORD, and WIFI_SECURITY_TYPE macros to match with that of the Wi-Fi network credentials that you want to connect. These macros are defined in the tcp_client.c file. Ensure that the Wi-Fi network that you are connecting to is configured as a private network for the proper functioning of this example.

   Kit in AP mode:

   1. Set the USE_AP_INTERFACE macro to '1'.

   2. Update the SOFTAP_SSID, SOFTAP_PASSWORD, and SOFTAP_SECURITY_TYPE as desired. This step is optional.

   Note: CYSBSYSKIT-01 does not support AP mode and reserves UDP and TCP port numbers from 49152 to 57343.

3. Open a terminal program and select the KitProg3 COM port. Set the serial port parameters to 8N1 and 115200 baud.

4. Program the board using one of the following:

   Using Eclipse IDE for ModusToolbox

   1. Select the application project in the Project Explorer.

   2. In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).

   Using CLI

   From the terminal, execute the make program command to build and program the application using the default toolchain to the default target. You can specify a target and toolchain manually:

   make program TARGET=<BSP> TOOLCHAIN=<toolchain>
   

   Example:

   make program TARGET=CY8CPROTO-062-4343W TOOLCHAIN=GCC_ARM
   

Note: Before building the application, ensure that the deps folder contains the BSP file (TARGET_xxx.lib) corresponding to the TARGET. Execute the make getlibs command to fetch the BSP contents before building the application.

After programming, the application starts automatically. Confirm that the text as shown in Figure 1 for STA mode and Figure 2 in AP mode is displayed on the UART terminal. Note that in STA mode, the Wi-Fi SSID and IP address assigned will be different based on the network that you have connected to; in AP mode, the AP credentials will be different based on your configuration in Step 2.

Figure 1. UART Terminal Showing the Wi-Fi Connectivity Status in STA Mode

Figure 2. UART Terminal Showing the Wi-Fi Connectivity Status in AP Mode

5. Connect your computer to the Wi-Fi AP that you have configured in Step 2:

   • In STA mode: Connect the computer to the same AP to which the kit is connected.

   • In AP mode: Connect the computer to the kit's AP.

6. Open a command shell from the project directory and run the Python TCP server (tcp_server.py). In the command shell opened in the project directory, type in the following command:

   python tcp_server.py
   

   Make a note of the TCP server's IPv4 address.

   Note: Ensure that the firewall settings of your computer allow access to the Python software so that it can communicate with the TCP client. For more details on enabling Python access, refer to this community thread.

   Figure 3. TCP Server IPv4 Address

   

7. From the UART terminal, enter the IPv4 address for the TCP server as noted in Step 6.

   For example, if the TCP server IPv4 address is 192.168.10.2, then enter the IP address from the UART terminal as shown in Figure 4 and press the Enter key.

   Figure 4. Entering IPv4 Address from the UART Terminal

   

8. From the Python TCP server, send the command to turn the LED ON or OFF to the TCP client ('0' to turn LED OFF and '1' to turn LED ON). Observe the user LED (CYBSP_USER_LED) turning ON/OFF on the board.

   Figure 5. TCP Server Output

   

   Figure 6. LED Status on TCP Client

   

Note: Instead of using the Python TCP server (tcp_server.py), you can use the example mtb-example-anycloud-tcp-server to run as TCP server on a second kit. See the code example documentation.

Debugging

You can debug the example to step through the code. In the IDE, use the <Application Name> Debug (KitProg3_MiniProg4) configuration in the Quick Panel. For more details, see the "Program and Debug" section in the Eclipse IDE for ModusToolbox User Guide.

Note: (Only while debugging) On the CM4 CPU, some code in main() may execute before the debugger halts at the beginning of main(). This means that some code executes twice - once before the debugger stops execution, and again after the debugger resets the program counter to the beginning of main(). See KBA231071 to learn about this and for the workaround.

Design and Implementation

Resources and Settings

Table 1. Application Resources

Resource	Alias/Object	Purpose
SDIO (HAL)	sdio_obj	SDIO interface for Wi-Fi Connectivity
UART (HAL)	cy_retarget_io_uart_obj	UART HAL object used by Retarget-IO for Debug UART port
LED (BSP)	CYBSP_USER_LED	User LED to show the output

This example uses the Arm® Cortex®-M4 (CM4) CPU of PSoC 6 MCU to execute an RTOS task: TCP Client task. At device reset, the default Cortex-M0+ (CM0+) application enables the CM4 CPU and configures the CM0+ CPU to go to sleep.

In this example, PSoC 6 MCU is configured as a TCP client, which establishes a connection with a remote TCP server and, based on the command received from the TCP server, turns the user LED (CYBSP_USER_LED) ON or OFF.

Related Resources

Application Notes
AN228571 – Getting Started with PSoC 6 MCU on ModusToolbox	Describes PSoC 6 MCU devices and how to build your first application with ModusToolbox
AN221774 – Getting Started with PSoC 6 MCU on PSoC Creator	Describes PSoC 6 MCU devices and how to build your first application with PSoC Creator
AN210781 – Getting Started with PSoC 6 MCU with Bluetooth Low Energy (BLE) Connectivity on PSoC Creator	Describes PSoC 6 MCU with BLE Connectivity devices and how to build your first application with PSoC Creator
AN215656 – PSoC 6 MCU: Dual-CPU System Design	Describes the dual-CPU architecture in PSoC 6 MCU, and shows how to build a simple dual-CPU design
Code Examples
Using ModusToolbox	Using PSoC Creator
Device Documentation
PSoC 6 MCU Datasheets	PSoC 6 Technical Reference Manuals
Development Kits	Buy at www.cypress.com
CY8CKIT-062-BLE PSoC 6 BLE Pioneer Kit	CY8CKIT-062-WiFi-BT PSoC 6 WiFi-BT Pioneer Kit
CY8CPROTO-063-BLE PSoC 6 BLE Prototyping Kit	CY8CPROTO-062-4343W PSoC 6 Wi-Fi BT Prototyping Kit
CY8CKIT-062S2-43012 PSoC 62S2 Wi-Fi BT Pioneer Kit	CY8CPROTO-062S3-4343W PSoC 62S3 Wi-Fi BT Prototyping Kit
CYW9P62S1-43438EVB-01 PSoC 62S1 Wi-Fi BT Pioneer Kit	CYW9P62S1-43012EVB-01 PSoC 62S1 Wi-Fi BT Pioneer Kit
CY8CKIT-064B0S2-4343W PSoC 64 Secure Boot Wi-Fi BT Pioneer Kit	CYSBSYSKIT-01 Rapid IoT Connect Platform RP01 Feather Kit
CYSBSYSKIT-DEV-01 Rapid IoT Connect Developer Kit
Libraries
PSoC 6 Peripheral Driver Library (PDL) and docs	mtb-pdl-cat1 on GitHub
Cypress Hardware Abstraction Layer (HAL) Library and docs	mtb-hal-cat1 on GitHub
Retarget IO - A utility library to retarget the standard input/output (STDIO) messages to a UART port	retarget-io on GitHub
Middleware
CapSense® library and docs	capsense on GitHub
Links to all PSoC 6 MCU Middleware	psoc6-middleware on GitHub
Tools
Eclipse IDE for ModusToolbox	The cross-platform, Eclipse-based IDE for IoT designers that supports application configuration and development targeting converged MCU and wireless systems.
PSoC Creator™	The Cypress IDE for PSoC and FM0+ MCU development.

Other Resources

Cypress provides a wealth of data at www.cypress.com to help you select the right device, and quickly and effectively integrate it into your design.

For PSoC 6 MCU devices, see How to Design with PSoC 6 MCU - KBA223067 in the Cypress community.

Document History

Document Title: CE229112 - AnyCloud Example: TCP Client

Version	Description of Change
1.0.0	New code example
1.1.0	Updated for ModusToobox 2.1. Code updated to use Cypress Secure Sockets and Wi-Fi connection manager libraries.
1.2.0	Makefile updated to sync with BSP changes. Code updated to use binary semaphore.
2.0.0	Major update to support ModusToolbox software v2.2, added support for new kits. Added soft AP Wi-Fi interface mode. This version is not backward compatible with ModusToolbox software v2.1.
2.1.0	Added support for new kits

---

All other trademarks or registered trademarks referenced herein are the property of their respective owners.

---

© Cypress Semiconductor Corporation (An Infineon Technologies Company), 2020-2021. This document is the property of Cypress Semiconductor Corporation and its affiliates ("Cypress"). This document, including any software or firmware included or referenced in this document ("Software"), is owned by Cypress under the intellectual property laws and treaties of the United States and other countries worldwide. Cypress reserves all rights under such laws and treaties and does not, except as specifically stated in this paragraph, grant any license under its patents, copyrights, trademarks, or other intellectual property rights. If the Software is not accompanied by a license agreement and you do not otherwise have a written agreement with Cypress governing the use of the Software, then Cypress hereby grants you a personal, non-exclusive, nontransferable license (without the right to sublicense) (1) under its copyright rights in the Software (a) for Software provided in source code form, to modify and reproduce the Software solely for use with Cypress hardware products, only internally within your organization, and (b) to distribute the Software in binary code form externally to end users (either directly or indirectly through resellers and distributors), solely for use on Cypress hardware product units, and (2) under those claims of Cypress's patents that are infringed by the Software (as provided by Cypress, unmodified) to make, use, distribute, and import the Software solely for use with Cypress hardware products. Any other use, reproduction, modification, translation, or compilation of the Software is prohibited.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS DOCUMENT OR ANY SOFTWARE OR ACCOMPANYING HARDWARE, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. No computing device can be absolutely secure. Therefore, despite security measures implemented in Cypress hardware or software products, Cypress shall have no liability arising out of any security breach, such as unauthorized access to or use of a Cypress product. CYPRESS DOES NOT REPRESENT, WARRANT, OR GUARANTEE THAT CYPRESS PRODUCTS, OR SYSTEMS CREATED USING CYPRESS PRODUCTS, WILL BE FREE FROM CORRUPTION, ATTACK, VIRUSES, INTERFERENCE, HACKING, DATA LOSS OR THEFT, OR OTHER SECURITY INTRUSION (collectively, "Security Breach"). Cypress disclaims any liability relating to any Security Breach, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any Security Breach. In addition, the products described in these materials may contain design defects or errors known as errata which may cause the product to deviate from published specifications. To the extent permitted by applicable law, Cypress reserves the right to make changes to this document without further notice. Cypress does not assume any liability arising out of the application or use of any product or circuit described in this document. Any information provided in this document, including any sample design information or programming code, is provided only for reference purposes. It is the responsibility of the user of this document to properly design, program, and test the functionality and safety of any application made of this information and any resulting product. "High-Risk Device" means any device or system whose failure could cause personal injury, death, or property damage. Examples of High-Risk Devices are weapons, nuclear installations, surgical implants, and other medical devices. "Critical Component" means any component of a High-Risk Device whose failure to perform can be reasonably expected to cause, directly or indirectly, the failure of the High-Risk Device, or to affect its safety or effectiveness. Cypress is not liable, in whole or in part, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any use of a Cypress product as a Critical Component in a High-Risk Device. You shall indemnify and hold Cypress, its directors, officers, employees, agents, affiliates, distributors, and assigns harmless from and against all claims, costs, damages, and expenses, arising out of any claim, including claims for product liability, personal injury or death, or property damage arising from any use of a Cypress product as a Critical Component in a High-Risk Device. Cypress products are not intended or authorized for use as a Critical Component in any High-Risk Device except to the limited extent that (i) Cypress's published data sheet for the product explicitly states Cypress has qualified the product for use in a specific High-Risk Device, or (ii) Cypress has given you advance written authorization to use the product as a Critical Component in the specific High-Risk Device and you have signed a separate indemnification agreement.
Cypress, the Cypress logo, Spansion, the Spansion logo, and combinations thereof, WICED, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress in the United States and other countries. For a more complete list of Cypress trademarks, visit cypress.com. Other names and brands may be claimed as property of their respective owners.