Common Use Cases¶

Note

The commands in the guide will use the flync_example directory. Try it out or update the path accordingly to your config path!

Validate a workspace¶

flync validate examples/flync_example

Run validation as a pipeline gate to catch configuration errors early:

flync validate examples/flync_example --quiet

Use –node or -n to validate just a part of a config such as an ECU directory, a SOME/IP config, a Switch config, etc. :

flync validate --node ECU examples/flync_example/ecus/eth_ecu

flync validate -n Switch examples/flync_example/ecus/high_performance_compute/switches/hpc_switch1.flync.yaml

flync info list-ecus examples/flync_example

Quickly list all IP addresses across every ECU in a workspace to spot conflicts:

flync info list-ips examples/flync_example

Use -e to inspect a specific ECU:

flync info list-ips -e eth_ecu examples/flync_example

Check which interfaces and ECUs belong to a specific VLAN:

flync display-vlan-info 10 examples/flync_example

Identify which ECUs provide or consume a service and verify IP/port configuration:

flync display-service-info "Enhanced Testability Services" examples/flync_example

Produce a PlantUML diagram of the full ethernet topology for documentation or review:

flync generate-system-uml examples/flync_example --output topology.puml

Get the next free number, then add it (with a category) at the factory call site:

flync errors get-next-number

raise err_major("Port {name} is invalid.", category=Category.VALUE_RANGE, error_number="175")

Check the code against the catalogue, then regenerate it:

flync errors validate-catalogue
flync errors generate-catalogue