Difference between revisions of "42Q-MES0184-IIoT Configuration"

From 42Q
Jump to navigation Jump to search
Line 12: Line 12:
 
 
 
 
  
= <span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction">Introduction</span></span></span></span></span></span></span></span></span></span> =
+
= <span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction">Introduction</span></span></span></span></span></span></span></span></span></span></span> =
  
 
The concept of GGC stands for “Green Grass Computer”, the word: “Computer” also refers to any kind of device. This document will teach users how to configure, install, and deploy a GGC, as well as create and set up an Edge Device for the purpose of establishing a connection between the computer (device) and the 42Q portal to send data (payloads).
 
The concept of GGC stands for “Green Grass Computer”, the word: “Computer” also refers to any kind of device. This document will teach users how to configure, install, and deploy a GGC, as well as create and set up an Edge Device for the purpose of establishing a connection between the computer (device) and the 42Q portal to send data (payloads).
Line 22: Line 22:
 
&nbsp;
 
&nbsp;
  
= <span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites">Prerequisites</span></span></span></span></span></span></span></span></span></span> =
+
= <span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites"><span class="mw-headline" id="Prerequisites">Prerequisites</span></span></span></span></span></span></span></span></span></span></span> =
  
 
*Only Linux is supported for the computer or device to install the Green Grass Core. The related shell scripts and test code only work on Linux systems (Windows is not currently supported).  
 
*Only Linux is supported for the computer or device to install the Green Grass Core. The related shell scripts and test code only work on Linux systems (Windows is not currently supported).  
Line 41: Line 41:
 
&nbsp;
 
&nbsp;
  
= <span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description">Functional Description</span></span></span></span></span></span></span></span></span> =
+
= <span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description"><span class="mw-headline" id="Functional_Description">Functional Description</span></span></span></span></span></span></span></span></span></span> =
  
 
There are three different functional components: '''CloudPrinting''', '''MachineInterface''', and '''DataIngestion'''.<br/> To access the Edge Devices portlet, navigate to: '''Shop Floor Control > Configuration > IIoT Configuration > Edge Devices'''.
 
There are three different functional components: '''CloudPrinting''', '''MachineInterface''', and '''DataIngestion'''.<br/> To access the Edge Devices portlet, navigate to: '''Shop Floor Control > Configuration > IIoT Configuration > Edge Devices'''.
Line 69: Line 69:
 
&nbsp;
 
&nbsp;
  
= <span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software">Install 42Q Edge Software</span></span></span></span></span></span></span></span></span> =
+
= <span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software"><span class="mw-headline" id="Install_42Q_Edge_Software">Install 42Q Edge Software</span></span></span></span></span></span></span></span></span></span> =
  
== <span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting">CloudPrinting</span></span></span></span></span></span></span></span></span> ==
+
== <span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting"><span class="mw-headline" id="CloudPrinting">CloudPrinting</span></span></span></span></span></span></span></span></span></span> ==
  
 
Please follow the steps below to create a 42Q Cloud Printing Edge Device in 42Q:
 
Please follow the steps below to create a 42Q Cloud Printing Edge Device in 42Q:
Line 144: Line 144:
 
&nbsp;
 
&nbsp;
  
=== <span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens">Testing Label Printing Function Using Label Engine Screens</span></span></span></span></span></span></span></span></span> ===
+
=== <span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens"><span class="mw-headline" id="Testing_Label_Printing_Function_Using_Label_Engine_Screens">Testing Label Printing Function Using Label Engine Screens</span></span></span></span></span></span></span></span></span></span> ===
  
 
#'''Navigate''' to: '''Administration > Label Engine Admin > Printer'''.  
 
#'''Navigate''' to: '''Administration > Label Engine Admin > Printer'''.  
Line 220: Line 220:
 
&nbsp;
 
&nbsp;
  
== <span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface">MachineInterface</span></span></span></span></span></span></span></span></span></span> ==
+
== <span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface"><span class="mw-headline" id="MachineInterface">MachineInterface</span></span></span></span></span></span></span></span></span></span></span> ==
  
This function is used for sending commands to machines from the cloud.<br/> Below there is an example for stopping a machine when the server finds MSD material expired.
+
This function is used for sending commands to machines from the cloud.<br/> Below there is an example of stopping a machine when the server finds MSD material expired.
  
 
&nbsp;
 
