esrf

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

st_falcon.mac $Revision: 1.3 $ $Log: st_falcon.mac,v $ Revision 1.3 2007/11/06 15:10:19 witsch tested version with appropriate changes for real operation. Revision 1.1 2007/03/14 13:15:06 witsch Initial revision
See other macros in category: All
Description:
    st_falcon.mac
Documentation:
    DESCRIPTION
    Macro motors for the ST France pump (>MCAPC)

    SETUP
    There must be a serial line device server running on the PC with the ST France software called Falcon. The Falcon software and the device server must not run at the same time! The serial line device server must be set to use 19200 baud, 7 data bits, 1 stop bit, even parity.

    SETUP
    falcon_scan_user is the local hook macro, that ID27 can modify, which will be executed before the counting at each scan point. I will be empty at each fresh start, so please save with savmac and use jtdo() to read it from the setup.

Macros:
    falcon_scan
    Usage: falcon_scan motor start finish intervals
    Do a scan with the Sanchez Technologies, Falcon Pump controller. Behaves like an ascan.

Internal Macros:
    mm_falcon_set_serial_parameters
    Usage: mm_falcon_set_serial_parameters (mne)
    Setting a couple of preset values. Device and controller ID.

    mm_falcon_bcc
    Usage: mm_falcon_bcc (str)
    Don't use this macro directly. Calculates bcc for command to send to the controller. simple exclusive or going from the <EOT> to the <ETC> character.

    mm_falcon_write_aux
    Usage: mm_falcon_write_aux (mne, send)
    Don't use this macro directly. Writes a string to the pump.

    mm_falcon_read_aux
    Usage: mm_falcon_read_aux (mne)
    Don't use this macro directly. Reads a string from the pump.

    mm_falcon_read_char
    Usage: mm_falcon_read_char (mne)
    Don't use this macro directly. Reads a string from the pump.

    mm_falcon_read_value
    Usage: mm_falcon_read_value (mne, cmd)
    Don't use this macro directly. Read a value from the ST France pump. It returns the answer of the controller. No BCC is added !
    Examples:
    SW (status word), II (indentification), VO (software version)

    mm_falcon_write_value
    Usage: mm_falcon_write_value (mne, cmd)
    Don't use this macro directly. Set a value on the ST France pump. It returns the answer of the controller, if it is anything else than <ACK>. The request is passed through the function creating the BCC, here. Sent strings mustn\'t be longer than 32 bytes.
    Examples:
    1SP (Consigne de pression), 1RP (Rampe de pression)

    mm_falcon_get_state
    Usage: mm_falcon_get_state (mne)
    Don't use this macro directly. Use function mm_falcon_read_value() to send command "SW" and analyse the answer.

    mm_falcon_ident
    Usage: mm_falcon_ident (mne)
    Don't use this macro directly. Use function mm_falcon_read_value() to send command "II" and analyse the answer.

    mm_falcon_just_spell_out_answer
    Usage: mm_falcon_just_spell_out_answer(str)


    stfalcon_config
    Usage: stfalcon_config(motnum, type, unit, module, chan )
    Called by spec after reading the config file

    stfalcon_cmd
    Usage: stfalcon_cmd(num, cmd, p1, p2)
    Called by spec

Filename: st_falcon.mac
Author: by H. Witsch, BLISS
Last mod.: 06/11/2007 16:10 by witsch