Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

mtb-example-wifi-tcp-client/README.md

Go to file
 
 
Cannot retrieve contributors at this time
TCP client Requirements Supported toolchains (make variable 'TOOLCHAIN') Supported kits (make variable 'TARGET') Hardware setup Software setup Using the code example Create the project Open the project Operation Debugging Design and implementation Resources and settings Using ThreadX and NetX Duo Related resources Other resources Document history
398 lines (238 sloc) 28.9 KB
Raw Blame
Open in GitHub Desktop

TCP client

This code example demonstrates the implementation of a TCP client with PSoC™ 6 MCU with AIROC™ CYW43xxx Wi-Fi & Bluetooth® combo chips. This example establishes a connection with a remote TCP server based on the command received from the TCP server, which 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 Soft AP interface mode.

This example uses the Wi-Fi Core FreeRTOS lwIP mbedtls library of the SDK. This library enables application development based on Wi-Fi by pulling wifi-connection-manager, FreeRTOS, lwIP, mbed TLS, secure sockets, and other dependent modules. The secure sockets library provides an easy-to-use API by abstracting the network stack (lwIP) and the security stack (mbed TLS).

This example can be modified to use ThreadX and NetX Duo instead of FreeRTOS and lwIP. See the Design and implementation section for more details.

View this README on GitHub.

Provide feedback on this code example.

Requirements

Supported toolchains (make variable 'TOOLCHAIN')

  • GNU Arm® Embedded Compiler v11.3.1 (GCC_ARM) – Default value of TOOLCHAIN
  • Arm® Compiler v6.16 (ARM)
  • IAR C/C++ Compiler v9.30.1 (IAR)

Supported kits (make variable 'TARGET')

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 Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-062-WIFI-BT) ships with KitProg2 installed. The 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

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

  2. 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

The ModusToolbox™ tools package provides the Project Creator as both a GUI tool and a command line tool.

Use Project Creator GUI

  1. Open the Project Creator GUI tool.

    There are several ways to do this, including launching it from the dashboard or from inside the Eclipse IDE. For more details, see the Project Creator user guide (locally available at {ModusToolbox™ install directory}/tools_{version}/project-creator/docs/project-creator.pdf).

  2. On the Choose Board Support Package (BSP) page, select a kit supported by this code example. See Supported kits.

    Note: To use this code example 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. On the Select Application page:

    a. Select the Applications(s) Root Path and the Target IDE.

    Note: Depending on how you open the Project Creator tool, these fields may be pre-selected for you.

    b. Select this code example from the list by enabling its check box.

    Note: You can narrow the list of displayed examples by typing in the filter box.

    c. (Optional) Change the suggested New Application Name and New BSP Name.

    d. Click Create to complete the application creation process.

Use Project Creator CLI

The 'project-creator-cli' tool can be used to create applications from a CLI terminal or from within batch files or shell scripts. This tool is available in the {ModusToolbox™ install directory}/tools_{version}/project-creator/ directory.

Use a CLI terminal to invoke the 'project-creator-cli' tool. On Windows, use the command-line 'modus-shell' program provided in the ModusToolbox™ installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ tools. You can access it by typing "modus-shell" in the search box in the Windows menu. In Linux and macOS, you can use any terminal application.

The following example clones the "mtb-example-wifi-tcp-client" application with the desired name "TcpClient" configured for the CY8CPROTO-062S2-43439 BSP into the specified working directory, C:/mtb_projects:

project-creator-cli --board-id CY8CPROTO-062S2-43439 --app-id mtb-example-wifi-tcp-client --user-app-name TcpClient --target-dir "C:/mtb_projects"

The 'project-creator-cli' tool has the following arguments:

Argument Description Required/optional
--board-id Defined in the field of the BSP manifest Required
--app-id Defined in the field of the CE manifest Required
--target-dir Specify the directory in which the application is to be created if you prefer not to use the default current working directory Optional
--user-app-name Specify the name of the application if you prefer to have a name other than the example's default name Optional

Note: The project-creator-cli tool uses the git clone and make getlibs commands to fetch the repository and import the required libraries. For details, see the "Project creator tools" section of the ModusToolbox™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).

Open the project

After the project has been created, you can open it in your preferred development environment.

