Skip to content

Commit bf2b8c9

Browse files
author
Amanda Butler
authored
Merge pull request #981 from KariHaapalehto/wisun
Wi-SUN api documentation changes
2 parents 904c4d2 + ca03c4d commit bf2b8c9

File tree

2 files changed

+65
-382
lines changed

2 files changed

+65
-382
lines changed

docs/api/networkinterfaces/MeshInterface.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@
22

33
<span class="images">![](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_mesh_interface.png)<span>MeshInterface class hierarchy</span></span>
44

5-
The Arm Mbed Mesh API allows the application to use the IPv6 mesh network topologies through the [Nanostack](../reference/mesh-tech.html#nanostack) networking stack.
5+
The Arm Mbed Mesh API allows the application to use the IPv6 mesh network topologies through the Nanostack networking stack.
66

7-
Mbed OS provides two types of IPv6 based mesh networks:
7+
Mbed OS provides three types of IPv6 based mesh networks:
88

99
- 6LoWPAN_ND, loosely following the Zigbee-IP specification.
10+
- Wi-SUN, following the specification from Wi-SUN alliance.
1011
- Thread, following the specification from Thread Group.
1112

12-
Nanostack is the networking stack that provides both of these protocols. For more information on the stack internals, please refer to the [6LoWPAN mesh technology](../reference/mesh-tech.html) section. Application developers use Nanostack through the Mbed Mesh API.
13+
Nanostack is the networking stack that provides these protocols. For more information on the stack internals, please refer to the [Thread](../reference/thread.html), [Wi-SUN](../reference/wi-sun.html) and [6LowPAN](../reference/mesh-tech.html) sections. Application developers use Nanostack through the Mbed Mesh API.
1314

14-
The application can use the `LoWPANNDInterface` or `ThreadInterface` object for connecting to the mesh network. When successfully connected, the application can use the Mbed [C++ socket APIs](network-socket.html) to create a socket to start communication with a remote peer.
15+
The application can use the `LoWPANNDInterface`, `WisunInterface` or `ThreadInterface` object for connecting to the mesh network. When successfully connected, the application can use the Mbed [C++ socket APIs](network-socket.html) to create a socket to start communication with a remote peer.
1516

1617
You can configure the mesh interface by providing values in `mbed_app.json`, as the [mesh configuration](../reference/configuration-mesh.html) section documents.
1718

@@ -23,7 +24,7 @@ You can configure the mesh interface by providing values in `mbed_app.json`, as
2324

2425
### Supported mesh networking modes
2526

26-
Currently, 6LoWPAN-ND (neighbor discovery) and Thread bootstrap modes are supported.
27+
Currently, 6LoWPAN-ND (neighbor discovery), Wi-SUN FAN and Thread bootstrap modes are supported.
2728

2829
### Network connection states
2930

@@ -41,10 +42,12 @@ See the example application [mbed-os-example-mesh-minimal](https://github.com/AR
4142

4243
### Mesh example
4344

44-
To learn how to use mesh, please see our [light control tutorial](../tutorials/light-control.html), which demonstrates a light control application, where devices can control the LED status of all devices in the network. You can build the application for the unsecure 6LoWPAN-ND or Thread network.
45+
To learn how to use mesh, please see our [light control tutorial](../tutorials/light-control.html), which demonstrates a light control application, where devices can control the LED status of all devices in the network. You can build the application for the unsecure 6LoWPAN-ND, Wi-SUN or Thread network.
4546

4647
### Related content
4748

48-
- [Nanostack](../reference/mesh-tech.html#nanostack) technology reference material.
49-
- [6LoWPAN and Thread Mesh configuration documentation](../reference/configuration-mesh.html).
49+
- [Thread](../reference/thread.html) technology reference material.
50+
- [Wi-SUN](../reference/wi-sun.html) technology reference material.
51+
- [6LowPAN](../reference/mesh-tech.html) technology reference material.
52+
- [6LoWPAN, Wi-SUN and Thread Mesh configuration documentation](../reference/configuration-mesh.html).
5053
- [Light control tutorial](../tutorials/light-control.html).

0 commit comments

Comments
 (0)