Gw XML setup

From Phobos Wiki
Jump to navigation Jump to search

Element: Setup

The XML setup starts with the tag Setup. The entire setup is contained in this element.

All id attributes must be unique!

This element contains:

  • Element: Device
    • At least one element of this type.
  • Attribute: device
    • If more than one Device element available. This attribute specifies the id of the Device to use as current setup.

 <Setup device="Telem-Gw6-1">
 	<Device id="Telem-Gw6-1" />
 	<Device id="Gw1" />
 	<Device id="Gw2" />

Element: Device

This element contains setup for a specific device. This might be Gw itself or some substation device or SCADA device.

This element contains:

Child elements of Device when used as GW device

 <Device id="Telem-Gw6-1">
 	<Channel />
 	<Interfaces />

Child elements of Device when used as the device we're connecting to.

 <Device id="DI-24T-1">
 	<Protocol />
 	<Objects />

Element: Channel

This element contains:

 <Channel id="DI-24T-1">
 	<Port />
 	<Device />
 	<Objects />

Element: Protocol

 <Protocol comment="protocol8" id="prot_8_0">
 	<Address />
 	<CommunicationDelay unit="millisecond">0</CommunicationDelay>
 	<PollingTimeout unit="millisecond">500</PollingTimeout>
 	<TimeSync />
 	<TimeoutRemoveTime unit="second">20</TimeoutRemoveTime>
 	<Type SubVersion="0" isMaster="false">IEC101UnBalanced</Type>

Element: TimeSync

Timesync interval and correction setup

 <TimeSync isEnabled="true">
 	<Interval unit="second">30</Interval>
 	<Correction />

Element: Correction

Possible timesync correction types:

  • Absolute
    • Timesync message shall always be modified by this amount.
  • ConnectionSpeed
    • Baudrate based(only when using serial port)
 	<Absolute enabled="true" unit="millisecond">0</Absolute>
 	<ConnectionSpeed enabled="true"/>

Element: Address

This element can refer to protocol address or some specific object address.

Address for protocol

This elements contents depend on the protocol selected




Value: integer



Value: string

Can be empty if only one device on channel.

 <Address id="0.0.0">addr123</Address>

If this Address element contains attribute id, It shall be used for device verification.

Address of object


Value: integer

 <Address index="0">10</Address>

attribute index is unnecessary if value==0


 <Address fnCode="3" infoNr="6"/>


Kas standardis on dataType või dataCode vastava välja nimetus?

Väärtuse 1234 oleks ka võibolla mõistlik attribuuti dataNumber tõsta

Kas DI'l index on kasutused?

 <Address index="3" onEvent="6" offEvent="6" channelNumber="6" dataType="I">1234</Address>


 <Address onEvent="6" offEvent="6" channelNumber="6" dataCode="I" dataNumber="1234" />
 <Address channelNumber="6" dataType="I">1234</Address>


 <Address channelNumber="6" dataCode="I" dataNumber="1234" />
 <Address channelNumber="6" dataType="I">1234</Address>


 <Address channelNumber="6" dataCode="I" dataNumber="1234" />


Value: string



Other protocols might have additional fields.

Element: Port

        <Buffer id="inBuffer"/>
        <Buffer id="outBuffer"/>
        <IoBuffer in="inBuffer" out="outBuffer"/>

Port data forwarding

It is possible to send data from one port to another.

To do that, port1's input buffer is the same as port2's outputbuffer and vice versa.

 <Port id="port1">
        <Buffer id="portBufferIn"/>
        <Buffer id="portBufferOut"/>
        <IoBuffer in="portBufferIn" out="portBufferOut"/>
 <Port id="port2">
        <IoBuffer in="portBufferOut" out="portBufferIn"/>

The same method allows creation of a local loopback.

 <Port id="portLoopback">
        <Buffer id="portBuffer"/>
        <IoBuffer in="portBuffer" out="portBuffer"/>

Serial port

 <Port class="SerialPortSetup">

TCP/IP server

 <Port class="TcpIpServerSetup">

Element: ClientIpMask

Defines who is allowed to connect with us. More than one possible.

TCP/IP client

 <Port class="TcpIpClientSetup" name="16">

Virtual port

They are ports 3-5 on GW6.

 <Port class="VirtualPortSetup">
 	<Port class="SerialPortSetup">

Element: Objects

Element: Object

Depending on protocol the object belongs to (master/slave), has different child elements.

Possible child elements:

Attribute: type

Defines object type.

Possible values:

  • DI
  • AI
  • CN
  • DO
  • AO

Element: MxValue

Defines the object for current/latest value.

Child elements define default value, flags and time tag.

 <MxValue id="DI_6_value">

Element: Filter

Defines what is going to happen to the incoming measured value.

