esrf

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

TFOC.MAC
See other macros in category: All
Description:
    TFOC.MAC - Manages the transfocator device through WAGO DAC and I/O
Documentation:
    DESCRIPTION


    SETUP
    The Wago controllers must be declared in the setup file by means of the wagosetup macro (see help in wagocore.mac). This requires that the the device server Wagods must be properly configured to access to the Wago controllers.


Macros:
    tfsetup
    Usage: tfsetup <edit|show|update>
    edit : create or modify a configuration
    show : print current configuration loaded
    update: load configuration from file


    tfshow
    Usage: tfshow ["all"|"in"|"out"]
    Without argument, it shows the position of configured actuators.
    With "all", it shows even the unconfigured actuators.
    Finally only the actuationrs "in" the beam or "out" can be displayed.

    tfin
    Usage: tfin actuator
    Move the specified actuator, numbered from 1, in the beam.

    tfout
    Usage: tfout actuator|"all"
    Move the specified actuator, numbered from 1, or "all" the actuators out of the beam.

    tfset
    Usage: tfset bit_pattern
    Move all the actuators according to the bit pattern passed. If the bit is set then the corresponding actuator is moved in the beam. If the bit is clear then the actuator is moved out. The bit pattern can be passed as "0xNNNN"

    tfabort
    Usage: tfabort
    Abort any motion on all actuators

    tfenable
    Usage: tfenable
    Enable the piezo controller

    tfdisable
    Usage: tfdisable
    Disable the piezo controller

    tfreset
    Usage: tfreset
    Reset the piezo controller

Internal Macros:
    _tfsetup_usage
    Usage: _tfsetup_usage(arg)


    _tfsetup_cfgfile
    Usage: _tfsetup_cfgfile ()


    _tfsetup_edit
    Usage: _tfsetup_edit ()


    _tfsetup_new
    Usage: _tfsetup_new ()


    _tfsetup_show
    Usage: _tfsetup_show ()


    _tfsetup_read
    Usage: _tfsetup_read ()


    _tfgetls_pattern
    Usage: _tfgetls_pattern (array)
    Fill the two cells array. The first value is a bit pattern value corresponding to the limitswitches values. The actuator positive switch is activated, the corresponding bit is set. In all other switch value cases (negative on, both on, both off), the bit is clear. The second value returned is a bit pattern with bit set when the corresponding actuator limitswitches are in-coherent (both on, both off)

    _tfgetls
    Usage: _tfgetls (array)
    Fill the array with all limitswitches values. Return the array size or -1 in case or error.

    _tfgetdacs
    Usage: _tfgetdacs (array)
    Fill the array with all WAGO DACs values. Return the array size or -1 in case or error.

    _tfsetdacs
    Usage: _tfsetdacs (array)
    Write the array of values to all WAGO DACs.

    _tfset
    Usage: _tfset (bit_pattern)
    Move all the actuators according to the bit pattern passed. If the bit is set then the corresponding actuator is moved in the beam. If the bit is clear then the actuator is moved out.
    Return -1 in case of error, 0 otherwise

    _tfcontrol
    Usage: _tfcontrol (action)
    action = 1 -> enable axis
    action = 0 -> disable axis
    action = -1 -> reset axis


Filename: tfoc.mac
Author: R.Hino, M.Perez, (Original 5/2010). $Revision: 1.4 $ / $Date: 2010/06/22 06:25:19 $
Last mod.: 22/06/2010 08:25 by perez