GE Multilin SR Events Master Protocol

Download as pdf or txt
Download as pdf or txt
You are on page 1of 19

Reference Manual

MN912085EN, version 3

GE Multilin SR Events
Master Protocol
Documentation for part number P-SMPR-3301.
For use with SMP Gateway software version 7.0 or later.
All brand and product names appearing in this document are the trademark or registered trademark
of their respective holders.

© 2016 Eaton – All rights reserved.


The information in this document is subject to change without notice.

Eaton’s Energy Automation Solutions


1990 5th Street
Suite 220
Levis, Quebec
Canada G6W 5M6
Phone: +1.418.830.5800
Fax: +1.514.227.5256
Email: [email protected]
Web: http://www.cooperpower.com

Technical Support: [email protected]

MN912085EN, version 3
EAS-SA QF-MKT-02 Rev.02

Contents
1 Introduction 1
1.1 Getting Assistance .................................................................................................1

2 Features 3
2.1 Communications Features .....................................................................................3
2.2 Supported Requests ...............................................................................................3
2.2.1 Device Data Retrieval .............................................................................5
2.2.2 Device Control ........................................................................................5

3 Configuration Settings 7
3.1 General Settings ....................................................................................................7
3.2 Configuration Files Settings ..................................................................................8

4 Implementation Details 11
4.1 Startup Sequence ................................................................................................. 11
4.2 Scan Cycle ........................................................................................................... 11

5 Troubleshooting 13

GE Multilin SR Events Master Protocol Reference Manual ●i


EAS-SA QF-MKT-02 Rev.02

Tables
Table 2-1 Communications Features ............................................................................................ 3
Table 2-2 Request Subset Used .................................................................................................... 4
Table 2-3 MODBUS Registers Used ............................................................................................ 5
Table 3-1 General Settings ............................................................................................................ 8
Table 3-2 Configuration File Settings ........................................................................................... 9
Table 3-3 Modules Settings .......................................................................................................... 9
Table 3-4 Module Details Settings.............................................................................................. 10
Table 5-1 Troubleshooting .......................................................................................................... 13

GE Multilin SR Events Master Protocol Reference Manual ● iii


EAS-SA QF-MKT-02 Rev.02

1 Introduction

This manual provides the information required to install and set up a GE Multilin SR Events
master protocol component in a SMP Gateway.
This protocol component is used exclusively to retrieve events and configuration files from any
GE SR 750/760 Feeder Management device. Except for clock synchronization, it cannot be used
to configure and control these devices.
The reader must be familiar with the SMP Gateway environment, protocol concepts and the SR
MODBUS protocol specifications before proceeding with this document. This information can be
acquired by reading the following documents:
 SR 750/760 user manuals and datasheets.
 Protocol Common Concepts Reference Manual, MN912003EN, Eaton.
 SMP Gateway User Manual, MN912001EN, Eaton.

1.1 Getting Assistance


If you have any question regarding the performance, application or testing of any component of
this SMP product, do not hesitate to contact us. Our staff will be pleased to assist you.
Technical Support
Eaton’s Energy Automation Solutions

Email: [email protected]
Phone: +1.763.595.7775
Toll Free: +1.800.815.2258

Business hours are from 8 a.m. and 5 p.m. CST, Monday to Friday.

GE Multilin SR Events Master Protocol Reference Manual •1


EAS-SA QF-MKT-02 Rev.02

2 Features

This chapter enumerates the features provided by the SR Events master protocol component.

2.1 Communications Features


The following communication features are available when interconnecting devices to the
SMP Gateway:

Feature Comment
Serial Port The SR Events protocol component supports RS-232 and RS-485 interfaces
at bit rates up to 115200 bps.

Serial Multidrop Multiple instances of this protocol component can share a single serial port, if
the hardware supports such a feature, as long as different addresses are used
to identify the devices.

RTU over TCP/IP LAN connections using the “MODBUS RTU over Ethernet and TCP/IP”
protocol. This protocol is the exact equivalent of the serial RTU protocol.

MODBUS/TCP LAN connections using the “MODBUS/TCP” protocol. This protocol is


similar to the serial RTU protocol, but it adds an additional 6-byte header to
every request and every response.

TCP/IP Multidrop Multiple instances of the SR Events protocol component can share a single
TCP/IP port, as long as different addresses are used to identify the devices
and as long as the devices support such a feature.

File Retrieval Event files generated by SR devices can be retrieved by this master protocol
component and stored in a system folder.
Configuration information available from these SR devices can also be
retrieved this master protocol component and stored as files in a system
folder.

Table 2-1 Communications Features

2.2 Supported Requests


Only a subset of the SR MODBUS requests is used by the SR Events master protocol component.
The following table illustrates the request subset used.

GE Multilin SR Events Master Protocol Reference Manual •3


EAS-SA QF-MKT-02 Rev.02

Request Description
04h Read Input Registers
 Used during scan cycle to read event indexes;
 Used during a file transfer to read data buffers and position index.
 Used during configuration files scan cycle to read configuration data.

10h Preset Multiple Registers


 Used to set device date and time;
 Used during a file transfer to select data buffer section.

