Revision 77:e0618756b84e, committed 2017-03-28

Comitter:

mbed_official

Date:

Tue Mar 28 09:45:11 2017 +0100

Parent:

76:29e676124b6c

Child:

78:8e2d9a2395b9

Commit message:

Doc update thr (#214)

Update README.md - thread channel settings

Described where to find settings for
the thread channel setting in the example parameters.

.
Commit copied from https://github.com/ARMmbed/mbed-os-example-client

Changed in this revision

--- a/README.md	Fri Mar 24 08:30:12 2017 +0000
+++ b/README.md	Tue Mar 28 09:45:11 2017 +0100
@@ -48,6 +48,10 @@
 
 ### Mesh
 
+There are example settings under the configs directory, which provide the easiest way to start with the applications. 
+The [mbed-mesh-api](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed_lib.json)
+defines the defaults settings for applications. The most relevant parameters are described in more detail in the following sections.
+
 #### Supported boards
 
 * K64F + NXP MCR20 15.4 shield (mesh `NANOSTACK_FULL` mode)
@@ -99,6 +103,31 @@
     }
 ```
 
+#### Channel settings
+
+The default 2.4GHz channel settings are already defined by the [mbed-mesh-api](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api) to match the mbed gateway settings. The application can override these settings by adding them to the `.json` file. For example:
+
+```json
+    "target_overrides": {
+        "*": {
+            "mbed-mesh-api.6lowpan-nd-channel-page": 0,
+            "mbed-mesh-api.6lowpan-nd-channel": 12,
+            "mbed-mesh-api.thread-config-channel-page": 0,
+            "mbed-mesh-api.thread-config-channel": 22
+        }
+    }
+```
+
+For sub-GHz shields ([Spirit1](https://github.com/ARMmbed/stm-spirit1-rf-driver) or AT86RF212B) use the following overrides, **6LoWPAN ND only**:
+
+```json
+"mbed-mesh-api.6lowpan-nd-channel-page": 2,
+"mbed-mesh-api.6lowpan-nd-channel": 1
+```
+
+For more information about the radio shields, see [the related documentation](docs/radio_module_identify.md). 
+ 
+=======
 #### Supported combinations of board and shields
 
 See Mesh-minimal's [Notes on different hardware](https://github.com/ARMmbed/mbed-os-example-mesh-minimal/blob/master/Hardware.md) for known combinations of development boards and RF shields that have been tested with mesh networking stack.
@@ -130,30 +159,6 @@
 
 You can view debug traces from the gateway with a serial port monitor. The gateway uses baud rate 460800. The gateway IPv6 address is correctly configured when the following trace is visible: `Eth bootstrap ready, IP=XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX`.
 
-#### Channel settings
-
-The default 2.4GHz channel settings are already defined by the [mbed-mesh-api](https://github.com/ARMmbed/mbed-mesh-api) to match the mbed gateway settings. The application can override these settings by adding them to the `mbed_app.json` file in the main project directory. For example:
-
-```json
-    "target_overrides": {
-        "*": {
-            "mbed-mesh-api.6lowpan-nd-channel-page": 0,
-            "mbed-mesh-api.6lowpan-nd-channel": 12,
-            "mbed-mesh-api.thread-config-channel-page": 0,
-            "mbed-mesh-api.thread-config-channel": 12
-        }
-    }
-```
-
-For sub-GHz shields ([Spirit1](https://github.com/ARMmbed/stm-spirit1-rf-driver) or AT86RF212B) use the following overrides, **6LoWPAN ND only**:
-
-```json
-"mbed-mesh-api.6lowpan-nd-channel-page": 2,
-"mbed-mesh-api.6lowpan-nd-channel": 1
-```
-
-For more information about the radio shields, see [the related documentation](docs/radio_module_identify.md). All configurable settings are in the `mbed-os-example-client/mbed-os/features/FEATURE_IPV6/mbed-mesh-api/mbed_lib.json` file.
-
 #### Thread-specific settings
 
 With Thread, you can change the operating mode of the client from the default router mode to a sleepy end device by adding the following override to the `mbed_app.json` file: