manualshive.com logo in svg

Emerson PACSystems, User Manual, Page: 19 / 47

Share
Download
Emerson PACSystems User Manual Download Page 19

User Guide  

Chapter 4 

GFK-3019G 

Oct 2019 

 

Modbus RTU Machine Adapter 

 

 

15 

 

Chapter 4:

 

Modbus RTU Machine Adapter 

4.1

 

Modbus RTU Machine Adapter Architecture  

Modbus RTU is an open, industry standard serial protocol used by many industrial devices 
to  communicate.  Modbus  RTU  enables  a  Modbus  Slave  to  share  a  portion  of  its  internal 
reference memory with one or more Modbus Masters. The Modbus RTU Machine Adapter 
enables a Mini Field Agent to act as a Modbus Master to read data from a Modbus Slave 
connected  by  a  RS-232  serial  cable  and  make  this  industrial  data  available  to  the  Predix 
Machine platform and Predix Cloud. 

4.1.1

 

Features and Compatibility 

This table lists the Modbus RTU Machine Adapter features and compatibility. 

Features 

Modbus RTU Machine Adapter 170102.1.0 

Modbus Read 

Yes 

Modbus Write 

No 

Predix Machine Version 

17.1 

4.2

 

Obtaining the Modbus RTU Machine Adapter 

The Modbus RTU Machine Adapter must be purchased for each Field Agent where it will be 
installed. 

It 

can 

then 

be 

downloaded 

from 

the 

following 

location: 

https://www.emerson.com/Industrial-Automation-Controls/support

. 

After downloading the zip file containing the Modbus RTU Machine Adapter, verify the file 
integrity by calculating a SHA-256 sum of the zip file and compare it to the expected SHA-
256 sum posted on the download page.

 

4.3

 

Deployment Options 

The Modbus RTU Machine Adapter is packaged as a single zip file containing two separate 
components: 

1.

 

An inner zip file containing the Modbus RTU Machine Adapter binaries (.jar, .so). 

•

 

Customers  that  want  to  deploy  the  non-configured  Modbus  RTU  Machine 
Adapter into a running system can directly upload the zip to EdgeManager as an 
Application and deploy it. 

•

 

Customers that want to add these binaries to an existing Application Template 
can do so using the instructions below. 

2.

 

An inner zip file containing the Modbus RTU Machine Adapter configuration files 
(.config, .xml). 

Summary of Contents for PACSystems

Page 1: ...User Guide GFK 3019G Oct 2019 PACSystemsTM FIELD AGENT MACHINE ADAPTER USER GUIDE ...

Page 2: ...nd Compatibility 6 3 2 Obtaining the EGD Machine Adapter 6 3 3 Deployment Options 6 3 4 Configuring the EGD Machine Adapter 7 3 4 1 Modifying the Configuration Files 7 3 4 2 Field Agent Configuration Tool 11 3 5 Performance 11 3 6 Troubleshooting 12 3 6 1 The EGD debug webpage 12 Configuring and Accessing the Webpage 12 Elements of the EGD Debug Webpage 13 3 6 2 No EGD Data in the EGD Machine Adap...

Page 3: ...apter 26 5 1 OSI PI Machine Adapter Architecture 26 5 1 1 Features and Compatibility 26 5 1 2 Supported Value Type 26 5 2 Obtaining the OSI PI Machine Adapter 26 5 3 Deployment Options 27 5 4 Configuring the OSI PI Machine Adapter 28 5 4 1 Modifying the Configuration Files Manually 28 5 4 2 Field Agent Configuration Tool 30 5 5 Deploying the OSI PI Machine Adapter 30 5 6 Performance 30 5 7 Trouble...

Page 4: ...g the EtherNet IP Machine Adapter 37 6 4 1 Modifying the Configuration Files Manually 38 6 4 2 Field Agent Configuration Tool 39 6 4 3 Deploying the EtherNet IP Machine Adapter 39 6 5 Performance 39 6 6 Troubleshooting 40 6 6 1 Invalid XML file path 40 6 6 2 Null PLC Port Number 40 6 6 3 Null IP Address 40 6 6 4 Invalid IP Address 40 6 6 5 PLC Not reachable or cable disconnected 41 6 6 6 Null Time...

