Overview

This library provides a framework to add command console support to your application. Support for Wi-Fi, Ethernet, iPerf, Bluetooth Low Energy (BLE), and WebSocket commands is bundled with this library.

MTB AnyCloud Wi-Fi Bluetooth Tester application is built over this library for Wi-Fi kits.

Please refer Readme for more information.

Features and Functionality

• Supports Wi-Fi commands to perform network operations such as scan, join, etc.
• Supports Ethernet commands to perform network operations such as ethernet interface up and ethernet interface down.
• Integrates iPerf 2.0 commands. iPerf is a tool for active measurements of the maximum achievable bandwidth on IP networks.
• Supports TCP client/server and UDP client/server on IPv4. IPv6 support will be added in the future.
• Supports Bluetooth LE commands including Tx/Rx for measuring BLE throughput

• Supports WebSocket commands for interactive client and server operations, including secure (WSS/TLS) connections. Requires the websocket middleware library.

  Note

  While iPerf provides several other commands, only a subset of commands that are relevant to embedded connectivity use cases is enabled in this library.

Supported Platforms

ModusToolbox™

• PSoC™ 6 WiFi-BT Prototyping Kit (CY8CPROTO-062-4343W)
• PSoC™ 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-LAI-4373M2)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-MUR-43439M2)
• CYW943907AEVAL1F evaluation kit (CYW943907AEVAL1F)
• CYW954907AEVAL1F evaluation kit (CYW954907AEVAL1F)
• XMC7200D-E272K8384 kit (KIT-XMC72-EVK)
• XMC7200D-E272K8384 kit (KIT_XMC72_EVK_MUR_43439M2)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-CYW43022CUB)
• CYW955913EVK-01 Wi-Fi Bluetooth® Prototyping Kit (CYW955913EVK-01)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-CYW955513SDM2WLIPA)

Supported Frameworks

• ModusToolbox™ environment: In this environment the command-console Library uses the abstraction-rtos library that provides the RTOS abstraction API and uses the secure-sockets library for implementing socket functions. For the BLE functionality, this library uses BT stack Integration.

Dependent Libraries

ModusToolbox™

• Wi-Fi connection manager
• Ethernet connection manager
• BT stack Integration
• WebSocket (required for WebSocket utility commands)

Quick Start

This library is supported on ModusToolbox™ frameworks. See the following section to build the library in those frameworks.

ModusToolbox™

• For Wi-Fi kits,

  • To include wifi-connection-manager library, the application should pull wifi-core-freertos-lwip-mbedtls library which will internally pull wifi-connection-manager and other dependent modules. To pull wifi-core-freertos-lwip-mbedtls create the following *.mtb* file in deps folder. wifi-core-freertos-lwip-mbedtls.mtb: https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls#latest-v1.X#$$ASSET_REPO$$/wifi-core-freertos-lwip-mbedtls/latest-v1.X

  Note

  For CYW955913EVK-01, to include wifi-connection-manager library, the application should pull wifi-core-freertos-lwip-mbedtls library which will internally pull wifi-connection-manager and other dependent modules.

  • To pull wifi-core-threadx-cat5 create the following *.mtb* file in deps folder. wifi-core-threadx-cat5.mtb: https://github.com/Infineon/wifi-core-threadx-cat5#latest-v1.X#$$ASSET_REPO$$/wifi-core-threadx-cat5/latest-v1.X

• For Ethernet kits,
  • To include ethernet-connection-manager library, the application should pull ethernet-core-freertos-lwip-mbedtls library which will internally pull ethernet-connection-manager and other dependent modules. To pull ethernet-core-freertos-lwip-mbedtls create the following *.mtb* file in deps folder. ethernet-core-freertos-lwip-mbedtls.mtb: https://github.com/Infineon/ethernet-core-freertos-lwip-mbedtls#latest-v1.X#$$ASSET_REPO$$/ethernet-core-freertos-lwip-mbedtls/latest-v1.X
• To pull BT stack Integration create the following *.mtb* file in deps folder. btstack-integration.mtb: https://github.com/Infineon/btstack-integration#latest-v5.X#$$ASSET_REPO$$/btstack-integration/latest-v5.X

  Note

  BT stack Integration should not be included for CYW955913EVK-01.

• Review and make the required changes to the pre-defined configuration files and Makefile COMPONENTS in the application.
  • The configuration files are bundled with the Wi-Fi core freertos lwip mbedtls library/Ethernet core freertos lwip mbedtls library for FreeRTOS, lwIP, and Mbed TLS.
    • See README.md of Wi-Fi core freertos lwip mbedtls library for Wi-Fi kits.
    • See README.md of Ethernet core freertos lwip mbedtls library for Ethernet kits.
  • If the application is using bundle library then the configuration files are in the bundle library. For example if the application is using Wi-Fi core freertos lwip mbedtls bundle library, the configuration files are in wifi-core-freertos-lwip-mbedtls/configs folder. Similarly if the application is using Ethernet Core FreeRTOS lwIP mbedtls library, the configuration files are in ethernet-core-freertos-lwip-mbedtls/configs folder.
