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@22:a3cd35c5cff0, 2018-12-18 (annotated)

Committer:
1050186
Date:
Tue Dec 18 07:37:37 2018 +0000
Revision:
22:a3cd35c5cff0
Parent:
17:548cfbfba6d8 
Modify README.md file.

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
1050186 17:548cfbfba6d8 15 * [Renesas GR-LYCHEE](https://developer.mbed.org/platforms/Renesas-GR-LYCHEE/).
<> 0:eb73febb2bba 16 * 1-2 micro-USB cables.
1050186 17:548cfbfba6d8 17 * Ethernet cable is unnecessay(This board connect to internet by using Wifi module is incorporated).
<> 0:eb73febb2bba 18
<> 0:eb73febb2bba 19 ## Required software
<> 0:eb73febb2bba 20
<> 0:eb73febb2bba 21 * [ARM mbed account](https://developer.mbed.org/account/login/?next=/).
<> 0:eb73febb2bba 22 * [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 23 * [Serial port monitor](https://developer.mbed.org/handbook/SerialPC#host-interface-and-terminal-applications).
<> 0:eb73febb2bba 24
<> 0:eb73febb2bba 25 ## Application setup
<> 0:eb73febb2bba 26
<> 0:eb73febb2bba 27 To configure the example application, please:
<> 0:eb73febb2bba 28
<> 0:eb73febb2bba 29 1. [Select the connection type](#connection-type).
<> 0:eb73febb2bba 30 1. [Set the client credentials](#client-credentials).
<> 0:eb73febb2bba 31 1. [Change Wi-Fi settings](#wi-fi-settings).
<> 0:eb73febb2bba 32
<> 0:eb73febb2bba 33 ### Connection type
<> 0:eb73febb2bba 34
1050186 17:548cfbfba6d8 35 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 WIFI_ESP32 mode:
<> 0:eb73febb2bba 36
<> 0:eb73febb2bba 37 ```json
dkato 2:6ec5c1c1d41c 38 "network-interface":{
1050186 17:548cfbfba6d8 39 "help": "Options are ETHERNET, WIFI_IDW0XX1, WIFI_ESP8266, WIFI_BP3595, WIFI_ESP32, WIFI_ISM43362, WIFI_ODIN, WIFI_WIZFI310, MESH_LOWPAN_ND, MESH_THREAD, CELLULAR_ONBOARD, NO_CONNECT",
1050186 17:548cfbfba6d8 40 "value": "WIFI_ESP32"
dkato 2:6ec5c1c1d41c 41 },
<> 0:eb73febb2bba 42 ```
<> 0:eb73febb2bba 43
<> 0:eb73febb2bba 44 ### Client credentials
<> 0:eb73febb2bba 45
<> 0:eb73febb2bba 46 To register the application to the Connector service, you need to create and set the client side certificate.
<> 0:eb73febb2bba 47
<> 0:eb73febb2bba 48 1. Go to [mbed Device Connector](https://connector.mbed.com) and log in with your mbed account.
<> 0:eb73febb2bba 49 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 50 1. Replace the contents in `security.h` of this project's directory with content copied above.
<> 0:eb73febb2bba 51
1050186 17:548cfbfba6d8 52 ### Wi-Fi settings
<> 0:eb73febb2bba 53
1050186 17:548cfbfba6d8 54 The example application uses WIFI_ESP32 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need:
<> 0:eb73febb2bba 55
<> 0:eb73febb2bba 56 1. In the `mbed_app.json` file, change
<> 0:eb73febb2bba 57 ```json
dkato 2:6ec5c1c1d41c 58 "network-interface":{
1050186 17:548cfbfba6d8 59 "help": "Options are ETHERNET, WIFI_IDW0XX1, WIFI_ESP8266, WIFI_BP3595, WIFI_ESP32, WIFI_ISM43362, WIFI_ODIN, WIFI_WIZFI310, MESH_LOWPAN_ND, MESH_THREAD, CELLULAR_ONBOARD, NO_CONNECT",
1050186 17:548cfbfba6d8 60 "value": "WIFI_ESP32"
dkato 2:6ec5c1c1d41c 61 },
<> 0:eb73febb2bba 62 ```
<> 0:eb73febb2bba 63
<> 0:eb73febb2bba 64 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 65 ```json
<> 0:eb73febb2bba 66 "wifi-ssid": {
<> 0:eb73febb2bba 67 "help": "WiFi SSID",
<> 0:eb73febb2bba 68 "value": "\"SSID\""
<> 0:eb73febb2bba 69 },
<> 0:eb73febb2bba 70 "wifi-password": {
<> 0:eb73febb2bba 71 "help": "WiFi Password",
<> 0:eb73febb2bba 72 "value": "\"Password\""
<> 0:eb73febb2bba 73 }
<> 0:eb73febb2bba 74 ```
<> 0:eb73febb2bba 75
dkato 2:6ec5c1c1d41c 76 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 77 ```json
<> 0:eb73febb2bba 78 "wifi-security": {
dkato 2:6ec5c1c1d41c 79 "help": "Options are NSAPI_SECURITY_WEP, NSAPI_SECURITY_WPA, NSAPI_SECURITY_WPA2, NSAPI_SECURITY_WPA_WPA2",
dkato 2:6ec5c1c1d41c 80 "value": "NSAPI_SECURITY_WPA_WPA2"
<> 0:eb73febb2bba 81 }
<> 0:eb73febb2bba 82 ```
<> 0:eb73febb2bba 83
<> 0:eb73febb2bba 84 ## Building the example
<> 0:eb73febb2bba 85
dkato 2:6ec5c1c1d41c 86 To build the example using mbed CLI:
<> 0:eb73febb2bba 87
<> 0:eb73febb2bba 88 1. Open a command line tool and navigate to the project’s directory.
dkato 2:6ec5c1c1d41c 89
dkato 2:6ec5c1c1d41c 90 2. Import this example:
dkato 2:6ec5c1c1d41c 91
dkato 2:6ec5c1c1d41c 92 ```
1050186 22:a3cd35c5cff0 93 mbed import http://os.mbed.com/users/1050186/code/GR-LYCHEE_mbed-os-client-ZXingSample/
dkato 2:6ec5c1c1d41c 94 ```
dkato 2:6ec5c1c1d41c 95
dkato 2:6ec5c1c1d41c 96 3. To build the application, select the hardware board and build the toolchain using the command:
dkato 2:6ec5c1c1d41c 97
dkato 2:6ec5c1c1d41c 98 ```
dkato 2:6ec5c1c1d41c 99 mbed compile -m RZ_A1H -t GCC_ARM -c
dkato 2:6ec5c1c1d41c 100 ```
dkato 2:6ec5c1c1d41c 101
dkato 2:6ec5c1c1d41c 102 mbed CLI builds a binary file under the project’s `BUILD/` directory.
dkato 2:6ec5c1c1d41c 103
1050186 17:548cfbfba6d8 104 4. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device.
dkato 2:6ec5c1c1d41c 105
1050186 17:548cfbfba6d8 106 5. Drag the binary `BUILD/RZ_A1H/GCC_ARM/XXXXXXXX.bin` to the board to flash the application.
dkato 2:6ec5c1c1d41c 107
dkato 2:6ec5c1c1d41c 108 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 109
dkato 2:6ec5c1c1d41c 110 8. Press the **Reset** button on the board to run the program.
dkato 2:6ec5c1c1d41c 111
dkato 2:6ec5c1c1d41c 112 9. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter.
<> 0:eb73febb2bba 113
<> 0:eb73febb2bba 114 ## Monitoring the application
<> 0:eb73febb2bba 115
<> 0:eb73febb2bba 116 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 117
<> 0:eb73febb2bba 118 <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 119
<> 0:eb73febb2bba 120
<> 0:eb73febb2bba 121 ```
1050186 17:548cfbfba6d8 122 Starting mbed Client example
1050186 17:548cfbfba6d8 123 [EasyConnect] Using WiFi (ESP32)
1050186 17:548cfbfba6d8 124 [EasyConnect] Connecting to WiFi XXXXXXXX
dkato 2:6ec5c1c1d41c 125 [EasyConnect] Connected to Network successfully
1050186 17:548cfbfba6d8 126 [EasyConnect] IP address xxx.xxx.xxx.xxx
1050186 17:548cfbfba6d8 127 [EasyConnect] MAC address xx:xx:xx:xx:xx:xx
<> 0:eb73febb2bba 128
dkato 2:6ec5c1c1d41c 129 SOCKET_MODE : TCP
<> 0:eb73febb2bba 130 Connecting to coap://api.connector.mbed.com:5684
<> 0:eb73febb2bba 131
1050186 17:548cfbfba6d8 132 Registered object successfully!
<> 0:eb73febb2bba 133 ```
<> 0:eb73febb2bba 134
<> 0:eb73febb2bba 135 <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 136
<> 0:eb73febb2bba 137 When the barcode data is successfully decoded, you should see the decoded string.
<> 0:eb73febb2bba 138
<> 0:eb73febb2bba 139 ## Testing the application
<> 0:eb73febb2bba 140
<> 0:eb73febb2bba 141 1. Flash the application.
<> 0:eb73febb2bba 142 1. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port.
<> 0:eb73febb2bba 143 1. On mbed Device Connector, go to [My devices > Connected devices](https://connector.mbed.com/#endpoints). Your device should be listed here.
<> 0:eb73febb2bba 144 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 145 1. Go to [Device Connector > API Console](https://connector.mbed.com/#console).
<> 0:eb73febb2bba 146 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 147 1. Decoded string is shown.
<> 0:eb73febb2bba 148
<> 0:eb73febb2bba 149 ![Decoded String, as shown by the API Console](zxing.png)
<> 0:eb73febb2bba 150
<> 0:eb73febb2bba 151 <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 152
<> 0:eb73febb2bba 153 <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 154
<> 0:eb73febb2bba 155 ### Application resources
<> 0:eb73febb2bba 156
dkato 2:6ec5c1c1d41c 157 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 158
<> 0:eb73febb2bba 159 1. `3202/0/5700`. Decoded String of Barcode Data (GET).
<> 0:eb73febb2bba 160 2. `3201/0/5850`. Blink function, blinks `LED1` when executed (POST).
<> 0:eb73febb2bba 161 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 162 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 163
<> 0:eb73febb2bba 164 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).