avnet visible things platform - renesas electronics...avnet visible things platform start here guide...

Rev. 1.02 Jun 16, 2017

Rev. 1.02 Jun 16, 2017

Avnet Visible Things Platform Start Here Guide

Introduction

At Avnet, our goal is to make it easy for our customers to get their projects up and running as

quickly as possible. The Visible Things Industrial IoT Gateway ships pre-programmed with

demo software which connects to the IBM Bluemix cloud service. This guide will show you how

to access sensor data from the cloud using IBM Bluemix® Quickstart and direct you to other

example software and application notes.

Aside from this document, there are many additional resources available at

https://www.avnet.com/wps/portal/silica/solutions/iot/internet-of-things/visible-things. If you ever

need more help, contact us and we will be happy to assist you.

Hardware Used in This Guide (Included in Kit)

• Avnet Visible Things Industrial IoT Gateway

• Smart Sensor w/ Bluetooth

• 2x USB Type A to USB Type Mini B Cable

Contents

1. Hardware Verification ......................................................................... 2

2. Software Installation ........................................................................... 4

2.1. Renesas Synergy Account Setup ................................................................................. 4

2.2. Installing Synergy Software and Tools ......................................................................... 6

2.3. Installing ubiquiOS ....................................................................................................... 8

2.4. Installing Board Support Packs .................................................................................... 8

3. Sensor to Cloud Demo ........................................................................ 9

3.1. Importing the Sensor to Cloud Demo into e2studio ....................................................... 9

3.2. Selecting a Synergy License .......................................................................................13

3.3. Configuring the Sensor to Cloud Demo with Wi-fi Credentials .....................................15

3.4. Programming the Sensor to Cloud Demo ....................................................................17

3.5. Navigating the Demo Application ................................................................................19

3.6. Using IBM Watson Quickstart .....................................................................................20

4. Next Steps.......................................................................................... 22

5. Website and Support ........................................................................ 22

https://www.avnet.com/wps/portal/silica/solutions/iot/internet-of-things/visible-things

mailto:[email protected]?subject=Support%20Question


Rev. 1.02 Jun 16, 2017

1. Hardware Verification The Gateway comes pre-programmed with a demo cloud application that allows you to

verify many of the hardware features when you first power it on.

Figure 1 – Industrial IoT Gateway

Power is supplied via the USB cable provided in the kit.

1. Connect one of the included USB cables to the Micro-AB connector marked Full Speed

USB on the Gateway.

Figure 2 – Powering the Gateway

2. Connect the other end of the USB cable to your PC USB port or the international USB

power supply A/C adapter (included with kit).

Once power has been connected, the USB Power LED will come on and the pre-

programmed demo will load the following screen.

Figure 3 – Running the demo application


Rev. 1.02 Jun 16, 2017

3. Insert the provided battery into the smart sensor, making sure to observe the polarity

marking inside the battery holder.

Figure 4 – Powering the sensor module

Once the battery is inserted, the sensor module will begin broadcasting. Once a

connection is made between the sensor module and Gateway, the module will begin

transmitting data from its multiple on-board sensors to the Gateway. The sensor’s MAC

address will also be added to the list of connected sensors on the Gateway’s display.


Rev. 1.02 Jun 16, 2017

2. Software Installation

2.1. Renesas Synergy Account Setup To create an account with Synergy, open a browser window on your PC and go to

synergygallery.renesas.com. The Synergy gallery is the central location which provides

access to all the free software and tools needed to develop Synergy-based projects.

1. Select Sign Up Now in the upper right corner.

Figure 5 – Signing up for a new Synergy account

2. Complete the form, making sure to enter everything that is marked with an asterisk

(*).

3. Complete the security challenge and make sure to read and agree to the Renesas

Synergy Gallery Terms of Use by checking the first box.

synergygallery.renesas.com


Rev. 1.02 Jun 16, 2017

4. If you would like to receive email notifications or marketing and support information,

leave the bottom two checked.

Figure 6 – Signing up for a new Synergy account

Once you have submitted the form, you will receive an e-mail requiring you to confirm

your account. If you do not receive this e-mail within a short period of time, check you

junk-mail folder. Follow the instructions in the e-mail and proceed to log into the website.

Figure 7 – Synergy Gallery home page


Rev. 1.02 Jun 16, 2017

2.2. Installing Synergy Software and Tools To develop software for the Renesas Synergy line of MCUs, it is highly recommended to

download and install the free software available with purchase of the MCU used on the

Gateway. The provided software has been developed using e2studio version 5.3.1.002

and Synergy Software Package (SSP) version 1.2.0. Make sure to download those

versions of the software to successfully build and run the project.

1. From the Synergy Gallery main page, select Development Tools > e2studio ISDE

from the toolbar on the top of the page.

NOTE: The latest version of e2studio will be shown on the page that opens. As of