Table 2-2 Request Subset Used

The following table lists the MODBUS registers that will be used by the SR Events master
protocol.

MODBUS Access Description


Register
System Setup
1100h to 110Dh Read System setup

Event Transfer
2000h Read/Write Event number selector

2001h Read Number of events since clear

2010h to 2029 Read Event record Data

Trace Memory Transfer (Waveform)


2100h Read/Write Trace memory number selector

2101h Read/Write Trace memory channel selector

2102h Read/Write Trace memory sample selector

2110h to 2119h Read Trace memory information

2120h to 215Fh Read Trace memory samples

Data Log Transfer


2200h Read/Write Data log number selector

2201h Read/Write Data log channel selector

2202h Read/Write Data log sample selector

2210h to 2117h Read Data log information

2220h to 225Fh Read Data log samples

4● Chapter 2: Features
EAS-SA QF-MKT-02 Rev.02

MODBUS Access Description


Register
Clock Write Real time clock set date and time
Synchronization
00F0h to 00F2h

Configuration Read Software Revision


files
0002h Read Model Number

0005h Read User-defined configuration registers

----h

Table 2-3 MODBUS Registers Used

2.2.1 Device Data Retrieval


Various registers are read periodically using various “Read Input Registers” requests to scan for
any new event file. Once a new event is detected, a file transfer is initiated using a “Preset
Multiple Registers” request. The event contents are then retrieved by using multiple “Read Input
Registers” requests. Once the transfer is completed, the event file is written to a system folder.
Refer to the Protocol Common Concepts Reference Manual, for more details on file format,
management, and so on.

2.2.2 Device Control


The component does not perform any device control requests.

GE Multilin SR Events Master Protocol Reference Manual •5


EAS-SA QF-MKT-02 Rev.02

3 Configuration Settings

This chapter enumerates the configuration settings that one must specify for each SR Events
master protocol component instance. The SMP Config software program is generally used to
define these settings. You will use a template supplied by Eaton, so as to take advantage of all the
functions that are supported.

Note: Only those settings specific to the GE Multilin SR Events master protocol are
described here. The settings common to all master protocol components are
described in the Protocol Common Concepts Reference Manual.

3.1 General Settings


Every instance of this master protocol component contains general settings, which set the general
behavior of the component. The following table shows the general settings that are specific to the
GE Multilin SR Events master protocol.

Setting Description
Device Address MODBUS address of the SR relay communicating with this instance of the
protocol.
Range: 1 to 254
Default value: 254

MODBUS Type Indicates what type of MODBUS protocol is used.


Allowed values:
 RTU Serial.
The protocol component is connected to the device using a serial link and
uses the MODBUS RTU protocol.
 RTU Over TCP/IP.
The protocol component is connected to the device via TCP/IP and uses
the MODBUS RTU protocol. This connection type does not follow the
Open MODBUS/TCP specification, as it does not include the additional 6-
byte header.
 MODBUS/TCP.
The MODBUS protocol component is connected to the device via TCP/IP.
This connection follows the Open MODBUS/TCP specification by adding
a 6-byte header to all requests and responses.
Default value: MODBUS/TCP

GE Multilin SR Events Master Protocol Reference Manual •7


EAS-SA QF-MKT-02 Rev.02

Setting Description
Scan Interval The number of milliseconds between two complete scan cycles.
A value of 0 deactivates scan operations.
Range: 0 to 2,160,000,000 milliseconds (25 days)
Default value: 5000 milliseconds (5 seconds)

Rx Retry Count The number of consecutive times a bad response (or no response) must be
received before a communications failure is declared and an attempt is made to
re-initialize the link.
Range: 0 to 10
Default value: 9

Rx Timeout The number of milliseconds to wait for the end device to respond to a request
before attempting any retries. The timer is started after the last data of a
request is transmitted to the remote device.
Range: 100 to 30,000 milliseconds
Default value: 5000 milliseconds

Clock Sync Indicates whether or not the device clock must be synchronized. If you put a
checkmark, the device time is updated at clock sync cycle.
Range: checkmark / no checkmark
Default value: no checkmark

Clock Sync Cycle The time interval (in milliseconds) between two clock synchronizations.
If set to 0 and the Clock Sync option is selected, clock synchronization will
occur before every scan cycle.
Range: 0 to 2,160,000,000 milliseconds (25 days)
Default value: 1,800,000 milliseconds (30 minutes)

Table 3-1 General Settings

3.2 Configuration Files Settings


Every instance of this master protocol component contains configuration files settings, which
allows monitoring configuration changes in the device. Three different setting panels need to be
configured: “Configuration File”, “Modules” and “Module Details”.
The following table shows the configuration files settings.

Setting Description
Frequency The time interval (in seconds) between two configuration scans.
Range: 10 to 65,535 seconds
Default value: 60 seconds

Disabled See “Event File Settings” in the Protocol Common Concepts Reference
Manual, except for the default value.
Default value: checkmark

8● Chapter 3: Configuration Settings


EAS-SA QF-MKT-02 Rev.02

