Reference Manual

ABB SPA-Bus Master

Protocol
Documentation for part number P-SMPR-1301
© 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: [email protected]
Web: http://www.cooperpower.com

Technical Support: [email protected]

S1120-38-1, version 6
Contents
1. Introduction ............................................................................................................................. 1
2. Features.................................................................................................................................... 2
2.1 Communications....................................................................................................................... 2
2.2 Supported Data Categories ....................................................................................................... 2
2.2.1 Device Data Retrieval ................................................................................................. 2
2.2.2 Device Control ........................................................................................................... 2
2.2.3 4-Point Control .......................................................................................................... 3
3. Configuration Settings ............................................................................................................. 4
3.1 General Settings....................................................................................................................... 4
3.2 Analog Input Settings ............................................................................................................... 5
3.3 Binary Input Settings ................................................................................................................ 6
3.4 Analog Output Settings ............................................................................................................. 6
3.5 Binary Output Settings ............................................................................................................. 7
3.6 Scanning Sequence Settings ..................................................................................................... 8
4. Implementation Details ......................................................................................................... 10
4.1 Startup Sequence ................................................................................................................... 10
4.2 Scan Cycle ............................................................................................................................. 10
5. Troubleshooting ..................................................................................................................... 12

ABB SPA-BUS MASTER PROTOCOL I

Tables
Table 2-1 Communications Features ................................................................................ 2
Table 2-2 Supported Requests .......................................................................................... 2
Table 2-3 4-Point Control: Commands sent to the device ................................................ 3
Table 3-1 General Settings ............................................................................................... 5
Table 3-2 Analog Input Settings ....................................................................................... 6
Table 3-3 Binary Input Settings ........................................................................................ 6
Table 3-4 Analog Output Settings ..................................................................................... 7
Table 3-5 Binary Output Settings ..................................................................................... 8
Table 3-6 Scanning Sequence Settings ............................................................................. 9
Table 5-1 Troubleshooting .............................................................................................. 12

ABB SPA-BUS MASTER PROTOCOL III

1. Introduction
This manual provides the information required to install and set up an ABB SPA-Bus master
protocol component in an SMP Gateway.
This protocol component is used to retrieve data from any device compatible with the ABB SPA-
Bus protocol definition. It can also be used to control such a device.
You must be familiar with the SMP Gateway environment, master protocol concepts and the ABB
SPA-Bus protocol specification before proceeding with this document. You can acquire this
information 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.
 SPA-Bus Communication Protocol V2.5 - Technical Description, 1MRS 750076-MTD EN, ABB
Inc.

ABB SPA-BUS MASTER PROTOCOL 1

2. Features
This chapter enumerates the features provided by the ABB SPA-Bus master protocol component.

2.1 Communications
The following communications features are available when interconnecting devices to the
SMP Gateway:

Feature Comment
Serial Port The ABB SPA-Bus master protocol component supports RS-232
interfaces at bit rates up to 115200 bps.
Serial Multidrop Multiple instances of this protocol component can share a single
serial port, as long as different addresses are used to identify the
devices and the serial hardware supports such a feature.
Passthrough This protocol component allows passthrough connections without
Connections scanning sequence interruptions.
TCP/IP The ABB SPA-Bus protocol component supports TCP/IP
communications.
TCP/IP Multidrop Multiple instances of the ABB SPA-Bus 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.

Table 2-1 Communications Features

2.2 Supported Data Categories

The following table lists the data categories that are currently supported by the master protocol
component (refer to “SPA-Bus Communication Protocol V2.5” for a technical description).

Request Description

I Inputs (reading only).

O Outputs (reading and writing).
S Settings (reading and writing).
V Device variables (reading and writing).

Table 2-2 Supported Requests

2.2.1 Device Data Retrieval

All data categories can be used to retrieve data from the device. The data obtained is then
transformed to standard analog or binary input data, as specified by the configuration settings
(see chapter 3 for details on configuration), published on the system, and made available to slave
components.
All data is time-stamped by the system when transitions are received.
2.2.2 Device Control
Analog and binary outputs may be configured to allow device control. Data categories “O”, “S”
and “V” are used to send control requests to devices.

2 ABB SPA-BUS MASTER PROTOCOL

 Some device control requests are password-protected. Therefore, the appropriate password must
be specified in the configuration settings. Refer to the device configuration manual for a list of
password-protected requests.
2.2.3 4-Point Control
For interoperability reasons, it is possible to define a 4-point control group in the SPA-Bus master
protocol. A 4-point control group consists of 4 points that allow a Select/Execute operation, which
would normally be done with two different points, to be done on a single point. Such a group
includes the following points: Open, Close, Apply and Cancel (Cancel is optional).
By issuing a command on an “Open” or “Close” point that is part of a 4-point control group, two
commands are sent to the device: Open/Close and Apply. For the operation to be considered a
success, both of these commands need to succeed.
The following table shows the commands sent to the device, depending on the value on which
the operation occurred:

