Getting Started with NXP Wi-Fi® Modules Using i.MX RT Platform

Last Modified: 2020-05-28 18:07:00

Contents of this document

  • 1

    Plug It In
  • 2

    Get Software
  • 3

    Build and Run

1. Plug It In

Let's take your Wi-Fi module for a test drive using an i.MX RT platform. This guide contains different modules from third parties that enable NXP Wi-Fi SoCs on i.MX RT EVKs.

1.1 Get Familiar with the Hardware

The links below will take you to the Getting Started website for your evaluation board; it will guide you with detailed instructions to download and install the required software.

Select your i.MX RT platform.

1.2 Connect your Wi-Fi Module

Select the Wi-Fi platform to display a module that enables it and how to connect it to an i.MX RT EVK.

Host MCU 88w8801
Wi-Fi 4, 1x1
2.4 GHz
88w8977
Wi-Fi 4, 1x1
2.4 GHz + 5 GHz
Bluetooth 4.2
IW416
Wi-Fi 4, 1x1
2.4 GHz + 5 GHz
Bluetooth 5.1
88W8987
Wi-Fi 5, 1x1
2.4 GHz + 5 GHz
Bluetooth 5.1
IW612
Wi-Fi 6, 1x1
2.4 GHz + 5 GHz
Bluetooth/BLE 5.2
and 802.15.4
i.MX RT500 Partner Modules
Partner Modules
Partner Modules
Partner Modules
Partner Modules
i.MX RT600
i.MX RT1020
i.MX RT1040
i.MX RT1050
i.MX RT1060
i.MX RT1064
i.MX RT1160
i.MX RT1170

1.3 Attach the USB Cable to Your i.MX RT EVK

Power up the board by plugging the micro USB cable in your board as described in your board's Getting Started page.

The following section will help you load and run a Wi-Fi example. Make sure you have installed the software provided by the i.MX RT Getting Started section and that your Wi-Fi module is connected to your i.MX RT board.

2. Get Software

2.1 Build and Run Wi-Fi Demo From the SDK

NXP offers a complimentary toolchain called MCUXpresso IDE. Please download MCUXpresso v11.8.1 or above.

Get MCUXpresso IDE

Get MCUXpresso for VS Code

Learn how to install VS Code for your host PC with the following tutorial.

Want to use a different toolchain?

If you need help choosing, explore the MCUXpresso Suite of Software and Tools.

The MCUXpresso SDK includes support for other tools such as IAR , Keil , command-line GCC .

2.2 Jump Start Your Design With the MCUXpresso SDK

The MCUXpresso SDK is complimentary and includes full source code under a permissive open-source license for all hardware abstraction and peripheral driver software. You may install the MCUXpresso SDK directly form the MCUXpresso SDK website . Click on the button below to open the MCUXpresso SDK builder.

MCUXpresso SDK Builder

SDK via GitHub

2.3 MCUXpresso Config Tools

The MCUXpresso Config Tools is an integrated suite of configuration tools that guides users in creating new MCUXpresso SDK projects, and also provides pin and clock tools to generate initialization C code for custom board support. It is fully integrated as a part of MCUXpresso IDE and also as a separate tool if using a different IDE. Click the Get MCUXpresso Config Tools below to get the Config Tools installer.

Get MCUXpresso Config Tools

3. Build and Run

3.1 Building and Debugging Wi-Fi Example from MCUXpresso SDK

The NXP Wi-Fi Applications User's Guide document provides step-by-step instructions on how to configure, build and debug the Wi-Fi demos for the toolchains supported by the SDK.

The "wifi_cli" demo is one of the Wi-Fi examples applications available in the SDK. It implements several useful features that can help you as a reference on your development, such as: scan the visible access points, connect to an access point, start your own access point, print network information, enable deep sleep operation, and run a throughput test.

Use the guide below to learn how to load, build and debug the "wifi_cli" demo application in MCUXpresso IDE.

Building and Running a Wi-Fi Demo

The MCUXpresso SDK provides a collection of Wi-Fi example applications.

Follow these steps to import, configure, build, debug and run a Wi-Fi demo example through MCUXpresso IDE. This guide will use i.MX RT 1060 as reference, but similar steps apply to other EVKs.

