esrf

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

ICPLUS.MAC
See other macros in category: Detection BPM
Description:
    Macros for operating the Oxford Danfysik 4-channel IC_PLUS electrometer
Documentation:
    OVERVIEW
    This macro set allows to control IC-PLUS units in spec and configure their signal inputs as pseudocounters.
    More than one IC-PLUS unit can be operated through this macro set.

    EXAMPLE
    icplussetup mydev 0 c1=curr1 c2=curr2 c3=curr3 c4=curr4
    Configures an IC-PLUS unit connected to the spec serial line #0 and associates its four input channels to the pseudocounters curr1, curr2, curr3 and curr4.
    icplussetup bpm0 id33/sl_lid331/3 c1c2=beamX c3c4=beamY
    Configures an IC-PLUS unit connected through the serial line device id33/sl_lid331/3. Associates normalised current differences to the pseudocounters beamX and beamY.
    icplus
    Display the list of IC-PLUS units currently configured.


Macros:
    icplussetup
    Usage: icplussetup <icpname> <serline> [<parameter>=<value> ...]
    Configures a IC-PLUS connected to <serline> with the name <icpname>. The following optional parameters can be also set.
    • Valid parameters:
      address=<addr>
      This parameter allows to address a particular unit when the serial line is shared by several IC-PLUS units. The default address is 0.
      c1=<cnt_mne>
      c2=<cnt_mne>
      c3=<cnt_mne>
      c4=<cnt_mne>
      If <cnt_mne> is a valid counter mnemonic, it gets configured as a pseudocounter loaded with the current in the corresponding channel (1 to 4). The "Scale Factor" value in the spec config file applies.
      c1c2=<cnt_mne>
      c3c4=<cnt_mne>
      If <cnt_mne> is a valid counter mnemonic, it gets configured as a pseudocounter loaded with the normalised current difference (c1-c2)/(c1+c2) or (c3-c4)/(c3+c4). The "Scale Factor" value in the spec config file applies.
      c12c34=<cnt_mne>
      c13c24=<cnt_mne>
      If <cnt_mne> is a valid counter mnemonic, it gets configured as a pseudocounter loaded with the normalised current difference (c1+c2-c3-c4)/(c1+c2+c3+c4) or (c1-c2+c3-c4)/(c1+c2+c3+c4). The "Scale Factor" value in the spec config file applies.
      autorange[=YES]
      Sets the autorange mode
      window={<wtime> | AUTO}
      Sets the integration window width to <wtime> seconds or to auto mode. The width range of the integration time window is limited.


    icplusrange
    Usage: icplusrange {<full_scale> | <range>} [<unit>]


    icplusauto
    Usage: icplusauto
    Adjusts the gain range

    icplus
    Usage: icplus
    Shows the list of IC-PLUS units configured

Internal Macros:
    _icplussetup
    Usage: _icplussetup(args)


    icp_add_pseudo
    Usage: icp_add_pseudo


    icplusunsetup
    Usage: icplusunsetup


    icplus_conf
    Usage: icplus_conf(icpname, comm)


    icplus_read
    Usage: icplus_read(icpname, comm)


    icplus__comm
    Usage: icplus__comm(icpname, comm, read)


    icplus__put
    Usage: icplus__put(comdev, mode, comm)


    icplus__get
    Usage: icplus__get(comdev, mode)


    icplus_setwin
    Usage: icplus_setwin (<icpname>, <itime>)
    Sets the integration window <wtime> in sec

    icplus_setrange
    Usage: icplus_setrange (<icpname>, <range>)
    Selects one of the 6 available gain ranges (1 to 6).

    icplus_getrange
    Usage: icplus_getrange (<icpname>)
    Returns the currently selected gain range (1 to 6).

    icplus_setfullscale
    Usage: icplus_setfullscale (<icpname>)


    icplus_default
    Usage: icplus_default()


    icplus_getcounts
    Usage: icplus_getcounts(icpname, auto)


Filename: icplus.mac
Author: P.Fajardo, (Original 04/05). $Revision: 1.2 $ / $Date: 2008/07/17 14:19:34 $
Last mod.: 17/07/2008 16:19 by rey