[go: up one dir, main page]

0% found this document useful (0 votes)
32 views21 pages

Domosys (PowerBus) Master Protocol

Uploaded by

Kamale Kasa
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
32 views21 pages

Domosys (PowerBus) Master Protocol

Uploaded by

Kamale Kasa
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 21

Reference Manual

MN912081, version 8

Domosys (PowerBus)
Master Protocol
Documentation for part number P-SMPR-2401.
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: PSMO-sales@eaton.com
Web: http://www.cooperpower.com

Technical Support: eas-support@eaton.com

MN912081, version 8
EAS-SA QF-MKT-02 Rev.02

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

2 Features 3
2.1 Communications ....................................................................................................3
2.2 Supported Requests ...............................................................................................3

3 Configuration Settings 5
3.1 General Settings ....................................................................................................5
3.2 Redundancy Settings .............................................................................................6
3.3 Analog Input Settings ............................................................................................7
3.3.1 Remote Analog Input Settings ................................................................7
3.3.2 Local Analog Input Settings ....................................................................8
3.4 Binary Input Settings .............................................................................................9
3.4.1 Remote Binary Input Settings .................................................................9
3.4.2 Local Binary Input Settings.....................................................................9
3.5 Analog Output Settings ....................................................................................... 10
3.6 Binary Output Settings ........................................................................................ 11

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

5 Troubleshooting 15

Domosys (PowerBus) Master Protocol Reference Manual ●i


EAS-SA QF-MKT-02 Rev.02

Tables
Table 2-1 Communications Features ............................................................................................ 3
Table 2-2 Supported Requests ...................................................................................................... 4
Table 3-1 General Settings ............................................................................................................ 6
Table 3-2 Redundancy Settings .................................................................................................... 7
Table 3-3 Remote Analog Input Settings ...................................................................................... 8
Table 3-4 Local Analog Input Settings ......................................................................................... 9
Table 3-5 Remote Binary Input Settings ....................................................................................... 9
Table 3-6 Local Binary Input Settings ........................................................................................ 10
Table 3-7 Analog output Settings ............................................................................................... 11
Table 3-8 Binary Output Settings ............................................................................................... 11
Table 5-1 Troubleshooting .......................................................................................................... 15

Domosys (PowerBus) 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 Domosys (PowerBus) master
protocol component in an SMP Gateway.
This protocol component is used to retrieve data from a Domosys U-532 device compatible with
the SMP Gateway Domosys (PowerBus) master protocol definition. It can also be used to control
such a device.
You need to be familiar with the SMP Gateway environment, master protocol concepts, and the
PowerBus protocol specification before proceeding with this document. You can get this
information by reading the following documents:
 PowerBus™ ICs Datasheet Firmware Version 3.0 Master/Slave, Document D-PWB-0100,
Revision 09, Domosys.
 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: eas-support@eaton.com
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.

Domosys (PowerBus) Master Protocol Reference Manual •1


EAS-SA QF-MKT-02 Rev.02

2 Features

This chapter enumerates the features provided by the Domosys (PowerBus) master protocol
component.

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

Feature Comment
Serial Port This protocol component supports RS-232 interfaces at bit rates up to
38400bps.

Serial Multidrop Multiple instances of the Domosys (PowerBus) protocol component can share a
single serial port, as long as different addresses are used to identify the devices
and as long as the devices support such a feature.

Passthrough Connections This protocol component allows passthrough connections with or without
scanning sequence interruptions.

TCP/IP This protocol component supports TCP/IP communications.

TCP/IP Multidrop Multiple instances of the Domosys (PowerBus) 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.

Link Redundancy This protocol component can be configured to use 2 different communication
links to communicate with the same device.

Hot Standby This protocol component can be configured to synchronize all its data and
scanning states between 2 SMP Gateways in a redundant setup.

Table 2-1 Communications Features

2.2 Supported Requests


The following table illustrates which requests are currently supported by the Domosys (PowerBus)
master protocol component:

Domosys (PowerBus) Master Protocol Reference Manual •3


EAS-SA QF-MKT-02 Rev.02

Request Description
000 Explicit Request (Get, Set)

100 Result (Get, Set)

111 Reject

Table 2-2 Supported Requests

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

3 Configuration Settings

This chapter enumerates the configuration settings you have to specify for each Domosys
(PowerBus) master protocol instance. The SMP Config software program is generally used to
define these settings.
Only the settings specific to the PowerBus protocol are described here. The settings common to all
master protocol components are described in the Eaton document entitled 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
Domosys (PowerBus) master protocol.

Setting Description
Device Address The address of the device with which the master protocol component
communicates.
Range: 0 to 0xFFFFFF
Default value: 0xFFFFFF

Mirror Enabled A checkmark enables the U-531 mirror query.


Range: checkmark / no checkmark
Default value: no checkmark

Mirror ID The identification of the mirror in the U-531.


Range: 0 to 0xFF
Default value: 0x50

