0% found this document useful (0 votes)
203 views90 pages

SE Machine Advisor Node User Manual

SE-Machine-Advisor-Node-User-Manual
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
203 views90 pages

SE Machine Advisor Node User Manual

SE-Machine-Advisor-Node-User-Manual
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 90

Node-RED -

SE Machine Advisor Node


User Manual
09/2021

www.schneider-electric.com
The information provided in this documentation contains general descriptions and/or technical
characteristics of the performance of the products contained herein. This documentation is not
intended as a substitute for and is not to be used for determining suitability or reliability of these
products for specific user applications. It is the duty of any such user or integrator to perform the
appropriate and complete risk analysis, evaluation and testing of the products with respect to the
relevant specific application or use thereof. Neither Schneider Electric nor any of its affiliates or
subsidiaries shall be responsible or liable for misuse of the information contained herein. If you
have any suggestions for improvements or amendments or have found errors in this publication,
please notify us.
You agree not to reproduce, other than for your own personal, noncommercial use, all or part of
this document on any medium whatsoever without permission of Schneider Electric, given in
writing. You also agree not to establish any hypertext links to this document or its content.
Schneider Electric does not grant any right or license for the personal and noncommercial use of
the document or its content, except for a non-exclusive license to consult it on an "as is" basis, at
your own risk. All other rights are reserved.
All pertinent state, regional, and local safety regulations must be observed when installing and
using this product. For reasons of safety and to help ensure compliance with documented system
data, only the manufacturer should perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant
instructions must be followed.
Failure to use Schneider Electric software or approved software with our hardware products may
result in injury, harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
© 2021 Schneider Electric. All rights reserved.

2 EIO0000004100 09/2021
Table of Contents

Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Part I Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Part II Installation and Uninstallation - SE Machine Advisor
Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 2 Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 3 Installing SE Machine Advisor Node – Linux Platform . . 19
Installing SE Machine Advisor Node - Offline Installation Mode . . . . . 20
Installing SE Machine Advisor Node - Online Installation Mode . . . . . 23
Chapter 4 Uninstalling SE Machine Advisor Node - Linux Platform 27
Uninstalling SE Machine Advisor Node - Offline Uninstallation Mode. 28
Uninstalling SE Machine Advisor Node - Online Uninstallation Mode. 30
Part III Node Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapter 5 Launching SE Machine Advisor Node . . . . . . . . . . . . . . 35
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Launching Node-RED and SE Machine Advisor Node - Linux Platform 39
Chapter 6 SE Machine Advisor Node . . . . . . . . . . . . . . . . . . . . . . . 43
EcoStruxure Machine Advisor Login Page . . . . . . . . . . . . . . . . . . . . . 44
HTTPs - Tango Data Format Configuration. . . . . . . . . . . . . . . . . . . . . 68
HTTPs - Charlie Data Format Configuration . . . . . . . . . . . . . . . . . . . . 71
MQTTs - Tango Data Format Configuration . . . . . . . . . . . . . . . . . . . . 73
MQTTs - Charlie Data Format Configuration. . . . . . . . . . . . . . . . . . . . 76
Chapter 7 Usage of SE Machine Advisor Node . . . . . . . . . . . . . . . 79
Usage of SE Machine Advisor Node . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Common Message Structure (CMS) . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Part IV IIoT and Cybersecurity . . . . . . . . . . . . . . . . . . . . . . . 87
Chapter 8 IIoT and Cybersecurity . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Cybersecurity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

EIO0000004100 09/2021 3
4 EIO0000004100 09/2021
Safety Information

Important Information

NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device
before trying to install, operate, service, or maintain it. The following special messages may appear
throughout this documentation or on the equipment to warn of potential hazards or to call attention
to information that clarifies or simplifies a procedure.

EIO0000004100 09/2021 5
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of
the use of this material.
A qualified person is one who has skills and knowledge related to the construction and operation
of electrical equipment and its installation, and has received safety training to recognize and avoid
the hazards involved.

6 EIO0000004100 09/2021
About the Book

At a Glance

Document Scope
This document describes the Node-RED installation and configuration for communication between
the IIOT Edge Box and EcoStruxure Machine Advisor application through HTTPs or MQTTs
protocol.
This document also describes:
⚫ installation and uninstallation of SE Machine Advisor node.
⚫ configuration of the node.
⚫ usage of the node.
⚫ limitations.

Validity Note
This document has been updated with the release of SE Machine Advisor node V2.0.0.

Related Documents

Title of Documentation Reference Number


Node-RED - SE Modbus Nodes - User Manual EIO0000004101

You can download these technical publications and other technical information from our website
at https://spiceportal.schneider-electric.com/web/industrial-automation-products-
campus/ecostruxure-plant-data-expert. See launch book where all the marketing aspects are
detailed on IAP Campus Portal.

EIO0000004100 09/2021 7
8 EIO0000004100 09/2021
Part I
Introduction

EIO0000004100 09/2021 9
Introduction

10 EIO0000004100 09/2021
Chapter 1
General Information

General Information

IIoT (Industrial Internet of Things)

IoT is a network of intelligent computers, devices, and objects that collect and share huge amounts
of data. IIoT is the use of Internet of Things (IoT) technologies in manufacturing. With Industrial
Internet of Things (IIoT), the device itself will be seamlessly wired to the business systems.
Operational Technology (OT) is a category of hardware and software that monitors and controls
the physical devices. Due to increasing trend towards convergence of IT (Information Technology)
and OT (Operational Technology), the plant managers in charge of operational technology are
more efficient being remote.

Node-RED in EcoStruxureTM
Node-RED is an IoT wiring tool to connect services through a user-friendly graphical interface.
Schneider Electric has selected Node-RED as the technology to deliver basic connectivity through
tested, validated and documented nodes.