Page 5: ...ng changes Updated Contact Info D Jul 2017 Added EtherNet IP Machine Adapter Added performance data for EGD Modbus RTU and OSI PI Machine Adapters C Oct 2016 Added OSI PI Machine Adapter B Jul 2016 Inserted Common Deployment Option Revised the deployment for the EGD Machine Adapter A Oct 2015 Added Modbus RTU Machine Adapter Jul 2015 Initial document release 1 2 Related Documentation 1 2 1 Product...

Page 6: ...30 PACSystems RXi RX3i and RX7i Controllers Secure Deployment Guide GFK 2222 PACSystems CPU Reference Manual GFK 2314 PACSystems RX3i System Manual GFK 2224 TCP IP Ethernet Communications for PACSystems User s Manual GFK 2225 TCP IP Ethernet Communications for PACSystems Station Manager Manual GFK 2571 PACSystems RX3i PROFINET Controller Manual GFK 2572 PACSystems RX3i PROFINET Controller Command ...

Page 7: ...ne can be found by searching for OPC UA Machine Adapter or Modbus Machine Adapter in https docs predix io 2 2 Minimum Requirements to Get Started The following are the minimum steps required to start using the machine adapter with the field agents For more detailed instructions for each step refer to the section Getting Started with the Field Agent in the Field Agents User Guide GFK 2993 1 Registe...

Page 8: ...entially for the configuration template and then the application template 2 3 1 Configuration Template 1 Obtain the configuration template a If the configuration is for Modbus RTU i Open the Field Agent Configuration Tool ii Configure the machine adapter accordingly Refer to the specific machine adapter section for more information on inputs iii Click on Validate to ensure all the information ente...

Page 9: ...search for your field agent and click on it 5 Go to the Configuration tab and click on Deploy Configuration and select the configuration template that you just uploaded and select Deploy 2 3 2 Application Template 6 Download the configuration template for the machine adapter from Salesforce https www emerson com Industrial Automation Controls support 7 Go to EdgeManager and login with your credent...

Page 10: ...n for the field agents The EGD Machine Adapter configuration and application files can be obtained from the following location https www emerson com Industrial Automation Controls support 3 3 Deployment Options The Configuration Template and Application Template can be deployed to the Field Agent from EdgeManager Refer to Section 2 3 Common Deployment Method for the general process flow of deployi...

Page 11: ...onfiguration Template configura tion machine Required com ge ac machine adapter egd xml com ge ac machineadapt er egd 1 0 0 cfg configuration machin e Configuration Template configura tion machine Required com ge ac machine adapter egd 1 0 0 jar com ge ac machineadapt er egd 1 0 0 app machine bundle Application Template machine bundles Required ProducedData Px x x x xml If dynamic binding is suppo...

Page 12: ... once The steps to configure the EGD Machine Adapter are com ge ac machineadapter egd config 1 Open the file com ge ac machineadapter egd config for editing 2 Note that the file is divided into three sections LIKELY TO CHANGE configurations that require modifications network interface could be a range of IP addresses in the following format x x where x is any integer number between 0 and 255 or a ...

Page 13: ...thread pool maximum size to handle subscriptions maxqueue size is the subscription queue size to handle subscriptions udp recvbuff size is the UDP IP receive buffer size to use when listening to EGD messages 3 Change the configurations as needed The description of what each configuration item does is included in the file 4 Remove the comment hashtag in front of the line of configuration not in fro...

Page 14: ...ed sent to the Hoover Spillway It must match the VarGroup Name element in step 4 If there are multiple producers that contain the same variables a single VarGroup can be defined and referenced for each producer rather than duplicating the variable list EgdHttp is a Boolean value true false that defines if the producer has dynamic binding loading capabilities for its EGD configurations 4 Edit the a...

