esrf

Beamline Instrument Software Support
SPEC Macro documentation: [ Macro Index | BCU Home ]

OXITCSWEEP.MAC
[ source code | installed at | configured at ]
See other macros in category: Temperature
Description:
    Macros for Oxford ITC503 Temperature controller. (sweep features)
Documentation:
    DESCRIPTION
    Those macros provide users with the Oxford ITC internal sweep feature access.

    DEPENDENCIES
    - The file oxITCsweep.mac has to be read in. It uses ox.mac, saveload.mac.

Macros:
    oxsweep
    Usage: oxsweep <startstep> <endstep> <seconds> [flag]"
    Handles a sweep.
    The steps are between 1 and 32, according to what was input to oxswprog macro; The macro starts the sweep and eventually SPEC counters, and loop reporting counters value till the end of the sweep, to the screen, and eventually to a disk file, if one has been opened using oxswnewfile macro. oxsweep sleeps the specified seconds at each loop turn. The flag can take one of the following values:
    • 0: The counters value are simply reported at each loop turn"
    • 1: The counters value are integrated while sleeping"
    • 2: The counters value are integrated all along the sweep"
    The command applies to the current Oxford device.

    oxswprog
    Usage: oxswprog [internal-flag]
    Records a sweep program into the controller memory. You must be in remote control with no sweep running to be allowed to do it. It asks for the following parameters 16 times for one sweep, which is 32 steps:
    • temperature setpoint value, common to 2 consecutive steps.
    • sweep time to setpoint in minutes, for odd numbered steps.
    • hold time at setpoint in minnutes, for even numbered steps.
    Fill in with 0 the steps you don't use.
    Only one sweep program is held in the controller at the same time.
    It is possiblre to save it to a disk file. see macro oxswsave. The command applies to the current Oxford device.

    oxswstep
    Usage: oxswstep [num] [minutes] [setpoint] [max_voltage]
    Changes one sweep step record in the controller memory. You must be in remote control with no sweep running to be allowed to do it. The command applies to the current Oxford device.

    oxswread
    Usage: oxswread
    Prints out the sweep program held in the controller memory. The command applies to the current Oxford device.

    oxswsave
    Usage: oxswsave [filename]
    Saves the current sweep program to a disk file.

    oxswload
    Usage: oxswload [filename]
    Reads in a sweep program from a previously saved disk file and eventually records it into the controller memory. The command applies to the current Oxford device.

    oxswstart
    Usage: oxswstart [step_no]
    Starts a sweep program.
    You can give as argument the step number at which you want to start sweeping, default being 1. Allowed step numbers are from 1 to 32. The command applies to the current Oxford device.

    oxswstop
    Usage: oxswstop
    Stops a running sweep. The command applies to the current Oxford device.

    oxswmon
    Usage: oxswmon [interval]
    Prints out parameters during sweep execution The command applies to the current Oxford device.

    oxswnewfile
    Usage: oxswnewfile [filename] [sweep_no]
    Opens the file where to store sweep data. The sweep data are typically temperatures, voltages and others counters values.
    The file format is the standard scans file one, added specific Oxford information as described here:
    #S 1 oxsweep 1 2 30
    first of all, the #S index here is coherent with a sweep number.
    #C OX HEATER MANUAL
    Heater control mode: could have been AUTO
    #C OX GAS MANUAL
    Gaz flow control mode: could have been AUTO
    #C OX COM REMOTE & UNLOCKED
    Communication status: could have been LOCAL & LOCKED
    #C OX SENSOR 1
    Sensor used to eventually feed back the heater control loop; out of 1, 2 or 3
    #C OX AUTOPID 0
    If 1, indicates that the Learnt Auto-PID values internal table is used, otherwise, fixed PID values are used.
    #C OX PID 0 0 0
    This is the fixed PID values, set by command oxPID.
    #C OX L EPOCH Seconds Counter TEMP1
    2 blank-characters separated list of counter names which values are listed as data, respectively to this kind of column header.


Internal Macros:
    oxsw_cleanup
    Usage: oxsw_cleanup


    oxsw_plot
    Usage: oxsw_plot
    Plot selected counter vs/time

Filename: oxITCsweep.mac
Author: OXITCSWEEP.MAC - Marie-Claire LAGIER - 96/04/24
Last mod.: 12/08/2008 17:27 by rey