Difference between revisions of "EdgeSense"

From ESS-WIKI
Jump to: navigation, search
 
(65 intermediate revisions by 8 users not shown)
Line 7: Line 7:
 
== For Windows Device ==
 
== For Windows Device ==
  
== For Linux Ubuntu device ==
+
=== How To Install ===
  
=== Basic Requirment: ===
+
*Step 1. Execute EdgeSense installer, click "Next >".
  
*Host OS must be Linux Distribution ( e.g. Ubuntu 14.04 / 16.04, ... )
+
[[File:2.1 Step1.png|RTENOTITLE]]
*Docker Engine - Installation Guide ( [https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/ Ubuntu], [https://docs.docker.com/engine/installation/linux/docker-ce/debian/ Debian], [https://docs.docker.com/engine/installation/linux/docker-ce/centos/ CentOS], [https://docs.docker.com/engine/installation/linux/docker-ce/centos/ Fedora], )
 
*Docker compose - [https://docs.docker.com/compose/install/ Installation Guid]
 
*Hardward: Advantech x86_64 Platforms ( e.g. ARK-2121L...)
 
  
=== How To Install and Run - Protocol Converter Docker Container Services ===
+
*Step 2. Select "I accept the ..." then click "Next >".
<pre># unzip installation package
 
tar zxvf EdgeSense_1.0.1.tar.gz
 
# Follow the readme to install your converter protocol</pre>
 
  
=== How to modify&nbsp;EnSaaS&nbsp;ID/Password and resart ===
+
[[File:2.1 Step2.png|RTENOTITLE]]​
<pre># To fill your "IoTKey" then save and exit
 
<IoTKey>304a99b5b452444c749a83bbb9e35dpow</IoTKey>
 
$cd {Installed path}/Installer/packages/Plugins/docker-edgesense-image-x86/EdgeSense/AgentService/config/
 
$sudo vim agent_config.xml
 
$sudo docker restart ensaas-ei-agent</pre>
 
  
 +
*Step 3. Select any cloud you would like to connect then click "Next >". (here we take WISE-PaaS/EnSaaS and RMM as example for below steps)
  
 +
[[File:2.1 Step3.png|RTENOTITLE]]
  
= Cloud =
+
*Step 4. Click "Next >".
  
== EnSaaS ==
+
[[File:2.1 Step4.png|RTENOTITLE]]
  
=== '''Register account on EdgesSense Portal''' ===
+
*Step 5. Click "Install".
  
*'''Purpose:'''
+
[[File:2.1 Step5.png|RTENOTITLE]]
  
Instructions in this document are intended to walk you through on how to register and create a user account on WISE-PaaS/EdgeSense portal
+
*Step 6. Wait for installation finished.
  
&nbsp;
+
[[File:2.1 Step6.png|RTENOTITLE]]
  
*'''Steps:'''
+
*Step 7. Select "I agree to the ..." then click "Install".
  
'''Step 1:'''
+
[[File:2.1 Step7.png|RTENOTITLE]]
  
*Step 1-1: Head to WISE-PaaS/EdgeSense portal [http://portal-rmm.wise-paas.com https://portal-rmm.wise-paas.com]
+
*Step 8. Select "I agree to the ..." then click "Install".
*Step 1-2: Click “Sign up” at the bottom&nbsp;
 
  
[[File:EnSaaS-Register Account 1-2.png|RTENOTITLE]]
+
[[File:2.1 Step8.png|RTENOTITLE]]
  
'''Step 2'''
+
*Step 9. Click "Finish". Now you have necessary component and agent installed in your device.
  
*Step 2-1: Fill in information including “Email”, “First Name”, “Last Name” and “Phone Number”
+
[[File:2.1 Step9.png|RTENOTITLE]]
  
[[File:EnSaaS-Register Account 2-1.png|RTENOTITLE]]
+
== For Linux Ubuntu ( Docker version ) ==
  
*Step 2-2: A message box will pop up after clicking “Sign up”, indicating it’s successfully done
+
=== Basic Requirment: ===
  
[[File:EnSaaS-Register Account 2-2.png|RTENOTITLE]]
+
*Host OS must be Linux Distribution (we developed and tested our software offering with '''Ubuntu 16.04''' environment so below content is referring to this specific Linux distribution.)
 +
*Docker Engine - Installation Guide&nbsp;( [https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/ Ubuntu]&nbsp;)
 +
*Docker compose - [https://docs.docker.com/compose/install/ Installation Guid]
 +
*Hardward: Advantech x86_64 Platforms ( e.g. ARK-2121L...)
  
'''Step 3:'''
+
=== How To Install and Run -&nbsp;Protocol Converter Docker Container Services ===
 +
<pre># unzip installation package
 +
tar zxvf EdgeSense_1.0.2.tar.gz
 +
# Follow the readme to install your converter protocol</pre>
  
*Step 3-1: In no time, you will receive a welcome email from Advantech in your registred mailbox which contains the information of your username and default password
+
=== How To modify&nbsp;EnSaaS&nbsp;ID/Password and resart ===
 +
<pre># To fill your "IoTKey" then save and exit
 +
<IoTKey>304a99b5b452444c749a83bbb9e35dpow</IoTKey>
 +
$cd {Installed path}/Installer/packages/Plugins/docker-edgesense-image-x86/EdgeSense/AgentService/config/
 +
$sudo vim agent_config.xml
 +
$sudo docker restart ensaas-ei-agent</pre>
  
​[[File:EnSaaS-Register Account 3-1.png|RTENOTITLE]]
+
=== How To config Modbus and resart service ===
 +
<pre>$cd {Installed path}/Installer/packages/Plugins/docker-edgesense-image-x86/EdgeSense/EService-Modbus/config/
 +
$sudo vim Modbus_Handler.ini
 +
$sudo docker restart service-modbus</pre>
  
*Step 3-2: Go back to login portal (as specified in Step1-1 or click “Return to login”) and login with your username and default password provided in welcome email
+
=== How To Restart Service ===
 +
<pre>// MQTT-BUS
 +
$sudo docker restart advigw-mqtt-bus
  
​[[File:EnSaaS-Register Account 3-2.png|RTENOTITLE]]
+
// Node-RED
 +
$sudo docker restart advigw-node-red
  
*Step 3-3: Upon first login, EdgeSense portal will ask user to change default password
+
// Modbus_Handler Service
 +
$sudo docker restart service-modbus
  
​[[File:EnSaaS-Register Account 3-3.png|RTENOTITLE]]
+
// HDD PMQ
 +
$sudo docker restart service-hddpmq
  
*Step 3-4: After changing password, re-login with new password
+
// SUSIControl
 +
$sudo docker restart service-susi</pre>
  
​[[File:EnSaaS-Register Account 3-4.png|RTENOTITLE]]
+
=== How To Uninstall Edgent Sense Docker&nbsp;Image ===
 +
<pre>$cd {Installed path}/Installer/packages/Plugins/docker-edgesense-image-x86/
 +
$sudo ./deploy.sh rmi</pre>
  
*Step 3-5: Now you should be able to see default page after logging in WISE-PaaS/EdgeSense portal
+
= Cloud =
  
​[[File:EnSaaS-Register Account 3-5.png|RTENOTITLE]]
+
== WISE-PaaS/EnSaaS ==
  
=== How to Connect Edge Devices to RMM Cloud ===
+
WISE-PaaS/EnSaaS is an open and standardized industrial IoT platform provided by Advantech Corp., and EdgeSense leverages cloud services on top of it to offer device management and visualization service.
  
*'''Purpose:'''
+
You will be re-directed to WISE-PaaS online documentation site via below links.
  
Instructions in this document are intended to walk you through the process of connecting your edge devices to RMM cloud
+
=== '''Register account on EdgesSense Portal''' ===
  
&nbsp;
+
Please visit [http://wise-paas-documentation.docs.wise-paas.com/Documentation/#!documents/RMM/register-account-on-edgessense-portal.md this page] for step by step&nbsp;instruction.
  
*'''Steps:'''
+
=== How to Connect Edge Devices to RMM Cloud ===
 
 
'''Step 1: Sign in EdgeSense Portal'''
 
 
 
(If you don’t have an EdgeSense account, please register one by clicking “Sign up” at the bottom)
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 1.png|RTENOTITLE]]
 
 
 
'''Step 2: Obtain Agent Credentials and Download EI Agent'''
 
 
 
*Step 2-1: Select “System” tab under “Setting” on the left of management console
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 2-1.png|RTENOTITLE]]
 
 
 
*Step 2-2: Click “Generate Agent Credential” botton to obtain ''IoTKey'' and ''Credential URL'' which will be needed when installing RMM EI Agent in Step 3 in order to connect agent to RMM cloud
 
 
 
​[[File:How to Connect Edge Devices to RMM Cloud 2-2.png|RTENOTITLE]]
 
 
 
*Step 2-3: Click “Download” button to download RMM EI Agent instllation package
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 2-3.png|RTENOTITLE]]
 
 
 
*Step 2-4: [Important Reminder] Please note that this step MUST BE taken on your edge devices
 
 
 
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Execute ''RMM EI AgentSetep_1.0.9.exe'' file to start instllation process on '''agent devices'''
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 2-4.png|RTENOTITLE]]
 
 
 
'''Step 3: Install RMM EI Agent'''
 
 
 
'''[[File:How to Connect Edge Devices to RMM Cloud 3-1.png|RTENOTITLE]][[File:How to Connect Edge Devices to RMM Cloud 3-2.png|RTENOTITLE]]'''
 
 
 
Enter ''Credential URL'' and ''IoTKey'' obtained earlier in EdgeSense management console (Step 2-2)
 
  
[[File:How to Connect Edge Devices to RMM Cloud 3-3.png|RTENOTITLE]][[File:How to Connect Edge Devices to RMM Cloud 3-4.png|RTENOTITLE]]
+
Please visit&nbsp;[http://wise-paas-documentation.docs.wise-paas.com/Documentation/#!documents/RMM/connect-edge-devices-to-rmm-cloud.md this page]&nbsp;for step by step&nbsp;instruction.
 
 
[[File:How to Connect Edge Devices to RMM Cloud 3-5.png|RTENOTITLE]]
 
 
 
If your devices support iAMT, you can also enter your iAMT account and password here
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 3-6.png|RTENOTITLE]]
 
 
 
(Note: iAMT may need to be enabled in BIOS first and MEBx configurations might as well needed)
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 3-7.png|RTENOTITLE]][[File:How to Connect Edge Devices to RMM Cloud 3-8.png|RTENOTITLE]]
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 3-9.png|RTENOTITLE]]
 
 
 
