readout config options...
readout cget ?pattern?
readout help
readout add module-name1 ?module-name2...?
readout list ?pattern?
readout remove module-name
The readout command is actually a module type that provides the top level list of things to read. It maintains an ordered list of modules. When a run starts, the modules are iterated through to initialize the system, prepare it for read, readout in response to triggers and so on.
readout is also implemented as a module type (see packet below). Used as such you can divide the readout into labeled packets and sub packets to any depth required.
the readout command supports options that provide the capability of wrapping the data read by its modules into an NSCL packet. An NSCL packet is a structure that consists of a header and a body. The header contains in order a 16 bit word count and a 16 bit type tag called an id. The configuration options that control this capability are shown below:
packetize boolean-value
Enables or disables wrapping the data in a packet.
This is false by default.
Set boolean-value to true
to enable packet wrapping.
id integer-value
Sets the packet id to use when packetize
is true. The value of this option
defaults to -1 which is deliberately
not suitable.
Since the readout command is a module command, it understands the config, cget and help subcommands documented by the module subcommands manpage.
In addition, in order to support the maintenance of the module list, readout defines some additional subcommands:
Each remaining command line work is the name of a module that was defined via the module command. These modules are appended in order to the list of modules the readout maintains.
Lists the modules (in order) maintained by the readout list. If the pattern is provided it is a string with glob wildcard characters that filters out the set of module names that are listed. If not provided the filter pattern is * listing all modules.
Removes the modle module-name from the list of modules maintained by the readout command. Note that this does not affect the order of the other modules in the list. For example: