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

From 42Q
Jump to navigation Jump to search
(Created page with " <small>42Q Home > IIoT > Device Self Service</small>   <br/>     <center>'''IIoT'''</center> <center>'''Devi...")
 
Line 12: Line 12:
 
&nbsp;
 
&nbsp;
  
−
= Introduction =
+
= <span class="mw-headline" id="Introduction">Introduction</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).
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
= 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 &nbsp;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:<br/> 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: 
 +
**[https://www.amazontrust.com/repository/AmazonRootCA1.pem].
 +
**[https://d2s8p88vqu9w66.cloudfront.net/releases/greengrass-2.6.0.zip].
 +
**greengrass-ats.iot.us-east-1.amazonaws.com. '''Ports:''' &nbsp; 8443, 443.
 +
***.iot.us-east-1.amazonaws.com. '''Ports:''' &nbsp;8883, 8443, 443.
 +
***.credentials.iot.us-east-1.amazonaws.com. '''Ports:''' 443 
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
= Functional Description =
 +
 +
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.
 +
 +
<br/> '''Figure 1: Accessing Edge Devices'''<br/> &nbsp;
 +
 +
&nbsp;
 +
 +
'''Figure 2: Edge Devices Functions'''
 +
 +
&nbsp;
 +
 +
#Users can query the list of all devices by Edge Device Name or Group Name.
 +
#Users can create a new edge device.
 +
#Users can view the details of the edge device.
 +
#Users can download the software of the edge device.
 +
#Users can upgrade this edge device with more features.
 +
#Users can get all functional components through this button when no functional components are deployed on their local core device.
 +
#Users can delete the edge device.
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
= Install 42Q Edge Software =
 +
 +
== CloudPrinting ==
 +
 +
Please follow the steps below to create a 42Q Cloud Printing Edge Device in 42Q:
 +
 +
#Navigate to: Shop Floor Control > Configuration > IIoT Configuration > Edge Devices.
 +
#Select CREATE EDGE DEVICE to create a new Green Grass Core.
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
'''Figure 3: CREATE EDGE DEVICE Button'''
 +
 +
&nbsp;
 +
<ol start="3">
 +
<li>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 (-).</li>
 +
<li>Select the Group Name as CloudPrintingGroup.</li>
 +
</ol>
 +
 +
<u>'''Note:'''</u> After selecting the Group Name, the Group Version will automatically be selected.
 +
 +
&nbsp;
 +
 +
<br/> '''Figure 4: Create Edge Device Form'''
 +
 +
&nbsp;
 +
<ol start="5">
 +
<li>Select the checkbox next to the desired Edge Device.</li>
 +
<li>Select the Download icon to download the Edge Device ZIP file.</li>
 +
</ol>
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
'''Figure 5: Downloading The Files'''
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
<ol start="7">
 +
<li>Right-click on the ZIP file.</li>
 +
<li>Select Extract Here to unzip the file.</li>
 +
<li>Open the Terminal.</li>
 +
<li>Enter the command: sudo su, and then press Enter.</li>
 +
<li>Enter the root user’s password, and then press Enter.</li>
 +
</ol>
 +
 +
<u>'''Note:'''</u> 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.
 +
 +
&nbsp;
 +
 +
<br/> '''Figure 6: User Logged In as a Root User'''
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
<ol start="12">
 +
<li>Enter the next command: sh ggcV2.sh, and then press Enter.</li>
 +
</ol>
 +
 +
<u>'''Note:'''</u> After the script is installed successfully, users can navigate to the local device’s path:&nbsp;'''/greengrass/v2''' to check the installed folder; logs are contained in the path: '''/greengrass/v2/logs'''.
 +
 +
&nbsp;
 +
 +
<br/> '''Figure 7: Edge Device Folder'''
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
=== Testing Label Printing Function Using Label Engine Screens ===
 +
 +
#Navigate to: Administration > Label Engine Admin > Printer.
 +
#Select Add.
 +
 +
&nbsp;
 +
 +
<br/> '''Figure 8: Add Printer Button'''<br/> &nbsp;
 +
 +
&nbsp;
 +
<ol start="3">
 +
<li>Enter the Printer Name.</li>
 +
<li>Select the Resolution from the drop-down list.</li>
 +
<li>Select the Connectivity Type as Edge Device.</li>
 +
</ol>
 +
 +
&nbsp;
 +
 +
<br/> '''Figure 9: Entering The Printer Details'''
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
<u>'''Note:'''</u> 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.
 +
 +
&nbsp;
 +
<ol start="6">
 +
<li>Navigate to: Production > Label Engine Labels > LE Labels.</li>
 +
<li>Search for the label called “entry”, which will print whatever "Entry" value is passed.</li>
 +
<li>Select the checkbox next to the printer name.</li>
 +
<li>Select Print.</li>
 +
</ol>
 +
 +
&nbsp;
 +
 +
<br/> '''Figure 10: Print Button'''
 +
 +
&nbsp;
 +
 +
<br/> &nbsp;

Revision as of 17:27, 13 March 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:
    • [1].
    • [2].
    • greengrass-ats.iot.us-east-1.amazonaws.com. Ports:   8443, 443.
      • .iot.us-east-1.amazonaws.com. Ports:  8883, 8443, 443.
      • .credentials.iot.us-east-1.amazonaws.com. Ports: 443

 

 

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
 

 

Figure 2: Edge Devices Functions

 

  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

 

  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

 

  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

 

 

  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

 

 

  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

 

 

Testing Label Printing Function Using Label Engine Screens

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

 


Figure 8: Add Printer Button
 

 

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

 


Figure 9: Entering The Printer Details

 

 

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

 


 

Retrieved from "https://42qrpt1.42-q.com/mes_wiki/index.php?title=42Q-MES0184-IIoT_Configuration&oldid=45511"