Point Operation Command

“Open” OPEN (0) 1 -> “Open” Point
1 -> “Apply” Point
“Open” CLOSE (1) 1 -> “Close” Point
1 -> “Apply” Point
“Close” OPEN (1) 1 -> “Open” Point
1 -> “Apply” Point
“Close” CLOSE (1) 1 -> “Close” Point
1 -> “Apply” Point

Table 2-3 4-Point Control: Commands sent to the device

For additional information on how to define a 4-point control group, turn to the “Description”
setting of the binary output point, in section 3.5 Binary Output Settings.

ABB SPA-BUS MASTER PROTOCOL 3

3. Configuration Settings
This chapter enumerates the configuration settings to be specified for each ABB SPA-Bus master
protocol component instance. The SMP Config software is generally used to define these settings.
A template is available in the “Device Templates” directory of the SMP Config software, which
contains all the required settings of a SPAA341C device. Its use is strongly recommended if you
are planning to use the ABB SPA-Bus master protocol component to communicate with a
SPAA341C device.
Only the settings specific to the ABB SPA-Bus 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 ABB SPA-Bus master protocol.

Setting Description
Device Address The address of the device with which the protocol component
communicates. This address must be unique for each instance that
uses the same multi-drop link.
Range: 1 to 999 (900 excluded)
Default value: 1
Password The password used to send control requests to the device.
Range: 0 to 999
Default value: 0 (disabled)
Scan Interval The minimum delay, in milliseconds, between two complete scan
cycles. Note that this delay may be much longer when multiple
instances of the protocol component share a communications link
(multi-drop).
Range: 0 to 300,000 ms (5 minutes)
Default value: 1000 ms
Time Sync Interval The interval, in seconds, between master protocol time
synchronization messages.
Range: 0 to 600 seconds (0 = disabled)
Default value: 60 seconds
Date Sync Interval The interval, in minutes, between master protocol date
synchronization messages.
Range: 0 to 1440 minutes (0 = disabled)
Default value: 60 minutes

4 ABB SPA-BUS MASTER PROTOCOL

 Setting Description
