Errata exists for this version of the document.
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 8.
Table 8 – 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 |
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 (see 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 (see IEEE 802.1Qcc-2018 clause 35.2.2.9.2).