The following figure shows the integration of SE Machine Advisor node in EcostruxureTM:

EIO0000004100 09/2021 11
General Information

Connected Products
Modbus is a non-proprietary communication protocol used for programmable controller networks
that fall under application level, that is, level 7 of OSI Model. Originally designed for Modicon
(Schneider Electric) PLCs, it has become widely used by many PLC manufacturers and industrial
networks.
The aim is to transform standard brownfield asset into connected asset. In this case, the data is
exchanged from the lowest layer of connected devices through the Edge layer further up to the
Apps, Analytics and Services. Predictive maintenance, MES or CMMS are the typical apps
integrated in this kind of solution.

Edge Control
Edge control provides connectivity for OT and IT systems and data processing right next to the
machines. Instead of sending data to the cloud for processing and waiting for the analytical results,
edge control devices collect and process data next to the machines. Then, those devices push their
data to the cloud, thus saving bandwidth and enabling increased responsiveness. Harmony iPC and
Harmony Edge Box offer smart application design and engineering to leverage asset performance
with end-to-end cybersecurity.
Schneider Electric provides nodes that are tested, validated, and supported to run with Node-RED
on the Harmony iPC and Edge Box.

12 EIO0000004100 09/2021
General Information

There are three main advantages of Schneider Electric nodes:


⚫ Scalability: easy to add connected devices in a cyber-secure manner.
⚫ Time to market: significant reduction in integration time to implement a use case solution.
⚫ Expert support: support chain L2 and Experts in the country organisation and L3 as a back up.

Apps, Analytics and Services


Specific nodes have been developed by Schneider to simplify the Node-RED flows for several
typical use cases. SE Machine Advisor node collects data from the devices and pushes it to
EcoStruxure Machine Advisor cloud application.

Harmony Edge Box


The new Harmony Edge Box meets IIoT challenges at the Edge Control level by enabling secured
communication from connected products on the shop floor to the required software and
applications on the top floor. The Edge box will complement your application, parallel to the control
of your machine application. There is no need to stop or modify your control application (including
3rd party control devices).
Harmony Edge Box types are commercialized, as detailed in the following table:

Harmony Edge Box Reference


Harmony HMIBSC Reference HMIBSCEA53D1L0T HMIBSC with ARM, Linux
Harmony HMIBMI Reference HMIBMIEA5DD110L HMIBMI with Intel Atom
Harmony HMIBMO Reference HMIBMOMA5DD1E01: HMIBMO with Intel Atom

Harmony iPC
The Harmony iPC is a robust industrial device without a fan or even a hard drive, requiring no
maintenance, and designed to run in the machine or plant field, even in harsh environments. New
IIoT monitors for the Harmony iPC come tested, validated, and supported in two versions - agent
and server.
Harmony iPC Box types are commercialized, as detailed in the following table:

Harmony iPC Reference


Harmony HMIBMP Reference HMIBMPHI74D4801 HMIBMP with 4 expansion slots, Intel
Core I7
Harmony HMIBMU Reference HMIBMUSI29D2801 HMIBMU with 2 expansion slots, Intel
Celeron

Machine Advisor
EcoStruxure Machine Advisor is the new digital cloud-based services platform. It enables machine
builders to provide new services to machine operators for each installed machine in any production
site worldwide.

EIO0000004100 09/2021 13
General Information

The SE Machine Advisor node is a Schneider Electric publishing node that is installed on the IIoT
Edge Box that connects the automation network to the cloud-based EcoStruxure Machine Advisor
application. The node receives data from collecting nodes in the data flow such as SE Modbus
Basic, SE Harmony Hub and so on. It then pushes the data to EcoStruxure Machine Advisor
application.
You should have an account in EcoStruxure Machine Advisor application to push the data.

Best Practice for Node-RED


1. Use Browsers Wisely
When more web pages are accessed in the browser, Node-RED server may not be responsive
to the program. Remove unused web pages in the browser to prevent this.
If Node-RED application is not responsive, you will receive a page unresponsive message.

Limitations
SE Machine Advisor node has the following limitations:
1. Node-RED application is supported in any browser with JavaScript V8 engine or similar
supported browser (for instance: Google Chrome V73.0 and Firefox V66).
2. Node-RED web page is available in English, irrespective of the system language.
3. If the Store and forward file is deleted, the stored data in the file will be lost as it is not pushed
to cloud (see page 81).
4. When the user wants to do the offline installation, the internet should be disabled. It takes longer
to install if the internet is enabled.
5. EcoStruxure Machine Advisor cloud limitation - It will only accept numeric values. The input to
SE Machine Advisor node (through collecting nodes) must not contain boolean or string values.

14 EIO0000004100 09/2021
Part II
Installation and Uninstallation - SE Machine Advisor Node

What Is in This Part?


This part contains the following chapters:
Chapter Chapter Name Page
2 Prerequisites 17
3 Installing SE Machine Advisor Node – Linux Platform 19
4 Uninstalling SE Machine Advisor Node - Linux Platform 27

EIO0000004100 09/2021 15
Installation and Uninstallation - SE Machine Advisor Node

16 EIO0000004100 09/2021
Chapter 2
Prerequisites

System Requirements

Operating System
SE Machine Advisor node V2.0.0. supports Linux Yocto (V1.00.010 and above) operating system.
NOTE: The required software like Node.js, Node-RED and Python are pre-installed in Harmony
HMIBSC box.

Hardware Requirements
NOTE: SE Machine Advisor node is supported for Harmony HMIBSC only. Other Harmony Edge Box
and Harmony iPC will be supported in future versions of the node.

