Skip to content

ClockEndpoint

Part of Clock diagnostics in the Python API reference.

Related guidance: how-to/check-clock, how-to/troubleshooting.

Runnable examples: check_clock.py.

from picogrid_ecn_client import ClockEndpoint

Configured ECN-relative NTP endpoint used for one measurement.

ClockEndpoint(*, host: str, port: int = 123)

Source · models/clock.py

NameTypeRequiredDefaultConstraintsDescription
hoststryesmin_length=1, max_length=1024NTP host that produced this measurement, from 1 through 1024 characters. The report always names a resolved host; the fallback to the configured ECN host is applied by ECNConfig when ntp_host is unset, not by this model.
portintno123ge=1, le=65535UDP port of the measured NTP endpoint, from 1 through 65,535.

Version 0.2.0 · branch main