check_zsync_connection#

PQSC.check_zsync_connection(ports: List[int] | int = 0, *, timeout: int = 30, sleep_time: int = 1) → List[bool] | bool[source]#

Check if the ZSync connection on the given port(s) is established.

This function checks the current status of the instrument connected to the given ports.

Parameters:

  • ports (List[int] | int) – The port numbers to check the ZSync connection for. It can either be a single port number given as integer or a list of several port numbers. (default: 0)

  • timeout (int) – Maximum time in seconds the program waits (default: 30).

  • sleep_time (int) – Time in seconds to wait between requesting the reference clock status (default: 1)

Raises:

TimeoutError – If the process of establishing a ZSync connection on one of the specified ports exceeds the specified timeout.

Return type:

List[bool] | bool