Getting started with mbed Client on mbed OS

Diff: README.md

Revision:

21:b88cdeb5b302

Parent:

13:c44e318674db

Child:

22:e39e09d79a63

--- a/README.md	Wed Oct 05 05:15:22 2016 +0100
+++ b/README.md	Fri Oct 21 09:30:10 2016 +0100
@@ -18,16 +18,17 @@
 * 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.
 
-## Requirements for non K64F board
-This example application is primarily designed for FRDM-K64F board but you can also use other mbed OS supported boards to run this example application , with some minor modifications for setup.
-* To get the application registering successfully on non K64F boards , you need Edit the `mbed_app.json` file to add `NULL_ENTROPY`  feature for mbedTLS:
+## 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.
 
-```
-""macros": ["MBEDTLS_USER_CONFIG_FILE=\"mbedtls_mbed_client_config.h\"",
-            "MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES",
-            "MBEDTLS_TEST_NULL_ENTROPY"],
-```
-* On non K64F boards, there is no unregistration functionality and button press is simulated through timer ticks incrementing every 15 seconds.
+    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
 
@@ -37,7 +38,7 @@
 
 ## Application setup
 
-To configure the example application, please:
+To configure the example application:
 
 1. [Select the connection type](#connection-type).
 1. [Set the client credentials](#client-credentials).
@@ -60,29 +61,43 @@
 
 ### Client credentials
 
-To register the application to the Connector service, you need to create and set the client side certificate.
+To register the application with the 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** button to get new credentials for your device.
-1. Replace the contents in `security.h` of this project's directory with content copied above.
+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.
 
 ### 6LoWPAN ND and Thread settings
 
-First you need to select the RF driver to be used by 6LoWPAN/Thread stack.
+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) and [NXP-MCR20a](https://github.com/ARMmbed/mcr20a-rf-driver) radio shields.
 
-For example Atmel AT86RF233/212B driver is located in https://github.com/ARMmbed/atmel-rf-driver
+To add the Atmel driver to you application from command line, call: `mbed add https://github.com/ARMmbed/atmel-rf-driver`.
+Please make sure that the `mbed_app.json` file points to the correct radio driver type:
 
-To add that driver to you application from command line, call: `mbed add https://github.com/ARMmbed/atmel-rf-driver`
+```json
+    "mesh_radio_type": {
+        	"help": "options are ATMEL, MCR20",
+        	"value": "ATMEL"
+        },
+```
 
-Then you need to enable the IPV6 functionality as the 6LoWPAN and Thread are part of IPv6 stack. Edit the `mbed_app.json` file to add `IPV6` feature:
+Then you need to enable ARM IPv6/6LoWPAN stack. Edit the `mbed_app.json` file to add `NANOSTACK` feature with the particular configuration of the stack:
 
 ```
-"target.features_add": ["CLIENT", "IPV6", "COMMON_PAL"],
+"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:
+
+```
+"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.
 
-**NOTE:** If you are using  [k64f-border-router](https://github.com/ARMmbed/k64f-border-router) (which can be used only as a 6LoWPAN BR and only with FRDM-K64F), you need to enable another security feature. By default, k64f-border-router uses `PSK` as security. You can either enable security here on your mbed-os-example-client application, e.g.,
+<span class="notes">**Note:** If you are using the [k64f-border-router](https://github.com/ARMmbed/k64f-border-router) (that can be used only as a 6LoWPAN BR and only with FRDM-K64F), you need to enable another security feature. By default, the `k64f-border-router` uses `PSK` as security.</span>
+
+You can enable the security here on your mbed-os-example-client application, for example:
 
 ```json
     "target_overrides": {
@@ -91,13 +106,15 @@
         }
 	}
 ```
-or you can remove link layer security from k64f-border-router. For doing that, change the [mbed_app.json](https://github.com/ARMmbed/k64f-border-router/blob/master/mbed_app.json) fetched from k64f-border-router repository, e.g., 
+
+Alternatively, you can remove the link layer security from the `k64f-border-router`. To do that, change the [mbed_app.json](https://github.com/ARMmbed/k64f-border-router/blob/master/mbed_app.json) fetched from the `k64f-border-router` repository, for example: 
 
 ```json
     "config": {
             "security-mode": "NONE",
         }
 ```
+
 #### mbed gateway
 
 To connect the example application in 6LoWPAN ND or Thread mode to Connector, you need to set up an mbed 6LoWPAN gateway router as follows:
@@ -137,7 +154,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 the 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 can be found in the `mbed-os-example-client/mbed-os/features/FEATURE_IPV6/mbed-mesh-api/mbed_lib.json` file.
 
 #### Thread-specific settings
 
@@ -158,11 +175,12 @@
 
 The example application uses ESP8266 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, 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. 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
+
 ```json
     "network-interface": {
         "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
@@ -171,6 +189,7 @@
 ```
 
 Provide your WiFi SSID and password here and leave `\"` in the beginning and end of your SSID and password (as shown in the example below). Otherwise, the example cannot pick up the SSID and password in correct format.
+
 ```json
     "wifi-ssid": {
         "help": "WiFi SSID",
@@ -182,9 +201,9 @@
     }
 ```
 
-<span class="notes">**Note:** Some devices don't support the Grove Shield or use the primary UART for USB communication. On these 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, the `mbed_app.json` should be modified to use the serial pins connected to the ESP8266.</span>
 
-For example, the NUCLEO_F401RE requires a different serial connection:
+For example, NUCLEO_F401RE requires a different serial connection:
 
 ```json
     "wifi-tx": {
@@ -218,21 +237,43 @@
 
 ## Building the example
 
-To build the example application:
+To build the example using mbed CLI:
 
-1. Clone [this](https://github.com/ARMmbed/mbed-os-example-client) repository.
 1. Open a command line tool and navigate to the project’s directory.
-1. Update mbed-os sources using the `mbed update` command.
-1. [Configure](#application-setup) the client application.
-1. Build the application by selecting the hardware board and build the toolchain using the command `mbed compile -m K64F -t GCC_ARM -c -j0`. mbed-cli builds a binary file under the project’s `.build` directory.
-1. Plug the Ethernet cable into the board if you are using Ethernet mode.
-1. If you are using 6LoWPAN ND or Thread mode, connect and power on the gateway first.
-1. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device.
-1. Drag the binary `.build/K64F/GCC_ARM/mbed-os-example-client.bin` to the board to flash the application.
-1. The board is automatically programmed with the new binary. A flashing LED on it indicates that it is still working. When the LED stops blinking, the board is ready to work.
-1. Press the **RESET** button on the board to run the program.
-1. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter.
+
+2. Import this example:
+
+    ```
+    mbed import mbed-os-example-client
+    ```
+
+3. [Configure](#application-setup) the client application.
+
+4. To build the application, select the hardware board and build the toolchain using the command:
+
+    ```
+    mbed compile -m K64F -t GCC_ARM -c
+    ```
+
+    mbed CLI builds a binary file under the project’s `BUILD/` directory.
 
+5. Plug the Ethernet cable into the board if you are using Ethernet mode.
+
+6. If you are using 6LoWPAN ND or Thread mode, connect and power on the gateway first.
+
+7. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device.
+
+8. Drag the binary `BUILD/K64F/GCC_ARM/mbed-os-example-client.bin` to the board to flash the application.
+
+9. The board is automatically programmed with the new binary. A flashing LED on it indicates that it is still working. When the LED stops blinking, the board is ready to work.
+
+10. Press the **Reset** button on the board to run the program.
+
+11. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter.
+
+**To build the example using the Online IDE:**
+
+Import this repository in the Online IDE and continue from step 3 onwards.
 
 ## Monitoring the application
 
@@ -254,9 +295,9 @@
 
 ```
 
-<span class="notes">**Note:** Device name is the endpoint name you will need later on when [testing the application](https://github.com/ARMmbed/mbed-os-example-client#testing-the-application) chapter.</span>
+<span class="notes">**Note:** Device name is the endpoint name you will need later on when [testing the application](https://github.com/ARMmbed/mbed-os-example-client#testing-the-application).</span>
 
-When you click the `SW2` button on your board you should see messages about the value changes:
+When you press the **SW2** button on your board you should see messages about the value changes:
 
 ```
 handle_button_click, new value of counter is 1
@@ -265,50 +306,30 @@
 ## Testing the application
 
 1. Flash the application.
-1. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port.
-1. On mbed Device Connector, go to [My devices > Connected devices](https://connector.mbed.com/#endpoints). Your device should be listed here.
-1. Press the `SW2` button on the device a number of times (make a note of how many times you did that).
-1. Go to [Device Connector > API Console](https://connector.mbed.com/#console).
-1. Enter `https://api.connector.mbed.com/endpoints/DEVICE_NAME/3200/0/5501` in the URI field and click **TEST API**. Replace `DEVICE_NAME` with your actual endpoint name. The device name can be found in the `security.h` file, see variable `MBED_ENDPOINT_NAME` or it can be found from the traces [Monitoring the application](https://github.com/ARMmbed/mbed-os-example-client#monitoring-the-application).
-1. The number of times you pressed `SW2` is shown.
-1. 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.
+2. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port.
+3. On mbed Device Connector, go to [My devices > Connected devices](https://connector.mbed.com/#endpoints). Your device should be listed here.
+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**. 
+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.
 
-<span class="notes">**Note:** On non K64F boards, there is no unregistration functionality and button press is simulated through timer ticks incrementing every 15 seconds.</span>
+<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>
 
 ![SW2 pressed five times, as shown by the API Console](clicks.png)
 
 <span class="tips">**Tip:** If you get an error, for example `Server Response: 410 (Gone)`, clear your browser's cache, log out, and log back in.</span>
 
-<span class="notes">**Note:** Only GET methods can be executed through [Device Connector > API Console](https://connector.mbed.com/#console). For other methods check the [mbed Device Connector Quick Start](https://github.com/ARMmbed/mbed-connector-api-node-quickstart).
+<span class="notes">**Note:** Only GET methods can be executed through [Device Connector > API Console](https://connector.mbed.com/#console). For other methods, check the [mbed Device Connector Quick Start](https://github.com/ARMmbed/mbed-connector-api-node-quickstart).
 
 ### Application resources
 
 The application exposes three [resources](https://docs.mbed.com/docs/mbed-device-connector-web-interfaces/en/latest/#the-mbed-device-connector-data-model):
 
-1. `3200/0/5501`. Number of presses of SW2 (GET).
-2. `3201/0/5850`. Blink function, blinks `LED1` when executed (POST).
+1. `3200/0/5501`. Number of presses of **SW2** (GET).
+2. `3201/0/5850`. Blink function, blinks **LED1** when executed (POST).
 3. `3201/0/5853`. Blink pattern, used by the blink function to determine how to blink. In the format of `1000:500:1000:500:1000:500` (PUT).
 
-For information on how to get notifications when resource 1 changes, or how to use resources 2 and 3, take a look at the [mbed Device Connector Quick Start](https://github.com/ARMmbed/mbed-connector-api-node-quickstart).
-
-## Important Note (Multi-platform support)
-
-mbed-OS provides the developer with total control of the device. However some defaults are always loaded if the user does not provide proper information regarding them. This becomes evident when a user switches among platforms. On some platforms a particular pin might be reserved for a particular functionality (depending upon the MCU) which thus cannot be used generally. A good example of such phenomenon is the use of atmel-rf-sheild with [Nucleo F401RE platform](https://developer.mbed.org/platforms/ST-Nucleo-F401RE/). 
-If user do not provide particular pin configuration for the atmel-rf-driver (sometimes a desired behaviour) the driver falls back to a default Arduino form factor, see [atmel-rf-driver pin assignment](https://github.com/ARMmbed/atmel-rf-driver/blob/master/source/driverAtmelRFInterface.h). This fallback mechanism works on most of the platforms, however in the above mentioned case, there is a catch. Fall back mechanism sets the GPIO pin D5 as a designated Reset pin for SPI (SPI_RST) in the radio driver. Whereas this particular pin is assigned by the MCU to debugging in Nucleo F401RE. This will result in hard fault ofcourse. The solution is to map the conflicting pins to a free GPIO pin. For example, the user can add *"atmel-rf.spi-rst": "D4"* to his/her mbed_app.json file. This will set the SPI_RST pin to D4 of the GPIO. 
-
-```json
-{
-    "target_overrides": {
-        "*": {
-            "target.features_add": ["IPV6", "COMMON_PAL"],
-            "atmel-rf.spi-rst": "D4"
-        }
-    }
-}
-```
-
-Desired work flow in such situations (if it may arise) should be:
-
-1.  Checking the platform pinmap from [mbed Platforms](https://developer.mbed.org/platforms/).
-2. Making sure that the desired GPIO pin is free by looking at the data sheet of the particular MCU. Most of the data sheets are available on  [mbed Platforms](https://developer.mbed.org/platforms/). 
-3. If necessary, change the pin or pins by using the mbed-OS config mechanism. You can get more informations about the configuration system in the [documentation](https://github.com/ARMmbed/mbed-os/blob/master/docs/config_system.md)
\ No newline at end of file
+To learn how to get notifications when resource 1 changes, or how to use resources 2 and 3, read the [mbed Device Connector Quick Start](https://github.com/ARMmbed/mbed-connector-api-node-quickstart).