\section{Overview}
-Currently, there are three main software tools for accessing TrbNet: trbcmd,
-trbflash and daqop. All are based on one common library, libtrbnet, that
-provides all features needed to communicate with any FPGA inside the network
-using the ETRAX CPU located on a central slow control TRB.
+Currently, there are two main software tools for accessing TrbNet: trbcmd,
+trbflash. All are based on one common library, libtrbnet, that
+provides all features needed to communicate with any FPGA inside the network.
\begin{description}
\item[trbcmd] A general purpose tool to execute every possible access on
TrbNet endpoints. Scripting capabilities and verbose error messages are
included.
- \item[daqop] A command line tool which accepts keywords as options and
-executes the corresponding TrbNet accesses without having the user to bother
-with network and register addresses.
\item[trbflash] A specialized tool to write, read and verify Flash ROMs used
to boot FPGAs. Currently, MDC OEP and RICH ADCM are supported, Shower AddOn
and MDC AddOn will follow.
- \item[trb\_i2c] A specialized tool to access the RICH ADCM I2C controller used
-for APV frontend card configuration. It is tailor made for APV preamp chips,
-but can be simply adjusted in VHDL to fully comply with a single I2C master.
- \item[trbrichcmd] A specialized tool for RICH ADCM features. It allows
-reading the serial numbers of frontend card and backplanes, and controls
-the internal logic analyzer for ADC data.
- \item[readout\_mdc] Simulates the CTS using a TRB by sending first a pseudo
-timing trigger via slow control, then a LVL1 trigger and finally an IPU
-readout request. Data is sent via UDP to an Eventbuilder. Primarily written
-for MDC, but should be compatible to other detectors as well.
\item[startup.pl] Executes script files to load many registers during
startup or for reconfiguration.
+ \item[hadplot] Tool to make very simple gnuplot plots of arbitrary registers
+ \item[logger] A central logfile is used to keep information from all important actions of the operator
\end{description}
-% \section{DaqOp}
-% \begin{itemize}
-% \item Commands use standard notation like (a|b|c) for choices, (a)? for
-% optional parts and \$ab for placeholders.
-% \item Most output is ordered by the network address
-% \item If no address is given, command is sent to all boards using a
-% broadcast (Unless specified otherwise)
-% \item The order of keywords and values in the command is arbitrary. Only in
-% few places the order is relevant. \verb|$channel| and \verb|$port| must
-% always directly follow their corresponding keyword.
-% \item Some commands can be modified by one of the keywords \verb|dec|,
-% \verb|decimal|, \verb|hex| or \verb|raw|. \verb|hex| forces the output in
-% hexadecimal form, \verb|dec| in decimal form and \verb|raw| gives the raw
-% content of the addressed registers.
-% \end{itemize}
-%
-% Placeholders are defined as follows:
-% \begin{description}
-% \item[\$addr] TrbNet address, 16bit long, preceded by \verb|ax| prefix in
-% the form, example: \verb|ax1234| or system name (\$system)
-% \item[\$channel] A value identifying a TrbNet channel. Usually either 0,1
-% or 3. Verbose names trigger, ipu, control can also be used.
-% \item[\$read] A keyword, one of \verb|read| and \verb|get|
-% \item[\$port] A value identifying one port of a hub. Usually a number
-% between 0 and 12.
-% \item[\$select] A keyword, one of \verb|select|, \verb|set| and \verb|switch|
-% \item[\$string] Any string of characters
-% \item[\$system] A keyword identifying a subsystem: \verb|hub|, \verb|oep|,
-% \verb|rich|, \verb|tof|, \verb|shower|, \verb|rpc| or an \$addr
-% \item[\$value] An integer value, either hexadecimal (\verb|0x1234|), a bit
-% position (\verb|0b5|, the sixth bit in the register) or a decimal value)
-% \item[\$write] A keyword, one of \verb|send|, \verb|set| and \verb|write|
-% \end{description}
-%
-% \subsection{Network Management}
-% \paragraph*{reset network \\ \$write hub port \$port reset \$addr} ~\\
-% Sends a network reset through the network. Either all boards or all boards
-% connected below the given board respectively the given port will receive the
-% reset. Note that the first works in all cases, but the latter two require a
-% still working slow control channel. The reset phase is dominated by the delay
-% in the optical link state machines which are around 5 seconds.
-%
-% \paragraph*{\$read ids} optional: \verb|$addr| \\
-% Reads the unique ids of boards with the given address. The first value
-% returned is the network address, the second the 64bit wide unique id, the
-% last the FPGA number.\\
-% Example output: \verb|0xf102 0x120000011234234 0x02|
-%
-% \paragraph*{reboot \$system} optional: \verb|$addr| \\
-% Triggers a reboot of the addressed FPGA. Only available on systems with
-% on-board Flash ROM such as OEP, MDC, RICH and Shower.
-%
-%
-% \subsection{Basic Information}
-% \paragraph*{\$read compile time} optional: \verb|$addr|, \verb|raw| \\
-% Reads the timestamp the currently loaded FPGA design has been compiled. The
-% \verb|raw| modifier gives back the unix timestamp, standard is a decimal
-% representation. \\
-% Example output: \verb|0xf102 2010-01-01 10:32|
-%
-% \paragraph*{\$read temp \\ \$read temperature} optional: \verb|$addr|,
-% \verb|raw| \\
-% Reads the temperature of the addressed boards. Output is in degrees Celsius
-% (standard) or in raw hexadecimal format.
-%
-% \subsection{Trigger}
-% \paragraph*{\$read global time \\ \$write global time \$value} optional:
-% \verb|$addr|, \verb|dec|, \verb|raw| \\
-% Reads or writes the global time register on the addressed boards. The
-% \verb|dec| option gives back a decimal representation in seconds, raw is a
-% hexadecimal representation of microseconds since the timer has been started.
-% An overflow will occur every 72 minutes.
-%
-% \paragraph*{\$read trigger time} optional: \verb|$addr|, \verb|dec|,
-% \verb|raw| \\
-% Equivalent to \verb|$read compile time| but gives back the time since the
-% last timing trigger has been received, counting in 10ns steps. An overflow
-% will occur within less than a minute.
-%
-% \paragraph*{\$read trigger number \\ \$write trigger number \$value}
-% optional: \verb|$addr|, \verb|dec| \\
-% Reads or writes the internal trigger number counter on the addressed
-% endpoints. Output can be either hexadecimal (standard) or decimal.
-%
-% \paragraph*{\$write timing trigger \$value} optional: \verb|$addr| \\
-% Sends a fake timing trigger using the slow control channel and the upper
-% 16bit of control register 0 in all endpoints. \verb|$value| is the type of
-% timing trigger in the range 0 to 15.
-%
-% \paragraph*{\$read endpoint data buffer status \\ \$read endp dat buf stat}
-% optional: \verb|$addr|, \verb|raw| \\
-% Reads the status of the data handler buffers of endpoint\_hades\_full\_handler.
-% The decoded data is shown in table format with marks for each set bit
-% according to table \ref{databufferdaqop}.
-%
-% \begin{table}[htbp]
-% \begin{center}
-% \begin{tabularx}{\textwidth}{|c|C|}
-% \hline
-% \textbf{Column} & \textbf{Description} \\
-% \hline\hline
-% Board & The network address of the board. \\
-% Level & The fill level of the buffer - a 5 digit decimal number counting
-% 32bit words inside the data buffer. The maximum value depends on the settings
-% of the buffer. \\
-% Buf & The number of the data buffer in case there is more than one data
-% buffer specified. \\
-% EMP & Empty flag of the buffer. \\
-% AFL & Almost full flag of the buffer. The threshold has been set by generics
-% in the VHDL code. \\
-% FUL & Full flag of the data buffer. If this flag is set, an error occured
-% due to a wrong buffer handling or wrong buffer settings. \\
-% WRE & Write enable strobe to the buffer. \\
-% IDL & Buffer handler state machine is idle, waiting for next trigger. \\
-% BSY & Buffer handler state machine is waiting for and / or writing data from
-% the FEE to the data buffer \\
-% CLS & Buffer handler is waiting for busy release. The FEE already finished
-% writing data to the buffer but LVL1 is still busy \\
-% LEM & Length buffer is empty. This must always be the same as EMP of the
-% LVL1 buffer. \\
-% LFL & Length buffer is almost full. This must always be the same as AFL of
-% the LVL1 buffer. \\
-% LWR & Length buffer write enable strobe. This must always be the same as
-% AFL of the LVL1 buffer. \\
-% \hline
-% \end{tabularx}
-% \caption{Definition of columns in DaqOp output for the status register of data
-% handler buffers.}
-% \label{databufferdaqop}
-% \end{center}
-% \end{table}
-%
-% \paragraph*{\$read endpoint lvl1 buffer status \\ \$read endp lvl1 buf stat}
-% optional: \verb|$addr|, \verb|raw| \\
-% Reads the status of the data handler LVL1 buffers of
-% endpoint\_hades\_full\_handler. The decoded data is shown similarly to the
-% output for the data buffer status registers according to table
-% \ref{databufferdaqop}. Here, not all columns are shown, i.e. there is no
-% buffer number and no flags regarding a length buffer (which does not exist
-% here).
-%
-%
-% \subsection{MDC}
-%
-% \paragraph*{\$read flash oep } optional: \verb|$addr| \\
-% Reads back the current status of the Flash select switch on the OEP. Value is
-% either 1 for flash 0, 2 for flash 1 or 3 in case of an error.
-%
-% \paragraph*{\$select flash (0|1) oep} optional: \verb|$addr| \\
-% Selects either Flash chip 0 or 1 on the OEP. 0 is the ``golden image'', 1 is
-% the working setup.
-%
-% \paragraph*{adc oep (init|on|off|single)} optional: \verb|$addr| \\
-% Sets the operation mode of the voltage monitoring ADC on the OEP. \\
-% \verb|init| Initializes the ADC, switches it on and starts continous
-% conversions.\\
-% \verb|on| Switches the ADC on and starts continous conversions.\\
-% \verb|off| Stops ADC measurements.\\
-% \verb|single| Runs a single conversion for all 8 monitored voltages,
-% then switches off the ADC.\\
-%
-% \paragraph*{\$read oep voltages (long)?} optional: \verb|$addr|, \verb|raw| \\
-% Reads the voltages of the addressed OEP. Standard output is a human-readable
-% status information. For each voltages, the status is shown as one of ``ERR''
-% (measurement error), ``ok'', ``low'', ``was low'' (voltage was too low, but
-% is ok now), ``high'', ``was high'' (voltage was too high, but is ok now),
-% ``high/low'' (voltage was too low and too high before, currently either too
-% high or too low) or ``vary/ok'' (voltage is ok now, but was too high and too
-% low before). The \verb|raw| option gives back the raw content of the register,
-% i.e. a list of 8 hexadecimal numbers for each board.
-% The long format gives back the exact voltage levels measured.
-%
-% \paragraph*{\$read oep voltage \$value} optional: \verb|$addr|, \verb|raw| \\
-% Reads the value of a single voltage on the addressed OEP. Additionally, the
-% lowest and highest measured value is shown. \verb|$value| is the voltage to
-% be shown, in the range of 0 to 7 according to the following list (voltages
-% are either on the measured on the input of the OEP (input) or after the
-% voltage regulator (output): (0: 5.6V input, 1: 5V output, 2: 3.5V input, 3:
-% 3.3V output, 4: 1.6V input, 5: 1.2V output, 6: +3V input, 7: -3V input).
-%
-%
-% \subsection{Shower}
-% \paragraph*{\$write shower pede(stals)? \$sector \$plane \$row \$column \$value} ~\\
-% Sets the pedestal value for the selected front-end channel on Shower. \$sector, \$row
-% and \$column have to be plain numbers, \$value is the desired pedestal setting in hex
-% notation. \$plane is one of "pre", "post1", "post2".
-%
-%
-% \subsection{Network Hubs}
-%
-% \paragraph*{\$read hub setup} optional: \verb|$addr|, \verb|raw| \\
-% Reads the uplink-/downlink-configuration of the addresses network hubs. The
-% output is two strings for either up- and downlinks. Each digit marks a
-% connection where that is configured as uplink respectively downlink or a dash
-% if this functionality is disabled. Ports that are listed in neither list do
-% not exist at all. The numbers themselves are inserted to gain a better
-% readability and represent the port number only.\\
-% Example output: \verb|0xf123 up: --------------10 down: -----a9876--3210|
-%
-% \paragraph*{\$read hub connected} optional: \verb|$addr|, \verb|raw| \\
-% Reads the current status of the hub, which ports are actually connected and
-% have a link established. The output format is similar to the one described
-% above. A dash marks an existing port without a connection, a number marks an
-% established link.
-%
-% \paragraph*{\$read hub timeout} optional: \verb|$addr|, \verb|raw| \\
-% Gives back information about hub ports on which a timeout occured. Standard
-% output is plain text: \\
-% Example output: \verb|Timeout on hub f123 channel 0 port 7| \\
-% The raw option gives the same information but as one 32bit value per channel
-% and board with one bit set for each port with a timeout.
-%
-% \paragraph*{\$read hub packets channel \$channel} optional: \verb|$addr|,
-% \verb|raw|, \verb|port $port| \\
-% Reads the amount of packets received on IPU and slow control channel on the
-% given hub and port or for all ports if no port number is given. The raw option
-% outputs one 32bit number for each channel.
-%
-% \paragraph*{\$read hub waiting (channel \$channel)?} optional: \verb|$addr|,
-% \verb|raw| \\
-% Shows all ports and channels on the addressed hubs that are currently waiting
-% for a reply (more precisely: waiting for a TRM in the reply channel). Although
-% channel can be chosen freely, the value read on channel 3 is accurate, but all
-% connected channels will always be marked as waiting. This is the case since
-% there actually is a transfer going on - namely this request itself. If no
-% channel is selected, information from all channels 0 and 1 is shown. The
-% output is either in plain text (standard) or in raw format.
-%
-% \paragraph*{\$read hub ack channel \$channel \\ \$read hub acknowledge
-% channel \$channel} optional: \verb|$addr|, \verb|raw| \\
-% Shows all ports and channels on the addressed hub that are blocked because the
-% sender is waiting for two acknowledge (ACK) packets from the receiver side for
-% too long. This kind of error usually corresponds to a broken communication,
-% e.g. mixed up TX and RX lines. If no channel is selected, information from all
-% 3 channels is shown. The output is either in plain text (standard) or in raw
-% format.
-%
-% \paragraph*{switch hub port \$port (channel \$channel)? \$addr (on|off)} ~\\
-% This command is used to switch a specific port on a specific channel on a
-% specific hub on or off. Switching one channel of a port off means, that no
-% request is sent on this port any more and no data is accepted on this port.
-% This command must be issued including all three pieces of information (namely
-% port, channel and address), otherwise it will return an error ``Parsing input
-% failed.'' for security reasons. Please be adviced that it is no good idea to
-% switch off the uplink of any hub! If this happens, a network reset is
-% inevitable.
-% If \verb|channel $channel| is not specified, the whole port will be powered
-% down. Currently, this feature is not correctly implemented.
-%
-% \paragraph*{\$read hub error(bits)? \\ \$read hub error(bits)? channel
-% \$channel} optional: \verb|$addr| \\
-% Reads the merged status- and errorbits from the last transfer from the
-% addressed hub. If no channel is specified, all channels are read out. The
-% output is one 32bit data word according to the corresponding status- and
-% errorbit definitions.
-%
-% \paragraph*{\$read hub error(bits)? ports \\ \$read hub error(bits)? port
-% \$port} optional: \verb|$addr|, \verb|raw| \\
-% Reads some error- and statusbits from all ports or the selected port from the
-% addressed hub. Included are parts of the errorbits from LVL1 and IPU channel.
-% For each channel, Bits 0-7 and 16-23 are included while the rest is omitted
-% to reduce ressource consumption. The standard output shows the bits in the
-% right positions while the raw output shows the bits merged into one value.
-%
-% \paragraph*{\$read hub ipu stat(us|e)} optional: \verb|$addr|, \verb|raw| \\
-% Reads the current status of the IPU state machine from the addresses hubs. The
-% standard output gives a description of the current state, the part of TrbNet
-% packet that will be sent next and the part of the HDR/DHDR that is currently
-% analyzed.
-%
-% \paragraph*{\$read hub ctrl error} optional: \verb|$addr|, \verb|raw| \\
-% Reads the error log for the slow control on hubs. One bit for each port. 1 if
-% there was a transfer with either error bit 1, 3 or 6 set, 0 otherwise. Cleared
-% after each read.
-%
-% \paragraph*{\$read hub time limit \\ \$write hub time limit \$value }
-% optional: \verb|$addr|, \verb|raw| \\
-% Reads or writes the setting for timeouts on hub ports. For details see the
-% entry for register 0xC5 in \ref{hubcontrolregs}.
-%
-% \subsection{CTS}
-% \paragraph*{cts \$read trigger box \\ cts \$write trigger box (on|off)}~\\
-% Switches the trigger box functionality of the CTS on or off, respectively reads
-% the current status.
-%
-% \paragraph*{cts \$read inputs \\ cts \$read outputs}~\\
-% Gives back a full list of enabled inputs and enabled outputs. Output is raw
-% in both hexadecimal and binary view as well as clear-text with the usual input names.
-%
-% \paragraph*{cts \$write input INPUT (on|off)}~\\
-% Enables or disables the given input or multiplicity trigger in the CTS. Allowed
-% input names are: start0 -- start7, veto0 -- veto7, tof1 -- tof6, rpc1 -- rpc6,
-% phys1 -- phys4 to enable a single input. start, veto, tof, rpc, phys enable the
-% full block of inputs of one type. For start and veto inputs, the corresponding
-% input to the ouput mux is also enabled.
-%
-% \paragraph*{cts \$write MULT (on|off)}~\\
-% Enables or disables the given multiplicity output of the multiplicity logic.
-% Available options are: mult1, mult2, mult3, mult4, mult5, mult6, mult2nn,
-% mult3nn, mult2opposite. "nn" means "no neighbour" and "opposite means opposite
-% sectors. The status of the multiplicity triggers are read using the read inputs
-% command.
-%
-% \paragraph*{cts \$read scaler}~\\
-% Reads the 32 scalers of trigger inputs and shows them including the clear-text
-% names of each input.
-%
-% \paragraph*{cts \$write pulser rate \$value}~\\
-% Sets the internal pulser to the given value. Allowed values are 0 -- 7. The
-% resulting trigger rate is also shown.
-%
-% \paragraph*{cts \$write pulser (on|off)}~\\
-% Switches the internal pulser on or off.
-%
-% \paragraph*{cts \$read pulser}~\\
-% Outputs the current status of the internal pulser.
-%
-% \paragraph*{cts \$write shower calib (on|off) \\ cts \$write shower pedestal
-% (on|off) \\ cts \$write mdc calib (on|off)}~\\
-% Switches on or off pedestal or calibration triggers for Shower and MDC.
-%
-% \paragraph*{cts \$read (calib|pedestal)}~\\
-% Reads the current status of calibration and pedestal triggers.
-%
-% \paragraph*{cts \$write antico(incidence) (on|off) \\ cts \$read
-% antico(incidence)}~\\
-% Sets or reads the status of the coincidence logic between start and veto inputs.
-%
-% \subsection{Other features}
-% \paragraph*{trbcmd \$string \\ trbflash \$string} ~\\
-% These two commands execute trbcmd or trbflash with the given string of
-% attributes.
-%
-% \paragraph*{watch \$float} ~\\
-% The watch option can be added to any command (depsite trbcmd and trbflash) to
-% execute the given command in an endless loop. The \verb|$float| value gives
-% the period in seconds.
-
-\section{trb\_i2c}
-\label{software_trb_i2c}
-
-trb\_i2c can only read or write one register with one 8bit value at a time.
-
-\noindent The following parameters are needed for access:
-
-\begin{description}
- \item[trb\_address] TRBnet address of RICH ADCM to be accessed. Broadcast
-access is supported.
- \item[chip] I2C bus address of the APV to be accessed. General call access
-is supported.
- \item[register] register address inside the APV chip.
- \item[value] only for write access: value to be written.
-\end{description}
-
-\noindent The APV I2C addresses are 0x20 -- 0x2f when being individually
-addressed (one ADCM connects to 15 APVs), or 0x3f when doing a general call
-access.
-
-\noindent APV register map can be found inside the APV manual.
-
-\noindent trb\_i2c usually is used once during configuration of the system to
-setup all APV internal registers. Please note that changing certain registers
-inside APV will make a new SYNC trigger mandatory to activate the changed
-settings. It is not recommended to play with that tool during beam.
-
-\subsection*{Reading data from APV}
-
-\paragraph*{trb\_i2c r 0x3000 0x20 0x05} ~\\
-This command reads register 0x01 from APV on I2C address 0x20 on ADCM module
-with TRBnet address 0x3000 (i.e. sector 0, most inner ADCM, APV FE number 0).\\
-This register shows the currently used LATENCY.
-
-\paragraph*{trb\_i2c r 0xfffb 0x3f 0x01} ~\\
-This command reads on all connected ADCMs (RICH broadcast) all connected APVs
-(I2C general call) the contents of register 0x01 (ERROR).\\
-Output is wired-and due to I2C bus signaling, so reading error bits from all
-APVs in a shot is not possible due to a design bug inside the APV.
-
-\subsection*{Writing data to APV}
-
-\paragraph*{trb\_i2c w 0xfffb 0x3f 0x04 11} ~\\
-This command sets the LATENCY of all APVs inside the RICH subsystem to 11.
-RICH broadcast and I2C general call is used.
-
-\section{trbrichcmd}
-\label{software_trbrichcmd}
-
-\textbf{trbrichcmd} allows accessing some special features of the RICH ADCMv3.
-
-\paragraph*{trbrichcmd uid trb\_address} ~\\
-This command reads the UniqueIDs of the backplane and APV frontends connected
-to one ADCM. As these IDs are not constantly updated by the FPGA, this command
-must be released twice. The first call will read the IDs from the 1Wire
-chips, the second call will deliver the data read in the access before.
-
-\noindent Due to the long access times on 1Wire, and not to disturb frontend
-operation, continously updating this information automatically is not possible.
-
-\noindent Failures on 1Wire readout (no presence pulse) are sensed; not
-connected sensors are marked with dashes in the result list.
-
-\noindent The first 15 sensor IDs correlate to the APV frontends, the 16th ID
-is read from the backplane.
-
-\paragraph*{trbrichcmd }
-
-To be written~$\ldots$
-
-\section{trb\_flash}
-\label{software_trbflash}
-
-This piece of software allows you to read, erase, program and verify the boot
-FlashROMs on different boards in the system. Not all boards feature such
-FlashROMs.
-
-\noindent \textbf{trb\_flash} offers are nice help page, if you start it
-without arguments.
-
-\noindent If you feel uncomfortable with this short help page, then it may be
-a wise decision to ask your local hardware expert for help before trying out
-some things on your own.\\
-\textbf{trb\_flash} has been written with many safety features to avoid the
-wrong bitfile to be written into the wrong module, but still you can screw up
-some things if you try hard enough.
-
-\noindent \textbf{You have been warned.}
-
\section{HadPlot}
HadPlot is a perl script that plots essentially every register available somewhere in the DAQ network in various forms. There are predefined settings that can be loaded, or the user can specify any register and way to display the data. The full syntax is:
\item One can zoom into the plots by drawing a rectangle with the right mouse button. Pressing 'p' reverts to the former zoom level.
\end{itemize}
-% \subsection{Common Options}
-% There are a few common options that can be used with any command:
-% \begin{description}
-% \item[-d delay] Sets the update interval with which the selected registers are read out. The value is given in milliseconds.
-% \item[-n samples] For histograms only. Selects how many samples should be kept in the history.
-% \item[-o downscaling] For histograms only. Selects how often the plot should be updated. If set to 2, the plot is refreshed only after each second register reading.
-% \item[-z style] Some plots provide different style settings. The selection is made by a numeric value. The description is given for each plot individually.
-% \item[-g geometry] Gives the geometry of the plot window in standard X notation.
-% \\\verb!-g 640x480+50+200!
-% \\This produces a window in VGA size, placed 50 pixel from the left and 200 pixels from the upper display border. By adding quotation marks around the argument, one can also give other X settings to gnuplot, e.g.
-% \\\verb!-g "640x480+50+200 -bg 'yellow' -fg 'blue'"!
-% \\This will set the background color to yellow and the font color to blue.
-% \item[-c windowtitle] Sets the title of the window. The given string will be put to the title bar of the plot window.
-%
-% \end{description}
-%
-%
-% \subsection{User Defined Plots}
-% \begin{description}
-% \item[-a address] The address of the board(s) from which the data should be read
-% \item[-r register] The register address from which the data will be read
-% \item[-w width] Width of the value in bits. Used if one register contains more than 1 value
-% \item[-p offset] Offset of the value in bits. Used if one register contains more than 1 value
-% \item[-t title] Title of the data set to be shown in the keys of the plot
-% \end{description}
-% E.g. \verb!-w 12 -p 10! takes a value from Bits 21..12 from the given register. All options a/r/w/p are mandatory, only the title can be left blank. In that case, the information from a/r/w/p is shown in the key. There might be more than one set of options a/r/w/p/t to plot more than one set of data in one window.
-%
-% These are the possible \verb!plotname!s for user defined plots:
-% \begin{description}
-% \item[genreg] Plots the values from the selected register. The x-axis shows the boards, the y-axis the value read from the given board. The \verb!-z style! option selects the labels for the x-axis: 0 shows numbers, 1 displays the actual board addresses for every data point. Please note, that the display of board addresses is usually not readable in the full view but can be used to identify boards when zooming into the plot.
-% \item[genregdiff] The same as genreg, but plots only the differences in register values between the current and the last reading. The available styles are:
-% \begin{description}
-% \item[0] Plots the values as data points
-% \item[1] Same as 0, but with address labels on the x-axis
-% \item[2] Plots a bargraph of the values. If more than one data set is shown, the bars are placed next to each other
-% \item[3] Same as 2, but with address labels on the x-axis
-% \item[4] Plots a bargraph of the values. If more than one data set is shown, the bars are placed on top of each other
-% \item[5] Same as 4, but with address labels on the x-axis
-% \item[12,13] The same as 4,5, but the values are assumed to be time in microseconds. The upper limit is fixed to the value defined by the delay setting and the readings show time in milliseconds.
-% \end{description}
-% \item[genhist] To be implemented. Plots a history of a register value. If the address is a broadcast and answers from multiple boards are received, the plotted value is the sum of all values.
-% \item[genhistdiff] The same as genhist, but shows only the relative changes to the registers. (Already implemented)
-% \end{description}
-%
-% \subsection{Predefined Plots}
-% For predefined plots the syntax is as follows:
-% \\\verb!hadplot [-d delay] [-n samples] [-o downscaling] [-z style] plotname!
-% The default values for the settings vary depending on the selected plot. They can always be overwritten by hand. The available plots are
-% \begin{description}
-% \item[timerate] A histogram of datarates with -s the user can select one of the following systems: all, shower, mdc, tof
-% \item[eventrate] Histogram of the trigger rate
-% \item[busy] A bargraph with the current busy times of the eight major parts of the system
-% \item[busytime] Histogram of the busy time. Eight major parts of the detector are shown
-% \item[filllevel] The fill level of all front-end data buffers
-% \item[oepfill] The fill level of the OEP data buffers
-% \item[showerfill] The fill level of the Shower data buffers
-% \item[oepretrrecv] Number of received retransmission request per OEP
-% \item[oepretrsent] Number of sent retransmission request per OEP
-% \item[oepretr] Combined plot of retransmission requests sent and received by each OEP
-% \item[oepretrhist] Combined histogram of retransmission requests sent and received
-% \item[oepspike] Number of spikes on the CMS input of OEP
-% \item[oepspikehist] Histogram of number of spikes per interval on all OEP
-% \item[oepmulttrg] Number of multiple triggers detected per OEP
-% \item[oepinvtrg] Number of invalid triggers detected per OEP
-% \item[oepspurtrg] Number of spurious trigger detected per OEP
-% \item[oeptrgerr] Combined plot of multiple, invalid and spurious triggers and spikes on CMS for each OEP
-% \item[oeptrgerr] Combined histogram for multiple, invalid and spurious triggers and spikes on CMS
-% \item[oepworktime] Bargraph of the time the OEP spends in different states of the trigger handler:
-% \begin{description}
-% \item[Init] Settings are loaded to TDC and the MBO is initialized
-% \item[Calib] Settings to take calibration data are being loaded
-% \item[Readout] Time between sending the token to the MBO and getting it background
-% \item[Waiting] Time the handler is waiting, e.g. waiting while data buffers are almost full
-% \item[Idle] The rest of the time. Includes the time, the endpoint trigger handler is waiting for the LVL1 trigger information.
-% \end{description}
-% \item[oeptemp] The temperature of all OEP
-% \item[oepretransmit] Number of retransmits for each OEP
-% \item[oepdatarate] Datarate for each OEP
-% \item[oep5V] Voltage monitor for 5V input and regulated 5V on OEP
-% \item[oep3.3V] Voltage monitor for 3.3V input and regulated 3.3V on OEP
-% \item[oep1.2V] Voltage monitor for 1.2V input and regulated 1.2V on OEP
-% \item[oep3V] Voltage monitor for +3V and -3V input on OEP
-%
-% \end{description}
-
\section{Logger}
All monitoring tools are supposed to write important messages to the central logile.
\\\verb!logger -p local1.info -t DAQ $message!
\\Message should follow the general rule that it starts with a system identifier with few letters (like DAQ, EB, MDC...). Then a padding to add up to 10 characters including the identifier. The type of message is specified by <I>,<W>,<E> for information, warning or error messages respectively. This defined part is then followed by the message.
-All log messages are written to one central file on lxhadesdaq: \verb!/home/hadeslog/messages!.
\ No newline at end of file
+All log messages are written to one central file on lxhadesdaq: \verb!/home/hadeslog/messages!.
jspc29 / daqdocu.git / commitdiff