Mirror Size The size of the U-531 mirror, in bytes.


Range: 0 to 0xFFFF bytes
Default value: 0x2040 bytes

Mirror Element Length The length of a mirror element.


Range: 0x01 to 0xFF
Default value: 0x40

Domosys (PowerBus) Master Protocol Reference Manual •5


EAS-SA QF-MKT-02 Rev.02

Setting Description
Elements by Mirror The maximum number of elements per mirror request.
Request
Range: 0 to 1024
Default value: 3

Mirror Scan Interval The minimum delay, in milliseconds, between two complete mirror scan cycles.
Range: 0 to 2,147,483,647 ms
Default value: 3000 ms

Fast Scan Interval The minimum delay, in milliseconds, between two complete fast scan cycles.
Range: 0 to 2,147,483,647 ms
Default value: 3000 ms

Medium Scan Interval The minimum delay, in milliseconds, between two complete medium scan
cycles.
Range: 0 to 2,147,483,647 ms
Default value: 60,000 ms

Slow Scan Interval The minimum delay, in milliseconds, between two complete slow scan cycles.
Range: 0 to 2,147,483,647 ms
Default value: 900,000 ms

Rx Timeout Timer The amount of time to wait, in milliseconds, 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 300,000 ms
Default value: 5000 ms

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

Table 3-1 General Settings

3.2 Redundancy Settings


Each instance of this master protocol component contains redundancy settings, which set the
general behavior of the redundancy component. The following table shows the redundancy
settings that are specific to the Domosys (PowerBus) master protocol.

6● Chapter 3: Configuration Settings


EAS-SA QF-MKT-02 Rev.02

Setting Description
Link 1 Test Interval The delay, in milliseconds, between two complete link test requests on link 1.
Range: 0 to 300,000 ms
Default value: 3,000 ms

Link 2 Test Interval The delay, in milliseconds, between two complete link test requests on link 2.
Range: 0 to 300,000 ms
Default value: 3,000 ms

Device Address The address of the device with which the protocol component communicates.
Range: 0 to 0xFFFFFF
Default value: 0xFFFFFF

Rx Timeout Timer The amount of time to wait, in milliseconds, 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 300,000 ms
Default value: 5,000 ms

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

Table 3-2 Redundancy Settings

3.3 Analog Input Settings


3.3.1 Remote Analog Input Settings
Each instance of the master protocol component may contain several remote analog input points.
Remote analog input settings tell the component how to process data retrieved from the PowerBus
device. The following table shows the remote analog input settings that are specific to the
Domosys (PowerBus) master protocol.

Setting Description
Value Type Indicates the type of value that will be retrieved from the device.
Allowed values: Unsigned Char (8 bits)
Signed Integer (16 bits)
Signed Long (32 bits)
Floating Point (32 bits)
Default value: Unsigned Char (8 bits)

Domosys (PowerBus) Master Protocol Reference Manual •7


EAS-SA QF-MKT-02 Rev.02

Setting Description
Address Indicates the PowerBus device address from which the input value is to be
retrieved.
Range: 0x0 to 0xFFFFFF
Default value: 0x0

ID Logical index that identifies the Virtual Variable (V2).


Range: 0x0 to 0xFF
Default value: 0x0

Quality Indicates the local binary input that will be associated with this data point for the
purpose of retrieving its quality. This setting has no effect unless the Mirror
Enabled general setting is selected.
Allowed values: None
Any defined local binary inputs
Default value: None

Scan Type The scan type used to retrieve the analog data.
Allowed values: Slow
Medium
Fast
Default value: Slow

Table 3-3 Remote Analog Input Settings

3.3.2 Local Analog Input Settings


Each instance of the master protocol component may contain several local analog input points.
Local analog input settings tell the component how to process data retrieved from the U-531
Mirror. The following table shows the local analog input settings that are specific to the Domosys
(PowerBus) master protocol.

Setting Description
Value Type Indicates the type of value that will be retrieved
Allowed values: Unsigned Char (8 bits)
Signed Integer (16 bits)
Signed Long (32 bits)
Floating Point (32 bits)
Default value: Unsigned Char (8 bits)

Address Contains the byte memory address in the U-531 mirror, where the input value is
stored.
Range: 0x0 to 0xFFFF
Default value: 0x0

8● Chapter 3: Configuration Settings


EAS-SA QF-MKT-02 Rev.02

Setting Description
Quality Indicates the local binary input that will be associated with this data point for the
purpose of retrieving its quality. This setting has no effect unless the Mirror
Enabled general setting is selected.
Allowed values: None
Any defined local binary inputs
Default value: None

Table 3-4 Local Analog Input Settings

3.4 Binary Input Settings


3.4.1 Remote Binary Input Settings
Each instance of the master protocol component may contain several remote binary input points.
Remote binary input settings tell the component how to process data retrieved from the PowerBus
device. The following table shows the remote binary input settings that are specific to the
Domosys (PowerBus) master protocol.

