esrf

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

OPIOM.MAC
[ source code | installed at | configured at ]
See other macros in category: Generic I/O Isg
Description:
    OPIOM.MAC - Macros for operating and testing OPIOM units
Documentation:
    OVERVIEW
    An interactive macro opiom can be used for device configuration and monitoring.
    More than one OPIOM module can be operated through this macro set.

    EXAMPLE
    opiomsetup op1 2 address=O1
    Configures a OPIOM unit connected to the serial line #2 with address O1 and assigns the name \"op1\" to it .
    opiomsetup ldet2 id33/serial/0 address=2
    Configures a OPIOM unit connected in the second position of a daisychain accesed by the ESRF device id33/serial/0 and assigns the name \"ldet2\" to it .
    opiom
    Starts the interactive test program with the default module.


    DEPENDENCIES
    These macros make use of the following macro sets:
    • stlist.mac
    • isgdevice.mac
    • isg.mac


    SETUP
    A opiomsetup macro must be included in the setup file for every OPIOM module configured. Each module is identified by its name that must be a unique isgdevice identifier.

Macros:
    opiomsetup
    Usage: opiomsetup <opiom_name> <serline> [<parameter>=<value> ...]
    Configures an opiom module connected to <serline> with the name <opiom_name>. 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 isgdevices in dasychain. If <addr> is a non-numerical value, it is treated as the isgdevice address set by the ADDR command and stored internally in the unit. On the other hand if <addr> is a numerical value it indicates the relative position of the module in the serial line chain starting from 0. If this parameter is not specified, spec looks for the first module in the chain.


    opiom
    Usage: opiom [<device_name>]
    Macro that runs the interactive loop. opiom refresh certain information on the screen and at the same time accepts commands from the standard input.


Internal Macros:
    _opiomsetup
    Usage: _opiomsetup(args)


    opiomunsetup
    Usage: opiomunsetup


    opiom_setdefault
    Usage: opiom_setdefault(isgname)


    opiom_update
    Usage: opiom_update


    opiom_getstate
    Usage: opiom_getstate(isgname)


    opiom_prompt
    Usage: opiom_prompt
    Displays the prompt on the screen. If the "update" flag is set also displays the board status.

    opiom_show_comm
    Usage: opiom_show_comm


    opiom_process_comm
    Usage: opiom_process_comm


    opiom_getopmoffsets
    Usage: opiom_getopmoffsets(opmarray, roffsets)


    opiom_calcoffset
    Usage: opiom_calcoffset(data, i)


    opiom_opm_header
    Usage: opiom_opm_header(path, file, opminfo)


    opiom_opm_hextract
    Usage: opiom_opm_hextract(line, field)


    opiom_list_files
    Usage: opiom_list_files(path, pldid)


    opiom_upload_program
    Usage: opiom_upload_program(opiom_name, file)


    opiom_cpld_prog
    Usage: opiom_cpld_prog(name, dat, binsz, srcsz, fsize, pldid, pldname)


    opiom_bin_tpg
    Usage: opiom_bin_tpg(opiom_name, tpgtab, nlines)


Filename: opiom.mac
Author: P.Fajardo, (Original 04/02). $Revision: 1.6 $ / $Date: 2009/01/16 10:34:52 $
Last mod.: 16/01/2009 11:38 by guilloud