Skip to content

Commit a887fc5

Browse files
author
Amanda Butler
authored
Update WifiInterface.md
Make changes from #472 after reviewing on test site.
1 parent 6b8e8f1 commit a887fc5

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

docs/reference/api/connectivity/networksocket/WifiInterface.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,32 @@
44

55
The WifiInterface provides a simple C++ API for connecting to the internet over a Wi-Fi device.
66

7-
There are multiple [Wi-Fi components](https://os.mbed.com/components/cat/wifi/) that implement the WiFiInterface class. The example below uses the [ESP8266Interface](https://github.com/armmbed/esp8266-driver).
8-
97
### Wi-Fi class reference
108

119
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_wi_fi_interface.html)
1210

1311
### Usage
1412

15-
To bring up the network interface:
13+
To bring up the network interface of an external Wi-Fi device (for example, the ESP8266Interface):
1614

17-
1. Instantiate an implementation of the WiFiInterface class (for example, the ESP8266Interface).
15+
1. Instantiate an implementation of the WiFiInterface class.
16+
1. Initialize the AT command parser.
1817
1. Call the `connect` function with an SSID and password for the Wi-Fi network.
19-
1. Once connected, the WiFiInterface can be used as a target for opening [network sockets](/docs/v5.8/reference/network-socket.html).
18+
1. Command the Wi-Fi device to connect to network.
19+
1. Once connected, you can use the WiFiInterface as a target for opening [network sockets](/docs/v5.8/reference/network-socket.html).
20+
21+
### Troubleshooting information
22+
23+
Network interface `connect` failure reasons:
24+
25+
1. Check that the SSID and password are correct.
26+
1. Check that the IP address configuration service is working.
2027

2128
### Wi-Fi example
2229

23-
Here is an example of an HTTP client program. The program brings up an ESP8266 as the underlying network interface, and uses it to perform an HTTP transaction over a TCPSocket:
30+
Here is an example of an HTTP client program. The program brings up an ESP8266 as the underlying network interface, and uses it to perform an HTTP transaction over a TCPSocket. There are multiple [Wi-Fi components](https://os.mbed.com/components/cat/wifi/) that implement the WiFiInterface class. The example below uses the [ESP8266Interface](https://github.com/armmbed/esp8266-driver) and [OdinWiFiInterface](https://github.com/u-blox/ublox-odin-w2-drivers-docs-mbed-5).
31+
32+
The ESP8266Interface uses AT commands over serial interface to connect to an external Wi-Fi device. The OdinWiFiInterface provides an Ethernet-like driver to the Mbed OS network stack. The network stack uses the driver to connect to Wi-Fi:
2433

2534
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/TCPSocketWiFi_Example/)](https://os.mbed.com/teams/mbed_example/code/TCPSocketWiFi_Example/file/6a4e57edc2b2/main.cpp)
2635

0 commit comments

Comments
 (0)