2.24 sddspvaglitchlogger

• description: sddspvaglitchlogger monitors EPICS PV Access process variables and logs values whenever configured trigger or glitch conditions occur. An input SDDS file lists the PVs to read and optional trigger parameters; a separate trigger file may be provided to define the triggers. Data are written to files in the given directory or using a supplied rootname.
• examples: The following command monitors PVs listed in pvlist.sdds for one day with a one minute sample interval.
  sddspvaglitchlogger pvlist.sdds logs -sampleInterval=60 -time=24,hours

• synopsis:
  usage: sddspvaglitchlogger <input> <outputDirectory>|<outputRootname>  
         [-triggerFile=<filename>] [-lockFile=<filename>[,verbose]]  
         [-sampleInterval=<secs>] [-time=<value>[,<units>]]  
         [-circularBuffer=[before=<number>,][after=<number>]]  
         [-delay=<steps>] [-holdoffTime=<seconds>] [-autoHoldoff]  
         [-pendIOtime=<value>]  
         [-inhibitPV=name=<name>[,pendIOTime=<seconds>][,waitTime=<seconds>]]  
         [-conditions=<filename>,{allMustPass|oneMustPass}]  
         [-verbose] [-watchInput]  
         [-runControlPV=string=<string>,pingTimeout=<value>]  
         [-runControlDescription=string=<string>]

• files:
  • input file:

    SDDS file defining the PVs to log. Required columns include ControlName, ReadbackName, ReadbackUnits, Provider, ExpectNumeric, ExpectFieldType and ExpectElements. When no trigger file is supplied, parameters such as OutputRootname, TriggerControlName, and optional threshold and alarm values appear in the file.

  • trigger file:

    Optional SDDS file containing trigger definitions. Columns mirror the trigger-related parameters and may include GlitchScript to specify a command executed when a trigger fires.

• switches:
  • -sampleInterval=<real>[,<units>] — interval between readings.
  • -time=<real>[,<units>] — total logging time.
  • -circularBuffer=[before=<n>,][after=<n>] — samples to keep around triggers.
  • -delay=<steps> — delay reading after a trigger.
  • -holdoffTime=<seconds> — wait time after a trigger before enabling new triggers.
  • -autoHoldoff — set holdoff time based on post-trigger samples.
  • -pendIOtime=<value> — maximum time to wait for PV replies.
  • -inhibitPV=name=<name>[,pendIOTime=<seconds>][,waitTime=<seconds>] — inhibit logging when this PV is nonzero.
  • -conditions=<file>,allMustPass|oneMustPass — require limits to be satisfied before logging.
  • -triggerFile=<file> — read trigger definitions from a separate SDDS file.
  • -lockFile=<file>[,verbose] — prevent multiple instances.
  • -watchInput — reload input files if they change.
  • -runControlPV=string=<name>,pingTimeout=<value> — run-control PV.
  • -runControlDescription=string=<text> — run-control description record.
  • -verbose — print messages while running.
• see also:
  • sddsglitchlogger()
  • sddsmonitor()
• author: Hairong Shang, ANL/APS.