Skip to content

Commit b59c6e1

Browse files
author
Arto Kinnunen
committed
Update 6LoWPAN mesh documentation
-Update EUI64 reading in Thread commissioning -Fix few broken links -Update Thread application list
1 parent 1af6498 commit b59c6e1

File tree

3 files changed

+9
-12
lines changed

3 files changed

+9
-12
lines changed

docs/reference/technology/mesh/thread_commissioning.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A model network setup could look like this:
1818

1919
#### Building the end node application
2020

21-
By default, the Mbed Thread applications/examples use the static network link configuration defined in the [mesh-api configuration file](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed_lib.json). If you want to use the Thread commissioning, add the following lines to your `.json` file. You can use the [mesh-minimal](https://github.com/ARMmbed/mbed-os-example-mesh-minimal) application as an example.
21+
By default, the Mbed Thread applications/examples use the static network link configuration defined in the [mesh-api configuration file](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/mbed-mesh-api/mbed_lib.json). If you want to use the Thread commissioning, add the following lines to your `.json` file. You can use the [mesh-minimal](https://github.com/ARMmbed/mbed-os-example-mesh-minimal) application as an example.
2222

2323
- `"mbed-mesh-api.thread-use-static-link-config": false` under `"target_overrides":`
2424
- `"macros": ["MBEDTLS_USER_CONFIG_FILE=\"mbedtls_config.h\""]` in to the same level as `"config":` and `"target_overrides":`
@@ -35,14 +35,12 @@ Once the binary is generated, flash the binary to the end device, and run the ap
3535

3636
You can use [a free online tool](http://www.qr-code-generator.com/) to generate a QR code.
3737

38-
In the online tool, fill in the URL field. The following is an example: `v=1&eui=000b57fffe07a8be&cc=PV7TUCB0`. Fill in the correct values for your device, and ensure `v=1` is always present. The other required parameters are:
38+
In the online tool, fill in the URL field. The following is an example: `v=1&eui=000b57fffe07a8be&cc=ABCDEFGH`. Fill in the correct values for your device, and ensure `v=1` is always present. The other required parameters are:
3939

4040
- `cc` is the PSKd, which is configured in the `.json` file (see the mesh-api configuration). *PSKd must be uppercase characters (0-9, A-Y excluding I,O,Q and Z)*
41-
- `eui` is equal to the RF MAC address by default.
41+
- `eui` is equal to the EUI64 address.
4242

43-
To get the MAC address for your end device, connect the node to the Thread network with static configuration enabled. In other words, `"mbed-mesh-api.thread-use-static-link-config": true`, unless you have your own configuration for the MAC address.
44-
45-
For example, in the **mesh-minimal** application, place this `printf("MAC address = %s\n", mesh.get_mac_address());` after `printf("connected. IP = %s\n", mesh.get_ip_address());`
43+
You can get EUI64 address for your end device by using method `device_eui64_get` in your application. An example can be found from the [mesh-minimal](https://github.com/ARMmbed/mbed-os-example-mesh-minimal).
4644

4745
There are four additional (optional) query parameters you can put into this field:
4846

docs/reference/technology/mesh/thread_faq.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,11 @@ Ad-hoc networks with devices from different manufacturers can be easily created
3232

3333
An example application is [downloadable from the Android store](https://play.google.com/store/apps/details?id=org.threadgroup.commissioner).
3434

35-
#### Are there any application examples? What are the Thread features supported/not supported by them?
35+
#### Are there any application examples?
3636

37-
- Application examples supporting SED and REED types:
38-
- [Mbed OS Client example](https://github.com/ARMmbed/mbed-os-example-client).
39-
- [Mesh minimal example](https://github.com/ARMmbed/mbed-os-example-mesh-minimal).
37+
- [Mesh minimal example](https://github.com/ARMmbed/mbed-os-example-mesh-minimal).
4038
- [Thread border router](https://github.com/ARMmbed/nanostack-border-router).
39+
- [Mbed Cloud client example](https://github.com/ARMmbed/mbed-cloud-client-example)
4140

4241
#### How to debug and visualize the network?
4342

docs/reference/technology/mesh/thread_intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ The key elements of Mbed OS are:
3333

3434
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.
3535

36-
- To connect to the Thread network, use the [Thread interface API](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h).
36+
- 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).
3737
- For the socket communication over the Thread network, use the [Mbed sockets API](../apis/network-socket.html).
3838

39-
Nanostack provides a set of C API headers with more functionalities. The [nanostack repository](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/FEATURE_NANOSTACK/sal-stack-nanostack/nanostack) has the following header files():
39+
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():
4040

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

0 commit comments

Comments
 (0)