GitHub hosted

DEPRECATED: Wi-fi example for Mbed OS 6

Download repository: zip

This example has been deprecated

Please use the sockets example. It contains all the functionality of the old Wi-Fi example.


Wi-Fi example for Mbed OS

(Note: To see this example in a rendered form you can import into the Arm Mbed Online Compiler, please see the documentation.)

Getting started with the Wi-Fi API

This is an example of a Wi-Fi application using the Wi-Fi APIs that Mbed OS provides.

The program brings up the Wi-Fi and the underlying network interface and uses it to scan available networks, connects to a network and prints interface and connection details.

For more information about Wi-Fi APIs, please visit the Mbed OS Wi-Fi documentation.

Supported hardware

Getting started

  1. Import the example.

mbed import mbed-os-example-wifi cd mbed-os-example-wifi

Or if you fetched the example with git clone, run mbed deploy inside the cloned repository.

  1. Configure the Wi-Fi shield and settings.
    Edit mbed_app.json to include the correct Wi-Fi shield, SSID and password:
    "config": {
        "wifi-ssid": {
            "help": "WiFi SSID",
            "value": "\"SSID\""
        "wifi-password": {
            "help": "WiFi Password",
            "value": "\"PASSWORD\""
    "target_overrides": {
        "*": {
            "platform.stdio-convert-newlines": true,
            "esp8266.provide-default" : false

For build-in WiFi, you do not need to set any provide-default values. Those are required
if you use external WiFi shield.

A sample mbed_app.json file is provided for ESP8266 (mbed_app_esp8266.json).

  1. Compile and generate binary.
    For example, for GCC:
    mbed compile -t GCC_ARM -m DISCO_L475VG_IOT01A

  2. Open a serial console session with the target platform using the following parameters:

    • Baud rate: 9600
    • Data bits: 8
    • Stop bits: 1
    • Parity: None
  3. Copy or drag the application mbed-os-example-wifi.bin in the folder mbed-os-example-wifi/BUILD/<TARGET NAME>/<PLATFORM NAME> onto the target board.

  4. The serial console should display a similar output to below, indicating a successful Wi-Fi connection:
    WiFi example

    Network: Dave Hot Spot secured: Unknown BSSID: 00:01:02:03:04:05 RSSI: -58 Ch: 1
    1 network available.


    MAC: 00:01:02:03:04:05
    RSSI: -27



If you have problems, you can review the documentation for suggestions on what could be wrong and how to fix it.

License and contributions

The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see for more info.

This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.