Filters can be daisy chained. To achieve different outcomes.

When an event is received, it is sent to it's filter. After the filter does what it's supposed to do, it will pass the event to the Next Filter

 <Filter class="Change">
 	<Filter class="Proxy" />

AddToBuffer may have more than one Target.

Target is a Buffer object.

 <Filter class="AddToBuffer">
 	<Target ref="DI_0_7_buf"/>
 	<Target ref="DI_1_7_buf"/>
 	<Target ref="DI_2_7_buf"/>
 	<Target ref="DI_3_7_buf"/>
 	<Target ref="DI_4_7_buf"/>

Passes event to the next filter only if specified target(MxValue) == false.

Possible use cases:

  • Respond negatively to control commands
  • Signal blocking

 <Filter class="Assert">

Detects change in Digital measurments value and status bits.


Used to detect change in analog and counter values

 <Filter class="Deadband">
  • Type
    • Default is Deadband1, if Deadband1 then element Type is unnecessary

New deadband type, not implemented.


This deadband is used for counter values.

f = abs( new_value - current_value ) > Threshold
  • Threshold
    • Integer value
    • If value=0; then no need for filter
<Filter class="Deadband">

This is the legacy GW6 deadband mode This deadband is used for analog values.

if( (new_value < Critical.min) || (new_value > Critical.max) )
    current_threshold = Threshold.db2
    current_threshold = Threshold.db1

if ( new_value.is_normalized )
    calculated_threshold = current_threshold / 100
    calculated_threshold = (Scale.max - Scale.min) * current_threshold / 100

f = abs( new_value - current_value ) > calculated_threshold
  • If Threshold.db1=0 and Threshold.db2=0, do not add Deadband filter.
  • Element Scale
    • Unneccessary when Scale.min=0 and Scale.max=0
  • If Critical.min=0 and Critical.max=0, following elements/attrbutes are not neccessary
    • Element Critical
    • Attribute "db2" of element "Threshold"

Example 1

Both DB1 and DB2 active

 <Filter class="Deadband">
  <Scale min="1" max="4" />
  <Threshold db1="2" db2="2" />
  <Critical min="2" max="3" />

Example 2

Works only on normalized values ( no element Scale )

DB2 inactive

 <Filter class="Deadband">
  <Threshold db1="2"/>

Example 3

Works on normalized and floating point values

DB2 inactive

 <Filter class="Deadband">
  <Scale min="1" max="4" />
  <Threshold db1="2"/>

Falls back to specified value.


This filter is used for converting floating point value to normalized value.

This filter works only on floating point values. Normalized values shall be passed on without change

 <Filter class="Normalize">

Element To has two possible value: -1...1 or 0...1 and this selects the formula and overflow conditions being used.

Range -1...1

overflow is set when normalized_value < -1 && normalized_value > 1

No element Min for this range

Range 0...1

overflow is set when normalized_value < 0 && normalized_value > 1


Inverts the passed digital value..


Input: digital value

This is not final!

<Filter class="IfElse">
    <Filter class="AddToBuffer">
      <Target ref="DO_device_output1_buf"/>  
    <Filter class="AddToBuffer">
      <Target ref="DO_device_output2_buf"/>  

This filter is used with Formulas when output controlling is needed.

  • Count
    • Default value if count not specified, 1
    • Number of output commands
    • Integer: 1...X ( X = uint32_t )
    • String: inf ( infinity, if Count is not convertable to integer, then inifinity is used)
  • Retry
    • time to wait before retry/next command
    • default value if not specified, 5 seconds
  • FirstControl
    • Defines if first control operation is allowed
<Filter class="OutputController">
  <Retry unit="second">5</Retry>
  <Filter class="Assert">
    <Filter class="AddToBuffer">
      <Target ref="DO_device_output1_buf"/>  

Proxy may have more than one next Filter.

 <Filter class="Proxy">
 	<Filter class="AddToBuffer" />
 	<Filter class="AddToBuffer" />
 	<Filter class="Fallback" />

This filter works only on normalized values. Non-normalized(floating point) values shall be passed on without change

 <Filter class="Scale">

If element Min=0 then no need to define that element, value 0 is used as default for Min. Element Max must always exist. Element To is not used.


??? kas teha filtrina või mõni muu lahendus?


Target is a MxValue object.

 <Filter class="UpdateValue">
 	<Target ref="DI_7_value"/>
f = 1 / tan(x)
f = 1 / cos(x)
f = 1 / sin(x)

Element: Buffer

Defines a buffer object, with depth.

 <Buffer id="DI_8_0_buf">

Element: Formula

Possible child elements:

Attribute: type - This defines the result type of formula. Possible choices DI, AI, CN

Element: Expression

Element name Expression may be abbreviated as Exp

Element name Operation may be abbreviated as O

