esrf

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

newport_agilis.mac
See other macros in category: All
Description:
    newport_agilis.mac - Macros to control the Newport Agilis piezo motor controller AG-M100. This one has been modified to be connected to a serial line. Normally, they have only USB. $Revision: 1.0 $
Documentation:
    DESCRIPTION
    First declare a serial line  SERIAL        DEVICE <>TYPE  <>BAUD                           <>MODE  0  YES    /dev/ttyS0     <>  115200                              raw
    To define a macro motor controller you must define a motor controller in config, ADDR is the serial line index number.    MOTORS       DEVICE    ADDR   <>MODE      NUM               <>TYPE       YES       laser     4                   1          Macro Motors Then declare a motor with that controller. make this window bigger for better reading!

    SETUP
    The defaults for the serial line :
    Baud Rate = 115200
    Data Bits = 8
    Parity = None
    Stop Bits = 1
    Flow Control = None
    Termination Character = CR/LF


    BUGS
    Bugs ? What bugs ??

Macros:
    agilis_debug
    Usage: agilis_debug
    toggle debug mode for the present macros.

    agilis_sim
    Usage: agilis_sim
    toggle simulation mode for the present macros.

    agilis_setstepsize
    Usage: agilis_setstepsize mne [step size]
    Set step amplitude or get step amplitude setting for the motor designated with mne.

Internal Macros:
    __agilis_globals
    Usage: __agilis_globals ()
    Setting a couple of preset values.

    __agilis_set_serial_parameters
    Usage: __agilis_set_serial_parameters (addr)
    Setting a couple of preset values. Device and controller ID.

    __agilis_err
    Usage: __agilis_err(__errstr)


    __agilis_put
    Usage: __agilis_put(addr, send)


    __agilis_get
    Usage: __agilis_get(addr)


    __agilis_putget
    Usage: __agilis_putget (addr, send)


    __agilis_checkerror
    Usage: __agilis_checkerror (addr, send)
    Does the packing of the command with the checksum and the unpacking of the answer.

    __agilis_simulation
    Usage: __agilis_simulation(send)


    __agilis_status
    Usage: __agilis_status %DESC%


    __agilis_change_module
    Usage: __agilis_change_module %DESC% changes the Agilis channel (which in Spec is the module), only if necessary. CC command is refused, when used during a movement.


    __agilis_config
    Usage: __agilis_config %DESC%


    __agilis_cmd
    Usage: __agilis_cmd %DESC% Spec Macro Motor function


Filename: newport_agilis.mac
Author: Holger (BLISS) for ID18.
Last mod.: 18/06/2012 10:29 by witsch