Aller au contenu principal

raydriver.core.discovery.serial_scan

Constants​

BAUD_CANDIDATES​

list[int]

list_port_info​

Any

PortObservation​

Raw output captured from one port during a scan.

baud_rate​

baud_rate: int

data​

data: bytes

Everything the device sent while the port was open.

info​

info: Optional[ports.SerialPortInfo]

USB metadata for the port, when available.

port​

port: str

Functions​

looks_like_device_output()​

looks_like_device_output(data: Sequence[int]) -> bool

Generic, firmware-agnostic test for "a device is talking on this port": the capture contains at least one line of mostly-printable ASCII. Output received at a wrong baud rate is typically framing garbage and fails this test.

ParameterTypeDescription
dataSequence[int]
Returnsbool

scan_serial_ports()​

scan_serial_ports(
ports: Optional[Iterable[str]] = None,
baud_rates: Optional[Iterable[int]] = None,
exclude_ports: Optional[Iterable[str]] = None,
timeout: Optional[float] = None,
) -> Any

Probes every port at baud_rates, all ports in parallel, and returns one observation per port that produced device-like output. Ports named in exclude_ports are skipped entirely (used by callers that hold devices on those ports). Ports that are busy, absent, or silent are skipped silently.

When timeout is given the scan stops waiting after that many seconds: observations collected so far are still returned and probes still in flight are cancelled, so a slow or silent adapter can never push a responsive machine past the deadline. Results keep the order of ports.

ParameterTypeDescription
portsOptional[Iterable[str]] = None
baud_ratesOptional[Iterable[int]] = None
exclude_portsOptional[Iterable[str]] = None
timeoutOptional[float] = None
ReturnsAny