IOT Edge Box PC hardware Specification


Harmony HMIBSC Processor Reference HMIBSCEA53D1L0T HMIBSC with ARM, Linux
Hard disk space eMMC and TPM for hardware encryption
Operating system Linux Yocto

Software Requirements
⚫ Node.js V10.15.3
⚫ Node-RED server V0.20.7
⚫ Npm (Node package manager) V6.4.1
⚫ Supported browser: Any browser with JavaScript V8 engine or similar supported browser (for
instance: Google Chrome V73.0 and Firefox V66).)
NOTE: The software versions mentioned above support the SE Nodes installation. Other versions
do not support it.

EIO0000004100 09/2021 17
Prerequisites

Accessing SE Machine Advisor Node


You can perform two modes of installation (online/offline):

You can perform the nodes installation on the modes given below:
⚫ Install the node - Offline (see page 20)
⚫ Install the node - Online (see page 23)

18 EIO0000004100 09/2021
Chapter 3
Installing SE Machine Advisor Node – Linux Platform

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Installing SE Machine Advisor Node - Offline Installation Mode 20
Installing SE Machine Advisor Node - Online Installation Mode 23

EIO0000004100 09/2021 19
Installing SE Machine Advisor Node – Linux Platform

Installing SE Machine Advisor Node - Offline Installation Mode

The Linux based Edge Boxes (for example, HMIBSC) have in-built Node-RED-as-a-Service. This
provides Node-Red and Node.js are pre-installed in the OS image.
The SE Machine Advisor node is installed by the user from the portable storage device (for
instance; pendrive).
The below procedure is applicable for the Edge Boxes running on Linux Yocto (for example,
Harmony HMIBSC):

Step Action
1 Download the Machine-Advisor_V2.0.0_Offline.zipfile from the link given below:
https://schneider-electric.box.com/s/xsmgvjhjo4km8jwlsn8qyprgb0gy8bv6
2 Extract the downloaded file Machine-Advisor_V2.0.0_Offline.zipand transfer the
extracted folder (Machine-Advisor_V2.0.0_Offline) into a portable disk.
Example: Pendrive.
3 Connect the portable device to IIoT Edge Box.
4 ⚫ Navigate to the directory of the portable device (for instance, cd mount/media/<disk
name>) and press Enter.
⚫ Type cd Machine-Advisor_V2.0.0_Offlineand press Enter to go to the directory
where the offline files for SE Machine Advisor node are placed.

5 Type sh se-node-red-machine_advisor_offline_install.shand press Enter to


install the SE Machine Advisor node. Press any key to read the Terms & Conditions.

NOTE: Press any key to continue until the result appears below.
Result: Do you agree to our Terms & Conditions? (yes/no):.

20 EIO0000004100 09/2021
Installing SE Machine Advisor Node – Linux Platform

Step Action
6 Type yesand press Enter to agree to the terms and conditions in EULA (End User License
Agreement is a legal contract between a software application author or publisher and the user
of that application) and install SE Machine Advisor node.

Result: se-node-red-machine_advisor installed successfully. Please restart node-red by


rebooting Harmony HMIBSC Edge box.
NOTE: If you type no, the installation is canceled.

EIO0000004100 09/2021 21
Installing SE Machine Advisor Node – Linux Platform

Step Action
7 Open a browser from system (Laptop or Desktop) connected in same network as the Linux
Edge box:
⚫ Go to https:\\<ip address>:1880
NOTE: To know your IP address, type ifconfigin your Linux Edge box.

⚫ Login window appears.


Note: Use your Node-RED login credentials to operate Linux Edge box through your system.

NOTE: As the browser is not accessible in the Linux Edge box, you can connect to another
system (Laptop or Desktop) using the Linux Edge box IP address.

22 EIO0000004100 09/2021
Installing SE Machine Advisor Node – Linux Platform

Installing SE Machine Advisor Node - Online Installation Mode

The Linux based Edge Boxes (for example, HMIBSC) have in-built Node-RED-as-a-Service. This
means Node.js, Node-Red and python are pre-installed in the OS image.
To install SE Machine Advisor node follow the steps given below:

Step Action
1 Type the text given below in the terminal and press Enter:
npm set registry https://wain05400.apa.gad.schneider-
electric.com:4878/
2 Type the text given below in the terminal and press Enter:
npm set proxy null
Note: If set proxy null command is not working, remove proxy for respective types as follows:
⚫ npm config rm proxy
⚫ npm config rm http-proxy
⚫ npm config rm https-proxy

3 Type npm install se-node-red-machine_advisorand press Enter.


NOTE: If you get the error as shown in image below:

Then, type the text given below in the terminal and press Enter, and run the installation
command again.
npm set strict-ssl false
NOTE: Press any key to continue until the result appears.
Result: Do you agree to our Terms & Conditions? (yes/no):.

EIO0000004100 09/2021 23
Installing SE Machine Advisor Node – Linux Platform

Step Action
4 Type yesand press Enter to agree the terms and conditions in EULA (End User License
Agreement is a legal contract between a software application author or publisher and the user
of that application) and install SE Machine Advisor node.

Result: Installation is successfully completed.


NOTE: If you type no, the installation is cancelled.
5 Restart Node-RED application by rebooting Harmony HMIBSC Edge box.

24 EIO0000004100 09/2021
Installing SE Machine Advisor Node – Linux Platform

Step Action
6 Open a browser from system (laptop or desktop) connected in same network as the Linux Edge
box:
⚫ Go to https:\\<ip address>:1880
NOTE: To know your ip address, type ifconfigin your Linux edge box.

⚫ Login window appears. Use your Node-RED login credentials to operate Linux Edge box
through your system (laptop or desktop).