Eclipse IDE

If you opened the Project Creator tool from the included Eclipse IDE, the project will open in Eclipse automatically.

For more details, see the Eclipse IDE for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_ide_user_guide.pdf).

Visual Studio (VS) Code

Launch VS Code manually, and then open the generated {project-name}.code-workspace file located in the project directory.

For more details, see the Visual Studio Code for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_vscode_user_guide.pdf).

Keil µVision

Double-click the generated {project-name}.cprj file to launch the Keil µVision IDE.

For more details, see the Keil µVision for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_uvision_user_guide.pdf).

IAR Embedded Workbench

Open IAR Embedded Workbench manually, and create a new project. Then select the generated {project-name}.ipcf file located in the project directory.

For more details, see the IAR Embedded Workbench for ModusToolbox™ user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_iar_user_guide.pdf).

Command line

If you prefer to use the CLI, open the appropriate terminal, and navigate to the project directory. On Windows, use the command-line 'modus-shell' program; on Linux and macOS, you can use any terminal application. From there, you can run various make commands.

For more details, see the ModusToolbox™ tools package user guide (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).

Operation

If using a PSoC™ 64 "Secure" MCU kit (like CY8CKIT-064B0S2-4343W), the PSoC™ 64 device must be provisioned with keys and policies before being programmed. Follow the instructions in the "Secure Boot" SDK user guide to provision the device. If the kit is already provisioned, copy-paste the keys and policy folder to the application folder.

Note: Use policy_single_CM0_CM4_smif_swap.json policy instead of using the default one "policy_single_CM0_CM4_swap.json" to provision CY8CKIT-064B0S2-4343W device.

  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 in the Wi-Fi STA or AP interface modes. Configure the interface mode 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'; default mode.

    2. Modify the WIFI_SSID, WIFI_PASSWORD, and WIFI_SECURITY_TYPE macros to match the Wi-Fi network credentials that you want to connect to in the tcp_client.c file. Ensure to configure your connecting Wi-Fi network 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. (Optional) Update the SOFTAP_SSID, SOFTAP_PASSWORD, and SOFTAP_SECURITY_TYPE as desired.

  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™ software

    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. The default toolchain is specified in the application's Makefile but you can override this value manually:

    make program TOOLCHAIN=<toolchain>

    Example:

    make program TOOLCHAIN=GCC_ARM

    Figure 1. Wi-Fi connectivity status in STA mode


    Figure 2. Wi-Fi connectivity status in AP mode

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

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

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

  6. Open a command shell from the project directory and run the Python TCP server (tcp_server.py). Enter the following command:

    python tcp_server.py

Note the TCP server's IPv4 address.

Note: Ensure that the firewall settings of your PC allow access to the Python software to communicate with the TCP client. For more details on enabling Python access, see the community thread.

Figure 3. TCP server IPv4 address

  1. 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 the IPv4 address from the UART terminal

  2. From the Python TCP server, send the command to turn the LED ON or OFF to the TCP client ('0' and '1' to turn the LED OFF and ON respectively). 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 STA mode


    Figure 6. LED status on TCP client AP mode

Note: Instead of using the Python TCP server (tcp_server.py), you can use the example mtb-example-wifi-tcp-server to run as the 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 details, see the "Program and debug" section in the Eclipse IDE for ModusToolbox™ software 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 the 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.

Using ThreadX and NetX Duo

This code example can be modified to use the ThreadX and NetX Duo instead of the default FreeRTOS and lwIP. All the source and configuration files required by both the RTOSes are already present in their COMPONENT_* folders. By default, the FreeRTOS and lwIP libraries are added as dependencies in this code example. Follow these steps to configure the code example to use ThreadX and NetX Duo instead.

Adding ThreadX and NetX Duo libraries
  1. In the Quick Panel, scroll down, and click Library Manger <version>.
  2. In the Library Manager window, delete the wifi-core-freertos-lwip-mbedtls library. This will delete all the dependent libraries as well.
  3. Click the Add Library button and add the following libraries back. This step requires a bundle repo for ThreadX, NetX Duo, and NetX Secure does not exist. 
    abstraction-rtos
