ptp4l_instance

PTP4L configuration and state parsing.

Classes:

• NetworkTransport –

  PTP network transport type.

• Ptp4lConfig –

  Configuration for a ptp4l instance.

• Ptp4lRunningState –

  Running state for ptp4l log parsing.

NetworkTransport

Bases: Enum

PTP network transport type.

Methods:

• from_flag –

  Create from ptp4l command-line flag.

• from_label –

  Create from config file label (L2, UDPv4, UDPv6).

• to_flag –

  Convert to ptp4l command-line flag.

from_flag classmethod

from_flag(flag: Literal['-2', '-4', '-6'])

Create from ptp4l command-line flag.

from_label classmethod

from_label(label: str)

Create from config file label (L2, UDPv4, UDPv6).

to_flag

to_flag()

Convert to ptp4l command-line flag.

Ptp4lConfig dataclass

Ptp4lConfig()

Bases: LinuxPtpConfig

Configuration for a ptp4l instance.

Attributes:

• clock (ClockId) –

  The clock used by this ptp4l instance.

• uds_address (str) –

  Unix domain socket address for PMC.

• network_transport (NetworkTransport) –

  The network transport type.

• ports (list[str]) –

  List of network interface names.

Used by:

• API Reference linuxptp_monitor  ptp4l_instance  Ptp4lRunningState

Methods:

• add_args_app_specific –

  Add ptp4l-specific arguments to the parser.

• override_app_specific –

  Return list of args that override config file settings.

• validate_args_app_specific –

  Validate ptp4l-specific arguments.

• validate_config_app_specific –

  Validate ptp4l-specific configuration.

add_args_app_specific

add_args_app_specific(parser: ArgumentParser) -> None

Add ptp4l-specific arguments to the parser.

override_app_specific

override_app_specific(
    args: Namespace, config: ConfigParser
) -> list[str]

Return list of args that override config file settings.

validate_args_app_specific

validate_args_app_specific(args: Namespace) -> None

Validate ptp4l-specific arguments.

validate_config_app_specific

validate_config_app_specific(config: ConfigParser) -> None

Validate ptp4l-specific configuration.

Ptp4lRunningState dataclass

Ptp4lRunningState(
    config: Ptp4lConfig,
    port_states: Dict[int, ValueType] = dict(),
    slave_clock_state: SlaveClockState | None = None,
)

Bases: State

Running state for ptp4l log parsing.

Attributes:

• config (Ptp4lConfig) –

  The ptp4l configuration.

• port_states (Dict[int, ValueType]) –

  Current state of each port by port number.

• slave_clock_state (SlaveClockState | None) –

  Current slave clock state, if available.

Methods:

• parse –

  Parse a journal entry and yield graph update events.

parse

parse(entry: JournalEntry)

Parse a journal entry and yield graph update events.