EcoStruxure Machine Expert Machine Advisor Communication Example Guide

(1)

67.01

EcoStruxure Machine Expert EIO0000003867 04/2020

EcoStruxure Machine

Expert

Machine Advisor Communication

Example Guide

(2)

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.

(3)

Safety Information. . .

5 About the Book . . .

9 Chapter 1 Example Description. . .

15

Overview . . .

₁₅

Chapter 2 Project Information . . .

17

2.1 Hardware Configuration. . .

₁₈

Overview of the Hardware Configuration. . .

₁₈

2.2 Application . . .

₁₉

Overview of the Application . . .

₂₀

Libraries. . .

₂₀

Program Organization Units (POUs) . . .

₂₂

2.3 Visualization . . .

₂₄

Visualization Screens . . .

₂₄

2.4 Running the Application Example . . .

₂₉

Preconditions for Running the Application Example . . .

₃₀

Creating a User Management for the Visualization . . .

₃₀

Downloading the Application . . .

₃₁

Operating the Application . . .

₃₁

(4)

(5)

Safety Information

Important Information

NOTICE

(6)

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.

BEFORE YOU BEGIN

Do not use this product on machinery lacking effective point-of-operation guarding. Lack of effective point-of-operation guarding on a machine can result in serious injury to the operator of that machine.

This automation equipment and related software is used to control a variety of industrial processes. The type or model of automation equipment suitable for each application will vary depending on factors such as the control function required, degree of protection required, production methods, unusual conditions, government regulations, etc. In some applications, more than one processor may be required, as when backup redundancy is needed.

Only you, the user, machine builder or system integrator can be aware of all the conditions and factors present during setup, operation, and maintenance of the machine and, therefore, can determine the automation equipment and the related safeties and interlocks which can be properly used. When selecting automation and control equipment and related software for a particular application, you should refer to the applicable local and national standards and regulations. The National Safety Council's Accident Prevention Manual (nationally recognized in the United States of America) also provides much useful information.

In some applications, such as packaging machinery, additional operator protection such as point-of-operation guarding must be provided. This is necessary if the operator's hands and other parts of the body are free to enter the pinch points or other hazardous areas and serious injury can occur. Software products alone cannot protect an operator from injury. For this reason the software cannot be substituted for or take the place of point-of-operation protection.

Ensure that appropriate safeties and mechanical/electrical interlocks related to point-of-operation

WARNING

UNGUARDED EQUIPMENT

 Do not use this software and related automation equipment on equipment which does not have

point-of-operation protection.

 Do not reach into machinery during operation.

(7)

NOTE: Coordination of safeties and mechanical/electrical interlocks for point-of-operation protection is outside the scope of the Function Block Library, System User Guide, or other implementation referenced in this documentation.

START-UP AND TEST

Before using electrical control and automation equipment for regular operation after installation, the system should be given a start-up test by qualified personnel to verify correct operation of the equipment. It is important that arrangements for such a check be made and that enough time is allowed to perform complete and satisfactory testing.

Follow all start-up tests recommended in the equipment documentation. Store all equipment documentation for future references.

Software testing must be done in both simulated and real environments.

Verify that the completed system is free from all short circuits and temporary grounds that are not installed according to local regulations (according to the National Electrical Code in the U.S.A, for instance). If high-potential voltage testing is necessary, follow recommendations in equipment documentation to prevent accidental equipment damage.

Before energizing equipment:

 Remove tools, meters, and debris from equipment.  Close the equipment enclosure door.

 Remove all temporary grounds from incoming power lines.  Perform all start-up tests recommended by the manufacturer.

WARNING

EQUIPMENT OPERATION HAZARD

 Verify that all installation and set up procedures have been completed.

 Before operational tests are performed, remove all blocks or other temporary holding means

used for shipment from all component devices.

 Remove tools, meters, and debris from equipment.

(8)

OPERATION AND ADJUSTMENTS

The following precautions are from the NEMA Standards Publication ICS 7.1-1995 (English version prevails):

 Regardless of the care exercised in the design and manufacture of equipment or in the selection

and ratings of components, there are hazards that can be encountered if such equipment is improperly operated.

 It is sometimes possible to misadjust the equipment and thus produce unsatisfactory or unsafe

operation. Always use the manufacturer’s instructions as a guide for functional adjustments. Personnel who have access to these adjustments should be familiar with the equipment manufacturer’s instructions and the machinery used with the electrical equipment.

 Only those operational adjustments actually required by the operator should be accessible to

(9)

About the Book

At a Glance

Document Scope