the release of this guide, the newest version is 5.4.0.018. The provided software

has been developed using e2studio 5.3.1.002.

2. Download version 5.3.1.002 by selecting Release Archive.

Figure 8 – Downloading e2studio 5.3.1.002

3. Download e2studio 5.3.1.002 by clicking the version number.

Figure 9 – Downloading e2studio 5.3.1.002

4. Next, select Synergy Software Package from the main toolbar on the top of the

page.


Rev. 1.02 Jun 16, 2017

NOTE: The latest version of SSP will be shown on the page that opens. As of the

release of this guide, the newest version is 1.2.1. This application has been

developed using SSP 1.2.0.

5. Download version 1.2.0 by selecting Release Archive.

Figure 10 – Downloading SSP 1.2.0

6. Download SSP 1.2.0 by clicking the version number.

Figure 11 – Downloading SSP 1.2.0

7. After downloading e2studio and SSP, unzip them both.

8. First, install e2studio into the default directory.

9. Second, make sure e2studio is not running, and install SSP into its default directory.


Rev. 1.02 Jun 16, 2017

2.3. Installing ubiquiOS This demo application uses the ubiquiOS wireless stack to handle wireless connectivity

and communication. Install ubiquiOS as instructed below.

1. Unzip the provided zip file, “ubiquios-cm4_fpv4spd16-7.5.2-514.zip” to a temporary

directory.

2. Create a new folder, “C:\Ubiquios” (make sure initial “U” is capitalized and the rest

are lower case)

3. Copy the contents of the folder un-zipped in Step 1 into the newly created Ubiquios

folder.

Figure 12 – Installing ubiquiOS

2.4. Installing Board Support Packs 1. Close e2studio if it is open.

2. Copy the three *.pack files included with the Start Here Guide download into

C:\Renesas\e2_studio\internal\projectgen\arm\Packs.

NOTE: If you did not install e2studio in the default directory, this link will not work.


Rev. 1.02 Jun 16, 2017

3. Sensor to Cloud Demo The Sensor to Cloud demo programmed on the Gateway can be used to demonstrate the

graphical user interface (GUI) and Bluetooth connectivity. This software uses hard-coded

Wi-fi credentials and must be rebuilt before demonstrating wireless connectivity. The

Synergy Gateway takes readings from the Bluetooth smart sensor included in your kit and

sends it to the cloud using a Wi-fi connection. This demo is provided to you as a

compressed archive that can be imported directly into the Eclipse-based e2studio

development environment.

3.1. Importing the Sensor to Cloud Demo into e2studio Follow the instructions below to import the provided zip file into e2studio. This feature

does not require you to unzip the file.

1. Open e2studio by double-clicking the icon on your desktop or from the Windows Start

menu.

2. Select a workspace such as C:\Workspace or another directory of your choice.

3. Click OK.

Figure 13 – Selecting a workspace


Rev. 1.02 Jun 16, 2017

4. If the Welcome screen appears, click Workbench.

Figure 14 – e2studio welcome screen

5. From the menu, select File > Import…

Figure 15 – Importing a project in e2studio


Rev. 1.02 Jun 16, 2017

6. In the dialog that opens, select General > Existing Projects into Workspace.

Figure 16 – Importing an existing project

7. Select Select archive file:

8. Click Browse…

Figure 17 – Importing a project zip


Rev. 1.02 Jun 16, 2017

9. Navigate to the location where you unzipped the Start Here Guide files and select

visible_things_sensor_to_cloud.zip.

10. Click Open.

Figure 18 – Importing the sensor to cloud project zip

11. Click Finish.

Figure 19 – Importing the project


Rev. 1.02 Jun 16, 2017

3.2. Selecting a Synergy License 1. In the lower right of the e2studio workspace, click the link to select the license that is

included with the installation of SSP.

NOTE: If this popup disappears before you get a chance to click the link, go to

Window > Preferences > C/C++ > Renesas > Synergy License

Figure 20 – Synergy license temporary pop-up

2. Click the ellipsis (…).

Figure 21 – Selecting the license file


Rev. 1.02 Jun 16, 2017

3. Click Browse…


4. Select the license file named

SSP_License_Example_EvalLicense_yyyymmdd.xml.

5. Click Open.

NOTE: If the dialog does not default to the correct directory, navigate to

C:\Renesas\e2_studio\internal\projectgen\arm\Licenses.



Rev. 1.02 Jun 16, 2017

6. Click OK to close the Preferences dialog.


3.3. Configuring the Sensor to Cloud Demo with Wi-fi Credentials This version of the demo software stores its Wi-fi credentials as a macro definition. To

change the SSID and password to connect to your network, follow the instructions

below:

1. In the Project Explorer pane, expand the project if it is not already expanded.

2. Double-click configuration.xml to open the Synergy Configurator.