Page 15: ... and 255 into the Configuration Template configuration machine directory 3 4 2 Field Agent Configuration Tool Currently the Field Agent Configuration Tool does not support configurations for the EGD machine adapter For more updated information on the Field Agent Configuration Tool please visit https www emerson com Industrial Automation Controls support 3 5 Performance EGD data throughput to Time ...

Page 16: ...ge Configuring and Accessing the Webpage The EGD Debug Webpage is intended to aid in debugging EGD configuration issues It can be accessed using a web browser while the EGD Machine Adapter is running It provides information on the configurations statistics of the messages details of EGD packets and logging messages Before accessing the webpage the following configuration modifications are needed 1...

Page 17: ...dapter is not initializing or running follow the steps below to troubleshoot and resolve the issue 1 Check the machinegateway ini file in Predix Machine Application Template machine bin vms Verify the following block of code is present bundle name com ge ac machineadapter egd 1 0 0 jar name bundle 2 Verify the com ge ac machineadapter egd xml and com ge ac machineadapter egd config files a Verify ...

Page 18: ...llway dataSubscriptions there is an item in the list that matches the subscriptionName from the com ge ac machineadapter egd config file The default value is EGDSub1 2 Open the com ge dspmicro websocketriver send 0 config file and verify that the following configurations are filled out correctly a com ge dspmicro websocketriver send river name should match com ge dspmicro hoover spillway destinati...

Page 19: ... the Modbus RTU Machine Adapter The Modbus RTU Machine Adapter must be purchased for each Field Agent where it will be installed It can then be downloaded from the following location https www emerson com Industrial Automation Controls support After downloading the zip file containing the Modbus RTU Machine Adapter verify the file integrity by calculating a SHA 256 sum of the zip file and compare ...

Page 20: ...the Modbus RTU Machine Adapter configuration files manually copied from the package downloaded to an existing Configuration Template like the MFA Configuration Template for Predix Machine 17 1 2 c Deploy a Configuration Template including the Modbus RTU Machine Adapter configuration files as an EdgeManager Configuration 3 Deployment Option 3 Application Template Configuration Template a Add the Mo...

Page 21: ... files manually 2 Refer to Section 4 4 2 Field Agent Configuration Tool to use the Field Agent Configuration Tool to generate the configuration files 4 4 1 Modifying the Configuration Files Manually The steps to configure the Modbus RTU Machine Adapter are 1 Open the file com ge ac machineadapter modbusrtu 0 xml for editing 2 Edit the data contained within the dataNodeConfigs element Each channel ...

Page 22: ...ols whether the Machine Adapter should use Modicon bit ordering which reverses the bit order Each unit element corresponds to one Modbus RTU Slave device The id attribute must be set to the Modbus Slave Device ID Each register element corresponds to one Modbus register The name attribute must be set to the tag name that is desired to be associated with the given Modbus register This is the name th...

Page 23: ...esent the default unit of measure is seconds The startPointOffset attribute is the amount of time to wait after the Modbus RTU Machine Adapter starts to begin reading configured tag data The unit of measure defaults to seconds unless the startPointUnit attribute is provided in which case the unit of measure is either minutes or hours The intervalIsMillis attribute indicates whether the updateInter...

Page 24: ...eld Agent Configuration Tool can be downloaded from the following URL https www emerson com Industrial Automation Controls support After installing the Field Agent Configuration Tool follow the steps below 1 On the Summary tab fill out the Field Agent Device Settings fields a Enter the Device Name as it appears in EdgeManager b Enter the Device ID as it appears in EdgeManager c Select Mini Field A...

Page 25: ...de the dataSubscriptionConfig element as described in Section 4 4 1 Modifying the Configuration Files Manually iii Set the Start Point Offset to the number of minutes or hours defined by the Units selection for the Machine Adapter to wait after starting before data polling begins A value of 1 means the Machine Adapter will start polling immediately upon starting iv Set the Units to either MINUTES ...

