WeOS
5.29.0

# “Custom telegram” data items list

Note

While all data items are available in all operational modes, some data items are only active (meaning that the relevant input data is processed, and the output data is populated) in certain modes.

## Direction incoming

### Input data-items active in all operational modes

#### lifesign8

- Size: 8 bits
- Format: unsigned integer
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation: Lifesign = 0
- Conditional check:
  Life-sign changed (differs from the previously received telegram)

#### lifesign16

- Size: 16 bits
- Format: unsigned integer in big endian format
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation: Lifesign = 0
- Conditional check:
  Life-sign changed (differs from the previously received telegram)

#### lifesign32

- Size: 32 bits
- Format: unsigned integer in big endian format
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation: Lifesign = 0
- Conditional check:
  Life-sign changed (differs from the previously received telegram)

#### crc32-fcs

- Size: 32 bits
- Format: unsigned integer in little endian format (IEC 61375-2-3 appendix A.3)
- Arguments: start:integer, length:integer
- Validation: Number of arguments == 2; 1st argument is an integer; 2nd argument is an integer
- Initialisation:
  Start = 1st argument
  Length = 2nd argument
- Conditional check:
  Checksum match the TRDP FCS CRC (CRC32 according to IEEE802.3) calculated over the configured section of the incoming dataset (Start, Length)

#### syncDateTime-C

- Size: 48 bits
- Format: Array of 6 unsigned 8-bits integers
- Coding:
  Byte 0: Year- 2000 [0-255] (0 = 2000)
  Byte 1: Month [1-12] (1 = January)
  Byte 2: Day of month [1-31]
  Byte 3: Hour [0-23]
  Byte 4: Minute [0-59]
  Byte 5: Second [0-59]
- Arguments: None
- Validation: Number of arguments == 0
- Action:
  If the input date/time is valid (within the ranges specified in the coding) and deviates more than 3 seconds to the system time then set the Real-Time Clock to the input date/time.

#### bypassCtrl

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = No action (keep old state)
  1 = Disable bypass relays (Connect ETB switch to ETB lines)
  2 = Enable bypass relays (Decouple ETB switch from ETB lines)
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation: OldCmd = 0
- Action:
  NewCmd = value of data-field
  If NewCmd != OldCmd and NewCmd is 1 or 2 then request control of bypass relays according to NewCmd
  If NewCmd is 0, 1 or 2 then OldCmd = NewCmd

### Input data-items active in ‘full’ operational mode

These data-items are available in all operational modes, but input data is only processed in ‘full’ operational mode (in all other modes the input data is ignored and no actions are performed).

#### etbInhibitCtrl

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = No action (keep old state)
  1 = No inhibit request
  2 = Inhibit request
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation: OldCmd = 0
- Action:
  NewCmd = value of data-field
  If NewCmd != OldCmd and NewCmd is 1 or 2 then request control of bypass relays according to NewCmd
  If NewCmd is 0, 1 or 2 then OldCmd = NewCmd

## Direction outgoing

### Output data-items active in all operational modes

#### lifesign8

- Size: 8 bits
- Format: unsigned integer
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation: Lifesign = 0
- Prepare:
  Increase lifesign by 1
  Data = Lifesign

#### lifesign16

- Size: 16 bits
- Format: unsigned integer in big endian format
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation: Lifesign = 0
- Prepare:
  Increase lifesign by 1
  Data = Lifesign

#### lifesign32

- Size: 32 bits
- Format: unsigned integer in big endian format
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation: Lifesign = 0
- Prepare:
  Increase lifesign by 1
  Data = Lifesign

#### value1

- Size: 1 bit
- Format: unsigned integer
- Arguments: value:integer
- Validation: Number of arguments == 1; 1st argument is an integer [0, 1]
- Initialisation: Value = 1st argument
- Prepare: Data = Value

#### value2

- Size: 2 bits
- Format: unsigned integer
- Arguments: value:integer
- Validation: Number of arguments == 1; 1st argument is an integer [0, 3]
- Initialisation: Value = 1st argument
- Prepare: Data = Value

#### value4

- Size: 4 bits
- Format: unsigned integer
- Arguments: value:integer
- Validation: Number of arguments == 1; 1st argument is an integer [0, 15]
- Initialisation: Value = 1st argument
- Prepare: Data = Value

