Skip to content

Commit 0ef4b97

Browse files
Wi-SUN api documentation changes
1 parent e328458 commit 0ef4b97

File tree

2 files changed

+82
-13
lines changed

2 files changed

+82
-13
lines changed

docs/api/networkinterfaces/MeshInterface.md

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

55
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.
66

7-
Mbed OS provides two types of IPv6 based mesh networks:
7+
Mbed OS provides 3 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 [mesh technology](../reference/mesh-tech.html) section. 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,10 @@ 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

4849
- [Nanostack](../reference/mesh-tech.html#nanostack) technology reference material.
49-
- [6LoWPAN and Thread Mesh configuration documentation](../reference/configuration-mesh.html).
50+
- [6LoWPAN, Wi-SUN and Thread Mesh configuration documentation](../reference/configuration-mesh.html).
5051
- [Light control tutorial](../tutorials/light-control.html).

docs/reference/configuration/mesh.md

Lines changed: 75 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
<h2 id="configuration-mesh">6LoWPAN and Thread Mesh</h2>
1+
<h2 id="configuration-mesh">6LoWPAN, Wi-SUN and Thread Mesh</h2>
22

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.
44

55
There is one mesh-capable stack in Mbed OS called Nanostack.
66

7-
This guide is divided in sections, and generic Nanostack configurations are first, followed by those for Thread and 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.
88

99
For understanding the technologies and APIs, please refer to following sections before this one:
1010

1111
- [Network connectivity in Mbed OS](../reference/networking.html) technology page.
12-
- [6LoWPAN Mesh technology](../reference/mesh-tech.html) page.
13-
- [6LoWPAN Mesh class reference](../apis/mesh-api.html) user API.
12+
- [Mesh technology](../reference/mesh-tech.html) page.
13+
- [Mesh class reference](../apis/mesh-api.html) user API.
1414
- [Socket API](../apis/network-socket.html).
1515

1616
#### Providing the configuration
@@ -30,7 +30,7 @@ An example of the configuration file:
3030
}
3131
```
3232

33-
<span class="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+
<span class="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>
3434

3535
#### Build time configuration of the stack
3636

@@ -53,11 +53,12 @@ Option name | Features supported | Estimated binary size of Nanostack
5353

5454
If you want to optimize the flash usage, you need to configure Nanostack. The configuration to choose depends mostly on the preferred use case.
5555

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.
5757

5858
Select the protocol the network is based on:
5959

6060
- 6LoWPAN-ND.
61+
- Wi-SUN.
6162
- Thread.
6263

6364
Select the device role:
@@ -68,6 +69,7 @@ Select the device role:
6869
In the application, choose from two supported interface classes:
6970

7071
- For 6LoWPAN-ND based network, use `LoWPANNDInterface`.
72+
- For Wi-SUN FAN based network, use `WisunInterface`.
7173
- For Thread based network, use `ThreadInterface`.
7274

7375
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.
@@ -276,3 +278,69 @@ Name: mbed-mesh-api.6lowpan-nd-security-mode
276278
Macro name: MBED_CONF_MBED_MESH_API_6LOWPAN_ND_SECURITY_MODE
277279
Value: NONE (set by library:mbed-mesh-api)
278280
```
281+
282+
#### Wi-SUN related configuration parameters
283+
284+
The following parameters are only valid for the Wi-SUN FAN mesh network. These are in use when the application uses the `WisunInterface` class.
285+
286+
```
287+
Configuration parameters
288+
------------------------
289+
290+
Name: mbed-mesh-api.wisun-network-name
291+
Description: default network name for wisun network.
292+
Defined by: library:mbed-mesh-api
293+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_NETWORK_NAME
294+
Value: ARM-WS-TESTING (set by application[*])
295+
Name: mbed-mesh-api.wisun-regulatory-domain
296+
Description: Regulator domain.
297+
Defined by: library:mbed-mesh-api
298+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_REGULATORY_DOMAIN
299+
Value: 3 (set by library:mbed-mesh-api)
300+
Name: mbed-mesh-api.wisun-operating-class
301+
Description: Operating class.
302+
Defined by: library:mbed-mesh-api
303+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_OPERATING_CLASS
304+
Value: 255 (set by library:mbed-mesh-api)
305+
Name: mbed-mesh-api.wisun-operating-mode
306+
Description: Operating mode.
307+
Defined by: library:mbed-mesh-api
308+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_OPERATING_MODE
309+
Value: 255 (set by library:mbed-mesh-api)
310+
Name: mbed-mesh-api.wisun-uc-channel-function
311+
Description: Unicast channel function.
312+
Defined by: library:mbed-mesh-api
313+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_UC_CHANNEL_FUNCTION
314+
Value: 255 (set by library:mbed-mesh-api)
315+
Name: mbed-mesh-api.wisun-bc-channel-function
316+
Description: Broadcast channel function.
317+
Defined by: library:mbed-mesh-api
318+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_BC_CHANNEL_FUNCTION
319+
Value: 255 (set by library:mbed-mesh-api)
320+
Name: mbed-mesh-api.wisun-uc-fixed-channel
321+
Description: Default fixed channel.
322+
Defined by: library:mbed-mesh-api
323+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_UC_FIXED_CHANNEL
324+
Value: 0xffff (set by library:mbed-mesh-api)
325+
Name: mbed-mesh-api.wisun-bc-fixed-channel
326+
Description: Default fixed channel.
327+
Defined by: library:mbed-mesh-api
328+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_BC_FIXED_CHANNEL
329+
Value: 0xffff (set by library:mbed-mesh-api)
330+
Name: mbed-mesh-api.wisun-bc-interval
331+
Description: Broadcast interval. Duration between broadcast dwell intervals. Range: 0-16777216 milliseconds.
332+
Defined by: library:mbed-mesh-api
333+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_BC_INTERVAL
334+
Value: 0 (set by library:mbed-mesh-api)
335+
Name: mbed-mesh-api.wisun-bc-dwell-interval
336+
Description: Broadcast dwell interval.
337+
Defined by: library:mbed-mesh-api
338+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_BC_DWELL_INTERVAL
339+
Value: 0 (set by library:mbed-mesh-api)
340+
Name: mbed-mesh-api.wisun-uc-dwell-interval
341+
Description: Unicast dwell interval.
342+
Defined by: library:mbed-mesh-api
343+
Macro name: MBED_CONF_MBED_MESH_API_WISUN_UC_DWELL_INTERVAL
344+
Value: 0 (set by library:mbed-mesh-api)
345+
346+
```

0 commit comments

Comments
 (0)