~ubuntu-branches/ubuntu/feisty/comedilib/feisty

« back to all changes in this revision

Viewing changes to man/comedi_calibrate.8

  • Committer: Bazaar Package Importer
  • Author(s): David Schleef
  • Date: 2003-09-23 18:11:12 UTC
  • Revision ID: james.westby@ubuntu.com-20030923181112-sat05jyh702rb1at
Tags: upstream-0.7.21
ImportĀ upstreamĀ versionĀ 0.7.21

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH comedi_calibrate 8 ""
 
2
.SH NAME
 
3
\fBcomedi_calibrate\fR - COMEDI calibration utility
 
4
.SH SYNOPSIS
 
5
\fBcomedi_calibrate\fR [-f /dev/comediN]
 
6
.br
 
7
.SH DESCRIPTION
 
8
\fBcomedi_calibrate\fR is used to autocalibrate \fBcomedi\fR
 
9
devices.  Some \fBcomedi\fR devices have the ability to
 
10
measure internal stable voltage references and control
 
11
gains and offsets using programmable DACs.  On these devices,
 
12
\fBcomedi_calibrate\fR adjusts the programmable calibration
 
13
DACs so that the measured value of reference voltages fall
 
14
within acceptable limits.  The calibration settings are
 
15
saved to a file which can be fed to comedi_apply_calibration()
 
16
and related functions.
 
17
 
 
18
\fBcomedi_calibrate\fR prints a lot of debugging information
 
19
as it runs.
 
20
 
 
21
.SH LIMITATIONS
 
22
 
 
23
\fBcomedi_calibrate\fR only works on boards that it understands.
 
24
For boards that are known to have autocalibration ability,
 
25
but are not currently supported, \fBcomedi_calibrate\fR will
 
26
output basic debugging information that is useful for
 
27
the author to add support for your device.  Please send this
 
28
output to him.
 
29
 
 
30
.SH EXAMPLES
 
31
 
 
32
.TP
 
33
.BI comedi_calibrate\ \-\-file\  /dev/comediN
 
34
If no default calibration for \fI/dev/comediN\fR already exists,
 
35
perform a calibration
 
36
and save results to default location.
 
37
 
 
38
.TP
 
39
.BI comedi_calibrate\ \-\-calibrate
 
40
Perform a calibration, using existing calibration (if it exists) as
 
41
starting point.
 
42
 
 
43
.TP
 
44
.BI comedi_calibrate\ \-\-reset\ \-\-calibrate
 
45
Perform a fresh calibration and save results to default location.
 
46
 
 
47
.TP
 
48
.BI comedi_calibrate\ \-\-no\-calibrate\ \-\-subdevice\  subd\  \-\-range\  range\  \-\-save\-file\  cal_file
 
49
Apply calibration for subdevice \fIsubd\fR, range \fIrange\fR, using
 
50
the settings in the calibration file \fIcal_file\fR.
 
51
 
 
52
 
 
53
.SH OPTIONS
 
54
 
 
55
\fBcomedi_calibrate\fR recognizes the following options:
 
56
 
 
57
.TP
 
58
.BI \-a\  aref ,\ \-\-aref\  aref
 
59
Along with \fB--channel\fR, \fB--range\fR
 
60
and \fB--subdevice\fR, this specifies which calibration you want comedi_calibrate
 
61
leave applied to the board.
 
62
 
 
63
.TP
 
64
.B \-\-[no\-]calibrate
 
65
Force calibration to be performed (or not).
 
66
By default, comedi_calibrate will only perform a new calibration if
 
67
no existing calibration file is found (see \fB--save-file\fR).
 
68
 
 
69
.TP
 
70
.BI \-c\  channel, \-\-channel\  channel
 
71
Along with \fB--subdevice\fR, \fB--range\fR
 
72
and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
 
73
to leave applied to the board.
 
74
 
 
75
.TP
 
76
.B \-\-[no\-]dump
 
77
Perform (or not) dump of various information about
 
78
state of calibration prior to performing new calibration.
 
79
 
 
80
.TP
 
81
.BI \-f\  /dev/comediN, \-\-file\  /dev/comediN
 
82
Perform calibration on device \fB/dev/comediN\fR.
 
83
 
 
84
.TP
 
85
.B \-\-help\
 
86
Print help for options then exit.
 
87
 
 
88
.TP
 
89
.B \-q, \-\-quiet
 
90
Don't generate output to stdout.
 
91
 
 
92
.TP
 
93
.BI \-r\  range ,\ \-\-range\  range
 
94
Along with \fB--channel\fR, \fB--subdevice\fR
 
95
and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
 
96
to leave applied to the board.
 
97
 
 
98
.TP
 
99
.B \-\-[no\-]reset
 
100
Reset (or don't reset) calibration subdevice to
 
101
a reasonable starting point before
 
102
performing calibration.  The default is \fB--no-reset\fR.  If
 
103
\fB--no-reset\fR is used, the calibration routine will try to use
 
104
an existing calibration (see \fB--save-file\fR) as a starting point.
 
105
This is useful if
 
106
a single calibration
 
107
pass is not sufficient, and you wish to perform another calibration
 
108
pass starting from the results of the previous pass.
 
109
 
 
110
.TP
 
111
.B \-\-[no\-]results
 
112
Perform (or not) dump of various information about
 
113
state of calibration after performing new calibration.
 
114
 
 
115
.TP
 
116
.BI \-S\  file ,\ \-\-save-file\  file
 
117
Save calibration information to specified file,
 
118
instead of default location.  If the file already exists, comedi_calibrate
 
119
will also use its contents as a starting point for the calibration pass (see
 
120
\fB--no-reset\fR).
 
121
 
 
122
.TP
 
123
.BI \-s\  subdevice ,\ \-\-subdevice\  subdevice
 
124
Along with \fB--channel\fR, \fB--range\fR
 
125
and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
 
126
to leave applied to the board.
 
127
 
 
128
.TP
 
129
.B \-v, \-\-verbose
 
130
Generate more verbose output to stdout, can be specified multiple times
 
131
 
 
132
 
 
133
.SH SEE ALSO
 
134
 
 
135
\fBcomedi\fR(7)
 
136
 
 
137
.SH VERSION
 
138
 
 
139
0.7.x
 
140
 
 
141
.SH AUTHOR
 
142
 
 
143
David Schleef, <ds@schleef.org>
 
144
 
 
145
Frank Mori Hess, <fmhess@users.sourceforge.net>