man/comedi_calibrate.8

   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 determines the proper values to
  13 feed into the programmable calibration
  14 DACs.  These calibration settings are then
  15 saved to a file, which can be fed to comedi_apply_calibration()
  16 and related functions.
  17
  18 If comedi_calibrate finds an existing calibration file, it
  19 will not perform a new calibration by default.  It will
  20 simply read its calibration information from the file.
  21 This behaviour
  22 may be overriden with the
  23 .B \-\-calibrate
  24 option, to force a new calibration to be performed.
  25
  26 After obtaining the calibration information for the board,
  27 comedi_calibrate will then apply a calibration setting
  28 appropriate for the specified subdevice, channel, and
  29 range (see the
  30 .B \-\-subdevice
  31 ,
  32 .B \-\-channel
  33 , and
  34 .B \-\-range
  35 options below).  See the comedilib documentation for
  36 comedi_apply_calibration() for more information.
  37
  38 \fBcomedi_calibrate\fR prints a lot of debugging information
  39 as it runs.
  40
  41 .SH LIMITATIONS
  42
  43 \fBcomedi_calibrate\fR only works on boards that it understands.
  44 For boards that are known to have autocalibration ability,
  45 but are not currently supported, \fBcomedi_calibrate\fR will
  46 output basic debugging information that is useful for
  47 the author to add support for your device.  Please send this
  48 output to him.
  49
  50 .SH EXAMPLES
  51
  52 .TP
  53 .BI comedi_calibrate\ \-\-file\  /dev/comediN
  54 If no default calibration for \fI/dev/comediN\fR already exists,
  55 perform a calibration
  56 and save results to default location.
  57
  58 .TP
  59 .BI comedi_calibrate\ \-\-calibrate
  60 Perform a calibration, using existing calibration (if it exists) as
  61 starting point.
  62
  63 .TP
  64 .BI comedi_calibrate\ \-\-reset\ \-\-calibrate
  65 Perform a fresh calibration and save results to default location.
  66
  67 .TP
  68 .BI comedi_calibrate\ \-\-no\-calibrate\ \-\-subdevice\  subd\  \-\-range\  range\  \-\-save\-file\  cal_file
  69 Apply calibration for subdevice \fIsubd\fR, range \fIrange\fR, using
  70 the settings in the calibration file \fIcal_file\fR.
  71
  72
  73 .SH OPTIONS
  74
  75 \fBcomedi_calibrate\fR recognizes the following options:
  76
  77 .TP
  78 .BI \-a\  aref ,\ \-\-aref\  aref
  79 Along with \fB--channel\fR, \fB--range\fR
  80 and \fB--subdevice\fR, this specifies which calibration you want comedi_calibrate
  81 leave applied to the board.
  82
  83 .TP
  84 .B \-\-[no\-]calibrate
  85 Force calibration to be performed (or not).
  86 By default, comedi_calibrate will only perform a new calibration if
  87 no existing calibration file is found (see \fB--save-file\fR).
  88
  89 .TP
  90 .BI \-c\  channel, \-\-channel\  channel
  91 Along with \fB--subdevice\fR, \fB--range\fR
  92 and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
  93 to leave applied to the board.
  94
  95 .TP
  96 .B \-\-[no\-]dump
  97 Perform (or not) dump of various information about
  98 state of calibration prior to performing new calibration.
  99
 100 .TP
 101 .BI \-f\  /dev/comediN, \-\-file\  /dev/comediN
 102 Perform calibration on device \fB/dev/comediN\fR.
 103
 104 .TP
 105 .B \-\-help\
 106 Print help for options then exit.
 107
 108 .TP
 109 .B \-q, \-\-quiet
 110 Don't generate output to stdout.
 111
 112 .TP
 113 .BI \-r\  range ,\ \-\-range\  range
 114 Along with \fB--channel\fR, \fB--subdevice\fR
 115 and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
 116 to leave applied to the board.
 117
 118 .TP
 119 .B \-\-[no\-]reset
 120 Reset (or don't reset) calibration subdevice to
 121 a reasonable starting point before
 122 performing calibration.  The default is \fB--no-reset\fR.  If
 123 \fB--no-reset\fR is used, the calibration routine will try to use
 124 an existing calibration (see \fB--save-file\fR) as a starting point.
 125 This is useful if
 126 a single calibration
 127 pass is not sufficient, and you wish to perform another calibration
 128 pass starting from the results of the previous pass.
 129
 130 .TP
 131 .B \-\-[no\-]results
 132 Perform (or not) dump of various information about
 133 state of calibration after performing new calibration.
 134
 135 .TP
 136 .BI \-S\  file ,\ \-\-save-file\  file
 137 Save calibration information to specified file,
 138 instead of default location.  If the file already exists, comedi_calibrate
 139 will also use its contents as a starting point for the calibration pass (see
 140 \fB--no-reset\fR).
 141
 142 .TP
 143 .BI \-s\  subdevice ,\ \-\-subdevice\  subdevice
 144 Along with \fB--channel\fR, \fB--range\fR
 145 and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
 146 to leave applied to the board.
 147
 148 .TP
 149 .B \-v, \-\-verbose
 150 Generate more verbose output to stdout, can be specified multiple times
 151
 152
 153 .SH SEE ALSO
 154
 155 \fBcomedi\fR(7)
 156
 157 .SH VERSION
 158
 159 0.7.x
 160
 161 .SH AUTHOR
 162
 163 David Schleef, <ds@schleef.org>
 164
 165 Frank Mori Hess, <fmhess@users.sourceforge.net>