&nbsp;
Line 228: Line 228:
 
'''Figure 13: Server Stopping A Machine Due To Material Expired Diagram'''
 
'''Figure 13: Server Stopping A Machine Due To Material Expired Diagram'''
  
[[File:DSS Server Stopping A Machine Due To Material Expired Diagram.png|900px|DSS Server Stopping A Machine Due To Material Expired Diagram.png]]<br/> &nbsp;
+
[[File:EdgeDevice Diagram.png|900px]]<br/> &nbsp;
  
 
The diagram above is divided into three steps:
 
The diagram above is divided into three steps:
Line 296: Line 296:
 
&nbsp;
 
&nbsp;
  
== <span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion">DataIngestion</span></span></span></span></span></span></span> ==
+
== <span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion"><span class="mw-headline" id="DataIngestion">DataIngestion</span></span></span></span></span></span></span></span> ==
  
 
Please follow the steps below to create a 42Q Cloud Data Ingestion Edge Device in 42Q:
 
Please follow the steps below to create a 42Q Cloud Data Ingestion Edge Device in 42Q:

Revision as of 21:42, 12 April 2023

42Q Home > IIoT > Device Self Service

 


 

 

IIoT
Device Self Service
Version MES 15.76
Revision B1
 

 

 

 

Introduction

The concept of GGC stands for “Green Grass Computer”, the word: “Computer” also refers to any kind of device. This document will teach users how to configure, install, and deploy a GGC, as well as create and set up an Edge Device for the purpose of establishing a connection between the computer (device) and the 42Q portal to send data (payloads).

 

 

 

Prerequisites

  • Only Linux is supported for the computer or device to install the Green Grass Core. The related shell scripts and test code only work on Linux systems (Windows is not currently supported).
  • Python 3.8 or higher must be installed and configured to run the test code.
  • Operating System and  Software requirements:
    • Linux kernel version 4.4 or later (Ubuntu 20.04 and CentOS 8.5).
    • Java Runtime Environment (JRE) version 8 or greater (included in the installation script).
    • Python version 3.8 for functions that use the Python 3.8 runtime (included in the installation script).
  • Network requirements:
    A Region is an AWS region that hosts 42Q portal APIs. The Green Grass Core hardware needs to be able to access the following endpoints through specific ports:

 

 

Functional Description

There are three different functional components: CloudPrinting, MachineInterface, and DataIngestion.
To access the Edge Devices portlet, navigate to: Shop Floor Control > Configuration > IIoT Configuration > Edge Devices.


Figure 1: Accessing Edge Devices
DSS Accessing Edge Devices.png

 

 

Figure 2: Edge Devices Functions

DSS Edge Devices Functions.png

 

  1. Users can query the list of all devices by Edge Device Name or Group Name.
  2. Users can create a new edge device.
  3. Users can view the details of the edge device.
  4. Users can download the software of the edge device.
  5. Users can upgrade this edge device with more features.
  6. Users can get all functional components through this button when no functional components are deployed on their local core device.
  7. Users can delete the edge device.

 

 

Install 42Q Edge Software

CloudPrinting

Please follow the steps below to create a 42Q Cloud Printing Edge Device in 42Q:

  1. Navigate to: Shop Floor Control > Configuration > IIoT Configuration > Edge Devices.
  2. Select CREATE EDGE DEVICE to create a new Green Grass Core.

 

Figure 3: CREATE EDGE DEVICE Button

DSS CREATE EDGE DEVICE Button.png

 

  1. Enter the Edge Device Name of the Green Grass Core. The name can be up to 128 characters. Valid characters are: a-z, A-Z, 0-9, colon (:), underscore (_), and hyphen (-).
  2. Select the Group Name as CloudPrintingGroup.

Note: After selecting the Group Name, the Group Version will automatically be selected.

 


Figure 4: Create Edge Device Form

DSS Create Edge Device Form.png

 

  1. Select the checkbox next to the desired Edge Device.
  2. Select the Download icon to download the Edge Device ZIP file.

 

 

Figure 5: Downloading The Files

DSS Downloading The Files.png

 

  1. Right-click on the ZIP file.
  2. Select Extract Here to unzip the file.
  3. Open the Terminal.
  4. Enter the command: sudo su, and then press Enter.
  5. Enter the root user’s password, and then press Enter.

