esrf

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

XRP_XGENE.MAC
[ source code | installed at | configured at ]
See other macros in category: All
Description:
    Implements macro motors and control macros for COMET XRP X generator
Documentation:
    DESCRIPTION
    - Configure the serial line connected to the controler.
    - Configure a macro motor controller: "device"field set to string "xrp" "addr"field set to the serial line entry "num"field set to 4 "type"field set to "Macro Motors"
    - Configure a macro counter controlle: "device"field set to string "xrp" "addr"field set to the serial line entry "num"field set to 4 "type"field set to "Macro Counter"
    - Configure motors: "Controller"field set to "MAC_MOT" "Unit"field set to macro motor controller entry "Channel"used to select the XRP parameter to control
    0: Voltage 1: Current
    - Configure counters: "Controller"field set to "MAC_MOT" "Unit"field set to macro motor controller entry "Channel"used to select the XRP parameter to read
    0: Voltage (set point) 1: Current (set point) 2: Voltage (actual) 3: Current (actual)


Macros:
    xrp_status
    Usage: xrp_status
    Print out the current status of the controller

    xrp_remote_on
    Usage: xrp_remote_on
    Switch the controller to remote mode. NOTE: the controller must be set in "mode 400" using front panel keys NOTE: the controller front panel will be disabled

    xrp_remote_off
    Usage: xrp_remote_off
    Switch the controller to local mode. NOTE: the controller front panel will be re-activated

    xrp_set_hvoff_time
    Usage: xrp_set_hvoff_time seconds
    Set the automatic HV switching off time. The minium is 2 seconds.

    xrp_no_hvoff_time
    Usage: xrp_no_hvoff_time
    Disable the automatic HV switching off.

    xrp_focal_normal
    Usage: xrp_focal_normal
    Select the standard focal spot

    xrp_focal_small
    Usage: xrp_focal_small
    Select the small focal spot

    xrp_hv
    Usage: xrp_hv [on | onwait | off]
    Control the output of the controller.

Internal Macros:
    xrp_config
    Usage: xrp_config ()
    Macro motor/counter implementation

    xrp_cmd
    Usage: xrp_cmd ()
    Macro motor/counter implementation

    xrp_check
    Usage: xrp_check (sl)
    Returns null if ok

    _xrp_status
    Usage: _xrp_status()
    Returns the current status of the controller

    _xrp_motors_disable
    Usage: _xrp_motors_disable (disable)
    Enable or disable all macro motors

    xrp_parse
    Usage: xrp_parse (string)
    Parse the given string answer from controller and returns a float value or -1 if an error occured

    xrp_query
    Usage: xrp_query (sl, cmd)
    Execute the given query on controller and returns the answer (remove terminators)

    xrp_flush
    Usage: xrp_flush (sl)
    Paranoic

    xrp_wr
    Usage: xrp_wr (sl, cmd)
    Send command to controller (add terminator)

    xrp_rd
    Usage: xrp_rd (sl)
    Read answer from controller (remove terminators) TODO: handle multi lines answers (protocol??) TODO: handle multi SPEC sessions talking to same controller

    xrp_debug
    Usage: xrp_debug [on|off]
    Cosmetics

    xrp_log
    Usage: xrp_log (msg)
    Cosmetics

    _xrp_debug
    Usage: _xrp_debug (msg)
    Cosmetics

    xrp_err
    Usage: xrp_err (msg)
    Cosmetics

Filename: xrp_xgene.mac
Author: MP BCU (Original 06/2018).
$Revision: 1.0 $ / $Date: 2018/06/19 07:02:24 $
Last mod.: 19/06/2018 09:02 by perez