5.2.7 IIeeeBaseTsnStreamType Interface

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
BrowseNameIIeeeBaseTsnStreamType
IsAbstractTrue
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseInterfaceType defined in OPC 10000-5
HasComponentVariableStreamIdByte[8]BaseDataVariableTypeMandatory
HasComponentVariableStreamNameStringBaseDataVariableTypeMandatory
HasComponentVariableStateTsnStreamState BaseDataVariableTypeMandatory
HasComponentVariableAccumulatedLatencyUInt32BaseDataVariableTypeOptional
HasComponentVariableSrClassIdByteBaseDataVariableTypeOptional
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.

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).