Reference Manual

Schneider Electric (ION)

Master Protocol
Documentation for part number P-SMPR-5401
© 2012 Cooper Power Systems, LLC – All rights reserved.
The information in this document is subject to change without notice.

Cooper Power Systems

Energy Automation Solutions
730 Commerciale Street
Suite 200
Saint-Jean-Chrysostome, Quebec
Canada G6Z 2C5
Phone: +1.418.834.0009
Fax: +1.514.227.5256
Email: PSMO-sales@cooperindustries.com
Web: http://www.cooperpower.com

Technical Support: PSSJ-support@cooperindustries.com

S1120-62-1, version 2
Contents
1. Introduction ............................................................................................................................. 1
2. Features.................................................................................................................................... 2
2.1 Communication ........................................................................................................................ 2
2.2 Supported Requests ................................................................................................................. 2
3. Configuration Settings ............................................................................................................. 4
3.1 General Settings....................................................................................................................... 4
3.2 Event Files ............................................................................................................................... 5
3.3 Configuration File Settings ........................................................................................................ 5
3.4 Analog Input Settings ............................................................................................................... 5
3.4.1 Physical Inputs .......................................................................................................... 5
3.4.2 Data Recorder Inputs ................................................................................................. 6
3.5 Binary Input Settings ................................................................................................................ 6
3.5.1 Physical Inputs .......................................................................................................... 6
3.5.2 Data Recorder Inputs ................................................................................................. 6
3.6 Request Interval Settings .......................................................................................................... 7
4. Implementation Details ........................................................................................................... 8
4.1 Startup Sequence ..................................................................................................................... 8
4.2 Scan Cycle ............................................................................................................................... 8
5. Troubleshooting ..................................................................................................................... 10

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●I

Tables
Table 2-1 Communication features ...................................................................................2
Table 2-2 Supported methods (requests) ..........................................................................3
Table 3-1 General settings .................................................................................................5
Table 3-2 Configuration File Settings ................................................................................5
Table 3-3 Physical Analog Input settings ..........................................................................6
Table 3-4 Data Recorder Analog Input settings ................................................................6
Table 3-5 Physical Binary Input settings ...........................................................................6
Table 3-6 Data Recorder Binary Input settings .................................................................7
Table 3-7 Request Interval settings ..................................................................................7
Table 5-1 Troubleshooting .............................................................................................. 10

II ● SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL

1. Introduction
This manual provides the information required to install and set up a Schneider Electric (ION)
master protocol component in an SMP Gateway.
This protocol component is used to retrieve data from any Schneider Electric ION device that
implements the IONTM protocol.
The reader must be familiar with the SMP Gateway environment, master protocol concepts and
the Schneider Electric ION protocol specification before proceeding with this document. This
information can be acquired by reading the following documents:
 Protocol Common Concepts Reference Manual, S1120-11-1, COOPER Power Systems, LLC.
 SMP Gateway User Manual, S1120-10-1, COOPER Power Systems, LLC.
 ION Serial Communications Protocol, Power Measurement, 2006.

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●1

2. Features
This chapter enumerates the features provided by the Schneider Electric (ION) Master Protocol
component.

2.1 Communication
The following communication features are available when interconnecting devices to the
SMP Gateway’s hardware.

Feature Comment
Serial Ports This protocol component supports RS-232 and RS-485
interfaces at bit rates up to 115,200 b/s.
Passthrough connections This protocol component supports passthrough (transparent)
connections. Note that link activity must be suspended while
the passthrough connection is in effect.
TCP/IP This protocol component supports TCP/IP communications.

Table 2-1 Communication features

2.2 Supported Requests

The following table enumerates the methods (requests) currently supported and needed by the
Schneider Electric (ION) Master Protocol component.

Method (Request) Description Specific To

