CRaTER -- CCmd

NAME

CArchive, CCmd, CData, CHouse, CStatus, CWeb -- Common High Level CRaTER Utilities

    CArchive    -- starts an archive file
    CCmd        -- starts the command.tcl window
    CData       -- starts a primary science data stream to STDOUT
    CHouse      -- starts the house.tcl window
    CPrint      -- prints a single page of data (Analog Housekeeping by default)
    CQuery      -- returns a list of all current user data streams
    CStatistics -- displays statistics of primary science stream
    CWeb        -- generates a web page of SecScience and Housekeeping info

USAGE

    CCmd [-h] [-L] [-v] [crater_gse_host] [-f base] \
         [-n samples] [-t ##] [100|120|121|122|123|124|125] [-z flags]

FLAGS

    -h   prints full help message
    -L   assumes localhost is the GSE
    -f   optional basename for CArchive only
    -n   set number of samples used by CStatistics
    -P   increment port numbers to talk to pdist
    -t   time limit for CArchive (in minutes)
         refresh interval for CWeb
    -u   displays time in UTC [local timezone]
    -v   provides verbosity
    -z   passes following flags on to rtlm (CArchive, CData only)

DESCRIPTION

This program resides in the directory as CCmd; all of the other program names are simply aliases.

The name of the CRaTER GSE host can be specified on the command line, either explicitly or through use of the -L flag. If neither of these are invoked, the program will look for the environment variable CRATER_GSE. If none of these succeed, the program will exit with an error message. The program will contact the GSE host for a UDP channel allocation and use the returned number to start a instance of rtlm.

Optional numeric arguments [100 120 121 122 123 124 125] explicitly choose the AppIds to be included in the data stream.

The CArchive command will generate a time-stamped basename for the telemetry archive file if none is provided. All AppIds will be included in the archive by default.

The CCmd invokes command.tcl with the appropriate parameters. command.tcl itself starts an input pipeline of rtlm followed by calcurve. Its output is piped to bcmd to send commands back to the GSE.

The CData command prints its ASCII data to STDOUT; by default all AppIds are processed.

The CHouse invokes house.tcl with the appropriate parameters. house.tcl itself starts an input pipeling of rtlm followed by calcurve.

The CStatus command reports back all current users of the GSE telemetry handler.

The CStatistics command reports the mean, one sigma variation, min observed amplitude and max observed amplitude in each selected number of samples of the primary science events (1000 events by default).

The CWeb command starts an input pipeline of rtlm and calcurve to feed c_monitor, which does the work of actually generating the web page. Note that this HTML will appear as ``index.html'' in the directory from which CWeb was invoked. A web browser -- which must be separately invoked (e.g.: firefox index.html) -- looking at this page will be instructed to refresh every 8 seconds unless the -t flag is given.

ENVIRONMENT

    perl5.6       Minimum version of Perl interpreter required
    CRATERTOOLS   Environment variable containing path to CRaTER utilities
    CRATER_GSE    Environment variable containing EGSE machine name

BUGS

We attempt on exit to contact the GSE and close the telemetry pipeline; if this process fails for some reason, the GSE will continue pumping out data on the assign UDP socket.

SEE ALSO

High Level programs CLog, CNoise, CQuery

Low Level programs

bcmd, calcurve, c_monitor, rtlm, tincan, statistics, verify, command.tcl, house.tcl

AUTHOR

Bob Goeke

RCS Information

$Id: CCmd,v 1.26 2008/09/15 18:51:53 goeke Exp goeke $