#### value8

- Size: 8 bits
- Format: unsigned integer
- Arguments: value:integer
- Validation: Number of arguments == 1; 1st argument is an integer [0, 255]
- Initialisation: Value = 1st argument
- Prepare: Data = Value

#### value16

- Size: 16 bits
- Format: unsigned integer in big endian format
- Arguments: value:integer
- Validation: Number of arguments == 1; 1st argument is an integer [0, 65535]
- Initialisation: Value = 1st argument
- Prepare: Data = Value

#### value32

- Size: 32 bits
- Format: unsigned integer in big endian format
- Arguments: value:integer
- Validation: Number of arguments == 1; 1st argument is an integer [0, 4294967295]
- Initialisation: Value = 1st argument
- Prepare: Data = Value

#### crc32-fcs

- Size: 32 bits
- Format: unsigned integer in little endian format (IEC 61375-2-3 appendix A.3)
- Arguments: start:integer, length:integer
- Validation: Number of arguments == 2; 1st argument is an integer; 2nd argument is an integer
- Initialisation:
  Start = 1st argument
  Length = 2nd argument
- Prepare:
  Data = TRDP FCS CRC (CRC32 according to IEEE802.3) calculated over the configured section of the outgoing dataset (Start, Length)

#### firmwareVersion

- Size: 32 bits
- Format: Array of 4 unsigned 8-bits integers
- Coding:
  Version is encoded as 4 unsigned integers [0, 255]: A.B.C.D
  Byte 0: A
  Byte 1: B
  Byte 2: C
  Byte 3: D
- Arguments: None
- Validation: Number of arguments == 0
- Initialisation:
  Version = Value of DISTRIB_RELEASE in /etc/lsb-release
- Prepare: Data = Version

#### cpuLoad

- Size: 8 bits
- Format: unsigned integer
- Coding: 1 = 1%
- Arguments: None
- Validation: Number of arguments == 0
- Prepare: Data = System load

#### devTemp-C

- Size: 8 bits
- Format: signed integer
- Coding:
  0: Temperature is unknown/invalid 0..127: Temperature 0 to 127 degree Celsius 128..255: Temperature -1 to -128 degree Celsius
- Arguments: None
- Validation: Number of arguments == 0
- Prepare: Data = Device temperature

#### oprTime

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 second
- Arguments: None
- Validation: Number of arguments == 0
- Prepare: Data = System uptime

#### oprTime-C

- Size: 16 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 0.1 hour
- Arguments: None
- Validation: Number of arguments == 0
- Prepare: Data = System uptime

#### dateTime

- Size: 48 bits
- Format: Array of 6 unsigned 8-bits integers
- Coding:
  Byte 0: Year- 1900 [0-255] (0 = 1900)
  Byte 1: Month [0-11] (0 = January)
  Byte 2: Day of month [1-31]
  Byte 3: Hour [0-23]
  Byte 4: Minute [0-59]
  Byte 5: Second [0-59]
- Arguments: None
- Validation: Number of arguments == 0
- Prepare: Data = Real-Time Clock time

#### dateTime-C

- Size: 48 bits
- Format: Array of 6 unsigned 8-bits integers
- Coding:
  Byte 0: Year- 2000 [0-255] (0 = 2000)
  Byte 1: Month [1-12] (1 = January)
  Byte 2: Day of month [1-31]
  Byte 3: Hour [0-23]
  Byte 4: Minute [0-59]
  Byte 5: Second [0-59]
- Arguments: None
- Validation: Number of arguments == 0
- Prepare: Data = Real-Time Clock time

#### portEnabled

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = Disabled
  1 = Enabled
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Enable state of configured port

#### portLinkState

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = Down
  1 = Up
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Link state of configured port

#### portAutoNeg

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = Disabled
  1 = Enabled
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Auto negotiation state of configured port

#### portMdixSetting

- Size: 2 bits
- Format: unsigned integer
- Coding:
  0 = Invalid, N/A
  1 = Normal (mdi)
  2 = Crossover (mdi-x)
  3 = Auto
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = MDI-X setting of configured port

#### portMdixStatus