Launch “ServerSetting” under C:\Program Files (x86)\Advantech\RMM EI Agent (default folder)
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 3-10.png|RTENOTITLE]]
 
 
 
You can set your password for accessing “ServerSetting”
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 3-11.png|RTENOTITLE]]
 
 
 
After setting password, please make sure it shows “''Connected''”, otherwise devices couldn’t get connected to RMM cloud
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 3-12.png|RTENOTITLE]]
 
 
 
'''Step 4: Get Edge Devices Connected to RMM Cloud'''
 
 
 
*Step 4-1: In management console, go to “Device Group” under “Setting” tab, then click “+” icon to add new group(s) before adding devices ('''Note: Please be noted that you HAVE TO create a new group before adding or assigning edge devices if there’s no existing group(s)''')
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-1.png|RTENOTITLE]]
 
 
 
*Step 4-2: Enter the name and description (optional) of the group you’re creating
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-2.png|RTENOTITLE]]
 
 
 
*Step 4-3: A notification window will pop up indicating your group has been created successfully
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-3.png|RTENOTITLE]]
 
 
 
*Step 4-4: Now we can see a new group has been generated (''EdgeSenseGroup'' here for example)
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-4.png|RTENOTITLE]]
 
 
 
*Step 4-5: Go to “Device” tab on the left console, click drop-down list and select the group you want your edge devices to be assigned
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-5.png|RTENOTITLE]]
 
 
 
*Step 4-6: Click “+” icon to add device
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-6.png|RTENOTITLE]]
 
 
 
*Step 4-7: Then Click “+” icon to add device manually
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-7.png|RTENOTITLE]]
 
 
 
*Step 4-8: Upon seeing this message box, go back and open ServerSetting ([[#ServerSetting|Step 3]]) on edge device then click the copy icon (as pointed in below screenshot) to copy full string of Agent ID
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-8.png|RTENOTITLE]]
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-8-2.png|RTENOTITLE]]
 
 
 
*Step 4-9: Paste the full string of Agent ID just copied in the blank
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-9.png|RTENOTITLE]]
 
 
 
*Step 4-10: Edge device to be added/connected will then appear with its “''Name''” and “''Agent ID''”
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-10.png|RTENOTITLE]]
 
 
 
*Step 4-11: Notification window will pop out indicating device(s) has been added to your group
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-11.png|RTENOTITLE]]
 
 
 
*&nbsp;'''[Note]''' Generally if your account is signed up/created through WISE-PaaS/EdgeSense portal, default account role assigned is “''device admin''”. If you wish to have elavated priviledge/permission as “''admin''” which allows you to search all unassigned devices and decide which to add, please contact Advantech for more information
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-11-2.png|RTENOTITLE]]
 
 
 
With “''admin''” permission, a list of unassigned devices will appear for users to search/select from
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-11-3.png|RTENOTITLE]]
 
 
 
*Step 4-12: Now you should be able to see your connected devices in management console
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-12.png|RTENOTITLE]]
 
 
 
*Step 4-13: Click the name of the edge device you will see all detailed information of this device
 
 
 
[[File:How to Connect Edge Devices to RMM Cloud 4-13.png|RTENOTITLE]]
 
  
 
== Azure ==
 
== Azure ==
Line 241: Line 133:
 
[[File:Create hub 1.png|center|750px|create-hub.png]]
 
[[File:Create hub 1.png|center|750px|create-hub.png]]
  
*Input IoT hub name: '''protocol-conn-hub''' (for example)
+
*Select Resource group created at step 2: click “'''Use existing'''” and select “'''protocol-conn-rg'''
  
*Select pricing and scale tier: here we chose “'''S1 - Standard'''
+
*Select Region: '''East Asia'''
  
*Select Resource group created at step 2: click “'''Use existing'''” and select “'''protocol-conn-rg'''
+
*Input IoT hub name: '''protocol-con-hub''' (for example)
 +
 
 +
*Click on '''Review+Create'''
 +
 
 +
[[File:Iot hub.png|center|800px|iot_hub.png]]
 +
 
 +
*Click on '''Create'''
  
[[File:Create-hub-detail.png|center|300px|create-hub-detail.png]]
+
[[File:Iot hub2.png|center|800px|iot_hub2.png]]
  
 
=== Connect device and data to Azure for Windows device – Protocol Converter Using Node-RED ===
 
=== Connect device and data to Azure for Windows device – Protocol Converter Using Node-RED ===
Line 255: Line 153:
 
