HCDF Stream Profile 1.0 Specification Browser

Element Attribute Has children (click to expand) Leaf node Defined in another tab (click to switch)
  • name Attribute
    Type: xs:string (required) — Profile name identifying the operational mode. Example: "operational", "calibration", "safe-mode", "demo". Must be unique across all profiles referenced by the HCDF. Required.
  • version Attribute
    Type: xs:string (required) — Profile version using semantic versioning. Increment when streams are added, removed, or their QoS requirements change. The agent can detect version mismatches between the profile and the HCDF. Required.
  • hcdf-ref Attribute
    Type: xs:string — Reference to the HCDF file this profile is designed for. All talker/listener device/port references in the streams must exist in this HCDF. Example: "humanoid-mobile-base.hcdf". Optional but recommended — enables the agent to validate stream references at load time.
  • <description> Element
    Type: xs:string
    Human-readable description of this profile's purpose and operational scenario. Example: "Normal operational mode: 1kHz arm control, 30fps wrist cameras, base wheel control via 1722+CAN, lidar/radar perception pipeline."
  • <stream-group> Element
    [0..*]
    Grouped streams organized by functional subsystem. Recommended over ungrouped streams for clarity. Each group can reference the HCDF chain it traverses.
  • <stream> Element
    [0..*]
    Ungrouped streams at the profile root level. Use for streams that don't belong to a specific group or for simple profiles with few streams.
  • name Attribute
    Type: xs:string (required) — Unique name for this stream within the profile. Used by the agent to reference this stream in schedule computation and diagnostics. Example: "imu_1khz", "cam_left_30fps", "safety_heartbeat". Required.
  • talker Attribute
    Type: xs:string (required) — Source port reference in the format "device/port" or "device/port:switch_port". Must match a comp and port defined in the HCDF. The talker originates the stream's frames. Example: "optical-flow/ETH0", "s32n79/xfi_left". Required.
  • listener Attribute
    Type: xs:string (required) — Destination port reference in the format "device/port" or "device/port:switch_port". Must match a comp and port defined in the HCDF. The listener receives and consumes the stream's frames. Example: "s32n79/eth0:2", "agx-thor/mgbe0". Required.
  • vlan Attribute
    Type: xs:unsignedInt — IEEE 802.1Q VLAN ID (1-4094) for this stream. Streams on different VLANs are isolated at Layer 2. Typically all streams in the same functional domain share a VLAN: motion control on VLAN 10, camera on VLAN 20, safety on VLAN 1. Optional — if omitted, the stream uses the link/chain default VLAN.
  • pcp Attribute
    Type: xs:unsignedInt — IEEE 802.1Q Priority Code Point (0-7). Maps to a traffic class in the TSN domain's traffic-classes definition. Higher PCP = higher priority. Typical mapping: 7=PTP, 6=safety, 5=motion control, 4=sensor, 3=camera, 0=best-effort. The agent uses PCP to determine which Qbv gate window this stream's frames are transmitted in. Optional.
  • max-frame-size Attribute
    Type: xs:unsignedInt (required) — Maximum Ethernet frame size in bytes for this stream, excluding MACsec overhead (32 bytes) and Ethernet preamble/IFG. The agent adds MACsec overhead when computing serialization delay. Standard frames: up to 1500 bytes. Jumbo frames: up to 9000 bytes (for camera/lidar). Small control frames: 64-256 bytes. Required.
  • interval-us Attribute
    Type: xs:unsignedInt (required) — Transmission interval in microseconds — how often the talker sends one frame of this stream. Determines bandwidth: bandwidth = max-frame-size * 8 / interval-us (Mbps). Examples: 1000 us (1 kHz motor control), 33333 us (30 fps camera), 10000 us (100 Hz safety heartbeat). Required.
  • max-latency-us Attribute
    Type: xs:unsignedInt — Maximum acceptable end-to-end latency in microseconds from talker transmission to listener reception. The agent validates that the cumulative per-hop delay (serialization + switch processing + propagation) across the network path does not exceed this value. If it does, the schedule is infeasible. Examples: 200 us (motor control, 4 hops), 10000 us (camera, tolerant), 500 us (safety heartbeat). Optional — if omitted, no latency constraint (best-effort).
  • protocol Attribute
    Type: xs:string — Transport protocol when not raw Ethernet. "ieee-1722-acf-can": IEEE 1722 AVTP with ACF CAN encapsulation — CAN frames tunneled over Ethernet for remote CAN bus access (e.g., S32N79 sending motor commands to S32J100 which decapsulates to CAN-FD). "ieee-1722-coe": IEEE 1722 Camera over Ethernet. Omit for standard Ethernet frames (raw L2 or IP). Optional.
  • <description> Element
    Type: xs:string
    Human-readable description of this stream's purpose, data content, and timing requirements. Example: "IMU accel/gyro at 1kHz from optical-flow sensor to navigation filter on S32N79."
  • <frer> Element
    IEEE 802.1CB redundancy configuration for this stream. Only needed for safety-critical streams that require seamless failover on link failure. Omit for best-effort or non-critical streams.
  • name Attribute
    Type: xs:string (required) — Unique name for this stream group within the profile. Example: "left-arm-control", "perception-cameras", "safety". Required.
  • chain Attribute
    Type: xs:string — Name of the HCDF chain that all streams in this group traverse. References a chain defined in the HCDF's network element. When set, the agent knows the ordered hop sequence without tracing each stream individually. Example: "left-arm" references the 802.3dm chain from S32N79 through MCN1-MCN4. Optional — omit for streams that don't traverse a chain (e.g., point-to-point links).
  • <description> Element
    Type: xs:string
    Human-readable description of this stream group's purpose and the subsystem it serves.
  • <stream> Element
    [0..*]
    Individual TSN stream definitions within this group. All streams in a group typically share the same VLAN and chain path, though each can override with its own VLAN/PCP.
  • seamless-trees Attribute
    Type: xs:unsignedInt (required) — Number of redundant disjoint paths (seamless trees) for this stream. Typically 2 for dual-path redundancy. The network must have at least this many physically independent paths between talker and listener. Required.
  • seq-encoding Attribute
    Type: xs:string, default="r-tag" — Sequence number encoding method used to identify and eliminate duplicate frames. "r-tag" (default): dedicated R-TAG (EtherType 0xF1C1) inserted in the frame — standard 802.1CB method. "hsr": HSR (High-availability Seamless Redundancy, IEC 62439-3) sequence tag — used in industrial ring networks.