This OPC UA Interface defines the basis of an IETF network interface. The IIetfBaseNetworkInterfaceType is formally defined in Table 1.

Table 1 – IIetfBaseNetworkInterfaceType definition

Attribute

Value

BrowseName

IIetfBaseNetworkInterfaceType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

AdminStatus

InterfaceAdminStatus

BaseDataVariableType

Mandatory

HasComponent

Variable

OperStatus

InterfaceOperStatus

BaseDataVariableType

Mandatory

HasComponent

Variable

PhysAddress

String

BaseDataVariableType

Optional

HasComponent

Variable

Speed

UInt64

AnalogUnitType

Mandatory

Conformance Units

BNM Ethernet Base Info

AdminStatus of DataType InterfaceAdminStatus specifies the desired state of the network interface. This Variable has the same read semantics as ifAdminStatus (ifAdminStatus is defined in IETF RFC 2863). The InterfaceAdminStatus Enumeration is defined in 5.3.1.2.

OperStatus of DataType InterfaceOperStatus specifies the current operational state of the network interface. This Variable has the same semantics as ifOperStatus (ifOperStatus is defined in IETF RFC 2863). The InterfaceOperStatus Enumeration is defined in 5.3.1.3.

PhysAddress of DataType String specifies the network interface's address at its protocol sub-layer. For example, for an 802.x network interface, this parameter normally contains a Media Access Control (MAC) address. The network interface's media-specific modules must define the bit and byte ordering and the format of the value of this object. For network interfaces that do not have such an address (e.g., a serial line), this node is not present (ifPhysAddress is defined in IETF RFC 2863).

Speed of DataType UInt64 specifies an estimate of the network interface's current bandwidth in bits per second. For network interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this value should contain the nominal bandwidth (ifSpeed and ifHighSpeed are defined in IETF RFC 2863).

The component Variables of the IIetfBaseNetworkInterfaceType have the Attribute values defined in Table 2.

Table 2 – IIetfBaseNetworkInterfaceType Attribute values for child Nodes

Source Path

Value Attribute

Description Attribute

Speed

EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4337968DisplayName: bit/sDescription: bit per second

-

This OPC UA Interface defines capabilities of an Ethernet-based port. The IIeeeBaseEthernetPortType is formally defined in Table 3.

Table 3 – IIeeeBaseEthernetPortType definition

Attribute

Value

BrowseName

IIeeeBaseEthernetPortType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Modelling Rule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

Speed

UInt64

AnalogUnitType

Mandatory

HasComponent

Variable

Duplex

Duplex

BaseDataVariableType

Mandatory

HasComponent

Variable

MaxFrameLength

UInt16

BaseDataVariableType

Mandatory

Conformance Units

BNM Ethernet Base Info

Speed of DataType UInt64 specifies the configured, negotiated, or actual speed of an Ethernet port in entities of 1 Mb/s (data rate). The default value is implementation-dependent (Ethernet ports are defined in IEEE 802.3-2022).

Duplex of DataType Duplex represents the configured, negotiated, or actual duplex mode of an Ethernet port (aDuplexStatus is defined in IEEE 802.3-2022, clause 30.3.1.1.32, aDuplexStatus). The Duplex DataType is defined in 5.3.1.1.

MaxFrameLength of DataType UInt16 indicates the MAC frame length (including FCS bytes) at which frames are dropped for being too long (aMaxFrameLength is defined in IEEE 802.3-2022, clause 30.3.1.1.37, aMaxFrameLength).

The component Variables of the IIeeeBaseEthernetPortType have the Attribute values defined in Table 4.

Table 4 – IIeeeBaseEthernetPortType Attribute values for child Nodes

Source Path

Value Attribute

Description Attribute

Speed

EngineeringUnits

NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact

UnitId: 4534832DisplayName: Mbit/sDescription: megabit per second

-

This OPC UA Interface defines the auto negotiation status of an Ethernet-based port. The IIeeeAutoNegotiationStatusType is formally defined in Table 5.