Rx Timeout Timer Time 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 (timeout 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 ms
Default value: 250 ms
Rx Retry Count The number of consecutive times that a bad response (or no
response) must be received prior to declaring a communications
failure and attempting to re-initialize the link.
Note that this setting is not used for control requests (they are sent
only once).
Range: 0 to 100
Default value: 3
Omit Tx Checksum If you put a checkmark, the master protocol component will not
calculate a valid checksum value when sending a request.
Characters “XX” will be sent as the checksum.
Range: checkmark / no checkmark
Default value: no checkmark

Table 3-1 General Settings

3.2 Analog Input Settings

Each instance of the master protocol component may contain several analog input points. Analog
input settings tell the component how to process data retrieved from the device. The following
table shows the analog input settings that are specific to the ABB SPA-Bus master protocol.

Setting Description
Data Format The data format of the point. This setting is used by the
SMP Gateway application to convert the point value.
Depending on the type of value that will be returned by the device,
configure this setting as follows:
 Device will return a raw value: set as integer (signed or
unsigned).
 Device will return an engineering value: set as real.
Allowed values: Unsigned Integer
Signed Integer
Real
Default value: Real

ABB SPA-BUS MASTER PROTOCOL 5

 Setting Description
Data Category The data category of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Allowed values: Input
Setting
Variable
Default value: Input
Channel The slave channel of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 0 to 999
Default value: 0
Index The index of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 1 to 999,999 (must be unique)
Default value: 1

Table 3-2 Analog Input Settings

3.3 Binary Input Settings

Each instance of the master protocol component may contain several binary input points. Binary
input settings tell the component how to process data retrieved from the device. The following
table shows the binary input settings that are specific to the ABB SPA-Bus master protocol.

Setting Description
Data Category The data category of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Allowed values: Input
Setting
Variable
Default value: Input
Channel The slave channel of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 0 to 999
Default value: 0
Index The index of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 1 to 999,999 (must be unique)
Default value: 1

Table 3-3 Binary Input Settings

3.4 Analog Output Settings

Each instance of the master protocol component may contain several analog output points.
Analog output settings tell the component how to control the device. The following table shows
the analog output settings that are specific to the ABB SPA-Bus master protocol.

6 ABB SPA-BUS MASTER PROTOCOL

 Setting Description
Data Format The data format of the point. This setting is used by the
SMP Gateway application to convert the point value.
Depending on the type of value that will be returned by the device,
configure this setting as follows:
 Device will return a raw value: set as integer (signed or
unsigned).
 Device will return an engineering value: set as real.

Allowed values: Unsigned Integer

Signed Integer
Real
Default value: Real
Data Category The data category of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Allowed values: Output
Setting
Variable
Default value: Output
Channel The slave channel of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 0 to 999
Default value: 0
Index The index of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 1 to 999,999 (must be unique)
Default value: 1

Table 3-4 Analog Output Settings

3.5 Binary Output Settings

Each instance of the master protocol component may contain several binary output points. Binary
output settings tell the component how to control the device. The following table shows the
binary output settings that are specific to the ABB SPA-Bus master protocol.

Setting Description
Data Category The data category of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Allowed values: Output
Setting
Variable
Default value: Output
Channel The slave channel of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 0 to 999
Default value: 0

ABB SPA-BUS MASTER PROTOCOL 7

 Setting Description
Index The index of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 1 to 999,999 (must be unique)
Default value: 1
Description Usually a simple description of the point. However, for certain
binary outputs, this setting defines a group of 4 points (Open,
Close, Apply, Cancel) used to open and close relay circuits. To
define a
4-point control group, use one of the following formats, depending
on the operation type:
 ::4PC + Type + Group#
For example:
Open Point: ::4PCO1
Close Point: ::4PCC1
Apply Point: ::4PCA1
Cancel Point: ::4PCX1
Note: The format is case sensitive.
You can set Apply and Cancel to global, which means that they will
be used for all groups. To do this, omit the group number at the
end of the description.
For example:
Apply Point: ::4PCA
Cancel Point: ::4PCX

Table 3-5 Binary Output Settings

3.6 Scanning Sequence Settings

Each instance of the master protocol component contains several scanning sequence settings,
which set up the requests for data retrieval that are sent periodically to the device. The following
table shows the scanning sequence settings.

Setting Description
Data Category The data category of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Allowed values: Input
Output
Setting
Variable
Default value: Input
Channel The slave channel of the point. This setting is used by the protocol
component to map the point to the appropriate data.
Range: 0 to 999
Default value: 0
Start Index First point index to be scanned.
Range: 1 to 999,999
Default value: 1

8 ABB SPA-BUS MASTER PROTOCOL

 Setting Description
Quantity Number of points to be scanned.
Range: 1 to 999,999
Default value: 1
Frequency Scanning frequency of the specified request. A value of 0 specifies
that the request is to be sent only once. A value of 1 specifies that
the request is sent every scanning cycle. A value of N specifies that
the request is to be sent every N cycles.
Allowed values: 0
1
2 to 1,000
Default value: 1

Table 3-6 Scanning Sequence Settings

ABB SPA-BUS MASTER PROTOCOL 9

4. Implementation Details
4.1 Startup Sequence
The protocol component goes through the following steps on 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 using the following principles:
 The protocol is half duplex.
 The device should never send data without having first received a request for data.
 There will always be a response to each request.

The ABB SPA-Bus response processing rules are:

 A response is valid only if it arrives within the configured time limit.
 A response is valid only if it begins and ends with a special transmission flag.
 A response is valid only if it has the correct checksum.
 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
configured retry counts.

Whatever the reason, the link is reset 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 communications link is being reset due to too many consecutive errors of any type.

Requests sent on a link initialization:

 The master updates the current time (if needed).
 The master sets the control password (if provided by the user).
 The master updates the current date (if needed).
 The master sets the slave status to 0.
 The master requests the slave identification.

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 message priority is defined in the following order:

10 ABB SPA-BUS MASTER PROTOCOL

  Control requests.
 Pass-thru messages.
 Date and time updates.
 Regular scanning requests.

The scanning cycle may be interrupted anytime if there are any output control requests, pass-
thru messages or date/time updates.

The regular scanning cycle is as follows:

 If the last request sent failed and must be retried, send it again.
 If a configured request with a 0 frequency has not been sent yet, send it.
 If a request that must be sent during this cycle has not been sent yet, send it.
 If there are no more requests to send, wait for the configured “scan interval” before starting
a new cycle.

If the normal scanning cycle is abandoned to cause a link reset, all I/O points are tagged as
being defective due to a 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. Binary output
points become valid again as soon as the link is considered active.

ABB SPA-BUS MASTER PROTOCOL 11

5. Troubleshooting
The following table enumerates solutions to common problems experienced with the ABB SPA-
Bus 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
with my device. Reference Manual.
 No request in the scan cycle: at least one request must be
configured in your scanning sequence settings.
 Device addressing problem: the device address configured in
the general settings must match the one configured in the
device.
 Serial configuration problem: make sure the baud rate, parity,
start and stop bits match your device configuration.

The link to my device This problem can be due to one of the following:
keeps resetting.  One of the reasons discussed in the Protocol Common Concepts
Reference Manual.
 Reception timeout problem: the reception timeout configured in
the general settings is too small.
 Out-of-range index requested: for a request, the sum of the
Start Index + Quantity must not exceed the last index
supported by the device for a specific Data Category. If it does
exceed that limit, the device will always send a NACK reply,
which will cause the link to reset.
 Index does not exist: for a request, if a point does not exist on
the device for the defined range, the device will always send a
NACK reply, which will cause the link to reset.

Table 5-1 Troubleshooting

12 ABB SPA-BUS MASTER PROTOCOL