ref2ew(n)

NAME

ref2ew - Earthworm module for putting RefTek trace packets into wave ring.

SYNOPSIS

ref2ew config-file

DESCRIPTION

Ref2ew reads RefTek packets from an input source, converts the packets to Earthworm trace_buff packets, and puts the packets on the Earthworm wave ring. The input source can be either a serial port (TTY device) or a TCP connection. Raw RefTek packets can optionally be saved to file. This module is may be used for reading RefTek packets from a Terra Technology strong-motion instrument, as well as a standard RefTek instrument.

CONFIGURATION FILE COMMANDS

TtyName name configures ref2ew to read from serial port name . This command is mutually exclusive with TcpHost .

Speed baud sets the speed of the serial port to baud . This command is required if TtyName is used in the configuration file; otherwise it is ignored.

TtyName host configures ref2ew to read data from a TCP connection to host , which may be a hostname or an IP address. This command is mutually exclusive with TtyName .

Port port specifies the TCP port number port . This command is required if TcpHost is used in the configuration file; otherwise it is ignored.

Station station identifies the wave trace packets as being from station . Channel n name associates RefTek channel n with channel name . Channels names should follow the SEED name convention. There should be one Channel command for each RefTek channel in use.

Network net sets the network string in output trace packets to net . The netowrk name for University of Washington is UW .

TimeShift time tells ref2ew to add time to the RefTek packet time as the packets are placed on the output ring. Raw RefTek packets being saved to file are not affected. There is no flag in Earthworm trace packets to indicate that this time correction has been applied. This command is optional.

SampleRate n identifies the sample rate of packets from the RefTek as being n samples per second. This command is required. RefVar variant may be used to identify the variant of the RefTek format being sent. The standard format is Reftek . Currently the only variant is Terra , spoken by Terra Technology IDS instruments. This command is optional. StationFile filename identifies filename as the station file. ref2ew uses the station file to look up the pin number for each of the channels it is processing. The pin number is currently used by Earthworm module pick_ew , although this will change in the future. This command is required.

nFileBufs n tells ref2ew to save raw RefTek packets per file. If you don't want to save raw RefTek packets, set n to zero. This command is required.

DirPath directory specifies the directory in which raw RefTek packets will be saved. This command is required if nFileBufs is non-zero; otherwise it is ignored.

Standard Earthworm Commands

RingName ring specifies the earthworm transport ring to which ref2ew sends its output messages. Normally this will be the WAVE_RING. This command is required.

MyModuleId modid sets the module ID for this invocation of ref2ew . Module ID's are found in earthworm.d . This command is required.

LogFile n sets the diagnostic logging flag to n . Use 1 to cause ref2ew to write its log to disk, 0 for no logging. This command is required.

HeartBeatInt n specifies the heartbeat interval in seconds. This command is required.

DISCUSSION

RefTek packets from a Terra Technology strong-motion instrument include a 24 byte header and 250 4-byte data samples. With the sample rate set to 100 samples per second, one of these packets will be delivered every 2.5 seconds for each channel on the instrument. When these packets are converted to Earthworm wave trace packets, the RefTek header is replaced by the 64-byte Earthworm header. Thus the wave trace packets are 1064 bytes in length.

SEE ALSO


Passcall RefTek manual, Earthworm documentation.

BUGS AND CAVEATS

AUTHOR


Pete Lombard
University of Washington

Earthworm provided by Alex Bittenbinder, Barbara Bogaert,
Lynn Dietz, and Will Kohler of the US Geological Survey,
Menlo Park, California



Contact: Pete Lombard,
Questions? Issues? Subscribe to the Earthworm Google Groups List.