Setting Description
Address Indicates the PowerBus device address from which the input value is to be
retrieved.
Range: 0x0 to 0xFFFFFF
Default value: 0x0

ID Logical index that identifies the Virtual Variable (V2).


Range: 0x0 to 0xFF
Default value: 0x0

Quality Indicates the local binary input that will be associated with this data point for the
purpose of retrieving its quality. This setting has no effect unless the Mirror
Enabled general setting is selected.
Allowed values: None
Any defined local binary inputs
Default value: None

Scan Type The scan type used to retrieve the analog data.
Allowed values: Slow
Medium
Fast
Default value: Slow

Table 3-5 Remote Binary Input Settings

3.4.2 Local Binary Input Settings


Each instance of the master protocol component may contain several local binary input points.
Local binary input settings tell the component how to process data retrieved from the U-531

Domosys (PowerBus) Master Protocol Reference Manual •9


EAS-SA QF-MKT-02 Rev.02

Mirror. The following table shows the local binary input settings that are specific to the Domosys
(PowerBus) master protocol.

Setting Description
Address Contains the byte memory address in the U-531 mirror, where the input value is
stored.
Range: 0x0 to 0xFFFF
Default value: 0x0

Bit Offset The bit position of the binary value, in the byte indicated by the Address
setting.
Range: 0 to 7
Default value: 0

Quality Indicates the local binary input that will be associated with this data point for
the purpose of retrieving its quality. This setting has no effect unless the Mirror
Enabled general setting is selected.
Allowed values: None
Any defined local binary inputs
Default value: None

Table 3-6 Local Binary Input Settings

3.5 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 Domosys (PowerBus) master protocol.

Setting Description
Value Type Indicates the type of value that will be written.
Allowed values: Unsigned Char (8 bits)
Signed Integer (16 bits)
Signed Long (32 bits)
Floating Point (32 bits)
Default value: Unsigned Char (8 bits)

Address Indicates the PowerBus device address to which the output value is to be
written.
Range: 0x0 to 0xFFFFFF
Default value: 0x0

ID Logical index that identifies the Virtual Variable (V2).


Range: 0x0 to 0xFF
Default value: 0x0

10 ● Chapter 3: Configuration Settings


EAS-SA QF-MKT-02 Rev.02

Setting Description
Quality Indicates the local binary input that will be associated with this data point for the
purpose of retrieving its quality. This setting has no effect unless the Mirror
Enabled general setting is selected.
Allowed values: None
Any defined local binary inputs
Default value: None

Table 3-7 Analog output Settings

3.6 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 Domosys (PowerBus) master protocol.

Setting Description
Address Indicates the PowerBus device address to which the output value is to be
written.
Range: 0x0 to 0xFFFFFF
Default value: 0x0

ID Logical index that identifies the Virtual Variable (V2).


Range: 0x0 to 0xFF
Default value: 0x0

Quality Indicates the local binary input that will be associated with this data point for
the purpose of retrieving its quality. This setting has no effect unless the Mirror
Enabled general setting is selected.
Allowed values: None
Any defined local binary inputs
Default value: None

Table 3-8 Binary Output Settings

Domosys (PowerBus) Master Protocol Reference Manual • 11


EAS-SA QF-MKT-02 Rev.02

4 Implementation Details

4.1 Startup Sequence


The protocol component does the following on startup:
 Parses the configuration file.
 Initializes the various logs, traces and statistics.
 Creates all I/O points and marks them as invalid (communication failure).
 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 full duplex.
 The device never sends data without first having received a request for data (events are not
currently supported).
 There is a response to each request.

The Domosys (PowerBus) response processing rules are:


 A response is valid only if it arrives within the configured time limit.
 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 retry
counts configured.
Whatever the reason, the link is reset from scratch if too many consecutive bad reception 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.

Domosys (PowerBus) Master Protocol Reference Manual • 13


EAS-SA QF-MKT-02 Rev.02

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’s 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.
The scan cycle can be interrupted at any time 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. Binary output points
become valid again as soon as the link is considered active.

14 ● Chapter 4: Implementation Details


EAS-SA QF-MKT-02 Rev.02

5 Troubleshooting

The following table enumerates solutions to common problems experienced with the Domosys
(PowerBus) master protocol component:

Problem Solution
The SMP Gateway isn't This problem can be due to one of the following:
communicating with my
 One of the reasons discussed in the Protocol Common Concepts Reference
device.
Manual.
 Device addressing problem: The configured Device Address general setting
does not match the one configured in the device.

The link to my device keeps This problem can be due to one of the following:
resetting.
 One of the reasons discussed in the Protocol Common Concepts Reference
Manual.
 Reception timeout problem: The configured Rx Timeout Timer general
setting is too small.

Table 5-1 Troubleshooting

Domosys (PowerBus) Master Protocol Reference Manual • 15

You might also like