NOTE: As browser is not available in Linux edge box you can connect to another system
(laptop or desktop) using the ip address of Linux Edge box.

EIO0000004100 09/2021 25
Installing SE Machine Advisor Node – Linux Platform

26 EIO0000004100 09/2021
Chapter 4
Uninstalling SE Machine Advisor Node - Linux Platform

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Uninstalling SE Machine Advisor Node - Offline Uninstallation Mode 28
Uninstalling SE Machine Advisor Node - Online Uninstallation Mode 30

EIO0000004100 09/2021 27
Uninstalling SE Machine Advisor Node - Linux Platform

Uninstalling SE Machine Advisor Node - Offline Uninstallation Mode

The below procedure is applicable for the Edge Boxes running on Linux Yocto (for example,
HMIBSC):

Step Action
1 Type lsand press Enter.

Result: Installed nodes appears.


2 Type sh se-node-red-machine_advisor_offline_uninstall.shand press Enter to
uninstall SE Machine Advisor node.

NOTE: After uninstalllation restart Node-RED by rebooting Harmony HMIBSC Edge box.

28 EIO0000004100 09/2021
Uninstalling SE Machine Advisor Node - Linux Platform

Step Action
3 Open a browser from system (Laptop or Desktop) connected in same network as the Linux
Edge box:
⚫ Go to https:\\<ip address>:1880
NOTE: To know your IP address, type ifconfigin your Linux Edge box.

⚫ Login window appears.


Note: Use your Node-RED login credentials to operate Linux Edge box through your system.

NOTE: As the browser is not accessible in the Linux Edge box, you can connect to another
system (Laptop or Desktop) using the Linux Edge box IP address.

EIO0000004100 09/2021 29
Uninstalling SE Machine Advisor Node - Linux Platform

Uninstalling SE Machine Advisor Node - Online Uninstallation Mode

This procedure explains how to uninstall the SE Machine Advisor node:

Step Action
1 From the browser where Node-RED server is running, delete the SE Machine Advisor node
from the flow.
2
Click Deploy and Logout from the Node-RED application.
3 Go to HMIBSC terminal.
4 Type npm uninstall se-node-red-machine_advisor.
5 Press Enter to uninstall the SE Machine Advisor node.
Result: SE Machine Advisor node is successfully uninstalled.
6 Restart Node-RED application by rebooting Harmony HMIBSC Edge box.

30 EIO0000004100 09/2021
Uninstalling SE Machine Advisor Node - Linux Platform

Step Action
7 To check if your node is uninstalled follow the steps below
⚫ Open a browser from system (laptop or desktop) connected in same network as the Linux
Edge box:
 Go to https:\\<ip address>:1880
NOTE: To know your ip address, type ifconfigin your Linux edge box.

 Login window appears. Use your Node-RED login credentials to operate Linux Edge box
through your system (laptop or desktop).

NOTE: As browser is not available in Linux edge box you can connect to another system
(laptop or desktop) using the ip address of Linux Edge box.

EIO0000004100 09/2021 31
Uninstalling SE Machine Advisor Node - Linux Platform

32 EIO0000004100 09/2021
Part III
Node Usage

What Is in This Part?


This part contains the following chapters:
Chapter Chapter Name Page
5 Launching SE Machine Advisor Node 35
6 SE Machine Advisor Node 43
7 Usage of SE Machine Advisor Node 79

EIO0000004100 09/2021 33
Node Usage

34 EIO0000004100 09/2021
Chapter 5
Launching SE Machine Advisor Node

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Introduction 36
Launching Node-RED and SE Machine Advisor Node - Linux Platform 39

EIO0000004100 09/2021 35
Launching SE Machine Advisor Node

Introduction

SE Machine Advisor node is a publishing node that collects data in CMS format from collecting
node. It converts data to user configurable Tango/Charlie format (see page 37) and pushes the
data to EcoStruxure Machine Advisor application.
NOTE: You should have EcoStruxure Machine Advisor account to push the data to
EcoStruxure Machine Advisor application.
If the user network is behind the firewall, give the Proxy address in Proxy input field to the node,
so that it sends the data to the cloud.
The SE Machine Advisor node supports device node to EcoStruxure Machine Advisor cloud
communication using following protocols:
⚫ HTTPs
It works in open as well as closed network.
⚫ MQTTs
It works in open network only.
SE Machine Advisor node uses one of the transport format given below:
⚫ HTTPs - Tango data format (see page 68)
⚫ HTTPs - Charlie data format (see page 71)
⚫ MQTTs - Tango data format (see page 73)
⚫ MQTTs - Charlie data format (see page 76)

EcoStruxure Machine Advisor application supports either of the below formats given below:
⚫ Tango format
Use this format if address is available.
⚫ Charlie format
Use this format for tag or label names.

Node Description
SE Machine Advisor node consists of:

Item number Item name Description


1 Link node - Input Connects SE Machine Advisor node with collecting node.

36 EIO0000004100 09/2021
Launching SE Machine Advisor Node

Item number Item name Description


2 Connection status Indicates the following connection status:
⚫ Success: Data is pushed successfully to
EcoStruxure Machine Advisor cloud.
⚫ Connected: Node is ready to collect data and push to
EcoStruxure Machine Advisor cloud.
⚫ Invalid input: Indicates when input data is not in CMS format.
The data is not successfully pushed to
EcoStruxure Machine Advisor cloud.
⚫ Error: Indicates when the server is not responding.
⚫ ConfigError: Node is not configured.
⚫ Unauthorized: Indicates when the bearer token is incorrect.

2 Link node - Output Collected data is sent to EcoStruxure Machine Advisor cloud.