Note: If the word: root@ appears before the computer’s username as in the image below, it means that you are logged in as a root user.

 


Figure 6: User Logged In as a Root User

DSS User Logged In as a Root User.png

 

  1. Enter the next command: sh ggcV2.sh, and then press Enter.

Note: After the script is installed successfully, users can navigate to the local device’s path: /greengrass/v2 to check the installed folder; logs are contained in the path: /greengrass/v2/logs.

 


Figure 7: Edge Device Folder

DSS Edge Device Folder.png

 

Testing Label Printing Function Using Label Engine Screens

  1. Navigate to: Administration > Label Engine Admin > Printer.
  2. Select Add.

 


Figure 8: Add Printer Button
DSS Add Printer Button.png

 

  1. Enter the Printer Name.
  2. Select theResolution from the drop-down list.
  3. Select the Connectivity Type as Edge Device.

 


Figure 9: Entering The Printer Details

DSS Entering The Printer Details.png

 

Note: The TCP IP Address should be the address of the printer or start a TCP Server as a simulator by executing the next command in the Terminal: python3 tcpServer.py.

 

  1. Navigate to: Production > Label Engine Labels > LE Labels.
  2. Search for the label called “entry”, which will print whatever "Entry" value is passed.
  3. Select the checkbox next to the printer name.
  4. Select Print.

 


Figure 10: Print Button

DSS Print Button.png

 

  1. Select the Printer Name previously created.
  2. Enter a value in the Entry field.
  3. Select Test Print.

 

 

Figure 11: Entering Test Print Data

DSS Entering Test Print Data.png

 

  1. Open the Terminal.
  2. Navigate to the local device’s path: /greengrass/v2/logs.
  3. Enter the next command: tail -f {envide}_CloudPrinting.log. After that, a message will be received to confirm the successful testing.

 

 

Figure 12: Successful Testing Message

DSS Successful Testing Message.png
 

 

 

 

MachineInterface

This function is used for sending commands to machines from the cloud.
Below there is an example of stopping a machine when the server finds MSD material expired.

 

Figure 13: Server Stopping A Machine Due To Material Expired Diagram

EdgeDevice Diagram.png
 

The diagram above is divided into three steps:

  1. Install an Edge Device on a server in the plant.
  2. The plant creates a new local application which can communicate with the Edge Device by TCP and also can send commands to machines.
  3. The Cloud application will send commands to the Edge Device, then the Edge Device will forward the message to the local application through TCP/IP.


Please follow the steps below to create a 42Q Cloud Machine Interface Edge Device in 42Q:

  1. Navigate to: Shop Floor Control > Configuration > IIoT Configuration > Edge Devices.
  2. Select CREATE EDGE DEVICE to create a new Green Grass Core.
  3. Enter the Edge Device Name of the Green Grass Core. The name can be up to 128 characters. Valid characters are: a-z, A-Z, 0-9, colon (:), underscore (_), and hyphen (-).
  4. Select the Group Name as MachineInterfaceGroup.

Note: After selecting the Group Name, the Group Version will automatically be selected.

 

  1. Select the checkbox next to the desired Edge Device.
  2. Select the Download icon to download the ZIP file.
  3. Right-click on the ZIP file.
  4. Select Extract Here to unzip the file.
  5. Open the Terminal.
  6. Enter the command: sudo su, and then press Enter.
  7. Enter the root user’s password, and then press Enter.
  8. Navigate to the extract folder by using the command: cd {folder path}.
  9. Enter the next command: sh ggcV2.sh, and then press Enter.

Note: After the script is installed successfully, users can navigate to the computer’s path: /greengrass/v2 to check the installed folder; logs are contained in the path: /greengrass/v2/logs.

 

  1. Open Postman to test its functionality.
  2. Select POST as HTTP Method.
  3. Enter the URL.
  4. Enter the Topic.
  5. Enter the Output.
  6. Enter the Error.

 

Data nomenclature example:
URL: https://portal-uat.42-q.com/mes-api/[SiteName]/greengrass/v2/publish
Topic: [Envide]/machine-interface/[Envide]_[Edge device name]
Output: [Envide]/machine-interface/results
Error: [Envide]/machine-interface/errors

 


Figure 14: Sending The Payload Using Postman

