2.19 sddslogonchange

• description: sddslogonchange records only the values of process variables that change. This reduces the output file size if process variables do not change often.
• examples: Process variable setpoints from the storage ring are monitored with the command below.
  sddslogonchange SR.loc SR.sdds -logInitialValues -watchInput -connectTimeout=120

  where the contents of the file SR.loc are

  SDDS1  
  &column name=ControlName, type=string,  &end  
  &column name=Tolerance, format_string=%g, type=double,  &end  
  &column name=Description, type=string,  &end  
  &data mode = ascii, no_row_counts=1 &end  
  ! page number 1  
  S1A:H1:CurrentAI.AOFF 0.0 ""  
  S1A:H2:CurrentAI.AOFF 0.0 ""  
  S1A:H3:CurrentAI.AOFF 0.0 ""  
  ...

• synopsis:
  usage: sddslogonchange <input> <output>  
    [-timeDuration=<realValue>[,<time-units>]]  
    [-append[=recover]]  
    [-eraseFile]  
    [-generations[=digits=<integer>][,delimiter=<string>]]  
    [-dailyFiles]  
    [-pendEventTime=<seconds>]  
    [-durations]  
    [-connectTimeout=<seconds>]  
    [-explicit[=only]]  
    [-verbose]  
    [-comment=<parameterName>,<text>]  
    [-requireChange[=severity][,status][,both]]  
    [-inhibitPV=name=<name>[,pendIOTime=<seconds>][,waitTime=<seconds>]]  
    [-includeTimeOfDay]  
    [-offsetTimeOfDay]  
    [-logInitialValues]  
    [-logAlarms]  
    [-watchInput]  
    [-runControlPV=string=<string>,pingTimeout=<value>]  
    [-runControlDescription=string=<string>]  
    [-sddslogger]  
    [-noToleranceMinLimit]  
   
  Logs data for the process variables named in the ControlName  
  column of <input> to an SDDS file <output>.

• files:
  • input file:

    The input file is an SDDS file with only one data column required:

    • ControlName — Required string column for the names of the process variables or devices to be monitored.
    • ReadbackName — Optional string column.
    • ReadbackUnits — Optional string column.
    • Description — Optional string column.
    • RelatedControlName — Optional string column.
    • Tolerance — Optional numeric column which contains a tolerance value to avoid logging small changes.
  • output file:

    The output file contains parameters, arrays, and columns.

    • Parameters
    • InputFile — sddslogonchange input file.
    • TimeStamp — Time stamp for file.
    • PageTimeStamp — Time stamp for page.
    • StartTime — Start time.
    • YearStartTime
    • StartYear
    • StartJulianDay
    • StartMonth
    • StartDayOfMonth
    • StartHour
    • Arrays
    • ControlName — Control names of process variables
    • ReadbackName — Optional readback names of process variables
    • ReadbackUnits — Optional units of process variables
    • AlarmStatusString — Optional
    • AlarmSeverityString — Optional
    • DescriptionString — Optional
    • RelatedControlName — Optional
    • Columns
    • ControlNameIndex — Index of the ControlName array.
    • Value — Value of the process variable.
    • Time — Time stamp of the change in value.
    • PreviousRow — Previous row with an identical ControlNameIndex value.
    • AlarmStatusIndex — Optional
    • AlarmSeverityIndex — Optional
    • Duration — Optional
    • RelatedValueString — Optional
    • ControlName — Optional
    • AlarmStatus — Optional
    • AlarmSeverity — Optional
    • Description — Optional
    • RelatedControlName — Optional
• switches:
  • -timeDuration=<realValue>[,<time-units>] — Specifies time duration for logging. The default time units are seconds; you may also specify days, hours, or minutes.
  • -offsetTimeOfDay — Adjusts the starting TimeOfDay value so that it corresponds to the day for which the bulk of the data is taken. Hence, a 26 hour job started at 11pm would have initial time of day of -1 hour and final time of day of 25 hours.
  • -append[=recover] — Specifies appending to the file ¡output¿ if it exists already. If the recover qualifier is given, recovery of a corrupted file is attempted using sddsconvert, at the risk of loss of some of the data already in the file.
  • -eraseFile — Specifies erasing the file ¡output¿ if it exists already.
  • -generations[=digits=<integer>][,delimiter=<string>] — Specifies use of file generations. The output is sent to the file ¡output¿-¡N¿, where ¡N¿ is the smallest positive integer such that the file does not already exist. By default, four digits are used for formatting ¡N¿, so that the first generation number is 0001.
  • -dailyFiles — The output is sent to the file ¡output¿-YYYY-JJJ-MMDD.¡N¿, where YYYY=year, JJJ=Julian day, and MMDD=month+day. A new file is started after midnight.
  • -pendEventTime=<seconds> — Specifies the CA pend event time, in seconds. The default is 10.
  • -durations — Specifies including state duration and previous row reference data in output.
  • -connectTimeout=<seconds> — Specifies maximum time in seconds to wait for a connection before issuing an error message. 60 is the default.
  • -explicit[=only] — Specifies that explicit columns with control name, alarm status, and alarm severity strings be output in addition to the integer codes. If the ”only” qualifier is given, the integer codes are omitted from the output.
  • -verbose — Specifies printing of possibly useful data to the standard output.
  • -comment=<parameterName>,<text> — Gives the parameter name for a comment to be placed in the SDDS output file, along with the text to be placed in the file.
  • -requireChange[=severity][,status][,both] — Specifies that either severity, status, or both must change before an event is logged. The default behavior is to log an event whenever a callback occurs, which means either severity or status has changed.
  • -inhibitPV=name=<name>[,pendIOTime=<seconds>][,waitTime=<seconds>] — Checks this PV periodically. If nonzero, then data collection is aborted.
  • -includeTimeOfDay — Includes time-of-day information in the output.
  • -logInitialValues — Logs the initial value of each process variable.
  • -logAlarms — Logs alarm events even if the value doesn’t change.
  • -watchInput — Watches the input file and exits if it changes or is removed.
  • -runControlPV=string=<string>,pingTimeout=<value> — Specifies a run control PV name and optional ping timeout.
  • -runControlDescription=string=<string> — Specifies a run control PV description record.
  • -sddslogger — Writes the output file in sddslogger column format.
  • -noToleranceMinLimit — Disables the default minimum change limit when logging values.
• see also:
  • sddslogger()
  • sddssnapshot()
• author: Robert Soliday, ANL/APS.