flync_4_topology

class FLYNCTopology

Bases: FLYNCBaseModel

Represents the complete FLYNC system topology, including ECU connections and multicast routing configuration.

Parameters

system_topologySystemTopology

The system-wide external connection topology between ECUs.

System Topology

Expand for Schematic

        classDiagram

    class ExternalConnection {
        type: Literal['ecu_port_to_ecu_port'] = 'ecu_port_to_ecu_port'
        id: str
        ecu1_port_name: str
        ecu2_port_name: str
    }

    class FLYNCTopology {
        system_topology: SystemTopology
    }

    class SystemTopology {
        connections: list[ExternalConnection]
    }

    class FLYNCBaseModel {
    }

    class OutputStrategy {
        <<Enumeration>>
        AUTO: int = 1
        FOLDER: int = 1
        SINGLE_FILE: int = 2
        OMMIT_ROOT: int = 4
        FIXED_ROOT: int = 8
    }

    class ECUPort {
        name: str
        mdi_config: BASET1 | BASET1S | BASET = BASET1
        mii_config: MII | RMII | SGMII | RGMII | XFI | None = None
    }

    ECUPort ..> BASET1S
    ECUPort ..> MII
    ECUPort ..> XFI
    ECUPort ..> BASET1
    ECUPort ..> RMII
    ECUPort ..> SGMII
    ECUPort ..> RGMII
    ECUPort ..> BASET
    SystemTopology ..> ExternalConnection
    FLYNCTopology ..> SystemTopology


    

Expand for a YAML example - 📄 system_topology.flync.yaml

Note

In system_topology the external connections between ECUs of the system are described (if more than one ECU is specified).

connections:
  - type: ecu_port_to_ecu_port
    id: conn1
    ecu1_port: hpc1_p1
    ecu2_port: z1_p1
  - type: ecu_port_to_ecu_port
    id: conn2
    ecu1_port: hpc1_p2
    ecu2_port: z2_p1
  - type: ecu_port_to_ecu_port
    id: conn3
    ecu1_port: hpc1_p3
    ecu2_port: eth_ecu_p1

Hint

All the connections listed in a system topology shall be of the type : ecu_port_to_ecu_port.

class SystemTopology

Bases: FLYNCBaseModel

Represents the system-wide topology consisting of external connections between ECUs.

Parameters

connectionslist of ExternalConnection

A list of ExternalConnection instances that define the links between ECU ports.

Private Attributes

_flync_modelFLYNCModel

Internal reference to the FLYNC model that owns this topology. Managed internally and not part of the public API.

class ExternalConnection

Bases: FLYNCBaseModel

Represents a connection between two ECU (Electronic Control Unit) ports.

This model captures a directed or undirected link between two named ports on separate ECUs.

Parameters

typeLiteral[“ecu_port_to_ecu_port”]

The type of the connection. Defaults to “ecu_port_to_ecu_port” for schema identification.

idstr

A unique identifier for the external connection.

ecu1_port_namestr

The name of the first ECU port (alias: “ecu1_port”).

ecu2_port_namestr

The name of the second ECU port (alias: “ecu2_port”).

Private Attributes

_ecu1_portECUPort

Runtime reference to the first ECUPort object.

_ecu2_portECUPort

Runtime reference to the second ECUPort object.