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@0:eb73febb2bba, 2016-10-06 (annotated)

Committer:
<>
Date:
Thu Oct 06 18:00:30 2016 +0900
Revision:
0:eb73febb2bba
Child:
2:6ec5c1c1d41c
Initial Commit

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 ```
<> 0:eb73febb2bba 23 ""macros": ["MBEDTLS_USER_CONFIG_FILE=\"mbedtls_mbed_client_config.h\"",
<> 0:eb73febb2bba 24 "MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES",
<> 0:eb73febb2bba 25 "MBEDTLS_TEST_NULL_ENTROPY"],
<> 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
<> 0:eb73febb2bba 47 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:
<> 0:eb73febb2bba 48
<> 0:eb73febb2bba 49 ```json
<> 0:eb73febb2bba 50 "network-interface": {
<> 0:eb73febb2bba 51 "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
<> 0:eb73febb2bba 52 "value": "MESH_LOWPAN_ND"
<> 0:eb73febb2bba 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.
<> 0:eb73febb2bba 70
<> 0:eb73febb2bba 71 ### Wi-Fi settings (BP3595)
<> 0:eb73febb2bba 72
<> 0:eb73febb2bba 73 The example application uses BP3595 WiFi Interface for managing the wireless connectivity. To run this application using WiFi, you need:
<> 0:eb73febb2bba 74
<> 0:eb73febb2bba 75 1. An [BP3595](https://developer.mbed.org/components/BP3595-for-GR-PEACH/) WiFi module
<> 0:eb73febb2bba 76 1. Mount the WiFi module onto [Renesas GR-PEACH](https://developer.mbed.org/platforms/Renesas-GR-PEACH/)
<> 0:eb73febb2bba 77 1. In the `mbed_app.json` file, change
<> 0:eb73febb2bba 78 ```json
<> 0:eb73febb2bba 79 "network-interface": {
<> 0:eb73febb2bba 80 "help": "options are ETHERNET,WIFI,MESH_LOWPAN_ND,MESH_THREAD.",
<> 0:eb73febb2bba 81 "value": "WIFI"
<> 0:eb73febb2bba 82 }
<> 0:eb73febb2bba 83 ```
<> 0:eb73febb2bba 84
<> 0:eb73febb2bba 85 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 86 ```json
<> 0:eb73febb2bba 87 "wifi-ssid": {
<> 0:eb73febb2bba 88 "help": "WiFi SSID",
<> 0:eb73febb2bba 89 "value": "\"SSID\""
<> 0:eb73febb2bba 90 },
<> 0:eb73febb2bba 91 "wifi-password": {
<> 0:eb73febb2bba 92 "help": "WiFi Password",
<> 0:eb73febb2bba 93 "value": "\"Password\""
<> 0:eb73febb2bba 94 }
<> 0:eb73febb2bba 95 ```
<> 0:eb73febb2bba 96
<> 0:eb73febb2bba 97 Specify the security protocol in accordance with your wireless network. By default, NSAPI_SECURITY_WPA2 is specified. That means WPA2 is available. If you would like to use WEP instead of WPA2, please specify NSAPI_SECURITY_WEP here.
<> 0:eb73febb2bba 98 ```json
<> 0:eb73febb2bba 99 "wifi-security": {
<> 0:eb73febb2bba 100 "help": "Type of encryption for connection",
<> 0:eb73febb2bba 101 "value": "NSAPI_SECURITY_WPA2 or NSAPI_SECURITY_WEP"
<> 0:eb73febb2bba 102 }
<> 0:eb73febb2bba 103 ```
<> 0:eb73febb2bba 104
<> 0:eb73febb2bba 105 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 106
<> 0:eb73febb2bba 107 <span class="tips">**TODO:** Need to clarify when Audio Camera Shield is NOT available.</span>
<> 0:eb73febb2bba 108
<> 0:eb73febb2bba 109 ### IP address setup
<> 0:eb73febb2bba 110
<> 0:eb73febb2bba 111 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.
<> 0:eb73febb2bba 112
<> 0:eb73febb2bba 113 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 114
<> 0:eb73febb2bba 115 ### Changing socket type
<> 0:eb73febb2bba 116
<> 0:eb73febb2bba 117 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.
<> 0:eb73febb2bba 118
<> 0:eb73febb2bba 119 To change the binding mode:
<> 0:eb73febb2bba 120
<> 0:eb73febb2bba 121 1. In the `simpleclient.h` file, find the parameter `SOCKET_MODE`. The default is `M2MInterface::UDP`.
<> 0:eb73febb2bba 122 1. To switch to TCP, change it to `M2MInterface::TCP`.
<> 0:eb73febb2bba 123 1. Rebuild and flash the application.
<> 0:eb73febb2bba 124
<> 0:eb73febb2bba 125 <span class="tips">**Tip:** The instructions in this document remain the same, irrespective of the socket mode you select.</span>
<> 0:eb73febb2bba 126
<> 0:eb73febb2bba 127 ## Building the example
<> 0:eb73febb2bba 128
<> 0:eb73febb2bba 129 To build the example application:
<> 0:eb73febb2bba 130
<> 0:eb73febb2bba 131 1. Clone [this](https://github.com/ARMmbed/mbed-os-example-client) repository.
<> 0:eb73febb2bba 132 1. Open a command line tool and navigate to the project’s directory.
<> 0:eb73febb2bba 133 1. Update mbed-os sources using the `mbed update` command.
<> 0:eb73febb2bba 134 1. [Configure](#application-setup) the client application.
<> 0:eb73febb2bba 135 1. Build the application by selecting the hardware board and build the toolchain using the command `mbed compile -m RZ_A1H -t GCC_ARM -c -j0`. mbed-cli builds a binary file under the project’s `.build` directory.
<> 0:eb73febb2bba 136 1. Plug the Ethernet cable into the board if you are using Ethernet mode.
<> 0:eb73febb2bba 137 1. If you are using 6LoWPAN ND or Thread mode, connect and power on the gateway first.
<> 0:eb73febb2bba 138 1. Plug the micro-USB cable into the **OpenSDA** port. The board is listed as a mass-storage device.
<> 0:eb73febb2bba 139 1. Drag the binary `.build/RZ_A1H/GCC_ARM/mbed-os-example-client.bin` to the board to flash the application.
<> 0:eb73febb2bba 140 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.
<> 0:eb73febb2bba 141 1. Press the **RESET** button on the board to run the program.
<> 0:eb73febb2bba 142 1. For verification, continue to the [Monitoring the application](#monitoring-the-application) chapter.
<> 0:eb73febb2bba 143
<> 0:eb73febb2bba 144 ## Monitoring the application
<> 0:eb73febb2bba 145
<> 0:eb73febb2bba 146 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 147
<> 0:eb73febb2bba 148 <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 149
<> 0:eb73febb2bba 150
<> 0:eb73febb2bba 151 ```
<> 0:eb73febb2bba 152 Starting mbed Client example...
<> 0:eb73febb2bba 153 Using <Network Interface>
<> 0:eb73febb2bba 154
<> 0:eb73febb2bba 155 Connected to Network successfully
<> 0:eb73febb2bba 156 IP address xxx.xxx.xxx.xxx
<> 0:eb73febb2bba 157
<> 0:eb73febb2bba 158 SOCKET_MODE : UDP
<> 0:eb73febb2bba 159 Connecting to coap://api.connector.mbed.com:5684
<> 0:eb73febb2bba 160
<> 0:eb73febb2bba 161 ```
<> 0:eb73febb2bba 162
<> 0:eb73febb2bba 163 <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 164
<> 0:eb73febb2bba 165 When the barcode data is successfully decoded, you should see the decoded string.
<> 0:eb73febb2bba 166
<> 0:eb73febb2bba 167 ## Testing the application
<> 0:eb73febb2bba 168
<> 0:eb73febb2bba 169 1. Flash the application.
<> 0:eb73febb2bba 170 1. Verify that the registration succeeded. You should see `Registered object successfully!` printed to the serial port.
<> 0:eb73febb2bba 171 1. On mbed Device Connector, go to [My devices > Connected devices](https://connector.mbed.com/#endpoints). Your device should be listed here.
<> 0:eb73febb2bba 172 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 173 1. Go to [Device Connector > API Console](https://connector.mbed.com/#console).
<> 0:eb73febb2bba 174 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 175 1. Decoded string is shown.
<> 0:eb73febb2bba 176 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 177
<> 0:eb73febb2bba 178 ![Decoded String, as shown by the API Console](zxing.png)
<> 0:eb73febb2bba 179
<> 0:eb73febb2bba 180 <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 181
<> 0:eb73febb2bba 182 <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 183
<> 0:eb73febb2bba 184 ### Application resources
<> 0:eb73febb2bba 185
<> 0:eb73febb2bba 186 The application exposes three [resources](https://docs.mbed.com/docs/mbed-device-connector-web-interfaces/en/latest/#the-mbed-device-connector-data-model):
<> 0:eb73febb2bba 187
<> 0:eb73febb2bba 188 1. `3202/0/5700`. Decoded String of Barcode Data (GET).
<> 0:eb73febb2bba 189 2. `3201/0/5850`. Blink function, blinks `LED1` when executed (POST).
<> 0:eb73febb2bba 190 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).
<> 0:eb73febb2bba 191
<> 0:eb73febb2bba 192 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).