lib/currValTable/README

Go to the documentation of this file.

################################################################################
#  README for the CurrValTable subpackage of the LICOS project
#  Author: Jim Panetta 
#
#  This file is intended to be processed by doxygen.
#
#  $Id: $
#
################################################################################



/*! \page current_value_table GLAST LICOS Current Value Table subpackage
   

\section introduction Introduction

This sub package contains a set of python classes for support of and access to the 
LICOS Current Value Table (CVT)

\section definitions Definitions and Acronyms
\li \c CV  Current Value (object)
\li \c CVT current value table (object)
\li \c CCSDS A NASA data transfer protocol
\li \c VSC The Virtual SpaceCraft interface
\li \c observer  A client that "observes" a CV.  
       When a CV is updated, each \c observer is notified of the update asynchronously.
\li \c requestor A client that "requests" a CV.  This request is synchronous.


\section protocol TCP protocol

All messages are based on a simple TCP protocol.
\li Messages are INT16-strings: strings preceded with a 16 bit ushort length \n
    \b Note: This gives an inherent limit to the length of a message of 64k.
\li Messages to the server are in plain text and are of the format <keyword> [<arguments>]
\li Messages from the server are typically binary strings with a 3 character keyword
    prepending.  Ex;  "up ........." indicates an update of a CV of some sort.

\section files Files and Applications

\li \c CurrValServer.py 
    Implements the base current value table service and protocol as well as a server for testing\n
    (Classes \ref CurrentValueFactory, \ref CurrentValueProtocol)\n
    \n
    Usage:  python CurrValServer.py --pktFile packet.out --cvtPort 39800

\li \c CurrValClient.py 
    Implements the base current value table client (\e observer protocol) as well as a base client for testing\n
    (Classes \ref CurrValClientFactory, \ref CurrValClient)\n
    \n
    Usage:  python CurrValClient.py --cvtHost localhost --cvtPort 39800

\li \c CvtTesterImpl.py
    Implements a test CVT client (\e observer protocol) to display individual telemetry
    values with engineering unit conversions.\n
    \n
    Usage:  python CvtTesterImpl.py --cvtHost localhost --cvtPort 39800 --pktList "LHKADAB33V,LHKADABTEMP"
   

\li \c ScriptClient.py  
    Implements the base current value table client (\e requestor protocol) 
    as well as a base client for testing\n
    (Classes \ref ScriptClient)\n
    \n
    Usage:  python ScriptClient.py --cvtHost localhost --cvtPort 39800

\li \c VscCvt.py        
    Implements the connection of the CVT to the VSC/spacecraft\n
    The file vsc.cfg is in LICOS_ETC and is a template
    \n
    Usage:  python VscCvt.py --vscHost lat-elf2 --config vsc.cfg







\section classdiag Classes

\subsection CurrentValueFactory CurrentValueFactory
\subsection CurrentValueProtocol CurrentValueProtocol
\subsection CurrValClientFactory CurrValClientFactory
\subsection CurrValClient CurrValClient
\subsection ScriptClient ScriptClient



















*/

---