Skip to content

Update 6LoWPAN mesh namings #926

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.

Sign up for GitHub

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 1 commit into from
Jan 28, 2019
Merged

Update 6LoWPAN mesh namings #926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/api/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ The [Mbed OS RTOS](rtos.html) capabilities include managing objects such as thre
<tbody>
<tr>
<td><a href="ethernet.html">Ethernet</a></td>
<td><a href="mesh-api.html">6LoWPAN Mesh</a></td>
<td><a href="mesh-api.html">Mesh</a></td>
</tr>
<tr>
<td><a href="wi-fi.html">Wi-Fi</a></td>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/networkinterfaces/MeshInterface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h2 id="mesh-api">6LoWPAN Mesh</h2>
<h2 id="mesh-api">Mesh</h2>

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

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/technology/connectivity/connectivity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,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 Wi-SUN)
#### IP-based mesh (Thread 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. **Wi-SUN** 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. **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.

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 Down
2 changes: 1 addition & 1 deletion docs/reference/technology/connectivity/networking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@ On Mesh networks, Nanostack uses IEEE 802.15.4 radios for transmitting and recei

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

Please see the [6LoWPAN 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 [Mesh technology section](mesh-tech.html) and [Porting a new RF driver for the 6LoWPAN stack](../porting/lora-port.html) for more information.
14 changes: 2 additions & 12 deletions docs/reference/technology/mesh/quick_start_intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h2 id="mesh-tech">6LoWPAN Mesh</h2>
<h2 id="mesh-tech">Mesh</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.

Expand Down Expand Up @@ -36,7 +36,7 @@ A 6LoWPAN host is a type of node that does not route any packets. It has only on

A 6LoWPAN sleepy host is a 6LoWPAN host that is periodically allowed to sleep and turn off its radio.

#### Different types of 6LoWPAN mesh networks
#### Different types of mesh networks

6LoWPAN-based mesh networks cannot be described as a uniform standardized network type, such as Wi-Fi. Depending on the business requirements and use cases the network may have different setups and requirements.

Expand All @@ -57,13 +57,3 @@ In a mesh/tree network, all nodes are configured as 6LoWPAN routers.
In a 6LoWPAN network, RPL protocol is used for forming the routing topology. Every node selects a primary parent for routing so the result looks like a tree.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query: Should line 39 also change?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes it should

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the line #39 and pushed a rebased version in. Would you please recheck?


This network type allows to cover large areas because each node extends the range of the network. However, the packet is retransmitted on every hop, which means that the transfer capacity of the network decreases as the size of the network increases.

##### Example networks

![Example networks](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/examples.png)

In the further chapters, we provide recommendations for three different network sizes:

- A sensor network for an apartment.
- A sensor/actuator network for a building.
- A sensor/actuator network for a city.
4 changes: 2 additions & 2 deletions docs/reference/technology/mesh/thread_intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ The key elements of Mbed OS are:

Mbed Thread is implemented in the Nanostack library, which also supports the 6LoWPAN protocol. In Mbed OS, the Thread stack runs in its own RTOS thread using an internal event scheduler. Mbed OS provides the [Mesh C++ API](../apis/mesh-api.html) for building Thread applications.

- To connect to the Thread network, use the [Mbed Mesh API](../apis/mesh-api.html) or [Thread interface API](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h).
- To connect to the Thread network, use the [Thread interface API](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h).
- For the socket communication over the Thread network, use the [Mbed sockets API](../apis/network-socket.html).

Nanostack provides a set of C API headers with more functionalities. The [nanostack repository](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/nanostack) has the following header files:
Nanostack provides a set of C API headers with more functionalities. The [nanostack repository](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/nanostack) has the following header files():

- `thread_management_if.h` for initializing the stack and managing the network data.
- `thread_commissioning_api.h` for implementing an on-mesh or a native Thread commissioner.
Expand Down