-
Notifications
You must be signed in to change notification settings - Fork 178
Technology/Connectivity refactoring #470
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
Changes from all commits
8d777dd
67d9562
33ab3e0
1d77bcc
79258a3
81c49da
061a5e9
a2984fb
0275964
50b8535
f7bcd5f
fd4ea7f
bdea47e
1d4a28d
5afe2fa
c4a906f
57797bc
6cabaa1
b0b01f9
2961e1d
08d3f9b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -89,7 +89,19 @@ | |
}, | ||
{ | ||
"title": "Technology", | ||
"intro": { | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/technology/technology.md" | ||
}, | ||
"sources": [{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/technology/connectivity/connectivity.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/technology/connectivity/networking.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/technology/mesh/quick_start_intro.md" | ||
}, | ||
|
@@ -120,6 +132,10 @@ | |
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/technology/mesh/04_N_networking.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/technology/connectivity/intro-to-lora.md" | ||
} | ||
] | ||
}, | ||
|
@@ -370,35 +386,43 @@ | |
}, | ||
"sources": [{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/EthInterface.md" | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/UDPSocket.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/WifiInterface.md" | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/TCPSocket.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/CellularInterface.md" | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/TCPServer.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/MeshInterface.md" | ||
}, | ||
{ | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/SocketAddress.md" | ||
} | ||
] | ||
}, | ||
{ | ||
"title": "Network Interfaces", | ||
"intro": { | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/networkinterface.md" | ||
}, | ||
"sources": [{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/UDPSocket.md" | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/EthInterface.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/TCPSocket.md" | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/WifiInterface.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/TCPServer.md" | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/CellularInterface.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/SocketAddress.md" | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/MeshInterface.md" | ||
} | ||
] | ||
}, | ||
|
@@ -436,15 +460,7 @@ | |
}, | ||
{ | ||
"title": "LoRaWAN", | ||
"intro": { | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/lorawan/lora.md" | ||
}, | ||
"sources": [{ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think the user API should start with lorawanevents.md. Could we move this, so it stays with intro-to-lora.md? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Explanation of LoRa itself has moved to Technology/Connectivity/intro-to-lora.md |
||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/lorawan/intro-to-lora.md" | ||
}, | ||
{ | ||
"type": "markdown", | ||
"url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/lorawan/lorawanevents.md" | ||
}, | ||
|
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,92 @@ | ||
<h2 id="mesh-api">Mesh</h2> | ||
<h2 id="mesh-api">6LoWPAN Mesh</h2> | ||
|
||
<span class="images"><span>MeshInterface class hierarchy</span></span> | ||
|
||
The Arm Mbed mesh API allows the application to use the IPv6 mesh network topologies through the [nanostack](/docs/development/reference/technology.html#nanostack) networking stack. | ||
#### 6LoWPAN Mesh Interfaces | ||
|
||
The Arm Mbed Mesh API allows the application to use the IPv6 mesh network topologies through the [Nanostack](/docs/v5.7/tutorials/mesh.html#nanostack) networking stack. | ||
|
||
Mbed OS provides two types of IPv6 based mesh networks: | ||
|
||
- 6LoWPAN_ND, loosely following the Zigbee-IP specification. | ||
- Thread, following the specification from Thread Group. | ||
|
||
Nanostack is the networking stack that provides both of these protocols. For more information on the stack internals, please refer to the [Nanostack documentation](/docs/v5.7/tutorials/mesh.html#nanostack). Application developers use Nanostack through the Mbed Mesh API. | ||
|
||
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 to create a socket to start communication with a remote peer. | ||
|
||
##### Supported mesh networking modes | ||
|
||
Currently, 6LoWPAN-ND (neighbor discovery) and Thread bootstrap modes are supported. | ||
|
||
##### Module configuration | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This section needs to move the configuration section of the reference book. |
||
|
||
This module supports static configuration via the **Mbed configuration system**. The application needs to create an `mbed_app.json` configuration file if you want to use other than default settings. | ||
|
||
An example of the configuration file: | ||
|
||
``` | ||
{ | ||
"target_overrides": { | ||
"*": { | ||
"target.features_add": ["IPV6"], | ||
"mbed-mesh-api.6lowpan-nd-channel": 12, | ||
"mbed-mesh-api.6lowpan-nd-channel-mask": "(1<<12)", | ||
"mbed-mesh-api.heap-size": 10000 | ||
} | ||
} | ||
} | ||
``` | ||
|
||
**Configurable parameters in the `mbed-mesh-api` section** | ||
|
||
| Parameter name | Value | Description | | ||
| --------------- | ------------- | ----------- | | ||
| `heap-size` | number [0-0xfffe] | Nanostack's internal heap size | | ||
|
||
**Thread related configuration parameters** | ||
|
||
| Parameter name | Value | Description | | ||
| --------------- | ------------- | ----------- | | ||
| `thread-pskd` | string [6-255 chars] | Human-scaled commissioning credentials. | | ||
| `thread-use-static-link-config` | boolean | True: Use the below link config, False: Use commissioning, ignore the below link config. | | ||
| `thread-device-type` | enum from `mesh_device_type_t` | Supported device operating modes:<br> `MESH_DEVICE_TYPE_THREAD_ROUTER`<br> `MESH_DEVICE_TYPE_THREAD_SLEEPY_END_DEVICE`<br> `MESH_DEVICE_TYPE_THREAD_MINIMAL_END_DEVICE` | | ||
| `thread-config-channel-mask` | number [0-0x07fff800] | Channel mask, 0x07fff800 scans all channels. | | ||
| `thread-config-channel-page` | number [0]| Channel page, 0 for 2,4 GHz radio. | | ||
| `thread-config-channel` | number [11-26] | RF channel to use. | | ||
| `thread-config-panid` | number [0-0xFFFF] | Network identifier. | | ||
| `thread-config-network-name` | string [1-16] | | ||
| `thread-config-commissioning-dataset-timestamp` | [0-0xFFFFFFFFFFFFFFFF] | [48 bit timestamp seconds]-[15 bit timestamp ticks]-[U bit] | | ||
| `thread-config-extended-panid` | byte array [8] | Extended PAN ID. | | ||
| `thread-master-key` | byte array [16]| Network master key. | | ||
| `thread-config-ml-prefix` | byte array [8] | Mesh local prefix. | | ||
| `thread-config-pskc` | byte array [16] | Pre-Shared Key for the Commissioner. | | ||
| `thread-security-policy` | number [0-0xFF] | Commissioning security policy bits. | | ||
|
||
**6LoWPAN related configuration parameters** | ||
|
||
| Parameter name | Type | Description | | ||
| --------------- | ---------| ----------- | | ||
| `6lowpan-nd-channel-mask` | number [0-0x07fff800] | Channel mask, bit-mask of channels to use. | | ||
| `6lowpan-nd-channel-page` | number [0, 2] | 0 for 2,4 GHz and 2 for sub-GHz radios. | | ||
| `6lowpan-nd-channel` | number [0-26] | RF channel to use when `channel_mask` is not defined. | | ||
| `6lowpan-nd-panid-filter` | number [0-0xffff] | Beacon PAN ID filter, 0xffff means no filtering. | | ||
| `6lowpan-nd-security-mode` | "NONE" or "PSK" | To use either no security, or Pre shared network key. | | ||
| `6lowpan-nd-psk-key-id` | number | PSK key ID when PSK is enabled. | | ||
| `6lowpan-nd-psk-key` | byte array [16] | Pre-Shared network key. | | ||
| `6lowpan-nd-sec-level` | number [1-7] | Network security level. Use default `5`. | | ||
| `6lowpan-nd-device-type` | "NET_6LOWPAN_ROUTER" or "NET_6LOWPAN_HOST" | Device mode. Router is routing packets from other device, creating a mesh network. | | ||
|
||
**Network connection states** | ||
|
||
After the initialization, the network state is `MESH_DISCONNECTED`. After a successful connection, the state changes to `MESH_CONNECTED` and when disconnected from the network the state is changed back to `MESH_DISCONNECTED`. | ||
|
||
In case of connection errors, the state is changed to some of the connection error states. In an error state, there is no need to make a `disconnect` request and the application is allowed to attempt connecting again. | ||
|
||
##### Getting started | ||
|
||
See the example application [mbed-os-example-mesh-minimal](https://github.com/ARMmbed/mbed-os-example-mesh-minimal) for usage. | ||
|
||
**Tips:** | ||
- The mesh API supports 6LoWPAN-ND (neighbor discovery) and Thread bootstrap modes. | ||
- The applications do not use this module directly. The applications use `LoWPANNDInterface`, `ThreadInterface` or `NanostackEthernetInterface` directly. | ||
- When using an Ethernet interface, there are no configuration options available. It is using the dynamic mode to learn the IPv6 prefix from the network. | ||
|
||
### Mesh class reference | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we remove this section (or at least its formatting) from the .json, it will mess up the formatting of the documentation. It's OK to move the page, but we need to keep this formatting.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How can I fix the formatting?
Intro section itself has moved to Technology/Connectivity/intro-to-lora.md