Send the data of GR-PEACH_HVC-P2_sample to the cloud.

Dependencies:   AsciiFont GR-PEACH_video GraphicsFramework LCD_shield_config R_BSP USBHost_custom easy-connect-gr-peach

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

Note at the time of sample import

Please not check the "Update all libraries to the latest version" at the time of import.


When exporting and using it, increase the following stack size.


#define TCPIP_THREAD_STACKSIZE      1024
#define TCPIP_THREAD_STACKSIZE      2048


This is a sample to send the analysis result of GR-PEACH_HVC-P2_sample to the cloud using mbed-client. Please refer to following for operation of HVC-P2.

Import programGR-PEACH_HVC-P2_sample

Sample to operate omron HVC-P2 on GR-PEACH.

Required hardware

Application setup

Client credentials

To register the application to mbed Device Connector, you need to create and set the client side certificate.

  1. Go to and log in with your mbed account
  2. On mbed Device Connector, go to and click the Get my device security credentials button to get new credentials for your device.
  3. Replace the contents in security.h of this example with content copied above.

Ethernet settings

This sample uses Ethernet as the default connection type. To change the connection type, set WIFI_BP3595 in mbed_app.json:


    "help": "Options are ETHERNET, WIFI_ESP8266, WIFI_BP3595",
    "value": "ETHERNET"

To specify MAC address, add fllowing function to main.cpp. (When using Wifi, setting of MAC address is not necessary.)

Specify MAC address

