Gw XML setup
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" /> </Setup>
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:
- Element: Channel
- Element: Protocol
- Element: Objects
- Element: Interfaces
- Attribute: id
- Used for element identification
Child elements of Device when used as GW device
<Device id="Telem-Gw6-1"> <Channel /> <Interfaces /> </Device>
Child elements of Device when used as the device we're connecting to.
<Device id="DI-24T-1"> <Protocol /> <Objects /> </Device>
Element: Channel
This element contains:
- Element: Port
- If more than one Port is specified, they are for redundancy.
- Element: Device
- Element: Objects
<Channel id="DI-24T-1"> <Port /> <Device /> <Objects /> </Channel>
Element: Protocol
<Protocol comment="protocol8" id="prot_8_0"> <Address /> <CommunicationDelay unit="millisecond">0</CommunicationDelay> <PollingTimeout unit="millisecond">500</PollingTimeout> <TimeSync /> <TimeoutRemoveCount>5</TimeoutRemoveCount> <TimeoutRemoveTime unit="second">20</TimeoutRemoveTime> <ReplaceTime>false</ReplaceTime> <GeneralInterrogationForwarding>false</GeneralInterrogationForwarding> <Type SubVersion="0" isMaster="false">IEC101UnBalanced</Type> </Protocol>
Element: TimeSync
Timesync interval and correction setup
<TimeSync isEnabled="true"> <Interval unit="second">30</Interval> <Correction /> </TimeSync>
Element: Correction
Possible timesync correction types:
- Absolute
- Timesync message shall always be modified by this amount.
- ConnectionSpeed
- Baudrate based(only when using serial port)
<Correction> <Absolute enabled="true" unit="millisecond">0</Absolute> <ConnectionSpeed enabled="true"/> </Correction>
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
Iec-10x
<Address> <LinkAddress>1</LinkAddress> <LinkAddressLength>1</LinkAddressLength> <AsduAddress>1</AsduAddress> <AsduAddressLength>2</AsduAddressLength> <ObjectAddressLength>2</ObjectAddressLength> </Address>
MODBUS
Value: integer
<Address>2</Address>
IEC62056-21
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
Iec-10x
Value: integer
<Address index="0">10</Address>
attribute index is unnecessary if value==0
IEC61580/IEC62056-21
Value: string
<Address>5.3.5</Address>
Other
Other protocols might have additional fields.
Element: Port
<Port> <Buffer id="inBuffer"/> <Buffer id="outBuffer"/> <IoBuffer in="inBuffer" out="outBuffer"/> </Port>
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> <Port id="port2"> <IoBuffer in="portBufferOut" out="portBufferIn"/> </Port>
The same method allows creation of a local loopback.
<Port id="portLoopback"> <Buffer id="portBuffer"/> <IoBuffer in="portBuffer" out="portBuffer"/> </Port>
Serial port
<Port class="SerialPortSetup"> <BaudRate>9600</BaudRate> <DataBits>8</DataBits> <StopBits>1</StopBits> <Parity>none</Parity> <FlowControl>none</FlowControl> </Port>
TCP/IP server
<Port class="TcpIpServerSetup"> <PortNumber>80</PortNumber> <ClientIpMask>0.0.0.0</ClientIpMask> <Interface>eth0</Interface> </Port>
Element: ClientIpMask
Defines who is allowed to connect with us. More than one possible.
TCP/IP client
<Port class="TcpIpClientSetup" name="16"> <PortNumber>502</PortNumber> <IpAddress>10.0.0.89</IpAddress> <Interface>eth0</Interface> </Port>
Virtual port
They are ports 3-5 on GW6.
<Port class="VirtualPortSetup"> <Port class="SerialPortSetup"> <BaudRate>9600</BaudRate> <DataBits>8</DataBits> <StopBits>1</StopBits> <Parity>none</Parity> <FlowControl>none</FlowControl> </Port> </Port>
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"> <Value>0</Value> <BitMask> <Bit>Invalid</Bit> <Bit>NotTopical</Bit> </BitMask> </MxValue>
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" /> </Filter>
AddToBuffer
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"/> </Filter>
Assert
Passes event to the next filter only if specified target(MxValue) == false.
<Filter class="Assert"> <Target ref="DI_7_value"/> </Filter>
Change
Detects change in Digital measurments value and status bits.
Deadband
Used to detect change in analog and counter values
<Filter class="Deadband"> <Type>X</Type> <Threshold>2</Threshold> </Filter>
Integral
New deadband type, not implemented.
Absolute
This deadband is used for counter values.
f=abs(new_value-old_value)>Threshold
Deadband1
This deadband is used for analog values.
Fallback
Falls back to specified value.
Normalize
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"> <To>-1...1</To> <Max>100</Max> <Min>10</Min> </Filter>
Element To has two possible value: -1...1 or 0...1 and this selects the formula and overflow conditions being used.
Range -1...1
normalized_value=float_value/Max
overflow is set when normalized_value < -1 && normalized_value > 1
No element Min for this range
Range 0...1
normalized_value=(float_value-Min)/(Max-Min)
overflow is set when normalized_value < 0 && normalized_value > 1
Inversion
Inverts the passed digital value.
Proxy
Proxy may have more than one next Filter.
<Filter class="Proxy"> <Filter class="AddToBuffer" /> <Filter class="AddToBuffer" /> <Filter class="Fallback" /> </Filter>
Scale
This filter works only on normalized values. Non-normalized(floating point) values shall be passed on without change
scaled_value=normalized_value*(Max-Min)+Min
<Filter class="Scale"> <Max>100</Max> <Min>10</Min> </Filter>
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.
CsvLogger
??? kas teha filtrina või mõni muu lahendus?
UpdateValue
Target is a MxValue object.
<Filter class="UpdateValue"> <Target ref="DI_7_value"/> </Filter>
Element: Buffer
Defines a buffer object, with depth.
<Buffer id="DI_8_0_buf"> <Depth>10</Depth> </Buffer>
Element: Formula
Possible child elements:
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"> <Depth>10</Depth> </Buffer> <Buffer id="DI_f0_0_1_buf"> <Depth>10</Depth> </Buffer> <Filter class="Formula"> <O>or<O/> <a>DI_f0_0_0_buf<a/> <a>DI_f0_0_1_buf<a/> <Filter class="Change"> <Filter class="UpdateValue"> <Target ref="DI_f0_value"/> <Filter class="AddToBuffer" /> </Filter> </Filter> </Filter> </Formula>
DI_f0_0_0_buf and DI_f0_0_1_buf are inputs to formula.
Attribute: type
This defines the result type of formula. Possible choices DI, AI, CN
Element: Interfaces
Network setup
Has at least one Interface element.
<Interface name="eth0"> <IpAddress>192.168.0.111</IpAddress> <Netmask>255.255.255.0</Netmask> <Gateway>192.168.0.1</Gateway> </Interface>
VLAN
Example with required elements.
<Vlan interface="eth0"> <VlanId>10</VlanId> <VlanIngressQos>4</VlanIngressQos> <VlanEgressQos>4</VlanEgressQos> <IpIngressQos>0</IpIngressQos> <IpEgressQos>0</IpEgressQos> </Vlan>
Example with additional elements from Interface
<Vlan interface="eth0"> <VlanId>131</VlanId> <VlanIngressQos>4</VlanIngressQos> <VlanEgressQos>4</VlanEgressQos> <IpIngressQos>0</IpIngressQos> <IpEgressQos>0</IpEgressQos> <IpAddress>172.18.0.11</IpAddress> <Netmask>255.255.255.0</Netmask> <Gateway>172.18.0.254</Gateway> </Vlan>