- Size: 2 bits
- Format: unsigned integer
- Coding:
  0 = Invalid, N/A
  1 = Normal (mdi)
  2 = Crossover (mdi-x)
  3 = Auto
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = MDI-X status of configured port

#### portMdixStatus-C

- Size: 2 bits
- Format: unsigned integer
- Coding:
  0 = Crossover (mdi-x)
  1 = Normal (mdi)
  2 = Auto
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = MDI-X status of configured port

#### portAggregated

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = Port not assigned to aggregate
  1 = Port assigned to aggregate
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Enable state of configured port

#### portRxError

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of error packets inbound of configured port

#### portTxError

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of error packets outbound of configured port

#### ringStatus-C

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Ring disabled
  1 = Ring master node
  2 = Ring slave node
  3 = Ring broken
  4 = Other states
- Arguments: ring identity:integer
- Validation: Number of arguments == 1; 1st argument is an integer
- Initialisation: FRNTv2 ring identity = 1st argument
- Prepare: Data = Status of configured FRNTv2 ring

#### ringPortStatus-C

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Unknown
  1 = Disabled
  2 = Blocking
  3 = Listening
  4 = Learning
  5 = Forwarding
- Arguments: ring identity:integer, ring port index:integer
- Validation: Number of arguments == 2; 1st argument is an integer; 2nd argument is an integer [1, 2]
- Initialisation:
  FRNTv2 ring identity = 1st argument
  Ring port index = 2nd argument
- Prepare: Data = Status of configured ring port

#### ringPortNumber-C

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Ring port unknown (not in list of port names)
  1..N = Ring port equals the Nth port in the list of port names
- Arguments: ring identity:integer, ring port index:integer, [port name: string, … , port name:string]
- Validation: Number of arguments >= 2; 1st argument is an integer; 2nd argument is an integer [1, 2]; 3rd to Nth argument are strings
- Initialisation:
  FRNTv2 ring identity = 1st argument
  Ring port index = 2nd argument
  Port name 1 = 3rd argument
  Port name 2 = 4th argument
  Port name 3 = 5th argument
  :
- Prepare: Data = Number of port (1..N) that match the name of the configured ring port (or 0 if there is no match)

#### igmpEnabled

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Disabled
  1 = Enabled
- Arguments: None
- Validation: Number of arguments == 0
- Prepare: Data = IGMP snooping is allowed and enabled on at least one vlan

#### numberOfPorts

- Size: 8 bits
- Format: unsigned integer
- Arguments: None
- Validation: Number of arguments == 0
- Prepare: Data = Number of configured ports

#### portMulticastAware

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = No VLAN assigned to the port has multicast snooping enabled
  1 = At least one VLAN assigned to the port has multicast snooping enabled
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Prepare: Data = Port is assigned to at least one VLAN with multicast snooping enabled

#### portFlooding

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = Disabled (unknown multicasts are blocked)
  1 = Enabled (unknown multicasts from other ports in the same vlan is flooded on this port)
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Prepare: Data = Flooding of unknown multicast

#### portVlanAllTagged-C

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = This port has an untagged vlan (or it is not in any vlan)
  1 = All vlans on port is tagged
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Prepare: Data = Port is tagged on all vlans it is assigned to

#### portVlanId-C

- Size: 16 bits
- Format: unsigned integer in big endian format
- Coding:
  If the port has an untagged vlan the identity of that vlan is given as vlan number 1 and the identities of its tagged vlans are given (in ascending identity order) as vlan number 2 and upward
  If the port has no untagged vlan the identities of its tagged vlans are given (in ascending identity order) as vlan number 1 and upward
- Arguments: port name:string, vlan number:string
- Initialisation:
  Port name = 1st argument
  Vlan number = 2nd argument
- Validation: Number of arguments == 2; 1st argument is a string; 2nd argument is an integer
- Prepare: Data = Identity of the requested vlan (see coding)

#### portModule-C

- Size: 8 bits
- Format: unsigned integer in big endian format
- Coding:
  0 = Invalid
  1 = 1000M, full duplex
  2 = 1000M, half duplex
  3 = 100M, full duplex
  4 = 100M, half duplex
  5 = 10M, full duplex
  6 = 10M, half duplex
  7 = Adaptive
  8 = Disabled
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Speed and Duplex mode of configured port

#### portRx

- Size: 64 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of packets received on configured port