Table 5 – IIeeeAutoNegotiationStatusType definition

Attribute

Value

BrowseName

IIeeeAutoNegotiationStatusType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Modelling Rule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

NegotiationStatus

NegotiationStatus

BaseDataVariableType

Mandatory

Conformance Units

BNM AutoNeg

NegotiationStatus of DataType NegotiationStatus specifies the status of the auto-negotiation protocol (aAutoNegAutoConfig is defined in IEEE 802.3-2022, clause 30.6.1.1.4, aAutoNegAutoConfig). The NegotiationStatus DataType is defined in 5.3.1.4.

This OPC UA Interface defines if an Ethernet-based port is VLAN Tag capable. The IBaseEthernetCapabilitiesType is formally defined in Table 6.

Table 6 – IBaseEthernetCapabilitiesType definition

Attribute

Value

BrowseName

IBaseEthernetCapabilitiesType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Modelling Rule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

VlanTagCapable

Boolean

BaseDataVariableType

Mandatory

Conformance Units

BNM VLAN Capabilities

When VlanTagCapable is true, the network interface supports the ability to tag/untag frames using a Customer VLAN Tag (C-TAG of clause 9) provided by the network (VLAN Tags are defined in IEEE 802.1Qcc-2018, clause 46.2.3.7.1).

This OPC UA Interface specifies a VLAN Id to be associated with a network interface. The IVlanIdType is formally defined in Table 7.

Table 7 – IVlanIdType definition

Attribute 

Value 

BrowseName 

IVlanIdType 

IsAbstract 

True 

References 

NodeClass 

BrowseName  

DataType 

TypeDefinition 

Modelling Rule 

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent 

Variable 

VlanId 

UInt16 

BaseDataVariableType 

Mandatory 

Conformance Units

BNM IETF Interface Vlan Info

VlanId is an UInt16 and contains the Customer VLAN Tag (IEEE 802.1Q-2018 C-TAG of clause 9) that frames injected at this network interface will be tagged with (VlanId is defined in IEEE 802.1Qcc-2018 clause 46.2.3.7.1). 

This OPC UA Interface defines the content of an SrClass. The ISrClassType is formally defined in Table 8.

Table 8 – ISrClassType definition

Attribute

Value

BrowseName

ISrClassType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Modelling Rule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

Id

Byte

BaseDataVariableType

Mandatory

HasComponent

Variable

Priority

Byte

BaseDataVariableType

Mandatory

HasComponent

Variable

Vid

UInt16

BaseDataVariableType

Mandatory

Conformance Units

BNM TSN Base Info

Id is a Byte and specifies the SRclassID in a numeric representation of the SR classes which is supported by a particular Bridge Port (SRclassID is defined in IEEE 802.1Q-2018, clause 35.2.2.9.2, SRclassID). Only Values between 0 and 7 shall be used.

Priority is a Byte and holds the Data Frame Priority (item a in IEEE 802.1Q-2018 clause 35.2.2.8.5) value that will be used for streams that belong to the associated SR class. (SRclassPriority is defined in IEEE 802.1Q-2018, clause 35.2.2.9.3, SRclassPriority). Only Values between 0 and 7 shall be used.

Vid is an UInt16 and contains the SR_PVID (item i) in IEEE 802.1Q-2018 clause 35.2.1.4) that the associated streams will be tagged with by the Talker (SRclassVID is defined in IEEE 802.1Q-2018, clause 35.2.2.9.4, SRclassVID).

The IIeeeBaseTsnStreamType contains Variables which are common for both TSN talkers and TSN listeners. They represent the configuration properties and diagnostic values like reservation status and failure codes of a TSN stream. The IIeeeBaseTsnStreamType is formally defined Table 9.

Table 9 – IIeeeBaseTsnStreamType definition

Attribute

Value

BrowseName

IIeeeBaseTsnStreamType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

StreamId

Byte[8]