Following steps will create an azure iot device to connect to iot hub created at [[#Create_Azure_IoT_Hub|previous section]].
 
Following steps will create an azure iot device to connect to iot hub created at [[#Create_Azure_IoT_Hub|previous section]].
  
Step 1. Go to iot hub created at previous section: Resource groups → protocol-conn-rg → protocol-conn-hub
+
Step 1. Go to iot hub created at previous section: Resource groups → protocol-conn-rg → Overview → protocol-con-rg (for example)
  
[[File:Select-conn-hub.png|center|750px|select conn hub]]
+
[[File:Iot device0.png|center|750px|iot_device0]]
  
 
Step 2. IoT Devices → Add
 
Step 2. IoT Devices → Add
Line 270: Line 168:
  
 
*Connect device to IoT Hub: select “Enable”
 
*Connect device to IoT Hub: select “Enable”
 +
*Save the configurations
  
[[File:Create-conn-iot-device-details.png|center|300px|iot device details]]
+
[[File:Add device.png|center|300px|add_device]]
  
 
*Select the created iot device to get device connection string
 
*Select the created iot device to get device connection string
  
[[File:Select-iot-device.png|center|700px|select iot device]]
+
[[File:Iot device.png|center|700px|iot_device]]
  
 
*Click [[File:Save icon.png|20px|save-icon.png]] to copy “Connection string-primary key” and make sure the "Connect device to IoT Hub" is "'''Enable'''"
 
*Click [[File:Save icon.png|20px|save-icon.png]] to copy “Connection string-primary key” and make sure the "Connect device to IoT Hub" is "'''Enable'''"
Line 281: Line 180:
 
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;<span style="color:#FFA07A;">"Connection string-primary key" will be used later in Node-Red "Connection String" field.</span>
 
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;<span style="color:#FFA07A;">"Connection string-primary key" will be used later in Node-Red "Connection String" field.</span>
  
[[File:Select-iot-device-conn-str.png|center|700px|copy device conn string.png]]
+
[[File:Iot device2.png|center|700px|iot_device2]]
  
 
*Save the connection string in a text file for later use
 
*Save the connection string in a text file for later use
Line 291: Line 190:
 
Following steps will configure device Node-RED nodes to enable communications between Advantech protocol converter modules and azure iot hub.
 
Following steps will configure device Node-RED nodes to enable communications between Advantech protocol converter modules and azure iot hub.
  
Step 1. Open Node-RED page in the web browser (default URI is [http://127.0.0.1:1880 http://127.0.0.1:1880])
+
Step 1. Open Node-RED page in the web browser (default URI is '''[http://127.0.0.1:1880 http://127.0.0.1:1880]''')
  
 
[[File:Nr-main.png|center|750px|nr main]]
 
[[File:Nr-main.png|center|750px|nr main]]
Line 324: Line 223:
  
 
Step 5. Click [[File:Deploy-icon.png|100px|deploy icon]] to complete edge device environment setups and make sure the states of MQTT nodes are "connected"[[File:Deploy-nr-protocol2.png|center|750px|nr deployed]]
 
Step 5. Click [[File:Deploy-icon.png|100px|deploy icon]] to complete edge device environment setups and make sure the states of MQTT nodes are "connected"[[File:Deploy-nr-protocol2.png|center|750px|nr deployed]]
 +
 +
Step 6. Jump to&nbsp;'''[[#Monitor_Messages|Monitor Messages]]''' for further steps.
  
 
=== Connect device and data to Azure for Linux Ubuntu device – Protocol Converter Using IoT Edge ===
 
=== Connect device and data to Azure for Linux Ubuntu device – Protocol Converter Using IoT Edge ===
Line 369: Line 270:
  
 
1. Install IoT Edge control script (may need to run as root)
 
1. Install IoT Edge control script (may need to run as root)
<pre>        pip install -U azure-iot-edge-runtime-ctl</pre>
+
<pre>        pip install -U azure-iot-edge-runtime-ctl==1.0.0rc17</pre>
  
 
2. Make sure the “iotedgectl” command is available. (the version number may be different)
 
2. Make sure the “iotedgectl” command is available. (the version number may be different)
Line 418: Line 319:
  
 
*Open a command prompt and type following command. Replace "{your iot edge device connection string}" with the saved device connection string
 
*Open a command prompt and type following command. Replace "{your iot edge device connection string}" with the saved device connection string
<pre>        iotedgectl setup --connection-string "{your iot edge device connection string}" --auto-cert-gen-force-no-passwords</pre>
+
<pre>        sudo iotedgectl setup --connection-string "{your iot edge device connection string}" --auto-cert-gen-force-no-passwords</pre>
<!--
+
 
[[File:Edge-ctl-setup-win.png|center|750px|iotedge-setup-win]]<br/>
 
-->
 
 
[[File:Edge-ctl-setup-linux.png|center|750px|iotedge-setup-linux]]
 
[[File:Edge-ctl-setup-linux.png|center|750px|iotedge-setup-linux]]
  
 
*Start the IoT Edge runtime
 
*Start the IoT Edge runtime
<pre>        iotedgectl start</pre>
+
<pre>        sudo iotedgectl start</pre>
<!--
+
 
[[File:Edge-ctl-start-win.png|center|750px|iotedge-start-win]]<br/>
 
-->
 
 
[[File:Edge-ctl-start-linux.png|center|750px|iotedge-start-linux]]
 
[[File:Edge-ctl-start-linux.png|center|750px|iotedge-start-linux]]
  
 
*Check Docker to see that the IoT Edge agent is running as a module
 
*Check Docker to see that the IoT Edge agent is running as a module
<pre>        docker ps</pre>
+
<pre>        sudo docker ps</pre>
<!--
 
[[File:Iotedge-docker-ps-win.png|center|750px|docker-ps-win]]<br/>
 
-->
 
[[File:Docker ps linux.png|center|750px|docker-ps-linux]]
 
  
 
=== Deploy an IoT edge device module to edge device ===
 
=== Deploy an IoT edge device module to edge device ===
Line 494: Line 387:
 
=== Monitor Messages ===
 
=== Monitor Messages ===
  
==== Device to Cloud (D2C) ====
+
==== .Device to Cloud (D2C) ====
  
 
*Get IoT Hub Connection String from below steps.
 
*Get IoT Hub Connection String from below steps.
Step 1. Go to iot hub created at "[[#Create_Azure_IoT_Hub|Create Azure IoT Hub]]" section: Resource groups → protocol-conn-rg → protocol-conn-hub
 
[[File:Select-conn-hub.png|center|750px|select conn hub]]
 
  
Step 2. Click [[File:Save icon.png|20px|save-icon.png]] to copy iot hub connection string: Shared access policies → iothubowner → Primary key
+
Step 1. Go to iot hub created at "[[#Create_Azure_IoT_Hub|Create Azure IoT Hub]]" section: Resource groups → protocol-conn-rg → protocol-conn-hub [[File:Select-conn-hub.png|center|750px|select conn hub]]
[[File:Hub-conn-str.png|center|750px|copy hub conn string]]
+
 
 +
Step 2. Click [[File:Save icon.png|20px|save-icon.png]] to copy iot hub connection string: Resource groups → Shared access policies → iothubowner →&nbsp;Connection String​[[File:Share access policy.png|center|750px|Share_access_policy]]
  
*use [https://github.com/azure/iothub-explorer iothub-explorer] tool (require nodejs and npm) to monitor D2C messages.
+
*Use [https://github.com/azure/iothub-explorer iothub-explorer] tool (require nodejs and npm) to monitor D2C messages.
 
<pre>        npm install -g iothub-explorer
 
<pre>        npm install -g iothub-explorer
  
         iothub-explorer monitor-events iotedge-protocol-connector --login "{your iot hub connection string}"
+
         iothub-explorer monitor-events {Your IoT Device id} --login "{your iot hub connection string}"
 
</pre>
 
</pre>
  
Line 512: Line 404:
  
 
[[File:Iothub-explorer-linux.png|center|700px|iothub-explorer-linux]]
 
[[File:Iothub-explorer-linux.png|center|700px|iothub-explorer-linux]]
 +
 +
'''When Installing'''&nbsp;'''iothub-explorer on Windows system, please use administrator role to execute&nbsp;cmd. Otherwise,&nbsp;the environment variable cannot be correctly written to the system. You can add the&nbsp;environment variable&nbsp;manually.&nbsp;''' [[File:Iothub-explorer-win 1.png|center|700px|iothub-explorer-win_1]] [[File:Iothub-explorer-win 2.png|center|700px|iothub-explorer-win_2]]
  
 
==== Cloud to Device (C2D) ====
 
==== Cloud to Device (C2D) ====
Line 542: Line 436:
  
 
*AWS account
 
*AWS account
 +
 
*this example use service which is region in US East (N. Virginia).
 
*this example use service which is region in US East (N. Virginia).
  
 
==== Cloud Environment Setup ====
 
==== Cloud Environment Setup ====
  
Step 1.Return the AWS console and go to IAM menu.
+
Step 1.Return the AWS console and go to IAM menu. [[File:IAM1.png|center|1000px|IAM1.png]]
 
 
[[File:IAM1.png|center|1000px|IAM1.png]]
 
 
 
Step 2.Click “user” menu
 
 
 
[[File:IAM2.png|center|1000px|IAM2.png]]
 
 
 
 
 
 
 
&nbsp;
 
 
 
Step 3.Click “Add user” button
 
  
[[File:IAM3.png|center|1000px|IAM3.png]]
+
Step 2.Click “user” menu [[File:IAM2.png|center|1000px|IAM2.png]]
  
Step 4.Enter your user name. In this example user name is “Adv_test”.→ chose Programmatic access → Click “Next Permissions” button.
+
Step 3.Click “Add user” button [[File:IAM3.png|center|1000px|IAM3.png]]
  
[[File:IAM4.png|center|1000px|IAM4png]]
+
Step 4.Enter your user name. In this example user name is “Adv_test”.→ chose Programmatic access → Click “Next Permissions” button. [[File:IAM4.png|center|1000px|IAM4png]]
  
 
Step 5.Click [[File:IAM GP.png|IAM_GP.png]]
 
Step 5.Click [[File:IAM GP.png|IAM_GP.png]]
  
[[File:IAM5.png|center|1000px|IAM.png]]
+
Step 6.Choose AdministratorAccess → Click “Next: Review” button [[File:IAM6.png|center|1000px|IAM6.png]]
 
 
Step 6.Choose AdministratorAccess → Click “Next: Review” button
 
 
 
[[File:IAM6.png|center|1000px|IAM6.png]]
 
 
 
Step 7.Click “Create user”
 
  
[[File:IAM7.png|center|1000px|IAM7.png]]
+
Step 7.Click “Create user” [[File:IAM7.png|center|1000px|IAM7.png]]
  
 
Step 8.Download the credentials. This is the last time these credentials will be available to download.
 
Step 8.Download the credentials. This is the last time these credentials will be available to download.
  
Step 9.Click “Download .csv” button
+
Step 9.Click “Download .csv” button [[File:IAM8.png|center|1000px|IAM8.png]]
 
 
[[File:IAM8.png|center|1000px|IAM8.png]]
 
 
 
Step 10. Go to AWS IoT Core.
 
 
 
[[File:AWS iot core.png|center|1000px|AWS iot core.png]]
 
  
Step 11. Copy the endpoint from "Setting". <span style="color:#FF8C00;">The endpoint will be used in Node-Red setting later.</span>
+
Step 10. Go to AWS IoT Core. [[File:AWS iot core.png|center|1000px|AWS iot core.png]]
  
Check if the region is N. Virginia before copying the endpint.
+
Step 11. Copy the endpoint from "Setting". <span style="color:#FF8C00;">The endpoint will be used in Node-Red setting later.</span> Check if the region is N. Virginia before copying the endpint. [[File:13 2.png|center|1000px|13 2.png]]
 
 
[[File:13 2.png|center|1000px|13 2.png]]
 
  
 
==== Device Environment Setup ====
 
==== Device Environment Setup ====
  
 
In this section, you will install Advantech Node-Red tool for and Configurate the setting to connect AWS IoT
 
In this section, you will install Advantech Node-Red tool for and Configurate the setting to connect AWS IoT
 
 
  
 
*&nbsp;click on desktop to open NodeRED in web browser
 
*&nbsp;click on desktop to open NodeRED in web browser
Line 607: Line 474:
  
 
*Copy following NodeRED flow and import it into NodeRED:
 
*Copy following NodeRED flow and import it into NodeRED:
<pre>  
+
<pre>[
[{"id":"d652f017.65e74","type":"tab","label":"Protocol Connector ","disabled":false,"info":""},
+
{"id":"79179714.505328","type":"tab","label":"Protocol Connector ","disabled":false,"info":""},{"id":"d79da03e.4ac02","type":"mqtt in","z":"79179714.505328","name":"Data Recieved","topic":"/cagent/admin/+/deviceinfo","qos":"2","broker":"7c9c4d87.a21bd4","x":150,"y":132,"wires":[["f9b3112b.9e99a","d48faaf7.aded28"]]},
{"id":"bec4e2f6.b7b83","type":"mqtt in","z":"d652f017.65e74","name":"Data Recieved","topic":"/cagent/admin/+/deviceinfo","qos":"2","broker":"22aa981b.46a50c","x":150,"y":132,"wires":[["5651a33f.5722bc","cd4723c3.e1624"]]},{"id":"cd4723c3.e1624","type":"debug","z":"d652f017.65e74","name":"","active":true,"console":"false","complete":"payload","x":340,"y":112,"wires":[]},
+
{"id":"d48faaf7.aded28","type":"debug","z":"79179714.505328","name":"","active":true,"console":"false","complete":"payload","x":340,"y":112,"wires":[]},{"id":"27eaa5d8.f85fea","type":"comment","z":"79179714.505328","name":"Send Protocol Connector &nbsp;Sensor Data to AWS IoT","info":"","x":260,"y":69.36331176757812,"wires":[]},{"id":"3dc94fa0.0fb2d","type":"comment","z":"79179714.505328","name":"Send Auto-Report Request to Internal MQTT","info":"","x":220,"y":296,"wires":[]},{"id":"f9b3112b.9e99a","type":"function","z":"79179714.505328","name":"messgae topic","func":"var device_id = 'DK10';\nvar plugin_id = msg.topic.replace(/^\\/cagent\\/admin\\/|\\/deviceinfo$/g, \"\");\nmsg.topic = 'protocol-conn/' + device_id + '/' + plugin_id;\nreturn msg;","outputs":1,"noerr":0,"x":350,"y":157.10000610351562,"wires":[["21def20a.3d43ae"]]},{"id":"a99e0e2f.e33a3","type":"mqtt out","z":"79179714.505328","name":"Auto-Report Request","topic":"","qos":"0","retain":"false","broker":"7c9c4d87.a21bd4","x":692.0001220703125,"y":401,"wires":[]},{"id":"d10bad11.60342","type":"mqtt in","z":"79179714.505328","name":"Handler Registered","topic":"/cagent/admin/+/agentinfoack","qos":"2","broker":"7c9c4d87.a21bd4","x":160,"y":364.8398742675781,"wires":[["e0848357.efe7a"]]},{"id":"e0848357.efe7a","type":"function","z":"79179714.505328","name":"pakcage auto report command","func":"var auto_rpt_msg = function(device) {\n &nbsp; &nbsp;return {\n &nbsp; &nbsp; &nbsp; &nbsp;topic: \"/cagent/admin/\" + device + \"/agentcallbackreq\",\n &nbsp; &nbsp; &nbsp; &nbsp;payload: {\n &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;\"susiCommData\": {\n &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;\"commCmd\": 2053,\n &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;\"requestItems\": {\"All\":{}},\n &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;\"autoUploadIntervalSec\": 10,\n &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;\"handlerName\": \"general\"\n &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;}\n &nbsp; &nbsp; &nbsp; &nbsp;}\n &nbsp; &nbsp;};\n};\n\nvar registered = context.get(\"registered\") || [];\nvar dev_id = msg.topic.replace(/^\\/cagent\\/admin\\/|\\/agentinfoack$|\\/notify$/g, \"\");\nvar is_reg_msg = (\n &nbsp; &nbsp;msg.topic.endsWith(\"agentinfoack\") && JSON.parse(msg.payload).susiCommData.status\n);\nvar msg_out = (is_reg_msg || (!~registered.indexOf(dev_id)))? auto_rpt_msg(dev_id): null;\n\nif(!~registered.indexOf(dev_id)) {\n &nbsp; &nbsp;registered.push(dev_id);\n}\n\ncontext.set(\"registered\", registered);\nreturn msg_out;\n","outputs":1,"noerr":0,"x":418.0195617675781,"y":401.00390625,"wires":[["a99e0e2f.e33a3"]]},
{"id":"f7640bf7.c78ab8","type":"comment","z":"d652f017.65e74","name":"Send Protocol Connector Sensor Data to AWS IoT","info":"","x":260,"y":69.36331176757812,"wires":[]},
+
{"id":"5b81aa8.282ba54","type":"mqtt in","z":"79179714.505328","name":"Handler Heartbeat","topic":"/cagent/admin/+/notify","qos":"2","broker":"7c9c4d87.a21bd4","x":157,"y":438,"wires":[["e0848357.efe7a"]]},
{"id":"f6c0c463.1d1928","type":"comment","z":"d652f017.65e74","name":"Send Auto-Report Request to Internal MQTT","info":"","x":220,"y":296,"wires":[]},
+
{"id":"21def20a.3d43ae","type":"AWS IotData","z":"79179714.505328","aws":"b610e400.9f9db8","operation":"Publish","thingName":"","topic":"","payload":"","endPoint":"","name":"","x":535,"y":156.75,"wires":[[]]},
{"id":"5651a33f.5722bc","type":"function","z":"d652f017.65e74","name":"messgae topic","func":"var device_id = 'DK10';\nvar plugin_id = msg.topic.replace(/^\\/cagent\\/admin\\/|\\/deviceinfo$/g, \"\");\nmsg.topic = 'protocol-conn/' + device_id + '/' + plugin_id;\nreturn msg;","outputs":1,"noerr":0,"x":350,"y":157.10000610351562,"wires":[["bb0580c5.75a24"]]},{"id":"b74f9d97.3e912","type":"mqtt out","z":"d652f017.65e74","name":"Auto-Report Request","topic":"","qos":"0","retain":"false","broker":"22aa981b.46a50c","x":692.0001220703125,"y":401,"wires":[]},
+
{"id":"7c9c4d87.a21bd4","type":"mqtt-broker","z":"","broker":"127.0.0.1","port":"1883","clientid":"","usetls":false,"compatmode":true,"keepalive":"60","cleansession":true,"willTopic":"","willQos":"0","willPayload":"","birthTopic":"","birthQos":"0","birthPayload":""},
{"id":"828deeb3.bd324","type":"mqtt in","z":"d652f017.65e74","name":"Handler Registered","topic":"/cagent/admin/+/agentinfoack","qos":"2","broker":"22aa981b.46a50c","x":160,"y":364.8398742675781,"wires":[["8e87ec7b.6487b"]]},
+
{"id":"b610e400.9f9db8","type":"amazon config","z":"","name":"AWS","region":"us-east-1"}
{"id":"8e87ec7b.6487b","type":"function","z":"d652f017.65e74","name":"pakcage auto report command","func":"var auto_rpt_msg = function(device) {\n   return {\n       topic: \"/cagent/admin/\" + device + \"/agentcallbackreq\",\n       payload: {\n           \"susiCommData\": {\n               \"commCmd\": 2053,\n               \"requestItems\": {\"All\":{}},\n               \"autoUploadIntervalSec\": 10,\n               \"handlerName\": \"general\"\n           }\n       }\n   };\n};\n\nvar registered = context.get(\"registered\") || [];\nvar dev_id = msg.topic.replace(/^\\/cagent\\/admin\\/|\\/agentinfoack$|\\/notify$/g, \"\");\nvar is_reg_msg = (\n   msg.topic.endsWith(\"agentinfoack\") && JSON.parse(msg.payload).susiCommData.status\n);\nvar msg_out = (is_reg_msg || (!~registered.indexOf(dev_id)))? auto_rpt_msg(dev_id)&nbsp;: null;\n\nif(!~registered.indexOf(dev_id)) {\n   registered.push(dev_id);\n}\n\ncontext.set(\"registered\", registered);\nreturn msg_out;\n","outputs":1,"noerr":0,"x":418.0195617675781,"y":401.00390625,"wires":[["b74f9d97.3e912"]]},{"id":"b06132d0.4baf6","type":"mqtt in","z":"d652f017.65e74","name":"Handler Heartbeat","topic":"/cagent/admin/+/notify","qos":"2","broker":"22aa981b.46a50c","x":157,"y":438,"wires":[["8e87ec7b.6487b"]]},
+
]
{"id":"bb0580c5.75a24","type":"AWS IotData","z":"d652f017.65e74","aws":"20e9a430.34135","operation":"Publish","thingName":"","topic":"","payload":"","endPoint":"","name":"","x":535,"y":156.75,"wires":[[]]},{"id":"22aa981b.46a50c","type":"mqtt-broker","z":"","broker":"127.0.0.1","port":"1883","clientid":"","usetls":false,"compatmode":true,"keepalive":"60","cleansession":true,"willTopic":"","willQos":"0","willPayload":"","birthTopic":"","birthQos":"0","birthPayload":""},
 
{"id":"20e9a430.34135","type":"amazon config","z":"","name":"AWS","region":"us-east-1"}]
 
 
</pre>
 
</pre>
  
 
*Switch to Protocol Converter tab and double click “IotData Publish” node to set device configuration.
 
*Switch to Protocol Converter tab and double click “IotData Publish” node to set device configuration.
 
 
*Click [[File:Button NR.png|button_NR.png]]&nbsp;button[[File:2018-02-13 145112.png|center|2018-02-13_145112.png]]
 
*Click [[File:Button NR.png|button_NR.png]]&nbsp;button[[File:2018-02-13 145112.png|center|2018-02-13_145112.png]]
 
 
  
 
&nbsp;
 
&nbsp;
Line 635: Line 497:
 
[[File:2018-02-13 144939.png|center|2018-02-13_144939.png]]
 
[[File:2018-02-13 144939.png|center|2018-02-13_144939.png]]
  
 +
*Check your message topic&nbsp;on the "message&nbsp;topic' function node[[File:15-2.png|center|1000px|15-2.png]]
  
 
 
 
*Check your message topic&nbsp;on the "message&nbsp;topic' function node[[File:15-2.png|center|1000px|15-2.png]]
 
 
*Enter {your device id} in device_id, you can choose {your device id} which you want.
 
*Enter {your device id} in device_id, you can choose {your device id} which you want.
  
Line 652: Line 511:
 
[[File:18-2.png|center|1000px|18-2.png]]
 
[[File:18-2.png|center|1000px|18-2.png]]
  
*Go back to AWS IoT menu
+
*>Go back to AWS IoT menu
 
*click “Test” and enter Subscription&nbsp;topic click [[File:Subscription.png|Subscription.png]]
 
*click “Test” and enter Subscription&nbsp;topic click [[File:Subscription.png|Subscription.png]]
 +
 
*For more information, see&nbsp; <references /><references /><references />[https://docs.aws.amazon.com/iot/latest/developerguide/topics.html https://docs.aws.amazon.com/iot/latest/developerguide/topics.html]
 
*For more information, see&nbsp; <references /><references /><references />[https://docs.aws.amazon.com/iot/latest/developerguide/topics.html https://docs.aws.amazon.com/iot/latest/developerguide/topics.html]
  
 
[[File:2018-02-13 152730.png|center|1000px|2018-02-13_152730.png]]
 
[[File:2018-02-13 152730.png|center|1000px|2018-02-13_152730.png]]
 
 
  
 
*if your settings is correct, then you can see the message in this area.
 
*if your settings is correct, then you can see the message in this area.
  
[[File:2018-02-13 152741.png|center|1000px|2018-02-13_152741.png]]
+
[[File:2018-02-13 152741.png|center|1000px|2018-02-13_152741.png]] &nbsp; &nbsp;
 
 
 
 
 
 
&nbsp;
 
 
 
&nbsp;
 
  
=== Connect device and data to AWS for Windows device – Protocol Converter using Greengrass ===
+
=== Connect device and data to AWS for Linux Ubuntu device – Protocol Converter using Greengrass ===
  
 
==== Prerequisites ====
 
==== Prerequisites ====
  
AWS Account
+
AWS Account Linux Host OS version&nbsp;: Ubuntu 16.04 x64 [[#Basic_Requirment:|Protocol Converter installation steps]]
 
 
Linux Host
 
 
 
OS version&nbsp;: Ubuntu 16.04 x64
 
 
 
[[#Basic_Requirment:|Protocol Converter installation steps]]
 
  
 
==== Create Greengrass Group ====
 
==== Create Greengrass Group ====
  
Using the AWS IoT console, create an AWS IoT thing, certificate, and policy for your AWS Greengrass core device:
+
Using the AWS IoT console, create an AWS IoT thing, certificate, and policy for your AWS Greengrass core device: &nbsp; Step 1. Go to the AWS IoT console and click Greengrass. [[File:2018-02-07 105949.png|center|1000px|2018-02-07_105948.png]] [[File:2018-02-07 110140.png|center|1000px|2018-02-07_110140.png]]
 
 
&nbsp;
 
  
Step 1. Go to the AWS IoT console and click Greengrass.
+
Step 2. Create an AWS Greengrass group and name it GGC [[File:2018-02-07 110247.PNG|center|1000px|2018-02-07_110247.png]]Step 3. Create an AWS IoT for Greengrass core [[File:2018-02-07 110257.png|center|1000px|2018-02-07_110247.png]] Step 4. One-click to create Greengrass certificate and attach policy. [[File:2018-02-07 110405.png|center|1000px|2018-02-07_110405.png]] Step 5. Download Certificate and Greengrass config. <span style="color:#FF8C00;">This Certificate will be used later for&nbsp;setup AWS IoT device.</span>[[File:2018-02-07 110435.png|center|1000px|2018-02-07_110435.png]]
  
[[File:2018-02-07 105949.png|center|1000px|2018-02-07_105948.png]] [[File:2018-02-07 110140.png|center|1000px|2018-02-07_110140.png]]
 
  
Step 2. Create an AWS Greengrass group and name it GGC [[File:2018-02-07 110247.PNG|center|1000px|2018-02-07_110247.png]] Step 3. Create an AWS IoT for Greengrass core [[File:2018-02-07 110257.png|center|1000px|2018-02-07_110257.png]] Step 3. Create an AWS IoT for Greengrass core [[File:2018-02-07 110257.png|center|1000px|2018-02-07_110247.png]] Step 4. One-click to create Greengrass certificate and attach policy. [[File:2018-02-07 110405.png|center|1000px|2018-02-07_110405.png]] Step 5. Download Certificate and Greengrass config. <span style="color:#FF8C00;">This Certificate will be used later for&nbsp;setup AWS IoT device.</span>[[File:2018-02-07 110435.png|center|1000px|2018-02-07_110435.png]]
 
  
 
==== Setup Greengrass Group ====
 
==== Setup Greengrass Group ====
Line 704: Line 546:
 
===== Add Device to Your Group =====
 
===== Add Device to Your Group =====
  
Step 1.Go to the AWS IoT console.
+
Step 1.Go to the AWS IoT console. Step 2.In the navigation pane, select Greengrass and then Groups. Step 3.Click on your group, "GGC" Step 4.In the navigation pane, click '''Devices '''and then '''Add Device'''. [[File:2018-02-07 114426.png|center|1000px|2018-02-07_114426.png]]
 
 
Step 2.In the navigation pane, select Greengrass and then Groups.
 
 
 
Step 3.Click on your group, ''GGC''
 
 
 
Step 4.In the navigation pane, click '''Devices '''and then '''Add Device'''. [[File:2018-02-07 114426.png|center|1000px|2018-02-07_114426.png]]
 
  
 
Step 5. Enter AWS IoT Name Device and click Next [[File:2018-02-07 114443.png|center|1000px|2018-02-07_114443.png]]
 
Step 5. Enter AWS IoT Name Device and click Next [[File:2018-02-07 114443.png|center|1000px|2018-02-07_114443.png]]
Line 717: Line 553:
  
 
Step 7. Download certificate and finish this process.<span style="color:#FF8C00;">&nbsp;This Certificate will be used for running GreenGrass Core.</span>[[File:2018-02-07 114508.png|center|1000px|2018-02-07_114508.png]]
 
Step 7. Download certificate and finish this process.<span style="color:#FF8C00;">&nbsp;This Certificate will be used for running GreenGrass Core.</span>[[File:2018-02-07 114508.png|center|1000px|2018-02-07_114508.png]]
 
 
  
 
===== Add Subscriptions to Your Group =====
 
===== Add Subscriptions to Your Group =====
  
Step 1.In the navigation pane, click Subscriptions and then Add Subscription.
+
Step 1.In the navigation pane, click Subscriptions and then Add Subscription. [[File:SubscriptionAdd.png|center|700px|SubscriptionAdd.png]]
 
 
[[File:SubscriptionAdd.png|center|700px|SubscriptionAdd.png]]
 
 
 
Step 2.Under Select a source, select the source of the subscription and click on Next.
 
  
[[File:Subscription1.png|center|700px|Subscription1.png]]
+
Step 2.Under Select a source, select the source of the subscription and click on Next. [[File:Subscription1.png|center|700px|Subscription1.png]]
 
 
Step 3.Under Select a target, select the target of the subscription and click on Next.
 
  
 +
Step 3.Under Select a target, select the target of the subscription and click on Next.
 
[[File:Subscription2.png|center|700px|Subscription2.png]]
 
[[File:Subscription2.png|center|700px|Subscription2.png]]
  
Step 4.In the Optional topic filter, type the topic of the subscription <span style="color:#FF8C00;">" topic/MQTT "</span>.
+
Step 4.In the Optional topic filter, type the topic of the subscription <span style="color:#FF8C00;">" topic/MQTT "</span>. [[File:Subscription3.png|center|700px|Subscription3.png]]
 
 
[[File:Subscription3.png|center|700px|Subscription3.png]]
 
 
 
Step 5.Click on finish to confirm and save subscription.
 
  
[[File:Subscription4.png|center|700px|Subscription4.png]]
+
Step 5.Click on finish to confirm and save subscription. [[File:Subscription4.png|center|700px|Subscription4.png]]
  
Step 6.Review the subscription information.
+
Step 6.Review the subscription information. [[File:Subscription done.png|center|700px|Subscription done.png]]
 
 
[[File:Subscription done.png|center|700px|Subscription done.png]]
 
  
 
==== Run Greengrass Core in Your Device ====
 
==== Run Greengrass Core in Your Device ====
  
/greengrass&nbsp;is located under Installer folder, e.g. {$Unzip Path} is ~/Desktop/Installer/packages/AWS/EISGCC&nbsp;
+
/greengrass&nbsp;is located under Installer folder, e.g. {$Unzip Path} is ~/Desktop/Installer/packages/AWS/EISXGCC&nbsp; <br />
 
 
To configure your core to recognize the AWS IoT thing, update the /greengrass/config/config.json file. and /greengrass/certs.
 
 
 
Copy certs and config with root permission, <span style="color:#FF8C00;">use the certificate for GreenGrass Core</span>.
 
 
 
Step 1.sudo cp -R certs/ {$Unzip Path}/greengrass/
 
 
 
Step 2.sudo cp -R conf/ {$Unzip Path}/greengrass/
 
  
Step 3.sudo cp root.ca.pem {$Unzip Path}/greengrass/certs/
+
To configure your core to recognize the AWS IoT thing, update the /greengrass/config/config.json file. and /greengrass/certs.<br />
  
<span style="color:#888888;">root.ca.pem is just located under&nbsp;{$Unzip Path}. If the original file under&nbsp;{$Unzip Path} is root-ca.pem, just rename it to root.ca.pem after copying to&nbsp;{$Unzip Path}/greengrass/certs/</span>
+
Copy certs and config with root permission, <span style="color:#FF8C00;">use the certificate for GreenGrass Core</span>.<br />
  
 +
Step 1.sudo cp -R certs/ {$Unzip Path}/greengrass/ <br />
 +
Step 2.sudo cp -R config/ {$Unzip Path}/greengrass/ <br />
 +
Step 3.sudo cp root.ca.pem {$Unzip Path}/greengrass/certs/ <br />
 +
<span style="color:#888888;">root.ca.pem is just located under&nbsp;{$Unzip Path}.<br />
 +
If the original file under&nbsp;{$Unzip Path} is root-ca.pem, just rename it to root.ca.pem after copying to&nbsp;{$Unzip Path}/greengrass/certs/</span>
 +
<br />
 
<span style="color:#888888;"># mv root-ca.pem root.ca.pem</span>
 
<span style="color:#888888;"># mv root-ca.pem root.ca.pem</span>
  
 +
The Greengrass core software is installed inside the /'''greengrass''' directory of your device.
  
 
+
Step 1.Make sure your device is connected to the Internet. <br />
&nbsp;The Greengrass core software is installed inside the /'''greengrass''' directory of your device.
+
Step 2.sudo {$Unzip Path}/greengrass/ggc/core/greengrassd start [[File:Greengrassrun.png|center|1000px|greengrassrun.png]]
 
 
Step 1.Make sure your device is connected to the Internet.
 
 
 
Step 2.sudo {$Unzip Path}/greengrass/ggc/core/greengrassd start
 
 
 
[[File:Greengrassrun.png|center|1000px|greengrassrun.png]]
 
  
 
==== Deploy Your Greengrass Group ====
 
==== Deploy Your Greengrass Group ====
  
After running Greengrass core, you can deploy your Greengrass group to your device.
+
After running Greengrass core, you can deploy your Greengrass group to your device. <br />
 
+
Step 1.Go to the AWS IoT console. <br />
Step 1.Go to the AWS IoT console.
+
Step 2.In the navigation pane, select Greengrass and then Groups. <br />
 
+
Step 3.Click on your group, GGC. <br />
Step 2.In the navigation pane, select Greengrass and then Groups.
+
Step 4.In the navigation pane, click Deployments. <br />
 
+
Step 5.Click Actions > Deploy. &nbsp; [[File:2018-02-01 135700.png|center|1000px|2018-02-01_135700.png]]
Step 3.Click on your group, GGC.
 
 
 
Step 4.In the navigation pane, click Deployments.
 
 
 
Step 5.Click Actions > Deploy.
 
 
 
&nbsp;
 
 
 
[[File:2018-02-01 135700.png|center|1000px|2018-02-01_135700.png]]
 
  
 
Step 6.In the Configure how Devices discover your Core select Automatic detection. [[File:2018-02-01 135720.png|center|1000px|2018-02-01_135720.png]]
 
Step 6.In the Configure how Devices discover your Core select Automatic detection. [[File:2018-02-01 135720.png|center|1000px|2018-02-01_135720.png]]
Line 800: Line 607:
 
==== Set Up Your AWS IoT Things ====
 
==== Set Up Your AWS IoT Things ====
  
When Greengrass group is deployed successful. You can setup AWS IoT '''Device '''which is defined in Greengrass group with Protocol Converter.
+
When Greengrass group is deployed successful. You can setup AWS IoT '''Device '''which is defined in Greengrass group with Protocol Converter. &nbsp;
 
 
&nbsp;
 
  
 
AWS IoT devices need certificates to authenticate with AWS IoT and retrieve the connectivity information of your Greengrass core. You downloaded these certificates in '''Add devices to your group''' Create device things.
 
AWS IoT devices need certificates to authenticate with AWS IoT and retrieve the connectivity information of your Greengrass core. You downloaded these certificates in '''Add devices to your group''' Create device things.
Line 808: Line 613:
 
==== Install Your IoT Thing Certificate ====
 
==== Install Your IoT Thing Certificate ====
  
<span style="color:#FF8C00;">Use Certificate for setup AWS IoT device.</span>
+
<span style="color:#FF8C00;">Use Certificate for setup AWS IoT device.</span><br/>cp root-ca.pem {$Unzip Path}/ProtocolConnectorSample/certs<br/>cp &lt;id&gt;.cert.pem&nbsp;{$Unzip Path}/ProtocolConnectorSample/certs<br/>cp &lt;id&gt;.private.key {$Unzip Path}/ProtocolConnectorSample/certs
 
 
cp root-ca.pem {$Unzip Path}/ProtocolConnectorSample/certs
 
 
 
cp &lt;id&gt;.cert.pem&nbsp;{$Unzip Path}/ProtocolConnectorSample/certs
 
 
 
cp &lt;id&gt;-private.key {$Unzip Path}/ProtocolConnectorSample/certs
 
  
 
==== Configure The Samples ====
 
==== Configure The Samples ====
  
Inside the ProtocolConnectorSample/config/ directory you can find the configuration files&nbsp;<span style="color:#FF8C00;">SampleConfig.json</span>&nbsp;for your things:
+
Inside the ProtocolConnectorSample/config/ directory you can find the configuration files&nbsp;<span style="color:#FF8C00;">SampleConfig.json</span>&nbsp;for your things: <br />
 
+
1. Please find your endpoint in Settings page in AWS IoT Console. <br />
1. Please find your endpoint in Settings page in AWS IoT Console.
+
2. Fill in relative path of root-ca.pem. <br />
 
+
3. Fill in relative path of &lt;id&gt;.cert.pem. <br />
2. Fill in relative path of root-ca.pem.
+
4. Fill in relatvie path of &lt;id&gt;.private.key <br />
 
+
5. Fill in your device name that you added for GreenGrass group&nbsp;in the following three fields. [[File:Screenshot from 2018-02-09 16-17-16.png|center|2018-02-09 16-17-16.png]]
3. Fill in relative path of &lt;id&gt;.cert.pem.
 
 
 
4. Fill in relatvie path of &lt;id&gt;.private.key
 
 
 
5. Fill in your device name that you added for GreenGrass group&nbsp;in the following three fields.
 
 
 
[[File:Screenshot from 2018-02-09 16-17-16.png|center|2018-02-09 16-17-16.png]]
 
  
 
==== Run the Protocol Converter Sample ====
 
==== Run the Protocol Converter Sample ====
  
After setting AWS IoT you can execute protocol converter sample,
+
After setting AWS IoT you can execute protocol converter sample, In the ProtocolConnectorSample folder <br />
 +
./MQTTAgent-sample [[File:Screenshot from 2018-02-09 16-18-09.png|center|2018-02-09 16-18-09.png]]
  
In the ProtocolConnectorSample folder
+
= IoT connectivity =
  
./MQTTAgent-sample
 
 
[[File:Screenshot from 2018-02-09 16-18-09.png|center|2018-02-09 16-18-09.png]]
 
 
= IoT connectivity =
 
 
== How to use SUSI (Advantech HW information) plugin ==
 
== How to use SUSI (Advantech HW information) plugin ==
  
Line 851: Line 639:
 
Please visit [http://ess-wiki.advantech.com.tw/view/Modbus_Service#Configuration this page] for more details and plugin configuration.
 
Please visit [http://ess-wiki.advantech.com.tw/view/Modbus_Service#Configuration this page] for more details and plugin configuration.
  
== [[OPC-UA_Service|How to use OPC-UA plugin]] ==
+
== How to use OPC-UA plugin ==
 +
 
 +
Currently our OPC-UA plugin is only available on Windows platform. Please visit&nbsp;[http://ess-wiki.advantech.com.tw/view/OPC-UA_Service this page]&nbsp;for more details and plugin configuration.
 +
 
 +
== How to use PMQ plugin ==
  
== [[PMQ_Architecture|How to use PMQ plugin]] ==
+
Advantech storage PMQ solution includes the&nbsp;deployment'''&nbsp;'''of the trained model to&nbsp;make predictions&nbsp;and&nbsp;visualization'''&nbsp;'''UI, and&nbsp;recommendations'''&nbsp;'''for corresponding strategies. Except storage PMQ service for Advantech hardware, the objective is to provide software developers basic concepts and better understating of PMQ deployment and to be&nbsp;more effective&nbsp;to bring your predictive model to production with Advantech PMQ architecture.
  
===  ===
+
Visit [http://ess-wiki.advantech.com.tw/view/PMQ_Architecture this page] for more details.
  
 
= Release =
 
= Release =
  
Pages with broken file links
+
Pages under construction...

Latest revision as of 11:36, 12 September 2018

Contents

Introduction

    WISE-PaaS/EdgeSense is an edge intelligence and sensing integration software solution that incorporates sensor data aggregation, cloud applications, edge analytics, and secure end-to-end data protection for fast and easy device-to-cloud operation. “Protocol Converter” is one of the major part of EdgeSense, it is an all-in-one message broker service which collects sensor data via various industrial protocols and then upload to cloud.

Installation Guide

For Windows Device

How To Install

  • Step 1. Execute EdgeSense installer, click "Next >".

RTENOTITLE

  • Step 2. Select "I accept the ..." then click "Next >".

RTENOTITLE

  • Step 3. Select any cloud you would like to connect then click "Next >". (here we take WISE-PaaS/EnSaaS and RMM as example for below steps)

RTENOTITLE

  • Step 4. Click "Next >".

RTENOTITLE

  • Step 5. Click "Install".

RTENOTITLE

  • Step 6. Wait for installation finished.

RTENOTITLE

  • Step 7. Select "I agree to the ..." then click "Install".

RTENOTITLE

  • Step 8. Select "I agree to the ..." then click "Install".

RTENOTITLE

  • Step 9. Click "Finish". Now you have necessary component and agent installed in your device.

RTENOTITLE

For Linux Ubuntu ( Docker version )

Basic Requirment:

  • Host OS must be Linux Distribution (we developed and tested our software offering with Ubuntu 16.04 environment so below content is referring to this specific Linux distribution.)
  • Docker Engine - Installation Guide ( Ubuntu )
  • Docker compose - Installation Guid
  • Hardward: Advantech x86_64 Platforms ( e.g. ARK-2121L...)

How To Install and Run - Protocol Converter Docker Container Services

# unzip installation package
tar zxvf EdgeSense_1.0.2.tar.gz
# Follow the readme to install your converter protocol

How To modify EnSaaS ID/Password and resart

# To fill your "IoTKey" then save and exit 
 <IoTKey>304a99b5b452444c749a83bbb9e35dpow</IoTKey>
$cd {Installed path}/Installer/packages/Plugins/docker-edgesense-image-x86/EdgeSense/AgentService/config/
$sudo vim agent_config.xml
$sudo docker restart ensaas-ei-agent

How To config Modbus and resart service

$cd {Installed path}/Installer/packages/Plugins/docker-edgesense-image-x86/EdgeSense/EService-Modbus/config/
$sudo vim Modbus_Handler.ini
$sudo docker restart service-modbus

How To Restart Service

// MQTT-BUS
$sudo docker restart advigw-mqtt-bus

// Node-RED
$sudo docker restart advigw-node-red

// Modbus_Handler Service
$sudo docker restart service-modbus

// HDD PMQ
$sudo docker restart service-hddpmq

// SUSIControl
$sudo docker restart service-susi

How To Uninstall Edgent Sense Docker Image

$cd {Installed path}/Installer/packages/Plugins/docker-edgesense-image-x86/
$sudo ./deploy.sh rmi

Cloud

WISE-PaaS/EnSaaS

WISE-PaaS/EnSaaS is an open and standardized industrial IoT platform provided by Advantech Corp., and EdgeSense leverages cloud services on top of it to offer device management and visualization service.

You will be re-directed to WISE-PaaS online documentation site via below links.

Register account on EdgesSense Portal

Please visit this page for step by step instruction.

How to Connect Edge Devices to RMM Cloud

Please visit this page for step by step instruction.

Azure

Create Azure IoT Hub

To utilize Azure services, we need a Microsoft account to log in to azure portal. Following steps will create an azure iot hub to communicate with Advantech protocol converter modules.

Step 1. Log in to Microsoft Azure Portal

Step 2. Create a resource group

  • Search “resource group” and create new one
create-rg.png
  • Input resource group name: protocol-conn-rg (for example)
  • Select a location (service region): East Asia (for example)
create-rg-detail.png

Step 3. Create an azure iot hub

  • Search “iot hub” and create new one
create-hub.png
  • Select Resource group created at step 2: click “Use existing” and select “protocol-conn-rg
  • Select Region: East Asia
  • Input IoT hub name: protocol-con-hub (for example)
  • Click on Review+Create
iot_hub.png
  • Click on Create
iot_hub2.png

Connect device and data to Azure for Windows device – Protocol Converter Using Node-RED

Cloud Environment Setup

Following steps will create an azure iot device to connect to iot hub created at previous section.

Step 1. Go to iot hub created at previous section: Resource groups → protocol-conn-rg → Overview → protocol-con-rg (for example)

iot_device0

Step 2. IoT Devices → Add

select conn hub
  • Device ID: protocol-conn-device (for example)
  • Authentication Type: select “Symmetric Key” for this tutorial
  • Check “Auto Generate Keys”
  • Connect device to IoT Hub: select “Enable”
  • Save the configurations
add_device
  • Select the created iot device to get device connection string
iot_device
  • Click save-icon.png to copy “Connection string-primary key” and make sure the "Connect device to IoT Hub" is "Enable"

          "Connection string-primary key" will be used later in Node-Red "Connection String" field.

iot_device2
  • Save the connection string in a text file for later use
save-conn-string

Device Environment Setup

Following steps will configure device Node-RED nodes to enable communications between Advantech protocol converter modules and azure iot hub.

Step 1. Open Node-RED page in the web browser (default URI is http://127.0.0.1:1880)

nr main

Step 2. Copy following content and import it into Node-RED

        [
            {"id": "ce169f53.786dd" , "type": "tab", "label": "Protocol Connector ", "disabled": false, "info": ""},
            {"id": "104120.85f37ee" , "type": "mqtt in", "z": "ce169f53.786dd", "name": "Data Recieved", "topic": "/cagent/admin/+/deviceinfo", "qos": "2", "broker": "23acb8c5.a15ad8", "x": 150, "y": 132, "wires": [["12642914.e549c7", "95d1843d.e8a5c8"]]},
            {"id": "97d0f87d.614ea8", "type": "mqtt out", "z": "ce169f53.786dd", "name": "Auto-Report Request", "topic": "", "qos": "0", "retain": "false", "broker": "23acb8c5.a15ad8", "x": 692.0001220703125, "y": 401, "wires": []},
            {"id": "12642914.e549c7", "type": "debug", "z": "ce169f53.786dd", "name": "", "active": true, "console": "false", "complete": "payload", "x": 340, "y": 112, "wires": []},
            {"id": "6bacc623.4bc318", "type": "comment", "z": "ce169f53.786dd", "name": "Send Protocol Connector  Sensor Data to Azure IoT Hub", "info": "", "x": 270, "y": 69.36331176757812, "wires": []},
            {"id": "4a9698eb.3deed8", "type": "comment", "z": "ce169f53.786dd", "name": "Send Auto-Report Request to Internal MQTT", "info": "", "x": 240, "y": 296, "wires": []},
            {"id": "3a7f0c9.34066f4", "type": "mqtt in", "z": "ce169f53.786dd", "name": "Handler Registered", "topic": "/cagent/admin/+/agentinfoack", "qos": "2", "broker": "23acb8c5.a15ad8", "x": 160, "y": 364.8398742675781, "wires": [["3cd5a503.a6b2ca"]]},
            {"id": "3cd5a503.a6b2ca", "type": "function", "z": "ce169f53.786dd", "name": "pack auto report command", "func": "var auto_rpt_msg = function(device) {\n    return {\n        topic: \"/cagent/admin/\" + device + \"/agentcallbackreq\",\n        payload: {\n            \"susiCommData\": {\n                \"commCmd\": 2053,\n                \"requestItems\": {\"All\":{}},\n                \"autoUploadIntervalSec\": 10,\n                \"handlerName\": \"general\"\n            }\n        }\n    };\n};\n\nvar registered = context.get(\"registered\") || [];\nvar dev_id = msg.topic.replace(/^\\/cagent\\/admin\\/|\\/agentinfoack$|\\/notify$/g, \"\");\nvar is_reg_msg = (\n    msg.topic.endsWith(\"agentinfoack\") && JSON.parse(msg.payload).susiCommData.status\n);\nvar msg_out = (is_reg_msg || (!~registered.indexOf(dev_id)))? auto_rpt_msg(dev_id) : null;\n\nif(!~registered.indexOf(dev_id)) {\n    registered.push(dev_id);\n}\n\ncontext.set(\"registered\", registered);\nreturn msg_out;\n", "outputs": 1, "noerr": 0, "x": 418.0195617675781, "y": 401.00390625, "wires": [["97d0f87d.614ea8"]]},
            {"id": "95d1843d.e8a5c8", "type": "azureiothub", "z": "ce169f53.786dd", "name": "Send to Azure IoT Hub", "protocol": "http", "x": 370, "y": 152, "wires": [["ecc11415.86a138"]]},
            {"id": "ecc11415.86a138", "type": "debug", "z": "ce169f53.786dd", "name": "", "active": true, "console": "false", "complete": "payload", "x": 601.5, "y": 151.29998779296875, "wires": []},
            {"id": "bf50c923.03a288", "type": "comment", "z": "ce169f53.786dd", "name": "Display Cloud to Device Messages", "info": "", "x": 671, "y": 192, "wires": []},
            {"id": "71829e36.9c78c" , "type": "mqtt in", "z": "ce169f53.786dd", "name": "Handler Heartbeat", "topic": "/cagent/admin/+/notify", "qos": "2", "broker": "23acb8c5.a15ad8", "x": 157, "y": 438, "wires": [["3cd5a503.a6b2ca"]]},
            {"id": "23acb8c5.a15ad8", "type": "mqtt-broker", "z": "", "broker": "127.0.0.1", "port": "1883", "clientid": "", "usetls": false, "compatmode": true, "keepalive": "60", "cleansession": true, "willTopic": "", "willQos": "0", "willPayload": "", "birthTopic": "", "birthQos": "0", "birthPayload": ""}
        ]
import nr flow

Step 3. Select "Protocol Converter" tab and double click "Send to Azure IoT Hub" node to configure node settings.

select nr node

Step 4. Copy the saved device "Connection String" and paste to "Connection String" field

select nr conn string
Step 5. Click deploy icon to complete edge device environment setups and make sure the states of MQTT nodes are "connected"
nr deployed

Step 6. Jump to Monitor Messages for further steps.

Connect device and data to Azure for Linux Ubuntu device – Protocol Converter Using IoT Edge

Prerequisites

Before to perform Azure IoT Edge environment setup steps, please make sure all following packages and tools are available and are correctly setup.

Linux Host

  • Docker:

1. Install Docker and check "docker" command is available. (the version number may be different).

prerequisites-docker-linux.png

Protocol Converter will install Python and IoT Edge Runtime Control Tool automatically, user could check the version to see if it's well installed. 

  • Python pip:

1. Install Python pip command.

        sudo apt-get install python-pip

2. Make sure the “pip” command is available.

prerequisites-win-python.png
  • IoT Edge Runtime Control Tool:

1. Install IoT Edge control script (may need to run as root)

        pip install -U azure-iot-edge-runtime-ctl==1.0.0rc17

2. Make sure the “iotedgectl” command is available. (the version number may be different)

prerequisites-win-iotedgectl.png

Cloud Environment Setup

Following steps will create an azure iot edge device at previously created iot hub.

Step 1. Create an iot edge device

  • Go to iot hub created at previous section: Resource groups → protocol-conn-rg → protocol-conn-hub
select conn hub
  • IoT Edge → Add IoT Edge Device
create-iotedge-device.png
  • Device ID: protocol-conn-device (for example)
  • Authentication Type: select “Symmetric Key” for this tutorial
  • Check “Auto Generate Keys
  • Connect device to IoT Hub: select “Enable
create-iotedge-device-details
  • Select the created iot edge device to get device connection string
select-iotedge-device
  • Click save-icon.png to copy “Connection string-primary key” and make sure the "Connect device to IoT Hub" is "Enable"
select-edge-device-conn-string
  • Save the connection string in a text file for later use
conn-string.png

Device Environment Setup

Following steps will configure edge device to bind to azure iot edge device previously created.

Step 1. Configure the iot edge runtime (need administrator privileges on windows 10 host or root privileges on linux host)

  • Open a command prompt and type following command. Replace "{your iot edge device connection string}" with the saved device connection string
        sudo iotedgectl setup --connection-string "{your iot edge device connection string}" --auto-cert-gen-force-no-passwords
iotedge-setup-linux
  • Start the IoT Edge runtime
        sudo iotedgectl start
iotedge-start-linux
  • Check Docker to see that the IoT Edge agent is running as a module
        sudo docker ps

Deploy an IoT edge device module to edge device

Step 1. Select iot edge device created at previous section

select-iotedge-device

Step 2. Set Modules → Add IoT Edge Module

add-iotedge-device-module.png
  • Name: protocol-connector-module
  • Image URI: advigw4x86/protocol-connector-azure-iot-edge:latest
  • Container Create Options:
  • In Windows host, paste following content
        {
            "Env": ["MQTT_HOST=10.0.75.1", "MQTT_PORT=1883"]
        }
  • In Linux host, paste following content
        {
            "Env": ["MQTT_HOST=172.17.0.1", "MQTT_PORT=1883"]
        }
  • Restart Policy: select “always
  • Desired Status: select “running
add-device-module-detail.png
  • Click “Next” to specify routes step
add-device-module-cont.png
  • Paste following content to specify route and click “Next” to review template
        {
            "routes": {
                "moduleToIoTHub": "FROM /messages/modules/protocol-connector-module/outputs/output1 INTO $upstream"
            }
        }
add-device-module-route.png
  • In the Review Template step, click “Submit”
add-device-module-template.png
  • Return to the IoT Edge device details page and click Refresh. The "protocol-connector-module" should be running along with the IoT Edge runtime
add-device-module-done.png

Monitor Messages

.Device to Cloud (D2C)

  • Get IoT Hub Connection String from below steps.
Step 1. Go to iot hub created at "Create Azure IoT Hub" section: Resource groups → protocol-conn-rg → protocol-conn-hub
select conn hub
Step 2. Click save-icon.png to copy iot hub connection string: Resource groups → Shared access policies → iothubowner → Connection String​
Share_access_policy
        npm install -g iothub-explorer

        iothub-explorer monitor-events {Your IoT Device id} --login "{your iot hub connection string}"
iothub-explorer-win
iothub-explorer-linux
When Installing iothub-explorer on Windows system, please use administrator role to execute cmd. Otherwise, the environment variable cannot be correctly written to the system. You can add the environment variable manually. 
iothub-explorer-win_1
iothub-explorer-win_2

Cloud to Device (C2D)

  • C2D message is not yet ready on IoT Edge public preview.
  • For Node-RED protocol converter modules, we can take following steps to send C2D messages.

Step 1. Open Node-RED in web browser, select Protocol Converter and click the debug tab

select c2d message

Step 2. Go to iot device created at previous section: Resource groups → protocol-conn-rg → protocol-conn-hub → protocol-conn-device, then select "Message To Device"

select c2d message

Step 3. Type our cloud to device messages in "Message Body" field then click "Send Message".

send select c2d message

Step 4. Back to Node-RED page, we can see the received message

receive c2d message

AWS

Connect device and data to AWS for Windows device – Protocol Converter using Node-Red

Prerequisites:

  • AWS account
  • this example use service which is region in US East (N. Virginia).

Cloud Environment Setup

Step 1.Return the AWS console and go to IAM menu.
IAM1.png
Step 2.Click “user” menu
IAM2.png
Step 3.Click “Add user” button
IAM3.png
Step 4.Enter your user name. In this example user name is “Adv_test”.→ chose Programmatic access → Click “Next Permissions” button.
IAM4png

Step 5.Click IAM_GP.png

Step 6.Choose AdministratorAccess → Click “Next: Review” button
IAM6.png
Step 7.Click “Create user”
IAM7.png

Step 8.Download the credentials. This is the last time these credentials will be available to download.

Step 9.Click “Download .csv” button
IAM8.png
Step 10. Go to AWS IoT Core.
AWS iot core.png
Step 11. Copy the endpoint from "Setting". The endpoint will be used in Node-Red setting later. Check if the region is N. Virginia before copying the endpint.
13 2.png

Device Environment Setup

In this section, you will install Advantech Node-Red tool for and Configurate the setting to connect AWS IoT

  •  click on desktop to open NodeRED in web browser
8.png

Set up edge device environment

  • Copy following NodeRED flow and import it into NodeRED:
[
{"id":"79179714.505328","type":"tab","label":"Protocol Connector ","disabled":false,"info":""},{"id":"d79da03e.4ac02","type":"mqtt in","z":"79179714.505328","name":"Data Recieved","topic":"/cagent/admin/+/deviceinfo","qos":"2","broker":"7c9c4d87.a21bd4","x":150,"y":132,"wires":[["f9b3112b.9e99a","d48faaf7.aded28"]]},
{"id":"d48faaf7.aded28","type":"debug","z":"79179714.505328","name":"","active":true,"console":"false","complete":"payload","x":340,"y":112,"wires":[]},{"id":"27eaa5d8.f85fea","type":"comment","z":"79179714.505328","name":"Send Protocol Connector  Sensor Data to AWS IoT","info":"","x":260,"y":69.36331176757812,"wires":[]},{"id":"3dc94fa0.0fb2d","type":"comment","z":"79179714.505328","name":"Send Auto-Report Request to Internal MQTT","info":"","x":220,"y":296,"wires":[]},{"id":"f9b3112b.9e99a","type":"function","z":"79179714.505328","name":"messgae topic","func":"var device_id = 'DK10';\nvar plugin_id = msg.topic.replace(/^\\/cagent\\/admin\\/|\\/deviceinfo$/g, \"\");\nmsg.topic = 'protocol-conn/' + device_id + '/' + plugin_id;\nreturn msg;","outputs":1,"noerr":0,"x":350,"y":157.10000610351562,"wires":[["21def20a.3d43ae"]]},{"id":"a99e0e2f.e33a3","type":"mqtt out","z":"79179714.505328","name":"Auto-Report Request","topic":"","qos":"0","retain":"false","broker":"7c9c4d87.a21bd4","x":692.0001220703125,"y":401,"wires":[]},{"id":"d10bad11.60342","type":"mqtt in","z":"79179714.505328","name":"Handler Registered","topic":"/cagent/admin/+/agentinfoack","qos":"2","broker":"7c9c4d87.a21bd4","x":160,"y":364.8398742675781,"wires":[["e0848357.efe7a"]]},{"id":"e0848357.efe7a","type":"function","z":"79179714.505328","name":"pakcage auto report command","func":"var auto_rpt_msg = function(device) {\n    return {\n        topic: \"/cagent/admin/\" + device + \"/agentcallbackreq\",\n        payload: {\n            \"susiCommData\": {\n                \"commCmd\": 2053,\n                \"requestItems\": {\"All\":{}},\n                \"autoUploadIntervalSec\": 10,\n                \"handlerName\": \"general\"\n            }\n        }\n    };\n};\n\nvar registered = context.get(\"registered\") || [];\nvar dev_id = msg.topic.replace(/^\\/cagent\\/admin\\/|\\/agentinfoack$|\\/notify$/g, \"\");\nvar is_reg_msg = (\n    msg.topic.endsWith(\"agentinfoack\") && JSON.parse(msg.payload).susiCommData.status\n);\nvar msg_out = (is_reg_msg || (!~registered.indexOf(dev_id)))? auto_rpt_msg(dev_id): null;\n\nif(!~registered.indexOf(dev_id)) {\n    registered.push(dev_id);\n}\n\ncontext.set(\"registered\", registered);\nreturn msg_out;\n","outputs":1,"noerr":0,"x":418.0195617675781,"y":401.00390625,"wires":[["a99e0e2f.e33a3"]]},
{"id":"5b81aa8.282ba54","type":"mqtt in","z":"79179714.505328","name":"Handler Heartbeat","topic":"/cagent/admin/+/notify","qos":"2","broker":"7c9c4d87.a21bd4","x":157,"y":438,"wires":[["e0848357.efe7a"]]},
{"id":"21def20a.3d43ae","type":"AWS IotData","z":"79179714.505328","aws":"b610e400.9f9db8","operation":"Publish","thingName":"","topic":"","payload":"","endPoint":"","name":"","x":535,"y":156.75,"wires":[[]]},
{"id":"7c9c4d87.a21bd4","type":"mqtt-broker","z":"","broker":"127.0.0.1","port":"1883","clientid":"","usetls":false,"compatmode":true,"keepalive":"60","cleansession":true,"willTopic":"","willQos":"0","willPayload":"","birthTopic":"","birthQos":"0","birthPayload":""},
{"id":"b610e400.9f9db8","type":"amazon config","z":"","name":"AWS","region":"us-east-1"}
]
  • Switch to Protocol Converter tab and double click “IotData Publish” node to set device configuration.
  • Click button_NR.png button
    2018-02-13_145112.png

 

  • Enter the Access Id and Secret Key which is on credentials .csv file.
11.png
  • Enter the Name “IoT Pubilsh” and Endpoint, Endpoint is copied in AWS IoT Core.
2018-02-13_144939.png
  • Check your message topic on the "message topic' function node
    15-2.png
  • Enter {your device id} in device_id, you can choose {your device id} which you want.
16-2.PNG
  • Click deploy.png to finish edge device environment setups.
17-2.png
  • Click NodeRED “Debug” tab, the sent messages will be displayed. 
18-2.png
  • >Go back to AWS IoT menu
  • click “Test” and enter Subscription topic click Subscription.png
2018-02-13_152730.png
  • if your settings is correct, then you can see the message in this area.
2018-02-13_152741.png
   

Connect device and data to AWS for Linux Ubuntu device – Protocol Converter using Greengrass

Prerequisites

AWS Account Linux Host OS version : Ubuntu 16.04 x64 Protocol Converter installation steps

Create Greengrass Group

Using the AWS IoT console, create an AWS IoT thing, certificate, and policy for your AWS Greengrass core device:   Step 1. Go to the AWS IoT console and click Greengrass.
2018-02-07_105948.png
2018-02-07_110140.png
Step 2. Create an AWS Greengrass group and name it GGC
2018-02-07_110247.png
Step 3. Create an AWS IoT for Greengrass core
2018-02-07_110247.png
Step 4. One-click to create Greengrass certificate and attach policy.
2018-02-07_110405.png
Step 5. Download Certificate and Greengrass config. This Certificate will be used later for setup AWS IoT device.
2018-02-07_110435.png


Setup Greengrass Group

To define your Greengrass group, follow these steps:

  1. Add devices to your group
  2. Add Lambda functions to your group
  3. Add subscriptions to your group
Add Device to Your Group
Step 1.Go to the AWS IoT console. Step 2.In the navigation pane, select Greengrass and then Groups. Step 3.Click on your group, "GGC" Step 4.In the navigation pane, click Devices and then Add Device.
2018-02-07_114426.png
Step 5. Enter AWS IoT Name Device and click Next
2018-02-07_114443.png
Step 6. Using default setting to quick create access permissions and certificate.
2018-02-07_114456.png
Step 7. Download certificate and finish this process. This Certificate will be used for running GreenGrass Core.
2018-02-07_114508.png
Add Subscriptions to Your Group
Step 1.In the navigation pane, click Subscriptions and then Add Subscription.
SubscriptionAdd.png
Step 2.Under Select a source, select the source of the subscription and click on Next.
Subscription1.png

Step 3.Under Select a target, select the target of the subscription and click on Next.

Subscription2.png
Step 4.In the Optional topic filter, type the topic of the subscription " topic/MQTT ".
Subscription3.png
Step 5.Click on finish to confirm and save subscription.
Subscription4.png
Step 6.Review the subscription information.
Subscription done.png

Run Greengrass Core in Your Device

/greengrass is located under Installer folder, e.g. {$Unzip Path} is ~/Desktop/Installer/packages/AWS/EISXGCC 

To configure your core to recognize the AWS IoT thing, update the /greengrass/config/config.json file. and /greengrass/certs.

Copy certs and config with root permission, use the certificate for GreenGrass Core.

Step 1.sudo cp -R certs/ {$Unzip Path}/greengrass/
Step 2.sudo cp -R config/ {$Unzip Path}/greengrass/
Step 3.sudo cp root.ca.pem {$Unzip Path}/greengrass/certs/
root.ca.pem is just located under {$Unzip Path}.
If the original file under {$Unzip Path} is root-ca.pem, just rename it to root.ca.pem after copying to {$Unzip Path}/greengrass/certs/

# mv root-ca.pem root.ca.pem

The Greengrass core software is installed inside the /greengrass directory of your device.

Step 1.Make sure your device is connected to the Internet.

Step 2.sudo {$Unzip Path}/greengrass/ggc/core/greengrassd start
greengrassrun.png

Deploy Your Greengrass Group

After running Greengrass core, you can deploy your Greengrass group to your device.
Step 1.Go to the AWS IoT console.
Step 2.In the navigation pane, select Greengrass and then Groups.
Step 3.Click on your group, GGC.
Step 4.In the navigation pane, click Deployments.

Step 5.Click Actions > Deploy.  
2018-02-01_135700.png
Step 6.In the Configure how Devices discover your Core select Automatic detection.
2018-02-01_135720.png
Step 7.In the Grant permissions to access other services, click Grant permission.
2018-02-01_135731.png
When the operation is complete, the Deployment successfully completed is displayed at the top of the page.
2018-02-08_151442.png

Set Up Your AWS IoT Things

When Greengrass group is deployed successful. You can setup AWS IoT Device which is defined in Greengrass group with Protocol Converter.  

AWS IoT devices need certificates to authenticate with AWS IoT and retrieve the connectivity information of your Greengrass core. You downloaded these certificates in Add devices to your group Create device things.

Install Your IoT Thing Certificate

Use Certificate for setup AWS IoT device.
cp root-ca.pem {$Unzip Path}/ProtocolConnectorSample/certs
cp <id>.cert.pem {$Unzip Path}/ProtocolConnectorSample/certs
cp <id>.private.key {$Unzip Path}/ProtocolConnectorSample/certs

Configure The Samples

Inside the ProtocolConnectorSample/config/ directory you can find the configuration files SampleConfig.json for your things:
1. Please find your endpoint in Settings page in AWS IoT Console.
2. Fill in relative path of root-ca.pem.
3. Fill in relative path of <id>.cert.pem.
4. Fill in relatvie path of <id>.private.key

5. Fill in your device name that you added for GreenGrass group in the following three fields.
2018-02-09 16-17-16.png

Run the Protocol Converter Sample

After setting AWS IoT you can execute protocol converter sample, In the ProtocolConnectorSample folder

./MQTTAgent-sample
2018-02-09 16-18-09.png

IoT connectivity

How to use SUSI (Advantech HW information) plugin

Page under construction...

How to use Modbus plugin

Please visit this page for more details and plugin configuration.

How to use OPC-UA plugin

Currently our OPC-UA plugin is only available on Windows platform. Please visit this page for more details and plugin configuration.

How to use PMQ plugin

Advantech storage PMQ solution includes the deployment of the trained model to make predictions and visualization UI, and recommendations for corresponding strategies. Except storage PMQ service for Advantech hardware, the objective is to provide software developers basic concepts and better understating of PMQ deployment and to be more effective to bring your predictive model to production with Advantech PMQ architecture.

Visit this page for more details.

Release

Pages under construction...