This document describes an application example for implementing the sending of telemetry data to the EcoStruxure Machine Advisor cloud application.

Since the example described in this document is intended for learning purposes only, it must not be used directly on products that are part of a machine or process.

This document and its related EcoStruxure Machine Expert project file focus on specific functions and function blocks of the Schneider Electric libraries provided with EcoStruxure Machine Expert, and on specific features available in EcoStruxure Machine Expert if these features are related to these libraries. They are intended to help you understand how to develop, test, commission, and integrate applicative software of your own design on control systems.

It is intended for new EcoStruxure Machine Expert users who already have some degree of expertise in the design and programming of control systems.

Validity Note

This document has been updated for the release of EcoStruxureTM Machine Expert V1.2.3. The technical characteristics of the devices described in the present document also appear online. To access the information online:

WARNING

UNINTENDED EQUIPMENT OPERATION

Do not include the code from this example in your machine or process without thoroughly testing your entire application.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Step Action

1 Go to the Schneider Electric home page www.schneider-electric.com.

2 In the Search box type the reference of a product or the name of a product range.

 Do not include blank spaces in the reference or product range.  To get information on grouping similar modules, use asterisks (*).

3 If you entered a reference, go to the Product Datasheets search results and click on the reference that interests you.

(10)

The characteristics that are described in the present document should be the same as those characteristics that appear online. In line with our policy of constant improvement, we may revise content over time to improve clarity and accuracy. If you see a difference between the document and online information, use the online information as your reference.

Product Related Information

