esrf

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

SHUT.MAC
See other macros in category: All
Description:
    A simple macro package to pulse, open or close a shutter (ICV196)
Documentation:
    DESCRIPTION
    A shutter (or any other relay) can be opened or closed.

    EXAMPLE
    shutopen 0
    (opens shutter 0)
    shutclose
    (closes shutter 0, remembers last channel used)
    shutpuls 10
    (opens the shutter 0 for 10 seconds)
    shutwait Close
    (wait until shutter is closed again)


Macros:
    shutsetup
    Usage: shutsetup [relay device name] [pulsed relay device name]
    The name of the device servers are used in all the macros. Input the first two parts of the device server name only (for ex. ID/ID112pulsed) The last part will be the number of the channel.

    shutsetupf
    Usage: shutsetupf (relay device name, pulsed relay device name)
    Same as shutsetup, but defined as a function. If one of the relay types is not used, NULL has to be specified.

    shutopen
    Usage: shutopen [channel]
    Opens the shutter. If no channel is given the channel will be taken from the last shutter command.

    shutclose
    Usage: shutclose [channel]
    Like above. Closes the shutter

    shutread
    Usage: shutread [channel]
    Reads the current shutter state (Open or Closed)

    shutpuls
    Usage: shutpuls <time in s> [channel]
    Pulses (opens for a certain time) the shutter. The timing will be done on OS9 level.

    shutwait
    Usage: shutwait O[pen]|C[lose] [channel]
    Waits until the given shutter is Open or Closed

Internal Macros:
Filename: shut.mac
Author: Jorg Klora $Revision: 2.3 $, $Date: 1999/07/30 10:14:45 $
Last mod.: 08/08/2002 14:37 by berruyer