BaseDataVariableType

Mandatory

HasComponent

Variable

StreamName

String

BaseDataVariableType

Mandatory

HasComponent

Variable

State

TsnStreamState

BaseDataVariableType

Mandatory

HasComponent

Variable

AccumulatedLatency

UInt32

BaseDataVariableType

Optional

HasComponent

Variable

SrClassId

Byte

BaseDataVariableType

Optional

Conformance Units

BNM TSN Base Info

StreamId is an array of 8 Bytes defined according to the StreamID in IEEE 802.1Qcc-2018 clause 35.2.2.8.2. The StreamId shall be unique in the scope of the related TSN Network. The mapping between the StreamId Byte array and the IEEE octet string StreamID is as follows: Entry[n] of StreamId is mapped to octet[n] of StreamID. The StreamId shall be provided in the TSN stream Objects for diagnostic reasons.

Note: In the distributed configuration model the StreamId is typically generated by the TSN control stack of the endstation. In the fully centralized configuration model the StreamId is typically generated by the CUC.

StreamName is a String identifying the related stream in the network. The format of the String is application specific. The uniqueness of the StreamName inside the network segment shall be guaranteed by the application. If multiple applications use the network segment, they need to agree on a naming scheme.

State represents the current state of the TSN configuration process of a TSN stream. The TsnStreamState Enumeration is defined in 5.3.1.6.

AccumulatedLatency of DataType UInt32 is the maximum worst case propagation delay in nanoseconds calculated and guaranteed by the TSN Control Layer for this Listener. Once the stream reservation has succeeded the AccumulatedLatency is not expected to increase during the lifecycle of the TSN Stream (AccumulatedLatency is defined in IEEE 802.1Q-2018 clause 35.2.2.8.6).

SrClassId of DataType Byte contains the Stream Reservation Class that is used for this stream (as defined in IEEE 802.1Qcc-2018 clause 35.2.2.9.2).

This OPC UA Interface is used to represent the traffic specification of a TSN stream. The IIeeeBaseTsnTrafficSpecificationType is formally defined in Table 10.

Table 10 – IIeeeBaseTsnTrafficSpecificationType definition

Attribute

Value

BrowseName

IIeeeBaseTsnTrafficSpecificationType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Modelling Rule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

MaxIntervalFrames

UInt16

BaseDataVariableType

Mandatory

HasComponent

Variable

MaxFrameSize

UInt32

BaseDataVariableType

Mandatory

HasComponent

Variable

Interval

UnsignedRationalNumber

BaseDataVariableType

Mandatory

Conformance Units

BNM TSN Config

The MaxFrameSize of DataType UInt16 specifies the maximum size frame that will be sent by a Talker for this Stream (as defined in IEEE 802.1Q-2018 clause 35.2.2.8.4a).

Note: According to 802.1Q MaxFrameSize only counts the number of bytes of the Ethernet payload without the media specific framing bytes. (i.e. without 8-byte preamble, 14-byte IEEE 802.3 header, 4-byte IEEE 802.1Q priority/VID Tag, 4-byte CRC, 12-byte inter frame gap). Same rules apply for counting MaxBytesPerInterval.

The MaxIntervalFrames of DataType UInt16 Variable specifies the maximum number of frames that will be sent during an Interval. (as defined in IEEE 802.1Q-2018, clause 35.2.2.8.4b, “MaxIntervalFrames” or IEEE 802.1Qcc-2018, clause 35.2.2.10.6, “MaxFramesPerInterval”)

Interval of DataType UnsignedRationalNumber defines the time period of the TSN Stream in nanoseconds. In that interval a specified number of frames (MaxIntervalFrames) with a maximum payload size per frame (MaxFrameSize) and a maximum total number of bytes (MaxBytesPerInterval) will be transmitted. The Interval therefore shall either represent the “class measurement interval” as used for AVB based Streams (as defined in IEEE 802.1Q-2018 clause 35 or the “Interval” parameter used in the TrafficSpecification group in IEEE 802.1Qcc-2018 clause 46.2.3.5.1).

