update_user_specs

Purpose:

Update the user control specification file with new gains and/or feedback variable values for a specified loop based on current system variables. This executable is not intended for end-users.

Enter:

update_user_specs <user_control_spec_file> <loop_name> <which_var> <WRITE | READ>

Where:

user_control_spec_file

Specify the name of the specification file to update.

loop_name

Specify the name of the loop to configure.

which_var

Specify one of the following to indicate the element(s) to update:

  • GAINS
  • FEEDBACK VARIABLE
  • BOTH

WRITE | READ

Specify one of the following:

  • WRITE to modify the user control specs file with new
    gains and/or feedback variable.
  • READ to modify the user control specs file to restore
    the old gains and/or feedback variable.

Example:

update_user_specs user_ctrl_specs.def loop_name_FB BOTH WRITE
The preceding specifies a user control specification file and feedback loop name, instructs to update both gains and the feedback variable and to modify the user control specification file with the new gains and feedback variable.

Notes:

This program uses a temporary file to modify the specification file and handles errors by logging and exiting if issues occur.

See Also: