Tomo Yamanaka / Mbed OS GR-LYCHEE_mbed-os-client-ZXingSample

Mbed Client sample for GR-LYCHEE where ZXing is incorporated.

Dependencies:   DisplayApp AsciiFont

Fork of GR-PEACH_mbed-os-client-ZXingSample by Renesas

Overview

This sample program shows how to use mbed Client together with ZXing which is an open-source, multi-format 1D/2D barcode image processing library. For more info on ZXing, please refer to https://github.com/zxing/zxing.

Required hardware

Application setup

  1. Select the connection type. For details, please refer to the following wiki:
    https://os.mbed.com/users/1050186/code/GR-LYCHEE_mbed-os-client-ZXingSample/wiki/Connection-type.
  2. Set the client credentials. For details, please refer to the following wiki:
    https://os.mbed.com/users/1050186/code/GR-LYCHEE_mbed-os-client-ZXingSample/wiki/Client-credentials.
  3. Change Wifi settings. For details, please refer to the following wiki:
    https://os.mbed.com/users/1050186/code/GR-LYCHEE_mbed-os-client-ZXingSample/wiki/Wifi-settings.

Building the example

To build this example:

  1. Import this example onto mbed Compiler.
  2. Configure the example in accordance with Application setup.
  3. Compile the example on mbed Compiler and download the resultant binary file.
  4. Plug the micro-USB cable into the OpenSDA port which lies on the next to the RESET button.
  5. Copy the binary previously downloaded to your PC to GR-LYCHEE to flash this example. When the copy is successfully completed, the board is ready to work.
  6. Press the RESET button on the board to run the example.
  7. For verification, please refer to the following wiki:
    https://os.mbed.com/users/1050186/code/GR-LYCHEE_mbed-os-client-ZXingSample/wiki/Monitoring-the-application.

Application resources

