2.25 sddspvalogger

• description: sddspvalogger connects to process variables over the EPICS7 PVA and CA protocols and logs the values to an SDDS file. The program supports conditional logging, data strobes, generation-based file rotation, and optional glitch capture.
• examples:
  sddspvalogger pvlist.sdds data.sdds -sampleInterval=1,seconds -steps=10

  where pvlist.sdds defines the PVs to monitor and data.sdds receives the logged values.

• synopsis:
  usage: sddspvalogger <inputfile> <outputfile>  
  Global Options:  
    [-pendIOtime=<value>]  
    [-watchInput]  
    [-monitorMode=[randomTimedTrigger]]  
    [-append | -overwrite]  
    [-sampleInterval=<real-value>[,<time-units>]]  
    [-dataStrobePV=<PVname>,<provider>[,notTimeValue][,holdoff=<seconds>]]  
    [-steps=<integer-value>]  
    [-time=<real-value>[,<time-units>]]  
    [-conditions=<filename>,{allMustPass|oneMustPass}[,touchOutput][,retakeStep]]  
    [-onerror={usezero|skip|exit}]  
    [-inhibitPV=name=<name>,provider=<provider>[,waitTime=<seconds>]]  
    [-generations[=digits=<integer>][,delimiter=<string>][,rowlimit=<number>][,timelimit=<secs>]]  
    [-dailyFiles[=rowlimit=<number>][,timelimit=<secs>][,timetag][,verbose]]  
    [-monthlyFiles[=rowlimit=<number>][,timelimit=<secs>][,timetag][,verbose]]  
    [-strictPVverification]  
    [-truncateWaveforms]  
    [-runControlPV=string=<string>,pingTimeout=<value>]  
    [-runControlDescription=string=<string>]  
    [-verbose]  
  Logger Options:  
    [-logInterval=<integer-value>]  
    [-flushInterval=<integer-value>]  
    [-onePvPerFile=<dirName>]  
  Glitch Logger Options:  
    [-triggerFile=<filename>]  
    [-circularBuffer=[before=<number>,][after=<number>]]  
    [-delay=<steps>] [NOT YET IMPLEMENTED]  
    [-holdoffTime=<seconds>]  
    [-autoHoldoff]

• files:
  • input file: SDDS file with string column ControlName listing PVs to log.
  • output file: SDDS file containing logged PV values.
• switches:
  • -pendIOtime=<value> — maximum time to wait for PV responses.
  • -watchInput — reload the input file when it changes.
  • -monitorMode=[randomTimedTrigger] — use monitor mode; optional value randomizes trigger timing.
  • -append — append to an existing output file.
  • -overwrite — overwrite an existing output file.
  • -sampleInterval=<real-value>[,<time-units>] — interval between readings.
  • -dataStrobePV=<PVname>,<provider>[,notTimeValue][,holdoff=<seconds>] — use a PV as a data strobe with optional holdoff.
  • -steps=<integer-value> — number of samples to take before exiting.
  • -time=<real-value>[,<time-units>] — total logging time.
  • -conditions=<file>,{allMustPass|oneMustPass}[,touchOutput][,retakeStep] — require limits from a conditions file.
  • -onerror={usezero|skip|exit} — action taken when a read fails.
  • -inhibitPV=name=<name>,provider=<provider>[,waitTime=<seconds>] — inhibit logging while this PV is nonzero.
  • -generations[=digits=<integer>][,delimiter=<string>][,rowlimit=<number>][,timelimit=<secs>] — rotate output files by generation.
  • -dailyFiles[=rowlimit=<number>][,timelimit=<secs>][,timetag][,verbose] — start a new output file each day.
  • -monthlyFiles[=rowlimit=<number>][,timelimit=<secs>][,timetag][,verbose] — start a new output file each month.
  • -strictPVverification — exit if PV data do not match expectations.
  • -truncateWaveforms — truncate waveform PVs to the minimum common length.
  • -runControlPV=string=<pv>,pingTimeout=<value> — integrate with run control.
  • -runControlDescription=string=<string> — description for the run-control record.
  • -verbose — print progress messages.
  • -logInterval=<integer-value> — average this many samples before writing.
  • -flushInterval=<integer-value> — force a file flush after this many samples.
  • -onePvPerFile=<dirName> — write each PV to a separate file in the given directory.
  • -triggerFile=<filename> — read glitch trigger definitions from an SDDS file.
  • -circularBuffer=[before=<number>,][after=<number>] — samples to retain before and after a trigger.
  • -delay=<steps> — delay reading after a trigger (not yet implemented).
  • -holdoffTime=<seconds> — minimum time between triggers.
  • -autoHoldoff — compute holdoff time from post-trigger samples.
• see also:
  • sddslogger()
  • sddsglitchlogger()
  • sddspvtest()
• author: Robert Soliday, Hairong Shang, ANL/APS.