2.23 sddspvacontrollaw

• description: sddspvacontrollaw performs feedback on process variables using PV Access. The input file defines an inverse response matrix: each column names a readback PV and a string column lists the actuator PVs. The program adjusts actuators to regulate the readbacks to zero or to given offsets, optionally logging data and applying limits.
• examples:
  sddspvacontrollaw sddspvacontrollaw.inv -searchPath=/home/controls -interval=1 -steps=10 -gain=0.75  
    -runControlPV=string=shang:ControlLawRC -verbose

• synopsis:
  usage: sddspvacontrollaw <inputfile> [-searchPath=<dir-path>] [-actuatorColumn=<string>] [<outputfile>]  
  [-gain={<real-value>|PVname=<name>}] [-interval={<real-value>|PVname=<name>}] [-steps=<integer>]  
  [-updateInterval=<integer>] [-average={<number>|PVname=<name>}[,interval=<seconds>]]  
  [-testValues=<file>]  
  [-despike[=neighbors=<integer>][,passes=<integer>][,averageOf=<integer>][,threshold=<value>]  
    [,pvthreshold=<pvname>][,file=<filename>][,countLimit=<integer>]  
    [,startThreshold=<value>,endThreshold=<value>,stepsThreshold=<integer>]  
    [,rampThresholdPV=<string>]]  
  [-deltaLimit={value=<value>|file=<filename>}]  
  [-readbackLimit={value=<value>|minValue=<value>,maxValue=<value>|file=<filename>}]  
  [-actionLimit={value=<value>|file=<filename>}]  
  [-runControlPV={string=<string>|parameter=<string>}[,pingTimeout=<value>]]  
  [-runControlDescription={string=<string>|parameter=<string>}] [-controlLogFile=<file>]  
  [-glitchLogFile=file=<string>[,readbackRmsThreshold=<value>][,controlRmsThreshold=<value>]  
    [,rows=<integer>]]  
  [-CASecurityTest] [-waveforms=<filename>,<type>] [-verbose] [-dryRun]

• files:
  • input file:

    An SDDS file containing the inverse response matrix. A string column lists actuator PV names and one column for each readback PV provides the matrix elements.

  • output file:

    If given, records readback and actuator values at each correction step.

• switches:
  • -searchPath — directory path used to locate input files.
  • -actuatorColumn — string column in the input file naming actuators.
  • -gain — scalar or PV specifying overall feedback gain.
  • -interval — time between corrections.
  • -steps — number of correction iterations.
  • -updateInterval — steps between output file updates.
  • -average — number of readback acquisitions to average, optionally with a time interval.
  • -testValues — SDDS file giving limits that suspend feedback when readbacks are out of range.
  • -deltaLimit — maximum change permitted for any actuator.
  • -readbackLimit — maximum allowed readback error for each PV.
  • -actionLimit — minimum absolute readback before applying corrections.
  • -despike — despike readback data using neighbors and threshold tests.
  • -runControlPV — run control PV name or parameter.
  • -runControlDescription — run control description parameter.
  • -controlLogFile — write actuator changes to a log file.
  • -glitchLogFile — log data when RMS thresholds are exceeded.
  • -CASecurityTest — verify write access to control PVs.
  • -waveforms — specify waveform PVs to read or write in addition to scalars.
  • -verbose — print extra information.
  • -dryRun — compute corrections without writing to actuators.
• see also:
  • sddscontrollaw()
• author: Louis Emery, Hairong Shang, Robert Soliday, ANL/APS.