Figure 25 – Opening the Synergy configurator


Rev. 1.02 Jun 16, 2017

3. Click Generate Project Content to generate the project files.

Figure 26 – Generating project content

4. In the Project Explorer pane, expand the src folder.

5. Double-click vt_config.h to open it.

Figure 27 – Setting the Wi-fi credentials


Rev. 1.02 Jun 16, 2017

6. Update the file with your Wi-fi network credentials.

Figure 28 – Setting Wi-fi credentials

7. Click Save All from the toolbar.

8. Click Build from the toolbar.

9. Verify there are 0 errors in the console after the project has finished building.

Figure 29 – Verifying build is successful

3.4. Programming the Sensor to Cloud Demo 1. Within e2studio, select Run > Debug Configurations…

Figure 30 – Configuring debugger


Rev. 1.02 Jun 16, 2017

2. Select Renesas GDB Hardware > visible_things_sensor_to_cloud Debug

3. Click Debug.

Figure 31 – Programming and debugging the Gateway

4. If a dialog appears asking to change to the Debug Perspective, click Yes.

5. When the program starts running, it stops at a pre-defined breakpoint. Press F8 or

to let the program continue.

6. The program stops at another pre-defined breakpoint at main(). Press F8 or

again to let the program run.

Now that the program is running, it will attempt to connect to the wireless network with

your credentials. Once it connects, the Bluetooth module on the Gateway will begin

scanning to read sensor data. If a powered sensor module is within range, the Gateway

will read data from the sensor and publish that data to the IBM Watson IoT Quickstart

page at quickstart.internetofthings.ibmcloud.com.

http://quickstart.internetofthings.ibmcloud.com/


Rev. 1.02 Jun 16, 2017

3.5. Navigating the Demo Application When the demo first boots, it starts at the sensor list. At the top, the status of the various

connections are shown. The Wi-fi MAC address is shown on the bottom left, and the

server host name is shown on the bottom. Once a sensor is detected,

1. View the sensor data by selecting the sensor from the list.

Figure 32 – Viewing sensor data on the Gateway

2. After watching the sensor values update, return to the home page by clicking the

home button.

Figure 33 – Gateway sensor data

Once the Gateway has successfully connected to the network, the Wi-fi status will show

Connected and the Gateway ID (Wi-fi MAC address) will appear. This is the Device ID

that will be used to connect to the IBM Watson Quickstart page.


Rev. 1.02 Jun 16, 2017

3.6. Using IBM Watson Quickstart 1. Open the IBM Watson Quickstart page at:

http://quickstart.internetofthings.ibmcloud.com.

2. Check the box next to “I accept IBM’s Terms of Use”.

Figure 34 – Accepting IBM Terms of Use

3. Enter the Gateway ID shown in the lower left corner of the Gateway home screen.

The Gateway ID is the Gateway’s Wi-fi module’s MAC address and your Gateway ID

will be unique.

NOTE: The Gateway ID is case sensitive and must be entered as shown on the

Gateway without the colons!

Figure 35 – Entering MAC address

4. Click Go.

http://quickstart.internetofthings.ibmcloud.com/


Rev. 1.02 Jun 16, 2017

Once the device transmits the next packet, you will begin to see a visualization of all the

sensor data coming from the Gateway. Click on the different Datapoints shown below

the graph to view different sensor data. The ambient light graph is shown as an

example.

Figure 36 – Viewing sensor data on IBM Quickstart


Rev. 1.02 Jun 16, 2017

4. Next Steps Below is a list of the current application notes (or those being developed). Check our

website as we are constantly developing new demos and application notes:

• Sensor to Cloud using Node Red in IBM Bluemix/IoT Watson.

• http://www.teamfdi.com/syg#syg-appnotes

• All SYG Application Notes (in one spot)

5. Website and Support Product page and Documentation at:

https://www.avnet.com/wps/portal/silica/solutions/iot/internet-of-things/visible-things/vt-kit2

• Visible Things Industrial IoT Gateway User’s Manual

• Visible Things Industrial IoT Gateway Quick Start Guide

• Visible Things Industrial IoT Gateway Start Here Guide (this guide)

Contact information:

Future Designs, Inc.

996 A Cleaner Way SW

Huntsville, AL 35805

Phone: (256) 883-1240

Fax: (256) 883-1241

E-mail: [email protected] & [email protected]

Website: http://www.TeamFDI.com

http://www.teamfdi.com/syg#syg-appnotes

https://www.avnet.com/wps/portal/silica/solutions/iot/internet-of-things/visible-things/vt-kit2

mailto:[email protected]?subject=Sales%20question%20from%20possible

mailto:[email protected]?subject=Support%20Request%20from%20Customer

http://www.teamfdi.com/

avnet visible things platform - renesas electronics...avnet visible things platform start here guide...

Documents