Import SDK to your MCUXpresso Workspace

  1. Open the MCUXpresso IDE
  2. Switch to the 'Installed SDKs' view within the MCUXpresso IDE window
  3. Getting Started with NXP WiFi modules using i.MXRT platform 1.2

    Getting Started with NXP WiFi modules using i.MXRT platform 1.2
  4. If you haven't imported the SDK into MCUXpresso IDE, drag and drop the SDK for your development board (in zip format) into the "Installed SDKs" section. Click on OK to continue the import
  5. The SDK will now appear in the Installed SDK's view as shown below:
  6. Getting Started with NXP WiFi modules using i.MXRT platform 1.5

    Getting Started with NXP WiFi modules using i.MXRT platform 1.5

Build the Application

The "wifi_cli" application demonstrates how to implement different features.

  • Perform a Network scan
  • Connect to an Access Point
  • Start your own Access Point
  • Enable Deep Sleep operation
  • TCP and UDP throughput measurements acting as a server or as a client
  • Print network information

The following steps will guide you to build and run the "wifi_cli" application using MCUXpresso IDE.

  1. Locate the Quickstart Panel in the lower left-hand corner
  2. Click on Import SDK example(s)
  3. Getting Started with NXP WiFi modules using i.MXRT platform 1.7

    Getting Started with NXP WiFi modules using i.MXRT platform 1.7
  4. Select your evaluation board and click on Next
  5. Getting Started with NXP WiFi modules using i.MXRT platform 1.8

    Getting Started with NXP WiFi modules using i.MXRT platform 1.8
  6. Use the arrow button to expand the "wifi_examples" category and click the checkbox next to "wifi_cli" to select that project. Then, click on Finish
  7. Getting Started with NXP WiFi modules using i.MXRT platform 1.9

    Getting Started with NXP WiFi modules using i.MXRT platform 1.9
  8. The demo is pre-configured with a Wi-Fi module that can easily be adjusted. Open the wifi_cli/source/app_config.h file and verify the Wi-Fi modules available for your SDK. Modify the value to match the module on your setup to include and compile the desired driver, components and application(s). Open the readme file for any hardware configuration required by your EVK and module
  9. GS-WIFI-MODULES-BUILDING-1.9-APP-CONFIG

    GS-WIFI-MODULES-BUILDING-1.9-APP-CONFIG
  10. Save the project
  11. Select the project and build it
  12. Getting Started with NXP WiFi modules using i.MXRT platform 1.13

    Getting Started with NXP WiFi modules using i.MXRT platform 1.13
  13. The project should build without problems

Build the Application

  1. Make sure that the Wi-Fi module is attached to the EVK and connect your board to your computer
  2. Download the application to your i.MX RT-EVK
  3. Getting Started with NXP WiFi modules using i.MXRT platform 1.16

    Getting Started with NXP WiFi modules using i.MXRT platform 1.16
  4. Select the debug probe of the board connected to your PC
  5. Getting Started with NXP WiFi modules using i.MXRT platform 1.17

    Getting Started with NXP WiFi modules using i.MXRT platform 1.17
  6. Before you start your application, open a Serial Terminal application (ie. PuTTY, Tera Term). You can find instructions to set up a Terminal application on the EVK's Getting Started website → Section 2: Get Software → PC Configuration
  7. Getting Started with NXP WiFi modules using i.MXRT platform 1.18

    Getting Started with NXP WiFi modules using i.MXRT platform 11.18
  8. Click on the Resume button to start the application
  9. Getting Started with NXP WiFi modules using i.MXRT platform 1.19

    Getting Started with NXP WiFi modules using i.MXRT platform 1.19
  10. You should see the output of the application
  11. Click on 'Terminate' button to stop the debugging session
  12. Getting Started with NXP WiFi modules using i.MXRT platform 1.21

    Getting Started with NXP WiFi modules using i.MXRT platform 1.21

Refer to SDK path/docs/wireless/UM11442-NXP-Wi-Fi-and-Bluetooth-Demo-Applications-for-i.MX-RT-platforms-User-Guide.pdf document available in the SDK for detailed instructions to run all Wi-Fi demos.

To learn more about all Wi-Fi example applications and additional features supported by the Wi-Fi module, browse to the wireless documentation folder available in the SDK.

Wireless Connectivity

