esrf

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

ETEL.mac
See other macros in category: All
Description:
Documentation:
    DESCRIPTION
    set of macros for the management of ETEL motors.

    ETEL motors are seen by spec as MAXE controllers via a dedicated device server.
    The setting of the various parameters is supposed to have been done already by CoMet (the ETEL GUI). spec will give access to the commands defined for MAXE controllers (such as velocity, acceleration settings, home search ...)

    - note about dial positions: the spec set_dial macro allows to set the motor dial position (hardware internal counter). For ETEL motors, it is not possible to set a value to the hardware. So, the device server introduces an artificial 'offset' in order to satisfy the spec user and the motor controller. For some reason, it may be necessary to change this offset (for example to set it to 0 if the user wants the dial position to reflect the same position as the controller one). This can be done with de "DevStore" command of the device server
    06/10/10: DevStore now reads array of double
    06/10/10: etel_home: moves to 0 at the end.

Macros:
    etel_dev
    Usage: etel_dev <mne>
    home search. The procedure for the home is the one which has been programmed using CoMet
    At the end of the procedure, a home is found and the reference is at the position 0 of the hardware internal counter.
    spec dial position is set to etel hardware internal counter.
    When home procedure is finished, the motor is not necessarily stopped at position 0 (but position 0 is exactly the reference position).
    At the end, the original motor velocity is restored (because internally, the hardware would have kept the homeslewrate velocity as the normal velocity until the next reconfig). global ETEL_resp ETEL_DEBUG

    mv_etel
    Usage: mv_etel
    makes an absolute motion instead of relative

    etel_stop
    Usage: etel_stop <mne>
    stops explicitely motor <mne>

    etel_status
    Usage: etel_status <mne>
    prints the status of the motor which can be:
    - DEVMOVING : motor is moving
    - DEVON: motor not moving. ready to move
    - unknown state: else

    etel_readK
    Usage: etel_readK <mne> <Knum>
    read K parameter <Knum> for motor <mne>
    returns value in global ETEL_resp

    etel_writeK
    Usage: etel_writeK <mne> <Knum> <Kval>
    is in increment unit.

    etel_setfreerun
    Usage: etel_setfreerun <mne> <dir>
    free run on motor <mne> with direction given by the sign of <dir>

    etel_setstd
    Usage: etel_setstd <mne>
    standard motion mode on motor <mne>

    etel_free_run
    Usage: etel_free_run <mne> <dir>
    free run on motor <mne> with direction given by the sign of <dir>

    ETEL_debug
    Usage: ETEL_debug
    toggle the debug mode if (!(whatis("__ETEL_debug") & 2)) rdef __ETEL_debug \'#$*\'

    etel_poweron
    Usage: etel_poweron <mne>
    power on motor <mne>

    etel_poweroff
    Usage: etel_poweroff <mne>
    power off motor <mne>

Internal Macros:
    etel_home
    Usage: etel_home


    _mv_etel
    Usage: _mv_etel <motor> <position>
    absolute motion

    _mv_etel_function
    Usage: _mv_etel_function (<mne>, <position>)
    absolute motion

    _poll_etel
    Usage: _poll_etel (motor_num)
    polling on motion

    etel_stop_function
    Usage: etel_stop_function (mne)
    stops explicitely motor <mne>

    etel_readK_function
    Usage: etel_readK_function (<mne>, <Knum>)
    read K parameter <Knum> for motor <mne>
    returns value in global ETEL_resp

    etel_writeK_function
    Usage: etel_writeK_function (<mne>, <Knum>, <Kval>)
    is in increment unit.

    etel_setfreerun_function
    Usage: etel_setfreerun_function (<mne>, <dir>)
    free run on motor <mne> with direction given by the sign of <dir>

    etel_setstd_function
    Usage: etel_setstd_function (mne)
    standard motion mode on motor <mne>

    etel_free_run_function
    Usage: etel_free_run_function (<mne>, <mydir>)
    free run on motor <mne> with direction given by the sign of <dir>

Filename: ETEL.mac
Author: MCD august 2010
$Revision: 1.8 $ / $Date: 2017/01/10 13:56:13 $
Last mod.: 10/01/2017 14:56 by domingue