Updated ref
Dependencies: FXOS8700Q-driver MODSERIAL
Fork of AAT_LWM2M_K64F by
README.md@7:9a1ee269650b, 2016-08-02 (annotated)
- Committer:
- mbed_official
- Date:
- Tue Aug 02 12:30:18 2016 +0100
- Revision:
- 7:9a1ee269650b
- Parent:
- 6:8fff223f3f84
- Child:
- 9:dcc4b552c03a
Merge pull request #63 from ARMmbed/null_entropy_update
Adding instructions for enabling NULL entropy
Commit copied from https://github.com/ARMmbed/mbed-os-example-client
Who changed what in which revision?
User | Revision | Line number | New 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 | 7:9a1ee269650b | 21 | ## Requirements for non K64F board |
mbed_official | 7:9a1ee269650b | 22 | This example application is primarily designed for FRDM-K64F board but you can also use other mbed OS supported boards to run this example application , with some minor modifications for setup. |
mbed_official | 7:9a1ee269650b | 23 | * To get the application registering successfully on non K64F boards , you need Edit the `mbed_app.json` file to add `NULL_ENTROPY` feature for mbedTLS: |
mbed_official | 7:9a1ee269650b | 24 | |
mbed_official | 7:9a1ee269650b | 25 | ``` |
mbed_official | 7:9a1ee269650b | 26 | ""macros": ["MBEDTLS_USER_CONFIG_FILE=\"mbedtls_mbed_client_config.h\"", |
mbed_official | 7:9a1ee269650b | 27 | "MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES", |
mbed_official | 7:9a1ee269650b | 28 | "MBEDTLS_TEST_NULL_ENTROPY"], |
mbed_official | 7:9a1ee269650b | 29 | ``` |
mbed_official | 7:9a1ee269650b | 30 | * On non K64F boards, there is no unregistration functionality and button press is simulated through timer ticks incrementing every 15 seconds. |
mbed_official | 7:9a1ee269650b | 31 | |
Yogesh Pande |
0:7d5ec759888b | 32 | ## Required software |
Yogesh Pande |
0:7d5ec759888b | 33 | |
Yogesh Pande |
0:7d5ec759888b | 34 | * [ARM mbed account](https://developer.mbed.org/account/login/?next=/). |
Yogesh Pande |
0:7d5ec759888b | 35 | * [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 | 36 | * [Serial port monitor](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications). |
Yogesh Pande |
0:7d5ec759888b | 37 | |
Yogesh Pande |
0:7d5ec759888b | 38 | ## Application setup |
Yogesh Pande |
0:7d5ec759888b | 39 | |
Yogesh Pande |
0:7d5ec759888b | 40 | To configure the example application, please: |
Yogesh Pande |
0:7d5ec759888b | 41 | |
Yogesh Pande |
0:7d5ec759888b | 42 | 1. [Select the connection type](#connection-type). |
Yogesh Pande |
0:7d5ec759888b | 43 | 1. [Set the client credentials](#client-credentials). |
Yogesh Pande |
0:7d5ec759888b | 44 | 1. [Change 6LoWPAN ND & Thread settings](#6lowpan-nd-and-thread-settings). |
Yogesh Pande |
0:7d5ec759888b | 45 | 1. [Change Ethernet settings](#ethernet-settings). |
Yogesh Pande |
0:7d5ec759888b | 46 | 1. [Change Wi-Fi settings](#wi-fi-settings). |
Yogesh Pande |
0:7d5ec759888b | 47 | 1. [Set up an IP address](#ip-address-setup). This step is optional. |
Yogesh Pande |
0:7d5ec759888b | 48 | 1. [Change the socket type](#changing-socket-type). This step is optional. |
Yogesh Pande |
0:7d5ec759888b | 49 | |
Yogesh Pande |
0:7d5ec759888b | 50 | ### Connection type |
Yogesh Pande |
0:7d5ec759888b | 51 | |
Yogesh Pande |
0:7d5ec759888b | 52 | 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 | 53 | |
Yogesh Pande |
0:7d5ec759888b | 54 | ```json |
Yogesh Pande |
0:7d5ec759888b | 55 | "network-interface": { |
Yogesh Pande |
0:7d5ec759888b | 56 | "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.", |
Yogesh Pande |
0:7d5ec759888b | 57 | "value": "MESH_LOWPAN_ND" |
Yogesh Pande |
0:7d5ec759888b | 58 | } |
Yogesh Pande |
0:7d5ec759888b | 59 | ``` |
Yogesh Pande |
0:7d5ec759888b | 60 | |
Yogesh Pande |
0:7d5ec759888b | 61 | ### Client credentials |
Yogesh Pande |
0:7d5ec759888b | 62 | |
Yogesh Pande |
0:7d5ec759888b | 63 | To register the application to the Connector service, you need to create and set the client side certificate. |
Yogesh Pande |
0:7d5ec759888b | 64 | |
Yogesh Pande |
0:7d5ec759888b | 65 | 1. Go to [mbed Device Connector](https://connector.mbed.com) and log in with your mbed account. |
Yogesh Pande |
0:7d5ec759888b | 66 | 1. On mbed Device Connector, go to [My Devices > Security credentials](https://connector.mbed.com/#credentials) and click the **Get my device security credentials** button to get new credentials for your device. |
Yogesh Pande |
0:7d5ec759888b | 67 | 1. Replace the contents in `security.h` of this project's directory with content copied above. |
Yogesh Pande |
0:7d5ec759888b | 68 | |
Yogesh Pande |
0:7d5ec759888b | 69 | ### 6LoWPAN ND and Thread settings |
Yogesh Pande |
0:7d5ec759888b | 70 | |
Yogesh Pande |
1:e06e899acba6 | 71 | First you need to select the RF driver to be used by 6LoWPAN/Thread stack. |
Yogesh Pande |
1:e06e899acba6 | 72 | |
Yogesh Pande |
1:e06e899acba6 | 73 | For example Atmel AT86RF233/212B driver is located in https://github.com/ARMmbed/atmel-rf-driver |
Yogesh Pande |
1:e06e899acba6 | 74 | |
Yogesh Pande |
1:e06e899acba6 | 75 | To add that driver to you application from command line, call: `mbed add https://github.com/ARMmbed/atmel-rf-driver` |
Yogesh Pande |
1:e06e899acba6 | 76 | |
Yogesh Pande |
1:e06e899acba6 | 77 | Then you need to enable the IPV6 functionality as the 6LoWPAN and Thread are part of IPv6 stack. Edit the `mbed_app.json` file to add `IPV6` feature: |
Yogesh Pande |
1:e06e899acba6 | 78 | |
Yogesh Pande |
1:e06e899acba6 | 79 | ``` |
Yogesh Pande |
1:e06e899acba6 | 80 | "target.features_add": ["CLIENT", "IPV6", "COMMON_PAL"], |
Yogesh Pande |
1:e06e899acba6 | 81 | ``` |
Yogesh Pande |
1:e06e899acba6 | 82 | |
Yogesh Pande |
0:7d5ec759888b | 83 | 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 | 84 | |
mbed_official | 6:8fff223f3f84 | 85 | **NOTE:** If you are using [k64f-border-router](https://github.com/ARMmbed/k64f-border-router) (which can be used only as a 6LoWPAN BR and only with FRDM-K64F), you need to enable another security feature. By default, k64f-border-router uses `PSK` as security. You can either enable security here on your mbed-os-example-client application, e.g., |
mbed_official | 6:8fff223f3f84 | 86 | |
mbed_official | 6:8fff223f3f84 | 87 | ```json |
mbed_official | 6:8fff223f3f84 | 88 | "target_overrides": { |
mbed_official | 6:8fff223f3f84 | 89 | "*": { |
mbed_official | 6:8fff223f3f84 | 90 | "mbed-mesh-api.6lowpan-nd-security-mode": "PSK", |
mbed_official | 6:8fff223f3f84 | 91 | } |
mbed_official | 6:8fff223f3f84 | 92 | } |
mbed_official | 6:8fff223f3f84 | 93 | ``` |
mbed_official | 6:8fff223f3f84 | 94 | or you can remove link layer security from k64f-border-router. For doing that, change the [mbed_app.json](https://github.com/ARMmbed/k64f-border-router/blob/master/mbed_app.json) fetched from k64f-border-router repository, e.g., |
mbed_official | 6:8fff223f3f84 | 95 | |
mbed_official | 6:8fff223f3f84 | 96 | ```json |
mbed_official | 6:8fff223f3f84 | 97 | "config": { |
mbed_official | 6:8fff223f3f84 | 98 | "security-mode": "NONE", |
mbed_official | 6:8fff223f3f84 | 99 | } |
mbed_official | 6:8fff223f3f84 | 100 | ``` |
Yogesh Pande |
0:7d5ec759888b | 101 | #### mbed gateway |
Yogesh Pande |
0:7d5ec759888b | 102 | |
Yogesh Pande |
0:7d5ec759888b | 103 | 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 | 104 | |
Yogesh Pande |
0:7d5ec759888b | 105 | 1. Use an Ethernet cable to connect the mbed 6LoWPAN gateway router to the internet. |
Yogesh Pande |
0:7d5ec759888b | 106 | 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 | 107 | 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 | 108 | |
Yogesh Pande |
0:7d5ec759888b | 109 | * For the **6LoWPAN ND** bootstrap, use `gateway6LoWPANDynamic.bin`. |
Yogesh Pande |
0:7d5ec759888b | 110 | * For the **Thread** bootstrap, use `gatewayThreadDynamic.bin`. |
Yogesh Pande |
0:7d5ec759888b | 111 | |
Yogesh Pande |
0:7d5ec759888b | 112 | 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 | 113 | |
Yogesh Pande |
0:7d5ec759888b | 114 | 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 | 115 | |
Yogesh Pande |
0:7d5ec759888b | 116 | 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 | 117 | |
Yogesh Pande |
0:7d5ec759888b | 118 | #### Channel settings |
Yogesh Pande |
0:7d5ec759888b | 119 | |
Yogesh Pande |
0:7d5ec759888b | 120 | 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 | 121 | |
Yogesh Pande |
0:7d5ec759888b | 122 | ```json |
Yogesh Pande |
0:7d5ec759888b | 123 | "target_overrides": { |
Yogesh Pande |
0:7d5ec759888b | 124 | "*": { |
Yogesh Pande |
0:7d5ec759888b | 125 | "mbed-mesh-api.6lowpan-nd-channel-page": 0, |
Yogesh Pande |
0:7d5ec759888b | 126 | "mbed-mesh-api.6lowpan-nd-channel": 12, |
Yogesh Pande |
0:7d5ec759888b | 127 | "mbed-mesh-api.thread-config-channel-page": 0, |
Yogesh Pande |
0:7d5ec759888b | 128 | "mbed-mesh-api.thread-config-channel": 12 |
Yogesh Pande |
0:7d5ec759888b | 129 | } |
Yogesh Pande |
0:7d5ec759888b | 130 | } |
Yogesh Pande |
0:7d5ec759888b | 131 | ``` |
Yogesh Pande |
0:7d5ec759888b | 132 | |
Yogesh Pande |
0:7d5ec759888b | 133 | For sub-GHz shields (AT86RF212B) use the following overrides, **6LoWPAN ND only**: |
Yogesh Pande |
0:7d5ec759888b | 134 | |
Yogesh Pande |
0:7d5ec759888b | 135 | ```json |
Yogesh Pande |
0:7d5ec759888b | 136 | "mbed-mesh-api.6lowpan-nd-channel-page": 2, |
Yogesh Pande |
0:7d5ec759888b | 137 | "mbed-mesh-api.6lowpan-nd-channel": 1 |
Yogesh Pande |
0:7d5ec759888b | 138 | ``` |
Yogesh Pande |
0:7d5ec759888b | 139 | |
Yogesh Pande |
0:7d5ec759888b | 140 | For more information about the radio shields, see [the related documentation](docs/radio_module_identify.md). All the configurable settings can be found in the `mbed-os-example-client/mbed-os/features/FEATURE_IPV6/mbed-mesh-api/mbed_lib.json` file. |
Yogesh Pande |
0:7d5ec759888b | 141 | |
Yogesh Pande |
0:7d5ec759888b | 142 | #### Thread-specific settings |
Yogesh Pande |
0:7d5ec759888b | 143 | |
Yogesh Pande |
0:7d5ec759888b | 144 | 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 | 145 | |
Yogesh Pande |
0:7d5ec759888b | 146 | ```json |
Yogesh Pande |
0:7d5ec759888b | 147 | "mbed-mesh-api.thread-device-type": "MESH_DEVICE_TYPE_THREAD_SLEEPY_END_DEVICE" |
Yogesh Pande |
0:7d5ec759888b | 148 | ``` |
Yogesh Pande |
0:7d5ec759888b | 149 | |
Yogesh Pande |
0:7d5ec759888b | 150 | ### Ethernet settings |
Yogesh Pande |
0:7d5ec759888b | 151 | |
Yogesh Pande |
0:7d5ec759888b | 152 | For running the example application using Ethernet, you need: |
Yogesh Pande |
0:7d5ec759888b | 153 | |
Yogesh Pande |
0:7d5ec759888b | 154 | - An Ethernet cable. |
Yogesh Pande |
0:7d5ec759888b | 155 | - An Ethernet connection to the internet. |
Yogesh Pande |
0:7d5ec759888b | 156 | |
Yogesh Pande |
0:7d5ec759888b | 157 | ### Wi-Fi settings |
Yogesh Pande |
0:7d5ec759888b | 158 | |
Yogesh Pande |
0:7d5ec759888b | 159 | The example application uses ESP8266 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need: |
Yogesh Pande |
0:7d5ec759888b | 160 | |
Yogesh Pande |
0:7d5ec759888b | 161 | 1. An [ESP8266](https://en.wikipedia.org/wiki/ESP8266) WiFi module |
Yogesh Pande |
0:7d5ec759888b | 162 | 1. Updated [Espressif Firmware](https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update) |
Yogesh Pande |
0:7d5ec759888b | 163 | 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 | 164 | 1. Attach the shield on the K64F board. |
Yogesh Pande |
0:7d5ec759888b | 165 | 1. In the `mbed_app.json` file, change |
Yogesh Pande |
0:7d5ec759888b | 166 | ```json |
Yogesh Pande |
0:7d5ec759888b | 167 | "network-interface": { |
Yogesh Pande |
0:7d5ec759888b | 168 | "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.", |
Yogesh Pande |
0:7d5ec759888b | 169 | "value": "WIFI" |
Yogesh Pande |
0:7d5ec759888b | 170 | } |
Yogesh Pande |
0:7d5ec759888b | 171 | ``` |
Yogesh Pande |
0:7d5ec759888b | 172 | |
Yogesh Pande |
0:7d5ec759888b | 173 | Provide your WiFi SSID and password here and leave `\"` in the beginning and end of your SSID and password (as shown in the example below). Otherwise, the example cannot pick up the SSID and password in correct format. |
Yogesh Pande |
0:7d5ec759888b | 174 | ```json |
Yogesh Pande |
0:7d5ec759888b | 175 | "wifi-ssid": { |
Yogesh Pande |
0:7d5ec759888b | 176 | "help": "WiFi SSID", |
Yogesh Pande |
0:7d5ec759888b | 177 | "value": "\"SSID\"" |
Yogesh Pande |
0:7d5ec759888b | 178 | }, |
Yogesh Pande |
0:7d5ec759888b | 179 | "wifi-password": { |
Yogesh Pande |
0:7d5ec759888b | 180 | "help": "WiFi Password", |
Yogesh Pande |
0:7d5ec759888b | 181 | "value": "\"Password\"" |
Yogesh Pande |
0:7d5ec759888b | 182 | } |
Yogesh Pande |
0:7d5ec759888b | 183 | ``` |
Yogesh Pande |
0:7d5ec759888b | 184 | |
Yogesh Pande |
0:7d5ec759888b | 185 | ### IP address setup |
Yogesh Pande |
0:7d5ec759888b | 186 | |
Yogesh Pande |
0:7d5ec759888b | 187 | This example uses IPv4 to communicate with the [mbed Device Connector Server](https://api.connector.mbed.com) except for 6LoWPAN ND and Thread. The example program should automatically get an IPv4 address from the router when connected over Ethernet. |
Yogesh Pande |
0:7d5ec759888b | 188 | |
Yogesh Pande |
0:7d5ec759888b | 189 | 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 | 190 | |
Yogesh Pande |
0:7d5ec759888b | 191 | ### Changing socket type |
Yogesh Pande |
0:7d5ec759888b | 192 | |
Yogesh Pande |
0:7d5ec759888b | 193 | Your device can connect to mbed Device Connector via UDP or TCP binding mode. The default is UDP. The binding mode cannot be changed in 6LoWPAN ND or Thread mode. |
Yogesh Pande |
0:7d5ec759888b | 194 | |
Yogesh Pande |
0:7d5ec759888b | 195 | To change the binding mode: |
Yogesh Pande |
0:7d5ec759888b | 196 | |
Yogesh Pande |
0:7d5ec759888b | 197 | 1. In the `simpleclient.h` file, find the parameter `SOCKET_MODE`. The default is `M2MInterface::UDP`. |
Yogesh Pande |
0:7d5ec759888b | 198 | 1. To switch to TCP, change it to `M2MInterface::TCP`. |
Yogesh Pande |
0:7d5ec759888b | 199 | 1. Rebuild and flash the application. |
Yogesh Pande |
0:7d5ec759888b | 200 | |
Yogesh Pande |
0:7d5ec759888b | 201 | <span class="tips">**Tip:** The instructions in this document remain the same, irrespective of the socket mode you select.</span> |
Yogesh Pande |
0:7d5ec759888b | 202 | |
Yogesh Pande |
0:7d5ec759888b | 203 | ## Building the example |
Yogesh Pande |
0:7d5ec759888b | 204 | |
Yogesh Pande |
0:7d5ec759888b | 205 | To build the example application: |
Yogesh Pande |
0:7d5ec759888b | 206 | |
Yogesh Pande |
0:7d5ec759888b | 207 | 1. Clone [this](https://github.com/ARMmbed/mbed-os-example-client) repository. |
Yogesh Pande |
0:7d5ec759888b | 208 | 1. Open a command line tool and navigate to the project’s directory. |
Yogesh Pande |
0:7d5ec759888b | 209 | 1. Update mbed-os sources using the `mbed update` command. |
Yogesh Pande |
0:7d5ec759888b | 210 | 1. [Configure](#application-setup) the client application. |
Yogesh Pande |
0:7d5ec759888b | 211 | 1. Build the application by selecting the hardware board and build the toolchain using the command `mbed compile -m K64F -t GCC_ARM -c -j0`. mbed-cli builds a binary file under the project’s `.build` directory. |
Yogesh Pande |
0:7d5ec759888b | 212 | 1. Plug the Ethernet cable into the board if you are using Ethernet mode. |
Yogesh Pande |
0:7d5ec759888b | 213 | 1. If you are using 6LoWPAN ND or Thread mode, connect and power on the gateway first. |
Yogesh Pande |
0:7d5ec759888b | 214 | 1. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device. |
Yogesh Pande |
0:7d5ec759888b | 215 | 1. Drag the binary `.build/K64F/GCC_ARM/mbed-os-example-client.bin` to the board to flash the application. |
Yogesh Pande |
0:7d5ec759888b | 216 | 1. The board is automatically programmed with the new binary. A flashing LED on it indicates that it is still working. When the LED stops blinking, the board is ready to work. |
Yogesh Pande |
0:7d5ec759888b | 217 | 1. Press the **RESET** button on the board to run the program. |
Yogesh Pande |
0:7d5ec759888b | 218 | 1. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter. |
Yogesh Pande |
0:7d5ec759888b | 219 | |
Yogesh Pande |
0:7d5ec759888b | 220 | |
Yogesh Pande |
0:7d5ec759888b | 221 | ## Monitoring the application |
Yogesh Pande |
0:7d5ec759888b | 222 | |
Yogesh Pande |
0:7d5ec759888b | 223 | 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 | 224 | |
Yogesh Pande |
0:7d5ec759888b | 225 | <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 | 226 | |
Yogesh Pande |
0:7d5ec759888b | 227 | After connecting, you should see messages about connecting to mbed Device Connector: |
Yogesh Pande |
0:7d5ec759888b | 228 | |
Yogesh Pande |
0:7d5ec759888b | 229 | ``` |
mbed_official | 5:b7d7ca715fdb | 230 | Starting mbed Client example... |
mbed_official | 5:b7d7ca715fdb | 231 | Using <Network Interface> |
mbed_official | 5:b7d7ca715fdb | 232 | |
mbed_official | 5:b7d7ca715fdb | 233 | Connected to Network successfully |
mbed_official | 5:b7d7ca715fdb | 234 | IP address xxx.xxx.xxx.xxx |
mbed_official | 5:b7d7ca715fdb | 235 | |
mbed_official | 5:b7d7ca715fdb | 236 | SOCKET_MODE : UDP |
mbed_official | 5:b7d7ca715fdb | 237 | Connecting to coap://api.connector.mbed.com:5684 |
mbed_official | 5:b7d7ca715fdb | 238 | |
Yogesh Pande |
0:7d5ec759888b | 239 | ``` |
Yogesh Pande |
0:7d5ec759888b | 240 | |
Yogesh Pande |
0:7d5ec759888b | 241 | <span class="notes">**Note:** Device name is the endpoint name you will need later on when [testing the application](https://github.com/ARMmbed/mbed-os-example-client#testing-the-application) chapter.</span> |
Yogesh Pande |
0:7d5ec759888b | 242 | |
Yogesh Pande |
0:7d5ec759888b | 243 | When you click the `SW2` button on your board you should see messages about the value changes: |
Yogesh Pande |
0:7d5ec759888b | 244 | |
Yogesh Pande |
0:7d5ec759888b | 245 | ``` |
Yogesh Pande |
0:7d5ec759888b | 246 | handle_button_click, new value of counter is 1 |
Yogesh Pande |
0:7d5ec759888b | 247 | ``` |
Yogesh Pande |
0:7d5ec759888b | 248 | |
Yogesh Pande |
0:7d5ec759888b | 249 | ## Testing the application |
Yogesh Pande |
0:7d5ec759888b | 250 | |
Yogesh Pande |
0:7d5ec759888b | 251 | 1. Flash the application. |
Yogesh Pande |
0:7d5ec759888b | 252 | 1. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port. |
Yogesh Pande |
0:7d5ec759888b | 253 | 1. On mbed Device Connector, go to [My devices > Connected devices](https://connector.mbed.com/#endpoints). Your device should be listed here. |
Yogesh Pande |
0:7d5ec759888b | 254 | 1. Press the `SW2` button on the device a number of times (make a note of how many times you did that). |
Yogesh Pande |
0:7d5ec759888b | 255 | 1. Go to [Device Connector > API Console](https://connector.mbed.com/#console). |
Yogesh Pande |
0:7d5ec759888b | 256 | 1. Enter `https://api.connector.mbed.com/endpoints/DEVICE_NAME/3200/0/5501` in the URI field and click **TEST API**. Replace `DEVICE_NAME` with your actual endpoint name. The device name can be found in the `security.h` file, see variable `MBED_ENDPOINT_NAME` or it can be found from the traces [Monitoring the application](https://github.com/ARMmbed/mbed-os-example-client#monitoring-the-application). |
Yogesh Pande |
0:7d5ec759888b | 257 | 1. The number of times you pressed `SW2` is shown. |
Yogesh Pande |
0:7d5ec759888b | 258 | 1. Press the `SW3` button to unregister from mbed Device Connector. You should see `Unregistered Object Successfully` printed to the serial port and the LED starts blinking. This will also stop your application. Press the `RESET` button to run the program again. |
Yogesh Pande |
0:7d5ec759888b | 259 | |
mbed_official | 5:b7d7ca715fdb | 260 | <span class="notes">**Note:** On non K64F boards, there is no unregistration functionality and button press is simulated through timer ticks incrementing every 15 seconds.</span> |
Yogesh Pande |
0:7d5ec759888b | 261 | |
Yogesh Pande |
0:7d5ec759888b | 262 | ![SW2 pressed five times, as shown by the API Console](clicks.png) |
Yogesh Pande |
0:7d5ec759888b | 263 | |
Yogesh Pande |
0:7d5ec759888b | 264 | <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 | 265 | |
Yogesh Pande |
0:7d5ec759888b | 266 | <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 | 267 | |
Yogesh Pande |
0:7d5ec759888b | 268 | ### Application resources |
Yogesh Pande |
0:7d5ec759888b | 269 | |
Yogesh Pande |
0:7d5ec759888b | 270 | 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 | 271 | |
Yogesh Pande |
0:7d5ec759888b | 272 | 1. `3200/0/5501`. Number of presses of SW2 (GET). |
Yogesh Pande |
0:7d5ec759888b | 273 | 2. `3201/0/5850`. Blink function, blinks `LED1` when executed (POST). |
Yogesh Pande |
0:7d5ec759888b | 274 | 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 | 275 | |
Yogesh Pande |
0:7d5ec759888b | 276 | For information on how to get notifications when resource 1 changes, or how to use resources 2 and 3, take a look at the [mbed Device Connector Quick Start](https://github.com/ARMmbed/mbed-connector-api-node-quickstart). |
Yogesh Pande |
0:7d5ec759888b | 277 |