clib-support
connectivity-utilities
netxduo-network-interface-integration
secure-sockets
whd-bsp-integration
wifi-connection-manager
wifi-host-driver
  4. Click OK and Update. After the libraries are updated, click Close.
  5. The ThreadX and NetX Duo libraries do not show up in the library manager as these are not distributed by Infineon. Add these libraries manually. To add the ThreadX library, create a file called threadx.mtb in the deps folder of the code example with the following content:
https://github.com/azure-rtos/threadx#v6.1.5_rel#$$ASSET_REPO$$/threadx/v6.1.5_rel
  1. To add the NetX Duo library, create a file called netxduo.mtb in the deps folder with the following content:
https://github.com/azure-rtos/netxduo#v6.2.0_rel#$$ASSET_REPO$$/netxduo/v6.2.0_rel
  1. From the Terminal window, execute the make getlibs command to fetch these libraries.
Makefile changes
  1. Change the following lines from
COMPONENTS=FREERTOS

to

COMPONENTS=THREADX

Follow the steps in the Using the code example section to run this code example.

Note: NetXDuo network stack used with ThreadX does not have the option to dynamically configure the TCP keep alive parameters (interval, count, and idle time). Therefore, the secure sockets cy_socket_setsockopt function fails with an error code "CY_RSLT_MODULE_SECURE_SOCKETS_OPTION_NOT_SUPPORTED".

In the code example, you can skip cy_socket_setsockopt calls (except CY_SOCKET_SO_TCP_KEEPALIVE_ENABLE) related to TCP keepalive in the ThreadX environment. And you can configure the desired TCP keep alive parameters by changing the following defines in nx_user.h file:

NX_TCP_KEEPALIVE_RETRIES
NX_TCP_KEEPALIVE_INITIAL
NX_TCP_KEEPALIVE_RETRY

Note: The version of the code example currently supports ThreadX and the NetXDuo network stack in GCC_ARM toolchain only. Support for other toolchains will be added in a future version of the code example.


Related resources

Resources Links
Application notes AN228571 – Getting started with PSoC™ 6 MCU on ModusToolbox™ software
AN215656 – PSoC™ 6 MCU: Dual-CPU system design
Code examples Using ModusToolbox™ software on GitHub
Device documentation PSoC™ 6 MCU datasheets
PSoC™ 6 technical reference manuals
Development kits Select your kits from the evaluation board finder
Libraries on GitHub mtb-pdl-cat1 – PSoC™ 6 Peripheral Driver Library (PDL)
mtb-hal-cat1 – Hardware Abstraction Layer (HAL) library
retarget-io – Utility library to retarget STDIO messages to a UART port
Middleware on GitHub psoc6-middleware – Links to all PSoC™ 6 MCU middleware
Tools Eclipse IDE for ModusToolbox™ software – ModusToolbox™ software is a collection of easy-to-use software and tools enabling rapid development with Infineon MCUs, covering applications from embedded sense and control to wireless and cloud-connected systems using AIROC™ Wi-Fi and Bluetooth® connectivity devices.

Other resources

Infineon provides a wealth of data at www.infineon.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 Infineon Developer community.

Document history

Document title: CE229112 - TCP client

Version Description of change
1.0.0 New code example
1.1.0 Updated for ModusToolbox™ 2.1
Code updated to use 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
2.2.0 Updated to support FreeRTOS v10.3.1
3.0.0 Major update to support ModusToolbox™ v3.0 and BSPs v4.X. This version is not backward compatible with previous versions of ModusToolbox™ software
3.1.0 Added support for CY8CKIT-064B0S2-4343W
4.0.0 Updated to use abstraction-rtos to support various RTOS environments
4.1.0 Added support for CY8CEVAL-062S2-CYW43022CUB
4.2.0 Added support for CY8CEVAL-062S2-CYW955513SDM2WLIPA

© Cypress Semiconductor Corporation, 2020-2023. This document is the property of Cypress Semiconductor Corporation, an Infineon Technologies company, 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, including its affiliates, and its directors, officers, employees, agents, 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, and combinations thereof, WICED, ModusToolbox, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress or a subsidiary of Cypress in the United States or in other countries. For a more complete list of Cypress trademarks, visit www.infineon.com. Other names and brands may be claimed as property of their respective owners.