Andrea Corrado / Mbed OS mbed-os-demo-client-WiFi-notPUBLISHED

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-os-demo-client-ethernet by mbed techcon demos

README.md@27:bfc98bf1eaae, 2017-01-25 (annotated)

Committer:
andcor02
Date:
Wed Jan 25 12:33:54 2017 +0000
Revision:
27:bfc98bf1eaae
Parent:
13:c44e318674db 
UPDATED TO MBED O.S 5.3

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