This example shows how to perform a scan of Wi-Fi access points (APs) using ModusToolbox™ Amazon FreeRTOS SDK.

Provide feedback on this Code Example.

• ModusToolbox® software v2.1
• Programming Language: C
• ModusToolbox FreeRTOS SDK
• Cypress Programmer
• Associated Parts: All PSoC® 6 MCU parts with Amazon FreeRTOS support

• GNU Arm® Embedded Compiler v7.2.1 (GCC_ARM) - Default value of TOOLCHAIN
• Arm compiler v6.11 (ARM)
• IAR C/C++ compiler v8.42.2 (IAR)

• PSoC 6 Wi-Fi BT Prototyping Kit (CY8CPROTO-062-4343W) - Default target
• PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WIFI-BT)
• PSoC 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)

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 BLE Pioneer Kit (CY8CKIT-062-BLE) and 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".

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

This example requires no additional software or tools.

1. Clone Amazon FreeRTOS from GitHub and checkout the latest release using its tag. Following command also clones all the submodules.

   git clone https://github.com/cypresssemiconductorco/amazon-freertos.git -b 202007-MTBAFR2041 --recurse-submodules
   

2. Go to <amazon-freertos>/projects/cypress folder.

   Note: <amazon-freertos> refers to the path of the Amazon FreeRTOS folder in your computer.

3. Clone or download this code example, or copy it if you already have it.

   git clone https://github.com/cypresssemiconductorco/afr-example-wifi-scan.git
   

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

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

1. Go to File > Import.
2. Choose Existing Projects into Workspace under General and click Next.
3. Click the Browse button near Select root directory, choose the CE folder <amazon-freertos>/projects/cypress/afr-example-wifi-scan, and click Finish.
4. Select the application project in the Project Explorer.
5. In the Quick Panel, scroll down, and click afr-example-wifi-scan Program (KitProg3).

To program a target board different from the default one defined using the TARGET variable in the Makefile, you need to generate the launch configurations for the new target. See Running Amazon FreeRTOS Code Examples - KBA228845 for details.

1. Open a CLI terminal and navigate to the CE folder.

2. 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=CY8CKIT-062-WIFI-BT TOOLCHAIN=GCC_ARM
   

1. Create a build folder (e.g., cmake_build) under <amazon-freertos>/build.

2. Run the following command from the build folder:

   cmake -G Ninja -S ../.. -B . -DVENDOR=cypress -DCOMPILER=arm-gcc -DBOARD=CY8CPROTO_062_4343W -DAPP=projects/cypress/afr-example-wifi-scan
   

3. Once CMake has generated the configuration, run the following command:

   cmake --build .
   

4. Use Cypress Programmer to program the afr-example-wifi-scan.elf file generated under <amazon-freertos>/build/cmake_build.

After programming, the application starts automatically. Figure 1 shows the serial terminal output. Note that the SSIDs have been renamed purposefully.

You can debug the example to step through the code. In the ModusToolbox IDE, use the afr-example-wifi-scan Debug (KitProg3) configuration in the Quick Panel. See Debugging a PSoC 6 MCU ModusToolbox Project - KBA224621 for details.

This example sets up a task to perform periodic scan of Wi-Fi APs. Once the FreeRTOS scheduler has started, the task starts running. It first turns the Wi-Fi interface ON, then scans, and prints the details of the APs to the UART terminal. This example directly sets up the task without using the Demo Runner.

The following ModusToolbox resources are used in this example.

Table 1. Application 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 Title: CE229265 - AWS IoT and FreeRTOS for PSoC 6 MCU: Wi-Fi Scan

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

© Cypress Semiconductor Corporation, 2019-2021. This document is the property of Cypress Semiconductor Corporation and its subsidiaries ("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.