pll-vcxo

Type signature: (*->*)

Help

Usage:

pll-vcxo [OPTION]... [TIME_STREAM_NAME]

Allowed options:

Option	Description
--help	produce help message
--verbose	print messages for every VCXO command (default: only on failure)
--offset OFFSET (=0.000000000000000000)	offset phase of disciplined clock from reference time (positive = delay = shift disciplined clock forward in time; negative = advance = shift disciplined clock backwards in time) (units: seconds)
--offset-temperature-coefficient C1 (=0)	add linear temperature-dependent term to OFFSET of "C1 * (T-T0)" (units: seconds/(deg C))
--offset-temperature-polynomial [C1, C2, C3, ...] (=[])	add polynomial temperature-dependent term to OFFSET of "C1 * (T-T0) + C2 * (T-T0)^2 + C3 * (T-T0)^3 + ..." (units for Cn: seconds/(deg C)^n)
--temperature-statlog-variable arg (=Temperature (deg C))	StatLog variable name to obtain device temperature T from; only used if temperature coefficient or polynomial are nonzero
--temperature-0 T0 (=25)	set nominal temperature for calibration (T0 in above expressions) (units: deg C)
--offset-temperature-verbose	log device temperature T and total applied OFFSET at 1 Hz for debugging or testing calibration
--offset-temperature-no-statlog-output	inhibit logging of total applied OFFSET as "TemperatureCompensation offset (ns)" StatLog variable
--max-slew arg (=1e-9)	maximum slew rate during normal operation (units: relative frequency/second; e.g. 1e-9 = 1 ppb/second)
--max-slew-plan-factor arg (=0.1)	proportion of slew rate to assume while planning; must be in range (0, 1]; 0 = assume no authority; 1 = assume full authority
--update-rate arg (=50)	update rate (units: Hz)
--disable-fast-slew	disable fast slewing mode, where slew rate is increased to 10 ppb/s if frequency error is more than 10 ppb; avoids loss of GNSS lock
--force-zero-frequency-offset	force frequency offset to zero (default: use the nearest frequency to the start point that results in an integer number of VCXO cycles per input period (e.g. 1 second for a PPS signal))
--nominal-control-output arg (=0.5)	set initial control output to this value; 0 = minimum frequency; 1 = maximum frequency
--vcxo-frequency arg (=100000000)	frequency of VCXO (used for computing offsets that allow PPS output without sawtooth error)
--plot	plot state
--plot-min-sample-period arg (=0)	minimum width between plot points in seconds; plot points closer than this will be averaged
--plot-x-axis-unit arg (=sec)	unit of X axis (options: sec, min, hour, day)
--plot-x-axis-absolute	plot absolute stream time on X axis instead of relative to now (implied by --plot-wait)
--plot-detrend	<unused>
--plot-wait	wait for pipeline to terminate, then plot (default: live plotting)
--plot-live-history arg (=60)	duration of live history buffer in seconds
--title-suffix arg	append string to plot titles
--plot-after arg (=0)	only start plotting/stats this many seconds from start (useful to prevent convergence from affecting plot limits)
--plot-after-frequency-lock	only start plotting/stats after frequency lock has been obtained (useful to prevent convergence from affecting plot limits)
--plot-after-time-lock	only start plotting/stats after time lock has been obtained (useful to prevent convergence from affecting plot limits)
--time-stream-name TIME_STREAM_NAME	name of Time stream to use as reference; will also match a unique prefix of a name (default: the only one available)
--frequency-offset arg (=0)	lock to given relative frequency offset (e.g. 1e-6 would lock to +1ppm relative to reference