• A set of COMPONENTS must be defined in the code example project's Makefile for this library. See the Quick Start section in README.md.

  COMPONENTS=FREERTOS MBEDTLS LWIP

  Note

  For CYW955913EVK-01 the above defines are not applicable.

• For Wi-Fi kits, to enable the Wi-Fi functionality, add WCM to the COMPONENTS section in the application's Makefile:

  COMPONENTS=WCM

• For Ethernet kits, to enable the ethernet functionality, add ECM to the COMPONENTS section in the application's Makefile:

  COMPONENTS=ECM

• To enable BLE functionality, add WICED_BLE to the COMPONENTS section in the application's Makefile:

  COMPONENTS=WICED_BLE

• Add the following compiler directives to the DEFINES section in the application's Makefile:

  DEFINES=HAVE_SNPRINTF

• Tune the lwIP configuration parameters listed in application's lwipopts.h file, depending on the required Wi-Fi throughput and use case.

  Note

  For CYW955913EVK-01 the above configuration is not applicable.

WebSocket Commands

The WebSocket utility provides a unified ws command for interactive client and server operations from a serial terminal. Both plain (WS) and secure (WSS/TLS) connections are supported.

Prerequisites

• The device must be connected to a Wi-Fi network before using WebSocket commands.
• For TLS (WSS) connections, copy websocket_certificates.h from the library's source/websocket_utility/ directory into your application source directory and populate it with valid PEM-encoded certificates and keys.
• Add the websocket library to your project's deps folder.
• The TLS 1.3 handshake (mbedtls RSA operations) requires more stack than the default console thread provides. The default 6 KB is insufficient for WSS connections and will cause a stack overflow. Increase the console thread stack size in your application Makefile:

  DEFINES+=CONSOLE_THREAD_STACK_SIZE=(12*1024)

Command Options

Option	Long form	Description
-c	--client	Client mode
-s	--server	Server mode
-p	--port	Port number
-t	--type	Message type (text/binary/ping)
-m	--message	Message content
-cid	--clientid	Connected client ID (server mode)
tls		Enable TLS/WSS (positional flag)

Client Commands

Command	Syntax	Description
Connect	ws -c connect <host> -p <port> [tls]	Connect to a WebSocket server. Append tls for WSS.
Send text	ws -c send -t text -m <message>	Send a text frame.
Send binary	ws -c send -t binary -m <hex_string>	Send a binary frame (payload as hex).
Send ping	ws -c send -t ping -m <payload>	Send a ping frame.
Disconnect	ws -c disconnect	Gracefully disconnect from the server.

Server Commands

Command	Syntax	Description
Start	ws -s start -p <port> [tls]	Start a WebSocket server. Append tls for WSS.
Send	ws -s send -cid <id> -t <text&#124;binary> -m <msg>	Send to a specific connected client.
Stop	ws -s stop	Stop the server and release resources.

Sample Sessions

// Client Non-TLS
> ws -c connect 192.168.1.100 -p 50007
> ws -c send -t text -m "Hello"
> ws -c disconnect
 
// Client TLS
> ws -c connect 192.168.1.100 -p 50007 tls
> ws -c send -t text -m "Hello TLS"
> ws -c disconnect
 
// Server Non-TLS
> ws -s start -p 50007
> ws -s send -cid 0 -t text -m "Hi client"
> ws -s stop
 
// Server TLS
> ws -s start -p 50007 tls
> ws -s send -cid 0 -t text -m "Hi TLS client"
> ws -s stop

Note

Only one client instance and one server instance are supported simultaneously.

Disabling Unused Utilities

When using only the WebSocket utility, disable unused utilities to reduce code size by adding the following to your application Makefile:

DEFINES+=DISABLE_COMMAND_CONSOLE_WIFI DISABLE_COMMAND_CONSOLE_BT DISABLE_COMMAND_CONSOLE_IPERF DISABLE_COMMAND_CONSOLE_ETH

To disable WebSocket commands:

DEFINES+=DISABLE_COMMAND_CONSOLE_WEBSOCKET

ModusToolbox™

These code snippets demonstrate the initialization and usage of Command Console library APIs.

Code Snippet 1: Addition and deletion of commands

Initializes Command Console library and adds/removes commands.

 
#define CONSOLE_COMMAND_MAX_PARAMS     (32)
#define CONSOLE_COMMAND_MAX_LENGTH     (85)
#define CONSOLE_COMMAND_HISTORY_LENGTH (10)
 
const char* console_delimiter_string_doxygen = " ";
 
static char command_buffer[CONSOLE_COMMAND_MAX_LENGTH];
static char command_history_buffer[CONSOLE_COMMAND_MAX_LENGTH * CONSOLE_COMMAND_HISTORY_LENGTH];
 
int test_console_command_doxygen(int argc, char *argv[], tlv_buffer_t** data)
{
    printf (" test_console_command is called , argc = %d , argv = %s \n", argc, argv[1]);
    return 0;
}
 
