git.gag.com Git - fw/altos/blob - ao-tools/ao-cal-freq/ao-cal-freq.1

   1 .\"
   2 .\" Copyright © 2009 Keith Packard <keithp@keithp.com>
   3 .\"
   4 .\" This program is free software; you can redistribute it and/or modify
   5 .\" it under the terms of the GNU General Public License as published by
   6 .\" the Free Software Foundation; either version 2 of the License, or
   7 .\" (at your option) any later version.
   8 .\"
   9 .\" This program is distributed in the hope that it will be useful, but
  10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 .\" General Public License for more details.
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License along
  15 .\" with this program; if not, write to the Free Software Foundation, Inc.,
  16 .\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  17 .\"
  18 .\"
  19 .TH AO-LOAD 1 "ao-cal-freq" ""
  20 .SH NAME
  21 ao-cal-freq \- Calibrate AltOS flight computer frequency
  22 .SH SYNOPSIS
  23 .B "ao-cal-freq"
  24 [\-T \fItty-device\fP]
  25 [\--tty \fItty-device\fP]
  26 [\-D \fIaltos-device\fP]
  27 [\--device \fIaltos-device\fP]
  28 [\-v] [\--verbose]
  29 [\-n] [\--nosave]
  30 [\-o \fIcal-value-output-file\fP]
  31 [\--output \fIcal-value-output-file\fP]
  32 .SH DESCRIPTION
  33 .I ao-cal-freq
  34 drives the frequency calibration process and saves the result.
  35 .SH OPTIONS
  36 .TP
  37 \-T tty-device | --tty tty-device
  38 This selects which tty device the debugger uses to communicate with
  39 the target device. The special name 'BITBANG' directs ao-dbg to use
  40 the cp2103 connection, otherwise this should be a usb serial port
  41 connected to a suitable cc1111 debug node.
  42 .TP
  43 \-D AltOS-device | --device AltOS-device
  44 Search for a connected device. This requires an argument of one of the
  45 following forms:
  46 .IP
  47 TeleMega:2
  48 .br
  49 TeleMega
  50 .br
  51 2
  52 .IP
  53 Leaving out the product name will cause the tool to select a suitable
  54 product, leaving out the serial number will cause the tool to match
  55 one of the available devices.
  56 .TP
  57 \-o cal-value-output-file | --output cal-value-output-file
  58 Writes the resulting calibration value to the specified file.
  59 .TP
  60 \-n | --nosave
  61 Inhibits saving the calibration value on the device. Necessary for
  62 devices which don't have on-board configuration storage.
  63 .TP
  64 \-v | --verbose
  65 Makes
  66 .I ao-cal-freq
  67 chatty about communication with the target device.
  68 .SH USAGE
  69 .I ao-cal-freq
  70 opens the target device, interactively calibrates the frequency, then
  71 shows the resulting calibration values and (optionally) saves them to
  72 configuration memory and/or a file.
  73 .SH AUTHOR
  74 Keith Packard