Examples of Data Format


Tango data uses array format. Charlie data uses variable format.
The following graphic is an example of converting CMS input to Tango output data format:

EIO0000004100 09/2021 37
Launching SE Machine Advisor Node

The following graphic is an example of converting CMS input to Charlie output data format:

38 EIO0000004100 09/2021
Launching SE Machine Advisor Node

Launching Node-RED and SE Machine Advisor Node - Linux Platform

Node-RED
After Node-RED and SE Machine Advisor node are installed, launch Node-RED server.

Step Action
1 Open a browser from system (Laptop or Desktop) connected in same network as the Linux
Edge box.
2 Type https://<ip address>:1880/in the URL field in the browser and press Enter.
NOTE: To know your IP address, type ifconfigin your Linux Edge box.
Result: Login window appears
3 Use your Node-RED login credentials (Username and Password) to operate Linux Edge box
through your system.
NOTE: As the browser is not accessible in the Linux Edge box, you can connect to another
system (Laptop or Desktop) using the Linux Edge box IP address.

EIO0000004100 09/2021 39
Launching SE Machine Advisor Node

Step Action
4

Result: Node-RED editor appears.

40 EIO0000004100 09/2021
Launching SE Machine Advisor Node

SE Machine Advisor Node

Step Action
1 In Node-RED window, use the scroll bar to find SE Machine Advisor node on the left side.
NOTE: Alternatively, you can also search from the Filter Nodes search option available at the
left side node palette area.

Result: In Cloud Storage category, SE Machine Advisor node is available.


NOTE: SE Machine Advisor nodes license information is available in the LICENSE tab. Help
manual is available in the HELP tab (right next to LICENSE tab).
2 Drag-and-drop SE Machine Advisor node on a flow page.

EIO0000004100 09/2021 41
Launching SE Machine Advisor Node

42 EIO0000004100 09/2021
Chapter 6
SE Machine Advisor Node

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
EcoStruxure Machine Advisor Login Page 44
HTTPs - Tango Data Format Configuration 68
HTTPs - Charlie Data Format Configuration 71
MQTTs - Tango Data Format Configuration 73
MQTTs - Charlie Data Format Configuration 76

EIO0000004100 09/2021 43
SE Machine Advisor Node

EcoStruxure Machine Advisor Login Page

Login to EcoStruxure Machine Advisor web page


The communication between SE Machine Advisor node and EcoStruxure Machine Advisor cloud
is possible when you have EcoStruxure Machine Advisor account. SE Machine Advisor node has
to be configured using the authentication token. This token can be obtained from the Config page
of EcoStruxure Machine Advisor web page.

Accessing EcoStruxure Machine Advisor web page

Step Action
1 Login to EcoStruxure Machine Advisor web page in Chrome/Mozilla browser using the below
link:
https://machine-advisor.schneider-electric.com
2 Click Join us.

44 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
3 Click Register tab.

EIO0000004100 09/2021 45
SE Machine Advisor Node

Step Action
4 Enter your account details and click Register.

Result: EcoStruxure Machine Advisor cloud home page appears.

46 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
5 On the home page, click MY MACHINE TYPES.

EIO0000004100 09/2021 47
SE Machine Advisor Node

Step Action
6 To create a new machine, click +.

48 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
7 Type the name of new machine (for instance, Demo).

EIO0000004100 09/2021 49
SE Machine Advisor Node

Step Action
8 Click ✔ and go back to home page.

50 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
9 On the home page, click REGISTER MACHINE.

EIO0000004100 09/2021 51
SE Machine Advisor Node

Step Action
10 Enter the name of your machine (for instance, Demo).

52 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
11 Select the type of your machine.

EIO0000004100 09/2021 53
SE Machine Advisor Node

Step Action
12 Select the customer of your machine.

54 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
13 Select the location in map where your machine is placed and click FINISH.

EIO0000004100 09/2021 55
SE Machine Advisor Node

Step Action
14 Go back to FLEET window.

56 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
15 Select your machine and click MONITOR.

EIO0000004100 09/2021 57
SE Machine Advisor Node

Step Action
16 Click Config tab.

58 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
17 Select mode as Connect your machine.

EIO0000004100 09/2021 59
SE Machine Advisor Node

Step Action
18 Select Harmony or Custom. Other gateways are not applicable.

60 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
19 Select the format from the drop down list given below:
⚫ TANGO
⚫ CHARLIE

NOTE: The same format should be selected while configuring SE Machine Advisor node
(see page 36).

EIO0000004100 09/2021 61
SE Machine Advisor Node

Step Action
20 Select the required transport protocol from the drop down list given below:
⚫ HTTPs
⚫ MQTTs

NOTE: The same protocol should be selected while configuring SE Machine Advisor node
(see page 36).
Result: The Generated Configuration details are available.

62 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
21 Copy the Server and click +New Token.
For HTTPs transport,

NOTE: The copied server link should be used while configuring SE Machine Advisor node.

EIO0000004100 09/2021 63
SE Machine Advisor Node

Step Action
22 For MQTTs transport,

Copy the parameters and click +New Token.


NOTE: The copied configuration details should be used while configuring SE Machine Advisor
node.

64 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
23 Select the Duration from the drop down given below:
⚫ 365 days
⚫ Custom

NOTE: Select Custom to set date and time as per your requirement.

EIO0000004100 09/2021 65
SE Machine Advisor Node

Step Action
24 Click CREATE.

25 Select I confirm I want to generate a new token. and click Yes.

66 EIO0000004100 09/2021
SE Machine Advisor Node

Step Action
26 Copy the Token.
NOTE: Make sure you keep the generated token in your system, because the token can not
be stored and you will be unable to see it again.