Page 26: ...tes for Predix Machine 17 1 2 can be downloaded from the URL mentioned below https www emerson com Industrial Automation Controls support Detailed instructions for how to upload and deploy EdgeManager Applications and Configurations found in the Application Management and Configuration Management sections of the Field Agents User Guide GFK 2993 4 5 Performance The Modbus RTU Machine Adapter can se...

Page 27: ... to a register on the Modbus Slave with data the Modbus RTU Machine Adapter will log the following error messages to the machine log file which is also displayed inside the Predix Machine Web Console OSGi Log Service ERROR com ge ac machineadapter modbusrtu api MFAModbusSerialTransaction 111 com ge ac machineadapter modbusrtu 170102 1 0 execute try 1 error I O exception failed to read ERROR com ge...

Page 28: ...e Adapter will log the following error message to the machine log file which is also displayed inside the Predix Machine Web Console OSGi Log Service com ge ac machineadapter modbusrtu api ModbusMachineAdapterException Invalid configuration information Invalid register To correct this error reconfigure the XML file to specify the correct BOOLEAN register bitIndex and the Modbus RTU Machine Adapter...

Page 29: ... machineadapter modbusrtu api ModbusMachineAdapterException Invalid configuration information Invalid register type HOLD To correct this error reconfigure the XML file to specify the correct registerType and the Modbus RTU Machine Adapter will automatically read the correct Modbus data Until the configuration is corrected the Modbus RTU Machine Adapter will not attempt any retries ...

Page 30: ...atures and compatibility Features OSI PI Machine Adapter PI Web API 2017 Yes PI Web API 2018 No Read data from PI Server Yes Write data to PI Server No Predix Machine Version 17 1 5 1 2 Supported Value Type The OSI PI Machine Adapter currently supports the following value data type Value Type OSI PI Machine Adapter Boolean Yes Byte Double Int16 Int32 Int64 Single Yes DateTime No Guid No String Yes...

Page 31: ...pplication Field Agent Configuration Tool output a Deploy the OSI PI Machine Adapter Application zip from the package downloaded as an EdgeManager Application b Use the Field Agent Configuration Tool to generate configuration files for the OSI PI Machine Adapter c Deploy the output of the Field Agent Configuration Tool as an EdgeManager Configuration 2 Deployment Option 2 OSI PI Machine Adapter Ap...

Page 32: ...hine 5 4 Configuring the OSI PI Machine Adapter The OSI PI Machine Adapter configuration files can be prepared using two methods Refer to Section 5 4 1 Modifying the Configuration Files Manually to edit the configuration files manually Refer to Section 5 4 2 Field Agent Configuration Tool to use the Field Agent Configuration Tool to generate the configuration files 5 4 1 Modifying the Configuratio...

Page 33: ...TTPS request from the OSI PI Machine Adapter under this limit each piConfig is limited to a maximum of 200 tag elements Inside the dataSubscriptionConfigs element each dataSubscriptionConfig element corresponds to a desired subscription which includes one or more tags configured to be read at a given update interval The name attribute must be set to a text name that uniquely identifies this subscr...

Page 34: ...e 17 1 3 can be downloaded from the URLs below https www emerson com Industrial Automation Controls support Detailed instructions for how to upload and deploy Edge Manager Applications and Configurations found in the Application Management and Configuration Management sections of GFK 2993 Field Agents User Guide 5 6 Performance On the MFA the OSI PI Machine Adapter was validated capable of reading...

Page 35: ...vdata osisoft 443 piServerIpAddress piServerPort Response Code 502 Response Message Bad Gateway To correct this error reconfigure the XML file to specify the correct piServerPort 5 7 3 Invalid Proxy Host When the configured proxy host proxyHost in adapter configuration file com ge ac machineadapter osipi 0 xml is invalid the OSI PI Machine Adapter will log the following error message to the machin...

Page 36: ...side the Predix Machine Web Console OSGi Log Service WebId not found for piPoint piPointName Could not fetch WebID for piPoint piPointName Check if the tag exists in the PI Server WebIDs lookup process UnSuccessful Could not fetch WebIDs for few piPoint s Either No piPointName is specified or none of them have valid WebIDs in PI Server for Node name To correct this error reconfigure the XML file t...

