Diff: README.md

Revision:

76:29e676124b6c

Parent:

74:2a6c17db52ea

Child:

77:e0618756b84e

--- a/README.md	Thu Mar 23 20:30:11 2017 +0000
+++ b/README.md	Fri Mar 24 08:30:12 2017 +0000
@@ -2,6 +2,12 @@
 
 This is the mbed Client example for mbed OS (we also have one for [Linux](https://github.com/ARMmbed/mbed-client-linux-example)). It demonstrates how to register a device with mbed Device Connector, how to read and write values, and how to deregister. If you are unfamiliar with mbed Device Connector, we recommend that you read [the introduction to the data model](https://docs.mbed.com/docs/mbed-device-connector-web-interfaces/en/latest/#the-mbed-device-connector-data-model) first.
 
+## Required software
+
+* [ARM mbed account](https://developer.mbed.org/account/login/?next=/).
+* [mbed-cli](https://github.com/ARMmbed/mbed-cli) - to build the example programs. To learn how to build mbed OS applications with mbed-cli, see [the user guide](https://github.com/ARMmbed/mbed-cli/blob/master/README.md).
+* [Serial port monitor](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications).
+
 The application:
 
 * Connects to network with WiFi, Ethernet, 6LoWPAN ND or Thread connection.
@@ -10,89 +16,59 @@
 * Records the number of clicks on the device’s button and sends the number to mbed Device Connector.
 * Lets you control the blink pattern of the LED on the device (through mbed Device Connector).
 
-## Required hardware
-
-* [FRDM-K64F](http://developer.mbed.org/platforms/frdm-k64f/) board.
-* 1-2 micro-USB cables.
-* [mbed 6LoWPAN gateway router](https://firefly-iot.com/product/firefly-6lowpan-gateway-2-4ghz/) for 6LoWPAN ND and Thread.
-* mbed 6LoWPAN shield (AT86RF212B/[AT86RF233](https://firefly-iot.com/product/firefly-arduino-shield-2-4ghz/)) for 6LoWPAN ND and Thread.
-* Ethernet cable and connection to the internet.
-
-## Supported target hardware configurations
-
- This example has been tested in following configuration
- * K64F + NXP MCR20 15.4 shield (mesh `NANOSTACK_FULL` mode)
- * [NUCLEO_F429ZI](https://developer.mbed.org/platforms/ST-Nucleo-F429ZI/) + [X-NUCLEO-IDS01A4](https://github.com/ARMmbed/stm-spirit1-rf-driver) Spirit1 6LoWPAN expansion board (mesh `LOWPAN_ROUTER` mode)
- * NUCLEO_F429ZI + ATMEL AT233 15.4 shield (mesh `LOWPAN_ROUTER` mode)
- * K64F (Ethernet)
- * NUCLEO_F429ZI (Ethernet)
- * UBLOX_EVK_ODIN_W2 (WiFi & Ethernet - use the supplied `configs/eth_v4.json` for Ethernet)
- * K64F + GROVE SEEED shield (WiFi)
- * NUCLEO_F429ZI + GROVE SEEED shield (WiFi)
-
-Apart from this, this example can work on other mbed OS supported hardware boards which support any of the given network interface including Ethernet, WiFi, Mesh (6LoWPAN) or Thread, provided the configuration fulfills condition that the target hardware has TLS entropy implemented for it and the complete example configuration of mbed Client, selected network interface and mbed OS components fits into hardware's given memory size (Flash size and RAM size). 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.
-
-To see how different targets are built please see the supplied `build_all.sh script`.
-
-## Requirements for non-K64F boards
-
-*   This example requires TLS functionality to be enabled on mbed TLS.
-    On devices where hardware entropy is not present, TLS is disabled by default.
-    This would result in compile time failures or linking failures.
-
-    To learn why entropy is required, read the
-    [TLS Porting guide](https://docs.mbed.com/docs/mbed-os-handbook/en/5.2/advanced/tls_porting/).
-
-*   On non-K64F boards, there is no unregistration functionality and
-    button presses are simulated through timer ticks incrementing every 15 seconds.
-
-## Required software
-
-* [ARM mbed account](https://developer.mbed.org/account/login/?next=/).
-* [mbed-cli](https://github.com/ARMmbed/mbed-cli) - to build the example programs. To learn how to build mbed OS applications with mbed-cli, see [the user guide](https://github.com/ARMmbed/mbed-cli/blob/master/README.md).
-* [Serial port monitor](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications).
-
 ## Application setup
 
 To configure the example application:
 
-1. [Select the connection type](#connection-type).
+1. [Select network and board](#select-network-and-board)
+    * [Ethernet](#ethernet)
+    * [Mesh (6LoWPAN and Thread)](#mesh)
+    * [WiFi](#wifi)
+    * [Non listed boards](#non-listed-board-support)
 1. [Set the client credentials](#client-credentials).
-1. [Change 6LoWPAN ND & Thread settings](#6lowpan-nd-and-thread-settings).
-1. [Change Ethernet settings](#ethernet-settings).
-1. [Change WiFi settings](#wifi-settings).
 1. [Set up an IP address](#ip-address-setup). This step is optional.
 1. [Change the socket type](#changing-the-socket-type). This step is optional.
 
-### Connection type
+### Select network and board
+
+This example supports following hardware-network combinations:
 
-The application uses Ethernet as the default connection type. To change the connection type, set one of them in `mbed_app.json`. For example, to enable 6LoWPAN ND mode:
+### Ethernet
+
+#### Supported boards
 
-```json
-    "network-interface": {
-        "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
-        "value": "MESH_LOWPAN_ND"
-    }
-```
+* K64F
+* NUCLEO_F429ZI
+* UBLOX_EVK_ODIN_W2 (use the supplied `configs/eth_v4.json`)
+
+For running the example application using Ethernet, you need:
+
+- An Ethernet cable.
+- An Ethernet connection to the internet.
 
-### Client credentials
+### Mesh
+
+#### Supported boards
 
-To register the application with the Connector service, you need to create and set the client side certificate.
+* K64F + NXP MCR20 15.4 shield (mesh `NANOSTACK_FULL` mode)
+* [NUCLEO_F429ZI](https://developer.mbed.org/platforms/ST-Nucleo-F429ZI/) + [X-NUCLEO-IDS01A4](https://github.com/ARMmbed/stm-spirit1-rf-driver) Spirit1 6LoWPAN expansion board (mesh `LOWPAN_ROUTER` mode)
+* NUCLEO_F429ZI + ATMEL AT233 15.4 shield (mesh `LOWPAN_ROUTER` mode)
+* [Supported combinations of board and shields](#supported-combinations-of-board-and-shields)
 
-1. Go to [mbed Device Connector](https://connector.mbed.com) and log in with your mbed account.
-1. On mbed Device Connector, go to [My Devices > Security credentials](https://connector.mbed.com/#credentials) and click the **Get my device security credentials** to get new credentials for your device.
-1. Replace the contents in the `security.h` file of this project's directory with the content copied above.
+First, you need to select the RF driver to be used by the 6LoWPAN/Thread stack. 
+
+This example supports these shields:
 
-### 6LoWPAN ND and Thread settings
+* [AT86RF233/212B](https://github.com/ARMmbed/atmel-rf-driver)
+* [NXP-MCR20a](https://github.com/ARMmbed/mcr20a-rf-driver)
+* [X-NUCLEO-IDS01A4](https://github.com/ARMmbed/stm-spirit1-rf-driver) (*a.k.a.* Spirit1) radio shields. Check instructions for compilation [here](#compile-configuration-for-spirit1)
 
-First, you need to select the RF driver to be used by the 6LoWPAN/Thread stack. This example supports [AT86RF233/212B](https://github.com/ARMmbed/atmel-rf-driver), [NXP-MCR20a](https://github.com/ARMmbed/mcr20a-rf-driver), and [X-NUCLEO-IDS01A4](https://github.com/ARMmbed/stm-spirit1-rf-driver) (*a.k.a.* Spirit1) radio shields.
-
-To choose the radio shield make sure that the `mbed_app.json` file points to the correct radio driver type:
+To select the radio shield make sure that the `mbed_app.json` file points to the correct radio driver type:
 
 ```json
     "mesh_radio_type": {
-        	"help": "options are ATMEL, MCR20, SPIRIT1",
-        	"value": "ATMEL"
+            "help": "options are ATMEL, MCR20, SPIRIT1",
+            "value": "ATMEL"
         },
 ```
 
@@ -102,15 +78,18 @@
 "target.features_add": ["NANOSTACK", "LOWPAN_ROUTER", "COMMON_PAL"],
 ```
 
-If your connection type is `MESH_THREAD` then you may want to use the THREAD_ROUTER configuration:
+If your connection type is `MESH_THREAD` then you may want to use the `THREAD_ROUTER` configuration:
 
 ```
 "target.features_add": ["NANOSTACK", "THREAD_ROUTER", "COMMON_PAL"],
 ```
 
-6LoWPAN ND and Thread use IPv6 for connectivity. Therefore, you need to verify first that you have a working IPv6 connection. To do that, ping the Connector IPv6 address `2607:f0d0:2601:52::20` from your network.
+Since 6LoWPAN ND and Thread use IPv6 for connectivity, you need to verify first that you have a working IPv6 connection. 
+To do that, ping the Connector IPv6 address `2607:f0d0:2601:52::20` from your network.
 
-<span class="notes">**Note:** In case you want to use the STM Spirit1 Sub-1 GHz RF expansion board (X-NUCLEO-IDS01A4), you need also to configure its MAC address in the `mbed_app.json` file, for example:</span>
+#### Compile configuration for Spirit1
+
+<span class="notes">**Note:** In case you want to use the STM Spirit1 Sub-1 GHz RF expansion board (X-NUCLEO-IDS01A4), you also need to configure its MAC address in the `mbed_app.json` file, for example:</span>
 
 ```json
     "target_overrides": {
@@ -120,13 +99,17 @@
     }
 ```
 
+#### 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.
+
 #### Border router
 
 There are two options for border router.
 
 ##### Nanostack-border-router
 
- The [nanostack-border-router](https://github.com/ARMmbed/nanostack-border-router) can be configured and built for the 6LoWPAN ND or Thread mode.  
+You can configure and build the [nanostack-border-router](https://github.com/ARMmbed/nanostack-border-router) for the 6LoWPAN ND or Thread mode.  
 
 ##### mbed gateway
 
@@ -138,10 +121,10 @@
 2. Use a micro-USB cable to connect the mbed 6LoWPAN gateway router to your computer. The computer will list the router as removable storage.
 3. The firmware for the gateway is located in the `GW_Binary` folder in the root of this example. Select the binary matching your application bootstrap mode:
 
-	* For the **6LoWPAN ND** bootstrap, use `gateway6LoWPANDynamic.bin`.
-	* For the **Thread** bootstrap, use `gatewayThreadDynamic.bin`.
+    * For the **6LoWPAN ND** bootstrap, use `gateway6LoWPANDynamic.bin`.
+    * For the **Thread** bootstrap, use `gatewayThreadDynamic.bin`.
 
-	The dynamic binaries use IPv6 autoconfiguration and enable the client to connect to the mbed Device Connector service. The static binaries create a site-local IPv6 network and packets cannot be routed outside.
+    The dynamic binaries use IPv6 autoconfiguration and enable the client to connect to the mbed Device Connector service. The static binaries create a site-local IPv6 network and packets cannot be routed outside.
 
 4. Copy the gateway binary file to the mbed 6LoWPAN gateway router to flash the device. The device reboots automatically after flashing. If that does not happen, press the **Reset** button on the board.
 
@@ -169,7 +152,7 @@
 "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 can be found in the `mbed-os-example-client/mbed-os/features/FEATURE_IPV6/mbed-mesh-api/mbed_lib.json` file.
+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
 
@@ -179,22 +162,21 @@
     "mbed-mesh-api.thread-device-type": "MESH_DEVICE_TYPE_THREAD_SLEEPY_END_DEVICE"
 ```
 
-### Ethernet settings
+## WiFi
 
-For running the example application using Ethernet, you need:
+#### Supported boards
 
-- An Ethernet cable.
-- An Ethernet connection to the internet.
+* UBLOX_EVK_ODIN_W2. Check instructions for compilation [here](#compile-configuration-for-odin-wifi).
+* K64F + GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
+* NUCLEO_F429ZI + GROVE SEEED shield using [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
 
-### WiFi settings
-
-The example application uses ESP8266 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need:
+To run this application using ESP8266 WiFi Interface, you need:
 
 1. An [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
 1. Updated [Espressif Firmware](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update).
 1. Mount the WiFi module onto [K64F Grove Shield v2](https://developer.mbed.org/platforms/FRDM-K64F/#supported-seeed-studio-grove-extension).
-1. Attach the shield on the K64F board.
-1. In the `mbed_app.json` file, change
+1. Attach the shield on your board.
+1. In the `mbed_app.json` file, change:
 
 ```json
     "network-interface": {
@@ -216,7 +198,7 @@
     }
 ```
 
-<span class="notes">**Note:** Some devices do not support the Grove Shield or use the primary UART for USB communication. On such devices, the `mbed_app.json` should be modified to use the serial pins connected to the ESP8266.</span>
+<span class="notes">**Note:** Some devices do not support the Grove Shield or use the primary UART for USB communication. On such devices, modify the `mbed_app.json` to use the serial pins connected to the ESP8266.</span>
 
 For example, NUCLEO_F401RE requires a different serial connection:
 
@@ -231,9 +213,41 @@
     }
 ```
 
+#### Compile configuration for ODIN WiFi
+
+To compile ODIN WiFi configuration, you need to tell mbed NOT to compile the related files. To do that, set up a `.mbedignore` file. An example file is available in the `configs` folder.     
+
+This should resolve the issue:
+
+```     
+cp configs/eth-wifi-mbedignore ./.mbedignore 
+```    
+ 
+### Non listed board support 
+
+Apart from the listed configurations, this example can work on other mbed OS supported hardware boards which support any of the given network interface including Ethernet, WiFi, Mesh (6LoWPAN) or Thread, provided the configuration fulfills condition that the target hardware has TLS entropy implemented for it. On devices where hardware entropy is not present, TLS is disabled by default. This would result in compile time failures or linking failures.
+
+To learn why entropy is required, read the [TLS Porting guide](https://docs.mbed.com/docs/mbed-os-handbook/en/5.2/advanced/tls_porting/).
+
+Also, the complete example configuration of mbed Client, the selected network interface and mbed OS components must fit into hardware's given memory size (Flash size and RAM size). 
+
+<span class="notes">**Note:** On non-K64F boards, there is no unregistration functionality and button presses are simulated through timer ticks incrementing every 15 seconds.</span>
+
+<span class="notes">**Note:** To see how different targets are built please see the supplied `build_all.sh script`.</span>
+
+
+### Client credentials
+
+To register the application with the mbed Device Connector service, you need to create and set the client side certificate.
+
+1. Go to [mbed Device Connector](https://connector.mbed.com) and log in with your mbed account.
+1. On mbed Device Connector, go to [My Devices > Security credentials](https://connector.mbed.com/#credentials) and click the **Get my device security credentials** to get new credentials for your device.
+1. Replace the contents in the `security.h` file of this project's folder with the content copied above.
+
 ### IP address setup
 
 This example uses IPv4 to communicate with the [mbed Device Connector Server](https://api.connector.mbed.com) except for 6LoWPAN ND and Thread. However, you can easily change it to IPv6 by changing the `mbed_app.json` you make:
+
 ```
     "target_overrides": {
         "*": {
@@ -243,6 +257,7 @@
             "mbed-trace.enable": 0
         }
 ```
+
 by modifying the `ipv4-enabled` or `ipv6-enabled` to `true/false`. Only one should be true.
 
 The example program should automatically get an IP address from the router when connected over Ethernet or WiFi.
@@ -311,41 +326,6 @@
 
 Import this repository in the Online IDE and continue from step 3 onwards.
 
-### Compilation problems		
-		
-If you encounter a problem like this when compiling the application:
-		
-```		
-Building project mbed-os-example-client (K64F, GCC_ARM)		
-Scan: .		
-Scan: FEATURE_LWIP		
-Scan: FEATURE_UVISOR		
-Scan: FEATURE_COMMON_PAL		
-Scan: FEATURE_BLE		
-Scan: FEATURE_STORAGE		
-Scan: FEATURE_THREAD_BORDER_ROUTER		
-Scan: FEATURE_THREAD_ROUTER		
-Scan: FEATURE_LOWPAN_BORDER_ROUTER		
-Scan: FEATURE_LOWPAN_ROUTER		
-Scan: FEATURE_LOWPAN_HOST		
-Scan: FEATURE_NANOSTACK_FULL		
-Scan: FEATURE_NANOSTACK		
-Scan: FEATURE_THREAD_END_DEVICE		
-Scan: mbed		
-Scan: env		
-Compile [  0.3%]: NanostackRfPhyAtmel.cpp		
-[ERROR] ./atmel-rf-driver/source/NanostackRfPhyAtmel.cpp:18:44: fatal error: nanostack/platform/arm_hal_phy.h: No such file or directory		
-compilation terminated.		
-```		
-
-You are probably using the LWIP stack with Ethernet or WiFi and you have the mesh RF stacks in the root of this example. You need to tell mbed NOT to compile the related files. To do that, set up a `.mbedignore` file. An example file is available in the `configs` folder.		
-
-This should resolve the issue:
-
-```		
-cp configs/eth-wifi-mbedignore ./.mbedignore		
-```		
- 		
 ## Monitoring the application
 
 The application prints debug messages over the serial port, so you can monitor its activity with a serial port monitor. The application uses baud rate 115200.
@@ -384,8 +364,8 @@
 4. Press the **SW2** button on the device a number of times (make a note of how many times you did that).
 5. Go to [Device Connector > API Console](https://connector.mbed.com/#console).
 6. Click the **Endpoint directory lookups** drop down menu.
-![](/docs/img/ep_lookup.PNG) 
-7. In the menu, click **GET** next to **Endpoint's resource representation**. Select your _endpoint_ and _resource-path_. For example, the _endpoint_ is the identifier of your endpoint that can be found in the `security.h` file as `MBED_ENDPOINT_NAME`. Choose `3200/0/5501`as a resource path and click **TEST API**. 
+    ![](/docs/img/ep_lookup.PNG) 
+7. In the menu, click **GET** next to **Endpoint's resource representation**. Select your _endpoint_ and _resource-path_. For example, the _endpoint_ is the identifier of your endpoint that can be found in the `security.h` file as `MBED_ENDPOINT_NAME`. Select `3200/0/5501`as a resource path and click **TEST API**. 
 8. The number of times you pressed **SW2** is shown.
 9. Press the **SW3** button to unregister from mbed Device Connector. You should see `Unregistered Object Successfully` printed to the serial port and the LED starts blinking. This will also stop your application. Press the **Reset** button to run the program again.