NOTE: The copied token should be used while configuring SE Machine Advisor node.

EIO0000004100 09/2021 67
SE Machine Advisor Node

HTTPs - Tango Data Format Configuration

Description
Double-click SE Machine Advisor node. The Properties screen of the node appears.

HTTPs - Tango data format configuration consists of the following:

Fields Description
Name Displays the name of the configuration.
Transport Click HTTPs.
NOTE: For successful communication, this field value should be
same as the field value on Config page of
EcoStruxure Machine Advisor web page (see page 36).

68 EIO0000004100 09/2021
SE Machine Advisor Node

Fields Description
Format Select the Tango format.
NOTE: For successful communication, this field value should be
same as the field value on Config page of
EcoStruxure Machine Advisor web page (see page 36).
Server Copy this value from EcoStruxure Machine Advisor web page and
paste in this field (See step no 15) (see page 44).
Token Copy this value from EcoStruxure Machine Advisor web page and
paste in this field (See step no 18) (see page 44).
Use Proxy Select the required option from the list:
⚫ Yes: If you are in proxy network (for example: Schneider
network), you should provide valid proxy.
⚫ No: If you are not in proxy network (for example, Schneider
network), you need not provide proxy.
NOTE: Proxy acts as a gateway primarily used for network
restrictions.
Proxy Use valid proxy with respect to your organization or country (for
instance, http://yourproxy:XXXX/).
NOTE: This field is enabled if you select Yes in Use Proxy field.
Prefix string Enter an identifier of the data for pushing the data to the cloud. In
case, the prefix string is not available, the device name obtained
from the device node is taken as the identifier.
NOTE: By default, the value is M001.
Start Address Enter starting address of the data received as input.
NOTE: This field is only for Tango data format.
Logging Select the Enable or Disable for logging the events.
By default, Enable is selected. When enabled, the log events are
recorded in the log file.
The log files will be saved in the path given below:
<Installed Node Directory>/nodes/log/
For instance the location will be:
⚫ Offline installation
 <User Directory>/se-node-red-
machine_advisor/nodes/log/
⚫ Online installation
 <User Directory>/.node-red/node_modules/se-
node-red-machine_advisor/nodes/log/

EIO0000004100 09/2021 69
SE Machine Advisor Node

Fields Description
Level Select the logging level from the list:
⚫ All Events
Error, info, debug messages are logged
⚫ Alerts Only
Error messages are logged
NOTE: By default, Alerts Only is selected.

70 EIO0000004100 09/2021
SE Machine Advisor Node

HTTPs - Charlie Data Format Configuration

Description
Double-click SE Machine Advisor node. The Properties screen of the node appears.

HTTPs - Charlie data format configuration consists of the following:

Fields Description
Name Displays the name of the configuration.
Transport Click HTTPs.
NOTE: For successful communication, this field value should be
same as the field value on Config page of
EcoStruxure Machine Advisor web page (see page 36).

EIO0000004100 09/2021 71
SE Machine Advisor Node

Fields Description
Format Select the Charlie format.
NOTE: For successful communication, this field value should be
same as the field value on Config page of
EcoStruxure Machine Advisor web page (see page 36).
Server Copy this value from EcoStruxure Machine Advisor web page and
paste in this field (See step no 15) (see page 44).
Token Copy this value from EcoStruxure Machine Advisor web page and
paste in this field (See step no 18) (see page 44).
Use Proxy Select the required option from the list:
⚫ Yes: If you are in proxy network (for example: Schneider
network), you should provide valid proxy.
⚫ No: If you are not in proxy network (for example, Schneider
network), you need not provide proxy.
NOTE: Proxy acts as a gateway primarily used for network
restrictions.
Proxy Use valid proxy with respect to your organization or country (for
instance, http://yourproxy:XXXX/).
NOTE: This field is enabled if you select Yes in Use Proxy field.
Prefix string Enter an identifier of the data for pushing the data to the cloud. In
case, the prefix string is not available, the device name obtained
from the device node is taken as the identifier.
NOTE: By default, the value is M001.
Logging Select the Enable or Disable for logging the events.
By default, Enable is selected. When enabled, the log events are
recorded in the log file.
The log files will be saved in the path given below:
<Installed Node Directory>/nodes/log/
For instance the location will be:
⚫ Offline installation
 <User Directory>/se-node-red-
machine_advisor/nodes/log/
⚫ Online installation
 <User Directory>/.node-red/node_modules/se-
node-red-machine_advisor/nodes/log/
Level Select the logging level from the list:
⚫ All Events
Error, info, debug messages are logged
⚫ Alerts Only
Error messages are logged
NOTE: By default, Alerts Only is selected.

72 EIO0000004100 09/2021
SE Machine Advisor Node

MQTTs - Tango Data Format Configuration

Description
Double-click SE Machine Advisor node. The Properties screen of the node appears.

MQTTs - Tango data format configuration consists of the following:

Fields Description
Name Displays the name of the configuration.
Transport Click MQTTs.
NOTE: For successful communication, this field value should be
same as the field value on Config page of
EcoStruxure Machine Advisor web page (see page 36).

EIO0000004100 09/2021 73
SE Machine Advisor Node

Fields Description
Format Select the Tango format.
NOTE: For successful communication, this field value should be
same as the field value on Config page of
EcoStruxure Machine Advisor web page (see page 36).
Broker URL Copy this value from EcoStruxure Machine Advisor web page and
paste in this field (See step no 17) (see page 44).
Topic Copy Topic value from EcoStruxure Machine Advisor web page
and paste in this field (See step no 17) (see page 44).
Username Copy this value from your EcoStruxure Machine Advisor account
where data is pushed and paste in this field (See step no 17)
(see page 44).
Password Copy this value from your EcoStruxure Machine Advisor account
where data is pushed and paste in this field (See step no 18)
(see page 44).
NOTE: Paste the generated token as password.
Client Id Copy this value from your EcoStruxure Machine Advisor account
where data is pushed and paste in this field (See step no 17)
(see page 44).
Prefix string Enter an identifier of the data for pushing the data to the cloud. In
case, the prefix string is not available, the device name obtained
from the device node is taken as the identifier.
NOTE: By default, the value is M001.
Start Address Enter starting address of the data received as input.
NOTE: This field is only for Tango data format.
Logging Select the Enable or Disable for logging the events.
By default, Enable is selected. When enabled, the log events are
recorded in the log file.
The log files will be saved in the path given below:
<Installed Node Directory>/nodes/log/
For instance the location will be:
⚫ Offline installation
 <User Directory>/se-node-red-
machine_advisor/nodes/log/
⚫ Online installation
 <User Directory>/.node-red/node_modules/se-
node-red-machine_advisor/nodes/log/

74 EIO0000004100 09/2021
SE Machine Advisor Node

Fields Description
Level Select the logging level from the list:
⚫ All Events
Error, info, debug messages are logged
⚫ Alerts Only
Error messages are logged
NOTE: By default, Alerts Only is selected.

EIO0000004100 09/2021 75
SE Machine Advisor Node

MQTTs - Charlie Data Format Configuration

Description
Double-click SE Machine Advisor node. The Properties screen of the node appears.

MQTTs - Charlie data format configuration consists of the following:

Fields Description
Name Displays the name of the configuration.
Transport Click MQTTs.
NOTE: For successful communication, this field value should be
same as the field value on Config page of
EcoStruxure Machine Advisor web page (see page 36).

76 EIO0000004100 09/2021
SE Machine Advisor Node

Fields Description
Format Select the Charlie format.
NOTE: For successful communication, this field value should be
same as the field value on Config page of
EcoStruxure Machine Advisor web page (see page 36).
Broker URL Copy this value from EcoStruxure Machine Advisor web page and
paste in this field (See step no 17) (see page 44).
Topic Copy Topic value from EcoStruxure Machine Advisor web page
and paste in this field (See step no 17) (see page 44).
Username Copy this value from your EcoStruxure Machine Advisor account
where data is pushed and paste in this field (See step no 17)
(see page 44).
Password Copy this value from your EcoStruxure Machine Advisor account
where data is pushed and paste in this field (See step no 18)
(see page 44).
NOTE: Paste the generated token as password.
Client Id Copy this value from your EcoStruxure Machine Advisor account
where data is pushed and paste in this field (See step no 17)
(see page 44).
Prefix string Enter an identifier of the data for pushing the data to the cloud. In
case, the prefix string is not available, the device name obtained
from the device node is taken as the identifier.
NOTE: By default, the value is M001.
Logging Select the Enable or Disable for logging the events.
By default, Enable is selected. When enabled, the log events are
recorded in the log file.
The log files will be saved in the path given below:
<Installed Node Directory>/nodes/log/
For instance the location will be:
⚫ Offline installation
 <User Directory>/se-node-red-
machine_advisor/nodes/log/
⚫ Online installation
 <User Directory>/.node-red/node_modules/se-
node-red-machine_advisor/nodes/log/
Level Select the logging level from the list:
⚫ All Events
Error, info, debug messages are logged
⚫ Alerts Only
Error messages are logged
NOTE: By default, Alerts Only is selected.

EIO0000004100 09/2021 77
SE Machine Advisor Node

78 EIO0000004100 09/2021
Chapter 7
Usage of SE Machine Advisor Node

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Usage of SE Machine Advisor Node 80
Troubleshooting 82
Common Message Structure (CMS) 83

EIO0000004100 09/2021 79
Usage of SE Machine Advisor Node

Usage of SE Machine Advisor Node

The user needs to connect SE Modbus node as an input to collect data and upload it to the
EcoStruxure Machine Advisor cloud.
The procedure for the use of SE Machine Advisor node is given below:

Step Action
1 Launch Node-RED server and SE Machine Advisor (see page 39) node.
2 Launch SE Modbus Read node (see Node-RED – SE Modbus Basic Nodes, User Manual).
3 Connect two nodes by joining the output of SE Modbus Read with input of SE Machine Advisor
as shown below:

4 Double-click SE Machine Advisor node.


Result: Edit SEMachineAdvisor node opens.
5 Configure SE Machine Advisor node (see page 36).
NOTE: You need to configure SE Machine Advisor node by copying the required details from
EcoStruxure Machine Advisor web page and filling the remaining fields.
6 Double-click SE Modbus Read node.
Result: Edit SEModbusRead node opens.

80 EIO0000004100 09/2021
Usage of SE Machine Advisor Node

Step Action
7 Configure SE Modbus Read node (see Node-RED – SE Modbus Basic Nodes, User Manual).
NOTE: The Values page of EcoStruxure Machine Advisor application shows the details of the
data pushed to the cloud with timestamp.
8
Click Done and Deploy to save the changes.
Result: Nodes status changes to Connected.
Result: The data is pushed to the cloud at a frequency defined in the Poll Rate field of
SE Modbus Read node.

Communicating Data to the EcoStruxure Machine Advisor Cloud


When SE Machine Advisor node is connected to collecting node it receives the data in the CMS
format.
You need to configure SE Machine Advisor node to initiate a communication. This can be done by
copying the required details from EcoStruxure Machine Advisor Cloud Login Page (see page 44)
depending upon the configuration (see page 36). EcoStruxure Machine Advisor converts the input
data in Tango/ Charlie format and pushes the data to EcoStruxure Machine Advisor cloud.
EcoStruxure Machine Advisor cloud communication gives response status when the data is
succesfully pushed to the cloud.

The status is displayed in Debug window located on the right side of Node-RED.

Store and forward mechanism


In case of network interruption, the data is stored locally to a file. Whenever the data is pushed
successfully after interruption, the stored data is pushed to the cloud in an iterative manner.
150 records are pushed per iteration. After pushing first iteration successfully and with success
acknowledge, next iteration is initiated. The process is continued till the file is emptied and all store
and forward files are pushed. Each node creates separate Store and Forward file stored in the
node directory. When SE Machine Advisor node is deleted, then corresponding store and forward
file is deleted from the directory.
The stored data files will be saved in the path given below:
<Installed Node Directory>/nodes/data/

EIO0000004100 09/2021 81
Usage of SE Machine Advisor Node

Troubleshooting

All the error messages are logged in the log file. If you come across with any below problems, try
the following solutions:

Cause Response Status Solution


When the server URL Enter the valid URL.
configured is not valid

When authentication is not Login with valid credentials.


valid

When unable to reach the Check for network connectivity.


server
NOTE: In case of network
interruption, the data is stored
locally in a file. This data is pushed
iteratively after connection is
restored.
Log events are not captured – Verify if the log folder has WRITE
permission.
Store and Forward – Verify if the data folder has
information not captured READ/WRITE permission.

82 EIO0000004100 09/2021
Usage of SE Machine Advisor Node

Common Message Structure (CMS)

CMS is standard JSON format between a connecting node and a publishing node to avoid any
intermediate functions. JSON is a standard way for representing a JavaScript object as a string. It
is commonly used by web APIs to return data.
A Node-RED flow works by passing messages between nodes. All the messages conform to a
common message format to simplify the message content navigation. The messages are simple
JavaScript objects that can have any set of properties.
The following is the CMS structure:

Field Description
Name Name of the node.
Id Unique Identifier
Timestamp Time duration for which data was read.
Devices Applicable for Harmony Hub sensor. All nested
objects inside are mandatory if atleast one device
object exists.

EIO0000004100 09/2021 83
Usage of SE Machine Advisor Node

Field Description
Data Object at root level and as a composite inside
Devices. It contains at least one property object.
Error Error at the root level, not tied to any parameter.
⚫ Scenario 1: Gateway disconnected.
⚫ Scenario 2: Gateway timed out.
⚫ Scenario 3: Modbus port not opened.
⚫ Scenario 4: Gateway connected. Read Error
encountered.
Property If data object exists, then atleast one property is
mandatory. Mapped to the parameter details. It
contains Error, Value, Unit, Type.
Error Local error pertaining to the parameter.
⚫ Scenario 1: No Radio (at a sensor level)
⚫ Scenario 2: Parameter Read Error encountered.
(e.g.FF, FFFF, FFFFFFFF)
 Value: When mandatory, always in case of
success. When optional, in case of error.
 Unit - optional field
 Type - optional field

The following graphics are an example of CMS data:


Example 1: One device connected directly through SE Machine Advisor node output:

84 EIO0000004100 09/2021
Usage of SE Machine Advisor Node

Example 2: One gateway (associated with multiple devices) connected through


SE Machine Advisor node output:

EIO0000004100 09/2021 85
Usage of SE Machine Advisor Node

86 EIO0000004100 09/2021
Part IV
IIoT and Cybersecurity

EIO0000004100 09/2021 87
88 EIO0000004100 09/2021
Chapter 8
IIoT and Cybersecurity

Cybersecurity

Overview
Because of the IIoT design, industrial and control systems are increasingly vulnerable to cyber-
attacks for the following reasons:
⚫ Harmony Edge Box and Harmony iPC are commercially available in the market.
⚫ Publishing nodes can be remotely accessible.
⚫ IIoT designs are a strategic location in the industrial processes that is of interest to hackers.

To secure the industrial installation, the following fundamental characteristics should be


considered:
⚫ Availability of the system to help ensure that the system remains operational
⚫ Integrity of the data to maintain the integrity of information
⚫ Confidentiality to avoid information disclosure

General Practices
To keep the system as secured as possible, secure the environment where the Box is installed.
Unauthorized persons may gain access to the Harmony iPC and Harmony Edge Box as well as to
other devices on the network/fieldbus of the machine and connected networks via insufficiently
secure access to the software and networks.
Before creating user login details, cross-check again if it is necessary to give access to others.
Users may have one of two permissions (*-full access/read-only access). Admin login and
password details must be secured.
To avoid unauthorized access to the Harmony iPC and Harmony Edge Box, you must have the:
⚫ Operating system, libraries, runtime environments, etc. are installed and correctly configured.
⚫ Patch management controls to ensure that all software is kept up-to-date.
⚫ Configuration change management controls.
⚫ Malicious code detection and prevention controls, for example:
 Anti-virus signature and pattern updates are applied in a timely fashion.
 Application whitelisting.

⚫ Access control and permission management.


⚫ Backup and restore functionality.
⚫ Area where the Box is placed must be physically protected to keep the device as safe as
possible.

EIO0000004100 09/2021 89
IIoT and Cybersecurity

⚫ Authentication and authorization enabled for Node-RED environment.


⚫ SSL enabled to secure Node-RED in Windows platform. By default, SSL is enabled to secure
Node-RED in the HMIBSC boxes.

Cybersecurity Certification
Schneider Electric developed cybersecurity guidelines based on the following recommendations:
⚫ ISA Secure.

90 EIO0000004100 09/2021

You might also like