infineon / mtb-example-wifi-web-server

This code example demonstrates Wi-Fi provisioning via SoftAP and setting up a web server with PSoC 6 MCU and CYW43xxx connectivity devices.

Wi-Fi web server

This code example demonstrates Wi-Fi provisioning via a SoftAP and setting up a web server with PSoC™ 6 MCU with AIROC™ CYW43xxx Wi-Fi & Bluetooth® combo chips.

In this example, the PSoC™ 6 MCU device is configured in AP+STA concurrent mode. It starts an HTTP web server while in AP+STA concurrent mode and hosts an HTTP web page. The kit can be connected to the desired Wi-Fi network using the credentials entered via this HTTP web page. After connecting to the specified Wi-Fi network, the device is reconfigured to start a new HTTP web server. The new web server displays the device data containing ambient light sensor (ALS) values, and buttons to change the brightness of an LED on a web page.

View this README on GitHub.

Provide feedback on this code example.

Requirements

• ModusToolbox™ v3.1 or later (tested with v3.1)
• Board support package (BSP) minimum required version: 4.0.0
• Programming language: C
• Associated parts: All PSoC™ 6 MCU parts, AIROC™ CYW20819 Bluetooth® & Bluetooth® LE SoC, AIROC™ CYW43012 Wi-Fi & Bluetooth® combo chip, AIROC™ CYW4343W Wi-Fi & Bluetooth® combo chip, AIROC™ CYW4373 Wi-Fi & Bluetooth® combo chip, AIROC™ CYW43439 Wi-Fi & Bluetooth® combo chip,AIROC™ CYW43022 Wi-Fi & Bluetooth® combo chip

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')

• PSoC™ 6 Wi-Fi Bluetooth® Prototyping Kit (CY8CPROTO-062-4343W) - Default value of TARGET
• PSoC™ 6 Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-062-WIFI-BT)
• PSoC™ 62S2 Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-062S2-43012)
• PSoC™ 62S1 Wi-Fi Bluetooth® Pioneer Kit (CYW9P62S1-43438EVB-01)
• PSoC™ 62S1 Wi-Fi Bluetooth® Pioneer Kit (CYW9P62S1-43012EVB-01)
• PSoC™ 62S3 Wi-Fi Bluetooth® Prototyping Kit (CY8CPROTO-062S3-4343W)
• PSoC™ 64 "Secure Boot" Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-064B0S2-4343W)
• PSoC™ 62S2 Evaluation Kit (CY8CEVAL-062S2-LAI-4373M2, CY8CEVAL-062S2-LAI-43439M2, CY8CEVAL-062S2-MUR-43439M2, CY8CEVAL-062S2-MUR-4373EM2)
• PSoC™ 62S2 Wi-Fi Bluetooth® prototyping kit (CY8CPROTO-062S2-43439)

Hardware setup

The code example can be configured to work with or without the CY8CKIT-028-TFT TFT display shield board. This shield comes with PSoC™ 6 Wi-Fi Bluetooth® pioneer kit. It can also be purchased standalone and used with other supported kits.

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. This example requires no additional software or tools.

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-scan" application with the desired name "WifiScan" 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-mtb-example-wifi-scan --user-app-name WifiScan --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 the policy_single_CM0_CM4_smif_swap.json policy instead of using the default one "policy_single_CM0_CM4_swap.json" to provision the CY8CKIT-064B0S2-4343W device.

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

2. Open Makefile and modify the ENABLE_TFT macro to enable or disable the TFT functionality.

   Note: The TFT display shield board is not compatible with PSoC™ 6 Wi-Fi Bluetooth® prototyping kit (CY8CPROTO-062-4343W) and PSoC™ 62S1 Wi-Fi Bluetooth® pioneer kit (CYW9P62S1-43012EVB-01). Therefore, by default, the TFT functionality is disabled.

3. Open web_server.h from the source directory and modify the SOFTAP_SSID, SOFTAP_PASSWORD, and SOFTAP_SECURITY_TYPE macros to the desired values that you want to allot to the SoftAP.

   All possible security types are defined in the cy_wcm_security_t structure in the cy_wcm.h file.

4. Modify the IP address assigned to the SoftAP by updating the SOFTAP_IP_ADDRESS macro defined in the web_server.h file.

   For example, if you are assigning the SoftAP with the IP address 192.168.0.2, update the macro as follows:

   #define SOFTAP_IP_ADDRESS             MAKE_IPV4_ADDRESS(192, 168, 0, 2)
   

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

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

7. After programming, the application starts automatically. Verify that the following logs appear on the serial terminal (details such as the MAC address will be different):

    Info: ============================================================
    Info:                Wi-Fi Web Server
    Info: ============================================================
   
    WLAN MAC Address : E8:E8:B7:A0:2C:C0
    WLAN Firmware    : wl0: Apr 26 2021 04:04:15 version 13.10.271.265 (aa096f9 CY) FWID 01-29e05f8
    WLAN CLM         : API: 18.2 Data: 9.10.0 Compiler: 1.36.1 ClmImport: 1.34.1 Creation: 2021-04-26 04:01:15
    WHD VERSION      : v1.94.0 : v1.94.0 : GCC 9.3 : 2021-04-27 16:54:34 +0800
   
    Info: ****************************************************************************
    Info: Using another device, connect to the following Wi-Fi network:
    Info: SSID     : SOFTAP_SSID
    Info: Password : SOFTAP_PWD
    Info: Open a web browser of your choice and enter the URL http://192.168.0.2:80
    Info: This opens up the home page for web server application.
    Info: You can either enter Wi-Fi network name and password directly or
    Info: perform a Wi-Fi scan to get the list of available APs.
    Info: ****************************************************************************
   
   