1_{For additional information, refer to NEMA ICS 1.1 (latest edition), "Safety Guidelines for the}

Application, Installation, and Maintenance of Solid State Control" and to NEMA ICS 7.1 (latest edition), "Safety Standards for Construction and Guide for Selection, Installation and Operation of Adjustable-Speed Drive Systems" or their equivalent governing your particular location.

Before you attempt to provide a solution (machine or process) for a specific application using the POUs found in the library, you must consider, conduct and complete best practices. These practices include, but are not limited to, risk analysis, functional safety, component compatibility, testing and system validation as they relate to this library.

4 If more than one reference appears in the Products search results, click on the reference that interests you.

5 Depending on the size of your screen, you may need to scroll down to see the datasheet. 6 To save or print a datasheet as a .pdf file, click Download XXX product datasheet. Step Action

WARNING

LOSS OF CONTROL

 The designer of any control scheme must consider the potential failure modes of control paths

and, for certain critical control functions, provide a means to achieve a safe state during and after a path failure. Examples of critical control functions are emergency stop and overtravel stop, power outage and restart.

 Separate or redundant control paths must be provided for critical control functions.

 System control paths may include communication links. Consideration must be given to the

implications of unanticipated transmission delays or failures of the link.

 Observe all accident prevention regulations and local safety guidelines.1

 Each implementation of this equipment must be individually and thoroughly tested for proper

operation before being placed into service.

(11)

Incomplete file transfers, such as data files, application files and/or firmware files, may have serious consequences for your machine or controller. If you remove power, or if there is a power outage or communication interruption during a file transfer, your machine may become inoperative, or your application may attempt to operate on a corrupted data file. If an interruption occurs, reattempt the transfer. Be sure to include in your risk analysis the impact of corrupted data files.

WARNING

IMPROPER USE OF POUS

 Perform a safety-related analysis for the application and the devices installed.

 Ensure that the POUs are compatible with the devices in the system and have no unintended

effects on the proper functioning of the system.

 Use appropriate parameters, especially limit values, and observe machine wear and stop

behavior.

 Verify that the sensors and actuators are compatible with the selected POUs.

 Thoroughly test all functions during verification and commissioning in all operation modes.  Provide independent methods for critical control functions (emergency stop, conditions for limit

values being exceeded, etc.) according to a safety-related analysis, respective rules, and regulations.

WARNING

UNINTENDED EQUIPMENT OPERATION

 Only use software approved by Schneider Electric for use with this equipment.

 Update your application program every time you change the physical hardware configuration.

WARNING

UNINTENDED EQUIPMENT OPERATION, DATA LOSS, OR FILE CORRUPTION

 Do not interrupt an ongoing data transfer.

 If the transfer is interrupted for any reason, re-initiate the transfer.

 Do not place your machine into service until the file transfer has completed successfully,

(12)

Chapter 1 Example Description

Overview

Short Description

The project implements an application example which shows how to implement the sending of telemetry data to the EcoStruxure Machine Advisor cloud application.

The example provides two different solutions for the communication with the EcoStruxure Machine Advisor cloud application:

 Via secured MQTT (MQTTS) using the MqttHandling library  Via secured HTTP (HTTPS) using the HttpHandling library

The data is sent as JSON string in the format Charlie, which is a dedicated format supported by the EcoStruxure Machine Advisor data connector. The data in JSON format are created using the function block FB_CreateJsonFormattedString out of the FileFormatUtility library.

System Requirements and Limitations

The application example has been created and tested with the components listed in the table:

Component Type and Version

Software  EcoStruxure Machine Expert V1.1

Controller  Modicon M262 Logic/Motion Controller

(16)

(17)

EcoStruxure Machine Expert Project Information EIO0000003867 04/2020 Project Information

Chapter 2 Project Information

Overview

This section provides information about the EcoStruxure Machine Expert project.

What Is in This Chapter?

This chapter contains the following sections:

Section Topic Page

2.1 Hardware Configuration 18

2.2 Application 19

2.3 Visualization 24

(18)

Project Information

Hardware Configuration

Section 2.1

Hardware Configuration

Overview of the Hardware Configuration

Overview

To run the application example, the following hardware installation was tested:

1 Modicon M262 Logic/Motion Controller 2 PC with EcoStruxure Machine Expert 3 Internet Router

4 EcoStruxure Machine Advisor (cloud server)

For further information about the EcoStruxure Machine Advisor cloud application, refer to

(19)

Project Information

Application

Section 2.2

Application

What Is in This Section?

This section contains the following topics:

Topic Page

Overview of the Application 20

Libraries 20

(20)

Project Information

Overview of the Application

Overview

The example application implements an HTTP client and an MQTT client. Each of these clients can be used to connect to the registered machine twin in EcoStruxure Machine Advisor. Via this connection the data is sent to the EcoStruxure Machine Advisor. Before the data is sent, it is converted into the specified format using the FB_CreateJsonFormattedString function block from the FileFormatUtility library.

In addition, the example includes a visualization for the configuration, control, and monitoring of the communication.

The following features are supported:

 Establishing a connection to the EcoStruxure Machine Advisor either via  Secured MQTT (MQTTS), or

 Secured HTTP (HTTPS)

 Simulating process and OEE (Overall Equipment Effectiveness) data of the machine  Creation of the JSON formatted string containing the OEE data in the format required by

EcoStruxure Machine Advisor

 Transmission of the data through the connection to the EcoStruxure Machine Advisor  Provides a DNS client to resolve a given domain name to an IPv4 address.

 Dynamic configuration of the controller firewall from the application program during runtime.

Libraries

Overview

The following libraries have been added to the Library Manager of the application:

Library Company Function

FileFormatUtility Schneider Electric Provides utility functions to access text files of certain formats. HttpHandling Schneider Electric Provides the HTTP client functionality to connect to an HTTP server

and to sent data to or to retrieve data from it.

MqttHandling Schneider Electric Provides the MQTT client functionality to exchange data with other devices over the network.

StringUtil System Provides tool functions for processing of variables of data type STRING.

SysMem System Provides components to access the dynamic memory management of the runtime system.

(21)

Project Information

The libraries MqttHandling, HttpHandling, and FileFormatUtility provide global parameters to configure the supported functions. You can access these parameters in the global parameter list (GPL) available in the Library Manager of the application. These parameters are editable constant variables. In consequence, they must be defined before the application is downloaded to the controller.

The table lists the parameter that has been modified in this application example:

Global Variable List (GVL)

Util System Provides function blocks and functions for the following use cases: Analog monitors, BCD (binary coded decimal) conversions, bit/byte functions, controller, function manipulators, mathematical functions, and signals.

CAA File CAA Technical

Workgroup Provides function blocks for accessing the system file directory and its files.

Library Company Function

Library Parameter Default value Applied value

MqttHandling GPL.Gc_uiMaxLengthOfClientID 23 255

Global variable list Description

GVL Contains variable declarations for general variables used globally in the application.

(22)

Project Information

Program Organization Units (POUs)

SR_DnsClient

The program implements the DNS client functionality.

SR_MachineAdvisorLink

The program implements the program code to control the communication to the EcoStruxure Machine Advisor.

The program code has been split into single logical functions. The single program parts are processed in subroutines, referred to as actions.

The actions called from the program are listed in the following table:

Name of the subroutine (action) Description

ACT_InputMapping In this logic, the input variables, mainly coming from the visualization, are verified and assigned to local variables for further processing.

ACT_StateMachineMqttClient This logic implements the state machine for the operation of the instance of the function block FB_MqttClient and the associated FB_MqttPublish. The general states are:

 Initialization of the function blocks

 Establishing the connection to the EcoStruxure Machine Advisor  Monitoring the status of the connection

 Publishing of a message

 Monitoring the execution of the data transmission  Disconnecting

 Error handling

ACT_StateMachineHttpClient This logic implements the state machine for the operation of the instance of the function block FB_HttpClient.

The general states are:

 Establishing the connection to the EcoStruxure Machine Advisor  Monitor the status of the connection

 Sending the HTTP request

 Processing the response from the server  Disconnecting

 Error handling

ACT_CreateDataString This logic implements the conversion of the process data into required JSON format to be transmitted to the EcoStruxure Machine Advisor.

ACT_VerifyNexttransmission This logic implements the verification if there is a request for transmission of data is active.

(23)

Project Information

SR_VisControl

The program SR_VisControl implements additional program code to control the displayed information on the visualization in the Logic Builder within the EcoStruxure Machine Expert software.

SR_SimulatedMachineData

The program SR_SimulatedMachineData implements the simulation of process values which are converted into the JSON formatted string and then transmitted to the EcoStruxure Machine Advisor.

SR_FirewallConfig

The program implements the dynamic configuration of the controller firewall.

After a warmstart of the application, the firewall of the controller is configured as follows:

Protocol Ethernet1 Ethernet2

Modbus Server Rejected Rejected

SNMP Rejected Rejected

Web Server (HTTP) Rejected Rejected

(24)

Project Information Visualization

Section 2.3

Visualization

Visualization Screens

Overview

The application example implements a visualization in the Logic Builder within the EcoStruxure Machine Expert software which can be used to control and monitor the application. Three visualization screens are provided which can be switched from the Visu_Main.

The visualization also exists as web visualization.

(25)

Project Information

Login Page

Visu_Login

WARNING

UNAUTHENTICATED, UNAUTHORIZED ACCESS

 Do not expose controllers and controller networks to public networks and the Internet as much

as possible.

 Use additional security layers, such as VPN, for remote access and install firewall

mechanisms.

 Restrict access to authorized personnel by activation and deployment of the user

management of the controller and the visualization.

 Change default passwords at start-up and modify them frequently.

 Validate the effectiveness of these measurements regularly and frequently.

(26)

Project Information

Machine Advisor HTTPs

(27)

Project Information

Machine Advisor MQTTs

(28)

Project Information

DNS Client

(29)

Project Information

Running the Application Example

Section 2.4

Running the Application Example

What Is in This Section?

This section contains the following topics:

Topic Page

Preconditions for Running the Application Example 30

Creating a User Management for the Visualization 30

Downloading the Application 31

(30)

Project Information

Preconditions for Running the Application Example

Overview

To run the application example, the following preconditions must be fulfilled:

 User management for EcoStruxure Machine Expert visualization is created.

 The application is downloaded and is running on the associated Modicon M262 Logic/Motion

Controller.

 A PC, laptop, or mobile device with a compatible web browser is connected to the same network

as the controller so that the web visualization can be accessed.

 An account on the EcoStruxure Machine Advisor exists and a machine is registered and

configured for either HTTPs or MQTTs connection.

Creating a User Management for the Visualization

Overview

To create a user management for the visualization, perform these steps:

Step Action Comment

1 Double-click the Visualization Manager node in the

Tools tree. –

2 Open the tab User management. – 3 Click the Create empty user management or Create

user management with default groups and users button to create the user management for the visualization in your application.

–

4 Configure the users and groups according to your

(31)

Project Information

Downloading the Application

Overview

To set the communication parameter of the controller, and to download the applications, perform these steps:

For more information on downloading an application and the communication settings, refer to the EcoStruxure Machine Expert Programming Guide (see EcoStruxure Machine Expert,

Programming Guide).

Operating the Application

General

The application example implements a web visualization for monitoring and control purposes. This section provides a brief description of each function. In addition, refer to the visualization screen (see page 24).

Open the Web Visualization

To open the web visualization, enter the following address in the address bar of your web browser:

Step Action Comment

1 Connect your PC to the controller via Ethernet. The controller and the PC must be connected to the same Ethernet network.

2 Open the application example in EcoStruxure Machine

Expert. –

3 Double-click the MyController node in the Devices

tree. Result: A network scan is performed. Available controllers are provided in the Controller selection view of the device editor.

4 Select the target controller from the list. – 5 Right-click the controller entry and execute the

command Process communication settings... from the contextual menu.

– 6 Enter the Communication parameter. – 7 Activate the option Save settings permanently and

click the OK button. Result: The communication parameters are stored on the controller. They are retained if it is restarted. These parameters override the application settings.

8 Execute the Multiple Download... command from the

Online menu. –

9 In the Multiple Download dialog box, select the

(32)

Project Information

https://<IP address of the controller>:8089/webvisu.htm

When you are connecting to the controller web visualization, two login prompts are displayed:

 Login to gain general access to the web visualization: Only users with access rights to the

runtime object WEB can connect to the web visualization. Refer to the user management of the controller.

 Login to the start page (Visu_Login (see page 25)) of the web visualization to get access to the

main page. Depending on the rights granted to the user that is logging in, access to objects on the visualization screens can be limited. Refer to the user management of the visualization manager.

Register a New Machine in EcoStruxure Machine Advisor

Before you can send data from your controller to the EcoStruxure Machine Advisor a machine must be registered in your account, to this you can connect to.

Once the machine is registered, navigate to Monitor → Config and configure the connection:

Obtain the IPv4 Address Using the DNS Client

For the connection to the EcoStruxure Machine Advisor, the corresponding client requires the IPv4 address of the EcoStruxure Machine Advisor. The IPv4 address can be obtained by using the

Step Action

1 Activate the radio button M262 as gateway. 2 Select the format Charlie.

3 Use either HTTPs or MQTTs as transport protocol.

(33)

Project Information

Establish a Connection to the EcoStruxure Machine Advisor Using the MQTT Client

Before you can establish a connection, you must specify the corresponding parameters.

 Enter the IPv4 address of the EcoStruxure Machine Advisor (also refer to the DNS client

visualization)

 The port number corresponds to the standard MQTTS port and must be set to 8883.

 Enter the corresponding parameters Client ID, Username, and Password, which are provided

on the EcoStruxure Machine Advisor configuration page.

 The TopicName is filled automatically when entering the Client ID, the format is

devices/<client id>/messages/events/

To establish the connection, click Connect. The progress and the result of the operation is displayed in the display Status on the visualization screen. After the connection is successfully established, the connection status changes to Connected. The button Connect changes to Disconnect and can be used to close the connection (refer to Considerations for TLS Certificates (see page 34)).

The application example implements an auto reconnect function which can be activated / deactivated at any time.

Establish a Connection to the EcoStruxure Machine Advisor Using the HTTP Client

Before you can establish a connection, you must specify the corresponding parameters.

 Enter the IPv4 address of the EcoStruxure Machine Advisor, in case there is an http proxy

server between your controller and the Internet, enter the IPv4 address of the proxy server.

 The port number corresponds to the standard HTTPS port and must be set to 443.

 Enter the corresponding parameters Hostname, Resource, Custom Header 1, and Custom

Header 2, which are provided on the EcoStruxure Machine Advisor configuration page. NOTE: If you have the server URL available for the registered machine twin, you can also enter this into the field Server URL. Doing so, the required fields Hostname and Resource are filled automatically.

To establish the connection, click Connect. The progress and the result of the operation is displayed in the display Status on the visualization screen. After the connection is successfully established, the connection status changes to Connected. The button Connect changes to Disconnect and can be used to close the connection (refer to Considerations for TLS Certificates (see page 34)).

(34)

Project Information

Transmit Data

The application implements four different sample data assets which can be sent to the EcoStruxure Machine Advisor. Therefore, the visualizations for the HTTP client and the MQTT client provided the dedicated displays:

 Data OEE - asset 1  Data Motor1 - asset 2  Data Motor2 - asset 3  Test - asset 4

Each of the four data assets can be edited from the visualization by clicking Edit data.

To request the transmission of the data asset, click Transmit. If the button Transmit is green, the request for the transmission is stored it switches back to grey when the transmission request has been processed.

The request is processed when the following preconditions are fulfilled:

 The corresponding client is in state Connected.  No other data transmission is in progress.

The result of the data transmission is provided in the associated display. Depending on the used client, the detailed status of the latest data transmission is provided on the corresponding visualization screen.

For the HTTP client, the http status code, the header, and the content of the received server response are provided.

For the MQTT client, the status and the result of the function block FB_MqttPublish are provided.

Considerations for TLS Certificates

The clients in the application are configured that only connections to servers which provide a trusted certificate are accepted. This requires that you must declare the server certificate as trusted on your controller. For more information about certificate management on the controller, refer to

(35)

EcoStruxure Machine Expert Index EIO0000003867 04/2020

Index

A

application examples, 15

E

examples

Machine Advisor Communication Exam-ple, 9

EcoStruxure Machine Expert Machine Advisor Communication Example Guide