#### portTx

- Size: 64 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of packets transmitted from configured port

#### portRxFiltered

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of filtered packets inbound on configured port

#### portTxFiltered

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of filtered packets outbound on configured port

#### portRxDropped

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of inbound packets dropped

#### portRxCollisions

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of inbound packets collisions

#### portTxCollisions

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of outbound packets collisions

#### portSpeedMode

- Size: 4 bits
- Format: unsigned integer
- Coding:
  0 = Invalid or N/A
  1 = 10Mbit/s
  2 = 100Mbit/s
  3 = 1000Mbit/s
  15 = Unknown
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Speed of configured port

#### portSpeedMode-C

- Size: 4 bits
- Format: unsigned integer
- Coding:
  0 = 10Mbit/s (Invalid, Unknown or N/A)
  1 = 100Mbit/s
  2 = 1000Mbit/s
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Speed of configured port

#### portDuplexMode

- Size: 4 bits
- Format: unsigned integer
- Coding:
  0 = Half duplex (invalid or N/A)
  1 = Full duplex
  15 = Unknown
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Duplex mode of configured port

#### portDuplexMode-C

- Size: 4 bits
- Format: unsigned integer
- Coding:
  0 = Half duplex (invalid, unknown or N/A)
  1 = Full duplex
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Duplex mode of configured port

#### portRxLimit

- Size: 16 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 256kbit/s
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Rate limit / Ingress bandwidth limit on configured port

#### portRxLimitBcast

- Size: 16 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 256kbit/s
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Rate limit / Ingress bandwidth limit for broadcast on configured port

#### portTxLimit

- Size: 16 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 256kbit/s
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Traffic shaping / Outbound bandwidth limit on configured port

#### portDefaultVid

- Size: 16 bits
- Format: unsigned integer in big endian format
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Default vlan identity of configured port

#### portPriority

- Size: 8 bits
- Format: unsigned integer
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Priority of configured port

#### portRxMcast

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of multicast packets received by configured port

#### portTxMcast

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of multicast packets transmitted by configured port

#### portRxBcast

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of broadcast packets received by configured port

#### portTxBcast

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of broadcast packets transmitted by configured port

#### portRxUcast

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of unicast packets received by configured port

#### portTxUcast

- Size: 32 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1 packet
- Arguments: port name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Port name = 1st argument
- Prepare: Data = Number of unicast packets transmitted by configured port

#### vlanIdentity

- Size: 16 bits
- Format: unsigned integer in big endian format
- Arguments: vlan name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Vlan name = 1st argument
- Prepare: Data = Identity of configured vlan

#### vlanAgingTime

- Size: 16 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1s
- Arguments: vlan name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Vlan name = 1st argument
- Prepare: Data = Aging time of configured vlan

#### vlanMcastSnooping

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Disabled for vlan, Disabled globally
  1 = Disabled for vlan, Enabled globally
  2 = Enabled for vlan, Disabled globally
  3 = Enabled for vlan, Enabled globally
- Arguments: vlan name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Vlan name = 1st argument
- Prepare: Data = Status of multicast snooping of configured vlan

#### vlanQueryEnabled

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Disabled
  1 = Enabled
- Arguments: vlan name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Vlan name = 1st argument
- Prepare: Data = Status of multicast querier of configured vlan

#### vlanQueryInterval

- Size: 16 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1s
- Arguments: vlan name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Vlan name = 1st argument
- Prepare: Data = Multicast querier interval of configured vlan

#### vlanRouterTimeout

- Size: 16 bits
- Format: unsigned integer in big endian format
- Coding: 1 = 1s
- Arguments: vlan name:string
- Validation: Number of arguments == 1; 1st argument is a string
- Initialisation: Vlan name = 1st argument
- Prepare: Data = Router timeout

#### vlanPortTagged

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = Port not tagged on vlan
  1 = Port tagged on vlan
- Arguments: vlan name:string, port name:string
- Validation: Number of arguments == 2; 1st argument is a string; ; 2nd argument is a string
- Initialisation:
  Vlan name = 1st argument
  Port name = 2nd argument
- Prepare: Data = Port tagged on vlan

#### vlanPortUntagged

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = Port not untagged on vlan
  1 = Port untagged on vlan