// set mac address
void mbed_mac_address(char *mac) {
    mac[0] = 0x00;
    mac[1] = 0x02;
    mac[2] = 0xF7;
    mac[3] = 0xF0;
    mac[4] = 0x00;
    mac[5] = 0x00;

Wifi settings

This example can use BP3595 Wifi Interface for managing the wireless connectivity. To run this example using Wifi, you need:

  1. A BP3595 Wifi module ( )
  2. Mount BP3595 onto GR-PEACH
  3. Close GR-PEACH's JP21 (
  4. In the mbed_app.json file, change


    "help": "Options are ETHERNET, WIFI_ESP8266, WIFI_BP3595",
    "value": "WIFI_BP3595"

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:


"wifi-ssid": {
    "help": "WiFi SSID",
    "value": "\"SSID\""
"wifi-password": {
    "help": "WIFI Password",
    "value": "\"Password\""

Specify the security type for connection to be used. When the security type is WPA2, you need to specify NSAPI_SECURITY_WAP as follows:


    "value": "NSAPI_SECURITY_WEP"

By default, NSAPI_SECURITY_WPA_WPA2 is specified here.

Application resources

This example exposes four resources listed below:

  1. 3202/0/5700. Recognition result from HVC-P2 (GET).
  2. 3201/0/5850. Blink function, blinks LED 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).
  4. 3201/0/5855. Blink color, used by the blink function. Any of red, green, blue, cyan, yellow and magenta is acceptable (PUT).

For more info on how to get notifications when resource 1 changes, or how to use resource 2, 3 and 4, please look at

Import programGR-PEACH_mbed-connector-ZXingSample-node

Node.js based Web Application for mbed Device Connector specific to GR-PEACH_mbed-os-client-ZXingSample

# This is a Web Application for GR-PEACH_mbed-os-client-ZXingSample, but it can also be used for this sample.

Tue Mar 14 05:59:09 2017 +0000
Changed initial setting of mbed_app.json to ETHERNET.

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]( 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]( 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]( board.
Yogesh Pande 0:7d5ec759888b 16 * 1-2 micro-USB cables.
Yogesh Pande 0:7d5ec759888b 17 * [mbed 6LoWPAN gateway router]( for 6LoWPAN ND and Thread.
Yogesh Pande 0:7d5ec759888b 18 * mbed 6LoWPAN shield (AT86RF212B/[AT86RF233]( for 6LoWPAN ND and Thread.
Yogesh Pande 0:7d5ec759888b 19 * Ethernet cable and connection to the internet.
Yogesh Pande 0:7d5ec759888b 20
mbed_official 68:1a8e13b21e7e 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 71:ec259c9b02ea 25 * [NUCLEO_F429ZI]( + [X-NUCLEO-IDS01A4]( Spirit1 6LoWPAN expansion board (mesh `LOWPAN_ROUTER` mode)
mbed_official 22:e39e09d79a63 26 * NUCLEO_F429ZI + ATMEL AT233 15.4 shield (mesh `LOWPAN_ROUTER` mode)
mbed_official 22:e39e09d79a63 27 * K64F (Ethernet)
mbed_official 22:e39e09d79a63 28 * NUCLEO_F429ZI (Ethernet)
mbed_official 62:077cbce2bd10 29 * UBLOX_EVK_ODIN_W2 (WiFi & Ethernet - use the supplied `configs/eth_v4.json` for Ethernet)
mbed_official 68:1a8e13b21e7e 30 * K64F + GROVE SEEED shield (WiFi)
mbed_official 68:1a8e13b21e7e 31 * NUCLEO_F429ZI + GROVE SEEED shield (WiFi)
mbed_official 22:e39e09d79a63 32
mbed_official 69:64f9214729ae 33 Apart from this, this example can work on other mbed OS supported hardware boards which support any of the given network interface including Ethernet, WiFi, Mesh (6LoWPAN) or Thread, provided the configuration fulfills condition that the target hardware has TLS entropy implemented for it and the complete example configuration of mbed Client, selected network interface and mbed OS components fits into hardware's given memory size (Flash size and RAM size). See Mesh-minimal's [Notes on different hardware]( for known combinations of development boards and RF shields that have been tested with mesh networking stack.
mbed_official 22:e39e09d79a63 34
mbed_official 62:077cbce2bd10 35 To see how different targets are built please see the supplied ` script`.
mbed_official 62:077cbce2bd10 36
mbed_official 21:b88cdeb5b302 37 ## Requirements for non-K64F boards
mbed_official 21:b88cdeb5b302 38
mbed_official 21:b88cdeb5b302 39 * This example requires TLS functionality to be enabled on mbed TLS.
mbed_official 21:b88cdeb5b302 40 On devices where hardware entropy is not present, TLS is disabled by default.
mbed_official 21:b88cdeb5b302 41 This would result in compile time failures or linking failures.
mbed_official 7:9a1ee269650b 42
mbed_official 21:b88cdeb5b302 43 To learn why entropy is required, read the
mbed_official 21:b88cdeb5b302 44 [TLS Porting guide](
mbed_official 21:b88cdeb5b302 45
mbed_official 21:b88cdeb5b302 46 * On non-K64F boards, there is no unregistration functionality and
mbed_official 21:b88cdeb5b302 47 button presses are simulated through timer ticks incrementing every 15 seconds.
mbed_official 7:9a1ee269650b 48
Yogesh Pande 0:7d5ec759888b 49 ## Required software
Yogesh Pande 0:7d5ec759888b 50
Yogesh Pande 0:7d5ec759888b 51 * [ARM mbed account](
Yogesh Pande 0:7d5ec759888b 52 * [mbed-cli]( - to build the example programs. To learn how to build mbed OS applications with mbed-cli, see [the user guide](
Yogesh Pande 0:7d5ec759888b 53 * [Serial port monitor](
Yogesh Pande 0:7d5ec759888b 54
Yogesh Pande 0:7d5ec759888b 55 ## Application setup
Yogesh Pande 0:7d5ec759888b 56
mbed_official 21:b88cdeb5b302 57 To configure the example application:
Yogesh Pande 0:7d5ec759888b 58
Yogesh Pande 0:7d5ec759888b 59 1. [Select the connection type](#connection-type).
Yogesh Pande 0:7d5ec759888b 60 1. [Set the client credentials](#client-credentials).
Yogesh Pande 0:7d5ec759888b 61 1. [Change 6LoWPAN ND & Thread settings](#6lowpan-nd-and-thread-settings).
Yogesh Pande 0:7d5ec759888b 62 1. [Change Ethernet settings](#ethernet-settings).
mbed_official 68:1a8e13b21e7e 63 1. [Change WiFi settings](#wifi-settings).
Yogesh Pande 0:7d5ec759888b 64 1. [Set up an IP address](#ip-address-setup). This step is optional.
mbed_official 68:1a8e13b21e7e 65 1. [Change the socket type](#changing-the-socket-type). This step is optional.
Yogesh Pande 0:7d5ec759888b 66
Yogesh Pande 0:7d5ec759888b 67 ### Connection type
Yogesh Pande 0:7d5ec759888b 68
Yogesh Pande 0:7d5ec759888b 69 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 70
Yogesh Pande 0:7d5ec759888b 71 ```json
Yogesh Pande 0:7d5ec759888b 72 "network-interface": {
Yogesh Pande 0:7d5ec759888b 73 "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
Yogesh Pande 0:7d5ec759888b 74 "value": "MESH_LOWPAN_ND"
Yogesh Pande 0:7d5ec759888b 75 }
Yogesh Pande 0:7d5ec759888b 76 ```
Yogesh Pande 0:7d5ec759888b 77
Yogesh Pande 0:7d5ec759888b 78 ### Client credentials
Yogesh Pande 0:7d5ec759888b 79
mbed_official 21:b88cdeb5b302 80 To register the application with the Connector service, you need to create and set the client side certificate.
Yogesh Pande 0:7d5ec759888b 81
Yogesh Pande 0:7d5ec759888b 82 1. Go to [mbed Device Connector]( and log in with your mbed account.
mbed_official 21:b88cdeb5b302 83 1. On mbed Device Connector, go to [My Devices > Security credentials]( and click the **Get my device security credentials** to get new credentials for your device.
mbed_official 21:b88cdeb5b302 84 1. Replace the contents in the `security.h` file of this project's directory with the content copied above.
Yogesh Pande 0:7d5ec759888b 85
Yogesh Pande 0:7d5ec759888b 86 ### 6LoWPAN ND and Thread settings
Yogesh Pande 0:7d5ec759888b 87
mbed_official 71:ec259c9b02ea 88 First, you need to select the RF driver to be used by the 6LoWPAN/Thread stack. This example supports [AT86RF233/212B](, [NXP-MCR20a](, and [X-NUCLEO-IDS01A4]( (*a.k.a.* Spirit1) radio shields.
Yogesh Pande 1:e06e899acba6 89
mbed_official 71:ec259c9b02ea 90 To choose the radio shield 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 71:ec259c9b02ea 94 "help": "options are ATMEL, MCR20, SPIRIT1",
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 72:d0c254f237c4 113 <span class="notes">**Note:** In case you want to use the STM Spirit1 Sub-1 GHz RF expansion board (X-NUCLEO-IDS01A4), you need also to configure its MAC address in the `mbed_app.json` file, for example:</span>
mbed_official 72:d0c254f237c4 114
mbed_official 72:d0c254f237c4 115 ```json
mbed_official 72:d0c254f237c4 116 "target_overrides": {
mbed_official 72:d0c254f237c4 117 "*": {
mbed_official 72:d0c254f237c4 118 "spirit1.mac-address": "{0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7}"
mbed_official 72:d0c254f237c4 119 },
mbed_official 72:d0c254f237c4 120 }
mbed_official 72:d0c254f237c4 121 ```
mbed_official 72:d0c254f237c4 122
mbed_official 70:23c95e43feb9 123 #### Border router
mbed_official 21:b88cdeb5b302 124
mbed_official 70:23c95e43feb9 125 There are two options for border router.
mbed_official 70:23c95e43feb9 126
mbed_official 70:23c95e43feb9 127 ##### Nanostack-border-router
mbed_official 6:8fff223f3f84 128
mbed_official 72:d0c254f237c4 129 The [nanostack-border-router]( can be configured and built for the 6LoWPAN ND or Thread mode.
mbed_official 21:b88cdeb5b302 130
mbed_official 70:23c95e43feb9 131 ##### mbed gateway
mbed_official 6:8fff223f3f84 132
mbed_official 70:23c95e43feb9 133 The mbed gateway is a binary release only.
Yogesh Pande 0:7d5ec759888b 134
mbed_official 68:1a8e13b21e7e 135 To connect the example application in 6LoWPAN ND or Thread mode to mbed Device 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
mbed_official 68:1a8e13b21e7e 144 The dynamic binaries use IPv6 autoconfiguration and enable the client to connect to the mbed Device Connector service. The static binaries create a site-local IPv6 network and packets cannot be routed outside.
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]( 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
mbed_official 71:ec259c9b02ea 165 For sub-GHz shields ([Spirit1]( or 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/ 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
mbed_official 68:1a8e13b21e7e 189 ### WiFi 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]( WiFi module.
mbed_official 21:b88cdeb5b302 194 1. Updated [Espressif Firmware](
mbed_official 21:b88cdeb5b302 195 1. Mount the WiFi module onto [K64F Grove Shield v2](
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
Yogesh Pande 0:7d5ec759888b 234 ### IP address setup
Yogesh Pande 0:7d5ec759888b 235
mbed_official 68:1a8e13b21e7e 236 This example uses IPv4 to communicate with the [mbed Device Connector Server]( except for 6LoWPAN ND and Thread. However, you can easily change it to IPv6 by changing the `mbed_app.json` you make:
mbed_official 45:b150e0aa009c 237 ```
mbed_official 45:b150e0aa009c 238 "target_overrides": {
mbed_official 45:b150e0aa009c 239 "*": {
mbed_official 45:b150e0aa009c 240 "target.features_add": ["LWIP", "NANOSTACK", "COMMON_PAL"],
mbed_official 45:b150e0aa009c 241 "lwip.ipv4-enabled": false,
mbed_official 45:b150e0aa009c 242 "lwip.ipv6-enabled": true,
mbed_official 45:b150e0aa009c 243 "mbed-trace.enable": 0
mbed_official 45:b150e0aa009c 244 }
mbed_official 45:b150e0aa009c 245 ```
mbed_official 68:1a8e13b21e7e 246 by modifying the `ipv4-enabled` or `ipv6-enabled` to `true/false`. Only one should be true.
mbed_official 45:b150e0aa009c 247
mbed_official 45:b150e0aa009c 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
mbed_official 68:1a8e13b21e7e 252 ### Changing the socket type
Yogesh Pande 0:7d5ec759888b 253
mbed_official 68:1a8e13b21e7e 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
mbed_official 45:b150e0aa009c 258 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 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
mbed_official 45:b150e0aa009c 264 Possible socket types per connection:
mbed_official 45:b150e0aa009c 265
mbed_official 45:b150e0aa009c 266 | Network interface | UDP | TCP |
mbed_official 45:b150e0aa009c 267 | ------------------------------|:-----:|:-----:|
mbed_official 45:b150e0aa009c 268 | Ethernet (IPv4) | X | X |
mbed_official 45:b150e0aa009c 269 | Ethernet (IPv6) | X | |
mbed_official 45:b150e0aa009c 270 | Wifi (IPv4) | X | X |
mbed_official 45:b150e0aa009c 271 | Wifi (IPv6) - Not supported | | |
mbed_official 45:b150e0aa009c 272 | 6LoWPAN/Thread (IPv6) | X | |
mbed_official 45:b150e0aa009c 273
Yogesh Pande 0:7d5ec759888b 274 ## Building the example
Yogesh Pande 0:7d5ec759888b 275
mbed_official 21:b88cdeb5b302 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.
mbed_official 21:b88cdeb5b302 279
mbed_official 21:b88cdeb5b302 280 2. Import this example:
mbed_official 21:b88cdeb5b302 281
mbed_official 21:b88cdeb5b302 282 ```
mbed_official 21:b88cdeb5b302 283 mbed import mbed-os-example-client
mbed_official 21:b88cdeb5b302 284 ```
mbed_official 21:b88cdeb5b302 285
mbed_official 72:d0c254f237c4 286 3. To build the application, select the hardware board and build the toolchain using the command:
mbed_official 21:b88cdeb5b302 287
mbed_official 70:23c95e43feb9 288 Specify the config file in the build command, for example for 6LoWPAN
mbed_official 70:23c95e43feb9 289
mbed_official 72:d0c254f237c4 290 ```
mbed_official 70:23c95e43feb9 291 mbed compile -m K64F -t GCC_ARM -c --app-config configs/6lowpan_Atmel_RF.json
mbed_official 21:b88cdeb5b302 292 ```
mbed_official 21:b88cdeb5b302 293
mbed_official 21:b88cdeb5b302 294 mbed CLI builds a binary file under the project’s `BUILD/` directory.
Yogesh Pande 0:7d5ec759888b 295
mbed_official 72:d0c254f237c4 296 4. Plug the Ethernet cable into the board if you are using Ethernet mode.
mbed_official 21:b88cdeb5b302 297
mbed_official 72:d0c254f237c4 298 5. If you are using 6LoWPAN ND or Thread mode, connect and power on the gateway first.
mbed_official 21:b88cdeb5b302 299
mbed_official 72:d0c254f237c4 300 6. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device.
mbed_official 21:b88cdeb5b302 301
mbed_official 72:d0c254f237c4 302 7. Drag the binary `BUILD/K64F/GCC_ARM/mbed-os-example-client.bin` to the board to flash the application.
mbed_official 21:b88cdeb5b302 303
mbed_official 72:d0c254f237c4 304 8. 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 305
mbed_official 72:d0c254f237c4 306 9. Press the **Reset** button on the board to run the program.
mbed_official 21:b88cdeb5b302 307
mbed_official 72:d0c254f237c4 308 10. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter.
mbed_official 21:b88cdeb5b302 309
mbed_official 21:b88cdeb5b302 310 **To build the example using the Online IDE:**
mbed_official 21:b88cdeb5b302 311
mbed_official 21:b88cdeb5b302 312 Import this repository in the Online IDE and continue from step 3 onwards.
Yogesh Pande 0:7d5ec759888b 313
mbed_official 68:1a8e13b21e7e 314 ### Compilation problems
mbed_official 68:1a8e13b21e7e 315
mbed_official 68:1a8e13b21e7e 316 If you encounter a problem like this when compiling the application:
mbed_official 68:1a8e13b21e7e 317
mbed_official 68:1a8e13b21e7e 318 ```
mbed_official 68:1a8e13b21e7e 319 Building project mbed-os-example-client (K64F, GCC_ARM)
mbed_official 68:1a8e13b21e7e 320 Scan: .
mbed_official 68:1a8e13b21e7e 321 Scan: FEATURE_LWIP
mbed_official 68:1a8e13b21e7e 322 Scan: FEATURE_UVISOR
mbed_official 68:1a8e13b21e7e 323 Scan: FEATURE_COMMON_PAL
mbed_official 68:1a8e13b21e7e 324 Scan: FEATURE_BLE
mbed_official 68:1a8e13b21e7e 325 Scan: FEATURE_STORAGE
mbed_official 68:1a8e13b21e7e 326 Scan: FEATURE_THREAD_BORDER_ROUTER
mbed_official 68:1a8e13b21e7e 327 Scan: FEATURE_THREAD_ROUTER
mbed_official 68:1a8e13b21e7e 328 Scan: FEATURE_LOWPAN_BORDER_ROUTER
mbed_official 68:1a8e13b21e7e 329 Scan: FEATURE_LOWPAN_ROUTER
mbed_official 68:1a8e13b21e7e 330 Scan: FEATURE_LOWPAN_HOST
mbed_official 68:1a8e13b21e7e 331 Scan: FEATURE_NANOSTACK_FULL
mbed_official 68:1a8e13b21e7e 332 Scan: FEATURE_NANOSTACK
mbed_official 68:1a8e13b21e7e 333 Scan: FEATURE_THREAD_END_DEVICE
mbed_official 68:1a8e13b21e7e 334 Scan: mbed
mbed_official 68:1a8e13b21e7e 335 Scan: env
mbed_official 68:1a8e13b21e7e 336 Compile [ 0.3%]: NanostackRfPhyAtmel.cpp
mbed_official 68:1a8e13b21e7e 337 [ERROR] ./atmel-rf-driver/source/NanostackRfPhyAtmel.cpp:18:44: fatal error: nanostack/platform/arm_hal_phy.h: No such file or directory
mbed_official 68:1a8e13b21e7e 338 compilation terminated.
mbed_official 68:1a8e13b21e7e 339 ```
mbed_official 68:1a8e13b21e7e 340
mbed_official 68:1a8e13b21e7e 341 You are probably using the LWIP stack with Ethernet or WiFi and you have the mesh RF stacks in the root of this example. You need to tell mbed NOT to compile the related files. To do that, set up a `.mbedignore` file. An example file is available in the `configs` folder.
mbed_official 68:1a8e13b21e7e 342
mbed_official 68:1a8e13b21e7e 343 This should resolve the issue:
mbed_official 68:1a8e13b21e7e 344
mbed_official 68:1a8e13b21e7e 345 ```
mbed_official 68:1a8e13b21e7e 346 cp configs/eth-wifi-mbedignore ./.mbedignore
mbed_official 68:1a8e13b21e7e 347 ```
mbed_official 68:1a8e13b21e7e 348
Yogesh Pande 0:7d5ec759888b 349 ## Monitoring the application
Yogesh Pande 0:7d5ec759888b 350
Yogesh Pande 0:7d5ec759888b 351 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 352
Yogesh Pande 0:7d5ec759888b 353 <span class="notes">**Note:** Instructions to set this up are located [here](</span>
Yogesh Pande 0:7d5ec759888b 354
Yogesh Pande 0:7d5ec759888b 355 After connecting, you should see messages about connecting to mbed Device Connector:
Yogesh Pande 0:7d5ec759888b 356
Yogesh Pande 0:7d5ec759888b 357 ```
mbed_official 63:c73f78fd7982 358 Starting mbed Client example in IPv4 mode
mbed_official 63:c73f78fd7982 359 [EasyConnect] Using Ethernet
mbed_official 63:c73f78fd7982 360 [EasyConnect] Connected to Network successfully
mbed_official 63:c73f78fd7982 361 [EasyConnect] IP address
mbed_official 63:c73f78fd7982 362 [EasyConnect] MAC address 5c:cf:7f:86:de:bf
mbed_official 5:b7d7ca715fdb 363
mbed_official 63:c73f78fd7982 364 SOCKET_MODE : TCP
mbed_official 5:b7d7ca715fdb 365
mbed_official 5:b7d7ca715fdb 366 Connecting to coap://
mbed_official 5:b7d7ca715fdb 367
mbed_official 63:c73f78fd7982 368 Registered object succesfully!
Yogesh Pande 0:7d5ec759888b 369 ```
Yogesh Pande 0:7d5ec759888b 370
mbed_official 21:b88cdeb5b302 371 <span class="notes">**Note:** Device name is the endpoint name you will need later on when [testing the application](</span>
Yogesh Pande 0:7d5ec759888b 372
mbed_official 21:b88cdeb5b302 373 When you press the **SW2** button on your board you should see messages about the value changes:
Yogesh Pande 0:7d5ec759888b 374
Yogesh Pande 0:7d5ec759888b 375 ```
Yogesh Pande 0:7d5ec759888b 376 handle_button_click, new value of counter is 1
Yogesh Pande 0:7d5ec759888b 377 ```
Yogesh Pande 0:7d5ec759888b 378
Yogesh Pande 0:7d5ec759888b 379 ## Testing the application
Yogesh Pande 0:7d5ec759888b 380
Yogesh Pande 0:7d5ec759888b 381 1. Flash the application.
mbed_official 21:b88cdeb5b302 382 2. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port.
mbed_official 21:b88cdeb5b302 383 3. On mbed Device Connector, go to [My devices > Connected devices]( Your device should be listed here.
mbed_official 21:b88cdeb5b302 384 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 385 5. Go to [Device Connector > API Console](
mbed_official 21:b88cdeb5b302 386 6. Click the **Endpoint directory lookups** drop down menu.
mbed_official 21:b88cdeb5b302 387 ![](/docs/img/ep_lookup.PNG)
mbed_official 21:b88cdeb5b302 388 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 389 8. The number of times you pressed **SW2** is shown.
mbed_official 21:b88cdeb5b302 390 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 391
mbed_official 21:b88cdeb5b302 392 <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 393
Yogesh Pande 0:7d5ec759888b 394 ![SW2 pressed five times, as shown by the API Console](clicks.png)
Yogesh Pande 0:7d5ec759888b 395
Yogesh Pande 0:7d5ec759888b 396 <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 397
mbed_official 21:b88cdeb5b302 398 <span class="notes">**Note:** Only GET methods can be executed through [Device Connector > API Console]( For other methods, check the [mbed Device Connector Quick Start](
Yogesh Pande 0:7d5ec759888b 399
Yogesh Pande 0:7d5ec759888b 400 ### Application resources
Yogesh Pande 0:7d5ec759888b 401
Yogesh Pande 0:7d5ec759888b 402 The application exposes three [resources](
Yogesh Pande 0:7d5ec759888b 403
mbed_official 21:b88cdeb5b302 404 1. `3200/0/5501`. Number of presses of **SW2** (GET).
mbed_official 21:b88cdeb5b302 405 2. `3201/0/5850`. Blink function, blinks **LED1** when executed (POST).
Yogesh Pande 0:7d5ec759888b 406 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 407
mbed_official 21:b88cdeb5b302 408 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](
mbed_official 52:957eff5f0ee9 409
mbed_official 69:64f9214729ae 410 ## Known issues
mbed_official 69:64f9214729ae 411
mbed_official 69:64f9214729ae 412 ### mbed OS 5.4
mbed_official 69:64f9214729ae 413
mbed_official 69:64f9214729ae 414 * [UBLOX_EVK_ODIN_W2]: This example is not compiling with IAR. See [#194](