Setting Description
Folder See “Event File Settings” in the Protocol Common Concepts Reference
Manual.

Min Free Disk Space See “Event File Settings” in the Protocol Common Concepts Reference
Manual.

Extra Info See “Event File Settings” in the Protocol Common Concepts Reference
Manual.

Description See “Event File Settings” in the Protocol Common Concepts Reference
Manual.

Table 3-2 Configuration File Settings

The following table shows the modules settings.

Setting Description
Module Name The long name describing this module.

Disabled When this setting is selected, the master protocol will not attempt to retrieve
configuration files of this module.
This flag can be used, for example, when the information stored in these
configurations files is not useful and does not need to be retrieved.
Range: checkmark / no checkmark
Default value: no checkmark

Category Specifies the module configuration category.


Allowed values: Hardware
Firmware
Settings
Default value: Hardware

Table 3-3 Modules Settings

The following table shows the module detail settings. It lists all the MODBUS registers associated
with a module.

Setting Description
Name The register name.

Disabled When this setting is selected, the master protocol will not attempt to retrieve
this register.
Range: checkmark / no checkmark
Default value: no checkmark

Address Hexadecimal address of the register.


Range: 0x0 to 0xFFFF
Default value: 0x0

GE Multilin SR Events Master Protocol Reference Manual •9


EAS-SA QF-MKT-02 Rev.02

Setting Description
Format Register’s GE SR format in numerical form.
(for example: 101 instead of F101)
Allowed values: 0 to 65535
Default value: 0

Table 3-4 Module Details Settings

10 ● Chapter 3: Configuration Settings


EAS-SA QF-MKT-02 Rev.02

4 Implementation Details

4.1 Startup Sequence


The protocol component must go through the following steps on startup:
 Parses the configuration file.
 Initializes the various logs, traces and statistics.
 Initializes the communications link.
 Starts the scan cycle.

4.2 Scan Cycle


The protocol component manages the device polling cycle based on the following principles:
 The protocol is half duplex.
 The device should never send data without having first received a request for data.
 There is a response to every request.

The SR Events response processing rules are:


 A response is valid only if it arrives within the configured time limit.
 The response format must be coherent and as expected.
 The response must match the request.
 The same request is re-issued if the reception status is not correct, up to the number of retry
counts configured.
Whatever the reason, the link is reset from scratch if too many consecutive bad responses are
received; “too many” being the number of retry counts configured.
A regular scanning cycle is used on a continuous basis. There is no special initialization sequence.
Note that the link is not considered active until a valid response is received from the device.

The regular scanning cycle is as follows:


 If so configured, read the register containing the number of event records available.
 Compare the value with the number of the last event records retrieved. If the value is higher,
request a file transfer for every new event record available, up to the configured maximum
retrievable. (Usually 128)

GE Multilin SR Events Master Protocol Reference Manual • 11


EAS-SA QF-MKT-02 Rev.02

 If so configured, read the register containing the number of trace memory or data log
available.
 Compare the value with the number of the last trace memory or data log retrieved. If the value
is higher, request a file transfer for every new trace memory or data log available, up to the
configured maximum retrievable.

The configuration files scanning cycle is as follows:


 If so configured, read the configuration modules’ registers.
 Compare configuration data’s signature of each module with the previous one. If the signature
changed for one module, download the entire configuration by reading again and outputting
one file by module. If the system folder is compressed, a zip file is generated to gather all
those files and the header file in a single package. The configuration data’s signature is
compared a second time to prevent from saving in an unstable condition. If the signature is
different, the download aborts and the process starts over until the signature is the same
between the first and the second reading.

The time synchronization cycle is as follows:


 The following cycle is only executed if clock synchronization is activated.
 The current date and time is written to the real-time clock set-time register. The date and time
is adjusted according to the configured time zone of the device.

12 ● Chapter 4: Implementation Details


EAS-SA QF-MKT-02 Rev.02

5 Troubleshooting

The following table enumerates solutions to common problems experienced with the GE Multilin
SR Events master protocol component.

Problem Solution
The SMP Gateway is This problem can be due to one of the following:
not communicating
 One of the reasons discussed in the Protocol Common Concepts Reference
with my device.
Manual.

The link to my device This problem can be due to one of the following:
keeps resetting.
 Reception timeout problem: The reception timeout configured in the
general settings is too small.
 The supplied password does not match the password configured in the
device.
 One of the reasons discussed in the Protocol Common Concepts Reference
Manual.

Event reports are This problem can be due to one of the following:
available on my
 The number of available files is greater than the maximum allowed. Only
device, but never
downloaded. the newest files have been downloaded.
 One or more event types are disabled in your configuration.
 One of the reasons discussed in the Protocol Common Concepts Reference
Manual.

Configuration file are This problem can be due to one of the following:
never downloaded.
 Configuration files are disabled in your configuration.
 The configuration of modules and/or module’s detail is missing or disabled.
 The scan cycle (frequency) is longer than the check interval for new files.

Table 5-1 Troubleshooting

GE Multilin SR Events Master Protocol Reference Manual • 13

You might also like