Documents and Videos Application Note SW (if applicable) Description
Getting Started with NXP-based Wireless Modules on i.MX RT Platforms Running RTOS Provides the step-by-step guidance to set up NXP-based wireless modules with i.MX RT products, build the firmware image and run Wi-Fi and Bluetooth demo applications.
NXP Wi-Fi and Bluetooth Debug Feature Configuration Guide for i.MX RT Platforms This document describes the debug configurations to generate various Wi-Fi driver/feature logs and Bluetooth protocol debugging methods.
Wi-Fi TX Power Table and Channel Scan Management for i.MX RT SDK This application note describes how to configure the Wi-Fi TX power table and Wi-Fi channel list in product software.
Wi-Fi Alliance Derivative Certification Process This document presents the overall Wi-Fi Alliance derivative certification process with the steps to follow to get derivative certification for your products.
WFA Certification Guide for NXP-based Wireless Modules on i.MX RT Platform Running RTOS This manual describes the test setup and procedure of Wi-Fi certification programs including 802.11n, 802.11ac, 802.11ax, protected management frames (PMF), WPA3, security enhancement and security vulnerability detection.
i.MX RT1170 with 88W8801 Hands On Training In this training session, we demonstrate getting Wi-Fi up-and-running on the MIMXRT1170-EVK using NXP's 88W8801 Wi-Fi solution and AzureWave AW-NM191-uSD module.
NXP Wi-Fi and Bluetooth Demo Applications for i.MX RT Platforms (UM11442) Provides step-by-step guidance to configure, compile, debug, flash and run the Wi-Fi and Bluetooth sample applications available in the MCUXpresso SDK. It also covers IDE configurations and required tool set up. Path: <SDK_PATH>\docs\wireless\Wi-Fi.
Compliance and Certification Considerations (AN12917) This application note provides general guidance and tips on how to test products based on NXP Wi-Fi devices for regulatory compliance (FCC, ETSI, etc.). Path: <SDK_PATH>\docs\wireless\Wi-Fi.
MCUXpresso SDK WLAN Driver Reference Manual This manual provides developer reference documentation for Wi-Fi driver and WLAN Connection Manager. In addition to the reference documentation in this manual, you can also explore the source code. Path: <SDK_PATH>\docs\wireless\Wi-Fi.

MCUXpresso SDK Examples

UART Wi-Fi Bridge Example

This is the UART Wi-Fi bridge example to demonstrate the Lab Tool support.

Path: <SDK_PATH>\boards\BOARD_NAME\wifi_examples\uart_wifi_bridge 

Wi-Fi CLI

This is the Wi-Fi CLI example to demonstrate the CLI support usage. The CLI module allows user to add CLIs in application. Currently only WLAN connection manager CLIs are available.

Path: <SDK_PATH>\boards\BOARD_NAME\wifi_examples\wifi_cli 

Wi-Fi IPV4 IPV6 Echo

The wifi_ipv4_ipv6_echo application demonstrates a TCP and UDP echo on the lwIP TCP/IP stack with FreeRTOS. The demo can use both TCP or UDP protocol over IPv4 or IPv6 and acts as an echo server.

Path: <SDK_PATH>\boards\BOARD_NAME\wifi_examples\wifi_ipv4_ipv6_echo 

Wi-Fi Setup

This demo implements a simple Wi-Fi station setup. The application will automatically scan local wireless networks at startup, then the user will be able to connect to one of the available networks and setup a ping task that will test the connection.

Path: <SDK_PATH>\boards\BOARD_NAME\wifi_examples\wifi_setup 

Wi-Fi Test Mode

This is the Wi-Fi Test mode example to demonstrate the test mode support usage.

Path: <SDK_PATH>\boards\BOARD_NAME\wifi_examples\wifi_test_mode 

Wi-Fi Webconfig

This demo implements a simple web-based Wi-Fi configuration utility for connecting the board to the local wireless network.

Path: <SDK_PATH>\boards\BOARD_NAME\wifi_examples\wifi_webconfig 

Wi-Fi WPA Supplicant

This is the Wi-Fi WPA Supplicant example to demonstrate the CLI support usage using WPA supplicant. The CLI module allows user to add CLIs in application. Currently only WLAN connection manager CLIs are available.

Path: <SDK_PATH>\boards\BOARD_NAME\wifi_examples\wifi_wpa_supplicant 

Tools and References

Residential Thermostat Reference Design - NXP offers a broad portfolio of sensors and MCUs for your Thermostat applications. This design is based on the i.MX RT1060 and the 88W8987.

Support

Forums

Connect with other engineers and get expert advice on designing with NXP Wi-Fi® Modules Using i.MX RT Platform on one of our community sites.