Sample program showing how to connect GR-PEACH into Watson IoT through mbed Connector and Watson's Connector Bridge

Dependencies:   AsciiFont DisplayApp GR-PEACH_video LCD_shield_config LWIPBP3595Interface_STA_for_mbed-os USBDevice

Overview

This sample program shows how to connect GR-PEACH into Watson IoT through mbed Connector and Watson's Connector Bridge. Note that this program is derived from https://github.com/ARMmbed/mbed-ethernet-sample-techcon2016.

In this program, at first, the barcode data input from camera is decoded on GR-PEACH using ZXing which is an open-source, multi-format 1D/2D barcode image processing library. Then, the decoded string is sent to Watson IoT via mbed Device Connector and Watson's Connector Bridge. At last, the delivered string is confirmed via NodeRED flow.

Required hardware

Application setup

  1. Select the connection type. For details, please refer to the following wiki:
    https://developer.mbed.org/teams/Renesas/code/mbed-os_Watson-IoT_ZXing_sample/wiki/Connection-type.
  2. Set the client credentials. For details, please refer to the following wiki:
    https://developer.mbed.org/teams/Renesas/code/mbed-os_Watson-IoT_ZXing_sample/wiki/Client-credentials.
  3. Change Ethernet settings. For details, please refer to the following wiki:
    https://developer.mbed.org/teams/Renesas/code/mbed-os_Watson-IoT_ZXing_sample/wiki/Ethernet-settings.
  4. Change Wifi settings. For details, please refer to the following wiki:
    https://developer.mbed.org/teams/Renesas/code/mbed-os_Watson-IoT_ZXing_sample/wiki/Wifi-settings.

Building this sample program

  1. Import this sample program onto mbed Compiler.
  2. Configure this sample program in accordance with Application setup.
  3. Compile the example on mbed Compiler and download the resultant binary file.
  4. Plug the Ethernet cable into GR-PEACH if you are using Ethernet mode. /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen7.png
  5. Plug the micro-USB cable into the OpenSDA port with lies on the next to the RESET button.
  6. Copy the binary previously downloaded to your PC to GR-PEACH to flash this sample program. When the copy is successfully completed, the board is ready to work.
  7. Press the RESET button on the board to run this sample program.
  8. For verification, please refer to the following wiki:
    https://developer.mbed.org/teams/Renesas/code/mbed-os_Watson-IoT_ZXing_sample/wiki/Monitoring-the-application.

Application resources

This sample program exposes two resources listed below:

  1. /311/0/5850 : Trigger to toggle LED on GR-PEACH (PUT). When "1" is sent to this resource by PUT method, LED should be turned off. Otherwise, LED should be turned on.
  2. /888/0/7700: Decode result of barcode data input from camera (GET)