This OPC UA Interface is used to represent the status of a TSN stream. The IIeeeBaseTsnStatusStreamType is formally defined in Table 11.

Table 11 – IIeeeBaseTsnStatusStreamType definition

Attribute

Value

BrowseName

IIeeeBaseTsnStatusStreamType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

TalkerStatus

TsnTalkerStatus

BaseDataVariableType

Optional

HasComponent

Variable

ListenerStatus

TsnListenerStatus

BaseDataVariableType

Optional

HasComponent

Variable

FailureCode

TsnFailureCode

BaseDataVariableType

Mandatory

HasComponent

Variable

FailureSystemIdentifier

Byte[][8]

BaseDataVariableType

Mandatory

Conformance Units

BNM TSN Base Info

TalkerStatus of DataType TsnTalkerStatus contains the Reservation Failure Code as defined in the “FailureInformation” in IEEE 802.1Qcc-2018 clause 46.2.5.1.1.

ListenerStatus of DataType TsnListenerStatus contains the Reservation Failure Code as defined in the “FailureInformation” in IEEE 802.1Qcc-2018 clause 46.2.5.1.2.

FailureCode of DataType TsnFailureCode contains the Reservation Failure Code as defined in the “FailureInformation” in IEEE 802.1Qcc-2018 clause 46.2.5.1.3.

FailureSystemIdentifier is an Array of Arrays of 8 Bytes and contains the System Identifiers representing the network nodes where the failure occurred (as defined in “System Identifier” in “FailureInformation” in IEEE 802.1Q-2018 clause 35.2.2.8.7).

This OPC UA Interface is used to represent an interface configuration which is part of a TSN stream (on the end-device). The IIeeeTsnInterfaceConfigurationType is formally defined in Table 12.

Table 12 – IIeeeTsnInterfaceConfigurationType definition

Attribute

Value

BrowseName

IIeeeTsnInterfaceConfigurationType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

MacAddress

String

BaseDataVariableType

Mandatory

HasComponent

Variable

InterfaceName

String

BaseDataVariableType

Optional

Conformance Units

BNM TSN Config

MacAddress of DataType String contains the MAC Address of the Interface the configuration will be applied to, as defined in IEEE 802.1Qcc-2018, clause 46.2.5.3.

InterfaceName of DataType String is optional and supports the identification of the Interface to be configured, as defined in IEEE 802.1Qcc-2018, clause 46.2.5.3.

This OPC UA Interface is used to represent a talker (sender) interface configuration of a TSN stream. The IIeeeTsnInterfaceConfigurationTalkerType is formally defined in Table 13.

Table 13 – IIeeeTsnInterfaceConfigurationTalkerType definition

Attribute

Value

BrowseName

IIeeeTsnInterfaceConfigurationTalkerType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the IIeeeTsnInterfaceConfigurationType defined in 5.2.10

HasComponent

Variable

TimeAwareOffset

UInt32

BaseDataVariableType

Optional

Conformance Units

BNM TSN Config

TimeAwareOffset of DataType UInt32 specifies the time offset in nanoseconds relative to the start of the Interval that the Talker shall use for transmission (as defined in IEEE 802.1Qcc-2018 clause 46.2.5.3.5).

This OPC UA Interface is used to represent a listener (receiver) interface configuration of a TSN stream. The IIeeeTsnInterfaceConfigurationListenerType is formally defined in Table 14.

Table 14 – IIeeeTsnInterfaceConfigurationListenerType definition

Attribute

Value

BrowseName

IIeeeTsnInterfaceConfigurationListenerType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the IIeeeTsnInterfaceConfigurationType defined in 5.2.10

HasComponent

Variable

ReceiveOffset

UInt32

BaseDataVariableType

Optional

Conformance Units

BNM TSN Config

ReceiveOffset of DataType UInt32 specifies the offset in nanoseconds within the Interval at which the Listener will receive the first frame of the TSN Stream.

