Skip to content

Commit 63d8e56

Browse files
author
Amanda Butler
authored
Copy edit networkinterface.md
Copy edit file, mostly for active voice and inclusion of articles.
1 parent d49e199 commit 63d8e56

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

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

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@ Network interface is also the controlling API for application to specify network
1313

1414
### Network status updates
1515

16-
Application may choose to registed callback for monitoring status changes from network interfaces. This is done by using following API.
16+
An application may choose to register a callback to monitoring status changes from network interfaces. The application can do this by using the following API:
1717

1818
- [Network status](network-status.html): API for monitoring network status changes.
1919

2020
### Default network interface
2121

22-
In Mbed OS, targets that provide network connectivity, provide also default network interface. This can be either Ethernet, WiFi, mesh or cellular. Using default interface allows applications to be easily ported to different targets and different connectivity options.
22+
In Mbed OS, targets that provide network connectivity also provide a default network interface. This can be Ethernet, Wi-Fi, mesh or cellular. Using a default interface allows you to port applications to different targets and connectivity options.
23+
24+
The following example uses a default interface to connect to the network:
2325

24-
Following example uses default interface for connecting to network:
2526
```
2627
NetworkInterface *net = NetworkInterface::get_default_instance();
2728
@@ -33,9 +34,10 @@ if (!net) {
3334
net->connect();
3435
```
3536

36-
This example works on all IP based connectivity options supported by Mbed OS. Configuration for default interface is provided by the Mbed OS configuration system on the build time, so on a run time you can just call `connect()` without any parameters.
37+
This example works on all IP-based connectivity options that Mbed OS supports. The Mbed OS configuration system provides configuration for the default interface at build time, so at run time, you can just call `connect()` without any parameters.
38+
39+
For example, when providing Wi-Fi SSID and password, you may use the following `mbed_app.json`:
3740

38-
For example, when providing WiFi SSID and password, following `mbed_app.json` may be used:
3941
```
4042
{
4143
"target_overrides": {
@@ -49,26 +51,26 @@ For example, when providing WiFi SSID and password, following `mbed_app.json` ma
4951
}
5052
```
5153

52-
Please see [Selecting the default network interface](configuration-connectivity.html#selecting-the-default-network-interface) for information of how to supply required configuration parameters on different connections.
54+
Please see [Selecting the default network interface](configuration-connectivity.html#selecting-the-default-network-interface) for information about how to supply required configuration parameters on different connections.
5355

54-
For targets that provide more than one type of connectivity, you may choose the default by overriding `target.network-default-interface-type` configuration variable.
56+
For targets that provide more than one type of connectivity, you may choose the default by overriding the `target.network-default-interface-type` configuration variable.
5557

56-
Applications may also ask for specific type of connection, as shown in following table:
58+
Applications may also ask for a specific type of connection, as the following table shows:
5759

5860
|Method|What connectivity is returned| Requirements |
5961
|------|-----------------------------|--------------|
60-
|`*WiFiInterface::get_default_instance()`| Wifi interface. | Requires security parameters (mode, SSID, password) |
61-
|`*EthInterface::get_default_instance()` | Wired Ethernet interface, not WiFi. | none |
62-
|`*MeshInterface::get_default_instance()` | Returns either `LoWPANNDInterface` or `ThreadInterface` depending on which is set to default | Target provides a driver or macro `DEVICE_802_15_4_PHY` is enabled |
62+
|`*WiFiInterface::get_default_instance()`| Wi-Fi interface | Requires security parameters (mode, SSID, password) |
63+
|`*EthInterface::get_default_instance()` | Wired Ethernet interface, not Wi-Fi | none |
64+
|`*MeshInterface::get_default_instance()` | Returns either `LoWPANNDInterface` or `ThreadInterface`, depending on which is set to default | Target provides a driver or macro `DEVICE_802_15_4_PHY` is enabled |
6365
| `*CellularBase::get_default_instance` | Return cellular connectivity | Requires network parameters (pin, APN, username, password) |
6466
| `*NetworkInterface::get_default_instance()` | First one from above that is found | |
6567

66-
Please note that any of those functions may return `NULL` when interface of this type or its configuration is not found.
68+
Please note that any of those functions may return `NULL` when the interface of this type or its configuration is not found.
6769

68-
### More information
70+
### Related content
6971

70-
* [Configuring the default network interface](configuration-connectivity.html#selecting-the-default-network-interface)
71-
* [Network connectivity in Mbed OS](connectivity-tech.html)
72-
* [IP networking](ip-networking.html)
73-
* [Network status API](network-status.html)
74-
* [Network Sockets](network-socket.html)
72+
- [Configuring the default network interface](configuration-connectivity.html#selecting-the-default-network-interface).
73+
- [Network connectivity](connectivity-tech.html).
74+
- [IP networking](ip-networking.html).
75+
- [Network status API](network-status.html).
76+
- [Network sockets](network-socket.html).

0 commit comments

Comments
 (0)