Page 37: ...e for data point 5 7 10 Invalid PI Server Username When the configured com ge ac machineadapter osipi serverUserName for PI Server in machine configuration file com ge ac machineadapter osipi 0 config is invalid the OSI PI Machine Adapter will log the following error message to the machine log file which is also displayed inside the Predix Machine Web Console OSGi Log Service IOException when read...

Page 38: ...or PI server 5 7 12 Null Timeseries Tag Name When the configured tsTagName for data point under tag element in adapter configuration file com ge ac machineadapter osipi 0 xml is empty the OSI PI Machine Adapter will send piPointName to the Predix Time Series Database instead To have desired Timeseries tag name reconfigure the XML file to specify the valid tsTagName for data point ...

Page 39: ...ity The following table lists the EtherNet IP Machine Adapter features and compatibility Features EtherNet IP Machine Adapter Read data from CIP Field Device example Rockwell Automation CompactLogix Yes Write data to CIP Field Device No Read data from PCCC Field Device example Rockwell Automation MicroLogix Yes Write data to PCCC Field Device No Predix Machine Version 17 1 6 1 2 Supported File Typ...

Page 40: ...s 1 An inner zip file containing the EtherNet IP Machine Adapter binaries jar Customers that want to deploy the non configured EtherNet IP Machine Adapter into a running system can directly upload the zip to EdgeManager as an Application and deploy it Customers that want to add these binaries to an existing Application Template can do so using the instructions below 2 An inner zip file containing ...

Page 41: ...d to an existing Configuration Template like the MFA Configuration Template for Predix Machine 17 1 2 d Deploy a Configuration Template including the EtherNet IP Machine Adapter configuration files as an EdgeManager Configuration In order to extend an existing Application or Configuration Template to include the EtherNet IP Machine Adapter manually copy the following source files into the specifie...

Page 42: ...lementNumber The TsTagName attribute is an optional parameter and can be set to the tag name that is desired to be associated with the variable for sending data to Predix Time Series Database It must have a unique name relative to other tags in the same Predix Time Series Database If not specified the above configured tagName will instead be used Inside the dataSubscriptionConfigs element each dat...

Page 43: ...com ge ac machineadapter ethernetip 1 0 app zip unmodified Configuration Template with EtherNet IP Machine Adapter configuration files added Deployment Option 3 Application Template with EtherNet IP Machine Adapter binaries added Configuration Template with EtherNet IP Machine Adapter configuration files added The Mini Field Agent Application and Configuration Templates for Predix Machine 17 1 2 c...

Page 44: ... file path configuration machine com ge ac machineadapter ethernetip 0 xml 6 6 2 Null PLC Port Number When the configured PLC Port is invalid means less than 1 the EtherNet IP Machine Adapter will log the following error message to the machine log file which is also displayed inside the Predix Machine Web Console OSGi Log Service Invalid configuration information Invalid TCP IP port number 0 To co...

Page 45: ...format or unsupported tag the EtherNet IP Machine Adapter will log the following error message to the machine log file which is also displayed inside the Predix Machine Web Console OSGi Log Service Unsupported Tag by PLC Given tag name To correct this error reconfigure the XML file to specify the valid tagname for tag 6 6 8 Incomplete tag PCCC Protocol When the configured tagame for tag under tag ...

Page 46: ...ect this error reconfigure the XML file to specify the valid tagname for tag or check the availability of the tag name in PLC or create tag in PLC 6 6 11 Null Subscription Name When the configured name for node under dataSubscriptionConfig element in adapter configuration file com ge ac machineadapter ethernetip 0 xml is null the EtherNet IP Machine Adapter will log the following error message to ...

Page 47: ...ht to modify or improve the designs or specifications of the products mentioned in this manual at any time without notice Emerson does not assume responsibility for the selection use or maintenance of any product Responsibility for proper selection use and maintenance of any Emerson product remains solely with the purchaser 2019 Emerson All rights reserved Emerson Terms and Conditions of Sale are ...

Reviews:

No comments