Suraj Pal / Mbed 2 deprecated U_Blox_DeviceConnector

U_Blox device connector

Dependencies:   mbed

Fork of mbed-os-example-client by mbed-os-examples

README.md@63:81c0432cb506, 2017-02-02 (annotated)

Committer:
surajdagar
Date:
Thu Feb 02 19:46:23 2017 +0000
Revision:
63:81c0432cb506
Parent:
62:077cbce2bd10 
u-Blox test for device connector

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
mbed_official 22:e39e09d79a63 21 ## Supported Target hardware configurations
mbed_official 22:e39e09d79a63 22
mbed_official 22:e39e09d79a63 23 This example has been tested in following configuration
mbed_official 22:e39e09d79a63 24 * K64F + NXP MCR20 15.4 shield (mesh `NANOSTACK_FULL` mode)
mbed_official 22:e39e09d79a63 25 * NUCLEO_F429ZI + ATMEL AT233 15.4 shield (mesh `LOWPAN_ROUTER` mode)
mbed_official 22:e39e09d79a63 26 * K64F (Ethernet)
mbed_official 22:e39e09d79a63 27 * NUCLEO_F429ZI (Ethernet)
mbed_official 62:077cbce2bd10 28 * UBLOX_EVK_ODIN_W2 (WiFi & Ethernet - use the supplied `configs/eth_v4.json` for Ethernet)
mbed_official 22:e39e09d79a63 29 * K64F + GROVE SEEED shield (Wifi)
mbed_official 22:e39e09d79a63 30 * NUCLEO_F429ZI + GROVE SEEED shield (Wifi)
mbed_official 22:e39e09d79a63 31
mbed_official 22:e39e09d79a63 32 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).
mbed_official 22:e39e09d79a63 33
mbed_official 62:077cbce2bd10 34 To see how different targets are built please see the supplied `build_all.sh script`.
mbed_official 62:077cbce2bd10 35
mbed_official 21:b88cdeb5b302 36 ## Requirements for non-K64F boards
mbed_official 21:b88cdeb5b302 37
mbed_official 21:b88cdeb5b302 38 * This example requires TLS functionality to be enabled on mbed TLS.
mbed_official 21:b88cdeb5b302 39 On devices where hardware entropy is not present, TLS is disabled by default.
mbed_official 21:b88cdeb5b302 40 This would result in compile time failures or linking failures.
mbed_official 7:9a1ee269650b 41
mbed_official 21:b88cdeb5b302 42 To learn why entropy is required, read the
mbed_official 21:b88cdeb5b302 43 [TLS Porting guide](https://docs.mbed.com/docs/mbed-os-handbook/en/5.2/advanced/tls_porting/).
mbed_official 21:b88cdeb5b302 44
mbed_official 21:b88cdeb5b302 45 * On non-K64F boards, there is no unregistration functionality and
mbed_official 21:b88cdeb5b302 46 button presses are simulated through timer ticks incrementing every 15 seconds.
mbed_official 7:9a1ee269650b 47
Yogesh Pande 0:7d5ec759888b 48 ## Required software
Yogesh Pande 0:7d5ec759888b 49
Yogesh Pande 0:7d5ec759888b 50 * [ARM mbed account](https://developer.mbed.org/account/login/?next=/).
Yogesh Pande 0:7d5ec759888b 51 * [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 52 * [Serial port monitor](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications).
Yogesh Pande 0:7d5ec759888b 53
Yogesh Pande 0:7d5ec759888b 54 ## Application setup
Yogesh Pande 0:7d5ec759888b 55
mbed_official 21:b88cdeb5b302 56 To configure the example application:
Yogesh Pande 0:7d5ec759888b 57
Yogesh Pande 0:7d5ec759888b 58 1. [Select the connection type](#connection-type).
Yogesh Pande 0:7d5ec759888b 59 1. [Set the client credentials](#client-credentials).
Yogesh Pande 0:7d5ec759888b 60 1. [Change 6LoWPAN ND & Thread settings](#6lowpan-nd-and-thread-settings).
Yogesh Pande 0:7d5ec759888b 61 1. [Change Ethernet settings](#ethernet-settings).
Yogesh Pande 0:7d5ec759888b 62 1. [Change Wi-Fi settings](#wi-fi-settings).
Yogesh Pande 0:7d5ec759888b 63 1. [Set up an IP address](#ip-address-setup). This step is optional.
Yogesh Pande 0:7d5ec759888b 64 1. [Change the socket type](#changing-socket-type). This step is optional.
Yogesh Pande 0:7d5ec759888b 65
Yogesh Pande 0:7d5ec759888b 66 ### Connection type
Yogesh Pande 0:7d5ec759888b 67
Yogesh Pande 0:7d5ec759888b 68 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 69
Yogesh Pande 0:7d5ec759888b 70 ```json
Yogesh Pande 0:7d5ec759888b 71 "network-interface": {
Yogesh Pande 0:7d5ec759888b 72 "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
Yogesh Pande 0:7d5ec759888b 73 "value": "MESH_LOWPAN_ND"
Yogesh Pande 0:7d5ec759888b 74 }
Yogesh Pande 0:7d5ec759888b 75 ```
Yogesh Pande 0:7d5ec759888b 76
Yogesh Pande 0:7d5ec759888b 77 ### Client credentials
Yogesh Pande 0:7d5ec759888b 78
mbed_official 21:b88cdeb5b302 79 To register the application with the Connector service, you need to create and set the client side certificate.
Yogesh Pande 0:7d5ec759888b 80
Yogesh Pande 0:7d5ec759888b 81 1. Go to [mbed Device Connector](https://connector.mbed.com) and log in with your mbed account.
mbed_official 21:b88cdeb5b302 82 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.
mbed_official 21:b88cdeb5b302 83 1. Replace the contents in the `security.h` file of this project's directory with the content copied above.
Yogesh Pande 0:7d5ec759888b 84
Yogesh Pande 0:7d5ec759888b 85 ### 6LoWPAN ND and Thread settings
Yogesh Pande 0:7d5ec759888b 86
mbed_official 21:b88cdeb5b302 87 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.
Yogesh Pande 1:e06e899acba6 88
mbed_official 21:b88cdeb5b302 89 To add the Atmel driver to you application from command line, call: `mbed add https://github.com/ARMmbed/atmel-rf-driver`.
mbed_official 21:b88cdeb5b302 90 Please make sure that the `mbed_app.json` file points to the correct radio driver type:
Yogesh Pande 1:e06e899acba6 91
mbed_official 21:b88cdeb5b302 92 ```json
mbed_official 21:b88cdeb5b302 93 "mesh_radio_type": {
mbed_official 21:b88cdeb5b302 94 "help": "options are ATMEL, MCR20",
mbed_official 21:b88cdeb5b302 95 "value": "ATMEL"
mbed_official 21:b88cdeb5b302 96 },
mbed_official 21:b88cdeb5b302 97 ```
Yogesh Pande 1:e06e899acba6 98
mbed_official 21:b88cdeb5b302 99 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:
Yogesh Pande 1:e06e899acba6 100
Yogesh Pande 1:e06e899acba6 101 ```
mbed_official 21:b88cdeb5b302 102 "target.features_add": ["NANOSTACK", "LOWPAN_ROUTER", "COMMON_PAL"],
mbed_official 21:b88cdeb5b302 103 ```
mbed_official 21:b88cdeb5b302 104
mbed_official 21:b88cdeb5b302 105 If your connection type is `MESH_THREAD` then you may want to use the THREAD_ROUTER configuration:
mbed_official 21:b88cdeb5b302 106
mbed_official 21:b88cdeb5b302 107 ```
mbed_official 21:b88cdeb5b302 108 "target.features_add": ["NANOSTACK", "THREAD_ROUTER", "COMMON_PAL"],
Yogesh Pande 1:e06e899acba6 109 ```
Yogesh Pande 1:e06e899acba6 110
Yogesh Pande 0:7d5ec759888b 111 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 112
mbed_official 21:b88cdeb5b302 113 <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>
mbed_official 21:b88cdeb5b302 114
mbed_official 21:b88cdeb5b302 115 You can enable the security here on your mbed-os-example-client application, for example:
mbed_official 6:8fff223f3f84 116
mbed_official 6:8fff223f3f84 117 ```json
mbed_official 6:8fff223f3f84 118 "target_overrides": {
mbed_official 6:8fff223f3f84 119 "*": {
mbed_official 6:8fff223f3f84 120 "mbed-mesh-api.6lowpan-nd-security-mode": "PSK",
mbed_official 6:8fff223f3f84 121 }
mbed_official 6:8fff223f3f84 122 }
mbed_official 6:8fff223f3f84 123 ```
mbed_official 21:b88cdeb5b302 124
mbed_official 21:b88cdeb5b302 125 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:
mbed_official 6:8fff223f3f84 126
mbed_official 6:8fff223f3f84 127 ```json
mbed_official 6:8fff223f3f84 128 "config": {
mbed_official 6:8fff223f3f84 129 "security-mode": "NONE",
mbed_official 6:8fff223f3f84 130 }
mbed_official 6:8fff223f3f84 131 ```
mbed_official 21:b88cdeb5b302 132
Yogesh Pande 0:7d5ec759888b 133 #### mbed gateway
Yogesh Pande 0:7d5ec759888b 134
Yogesh Pande 0:7d5ec759888b 135 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 136
Yogesh Pande 0:7d5ec759888b 137 1. Use an Ethernet cable to connect the mbed 6LoWPAN gateway router to the internet.
Yogesh Pande 0:7d5ec759888b 138 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 139 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 140
Yogesh Pande 0:7d5ec759888b 141 * For the **6LoWPAN ND** bootstrap, use `gateway6LoWPANDynamic.bin`.
Yogesh Pande 0:7d5ec759888b 142 * For the **Thread** bootstrap, use `gatewayThreadDynamic.bin`.
Yogesh Pande 0:7d5ec759888b 143
Yogesh Pande 0:7d5ec759888b 144 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 145
Yogesh Pande 0:7d5ec759888b 146 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 147
Yogesh Pande 0:7d5ec759888b 148 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 149
Yogesh Pande 0:7d5ec759888b 150 #### Channel settings
Yogesh Pande 0:7d5ec759888b 151
Yogesh Pande 0:7d5ec759888b 152 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 153
Yogesh Pande 0:7d5ec759888b 154 ```json
Yogesh Pande 0:7d5ec759888b 155 "target_overrides": {
Yogesh Pande 0:7d5ec759888b 156 "*": {
Yogesh Pande 0:7d5ec759888b 157 "mbed-mesh-api.6lowpan-nd-channel-page": 0,
Yogesh Pande 0:7d5ec759888b 158 "mbed-mesh-api.6lowpan-nd-channel": 12,
Yogesh Pande 0:7d5ec759888b 159 "mbed-mesh-api.thread-config-channel-page": 0,
Yogesh Pande 0:7d5ec759888b 160 "mbed-mesh-api.thread-config-channel": 12
Yogesh Pande 0:7d5ec759888b 161 }
Yogesh Pande 0:7d5ec759888b 162 }
Yogesh Pande 0:7d5ec759888b 163 ```
Yogesh Pande 0:7d5ec759888b 164
Yogesh Pande 0:7d5ec759888b 165 For sub-GHz shields (AT86RF212B) use the following overrides, **6LoWPAN ND only**:
Yogesh Pande 0:7d5ec759888b 166
Yogesh Pande 0:7d5ec759888b 167 ```json
Yogesh Pande 0:7d5ec759888b 168 "mbed-mesh-api.6lowpan-nd-channel-page": 2,
Yogesh Pande 0:7d5ec759888b 169 "mbed-mesh-api.6lowpan-nd-channel": 1
Yogesh Pande 0:7d5ec759888b 170 ```
Yogesh Pande 0:7d5ec759888b 171
mbed_official 21:b88cdeb5b302 172 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.
Yogesh Pande 0:7d5ec759888b 173
Yogesh Pande 0:7d5ec759888b 174 #### Thread-specific settings
Yogesh Pande 0:7d5ec759888b 175
Yogesh Pande 0:7d5ec759888b 176 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 177
Yogesh Pande 0:7d5ec759888b 178 ```json
Yogesh Pande 0:7d5ec759888b 179 "mbed-mesh-api.thread-device-type": "MESH_DEVICE_TYPE_THREAD_SLEEPY_END_DEVICE"
Yogesh Pande 0:7d5ec759888b 180 ```
Yogesh Pande 0:7d5ec759888b 181
Yogesh Pande 0:7d5ec759888b 182 ### Ethernet settings
Yogesh Pande 0:7d5ec759888b 183
Yogesh Pande 0:7d5ec759888b 184 For running the example application using Ethernet, you need:
Yogesh Pande 0:7d5ec759888b 185
Yogesh Pande 0:7d5ec759888b 186 - An Ethernet cable.
Yogesh Pande 0:7d5ec759888b 187 - An Ethernet connection to the internet.
Yogesh Pande 0:7d5ec759888b 188
Yogesh Pande 0:7d5ec759888b 189 ### Wi-Fi settings
Yogesh Pande 0:7d5ec759888b 190
Yogesh Pande 0:7d5ec759888b 191 The example application uses ESP8266 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need:
Yogesh Pande 0:7d5ec759888b 192
mbed_official 21:b88cdeb5b302 193 1. An [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module.
mbed_official 21:b88cdeb5b302 194 1. Updated [Espressif Firmware](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update).
mbed_official 21:b88cdeb5b302 195 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 196 1. Attach the shield on the K64F board.
Yogesh Pande 0:7d5ec759888b 197 1. In the `mbed_app.json` file, change
mbed_official 21:b88cdeb5b302 198
Yogesh Pande 0:7d5ec759888b 199 ```json
Yogesh Pande 0:7d5ec759888b 200 "network-interface": {
Yogesh Pande 0:7d5ec759888b 201 "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
Yogesh Pande 0:7d5ec759888b 202 "value": "WIFI"
Yogesh Pande 0:7d5ec759888b 203 }
Yogesh Pande 0:7d5ec759888b 204 ```
Yogesh Pande 0:7d5ec759888b 205
Yogesh Pande 0:7d5ec759888b 206 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.
mbed_official 21:b88cdeb5b302 207
Yogesh Pande 0:7d5ec759888b 208 ```json
Yogesh Pande 0:7d5ec759888b 209 "wifi-ssid": {
Yogesh Pande 0:7d5ec759888b 210 "help": "WiFi SSID",
Yogesh Pande 0:7d5ec759888b 211 "value": "\"SSID\""
Yogesh Pande 0:7d5ec759888b 212 },
Yogesh Pande 0:7d5ec759888b 213 "wifi-password": {
Yogesh Pande 0:7d5ec759888b 214 "help": "WiFi Password",
Yogesh Pande 0:7d5ec759888b 215 "value": "\"Password\""
Yogesh Pande 0:7d5ec759888b 216 }
Yogesh Pande 0:7d5ec759888b 217 ```
Yogesh Pande 0:7d5ec759888b 218
mbed_official 21:b88cdeb5b302 219 <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>
mbed_official 13:c44e318674db 220
mbed_official 21:b88cdeb5b302 221 For example, NUCLEO_F401RE requires a different serial connection:
mbed_official 13:c44e318674db 222
mbed_official 13:c44e318674db 223 ```json
mbed_official 13:c44e318674db 224 "wifi-tx": {
mbed_official 13:c44e318674db 225 "help": "TX pin for serial connection to external device",
mbed_official 13:c44e318674db 226 "value": "PA_11"
mbed_official 13:c44e318674db 227 },
mbed_official 13:c44e318674db 228 "wifi-rx": {
mbed_official 13:c44e318674db 229 "help": "RX pin for serial connection to external device",
mbed_official 13:c44e318674db 230 "value": "PA_12"
mbed_official 13:c44e318674db 231 }
mbed_official 13:c44e318674db 232 ```
mbed_official 13:c44e318674db 233
mbed_official 13:c44e318674db 234
Yogesh Pande 0:7d5ec759888b 235 ### IP address setup
Yogesh Pande 0:7d5ec759888b 236
mbed_official 45:b150e0aa009c 237 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
mbed_official 45:b150e0aa009c 238 by changing the mbed_app.json you make:
mbed_official 45:b150e0aa009c 239 ```
mbed_official 45:b150e0aa009c 240 "target_overrides": {
mbed_official 45:b150e0aa009c 241 "*": {
mbed_official 45:b150e0aa009c 242 "target.features_add": ["LWIP", "NANOSTACK", "COMMON_PAL"],
mbed_official 45:b150e0aa009c 243 "lwip.ipv4-enabled": false,
mbed_official 45:b150e0aa009c 244 "lwip.ipv6-enabled": true,
mbed_official 45:b150e0aa009c 245 "mbed-trace.enable": 0
mbed_official 45:b150e0aa009c 246 }
mbed_official 45:b150e0aa009c 247 ```
mbed_official 45:b150e0aa009c 248 by modifying the ipv4-enable or ipv6-enable to true/false. Only one should be true.
mbed_official 45:b150e0aa009c 249
mbed_official 45:b150e0aa009c 250 The example program should automatically get an IP address from the router when connected over Ethernet or WiFi.
Yogesh Pande 0:7d5ec759888b 251
Yogesh Pande 0:7d5ec759888b 252 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 253
Yogesh Pande 0:7d5ec759888b 254 ### Changing socket type
Yogesh Pande 0:7d5ec759888b 255
mbed_official 45:b150e0aa009c 256 Your device can connect to mbed Device Connector via UDP or TCP binding mode. The default and only allowed value is UDP for Thread and 6LowPan. TCP is the default for other connections. The binding mode cannot be changed in 6LoWPAN ND or Thread mode.
Yogesh Pande 0:7d5ec759888b 257
Yogesh Pande 0:7d5ec759888b 258 To change the binding mode:
Yogesh Pande 0:7d5ec759888b 259
mbed_official 45:b150e0aa009c 260 1. In the `simpleclient.h` file, find the parameter `SOCKET_MODE`. The default is `M2MInterface::UDP` for mesh and `M2MInterface::TCP` for others.
mbed_official 37:9a9428fc4b26 261 1. To switch to UDP, change it to `M2MInterface::UDP`.
Yogesh Pande 0:7d5ec759888b 262 1. Rebuild and flash the application.
Yogesh Pande 0:7d5ec759888b 263
Yogesh Pande 0:7d5ec759888b 264 <span class="tips">**Tip:** The instructions in this document remain the same, irrespective of the socket mode you select.</span>
Yogesh Pande 0:7d5ec759888b 265
mbed_official 45:b150e0aa009c 266 Possible socket types per connection:
mbed_official 45:b150e0aa009c 267
mbed_official 45:b150e0aa009c 268 | Network interface | UDP | TCP |
mbed_official 45:b150e0aa009c 269 | ------------------------------|:-----:|:-----:|
mbed_official 45:b150e0aa009c 270 | Ethernet (IPv4) | X | X |
mbed_official 45:b150e0aa009c 271 | Ethernet (IPv6) | X | |
mbed_official 45:b150e0aa009c 272 | Wifi (IPv4) | X | X |
mbed_official 45:b150e0aa009c 273 | Wifi (IPv6) - Not supported | | |
mbed_official 45:b150e0aa009c 274 | 6LoWPAN/Thread (IPv6) | X | |
mbed_official 45:b150e0aa009c 275
Yogesh Pande 0:7d5ec759888b 276 ## Building the example
Yogesh Pande 0:7d5ec759888b 277
mbed_official 21:b88cdeb5b302 278 To build the example using mbed CLI:
Yogesh Pande 0:7d5ec759888b 279
Yogesh Pande 0:7d5ec759888b 280 1. Open a command line tool and navigate to the project’s directory.
mbed_official 21:b88cdeb5b302 281
mbed_official 21:b88cdeb5b302 282 2. Import this example:
mbed_official 21:b88cdeb5b302 283
mbed_official 21:b88cdeb5b302 284 ```
mbed_official 21:b88cdeb5b302 285 mbed import mbed-os-example-client
mbed_official 21:b88cdeb5b302 286 ```
mbed_official 21:b88cdeb5b302 287
mbed_official 45:b150e0aa009c 288 3. Copy the relevant example configuration file from configs/xxx.json to mbed_app.json and
mbed_official 45:b150e0aa009c 289 [Configure](#application-setup) the client application.
mbed_official 21:b88cdeb5b302 290
mbed_official 21:b88cdeb5b302 291 4. To build the application, select the hardware board and build the toolchain using the command:
mbed_official 21:b88cdeb5b302 292
mbed_official 21:b88cdeb5b302 293 ```
mbed_official 21:b88cdeb5b302 294 mbed compile -m K64F -t GCC_ARM -c
mbed_official 21:b88cdeb5b302 295 ```
mbed_official 21:b88cdeb5b302 296
mbed_official 21:b88cdeb5b302 297 mbed CLI builds a binary file under the project’s `BUILD/` directory.
Yogesh Pande 0:7d5ec759888b 298
mbed_official 21:b88cdeb5b302 299 5. Plug the Ethernet cable into the board if you are using Ethernet mode.
mbed_official 21:b88cdeb5b302 300
mbed_official 21:b88cdeb5b302 301 6. If you are using 6LoWPAN ND or Thread mode, connect and power on the gateway first.
mbed_official 21:b88cdeb5b302 302
mbed_official 21:b88cdeb5b302 303 7. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device.
mbed_official 21:b88cdeb5b302 304
mbed_official 21:b88cdeb5b302 305 8. Drag the binary `BUILD/K64F/GCC_ARM/mbed-os-example-client.bin` to the board to flash the application.
mbed_official 21:b88cdeb5b302 306
mbed_official 21:b88cdeb5b302 307 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.
mbed_official 21:b88cdeb5b302 308
mbed_official 21:b88cdeb5b302 309 10. Press the **Reset** button on the board to run the program.
mbed_official 21:b88cdeb5b302 310
mbed_official 21:b88cdeb5b302 311 11. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter.
mbed_official 21:b88cdeb5b302 312
mbed_official 21:b88cdeb5b302 313 **To build the example using the Online IDE:**
mbed_official 21:b88cdeb5b302 314
mbed_official 21:b88cdeb5b302 315 Import this repository in the Online IDE and continue from step 3 onwards.
Yogesh Pande 0:7d5ec759888b 316
Yogesh Pande 0:7d5ec759888b 317 ## Monitoring the application
Yogesh Pande 0:7d5ec759888b 318
Yogesh Pande 0:7d5ec759888b 319 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 320
Yogesh Pande 0:7d5ec759888b 321 <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 322
Yogesh Pande 0:7d5ec759888b 323 After connecting, you should see messages about connecting to mbed Device Connector:
Yogesh Pande 0:7d5ec759888b 324
Yogesh Pande 0:7d5ec759888b 325 ```
mbed_official 5:b7d7ca715fdb 326 Starting mbed Client example...
mbed_official 5:b7d7ca715fdb 327 Using <Network Interface>
mbed_official 5:b7d7ca715fdb 328
mbed_official 5:b7d7ca715fdb 329 Connected to Network successfully
mbed_official 5:b7d7ca715fdb 330 IP address xxx.xxx.xxx.xxx
mbed_official 5:b7d7ca715fdb 331
mbed_official 5:b7d7ca715fdb 332 SOCKET_MODE : UDP
mbed_official 5:b7d7ca715fdb 333 Connecting to coap://api.connector.mbed.com:5684
mbed_official 5:b7d7ca715fdb 334
Yogesh Pande 0:7d5ec759888b 335 ```
Yogesh Pande 0:7d5ec759888b 336
mbed_official 21:b88cdeb5b302 337 <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>
Yogesh Pande 0:7d5ec759888b 338
mbed_official 21:b88cdeb5b302 339 When you press the **SW2** button on your board you should see messages about the value changes:
Yogesh Pande 0:7d5ec759888b 340
Yogesh Pande 0:7d5ec759888b 341 ```
Yogesh Pande 0:7d5ec759888b 342 handle_button_click, new value of counter is 1
Yogesh Pande 0:7d5ec759888b 343 ```
Yogesh Pande 0:7d5ec759888b 344
Yogesh Pande 0:7d5ec759888b 345 ## Testing the application
Yogesh Pande 0:7d5ec759888b 346
Yogesh Pande 0:7d5ec759888b 347 1. Flash the application.
mbed_official 21:b88cdeb5b302 348 2. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port.
mbed_official 21:b88cdeb5b302 349 3. On mbed Device Connector, go to [My devices > Connected devices](https://connector.mbed.com/#endpoints). Your device should be listed here.
mbed_official 21:b88cdeb5b302 350 4. Press the **SW2** button on the device a number of times (make a note of how many times you did that).
mbed_official 21:b88cdeb5b302 351 5. Go to [Device Connector > API Console](https://connector.mbed.com/#console).
mbed_official 21:b88cdeb5b302 352 6. Click the **Endpoint directory lookups** drop down menu.
mbed_official 21:b88cdeb5b302 353 ![](/docs/img/ep_lookup.PNG)
mbed_official 21:b88cdeb5b302 354 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**.
mbed_official 21:b88cdeb5b302 355 8. The number of times you pressed **SW2** is shown.
mbed_official 21:b88cdeb5b302 356 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.
Yogesh Pande 0:7d5ec759888b 357
mbed_official 21:b88cdeb5b302 358 <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>
Yogesh Pande 0:7d5ec759888b 359
Yogesh Pande 0:7d5ec759888b 360 ![SW2 pressed five times, as shown by the API Console](clicks.png)
Yogesh Pande 0:7d5ec759888b 361
Yogesh Pande 0:7d5ec759888b 362 <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 363
mbed_official 21:b88cdeb5b302 364 <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 365
Yogesh Pande 0:7d5ec759888b 366 ### Application resources
Yogesh Pande 0:7d5ec759888b 367
Yogesh Pande 0:7d5ec759888b 368 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 369
mbed_official 21:b88cdeb5b302 370 1. `3200/0/5501`. Number of presses of **SW2** (GET).
mbed_official 21:b88cdeb5b302 371 2. `3201/0/5850`. Blink function, blinks **LED1** when executed (POST).
Yogesh Pande 0:7d5ec759888b 372 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 373
mbed_official 21:b88cdeb5b302 374 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).
mbed_official 52:957eff5f0ee9 375
mbed_official 52:957eff5f0ee9 376 #### Compilation problems?
mbed_official 52:957eff5f0ee9 377
mbed_official 53:2e40e7d6aed6 378 If you encounter a problem like this when compiling the application:
mbed_official 52:957eff5f0ee9 379
mbed_official 52:957eff5f0ee9 380 ```
mbed_official 52:957eff5f0ee9 381 Building project mbed-os-example-client (K64F, GCC_ARM)
mbed_official 52:957eff5f0ee9 382 Scan: .
mbed_official 52:957eff5f0ee9 383 Scan: FEATURE_LWIP
mbed_official 52:957eff5f0ee9 384 Scan: FEATURE_UVISOR
mbed_official 52:957eff5f0ee9 385 Scan: FEATURE_COMMON_PAL
mbed_official 52:957eff5f0ee9 386 Scan: FEATURE_BLE
mbed_official 52:957eff5f0ee9 387 Scan: FEATURE_STORAGE
mbed_official 52:957eff5f0ee9 388 Scan: FEATURE_THREAD_BORDER_ROUTER
mbed_official 52:957eff5f0ee9 389 Scan: FEATURE_THREAD_ROUTER
mbed_official 52:957eff5f0ee9 390 Scan: FEATURE_LOWPAN_BORDER_ROUTER
mbed_official 52:957eff5f0ee9 391 Scan: FEATURE_LOWPAN_ROUTER
mbed_official 52:957eff5f0ee9 392 Scan: FEATURE_LOWPAN_HOST
mbed_official 52:957eff5f0ee9 393 Scan: FEATURE_NANOSTACK_FULL
mbed_official 52:957eff5f0ee9 394 Scan: FEATURE_NANOSTACK
mbed_official 52:957eff5f0ee9 395 Scan: FEATURE_THREAD_END_DEVICE
mbed_official 52:957eff5f0ee9 396 Scan: mbed
mbed_official 52:957eff5f0ee9 397 Scan: env
mbed_official 52:957eff5f0ee9 398 Compile [ 0.3%]: NanostackRfPhyAtmel.cpp
mbed_official 52:957eff5f0ee9 399 [ERROR] ./atmel-rf-driver/source/NanostackRfPhyAtmel.cpp:18:44: fatal error: nanostack/platform/arm_hal_phy.h: No such file or directory
mbed_official 52:957eff5f0ee9 400 compilation terminated.
mbed_official 52:957eff5f0ee9 401 ```
mbed_official 53:2e40e7d6aed6 402
mbed_official 53:2e40e7d6aed6 403 You probably have the LWIP stack in use 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.
mbed_official 53:2e40e7d6aed6 404
mbed_official 53:2e40e7d6aed6 405 This should resolve the issue:
mbed_official 53:2e40e7d6aed6 406
mbed_official 52:957eff5f0ee9 407 ```
mbed_official 52:957eff5f0ee9 408 cp configs/eth-wifi-mbedignore ./.mbedignore
mbed_official 52:957eff5f0ee9 409 ```
mbed_official 52:957eff5f0ee9 410