flync 0.14.0

Configuration-as-Code for Automotive E/E Networks

---

FLYNC (FLexible Yaml-based Network Configuration) is an open-source Python library that turns vehicle network configuration into clean, version-controlled code. It provides a single human-readable YAML schema and a comprehensive SDK to create, validate, and manipulate automotive E/E configurations programmatically.

By organizing system definitions in a central, version-controlled repository, FLYNC helps engineering teams manage complexity, enable reuse, and maintain consistency across domains.

Key Features

• 🧩 Layered Configuration Validation — Models configurations across multiple abstraction layers for early inconsistency detection
• ⚙️ Configuration-as-Code — Git-native version control, CI/CD integration, full traceability and reproducibility
• 🚀 Fast & Reliable — Optimized Pydantic v2 engine handles large-scale configurations with high and predictable performance
• 👩‍💻 Developer-Friendly — Intuitive YAML syntax, rich CLI, Python SDK, and clear documentation
• 🌍 Open Source & Collaborative — Apache-2.0 licensed, community-driven development
• 🔌 Extensible Converter Framework — Pluggy-based plugin system for format conversions (JSON, YAML, DBC, and custom plugins)

Domain Coverage

FLYNC models the full automotive E/E architecture across 13 domains:

Domain	Description
Application	Applications consuming/providing SOME/IP services
Bus	CAN bus and LIN bus definitions
Communication	System-wide TCP profiles
Diagnostics	DoIP/UDS: DoIP timings, UDS configurations (sessions, security access, supported services), DID/routine/DTC catalog, TCP/UDP socket deployment
ECU	Controllers, Ethernet/CAN/LIN interfaces, ports, PHY types (RGMII, SGMII, BASET…), switches, VLANs, multicast
Metadata	System/ECU metadata, OEM, platform, versioning, HW/SW BOM
Network Management	State management groups, timing profiles for wake-up/sleep coordination
Safety	E2E communication protection
Security	Firewall rules, MACsec encryption (integrity + confidentiality)
Signal / PDU / Frame	Full signal-to-frame stack, data types, PDUs (standard/multiplexed/container), CAN/LIN/CAN-FD frames, forwarding
SOME/IP	Open SOME/IP service interfaces, events, methods, fields, eventgroups, UDP/TCP deployment
Topology	Physical and logical network topology, switch/port interconnections, ECU connections
TSN	QoS shaping (CBS, ATS, HTB), traffic classes, PTP time synchronization

Quick Start

Installation

Requires Python 3.12+ and uv.

git clone https://github.com/Technica-Engineering/FLYNC.git
cd FLYNC

pip install uv
uv sync

For detailed platform-specific instructions and advanced options, see the Installation Guide.

Example: YAML Configuration

FLYNC workspaces organize vehicle configurations in modular .flync.yaml files:

my_project/
├── system_metadata.flync.yaml
├── topology/
│   └── ethernet_topology.flync.yaml
└── ecus/
    ├── hpc/
    │   ├── ecu_metadata.flync.yaml
    │   ├── ports.flync.yaml
    │   └── topology.flync.yaml
    └── zonal_gateway/
        ├── ecu_metadata.flync.yaml
        ├── ports.flync.yaml
        └── topology.flync.yaml

System metadata (system_metadata.flync.yaml):

release:
  version_schema: semver
  version: 1.2.1
author: System_Architect
compatible_flync_version:
  version_schema: semver
  version: 0.11.0
oem: OEM_example
platform: Arch1

ECU port definition (ecus/hpc/ports.flync.yaml):

ports:
  - name: hpc1_p1
    mdi_config:
      mode: base_t1
      speed: 1000
      duplex: full
      role: master
      autonegotiation: false
    mii_config:
      type: sgmii
      speed: 1000
      mode: phy

System topology (topology/ethernet_topology.flync.yaml):

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: zgw_p1

Explore the full example at examples/flync_example/.

Example: Python SDK

from flync.sdk.workspace import FLYNCWorkspace

