You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/networkinterfaces/MeshInterface.md
+7-6Lines changed: 7 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,15 @@
4
4
5
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.
6
6
7
-
Mbed OS provides two types of IPv6 based mesh networks:
7
+
Mbed OS provides 3 types of IPv6 based mesh networks:
8
8
9
9
- 6LoWPAN_ND, loosely following the Zigbee-IP specification.
10
+
- Wi-SUN, following the specification from Wi-SUN alliance.
10
11
- Thread, following the specification from Thread Group.
11
12
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 [mesh technology](../reference/mesh-tech.html) section. Application developers use Nanostack through the Mbed Mesh API.
13
14
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.
15
16
16
17
You can configure the mesh interface by providing values in `mbed_app.json`, as the [mesh configuration](../reference/configuration-mesh.html) section documents.
17
18
@@ -23,7 +24,7 @@ You can configure the mesh interface by providing values in `mbed_app.json`, as
23
24
24
25
### Supported mesh networking modes
25
26
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.
27
28
28
29
### Network connection states
29
30
@@ -41,10 +42,10 @@ See the example application [mbed-os-example-mesh-minimal](https://github.com/AR
41
42
42
43
### Mesh example
43
44
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.
<h2id="configuration-mesh">6LoWPAN and Thread Mesh</h2>
1
+
<h2id="configuration-mesh">6LoWPAN, Wi-SUN and Thread Mesh</h2>
2
2
3
-
This page describes build-time configurable parameters for 6LoWPAN-and Thread-based mesh networks. Mbed OS supports two main mesh protocols: 6LoWPAN-ND and Thread. Depending on the selected protocol, you can configure different set of values.
3
+
This page describes build-time configurable parameters for 6LoWPAN-, Wi-SUN- and Thread-based mesh networks. Mbed OS supports 3 main mesh protocols: 6LoWPAN-ND, Wi-SUN and Thread. Depending on the selected protocol, you can configure different set of values.
4
4
5
5
There is one mesh-capable stack in Mbed OS called Nanostack.
6
6
7
-
This guide is divided in sections, and generic Nanostack configurations are first, followed by those for Threadand then 6LoWPAN-ND.
7
+
This guide is divided in sections, and generic Nanostack configurations are first, followed by those for Thread, 6LoWPAN-ND and then Wi-SUN.
8
8
9
9
For understanding the technologies and APIs, please refer to following sections before this one:
10
10
11
11
-[Network connectivity in Mbed OS](../reference/networking.html) technology page.
-[Mesh class reference](../apis/mesh-api.html) user API.
14
14
-[Socket API](../apis/network-socket.html).
15
15
16
16
#### Providing the configuration
@@ -30,7 +30,7 @@ An example of the configuration file:
30
30
}
31
31
```
32
32
33
-
<spanclass="notes">**Note:** The configuration files for 6LoWPAN and Thread are provided for development or testing purposes. When setting up the production configuration, the user needs to have a good understanding of the whole system.</span>
33
+
<spanclass="notes">**Note:** The configuration files for 6LoWPAN, Wi-SUN and Thread are provided for development or testing purposes. When setting up the production configuration, the user needs to have a good understanding of the whole system.</span>
34
34
35
35
#### Build time configuration of the stack
36
36
@@ -53,11 +53,12 @@ Option name | Features supported | Estimated binary size of Nanostack
53
53
54
54
If you want to optimize the flash usage, you need to configure Nanostack. The configuration to choose depends mostly on the preferred use case.
55
55
56
-
See the [6LoWPAN technology overview](mesh-tech.html) for the definition of star and mesh networks. These same principles apply also to the Thread protocol.
56
+
See the [mesh technology overview](mesh-tech.html) for the definition of star and mesh networks. These same principles apply also to the Wi-SUN and Thread protocols.
57
57
58
58
Select the protocol the network is based on:
59
59
60
60
- 6LoWPAN-ND.
61
+
- Wi-SUN.
61
62
- Thread.
62
63
63
64
Select the device role:
@@ -68,6 +69,7 @@ Select the device role:
68
69
In the application, choose from two supported interface classes:
69
70
70
71
- For 6LoWPAN-ND based network, use `LoWPANNDInterface`.
72
+
- For Wi-SUN FAN based network, use `WisunInterface`.
71
73
- For Thread based network, use `ThreadInterface`.
72
74
73
75
Then you may optionally choose to select the nonrouting mode for those networks. The following tables show the values to use in the `mbed_app.json` file for your devices in different networks.
Description: Make critical section API usable from interrupt context. Else a mutex is used as locking primitive. Consult arm_hal_interrupt.c for possible side effects on interrupt latency.
0 commit comments