FILE: readme                    Copyright (c), Symmetric Research, 2004

SrParxchEwSend is a program for sending data from a SR PARxCH 24 bit
system to an Earthworm WAVE_RING buffer as TYPE_TRACEBUF messages.  It
works with all three PARxCH systems, one, four, and eight channels.
It is similar in concept and organization to the ADSEND module except it
works for the SR PARxCH A/D's.

In order to compile this module, a copy of the Symmetric Research
PARxCH and PARGPS software libraries and includes are required.  The
current SR software is available free from the download page of our
website: www.symres.com.  You should use the version of PARxCH
software, compiled with GPS_AVAILABLE defined, that supports the
PARGPS even if you don't plan to use the PARGPS in your
application.

In order to run this module, a PARxCH board must be properly connected
to your computer and its device driver must be correctly installed.
Before using the PARxCH with Earthworm, we strongly recommend you
follow the instructions included with the PARXCH software for setting
up the board and installing the driver and then verify its correct
operation using the included diags and scope programs.

Once you have both Earthworm and the PARxCH working separately, you
should edit the srparxchewsend.d configuration values so they match
your hardware setup.  You will probably also need to edit some
additional Earthworm configuration files like startstop.d,
wave_serverV.d, export_scn.d, etc to handle the data SrParxchEwSend
will be providing.  See some example steps below.

For more details about how the SrParxchEwSend module is organized,
please see the comments at the top of the .c source file.
    
For support or to suggest improvements, please contact Wendy Tucker at
Symmetric Research (email: info@symres.com).

The files in this directory are:
 Makefile.nt           creates the executable for SrParxchEwSend on Windows NT/2K/XP.
 Makefile.lnx          creates the executable for SrParxchEwSend on Linux.
 Makefile.sol          place holder for unsupported SrParxchEwSend on Solaris.
 readme                this file.
 srparxchewsend.c      source file for this module.
 srparxchewsend.d      configuration file read by SrParxchEwSend.
 srparxchewsend.desc   the descriptor file for SrParxchEwSend required by statmgr.



To run SrParxchEwSend, do the following:

1) Put srparxchewsend.exe in the standard earthworm executable 
   directory (eg \earthworm\v7.0\bin)

2) Put srparxchewsend.d and srparxchewsend.desc in the run params 
   directory (eg \earthworm\run\params)

3) Edit srparxchewsend.d to select the PARxCH model, port mode, etc
   that match your equipment and select the desired sampling rate, 
   channel names, etc

4) Edit startstop_nt.d to also control srparxchewsend (eg add 
   lines like:

   Process          "srparxchewsend srparxchewsend.d"
   PriorityClass     Normal
   ThreadPriority    Normal
   Display           NewConsole

5) Edit wave_serverV.d to save the PARxCH data into tanks 
   eg add lines like:

   Tank    CH00 xxx SR  880   INST_UNKNOWN  MOD_WILDCARD       1         10000         c:\earthworm\run_test\wsdata\pch00.tnk

6) Edit wave_viewer.d or the config file for another viewer
   to see the PARxCH data.

7) Hook up the PARxCH and optional PARGPS and use their
   respective diag.exe programs to make sure they're working
   properly.

Then startstop earthworm and the system will begin acquiring data.
