esrf

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

syrpump.mac
See other macros in category: All
Description:
    Control of Harvard apparatus Syringe Pump Pico Plus through serial line %BR% $Revision: 1.3 $
Documentation:
    DESCRIPTION

    Use syrconfig to configure syringe parameters
    Use syrshow to display current settings
    Use syrstart, syrstop to start/stop infuse
    A counter can be used to get the current accumulated volume infused. At each start command, this volume is reset to zero.
    To close remote connection and enable keyboard interaction, use syrclose.

    SETUP

    An ESRF device server for serial line has to be used (configuration of 2 stop bits), and configured in SPEC as raw:9600. Setup done using macro syrsetup

Macros:
    syrsetup
    Usage: syrsetup <sernum> <address> <volume_mne> <model_11>
    setup of the syringe pump:
    <sernum> : spec serial line unit. It has to be a device server as we need to configure 2 stop bits
    <address> : address of the pump as configured on the controller
    <volume_mne> : counter mnemonic to hold volume infused value

    syron
    Usage: syron
    Activate volume infused counter on each count

    syroff
    Usage: syroff
    De-activate volume infused counter. resets to 0.

    syrshow
    Usage: syrshow
    Shows current syringe configuration

    syrmodel
    Usage: syrmodel
    Display current syringwe pump model as cofnigured in syrsetup

    syrclose
    Usage: syrclose
    Close remote connection to the controller and allow keyboard interaction

    syrstop
    Usage: syrstop
    Stops the pump

    syrstart
    Usage: syrstart <target_volume>
    Start the pump up to <target_volume> infused. Units is as set in syrconfig.

    syrconfig
    Usage: syrconfig [<diameter> <rate> <unit>]
    Configure syringe pump parameters:
    <diameter> : syringe diameter in mm.
    <rate> : pump flow rate
    <unit> : rate unit

Internal Macros:
    _syrpump_initarr
    Usage: _syrpump_initarr


    syrunsetup
    Usage: syrunsetup
    setup cleanup

    _syrpump_getcounts
    Usage: _syrpump_getcounts


    _syrpump_getvolume
    Usage: _syrpump_getvolume()


    _syrpump_initserial
    Usage: _syrpump_initserial


    _syrpump_io
    Usage: _syrpump_io(cmd, inval, outval)


    _syrpump_getpar
    Usage: _syrpump_getpar


    syrflush
    Usage: syrflush


    _syrpump_config
    Usage: _syrpump_config(diameter, rate, unit)


    _syrpump_set_unit
    Usage: _syrpump_set_unit(value)


    _syrpump_set_rate
    Usage: _syrpump_set_rate(value)


    _syrpump_set_diameter
    Usage: _syrpump_set_diameter(value)


Filename: syrpump.mac
Author: E.Papillon
Last mod.: 03/12/2014 16:07 by claustre