- Arguments: vlan name:string, port name:string
- Validation: Number of arguments == 2; 1st argument is a string; ; 2nd argument is a string
- Initialisation:
  Vlan name = 1st argument
  Port name = 2nd argument
- Prepare: Data = Port untagged on vlan

#### vlanPortMember

- Size: 1 bit
- Format: unsigned integer
- Coding:
  0 = Port neither tagged nor untagged on vlan
  1 = Port tagged or untagged on vlan
- Arguments: vlan name:string, port name:string
- Validation: Number of arguments == 2; 1st argument is a string; 2nd argument is a string
- Initialisation:
  Vlan name = 1st argument
  Port name = 2nd argument
- Prepare: Data = Port tagged or untagged on vlan

#### bypassState

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Bypass disabled (ETB switch connected to ETB lines)
  1 = Bypass enabled (ETB switch decoupled from ETB lines)
- Arguments: None
- Prepare: Data = State of bypass function

### Output data-items active in ‘etbn’ and ‘full’ operational mode

These data-items are available in all operational modes but output data is only prepared in ‘etbn’ and ‘full’ operational mode (in all other operational modes the output data is set to zero).

#### etbnState

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = ETBN not operational
  1 = ETBN in operation
- Arguments: None
- Prepare: Data = ETBN operational state

#### etbnInaugState

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Init
  1 = Not inaugurated
  2 = Inaugurated
  3 = Ready for inauguration
- Arguments: None
- Prepare: Data = ETBN inauguration state

#### etbnPosition

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Unknown
  1 = Single node
  2 = Middle node
  3 = End node in TCN direction 1
  4 = End node in TCN direction 2
- Arguments: None
- Prepare: Data = Position of the ETBN

#### etbnRole

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Undefined
  1 = Master
  2 = Backup
  3 = Not redundant
- Arguments: None
- Prepare: Data = ETBN node role

#### etbLineState

- Size: 8 bits
- Format: unsigned integer
- Coding:
  Bit 0: Line A, ETBN direction 1 (0 = Not trusted, 1 = Trusted)
  Bit 1: Line B, ETBN direction 1
  Bit 2: Line C, ETBN direction 1
  Bit 3: Line D, ETBN direction 1
  Bit 4: Line A, ETBN direction 2
  Bit 5: Line B, ETBN direction 2
  Bit 6: Line C, ETBN direction 2
  Bit 7: Line D, ETBN direction 2
- Arguments: None
- Prepare: Data = Indication of ETB line status

#### etbTopoCnt

- Size: 32 bits
- Format: unsigned integer in big endian format
- Arguments: None
- Prepare: Data = ETB topography counter

#### etbInhibit

- Size: 8 bits
- Format: unsigned integer
- Coding:
  1 = Inhibit not requested on ETB
  2 = Inhibit set on local ETBN
  3 = Inhibit set on remote ETBN
  4 = Inhibit set on local and remote ETBN
- Arguments: None
- Prepare: Data = Inauguration inhibit indication

### Output data-items active in ‘full’ operational mode

These data-items are available in all operational modes but output data is only prepared in ‘full’ operational mode (in all other operational modes the output data is set to zero).

#### cstCnt

- Size: 8 bits
- Format: unsigned integer
- Coding: Number of consists in train [1, 63]
- Arguments: None
- Prepare: Data = Number of consists in train

#### cstOrient

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Unknown
  1 = Direct (same as train reference direction)
  2 = Inverse to train reference direction
- Arguments: None
- Prepare: Data = Consist orientation

#### etbLength

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Not lengthening
  1 = Lengthening detected
- Arguments: None
- Prepare: Data = Indication of train lengthening in case train inauguration is inhibited

#### etbShort

- Size: 8 bits
- Format: unsigned integer
- Coding:
  0 = Not shorting
  1 = Shorting detected
- Arguments: None
- Prepare: Data = Indication of train shortening in case train inauguration is inhibited

#### opTrnTopoCnt

- Size: 32 bits
- Format: unsigned integer in big endian format
- Arguments: None
- Prepare: Data = Operational train topography counter

#### ownTrnCstNo

- Size: 8 bits
- Format: unsigned integer
- Coding: Position of own consist in train [1, 63]
- Arguments: None
- Prepare: Data = Position of own consist in train

« Previous Next »