faraphel/chrony
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: update tempcomp description

Browse source
This commit is contained in:
Miroslav Lichvar 2014-11-21 13:13:15 +01:00
parent ed862c8d08
commit 7534ffee64
1 changed files with 49 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
chrony.texi.in
View file

@ -2973,21 +2973,23 @@ distances are in milliseconds.
@c {{{ tempcomp @c {{{ tempcomp
@node tempcomp directive @node tempcomp directive
@subsection tempcomp @subsection tempcomp
Normally, changes in rate of drift of the system clock are caused mainly by Normally, changes in the rate of drift of the system clock are caused mainly by
changes in temperature of the crystal oscillator on the mainboard. changes in the temperature of the crystal oscillator on the mainboard.
If there are available temperature measurements from a sensor close to the If there are temperature measurements available from a sensor close to the
oscillator, @code{tempcomp} directive can be used to compensate for the changes oscillator, the @code{tempcomp} directive can be used to compensate for the
in rate and possibly improve clock accuracy. changes in the temperature and improve the stability and accuracy of the clock.
Whether it will really help depends on many factors, including resolution of The result depends on many factors, including the resolution of the sensor,
the sensor, noise in measurements, time source polling interval, compensation the amount of noise in the measurements, the polling interval of the time
update interval, how good are the temperature coefficients, and how close is source, the compensation update interval, how well is the compensation
the sensor to the oscillator. The frequency reported in tracking.log should specified, and how close is the sensor to the oscillator. When it's working
be more stable and the offsets should be smaller. well, the frequency reported in the @file{tracking.log} file is more stable and
the maximum reached offset is smaller.
The directive has six parameters: path to the file which contains current There are two forms of the directive. The first one has six parameters: a
temperature in text format, update interval (in seconds), and temperature path to the file containing the current temperature from the sensor (in
text format), the compensation update interval (in seconds), and temperature
coefficients T0, k0, k1, k2. coefficients T0, k0, k1, k2.
The frequency compensation is calculated (in ppm) as The frequency compensation is calculated (in ppm) as
@ -2995,23 +2997,48 @@ The frequency compensation is calculated (in ppm) as
@code{k0 + (T - T0) * k1 + (T - T0)^2 * k2} @code{k0 + (T - T0) * k1 + (T - T0)^2 * k2}
The result has to be between -10 ppm and 10 ppm, otherwise the measurement is The result has to be between -10 ppm and 10 ppm, otherwise the measurement is
considered to be faulty and will be ignored. The k0 coefficient can be used to considered invalid and will be ignored. The k0 coefficient can be used to get
get the results in that range. the results in that range.
Valid measurements and calculated corrections are logged to tempcomp.log file if
enabled with @code{log tempcomp} directive.
An example of use is An example of use is
@example @example
tempcomp /sys/class/hwmon/hwmon1/device/temp2_input 30 26000 0.0 0.000183 0.0 tempcomp /sys/class/hwmon/hwmon0/temp2_input 30 26000 0.0 0.000183 0.0
@end example @end example
The measured temperature will be read from the file in Linux sysfs filesystem The measured temperature will be read from the file in the Linux sysfs
every 30 seconds. When the temperature is 26 degress (26000), the system clock filesystem every 30 seconds. When the temperature is 26000 (26 degrees
frequency will not be adjusted. When it is 27 degrees (27000), the clock will Celsius), the frequency correction will be zero. When it is 27000 (27 degrees
be set to run 0.183ppm faster than it would be without the compensation, etc. Celsius), the clock will be set to run 0.183ppm faster, etc.
The second form has three parameters, the path to the sensor file, the update
interval and a path to a file containing a list of (temperature, compensation)
points, from which the compensation is linearly interpolated or extrapolated.
An example is
@example
tempcomp /sys/class/hwmon/hwmon0/temp2_input 30 /etc/chrony.tempcomp
@end example
where the @file{chrony.tempcomp} file could have
@example
20000 1.0
21000 0.64
22000 0.36
23000 0.16
24000 0.04
25000 0.0
26000 0.04
27000 0.16
28000 0.36
29000 0.64
30000 1.0
@end example
Valid measurements with corresponding compensations are logged to the
@file{tempcomp.log} file if enabled by the @code{log tempcomp} directive.
@c }}} @c }}}
@c {{{ user @c {{{ user
@node user directive @node user directive