DSS Sending The Payload Using Postman..png
 

  1. Open the Terminal.
  2. Navigate to the local device’s path: /greengrass/v2/log to view the logs.

 

 

Figure 15: Successful Payload Sending Logs

DSS Successful Payload Sending Logs.png
 

Note: If the message from the previous image is printed in your local log, the function has succeeded.
Adding the corresponding configuration for PTS allows PTS to send messages to Edge Device.

 

DataIngestion

Please follow the steps below to create a 42Q Cloud Data Ingestion Edge Device in 42Q:

  1. Navigate to: Shop Floor Control > Configuration > IIoT Configuration > Edge Devices.
  2. Select CREATE EDGE DEVICE to create a new Green Grass Core.
  3. Enter the Edge Device Name of the Green Grass Core. The name can be up to 128 characters. Valid characters are: a-z, A-Z, 0-9, colon (:), underscore (_), and hyphen (-).
  4. Select the Group Name as DataIngestionGroup.

Note: After selecting the Group Name, the Group Version will automatically be selected.

 

  1. Select the checkbox next to the desired Edge Device.
  2. Select the Download icon to download the ZIP file.
  3. Right-click on the ZIP file.
  4. Select Extract Here to unzip the file.
  5. Open the Terminal.
  6. Enter the command: sudo su, and then press Enter.
  7. Enter the root user’s password, and then press Enter.
  8. Enter the next command: sh ggcV2.sh, and then press Enter.

Note: After the script is installed successfully, users can navigate to the computer’s path: /greengrass/v2 to check the installed folder; logs are contained in the path: /greengrass/v2/logs.

 

  1. When the status of this Edge Device is "Healthy", select the Edit button to enter the Edge Device information.

 


Figure 16: Edit Button

DSS Edit Button.png

 

  1. Select the CLIENT DEVICES tab.
  2. Select CREATE CLIENT DEVICES.

 


Figure 17: CLIENT DEVICES TAB

DSS CLIENT DEVICES TAB.png

 

  1. Enter the name of the Client Device to be created.

Note: The name can be up to 128 characters. Valid characters: a-z, A-Z, 0-9, colon (:), underscore (_), and hyphen (-).

 

  1. Select ASSOCIATE.

 

 

Figure 18: Creating a Client Device

DSS Creating a Client Device.png

 

  1. Select the Download icon to download the Client Device ZIP file.
  2. Right-click on the ZIP file.
  3. Select Extract Here to unzip the file.

 


Figure 19: Client Device Folder

DSS Client Device Folder.png

 

  1. Open the MqttTest.py file.
  2. Find the line that contains: ‘# Change This’.
  3. Modify the data information to be sent; users may see an example below (user’s will be different).

 


Figure 20: Data To Be Modified

DSS Data To Be Modified.png

 

  1. Open the Terminal.
  2. Enter the next command: python MqttTest.py, and then press Enter. The result should be similar to the image below:

 


Figure 21: Result Of Executing The MqttTest.py File

DSS Result Of Executing The MqttTest.py File.png

 

  1. Navigate to the local device’s path: /greengrass/v2/log to view the logs.

 

 

Figure 22: Successful MqttTest.py Running Logs

DSS Successful MqttTest.py Running Logs.png


 

Note: If the message from the previous image is printed in your local log, the function has succeeded.

 

  1. Navigate to: Shop Floor Control > Configuration > IIoT Configuration > Things.

 


Figure 23: Things Portlet

DSS Things Portlet.png

 

  1. If the “Thing ID” is the same as the “id” configured in MqttTest.py file, it means that AWS Cloud has already stored the data uploaded.

 

 

Figure 24: Thing ID
DSS Thing ID.png

 

  1. Navigate to: Reporting > IIoT Dashboard.
  2. Select the + icon to create a new widget.

 

 

Figure 25: Add (+) Icon
DSS Add (+) Icon.png

 

  1. Enter the Widget Name.
  2. Select the THINGS tab.
  3. Select the "id" value previously configured in the MqttTest.py file.
  4. Select the SAVE button located at the end of the Add Widget Form.

 


Figure 26: Creating a Widget

DSS Creating a Widget.png

 

  1. Select the show/hide icon to view the values of the widget created.

 


Figure 27: Show/Hide Icon

DSS Show-Hide Icon.png


Note: Users can check the payload sent through either of the following:

  • IIoT widget.