#define TEST_CONSOLE_COMMANDS \
    { (char*) "test_console_command",           test_console_command_doxygen, 1, NULL, NULL, (char *)"", (char *)"sample command with 1 argument" }, \
 
const cy_command_console_cmd_t test_command_table_doxygen[] =
{
    TEST_CONSOLE_COMMANDS
    CMD_TABLE_END
};
 
int snippet_add_remove_command_table(void)
{
 
    cy_command_console_cfg_t console_cfg;
    uint16_t wait_time = 0;
    cy_rslt_t result = CY_RSLT_SUCCESS;
 
    printf("Executing add-remove command snippet\n");
    console_cfg.serial             = (void *)&cy_retarget_io_uart_obj;
    console_cfg.line_len           = sizeof(command_buffer);
    console_cfg.buffer             = command_buffer;
    console_cfg.history_len        = CONSOLE_COMMAND_HISTORY_LENGTH;
    console_cfg.history_buffer_ptr = command_history_buffer;
    console_cfg.delimiter_string   = console_delimiter_string_doxygen;
    console_cfg.params_num         = CONSOLE_COMMAND_MAX_PARAMS;
    console_cfg.thread_priority    = CY_RTOS_PRIORITY_NORMAL;
 
    /* Initialize the Command Console library. */
    result = cy_command_console_init(&console_cfg);
    if ( result != CY_RSLT_SUCCESS )
    {
        printf ("Error in initializing command console library : %lu \n", (unsigned long)result);
        goto error;
    }
 
    /* Add the command table. */
    result = cy_command_console_add_table ( test_command_table_doxygen );
    if ( result != CY_RSLT_SUCCESS )
    {
        printf ("Error in adding command console table : %lu \n", (unsigned long)result);
        goto error;
    }
 
    /* Wait for a while to use the commands. */
    while(1)
    {
        cy_rtos_delay_milliseconds(500);
        wait_time += 500;
        if(wait_time == 5000)
        {
            break;
        }
    }
 
    /* Delete the command table. */
    result = cy_command_console_delete_table ( test_command_table_doxygen );
    if ( result != CY_RSLT_SUCCESS )
    {
        printf ("Error in removing command console table : %lu \n", (unsigned long)result);
        goto error;
    }
 
    /* De-initialize the Command Console  library. */
    result = cy_command_console_deinit();
    if ( result != CY_RSLT_SUCCESS )
    {
        printf ("command console deinit failed : %lu \n", (unsigned long)result);
        goto error;
    }
 
    return 0;
 
error:
    return -1;
}
 

Code Snippet 2: Initialization and addition of Utility commands

Initializes Command Console library and adds the Wi-Fi and BT utility commands provided by the library.

 
#include "command_console.h"
#include "iperf_utility.h"
#include "bt_utility.h"
#include "wifi_utility.h"
 
/* WCM parameters. */
static cy_wcm_config_t wcm_config;
 
int snippet_command_console_utility(void) {
 
    cy_command_console_cfg_t console_cfg;
    cy_rslt_t result = CY_RSLT_SUCCESS;
 
    /* Initialize WCM. */
    wcm_config.interface = CY_WCM_INTERFACE_TYPE_STA;
    result = cy_wcm_init(&wcm_config);
    if(result != CY_RSLT_SUCCESS)
    {
        printf("cy_wcm_init failed with error: %lu\n", (unsigned long)result);
        return -1;
    }
    printf("WCM Initialized\n");
 
 
    printf("Executing command console utility snippet \n");
    console_cfg.serial             = (void *)&cy_retarget_io_uart_obj;
    console_cfg.line_len           = sizeof(command_buffer);
    console_cfg.buffer             = command_buffer;
    console_cfg.history_len        = CONSOLE_COMMAND_HISTORY_LENGTH;
    console_cfg.history_buffer_ptr = command_history_buffer;
    console_cfg.delimiter_string   = console_delimiter_string_doxygen;
    console_cfg.params_num         = CONSOLE_COMMAND_MAX_PARAMS;
    console_cfg.thread_priority    = CY_RTOS_PRIORITY_NORMAL;
 
    /* Initialize the Command Console library. */
    result = cy_command_console_init(&console_cfg);
    if ( result != CY_RSLT_SUCCESS )
    {
        printf ("Error in initializing command console library : %lu \n", (unsigned long)result);
        goto error;
    }
 
    /* Initialize the Wi-Fi utility and add Wi-Fi commands. */
    result = wifi_utility_init();
    if ( result != CY_RSLT_SUCCESS )
    {
        printf ("Error in initializing command console library : %lu \n", (unsigned long)result);
        goto error;
    }
 
    /* Initialize the iPerf utility and add iPerf commands. */
    iperf_utility_init(&wcm_config.interface);
 
    /* Initialize the Bluetooth utility and add BT commands. */
    bt_utility_init();
 
    return 0;
 
error:
    return -1;
}