8. Connect your PC to the SoftAP using the credentials updated in Step 3.

9. Open the web browser of your choice and enter the URL http://<IP address>:80, where the IP address is the one that was updated in Step 4. This will open the home page for the web server application. This will look like the following:

   Figure 1. Wi-Fi web server - home page

   

10. If the Wi-Fi network and its credentials are already known, enter these directly and click Connect to Wi-Fi. This sends an HTTP POST command to the server running on the kit. If the credentials entered by you are correct, you will be redirected to a page where you have options to return to the home page or display the device data. If the credentials are incorrect, you will have only one option, that is to return back to the home page.

    Figure 2. Connection to Wi-Fi failed

    

    
    

    Figure 3. Connection to Wi-Fi success

    

11. If the Wi-Fi APs are unknown, click Scan for Wi-Fi Access Points to perform a Wi-Fi scan to get the list of available APs. This sends an HTTP GET command to the server running on the kit.

    This redirects to another web page which is populated with the list of available Wi-Fi APs. The list of available APs is returned by the server as a response to the HTTP GET command. The web page will also contain a login form to enter Wi-Fi credentials. The web page will look like the following:

    Figure 4. Available access points

    

12. After the device is successfully connected to the network, click Display Device Data. This redirects to another web page which instructs you to follow the instructions in the UART terminal to view the device data.

    Figure 5. Display device data - redirect web page

    

    
    

    Figure 6. UART - instructions to view the device data

    

13. Connect your PC to the same Wi-Fi AP whose credentials you have entered in Step 10 or Step 11.

14. Open the web browser of your choice and enter the URL http://<IP address>:80, where the IP address is the one that is displayed on the UART terminal. This will open the web page that displays the real-time device data.

    Figure 4. Device data - web page

    

15. Do one of the following to vary the brightness of the user LED:

    • Click the Increase/Decrease button from the web page.

    • Touch the CAPSENSE™ slider at different positions.

    • Touch the CAPSENSE™ button (BTN1/BTN0).

Note: The light sensor voltage displayed on the web page is measured by the ambient light sensor present in the TFT display shield board. Therefore, this will not be displayed for PSoC™ 6 Wi-Fi Bluetooth® prototyping kit (CY8CPROTO-062-4343W) and PSoC™ 62S1 Wi-Fi Bluetooth® pioneer kit (CYW9P62S1-43012EVB-01).

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
UART (HAL)	cy_retarget_io_uart_obj	UART HAL object used by retarget-io for Debug UART port
GPIO (HAL)	CYBSP_USER_LED	User LED to show the visual output
PWM (HAL)	pwm_led	PWM HAL object used to vary the LED brightness

This example uses the Arm® Cortex®-M4 (CM4) CPU of PSoC™ 6 MCU to start the server_task. At device reset, the default Cortex®-M0+ (CM0+) application enables the CM4 CPU and configures the CM0+ CPU to go to sleep.

The Wi-Fi web server code example configures the device in AP+STA concurrent mode and starts an HTTP web server. The HTTP web server then hosts an HTTP web page using which the device can be connected to a Wi-Fi AP. A new web server is started after the device gets connected to Wi-Fi AP and the device data is displayed on a web page hosted by this web server.

The entry point of the application is int main(), which initializes the board support package (BSP), initializes retarget-io to use the debug UART port, and creates server_task. This task calls start_ap_mode(), which initializes the Wi-Fi device as a SoftAP and prints the IP address assigned to the SoftAP on the UART terminal. The initialize_display() function initializes and sets up the TFT display.

Before starting the HTTP web server, the configure_http_server() function registers dynamic URL handlers to handle the HTTP GET and POST requests. After this, the web page hosted by the HTTP server can be accessed at the URL http://<IP address>:80, where the IP address is defined using the SOFTAP_IP_ADDRESS macro in the web_server.h file.

The data entered via the web page undergoes URL encoding; a custom function, url_decode(), is used to decode the URL-encoded HTTP data.

The IP address of the STA interface is retrieved after the device gets connected to the Wi-Fi AP. The reconfigure_http_server() function deletes the existing HTTP server instance and creates a new server instance using this IP address. The device data (ambient light sensor voltage and LED brightness value) is retrieved and displayed every 50 ms on the TFT display shield as well as the web page hosted by the new server instance. The device initializes the ambient light sensor, CAPSENSE™, and LED using the initialize_sensors() function.

The application uses a UART resource from the hardware abstraction layer (HAL) to print debug messages on a UART terminal emulator. The UART resource initialization and retargeting of the standard I/O to the UART port is done using the retarget-io library.

Related resources

Resources	Links
Application notes	AN228571 – Getting started with PSoC™ 6 MCU on ModusToolbox™ software AN215656 – PSoC™ 6 MCU: Dual-CPU system design AN85951 – PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide
Code examples	Using ModusToolbox™ software on GitHub
Device documentation	PSoC™ 6 MCU datasheets PSoC™ 6 technical reference manualsDevelopment kits
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	capsense – CAPSENSE™ library and documents 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: CE233246 – Wi-Fi web server

Version	Description of change
1.0.0	New code example
2.0.0	Major update to support ModusToolbox™ v3.0. This version is not backward compatible with previous versions of ModusToolbox™
2.0.1	TFT display feature is disabled by default
2.1.0	Updated to support ModusToolbox™ software v3.1, CAPSENSE™ middleware v4.X and added support for CY8CEVAL-062S2-LAI-43439M2, CY8CEVAL-062S2-MUR-4373EM2, and CY8CPROTO-062S2-43439
2.2.0	Added support for CY8CEVAL-062S2-CYW43022CUB

---

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