README
changeset 0 648bde652211
child 4 fda11de1826e
equal deleted inserted replaced
-1:000000000000 0:648bde652211
       
     1 #======================================================================
       
     2 #                    R E A D M E 
       
     3 #                    doc: Sat Mar 20 23:10:10 2004
       
     4 #                    dlm: Wed Nov 19 14:21:14 2008
       
     5 #                    (c) 2004 ladcp@
       
     6 #                    uE-Info: 68 56 NIL 0 0 72 3 2 8 NIL ofnI
       
     7 #======================================================================
       
     8 
       
     9 =Connecting Instruments=
       
    10 
       
    11 1) physically connect the instruments
       
    12 	- many USB-to-serial adapters do not work; we use keyspan ones
       
    13 
       
    14 2) determine the special files of the serial ports the instruments are
       
    15    connected to:
       
    16 	- Linux: /dev/ttyS0 /dev/ttyS1 for standard serial ports
       
    17 	- Linux: /dev/ttyUSB0 /dev/ttyUSB1 for USB2serial ports
       
    18 	- FreeBSD: /dev/cuad0 /dev/cuad1 for standard serial ports
       
    19 	- MacOSX: depends on USB2serial adapter, e.g. /dev/cu.USA* for
       
    20   	          a keyspan USA-19QW adapter;
       
    21 
       
    22 3) run "prepare_instrument <serial-port>" (e.g. prepare_instrument /dev/ttyS0)
       
    23 	- the search path must be set up to include the directory of the
       
    24 	  "prepare_instrument" script, i.e. it is NOT possible to use
       
    25 	  something like "./prepare_instrument /dev/ttyS0"
       
    26 	- this will reset the default communications speed of the
       
    27 	  instrument to 9600bps and report the instrument's serial
       
    28 	  number
       
    29 	- if this command does not work, none of the others will
       
    30 	- to troubleshoot, you can use "bbabble <serial-port>" but
       
    31 	  you're on your own there
       
    32 	  
       
    33 4) add the special-files and serial numbers to [DEFAULTS.expect]
       
    34 	- can change other settings, too
       
    35 
       
    36 5) test everything by running "reset2" and "dir2"
       
    37 
       
    38 ----------------------------------------------------------------------
       
    39 
       
    40 =Operator Scripts=
       
    41 
       
    42 NB: [DEFAULTS.expect] must have been edited to set cruise-specific
       
    43     information.
       
    44 
       
    45 NB: the search path must be set up to include the directory of the
       
    46     operator scripts. It is NOT possible, to use the operator scripts
       
    47     with full pathnames (e.g. ./reset2)
       
    48 
       
    49 NB: scripts ending in 1 are for use in a single-headed system; scripts
       
    50     ending in 2 are for use in a dual-headed system.
       
    51 
       
    52 reset1/reset2		wake up & reset instruments
       
    53 dir1/dir2		list recorder directories
       
    54 erasemem1/erasemem2	clear recorder memory
       
    55 interact1/interact2	enter interactive mode (similar to BBTALK)
       
    56 ladcp1/ladcp2		start new cast (upload command file & start pinging)
       
    57 abort1/abort2		abort started cast (rename cast directory)
       
    58 endladcp1/endladcp2	end cast (stop pinging & download data)
       
    59 checkfiles1/checkfiles2	postprocess data after download ok (check and
       
    60 			backup data files)
       
    61 
       
    62 ladcp_send_cmd <tty port> <cmd-file>
       
    63 			send command file to LADCP connected to specific
       
    64 			port; this is the command that can be used to
       
    65 			start a cast on a dual-headed instrument
       
    66 			connected to a switchbox
       
    67 
       
    68 print_version		print version of acquire scripts
       
    69 
       
    70 ----------------------------------------------------------------------
       
    71 
       
    72 =Aborting/Restarting Casts=
       
    73 
       
    74 After a cast has been started with ladcp1/2 it can be aborted with
       
    75 abort1/2. This renames the cast sub-directory that is created by
       
    76 ladcp1/2. However, it does not erase the memory on the ADCP. This has to
       
    77 be accomplished manually with erasemem1/2.
       
    78 
       
    79 ----------------------------------------------------------------------
       
    80 
       
    81 =Colors=
       
    82 
       
    83 - for dual-headed systems, color is determined by the serial numbers
       
    84   listed in [DEFAULTS.expect]: red for the master and blue for the
       
    85   slave;
       
    86 
       
    87 - this can be different to the colors if [bbabble] is used directly,
       
    88   because [bbabble] does not know anything about the instruments;
       
    89 
       
    90 ----------------------------------------------------------------------
       
    91 
       
    92 =Problems=
       
    93 
       
    94 - if downloading is to be restarted the RDI files have to be deleted
       
    95   manually;
       
    96 
       
    97 - all files are downloaded to the directory corresponding to the last
       
    98   deployment name; if there are data from multiple casts present in
       
    99   an instrument, they have to be copied to the correct directories
       
   100   manually;
       
   101 
       
   102 ----------------------------------------------------------------------
       
   103 
       
   104 =TTY Utilities=
       
   105 
       
   106 [bbabble]		bbtalk replacement
       
   107 [ttycat]		read from TTY, write to STDOUT (e.g. for logging GPS
       
   108 			data streams)
       
   109 [send_break]		send BREAK to TTY
       
   110 [find_comms_params]	cycle through comms params to determine baud rate &c