Skip to content

Update mesh pages for Wi-SUN #989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/reference/technology/connectivity/connectivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Mbed OS offers a strong, integrated stack of standards-based technologies:
For IP devices:

* Arm Mbed Thread.
* 6LoWPAN.
* Wi-SUN.
* 6LoWPAN-ND.
* Cellular.
* NB-IoT.
* Bluetooth Low Energy (BLE).
Expand Down Expand Up @@ -63,11 +64,11 @@ Typical applications of BLE are health care, fitness trackers, beacons, smart ho

To learn how to use BLE on Mbed OS, please refer to the [Bluetooth overview](../apis/ble.html).

#### IP-based mesh (Thread and 6LoWPAN-ND)
#### IP-based mesh (Thread, Wi-SUN and 6LoWPAN-ND)

As a technology designed with large-scale deployment in mind, mesh is optimized for long battery life and low cost.

**Thread** is designed for indoor use, with a range of only a few meters. **6LoWPAN-ND** has a range of up to one kilometer, and is therefore better suited for external use. Both technologies have a low throughput of up to 200 kbps and experience delays.
**Thread** is designed for indoor use, with a range of only a few meters. **Wi-SUN** and **6LoWPAN-ND** have a range of up to one kilometer and are therefore better suited for external use. Throughput of Mesh technologies is up to 200 kbps.

Mesh networks are self-healing, with no single point of failure. They are more suitable for limited spaces because of the expense in infrastructure setup and maintenance.

Expand All @@ -77,11 +78,11 @@ Additionally, Mbed OS Thread stack is certified using pre-defined test sets for

<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/mesh.png)<span>Tree type mesh</span></span>

6LoWPAN is a compression method for IPv6 packets. Mbed OS supports 6LoWPAN-ND and Thread protocols for forming IPv6 based mesh networks. Both protocols use the same 6LoWPAN compression method but different routing protocols to achieve wireless mesh network.
6LoWPAN is a compression method for IPv6 packets. Mbed OS supports Wi-SUN, 6LoWPAN-ND and Thread protocols for forming IPv6 based mesh networks. All protocols use the same 6LoWPAN compression method but different routing protocols to achieve wireless mesh network.

Applications running on 6LoWPAN-based mesh networks use the same Mbed OS Socket API for connectivity.

For descriptions of mesh networks, please see the [6LoWPAN Mesh](mesh-tech.html) section.
For descriptions of different mesh networks, please see the [Thread](thread-tech), [Wi-SUN](wisun-tech) and [6LoWPAN-ND Mesh](mesh-tech.html) sections.

### Non-IP networking

Expand Down
5 changes: 3 additions & 2 deletions docs/reference/technology/connectivity/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Mbed OS implements the following network interface APIs:
- Cellular (PPP).
- 6LoWPAN-ND mesh networking.
- Thread mesh networking.
- Wi-SUN mesh networking.

Refer to [Network Interface](../apis/network-interfaces.html) API reference for usage instructions.

Expand All @@ -82,12 +83,12 @@ There are two types of Wi-Fi drivers in Mbed OS, depending on which protocol lay

Cellular drivers have the same two separate cases as Wi-Fi. If they use an external IP stack, the driver implements the Network stack API. If they use the internal IP stack, LwIP, then they implement the Serial PPP driver.

#### 6LoWPAN/Thread RF driver
#### Mesh (Wi-SUN, 6LoWPAN, Thread) RF driver

<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/rf-driver.png)<span>RF driver</span></span>

On Mesh networks, Nanostack uses IEEE 802.15.4 radios for transmitting and receiving packets. The RF driver implements the `NanostackRfPhy` API.

This driver type has no other use cases, so it is implemented in C using a Nanostack-specific API.

Please see the [Mesh technology section](mesh-tech.html) and [Porting a new RF driver for the 6LoWPAN stack](../porting/lora-port.html) for more information.
Please see the [6LoWPAN technology section](mesh-tech.html) and [Porting a new RF driver for the 6LoWPAN stack](../porting/lora-port.html) for more information.
6 changes: 3 additions & 3 deletions docs/reference/technology/mesh/quick_start_intro.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<h2 id="mesh-tech">Mesh</h2>
<h2 id="mesh-tech">6LoWPAN-ND</h2>

This guide provides design guidelines for developing an application on top of the 6LoWPAN mesh solution. The APIs and technologies are not discussed in detail here.
This guide provides design guidelines for developing an application on top of the 6LoWPAN-ND mesh solution. The APIs and technologies are not discussed in detail here.

### Overview of the 6LoWPAN network
### Overview of the 6LoWPAN-ND network

![Node connected to server](https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/images/node_to_server_2.jpg?raw=true)

Expand Down
2 changes: 2 additions & 0 deletions docs/reference/technology/mesh/thread_intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<h2 id="thread-tech">Thread</h2>

## Thread

Thread was designed with one goal in mind; to create the best way to connect and control products in home. The key features of Thread are:
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/technology/mesh/wisun_intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<h2 id="wisun-tech">Wi-SUN</h2>

## Wi-SUN

The Wi-SUN Field Area Network (FAN) is based on open standards from IEEE802, IETF, ANSI/TIA and ETSI.
Expand Down Expand Up @@ -33,4 +35,4 @@ You can find an example using the [Mesh C++ API](../apis/mesh-api.html) for buil

#### Border router

You can find an example using the [Nanostack API](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/nanostack) to biuld a Wi-SUN border router at [nanostack border router](https://github.com/ARMmbed/nanostack-border-router).
You can find an example using the [Nanostack API](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/nanostack) to build a Wi-SUN border router at [nanostack border router](https://github.com/ARMmbed/nanostack-border-router).