Skip to content

Commit 508bd80

Browse files
author
Amanda Butler
authored
Merge pull request #472 from mikaleppanen/eth_wifi_if_updates
Updated ethernet and wifi interface description
2 parents c4afa25 + 5894295 commit 508bd80

File tree

2 files changed

+18
-20
lines changed

2 files changed

+18
-20
lines changed

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ Refer to the API below for how to set the IP addresses by calling the `set_netwo
4545
### Troubleshooting information
4646

4747
Network interface `connect` failure causes:
48-
1. `NSAPI_ERROR_NO_CONNECTION` indicates that Ethernet link up has failed. Check that the Ethernet connection is working.
49-
1. `NSAPI_ERROR_DHCP_FAILURE` indicates that acquiring IP address has failed. Check that the IP address configuration service is working.
48+
49+
- `NSAPI_ERROR_NO_CONNECTION` indicates that the Ethernet link up has failed. Check that the Ethernet connection is working.
50+
- `NSAPI_ERROR_DHCP_FAILURE` indicates that acquiring the IP address has failed. Check that the IP address configuration service is working.
5051

5152
### EthInterface class reference
5253

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

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,42 @@
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) and
8-
[OdinWiFiInterface](https://github.com/u-blox/ublox-odin-w2-drivers-docs-mbed-5).
9-
10-
ESP8266Interface uses AT commands over serial interface to connect to external Wi-Fi device. OdinWiFiInterface provides Ethernet like driver to Mbed OS network stack. Network stack uses the driver to connect to Wi-Fi.
11-
127
### Wi-Fi class reference
138

149
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_wi_fi_interface.html)
1510

1611
### Usage
1712

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

2015
1. Instantiate an implementation of the WiFiInterface class.
21-
1. Initialises AT command parser.
16+
1. Initialize the AT command parser.
2217
1. Call the `connect` function with an SSID and password for the Wi-Fi network.
23-
1. Commands Wi-Fi device to connect to network.
24-
1. Once connected, the WiFiInterface can be used as a target for opening [network sockets](/docs/development/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/development/reference/network-socket.html).
2520

26-
To bring up the network interface of Ethernet like driver (for example, the OdinWiFiInterface):
21+
To bring up the network interface of an Ethernet-like driver (for example, the OdinWiFiInterface):
2722

2823
1. Instantiate an implementation of the WiFiInterface class.
29-
1. Initialises Wifi driver for the target.
30-
1. Initialises network stack (LWIP).
24+
1. Initialize the Wi-Fi driver for the target.
25+
1. Initialize network stack (LWIP).
3126
1. Call the `connect` function with an SSID and password for the Wi-Fi network.
32-
1. Wi-Fi driver connects to Wi-Fi network.
33-
2. Network stack accuires IP address and DNS server address.
34-
35-
1. Once connected, the WiFiInterface can be used as a target for opening [network sockets](/docs/development/reference/network-socket.html).
27+
1. Connect the Wi-Fi driver to the Wi-Fi network.
28+
2. Ensure the network stack acquires the IP address and DNS server address.
29+
1. Once connected, you can use the WiFiInterface as a target for opening [network sockets](/docs/development/reference/network-socket.html).
3630

3731
### Troubleshooting information
3832

3933
Network interface `connect` failure reasons:
40-
1. Check that SSID and password are correct.
34+
35+
1. Check that the SSID and password are correct.
4136
1. Check that the IP address configuration service is working.
4237

4338
### Wi-Fi example
4439

45-
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:
40+
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).
41+
42+
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:
4643

4744
[![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)
4845

0 commit comments

Comments
 (0)