# Load and validate a workspace
workspace = FLYNCWorkspace(name="my_project")
workspace.ingest_folder("path/to/my_project")
workspace.run_analysis()

# Access the validated model
model = workspace.model
for ecu in model.ecus:
    print(f"ECU: {ecu.name}, Ports: {len(ecu.ports)}")

Example: CLI

# Store a workspace path once, so the commands below can omit it
flync config set path/to/my_project

# Validate a workspace
flync validate

# Show ECU / controller / interface / socket / IP information
flync info ecus
flync info sockets
flync info ip

# Generate a PlantUML system diagram
flync generate-system-uml

# Show SOME/IP services and one service instance's deployments
flync info services
flync info instances 0x0101 1

# Show VLAN membership
flync info vlans

CLI Tools

FLYNC ships with five CLI entry points:

Command	Description
flync	Main CLI — validate workspaces, inspect ECUs, generate UML diagrams, query services and VLANs
flync-converter	Convert between formats (FLYNC ↔ JSON ↔ YAML ↔ DBC and custom plugins)
flync-converter-interactive	Interactive terminal UI for conversions (requires flync[tui])
flync-converter-gui	Desktop GUI for conversions (requires flync[gui])
puml-to-html	Convert PlantUML diagrams to HTML

Architecture

src/
├── flync/                  # Core library
│   ├── core/               #   Base models (Pydantic v2), annotations, datatypes, validators
│   ├── model/              #   13 domain models (ECU, SOME/IP, TSN, topology, …)
│   └── sdk/                #   Workspace management, validation helpers, model serialization
├── flync_cli/              # Typer + Rich CLI application (validate, info, UML, …)
└── flync_converter/        # Pluggy-based converter framework (CLI, TUI, GUI)

Traditional Approach vs. FLYNC

	Traditional Approach	With FLYNC
Configuration storage	Multiple formats & scattered files	One unified YAML-based model
Version control	Partial / inconsistent	Git-native
CI/CD integration	Rare / custom scripts	Built-in workflow friendly
Cross-team collaboration	Siloed	Shared source of truth

Development

Setup

# Full developer environment (core + test + linting)
uv sync

# Add documentation dependencies
uv sync --group docs

# Install pre-commit hooks
pre-commit install

# Optional: install graphical front-ends
uv sync --extra gui --extra tui

Running Tests

uv run pytest                           # Full suite (parallel, with coverage)
uv run pytest tests/unit_test/          # Unit tests only
uv run pytest -k "test_ecu"             # Filter by keyword
uv run pytest --no-header -v --tb=short # Verbose, short tracebacks

Code Quality

# Run all checks (black, isort, flake8, mypy)
bash scripts/helpers/local_checkers.sh

# Auto-fix formatting issues
bash scripts/helpers/local_autoformat.sh

# Run pre-commit on all files
pre-commit run --all-files

Validate Bundled Examples

uv run python scripts/ci/validate_examples.py

Build Documentation

cd docs && make html

Target Users

FLYNC is designed for:

• E/E architecture teams — model and validate vehicle network configurations
• Network and platform engineers — define ECU topologies, SOME/IP services, TSN policies
• SDV DevOps and integration teams — integrate configuration validation into CI/CD pipelines
• Validation and test engineers — detect inconsistencies early across abstraction layers
• Toolchain and automation specialists — extend FLYNC with custom converter plugins

Contributing

We welcome contributions! See CONTRIBUTING.md for detailed guidelines on:

• Coding standards and Pydantic model conventions
• Branch naming and commit message format
• PR workflow and review process
• Testing requirements

Quick links:

• 🐛 Report a bug
• 💡 Request a feature
• 🔒 Security issues → flync@technica-engineering.de

Resources

🌐 Website	flync-language.com
📖 Documentation	GitHub / Docs
🐛 Issue Tracker	GitHub Issues
📧 Contact	flync@technica-engineering.de

License

Apache License 2.0 — Copyright 2026 Technica Engineering GmbH