Elements a and b are current expressions inputs.

Operation operand count example description
and ∞, a1 a2 ... an a1 ∧ a2 ∧ an
or ∞, a1 a2 ... an a1 ∨ a2 ∨ an
add ∞, a1 a2 ... an a1 + a2 + an
sub ∞, a1 a2 ... an a1 − a2 − an
not 1, a !a
sqr 1, a
sqrt 1, a √a
sin 1, a sin(a)
cos 1, a cos(a)
tan 1, a tan(a)
arcsin 1, a arcsin(a)
arccos 1, a arccos(a)
arctan 1, a arctan(a)
sec 1, a 1 / cos(a)
cosec 1, a 1 / sin(a)
cotan 1, a 1 / tan(a)
log 1, a loge(a) The natural logarithm is the base-e logarithm, the inverse of the natural exponential function (exp)
log10 1, a log10(a) Returns the common (base-10) logarithm of x
exp 1, a exp(a) Returns the base-e exponential function of x, which is the e number raised to the power x.
mul 2, a b a*b
div 2, a b a/b
pow 2, a b a^b
xor 2, a b a⊕b
eq 2, a b a = b Check equality
lt 2, a b a < b Less than
gt 2, a b a > b Greater than
example 1: or
f = a1 ∨ a2
    <Filter />
example 2: power
f = a^b

Formula example 1

f = @1 or @2
 <Formula type="DI" id="DI_f0" comment="Virtual1 OK">
      <MxValue id="DI_f0_value"/>
      <Buffer id="DI_f0_0_0_buf" /> <!-- @1 -->
      <Buffer id="DI_f0_0_1_buf" /> <!-- @2 -->
      <Expression>                  <!-- @1 or @2 -->
          <Filter ref="DI_f0_filter" />
      <Filter id="DI_f0_filter" class="Change">  <!-- result filter -->
          <Filter class="UpdateValue">
              <Target ref="DI_f0_value"/>
              <Filter class="AddToBuffer" />

DI_f0_0_0_buf and DI_f0_0_1_buf are inputs to formula.

Formula example 2

f = (@1 + @2) / (@3 + @4)
 <Formula type="DI" id="DI_f0" comment="formula example 2, f = (@1 + @2) / (@3 + @4)">
    <MxValue id="DI_f0_value"/>  <!-- This variable holds the latest value of formula -->
    <Buffer id="DI_f0_1_buf" />  <!-- @1 -->
    <Buffer id="DI_f0_2_buf" />  <!-- @2 -->
    <Buffer id="DI_f0_3_buf" />  <!-- @3 -->
    <Buffer id="DI_f0_4_buf" />  <!-- @4 -->
    <Buffer id="DI_f0_t1_buf" /> <!-- temporary result of @1 + @2 -->
    <Buffer id="DI_f0_t2_buf" /> <!-- temporary result of @2 + @3 -->
    <Expression>                 <!-- @1 + @2 -->
        <a>DI_f0_1_buf</a>       <!-- @1 -->
        <a>DI_f0_2_buf</a>       <!-- @2 -->
        <Filter class="AddToBuffer">
            <Target ref="DI_f0_t1_buf"/>
    <Expression>                 <!-- @3 + @4 -->
        <a>DI_f0_3_buf</a>       <!-- @3 -->
        <a>DI_f0_4_buf</a>       <!-- @4 -->
        <Filter class="AddToBuffer">
            <Target ref="DI_f0_t2_buf"/>
    <Expression>                 <!-- f = (@1 + @2) / (@3 + @4) -->
        <a>DI_f0_t1_buf</a>      <!-- @1 + @2 -->
        <a>DI_f0_t2_buf</a>      <!-- @3 + @4 -->
        <Filter ref="di_f0_filter" />
    <Filter id="di_f0_filter" class="AddToBuffer"> <!-- result filter -->
        <Target ref="DI_SCADA_buf"/>

Formula example 3

Comparison with constant

f = @1 < 3,5
 <Formula type="DI" id="DI_f0" comment="Formula example 3, constant, f = @1 < 3,5">
      <MxValue id="DI_f0_value"/>   <!-- latest value of formula -->
      <Buffer id="AI_f0_0_0_buf" /> <!-- @1 -->
      <Expression>                  <!-- @1 < 3,5 -->
          <Filter ref="DI_f0_filter" />
      <Filter id="DI_f0_filter" class="Change">  <!-- result filter -->
          <Filter class="UpdateValue">
              <Target ref="DI_f0_value"/>
              <Filter class="AddToBuffer" />

Element: Interfaces

Network setup

Has at least one Interface element.

 <Interface name="eth0">


Example with required elements.

 <Vlan interface="eth0">

Example with additional elements from Interface

 <Vlan interface="eth0">