Read ION name Read generic name for each All
handle
Read ION label Read custom name for each All
handle
Read Register Time Read time associated with a Ai, Bi
specific register
Read Register Value Read value associated with a Ai, Bi
specific register
Read Log Position Read counter associated with all Event, Waveform, DataRec
Log Record events.
Read Module Setup Read counter for configuration Configuration
Counter tracking of module
Read Manager Setup Read counter for configuration Configuration
Counter tracking of Feature Manager
Read Value with Value Read Log Record Event, Waveform, DataRec
Read Module Input Read Input handle associated for a All
Handle specific module
Read Module Output Read Output handle associated for All
Handle a specific module

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●2

 Method (Request) Description Specific To
Read Module Setup Read Setup handle associated for All
Handle a specific module
Read Module Input Read the label associated to all Configuration, Waveform
Names Input Handle of a specific module
Read Manager Class Read all class instance of specific All
type of module

Table 2-2 Supported methods (requests)

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●3

3. Configuration Settings
This chapter lists the configuration settings that must be specified for each Schneider Electric
(ION) master protocol component instance. The SMP Config software program is generally used
to define these settings.
Only Schneider Electric ION -specific settings of the 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
Each 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 Schneider Electric (ION) master protocol.

Setting Description
Source Address Address associated to a master instance
Range: 10,000 to 30,767
Default value: 20,000
Dest. Address Address associated to a slave instance
Range: 1 to 9,999
Default value: 100
Rx Timeout Timer The amount of time, in milliseconds, to wait for the remote device
response before attempting any retries. This timer is started after
the last data reception from the remote device.
Setting a short reception timeout may cause the link to operate
erratically (i.e. a timeout may be declared even though the
response is still coming). Setting a long reception timeout may
cause inefficiencies, with a considerable amount of bandwidth
wasted when communication errors occur.
Range: 100 to 30,000 milliseconds
Default value: 2000 milliseconds
Rx Retry Count The number of consecutive times a bad response must be received
(or no response at all) before a communication failure is declared
and an attempt is made to re-initialize the link.
This setting is not used for control requests, as they are sent only
once.
Range: 0 to 100
Default value: 2
Merge Waveforms Merge waveforms triggered simultaneously into a single
COMTRADE set of files.
Range: True or False
Default value: False

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●4

 Setting Description
Samples per file Data Recorder specific. Maximum number of samples stored in a
PQDIF file, a sample containing values at time ‘t’ for up to 16
inputs.
Range: 100 to 2000
Default value: 100

Table 3-1 General settings

3.2 Event Files

Each instance of this master protocol component contains events file settings, which set the
general behavior for the event file download process. For more information, see the "Event File
Settings" section of the Protocol Common Concepts Reference Manual.

3.3 Configuration File Settings

Every instance of this master protocol component contains configuration file settings, which
allows the monitoring of device configuration changes.
The following table shows the configuration file settings.

Setting Description
Disabled See “Event File Settings” in the Protocol Common Concepts
Reference Manual, except for the default value.
Default value: checkmark
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

3.4 Analog Input Settings

Each instance of this master protocol component may contain several analog inputs. Analog input
settings tell the component how to map data retrieved from the device to system analog data.
The following table shows all the physical analog input settings specific to the Schneider Electric
(ION) master protocol.
3.4.1 Physical Inputs
Physical analog inputs are analog data points that are retrieved from the device database.

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●5

 Setting Description
Handle Specify the handle of the device database that holds the point’s
value.
Range: 0 to FFFF (Hex)
Default value: 0

Table 3-3 Physical Analog Input settings

3.4.2 Data Recorder Inputs

Data Recorder inputs are analog data points that are extracted from ION Data Recorder log
records.

Setting Description
Data Recorder Module Specify the Data Recorder module.
Range: Data Rec #1 to Data Rec #50
Default value: Data Rec #1
Source ID Specify the source Id of the Data Recorder module selected.
Range: Source #1 to Source #16
Default value: Source #1

Table 3-4 Data Recorder Analog Input settings

3.5 Binary Input Settings

Each instance of this master protocol component may contain several binary inputs. Binary input
settings tell the component how to map data retrieved from the device to system analog data.
The following table shows all the physical binary input settings specific to the Schneider Electric
(ION) master protocol.
3.5.1 Physical Inputs
Physical binary inputs are binary data points that are retrieved from the device database.