Setup of Watson IoT

  1. You should create Watson IoT Instance by the following procedure:
    • Login IBM Bluemix from https://console.ng.bluemix.net/ and login it.
    • Select Services as follows: /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen6.png
    • Select Internet of Things" as follows: /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen7_1.png
    • Press Get Started as follows: /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen8.png
    • Configure Watson IoT Instance
      • Leave unbound /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen9.png
      • Select the Free plan, then click Create /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen10.png

  2. You should create Watson IoT Application Credentials Once you successfully create Watson IoT Instance, you should see the following Watson IoT dashboard: /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen11.png
    • On dashboard, launch the Connect your devices dashboard /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen12.png
    • Click APPS /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen13.png
    • Click Generate API Key /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen14_1.png
    • Record the API Key and Authenticatoin Token. Then click Generate after adding a comment /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen15.png Note that these two values will be needed in the later step.
  3. Watson IoT NodeRED Application should be created in accordance with the following procedure:
    • Go back to your Bluemix Dashboard: https://console.ng.bluemix.net
    • Click Create Application /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen16.png
    • Select Node-RED Starter /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen17.png
    • Enter a unique App name and Click Create /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen18.png
    • Application will Stage after a few minutes
    • Application will report app is running when the staging has completed
  4. Watson NodeRED Application should be binded to Watson IoT instance
    • You can now see the dashboard below: /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen19.png
    • Click Connections. Then, press Connect Existing /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen20.png
    • Click on Watson IoT Instance badge. Then, press Connect /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen21.png
    • NodeRED application will restage. This will take a while. Please wait for Your app is running state /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen22.png /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen23.png
  5. You should acquire mbed Device Connector DOMAIN value
    • Go to the mbed Device Connector Dashboard: https://connector.mbed.com and log in /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen41.png
    • Select Access Key in order to create a new token /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen42.png
    • Click CREATE NEW ACCESS KEY and enter a unique name. Then, push ADD bution /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen43.png
    • an API token is generated. Need to save the generated string for later steps /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen44.png
  1. You should configure Watson IoT ARM mbed Connector Bridge
    • Go back to the Watson IoT Dashboard and select Extensions /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen24.png
    • Press Add Extension /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen25.png
    • Add ARM mbed Connector /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen26_1.png
    • Setup the bridge /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen27.png
    • Enter your Connector API Token to Access Key and MBED_DOMAIN to Domain Id, respectively. Then, click Check Connection /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen28.png
    • If the connection is successfully established, you can see Connection Established. Then, press Done /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen29.png
  2. NodeRED Flow Example should be imported
    • Open NODEFLOW_GR-PEACH.txt
    • Navigate to the URL that you recorded earlier for your Watson IoT NodeRED Application (i.e. http://<app name>.mybluemix.net) and Select Go to your NodeRED flow editor /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen30.png
    • Select menu, Import and Clipboard /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen31.png
    • Paste the entire contents of JSON code described in NODEFLOW_GR-PEACH.txt and click Import /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen32.png
  3. Watson IoT Application Node Flow should be configured
    • Double-click input node and link them to your Watson IoT instance. /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen33.png
    • Click on the edit button /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen34.png
    • First enter arbitrary name. Then, Watson API Key and Watson Auth Token previously acquired. Finally, press Add to save /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen35.png
    • Enter MBED_ENDPOINT_NAME in security.h as Device ID. Then, press Done to save /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen36.png
    • Double-click output node /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen37.png
    • Edit API Key and Device Id in the same manner as that for input node
    • Click LED OFF and LED ON node and replace MBED_ENDPOINT_NAME_GOES_HERE with MBED_ENDPOINT_NAME as shown below: /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen38.png
    • Click Deproy to deploy NodeRED application /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen39.png
  4. Invoke sample program
    • Press the reset button on GR-PEACH
    • The decode result of barcode data should be shown in debug window /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen40_1.png
    • Also, you can toggle LED by clicking Turn LED OFF and Turn LED ON injection node /media/uploads/HinoNaka/mbed-os_watson-iot_zxing_sample_screen40_2.png
Committer:
Osamu Nakamura
Date:
Thu Nov 24 13:59:16 2016 +0900
Revision:
0:ad834d403a8c
Initial Commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Osamu Nakamura 0:ad834d403a8c 1 /**
Osamu Nakamura 0:ad834d403a8c 2 * @file DeviceManagementResponder.h
Osamu Nakamura 0:ad834d403a8c 3 * @brief mbed CoAP Endpoint Device Management Responder class
Osamu Nakamura 0:ad834d403a8c 4 * @author Doug Anson
Osamu Nakamura 0:ad834d403a8c 5 * @version 1.0
Osamu Nakamura 0:ad834d403a8c 6 * @see
Osamu Nakamura 0:ad834d403a8c 7 *
Osamu Nakamura 0:ad834d403a8c 8 * Copyright (c) 2016
Osamu Nakamura 0:ad834d403a8c 9 *
Osamu Nakamura 0:ad834d403a8c 10 * Licensed under the Apache License, Version 2.0 (the "License");
Osamu Nakamura 0:ad834d403a8c 11 * you may not use this file except in compliance with the License.
Osamu Nakamura 0:ad834d403a8c 12 * You may obtain a copy of the License at
Osamu Nakamura 0:ad834d403a8c 13 *
Osamu Nakamura 0:ad834d403a8c 14 * http://www.apache.org/licenses/LICENSE-2.0
Osamu Nakamura 0:ad834d403a8c 15 *
Osamu Nakamura 0:ad834d403a8c 16 * Unless required by applicable law or agreed to in writing, software
Osamu Nakamura 0:ad834d403a8c 17 * distributed under the License is distributed on an "AS IS" BASIS,
Osamu Nakamura 0:ad834d403a8c 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Osamu Nakamura 0:ad834d403a8c 19 * See the License for the specific language governing permissions and
Osamu Nakamura 0:ad834d403a8c 20 * limitations under the License.
Osamu Nakamura 0:ad834d403a8c 21 */
Osamu Nakamura 0:ad834d403a8c 22
Osamu Nakamura 0:ad834d403a8c 23 #ifndef __DEVICE_MANAGEMENT_RESPONDER_H__
Osamu Nakamura 0:ad834d403a8c 24 #define __DEVICE_MANAGEMENT_RESPONDER_H__
Osamu Nakamura 0:ad834d403a8c 25
Osamu Nakamura 0:ad834d403a8c 26 // Logger
Osamu Nakamura 0:ad834d403a8c 27 #include "mbed-connector-interface/Logger.h"
Osamu Nakamura 0:ad834d403a8c 28
Osamu Nakamura 0:ad834d403a8c 29 // Authenticator Support
Osamu Nakamura 0:ad834d403a8c 30 #include "mbed-connector-interface/Authenticator.h"
Osamu Nakamura 0:ad834d403a8c 31
Osamu Nakamura 0:ad834d403a8c 32 // invocation handler signature
Osamu Nakamura 0:ad834d403a8c 33 typedef void (*initialize_fn)(const void *logger);
Osamu Nakamura 0:ad834d403a8c 34 typedef bool (*manifest_fn)(const void *ep,const void *logger,const void *manifest,uint32_t manifest_length);
Osamu Nakamura 0:ad834d403a8c 35 typedef bool (*image_set_fn)(const void *ep,const void *logger,const void *image,uint32_t image_length);
Osamu Nakamura 0:ad834d403a8c 36 typedef bool (*responder_fn)(const void *ep,const void *logger,const void *data);
Osamu Nakamura 0:ad834d403a8c 37
Osamu Nakamura 0:ad834d403a8c 38 class DeviceManagementResponder {
Osamu Nakamura 0:ad834d403a8c 39 public:
Osamu Nakamura 0:ad834d403a8c 40 /**
Osamu Nakamura 0:ad834d403a8c 41 Default constructor
Osamu Nakamura 0:ad834d403a8c 42 @param logger input logger instance
Osamu Nakamura 0:ad834d403a8c 43 @param authenticator input authentication instance
Osamu Nakamura 0:ad834d403a8c 44 */
Osamu Nakamura 0:ad834d403a8c 45 DeviceManagementResponder(const Logger *logger,const Authenticator *authenticator);
Osamu Nakamura 0:ad834d403a8c 46
Osamu Nakamura 0:ad834d403a8c 47 /**
Osamu Nakamura 0:ad834d403a8c 48 Copy constructor
Osamu Nakamura 0:ad834d403a8c 49 @param resource input the DeviceManagementResponder that is to be deep copied
Osamu Nakamura 0:ad834d403a8c 50 */
Osamu Nakamura 0:ad834d403a8c 51 DeviceManagementResponder(const DeviceManagementResponder &manager);
Osamu Nakamura 0:ad834d403a8c 52
Osamu Nakamura 0:ad834d403a8c 53 /**
Osamu Nakamura 0:ad834d403a8c 54 Destructor
Osamu Nakamura 0:ad834d403a8c 55 */
Osamu Nakamura 0:ad834d403a8c 56 virtual ~DeviceManagementResponder();
Osamu Nakamura 0:ad834d403a8c 57
Osamu Nakamura 0:ad834d403a8c 58 /**
Osamu Nakamura 0:ad834d403a8c 59 Set the Endpoint instance
Osamu Nakamura 0:ad834d403a8c 60 @param ep input the endpoint instance pointer
Osamu Nakamura 0:ad834d403a8c 61 */
Osamu Nakamura 0:ad834d403a8c 62 void setEndpoint(const void *ep);
Osamu Nakamura 0:ad834d403a8c 63
Osamu Nakamura 0:ad834d403a8c 64 /**
Osamu Nakamura 0:ad834d403a8c 65 Set our Initialize handler function
Osamu Nakamura 0:ad834d403a8c 66 @param initialize_fn input the device initialize function pointer
Osamu Nakamura 0:ad834d403a8c 67 */
Osamu Nakamura 0:ad834d403a8c 68 void setInitializeHandler(initialize_fn initialize_fn);
Osamu Nakamura 0:ad834d403a8c 69
Osamu Nakamura 0:ad834d403a8c 70 /**
Osamu Nakamura 0:ad834d403a8c 71 Set our Reboot Responder handler function
Osamu Nakamura 0:ad834d403a8c 72 @param reboot_responder_fn input the device reboot responder function pointer
Osamu Nakamura 0:ad834d403a8c 73 */
Osamu Nakamura 0:ad834d403a8c 74 void setRebootResponderHandler(responder_fn reboot_responder_fn);
Osamu Nakamura 0:ad834d403a8c 75
Osamu Nakamura 0:ad834d403a8c 76 /**
Osamu Nakamura 0:ad834d403a8c 77 Set our Reset Responder handler function
Osamu Nakamura 0:ad834d403a8c 78 @param reset_responder_fn input the device reset responder function pointer
Osamu Nakamura 0:ad834d403a8c 79 */
Osamu Nakamura 0:ad834d403a8c 80 void setResetResponderHandler(responder_fn reset_responder_fn);
Osamu Nakamura 0:ad834d403a8c 81
Osamu Nakamura 0:ad834d403a8c 82 /**
Osamu Nakamura 0:ad834d403a8c 83 Set our FOTA manifest handler function
Osamu Nakamura 0:ad834d403a8c 84 @param fota_manifest_fn input the FOTA manifest handler function pointer
Osamu Nakamura 0:ad834d403a8c 85 */
Osamu Nakamura 0:ad834d403a8c 86 void setFOTAManifestHandler(manifest_fn fota_manifest_fn);
Osamu Nakamura 0:ad834d403a8c 87
Osamu Nakamura 0:ad834d403a8c 88 /**
Osamu Nakamura 0:ad834d403a8c 89 Set our FOTA image set handler function
Osamu Nakamura 0:ad834d403a8c 90 @param fota_image_set_fn input the FOTA image set function pointer
Osamu Nakamura 0:ad834d403a8c 91 */
Osamu Nakamura 0:ad834d403a8c 92 void setFOTAImageHandler(image_set_fn fota_image_set_fn);
Osamu Nakamura 0:ad834d403a8c 93
Osamu Nakamura 0:ad834d403a8c 94 /**
Osamu Nakamura 0:ad834d403a8c 95 Set our FOTA invocation handler function
Osamu Nakamura 0:ad834d403a8c 96 @param fota_invocation_fn input the FOTA invocation handler function pointer
Osamu Nakamura 0:ad834d403a8c 97 */
Osamu Nakamura 0:ad834d403a8c 98 void setFOTAInvocationHandler(responder_fn fota_invocation_fn);
Osamu Nakamura 0:ad834d403a8c 99
Osamu Nakamura 0:ad834d403a8c 100 /**
Osamu Nakamura 0:ad834d403a8c 101 ACTION: Deregister device
Osamu Nakamura 0:ad834d403a8c 102 @param challenge input the input authentication challenge
Osamu Nakamura 0:ad834d403a8c 103 */
Osamu Nakamura 0:ad834d403a8c 104 virtual void deregisterDevice(const void *challenge);
Osamu Nakamura 0:ad834d403a8c 105
Osamu Nakamura 0:ad834d403a8c 106 /**
Osamu Nakamura 0:ad834d403a8c 107 ACTION: Reboot device
Osamu Nakamura 0:ad834d403a8c 108 @param challenge input the input authentication challenge
Osamu Nakamura 0:ad834d403a8c 109 */
Osamu Nakamura 0:ad834d403a8c 110 virtual void rebootDevice(const void *challenge);
Osamu Nakamura 0:ad834d403a8c 111
Osamu Nakamura 0:ad834d403a8c 112 /**
Osamu Nakamura 0:ad834d403a8c 113 ACTION: Reset device
Osamu Nakamura 0:ad834d403a8c 114 @param challenge input the input authentication challenge
Osamu Nakamura 0:ad834d403a8c 115 */
Osamu Nakamura 0:ad834d403a8c 116 virtual void resetDevice(const void *challenge);
Osamu Nakamura 0:ad834d403a8c 117
Osamu Nakamura 0:ad834d403a8c 118 /**
Osamu Nakamura 0:ad834d403a8c 119 Set our FOTA manifest
Osamu Nakamura 0:ad834d403a8c 120 @param manifest input the FOTA manifest
Osamu Nakamura 0:ad834d403a8c 121 @param manifest_length input the length of the FOTA manifest
Osamu Nakamura 0:ad834d403a8c 122 */
Osamu Nakamura 0:ad834d403a8c 123 virtual void setFOTAManifest(char *manifest,uint32_t manifest_length);
Osamu Nakamura 0:ad834d403a8c 124
Osamu Nakamura 0:ad834d403a8c 125 /**
Osamu Nakamura 0:ad834d403a8c 126 Get our FOTA manifest
Osamu Nakamura 0:ad834d403a8c 127 @return the FOTA manifest
Osamu Nakamura 0:ad834d403a8c 128 */
Osamu Nakamura 0:ad834d403a8c 129 virtual char *getFOTAManifest();
Osamu Nakamura 0:ad834d403a8c 130
Osamu Nakamura 0:ad834d403a8c 131 /**
Osamu Nakamura 0:ad834d403a8c 132 Get our FOTA manifest length
Osamu Nakamura 0:ad834d403a8c 133 @return the FOTA manifest length
Osamu Nakamura 0:ad834d403a8c 134 */
Osamu Nakamura 0:ad834d403a8c 135 virtual uint32_t getFOTAManifestLength();
Osamu Nakamura 0:ad834d403a8c 136
Osamu Nakamura 0:ad834d403a8c 137 /**
Osamu Nakamura 0:ad834d403a8c 138 Set our FOTA image
Osamu Nakamura 0:ad834d403a8c 139 @param fota_image input the FOTA image
Osamu Nakamura 0:ad834d403a8c 140 @param fota_image_length input the length of the fota image
Osamu Nakamura 0:ad834d403a8c 141 */
Osamu Nakamura 0:ad834d403a8c 142 virtual void setFOTAImage(void *fota_image,uint32_t fota_image_length);
Osamu Nakamura 0:ad834d403a8c 143
Osamu Nakamura 0:ad834d403a8c 144 /**
Osamu Nakamura 0:ad834d403a8c 145 Get our FOTA image
Osamu Nakamura 0:ad834d403a8c 146 @return the FOTA image
Osamu Nakamura 0:ad834d403a8c 147 */
Osamu Nakamura 0:ad834d403a8c 148 virtual void *getFOTAImage();
Osamu Nakamura 0:ad834d403a8c 149
Osamu Nakamura 0:ad834d403a8c 150 /**
Osamu Nakamura 0:ad834d403a8c 151 Get our FOTA image length
Osamu Nakamura 0:ad834d403a8c 152 @return the FOTA image length
Osamu Nakamura 0:ad834d403a8c 153 */
Osamu Nakamura 0:ad834d403a8c 154 virtual uint32_t getFOTAImageLength();
Osamu Nakamura 0:ad834d403a8c 155
Osamu Nakamura 0:ad834d403a8c 156 /**
Osamu Nakamura 0:ad834d403a8c 157 ACTION: Invoke FOTA (default: empty action)
Osamu Nakamura 0:ad834d403a8c 158 @param challenge input the input authentication challenge
Osamu Nakamura 0:ad834d403a8c 159 */
Osamu Nakamura 0:ad834d403a8c 160 virtual void invokeFOTA(const void *challenge);
Osamu Nakamura 0:ad834d403a8c 161
Osamu Nakamura 0:ad834d403a8c 162 private:
Osamu Nakamura 0:ad834d403a8c 163 Logger *m_logger;
Osamu Nakamura 0:ad834d403a8c 164 Authenticator *m_authenticator;
Osamu Nakamura 0:ad834d403a8c 165 void *m_endpoint;
Osamu Nakamura 0:ad834d403a8c 166 char *m_manifest;
Osamu Nakamura 0:ad834d403a8c 167 int m_manifest_length;
Osamu Nakamura 0:ad834d403a8c 168 void *m_fota_image;
Osamu Nakamura 0:ad834d403a8c 169 uint32_t m_fota_image_length;
Osamu Nakamura 0:ad834d403a8c 170
Osamu Nakamura 0:ad834d403a8c 171 initialize_fn m_initialize_fn;
Osamu Nakamura 0:ad834d403a8c 172 responder_fn m_reboot_responder_fn;
Osamu Nakamura 0:ad834d403a8c 173 responder_fn m_reset_responder_fn;
Osamu Nakamura 0:ad834d403a8c 174 manifest_fn m_fota_manifest_fn;
Osamu Nakamura 0:ad834d403a8c 175 image_set_fn m_fota_image_set_fn;
Osamu Nakamura 0:ad834d403a8c 176 responder_fn m_fota_invocation_fn;
Osamu Nakamura 0:ad834d403a8c 177
Osamu Nakamura 0:ad834d403a8c 178 bool authenticate(const void *challenge);
Osamu Nakamura 0:ad834d403a8c 179 };
Osamu Nakamura 0:ad834d403a8c 180
Osamu Nakamura 0:ad834d403a8c 181 #endif // __DEVICE_MANAGEMENT_RESPONDER_H__