knobconfig

• description: knobconfig assigns knobs to devices according to the input file. Knob assignments are active only during program execution.
• example: Knobs are assigned for tune adjustment of the APS storage ring with this command:

  knobconfig SR_tunes.cokn
  

  where file SR_tunes.cokn contains weights for the various quadrupole magnets necessary for independent tune adjustments. Part of the first data set of the file SR_tunes.cokn is shown below:

  SDDS1
  &description 
          text="Knob Assignment Specification" 
          contents="knob assignment specification" 
  &end 
  &parameter name=ControlName, type=string  &end 
  &parameter name=KnobDescription, type=string  &end
  &parameter name=ControlType,  type=string &end 
  &parameter name=ControlUnits,  type=string &end 
  &parameter name=Gain type=double &end 
  &column name=ControlName type=string &end 
  &column name=Weight type=double &end 
  &data   mode=ascii, &end 
  S:NUx:fine              ! ControlName
  Triplet knob for x tune (0.0005/click)  ! KnobDescription
  dev                     ! ControlType
  ?                       ! ControlUnits
  0.5                     ! Gain
  240                     ! number of rows
  S1A:Q1  1.488923268326000e-03
  S1A:Q2  5.958927747443000e-03
  S1A:Q3  4.242561180246000e-03
  S1B:Q3  4.242561180246000e-03
  S1B:Q2  5.958927747443000e-03
  S1B:Q1  1.488923268326000e-03
  S2A:Q1  1.488923268326000e-03
  S2A:Q2  5.958927747443000e-03
  ...
  

• synopsis:

  usage: knobconfig spec-file
  purpose:	Configures knobs.
  		Assigns knobs to devices and process variables
  		according to spec-file. Assignments are active
  		only during program execution. In general, it 
  		is best not to run this utility in background.
  Sample spec-file. Note that ControlMessage parm is optional:
  SDDS1 
  &description 
          text="Knob Assignment Specification" 
          contents="knob assignment specification" 
  &end 
  &parameter name=ControlName 
             type=string  
  &end 
  &parameter name=ControlType 
             type=string 
  &end 
  &parameter name=ControlMsg 
             type=string 
  &end 
  &parameter name=ControlUnits 
             type=string 
  &end 
  &parameter name=Gain 
             type=double 
  &end 
  &column name=ControlName 
          type=string 
  &end 
  &column name=Weight 
          type=double 
  &end 
  &data   mode=ascii 
          no_row_counts=1 
  &end 
  COMPDEVICENAME 
  dev 
  set 
  tune 
  0.01 
  P:Q1  1.0000 
  P:Q2  1.1134 
   
  PTB:Q3 
  dev 
  set 
  Amps 
  0.1 
   
  PTB:Q4:CurrentAO 
  pv 
  - 
  Amps 
  0.1
  

• files:
  • input file:

    Each data set in the input file defines the weights of the devices controlled by one knob. The required parameters are:

    • ControlName -- String. The name of the composite device.
    • ControlType -- String. Descibes the type of control name. The only valid value is "dev".
    • Gain -- Double. Factor by which to multiply the Weight column values of each constituent of the composite device.
    An optional parameter is
    • ControlMsg -- String. The device message to be used. The default value is "set".
    The parameters KnobDesciption and Units may be implemented in future versions of knobconfig. For now, they may be defined as a data preparation aid. The required columns are:
    • ControlName -- String column of names of atomic devices.
    • Weight -- Double column of relative weights of each atomic device. Multiplied with the Gain, these are the values by which each device setpoints will be changed by one tick of the knob.
• switches: None.

• author: C. Saunders, ANL