diff --git a/doc/DaqPartUse.dox b/doc/DaqPartUse.dox new file mode 100644 index 0000000000000000000000000000000000000000..f679bbd90e83c98d947aec30497e35d89277599b --- /dev/null +++ b/doc/DaqPartUse.dox @@ -0,0 +1,16 @@ +/*! \page DaqPartUse RCG DAQ Part + +\section Function +The function of this part is to define model channels that are to be sent to the DAQ system for data storage. + +\image html daqPart.png DAQ Channel Definition Block + +\section Usage +This part may be placed at any level within an RCG model. Entries must be made as: +ChannelName AcquisitionRate +\section Operation +During the code installation process, these channels will be set within the MODELNAME.ini file to acquire data \n +at the desired rate. This file is used by both the RT runtime code and the DAQ system to determine which channels \n + are to be recorded and at what rate. Presently, all values are stored by the DAQ as 32 bit floating point numbers. + +*/ diff --git a/doc/daqPart.png b/doc/daqPart.png new file mode 100644 index 0000000000000000000000000000000000000000..9b8a67c8a62fff114e7883cba9e19ab304c2b42c Binary files /dev/null and b/doc/daqPart.png differ diff --git a/doc/rcgappdevguide.dox b/doc/rcgappdevguide.dox index 9e170c07049e84ce997edb0510adf3014cbdff24..412dd31b8994410f1d8dfe8050fefd27fcbfd396 100644 --- a/doc/rcgappdevguide.dox +++ b/doc/rcgappdevguide.dox @@ -9,29 +9,20 @@ The software produced by the RCG includes: \endverbatim -\section ug1 2.0 Document Overview -This document describes the means to develop a user application using the RCG. It contains the following sections: \n \n - • Reference Section (3): The RCG produces software which integrates with various other components of CDS software. In addition, there are various files and services which must be configured prior to code operation. These items are covered under separate documentation, listed in the reference section. \n - • RCG Overview (4): Provides a brief description of the RCG, its components and resulting code threads. \n - • Application Development (5): Provides the basics for developing an application using the RCG. \n - • Software Execution (6): Describes how to start and stop the software application. \n - • RCG Software Parts Library (7): Describes the various components supported by the RCG. \n -\n -\section ug17 3.0 References +\section ug17 2.0 References Additional RCG design overview documentation can be found at the following links:\n <a href="https://dcc.ligo.org/LIGO-T080135-v5">LIGO T080135 aLIGO CDS RCG Application Developers Guide in DCC</a> \n <a href="https://dcc.ligo.org/LIGO-T0900612-v2">LIGO T0900612 aLIGO CDS Design Overview</a> \n -\ref rcgSect4 "4.0 RCG Overview" \n -\ref rcgSect5 "5.0 RCG Application Development" \n -\ref rcgSect6 "6.0 Running the RCG Application" \n -\ref rcgSect7 "7.0 RCG PARTS LIBRARY" - -\section usg1 8.0 Scripting with kaTools -\ref KaTools "KaTools" - -\ref rcgsg2a "Runtime Overview" +\section ug1 3.0 Document Overview +This document describes the means to develop a user application using the RCG. It contains the following sections: \n \n + • \ref rcgSect4 "4.0 RCG Overview": Provides a brief description of the RCG, its components and resulting code threads. \n + • \ref rcgSect5 "5.0 RCG Application Development": Provides the basics for developing an application using the RCG. \n + • \ref rcgSect6 "6.0 Running the RCG Application": Describes how to start and stop the software application. \n + • \ref rcgSect7 "7.0 RCG PARTS LIBRARY": Describes the various components supported by the RCG. \n + • \ref KaTools "8.0 Scripting with KaTools": Preliminary doc on synchronous scripting tools. \n +\n */ diff --git a/doc/rcgappdevsect7.dox b/doc/rcgappdevsect7.dox index 3742a580e8a0178ac73d6068f61a14c7bebd9d74..ce5240dfa1b1d22fe6068f56345fed649e97211e 100644 --- a/doc/rcgappdevsect7.dox +++ b/doc/rcgappdevsect7.dox @@ -10,7 +10,7 @@ The CDS_PARTS.mdl file, supplied with the RCG code checkout, provides all parts - \ref rcgSect76 "Oscillator/Phase Shifter Components" - \ref rcgSect77 "Watchdog Components" - \ref CcodeUse "User Defined C Code Modules" - - \ref DaqChanUse "DAQ Channels" + - \ref DaqPartUse "DAQ Channels" \image html CDS_PARTS.png "RCG Parts Library" */