This example exposes four resources listed below:

  1. 3202/0/5700. Decode result of barcode data input from camera (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 green, yellow, orange and red is acceptable (PUT).

README.md@2:6ec5c1c1d41c, 2017-03-28 (annotated)

Committer:
dkato
Date:
Tue Mar 28 11:02:34 2017 +0000
Revision:
2:6ec5c1c1d41c
Parent:
0:eb73febb2bba
Child:
17:548cfbfba6d8
Memory-saving version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 0:eb73febb2bba 1 # Getting started with mbed Client on mbed OS
<> 0:eb73febb2bba 2
<> 0:eb73febb2bba 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.
<> 0:eb73febb2bba 4
<> 0:eb73febb2bba 5 The application:
<> 0:eb73febb2bba 6
<> 0:eb73febb2bba 7 * Connects to network with WiFi or Ethernet.
<> 0:eb73febb2bba 8 * Registers with mbed Device Connector.
<> 0:eb73febb2bba 9 * Gives mbed Device Connector access to its resources (read and write).
<> 0:eb73febb2bba 10 * Records the number of clicks on the device’s button and sends the number to mbed Device Connector.
<> 0:eb73febb2bba 11 * Lets you control the blink pattern of the LED on the device (through mbed Device Connector).
<> 0:eb73febb2bba 12
<> 0:eb73febb2bba 13 ## Required hardware
<> 0:eb73febb2bba 14
<> 0:eb73febb2bba 15 * [Renesas GR-PEACH](https://developer.mbed.org/platforms/Renesas-GR-PEACH/).
<> 0:eb73febb2bba 16 * 1-2 micro-USB cables.
<> 0:eb73febb2bba 17 * Ethernet cable and connection to the internet.
<> 0:eb73febb2bba 18
<> 0:eb73febb2bba 19 ## Requirements for Renesas GR-PEACH
<> 0:eb73febb2bba 20 * 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:
<> 0:eb73febb2bba 21
<> 0:eb73febb2bba 22 ```
dkato 2:6ec5c1c1d41c 23 "RZ_A1H": {
dkato 2:6ec5c1c1d41c 24 "target.macros_add": ["MBEDTLS_TEST_NULL_ENTROPY", "MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES"]
dkato 2:6ec5c1c1d41c 25 },
<> 0:eb73febb2bba 26 ```
<> 0:eb73febb2bba 27
<> 0:eb73febb2bba 28 ## Required software
<> 0:eb73febb2bba 29
<> 0:eb73febb2bba 30 * [ARM mbed account](https://developer.mbed.org/account/login/?next=/).
<> 0:eb73febb2bba 31 * [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).
<> 0:eb73febb2bba 32 * [Serial port monitor](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications).
<> 0:eb73febb2bba 33
<> 0:eb73febb2bba 34 ## Application setup
<> 0:eb73febb2bba 35
<> 0:eb73febb2bba 36 To configure the example application, please:
<> 0:eb73febb2bba 37
<> 0:eb73febb2bba 38 1. [Select the connection type](#connection-type).
<> 0:eb73febb2bba 39 1. [Set the client credentials](#client-credentials).
<> 0:eb73febb2bba 40 1. [Change Ethernet settings](#ethernet-settings).
<> 0:eb73febb2bba 41 1. [Change Wi-Fi settings](#wi-fi-settings).
<> 0:eb73febb2bba 42 1. [Set up an IP address](#ip-address-setup). This step is optional.
<> 0:eb73febb2bba 43 1. [Change the socket type](#changing-socket-type). This step is optional.
<> 0:eb73febb2bba 44
<> 0:eb73febb2bba 45 ### Connection type
<> 0:eb73febb2bba 46
dkato 2:6ec5c1c1d41c 47 The application uses "NO_CONNECT" as the default connection type. To change the connection type, set one of them in `mbed_app.json`. For example, to enable Ethernet mode:
<> 0:eb73febb2bba 48
<> 0:eb73febb2bba 49 ```json
dkato 2:6ec5c1c1d41c 50 "network-interface":{
dkato 2:6ec5c1c1d41c 51 "help": "Options are ETHERNET, WIFI_ESP8266, WIFI_BP3595, NO_CONNECT",
dkato 2:6ec5c1c1d41c 52 "value": "ETHERNET"
dkato 2:6ec5c1c1d41c 53 },
<> 0:eb73febb2bba 54 ```
<> 0:eb73febb2bba 55
<> 0:eb73febb2bba 56 ### Client credentials
<> 0:eb73febb2bba 57
<> 0:eb73febb2bba 58 To register the application to the Connector service, you need to create and set the client side certificate.
<> 0:eb73febb2bba 59
<> 0:eb73febb2bba 60 1. Go to [mbed Device Connector](https://connector.mbed.com) and log in with your mbed account.
<> 0:eb73febb2bba 61 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.
<> 0:eb73febb2bba 62 1. Replace the contents in `security.h` of this project's directory with content copied above.
<> 0:eb73febb2bba 63
<> 0:eb73febb2bba 64 ### Ethernet settings
<> 0:eb73febb2bba 65
<> 0:eb73febb2bba 66 For running the example application using Ethernet, you need:
<> 0:eb73febb2bba 67
<> 0:eb73febb2bba 68 - An Ethernet cable.
<> 0:eb73febb2bba 69 - An Ethernet connection to the internet.
dkato 2:6ec5c1c1d41c 70 - MAC address setting. To set MAC address, add fllowing function to main.cpp. (When using Wifi, setting of MAC address is not necessary.)
dkato 2:6ec5c1c1d41c 71 ```
dkato 2:6ec5c1c1d41c 72 // set mac address
dkato 2:6ec5c1c1d41c 73 void mbed_mac_address(char *mac) {
dkato 2:6ec5c1c1d41c 74 mac[0] = 0x00;
dkato 2:6ec5c1c1d41c 75 mac[1] = 0x02;
dkato 2:6ec5c1c1d41c 76 mac[2] = 0xF7;
dkato 2:6ec5c1c1d41c 77 mac[3] = 0xF0;
dkato 2:6ec5c1c1d41c 78 mac[4] = 0x00;
dkato 2:6ec5c1c1d41c 79 mac[5] = 0x00;
dkato 2:6ec5c1c1d41c 80 }
dkato 2:6ec5c1c1d41c 81 ```
<> 0:eb73febb2bba 82
<> 0:eb73febb2bba 83 ### Wi-Fi settings (BP3595)
<> 0:eb73febb2bba 84
<> 0:eb73febb2bba 85 The example application uses BP3595 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need:
<> 0:eb73febb2bba 86
<> 0:eb73febb2bba 87 1. An [BP3595](https://developer.mbed.org/components/BP3595-for-GR-PEACH/) WiFi module
<> 0:eb73febb2bba 88 1. Mount the WiFi module onto [Renesas GR-PEACH](https://developer.mbed.org/platforms/Renesas-GR-PEACH/)
<> 0:eb73febb2bba 89 1. In the `mbed_app.json` file, change
<> 0:eb73febb2bba 90 ```json
dkato 2:6ec5c1c1d41c 91 "network-interface":{
dkato 2:6ec5c1c1d41c 92 "help": "Options are ETHERNET, WIFI_ESP8266, WIFI_BP3595, NO_CONNECT",
dkato 2:6ec5c1c1d41c 93 "value": "WIFI_BP3595"
dkato 2:6ec5c1c1d41c 94 },
<> 0:eb73febb2bba 95 ```
<> 0:eb73febb2bba 96
<> 0:eb73febb2bba 97 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.
<> 0:eb73febb2bba 98 ```json
<> 0:eb73febb2bba 99 "wifi-ssid": {
<> 0:eb73febb2bba 100 "help": "WiFi SSID",
<> 0:eb73febb2bba 101 "value": "\"SSID\""
<> 0:eb73febb2bba 102 },
<> 0:eb73febb2bba 103 "wifi-password": {
<> 0:eb73febb2bba 104 "help": "WiFi Password",
<> 0:eb73febb2bba 105 "value": "\"Password\""
<> 0:eb73febb2bba 106 }
<> 0:eb73febb2bba 107 ```
<> 0:eb73febb2bba 108
dkato 2:6ec5c1c1d41c 109 Specify the security protocol in accordance with your wireless network. By default, NSAPI_SECURITY_WPA_WPA2 is specified. That means WPA and WPA2 are available. If you would like to use WEP instead of WPA2, please specify NSAPI_SECURITY_WEP here.
<> 0:eb73febb2bba 110 ```json
<> 0:eb73febb2bba 111 "wifi-security": {
dkato 2:6ec5c1c1d41c 112 "help": "Options are NSAPI_SECURITY_WEP, NSAPI_SECURITY_WPA, NSAPI_SECURITY_WPA2, NSAPI_SECURITY_WPA_WPA2",
dkato 2:6ec5c1c1d41c 113 "value": "NSAPI_SECURITY_WPA_WPA2"
<> 0:eb73febb2bba 114 }
<> 0:eb73febb2bba 115 ```
<> 0:eb73febb2bba 116
<> 0:eb73febb2bba 117 Short the jumper JP1 of [Audio Camera Shield](https://developer.mbed.org/teams/Renesas/wiki/Audio_Camera-shield) to supply the power to BP3595.
<> 0:eb73febb2bba 118
<> 0:eb73febb2bba 119 <span class="tips">**TODO:** Need to clarify when Audio Camera Shield is NOT available.</span>
<> 0:eb73febb2bba 120
<> 0:eb73febb2bba 121 ### IP address setup
<> 0:eb73febb2bba 122
dkato 2:6ec5c1c1d41c 123 This example uses IPv4 to communicate with the [mbed Device Connector Server](https://api.connector.mbed.com) except for 6LoWPAN ND and Thread.
dkato 2:6ec5c1c1d41c 124 The example program should automatically get an IP address from the router when connected over Ethernet or WiFi.
<> 0:eb73febb2bba 125 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.
<> 0:eb73febb2bba 126
<> 0:eb73febb2bba 127 ### Changing socket type
<> 0:eb73febb2bba 128
dkato 2:6ec5c1c1d41c 129 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.
<> 0:eb73febb2bba 130
<> 0:eb73febb2bba 131 To change the binding mode:
<> 0:eb73febb2bba 132
dkato 2:6ec5c1c1d41c 133 1. In the `simpleclient.h` file, find the parameter `SOCKET_MODE`. The default is `M2MInterface::UDP` for mesh and `M2MInterface::TCP` for others.
dkato 2:6ec5c1c1d41c 134 1. To switch to UDP, change it to `M2MInterface::UDP`.
<> 0:eb73febb2bba 135 1. Rebuild and flash the application.
<> 0:eb73febb2bba 136
<> 0:eb73febb2bba 137 <span class="tips">**Tip:** The instructions in this document remain the same, irrespective of the socket mode you select.</span>
<> 0:eb73febb2bba 138
dkato 2:6ec5c1c1d41c 139 Possible socket types per connection:
dkato 2:6ec5c1c1d41c 140
dkato 2:6ec5c1c1d41c 141 | Network interface | UDP | TCP |
dkato 2:6ec5c1c1d41c 142 | ------------------------------|:-----:|:-----:|
dkato 2:6ec5c1c1d41c 143 | Ethernet (IPv4) | X | X |
dkato 2:6ec5c1c1d41c 144 | Ethernet (IPv6) | X | |
dkato 2:6ec5c1c1d41c 145 | Wifi (IPv4) | X | X |
dkato 2:6ec5c1c1d41c 146 | Wifi (IPv6) - Not supported | | |
dkato 2:6ec5c1c1d41c 147 | 6LoWPAN/Thread (IPv6) | X | |
dkato 2:6ec5c1c1d41c 148
<> 0:eb73febb2bba 149 ## Building the example
<> 0:eb73febb2bba 150
dkato 2:6ec5c1c1d41c 151 To build the example using mbed CLI:
<> 0:eb73febb2bba 152
<> 0:eb73febb2bba 153 1. Open a command line tool and navigate to the project’s directory.
dkato 2:6ec5c1c1d41c 154
dkato 2:6ec5c1c1d41c 155 2. Import this example:
dkato 2:6ec5c1c1d41c 156
dkato 2:6ec5c1c1d41c 157 ```
dkato 2:6ec5c1c1d41c 158 mbed import http://mbed.org/teams/Renesas/code/GR-PEACH_mbed-os-client-ZXingSample/
dkato 2:6ec5c1c1d41c 159 ```
dkato 2:6ec5c1c1d41c 160
dkato 2:6ec5c1c1d41c 161 3. To build the application, select the hardware board and build the toolchain using the command:
dkato 2:6ec5c1c1d41c 162
dkato 2:6ec5c1c1d41c 163 ```
dkato 2:6ec5c1c1d41c 164 mbed compile -m RZ_A1H -t GCC_ARM -c
dkato 2:6ec5c1c1d41c 165 ```
dkato 2:6ec5c1c1d41c 166
dkato 2:6ec5c1c1d41c 167 mbed CLI builds a binary file under the project’s `BUILD/` directory.
dkato 2:6ec5c1c1d41c 168
dkato 2:6ec5c1c1d41c 169 4. Plug the Ethernet cable into the board if you are using Ethernet mode.
dkato 2:6ec5c1c1d41c 170
dkato 2:6ec5c1c1d41c 171 5. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device.
dkato 2:6ec5c1c1d41c 172
dkato 2:6ec5c1c1d41c 173 6. Drag the binary `BUILD/RZ_A1H/GCC_ARM/GR-PEACH_mbed-os-client-ZXingSample.bin` to the board to flash the application.
dkato 2:6ec5c1c1d41c 174
dkato 2:6ec5c1c1d41c 175 7. 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.
dkato 2:6ec5c1c1d41c 176
dkato 2:6ec5c1c1d41c 177 8. Press the **Reset** button on the board to run the program.
dkato 2:6ec5c1c1d41c 178
dkato 2:6ec5c1c1d41c 179 9. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter.
<> 0:eb73febb2bba 180
<> 0:eb73febb2bba 181 ## Monitoring the application
<> 0:eb73febb2bba 182
<> 0:eb73febb2bba 183 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.
<> 0:eb73febb2bba 184
<> 0:eb73febb2bba 185 <span class="notes">**Note:** Instructions to set this up are located [here](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications).</span>
<> 0:eb73febb2bba 186
<> 0:eb73febb2bba 187
<> 0:eb73febb2bba 188 ```
dkato 2:6ec5c1c1d41c 189 Starting mbed Client example in IPv4 mode
dkato 2:6ec5c1c1d41c 190 [EasyConnect] Using Ethernet
dkato 2:6ec5c1c1d41c 191 [EasyConnect] Connected to Network successfully
dkato 2:6ec5c1c1d41c 192 [EasyConnect] IP address 192.168.8.110
dkato 2:6ec5c1c1d41c 193 [EasyConnect] MAC address 5c:cf:7f:86:de:bf
<> 0:eb73febb2bba 194
dkato 2:6ec5c1c1d41c 195 SOCKET_MODE : TCP
<> 0:eb73febb2bba 196
<> 0:eb73febb2bba 197 Connecting to coap://api.connector.mbed.com:5684
<> 0:eb73febb2bba 198
dkato 2:6ec5c1c1d41c 199 Registered object succesfully!
<> 0:eb73febb2bba 200 ```
<> 0:eb73febb2bba 201
<> 0:eb73febb2bba 202 <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>
<> 0:eb73febb2bba 203
<> 0:eb73febb2bba 204 When the barcode data is successfully decoded, you should see the decoded string.
<> 0:eb73febb2bba 205
<> 0:eb73febb2bba 206 ## Testing the application
<> 0:eb73febb2bba 207
<> 0:eb73febb2bba 208 1. Flash the application.
<> 0:eb73febb2bba 209 1. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port.
<> 0:eb73febb2bba 210 1. On mbed Device Connector, go to [My devices > Connected devices](https://connector.mbed.com/#endpoints). Your device should be listed here.
<> 0:eb73febb2bba 211 1. Input the barcode data via camera. (If the decode is successfully carried out, decoded string should be uploaded onto mbed Device Connector)
<> 0:eb73febb2bba 212 1. Go to [Device Connector > API Console](https://connector.mbed.com/#console).
<> 0:eb73febb2bba 213 1. Enter `https://api.connector.mbed.com/endpoints/DEVICE_NAME/3202/0/5700` 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).
<> 0:eb73febb2bba 214 1. Decoded string is shown.
<> 0:eb73febb2bba 215 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.
<> 0:eb73febb2bba 216
<> 0:eb73febb2bba 217 ![Decoded String, as shown by the API Console](zxing.png)
<> 0:eb73febb2bba 218
<> 0:eb73febb2bba 219 <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>
<> 0:eb73febb2bba 220
<> 0:eb73febb2bba 221 <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).
<> 0:eb73febb2bba 222
<> 0:eb73febb2bba 223 ### Application resources
<> 0:eb73febb2bba 224
dkato 2:6ec5c1c1d41c 225 The application exposes four [resources](https://docs.mbed.com/docs/mbed-device-connector-web-interfaces/en/latest/#the-mbed-device-connector-data-model):
<> 0:eb73febb2bba 226
<> 0:eb73febb2bba 227 1. `3202/0/5700`. Decoded String of Barcode Data (GET).
<> 0:eb73febb2bba 228 2. `3201/0/5850`. Blink function, blinks `LED1` when executed (POST).
<> 0:eb73febb2bba 229 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).
dkato 2:6ec5c1c1d41c 230 4. `3201/0/5855`. Blink color, used by the blink function. Any of `red`, `green`, `blue`, `cyan`, `yellow` and `magenta` is acceptable (PUT).
<> 0:eb73febb2bba 231
<> 0:eb73febb2bba 232 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/Osamu-Nakamura/mbed-connector-api-node-quickstart).