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