Skip to content

Commit b125721

Browse files
author
Amanda Butler
authored
Update header sizes again in mesh.md
Change title to match other docs, and update header sizes for nestling.
1 parent 903e5b0 commit b125721

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/refs/api/networking/mesh.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
### mbed mesh API
1+
#### Arm Mbed Mesh
22

33
ARM mbed mesh API allows the client to use the IPv6 mesh network.
44

55
The client can use the `LoWPANNDInterface` or `ThreadInterface` object for connecting to the mesh network and when successfully connected, the client can create a socket by using the [mbed C++ socket API](https://developer.mbed.org/teams/NetworkSocketAPI/code/NetworkSocketAPI/docs/tip/) to start communication with a remote peer.
66

77
For ethernet `NanostackEthernetInterface` is provided.
88

9-
#### Supported mesh networking modes
9+
##### Supported mesh networking modes
1010

1111
Currently, 6LoWPAN-ND (neighbour discovery) and Thread bootstrap modes are supported.
1212

13-
#### Module Configuration
13+
##### Module Configuration
1414

1515
This module supports static configuration via **mbed configuration system** by using the `mbed_app.json` file. The application needs to create the configuration file if it wants to use other than default settings.
1616

@@ -29,13 +29,13 @@ An example of the configuration file:
2929
}
3030
```
3131

32-
##### Configurable parameters in section mbed-mesh-api
32+
###### Configurable parameters in section mbed-mesh-api
3333

3434
| Parameter name | Value | Description |
3535
| --------------- | ------------- | ----------- |
3636
| heap-size | number [0-0xfffe] | Nanostack's internal heap size |
3737

38-
##### Thread related configuration parameters
38+
###### Thread related configuration parameters
3939

4040
| Parameter name | Value | Description |
4141
| --------------- | ------------- | ----------- |
@@ -54,7 +54,7 @@ An example of the configuration file:
5454
| thread-config-pskc | byte array [16] | Pre-Shared Key for the Commissioner. |
5555
| thread-security-policy | number [0-0xFF] | Commissioning security policy bits |
5656

57-
##### 6LoWPAN related configuration parameters
57+
###### 6LoWPAN related configuration parameters
5858

5959
| Parameter name | Type | Description |
6060
| --------------- | ---------| ----------- |
@@ -68,23 +68,23 @@ An example of the configuration file:
6868
| 6lowpan-nd-sec-level | number [1-7] | Network security level. Use default `5` |
6969
| 6lowpan-nd-device-type | "NET_6LOWPAN_ROUTER" or "NET_6LOWPAN_HOST" | Device mode. Router is routing packets from other device, creating a mesh network. |
7070

71-
#### Usage notes
71+
##### Usage notes
7272

7373
This module should not be used directly by the applications. The applications should use the `LoWPANNDInterface`, `ThreadInterface` or `NanostackEthernetInterface` directly.
7474

7575
When using Ethernet interface, there is no configuration options available. It is using dynamic mode to learn the IPv6 prefix from the network. No static configuration is supported.
7676

77-
##### Network connection states
77+
###### Network connection states
7878

7979
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`.
8080

8181
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 client is allowed to attempt connecting again.
8282

83-
#### Getting started
83+
##### Getting started
8484

8585
See the example application [mbed-os-example-mesh-minimal](https://github.com/ARMmbed/mbed-os-example-mesh-minimal) for usage.
8686

87-
#### Usage example for 6LoWPAN ND mode
87+
##### Usage example for 6LoWPAN ND mode
8888

8989
Create a network interface and driver objects.
9090

@@ -110,7 +110,7 @@ Then connect to network:
110110
printf("connected. IP = %s\r\n", mesh.get_ip_address());
111111
```
112112

113-
#### Usage example for 6LoWPAN Thread mode
113+
##### Usage example for 6LoWPAN Thread mode
114114

115115
Basically the same as for ND, but the network interface uses different class:
116116

@@ -119,7 +119,7 @@ ThreadInterface mesh;
119119
mesh.connect();
120120
```
121121

122-
#### Usage example with Ethernet
122+
##### Usage example with Ethernet
123123

124124
API is still the same, you just need to provide a driver that implements `NanostackEthernetPhy` API.
125125

0 commit comments

Comments
 (0)