This OPC UA Interface is used to represent a MAC address based stream identification of a TSN stream. The IIeeeTsnMacAddressType is formally defined in Table 15.

Table 15 – IIeeeTsnMacAddressType definition

Attribute

Value

BrowseName

IIeeeTsnMacAddressType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

DestinationAddress

Byte[6]

BaseDataVariableType

Mandatory

HasComponent

Variable

SourceAddress

Byte[6]

BaseDataVariableType

Optional

Conformance Units

BNM TSN Config

DestinationAddress is defined according to the destination_mac_address in IEEE 802.1Qcc-2018 clause 46.2.3.4.1, which represents the destination MAC address in the Ethernet header of the streamed data packets. Entry[n] of DestinationAddress is mapped to octet[n] of destination_mac_address.

SourceAddress is defined according to the source_mac_address in IEEE 802.1Qcc-2018 clause 46.2.3.4.1, which represents the source MAC address in the Ethernet header of the streamed data packets. Entry[n] of SourceAddress is mapped to octet[n] of source_mac_address.

This OPC UA Interface is used to represent the VLAN configuration of a TSN stream. The IIeeeTsnVlanTagType is formally defined in Table 16.

Table 16 – IIeeeTsnVlanTagType definition

Attribute

Value

BrowseName

IIeeeTsnVlanTagType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

VlanId

UInt16

BaseDataVariableType

Mandatory

HasComponent

Variable

PriorityCodePoint

Byte

BaseDataVariableType

Mandatory

Conformance Units

BNM TSN Config

VlanId of DataType UInt16 defines the 12-Bit VLAN-Identifier of the VLAN tag in the Ethernet header for the related stream. Only values between 0 and 4095 shall be used according to IEEE 802.1Q-2018 Table 9-2.

PriorityCodePoint of DataType Byte defines the 3 Bit priority code point inside the VLAN tag of the Ethernet header of the related stream. Only values between 0 and 7 are supported as defined by IEEE 802.1Q-2018, clause 35.2.2.8.5a, Data Frame Priority.

This OPC UA Interface is used to translate a priority label like PriorityLabel (defined in Part 14) to a concrete network priority value (e.g. DSCP or PCP).

Note: This UA Interface is typically used to form a mapping rule table containing a set of object entities implementing the IPriorityMappingEntryType. Each network interface supporting priority mapping can reference such a mapping table Object.

Table 17 – IPriorityMappingEntryType definition

Attribute

Value

BrowseName

IPriorityMappingEntryType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseInterfaceType defined in OPC 10000-5

HasComponent

Variable

MappingUri

String

BaseDataVariableType

Mandatory

HasComponent

Variable

PriorityLabel

String

BaseDataVariableType

Mandatory

HasComponent

Variable

PriorityValue_PCP

Byte

BaseDataVariableType

Optional

HasComponent

Variable

PriorityValue_DSCP

UInt32

BaseDataVariableType

Optional

Conformance Units

BNM Priority Mapping

MappingUri of DataType String specifies a named identifier of a well-known predefined set of priority labels.

PriorityLabel of DataType String is a textual representation of the desired transport priority configured within the QoS settings of a communication relation, e.g. WriterGroup defined in Part14.

PriorityValue_PCP of DataType Byte is the Ethernet transport priority inside the VLAN-Tag associated with the PriorityLabel. The devices shall translate the defined priority label for each packet according to the communication relation (e.g. WriterGroup) and linked interface. Depending on the transport protocol mapping and if this Variable is supported, the PCP field inside a packet shall be set to the specified PCP value.

PriorityValue_DSCP of DataType UInt32 is the IP transport priority associated with the PriorityLabel. The devices shall translate the defined priority label for each packet according to the communication relation (e.g. WriterGroup) and linked interface. Depending on the transport protocol mapping and if this Variable is supported, the DSCP field inside a packet shall be set to the specified DSCP value.