Updated ref

Dependencies:   FXOS8700Q-driver MODSERIAL

Fork of AAT_LWM2M_K64F by Vinay Shrivastav

Committer:
Yogesh Pande
Date:
Mon Jul 25 16:32:20 2016 +0300
Revision:
0:7d5ec759888b
Child:
1:e06e899acba6
Update example home repo at https://github.com/ARMmbed/mbed-os-example-client

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Yogesh Pande 0:7d5ec759888b 1 # Getting started with mbed Client on mbed OS
Yogesh Pande 0:7d5ec759888b 2
Yogesh Pande 0:7d5ec759888b 3 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.
Yogesh Pande 0:7d5ec759888b 4
Yogesh Pande 0:7d5ec759888b 5 The application:
Yogesh Pande 0:7d5ec759888b 6
Yogesh Pande 0:7d5ec759888b 7 * Connects to network with WiFi, Ethernet, 6LoWPAN ND or Thread connection.
Yogesh Pande 0:7d5ec759888b 8 * Registers with mbed Device Connector.
Yogesh Pande 0:7d5ec759888b 9 * Gives mbed Device Connector access to its resources (read and write).
Yogesh Pande 0:7d5ec759888b 10 * Records the number of clicks on the device’s button and sends the number to mbed Device Connector.
Yogesh Pande 0:7d5ec759888b 11 * Lets you control the blink pattern of the LED on the device (through mbed Device Connector).
Yogesh Pande 0:7d5ec759888b 12
Yogesh Pande 0:7d5ec759888b 13 ## Required hardware
Yogesh Pande 0:7d5ec759888b 14
Yogesh Pande 0:7d5ec759888b 15 * [FRDM-K64F](http://developer.mbed.org/platforms/frdm-k64f/) board.
Yogesh Pande 0:7d5ec759888b 16 * 1-2 micro-USB cables.
Yogesh Pande 0:7d5ec759888b 17 * [mbed 6LoWPAN gateway router](https://firefly-iot.com/product/firefly-6lowpan-gateway-2-4ghz/) for 6LoWPAN ND and Thread.
Yogesh Pande 0:7d5ec759888b 18 * mbed 6LoWPAN shield (AT86RF212B/[AT86RF233](https://firefly-iot.com/product/firefly-arduino-shield-2-4ghz/)) for 6LoWPAN ND and Thread.
Yogesh Pande 0:7d5ec759888b 19 * Ethernet cable and connection to the internet.
Yogesh Pande 0:7d5ec759888b 20
Yogesh Pande 0:7d5ec759888b 21 ## Required software
Yogesh Pande 0:7d5ec759888b 22
Yogesh Pande 0:7d5ec759888b 23 * [ARM mbed account](https://developer.mbed.org/account/login/?next=/).
Yogesh Pande 0:7d5ec759888b 24 * [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).
Yogesh Pande 0:7d5ec759888b 25 * [Serial port monitor](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications).
Yogesh Pande 0:7d5ec759888b 26
Yogesh Pande 0:7d5ec759888b 27 ## Application setup
Yogesh Pande 0:7d5ec759888b 28
Yogesh Pande 0:7d5ec759888b 29 To configure the example application, please:
Yogesh Pande 0:7d5ec759888b 30
Yogesh Pande 0:7d5ec759888b 31 1. [Select the connection type](#connection-type).
Yogesh Pande 0:7d5ec759888b 32 1. [Set the client credentials](#client-credentials).
Yogesh Pande 0:7d5ec759888b 33 1. [Change 6LoWPAN ND & Thread settings](#6lowpan-nd-and-thread-settings).
Yogesh Pande 0:7d5ec759888b 34 1. [Change Ethernet settings](#ethernet-settings).
Yogesh Pande 0:7d5ec759888b 35 1. [Change Wi-Fi settings](#wi-fi-settings).
Yogesh Pande 0:7d5ec759888b 36 1. [Set up an IP address](#ip-address-setup). This step is optional.
Yogesh Pande 0:7d5ec759888b 37 1. [Change the socket type](#changing-socket-type). This step is optional.
Yogesh Pande 0:7d5ec759888b 38
Yogesh Pande 0:7d5ec759888b 39 ### Connection type
Yogesh Pande 0:7d5ec759888b 40
Yogesh Pande 0:7d5ec759888b 41 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:
Yogesh Pande 0:7d5ec759888b 42
Yogesh Pande 0:7d5ec759888b 43 ```json
Yogesh Pande 0:7d5ec759888b 44 "network-interface": {
Yogesh Pande 0:7d5ec759888b 45 "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
Yogesh Pande 0:7d5ec759888b 46 "value": "MESH_LOWPAN_ND"
Yogesh Pande 0:7d5ec759888b 47 }
Yogesh Pande 0:7d5ec759888b 48 ```
Yogesh Pande 0:7d5ec759888b 49
Yogesh Pande 0:7d5ec759888b 50 ### Client credentials
Yogesh Pande 0:7d5ec759888b 51
Yogesh Pande 0:7d5ec759888b 52 To register the application to the Connector service, you need to create and set the client side certificate.
Yogesh Pande 0:7d5ec759888b 53
Yogesh Pande 0:7d5ec759888b 54 1. Go to [mbed Device Connector](https://connector.mbed.com) and log in with your mbed account.
Yogesh Pande 0:7d5ec759888b 55 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.
Yogesh Pande 0:7d5ec759888b 56 1. Replace the contents in `security.h` of this project's directory with content copied above.
Yogesh Pande 0:7d5ec759888b 57
Yogesh Pande 0:7d5ec759888b 58 ### 6LoWPAN ND and Thread settings
Yogesh Pande 0:7d5ec759888b 59
Yogesh Pande 0:7d5ec759888b 60 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.
Yogesh Pande 0:7d5ec759888b 61
Yogesh Pande 0:7d5ec759888b 62 #### mbed gateway
Yogesh Pande 0:7d5ec759888b 63
Yogesh Pande 0:7d5ec759888b 64 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:
Yogesh Pande 0:7d5ec759888b 65
Yogesh Pande 0:7d5ec759888b 66 1. Use an Ethernet cable to connect the mbed 6LoWPAN gateway router to the internet.
Yogesh Pande 0:7d5ec759888b 67 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.
Yogesh Pande 0:7d5ec759888b 68 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:
Yogesh Pande 0:7d5ec759888b 69
Yogesh Pande 0:7d5ec759888b 70 * For the **6LoWPAN ND** bootstrap, use `gateway6LoWPANDynamic.bin`.
Yogesh Pande 0:7d5ec759888b 71 * For the **Thread** bootstrap, use `gatewayThreadDynamic.bin`.
Yogesh Pande 0:7d5ec759888b 72
Yogesh Pande 0:7d5ec759888b 73 The dynamic binaries use IPv6 autoconfiguration and enable the client to connect to the Connector service. The static binaries create a site-local IPv6 network and packets cannot be routed outside.
Yogesh Pande 0:7d5ec759888b 74
Yogesh Pande 0:7d5ec759888b 75 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.
Yogesh Pande 0:7d5ec759888b 76
Yogesh Pande 0:7d5ec759888b 77 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`.
Yogesh Pande 0:7d5ec759888b 78
Yogesh Pande 0:7d5ec759888b 79 #### Channel settings
Yogesh Pande 0:7d5ec759888b 80
Yogesh Pande 0:7d5ec759888b 81 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:
Yogesh Pande 0:7d5ec759888b 82
Yogesh Pande 0:7d5ec759888b 83 ```json
Yogesh Pande 0:7d5ec759888b 84 "target_overrides": {
Yogesh Pande 0:7d5ec759888b 85 "*": {
Yogesh Pande 0:7d5ec759888b 86 "mbed-mesh-api.6lowpan-nd-channel-page": 0,
Yogesh Pande 0:7d5ec759888b 87 "mbed-mesh-api.6lowpan-nd-channel": 12,
Yogesh Pande 0:7d5ec759888b 88 "mbed-mesh-api.thread-config-channel-page": 0,
Yogesh Pande 0:7d5ec759888b 89 "mbed-mesh-api.thread-config-channel": 12
Yogesh Pande 0:7d5ec759888b 90 }
Yogesh Pande 0:7d5ec759888b 91 }
Yogesh Pande 0:7d5ec759888b 92 ```
Yogesh Pande 0:7d5ec759888b 93
Yogesh Pande 0:7d5ec759888b 94 For sub-GHz shields (AT86RF212B) use the following overrides, **6LoWPAN ND only**:
Yogesh Pande 0:7d5ec759888b 95
Yogesh Pande 0:7d5ec759888b 96 ```json
Yogesh Pande 0:7d5ec759888b 97 "mbed-mesh-api.6lowpan-nd-channel-page": 2,
Yogesh Pande 0:7d5ec759888b 98 "mbed-mesh-api.6lowpan-nd-channel": 1
Yogesh Pande 0:7d5ec759888b 99 ```
Yogesh Pande 0:7d5ec759888b 100
Yogesh Pande 0:7d5ec759888b 101 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.
Yogesh Pande 0:7d5ec759888b 102
Yogesh Pande 0:7d5ec759888b 103 #### Thread-specific settings
Yogesh Pande 0:7d5ec759888b 104
Yogesh Pande 0:7d5ec759888b 105 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:
Yogesh Pande 0:7d5ec759888b 106
Yogesh Pande 0:7d5ec759888b 107 ```json
Yogesh Pande 0:7d5ec759888b 108 "mbed-mesh-api.thread-device-type": "MESH_DEVICE_TYPE_THREAD_SLEEPY_END_DEVICE"
Yogesh Pande 0:7d5ec759888b 109 ```
Yogesh Pande 0:7d5ec759888b 110
Yogesh Pande 0:7d5ec759888b 111 ### Ethernet settings
Yogesh Pande 0:7d5ec759888b 112
Yogesh Pande 0:7d5ec759888b 113 For running the example application using Ethernet, you need:
Yogesh Pande 0:7d5ec759888b 114
Yogesh Pande 0:7d5ec759888b 115 - An Ethernet cable.
Yogesh Pande 0:7d5ec759888b 116 - An Ethernet connection to the internet.
Yogesh Pande 0:7d5ec759888b 117
Yogesh Pande 0:7d5ec759888b 118 ### Wi-Fi settings
Yogesh Pande 0:7d5ec759888b 119
Yogesh Pande 0:7d5ec759888b 120 The example application uses ESP8266 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need:
Yogesh Pande 0:7d5ec759888b 121
Yogesh Pande 0:7d5ec759888b 122 1. An [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module
Yogesh Pande 0:7d5ec759888b 123 1. Updated [Espressif Firmware](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update)
Yogesh Pande 0:7d5ec759888b 124 1. Mount the WiFi module onto [K64F Grove Shield v2](https://developer.mbed.org/platforms/FRDM-K64F/#supported-seeed-studio-grove-extension)
Yogesh Pande 0:7d5ec759888b 125 1. Attach the shield on the K64F board.
Yogesh Pande 0:7d5ec759888b 126 1. In the `mbed_app.json` file, change
Yogesh Pande 0:7d5ec759888b 127 ```json
Yogesh Pande 0:7d5ec759888b 128 "network-interface": {
Yogesh Pande 0:7d5ec759888b 129 "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
Yogesh Pande 0:7d5ec759888b 130 "value": "WIFI"
Yogesh Pande 0:7d5ec759888b 131 }
Yogesh Pande 0:7d5ec759888b 132 ```
Yogesh Pande 0:7d5ec759888b 133
Yogesh Pande 0:7d5ec759888b 134 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.
Yogesh Pande 0:7d5ec759888b 135 ```json
Yogesh Pande 0:7d5ec759888b 136 "wifi-ssid": {
Yogesh Pande 0:7d5ec759888b 137 "help": "WiFi SSID",
Yogesh Pande 0:7d5ec759888b 138 "value": "\"SSID\""
Yogesh Pande 0:7d5ec759888b 139 },
Yogesh Pande 0:7d5ec759888b 140 "wifi-password": {
Yogesh Pande 0:7d5ec759888b 141 "help": "WiFi Password",
Yogesh Pande 0:7d5ec759888b 142 "value": "\"Password\""
Yogesh Pande 0:7d5ec759888b 143 }
Yogesh Pande 0:7d5ec759888b 144 ```
Yogesh Pande 0:7d5ec759888b 145
Yogesh Pande 0:7d5ec759888b 146 ### IP address setup
Yogesh Pande 0:7d5ec759888b 147
Yogesh Pande 0:7d5ec759888b 148 This example uses IPv4 to communicate with the [mbed Device Connector Server](https://api.connector.mbed.com) except for 6LoWPAN ND and Thread. The example program should automatically get an IPv4 address from the router when connected over Ethernet.
Yogesh Pande 0:7d5ec759888b 149
Yogesh Pande 0:7d5ec759888b 150 If your network does not have DHCP enabled, you have to manually assign a static IP address to the board. We recommend having DHCP enabled to make everything run smoothly.
Yogesh Pande 0:7d5ec759888b 151
Yogesh Pande 0:7d5ec759888b 152 ### Changing socket type
Yogesh Pande 0:7d5ec759888b 153
Yogesh Pande 0:7d5ec759888b 154 Your device can connect to mbed Device Connector via UDP or TCP binding mode. The default is UDP. The binding mode cannot be changed in 6LoWPAN ND or Thread mode.
Yogesh Pande 0:7d5ec759888b 155
Yogesh Pande 0:7d5ec759888b 156 To change the binding mode:
Yogesh Pande 0:7d5ec759888b 157
Yogesh Pande 0:7d5ec759888b 158 1. In the `simpleclient.h` file, find the parameter `SOCKET_MODE`. The default is `M2MInterface::UDP`.
Yogesh Pande 0:7d5ec759888b 159 1. To switch to TCP, change it to `M2MInterface::TCP`.
Yogesh Pande 0:7d5ec759888b 160 1. Rebuild and flash the application.
Yogesh Pande 0:7d5ec759888b 161
Yogesh Pande 0:7d5ec759888b 162 <span class="tips">**Tip:** The instructions in this document remain the same, irrespective of the socket mode you select.</span>
Yogesh Pande 0:7d5ec759888b 163
Yogesh Pande 0:7d5ec759888b 164 ## Building the example
Yogesh Pande 0:7d5ec759888b 165
Yogesh Pande 0:7d5ec759888b 166 To build the example application:
Yogesh Pande 0:7d5ec759888b 167
Yogesh Pande 0:7d5ec759888b 168 1. Clone [this](https://github.com/ARMmbed/mbed-os-example-client) repository.
Yogesh Pande 0:7d5ec759888b 169 1. Open a command line tool and navigate to the project’s directory.
Yogesh Pande 0:7d5ec759888b 170 1. Update mbed-os sources using the `mbed update` command.
Yogesh Pande 0:7d5ec759888b 171 1. [Configure](#application-setup) the client application.
Yogesh Pande 0:7d5ec759888b 172 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.
Yogesh Pande 0:7d5ec759888b 173 1. Plug the Ethernet cable into the board if you are using Ethernet mode.
Yogesh Pande 0:7d5ec759888b 174 1. If you are using 6LoWPAN ND or Thread mode, connect and power on the gateway first.
Yogesh Pande 0:7d5ec759888b 175 1. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device.
Yogesh Pande 0:7d5ec759888b 176 1. Drag the binary `.build/K64F/GCC_ARM/mbed-os-example-client.bin` to the board to flash the application.
Yogesh Pande 0:7d5ec759888b 177 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.
Yogesh Pande 0:7d5ec759888b 178 1. Press the **RESET** button on the board to run the program.
Yogesh Pande 0:7d5ec759888b 179 1. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter.
Yogesh Pande 0:7d5ec759888b 180
Yogesh Pande 0:7d5ec759888b 181
Yogesh Pande 0:7d5ec759888b 182 ## Monitoring the application
Yogesh Pande 0:7d5ec759888b 183
Yogesh Pande 0:7d5ec759888b 184 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.
Yogesh Pande 0:7d5ec759888b 185
Yogesh Pande 0:7d5ec759888b 186 <span class="notes">**Note:** Instructions to set this up are located [here](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications).</span>
Yogesh Pande 0:7d5ec759888b 187
Yogesh Pande 0:7d5ec759888b 188 After connecting, you should see messages about connecting to mbed Device Connector:
Yogesh Pande 0:7d5ec759888b 189
Yogesh Pande 0:7d5ec759888b 190 ```
Yogesh Pande 0:7d5ec759888b 191 In app_start()
Yogesh Pande 0:7d5ec759888b 192 IP address 10.2.15.222
Yogesh Pande 0:7d5ec759888b 193 Device name 6868df22-d353-4150-b90a-a878130859d9
Yogesh Pande 0:7d5ec759888b 194 ```
Yogesh Pande 0:7d5ec759888b 195
Yogesh Pande 0:7d5ec759888b 196 <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>
Yogesh Pande 0:7d5ec759888b 197
Yogesh Pande 0:7d5ec759888b 198 When you click the `SW2` button on your board you should see messages about the value changes:
Yogesh Pande 0:7d5ec759888b 199
Yogesh Pande 0:7d5ec759888b 200 ```
Yogesh Pande 0:7d5ec759888b 201 handle_button_click, new value of counter is 1
Yogesh Pande 0:7d5ec759888b 202 ```
Yogesh Pande 0:7d5ec759888b 203
Yogesh Pande 0:7d5ec759888b 204 ## Testing the application
Yogesh Pande 0:7d5ec759888b 205
Yogesh Pande 0:7d5ec759888b 206 1. Flash the application.
Yogesh Pande 0:7d5ec759888b 207 1. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port.
Yogesh Pande 0:7d5ec759888b 208 1. On mbed Device Connector, go to [My devices > Connected devices](https://connector.mbed.com/#endpoints). Your device should be listed here.
Yogesh Pande 0:7d5ec759888b 209 1. Press the `SW2` button on the device a number of times (make a note of how many times you did that).
Yogesh Pande 0:7d5ec759888b 210 1. Go to [Device Connector > API Console](https://connector.mbed.com/#console).
Yogesh Pande 0:7d5ec759888b 211 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).
Yogesh Pande 0:7d5ec759888b 212 1. The number of times you pressed `SW2` is shown.
Yogesh Pande 0:7d5ec759888b 213 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.
Yogesh Pande 0:7d5ec759888b 214
Yogesh Pande 0:7d5ec759888b 215
Yogesh Pande 0:7d5ec759888b 216 ![SW2 pressed five times, as shown by the API Console](clicks.png)
Yogesh Pande 0:7d5ec759888b 217
Yogesh Pande 0:7d5ec759888b 218 <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>
Yogesh Pande 0:7d5ec759888b 219
Yogesh Pande 0:7d5ec759888b 220 <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).
Yogesh Pande 0:7d5ec759888b 221
Yogesh Pande 0:7d5ec759888b 222 ### Application resources
Yogesh Pande 0:7d5ec759888b 223
Yogesh Pande 0:7d5ec759888b 224 The application exposes three [resources](https://docs.mbed.com/docs/mbed-device-connector-web-interfaces/en/latest/#the-mbed-device-connector-data-model):
Yogesh Pande 0:7d5ec759888b 225
Yogesh Pande 0:7d5ec759888b 226 1. `3200/0/5501`. Number of presses of SW2 (GET).
Yogesh Pande 0:7d5ec759888b 227 2. `3201/0/5850`. Blink function, blinks `LED1` when executed (POST).
Yogesh Pande 0:7d5ec759888b 228 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).
Yogesh Pande 0:7d5ec759888b 229
Yogesh Pande 0:7d5ec759888b 230 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).
Yogesh Pande 0:7d5ec759888b 231