Setting Description

Handle Specify the handle of the device database that holds the point’s
value.
Range: 0 to FFFF (Hex)
Default value: 0

Table 3-5 Physical Binary Input settings

3.5.2 Data Recorder Inputs

Data Recorder inputs are binary data points that are extracted from ION Data Recorder log
records.

Setting Description

Data Recorder Module Specify the Data Recorder module.

Range: Data Rec #1 to Data Rec #50
Default value: Data Rec #1

6 SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL

 Setting Description
Source ID Specify the source Id of the Data Recorder module selected.
Range: Source #1 to Source #16
Default value: Source #1

Table 3-6 Data Recorder Binary Input settings

3.6 Request Interval Settings

Each instance of the Schneider Electric (ION) master protocol component contains several
request interval settings, which define which requests (methods) will be transmitted to the
Schneider Electric ION device, and at which frequency these requests will be sent.
The following table presents these settings.

Setting Description

Request The name of the request (method) to transmit.

Frequency The frequency, in milliseconds, at which the request (method) is
sent.
Range: 100 to 2,147,483,647 milliseconds
Default value: 5000 milliseconds

Table 3-7 Request Interval settings

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●7

4. Implementation Details
4.1 Startup Sequence
The protocol component goes through the following steps upon startup:
 Parses the configuration file.
 Initializes the various logs, traces and statistics.
 Creates all I/O points and marks them as invalid (communications failure).
 Initializes the communications link.
 Starts the scan cycle.

4.2 Scan Cycle

The protocol component manages the device polling cycle according to the following principles:
 The protocol is half duplex.
 The device must never send data without having first received a request for data.
 A response is sent to each request.

The Schneider Electric (ION) master response-processing rules are:

 A response is valid only if it arrives within the configured time limit.
 A response is valid only if it is formatted correctly according to the Schneider Electric ION
protocol specifications.
 The overall 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 reinitialized if too many consecutive bad receptions are received;
“too many” being the number of retry counts configured.

Link initialization occurs under the following circumstances:

 The SMP Gateway is being restarted.
 The communication link is being reset due to too many consecutive errors of any type.
Once the link has been initialized, and as long as it remains active, a regular scanning cycle is
used on a continuous basis. 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 the last sent request failed and must be retried, send it again.
 If there is a request configured with a counter corresponding to its frequency cycle, send it.
 If all the requests have been sent, wait for the next request with a counter corresponding to
its cycle.
 If configuration file scan is enabled, perform such scan at the configured frequency, to
determine if the configuration changed. If so, save the corresponding configuration in a file,
in the specified system folder.

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●8

 The scanning cycle can be interrupted anytime if there are output control requests.
If the normal scanning cycle is abandoned to cause a link reset, all I/O points are tagged as
being defective due to communications failure. Analog and binary input points become valid
again on an individual basis only when valid I/O data is received from the device. Analog and
binary output points become valid again as soon as the link is considered active.

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ●9

5. Troubleshooting
The following table enumerates solutions to common problems experienced with the Schneider
Electric (ION) master protocol component:

Problem Solution
The SMP Gateway is This problem can be due to one of the following:
not communicating  All request intervals are set to 0, which means that no requests
with my device. are sent.
 One of the reasons discussed in the Protocol Common Concepts
Reference Manual.

The link to my device This problem can be due to one of the following:
keeps resetting.  Reception timeout problem: The Rx Timeout Timer general
setting value is too small.
 Configuration mismatch: The protocol settings and your
Schneider Electric (ION) master’s configuration mismatches
with the device’s configuration. Update your master’s
configuration as required.
 One of the reasons discussed in the Protocol Common Concepts
Reference Manual.

A request occasionally This problem could be due to the following:

times out.  The Rx Timeout Timer general setting value is too small.

Table 5-1 Troubleshooting

SCHNEIDER ELECTRIC (ION) MASTER PROTOCOL REFERENCE MANUAL ● 10