You are here: Foswiki>Frontend Web>AutoDoc>ToolsOverview (02 Sep 2020, TobiasHabermann)Edit Attach
This content was generated by autodoc on 2020-09-02 12:26:45.496479 from all tools in

1. Equipment Access

(i|d|p)dex

  • description: Access devices and their properties via their nomen.
  • usage: (i|d|p)dex [(Nomen | FecName) [Property [Item[=VAL]]] [options]] [-h]
  • author: MAW
  • tags: dex, fesa, frontend
  • documentation: https://www-acc.gsi.de/wiki/FESA/FESA-Device-Explorer
  • help:
    usage: (i|d|p)dex [(Nomen | FecName) [Property [Item[=VAL]]] [options]] [-h]
    
    Examples:
      pdex NOMEN 
      idex NOMEN Setting     -s p3
      ddex NOMEN Acquisition -s p3:7
      pdex NOMEN Power power=0
      pdex scuxl0666 / pdex 666
      ddex -h
    
    Nomen and FEC names can be specified case insensitive. Option '-a'
    suppresses that. Property names & value items are case sensitive.
    Standard properties can be abbreviated with their first letter(s): 
    'a' = 'Acquisition', 'c' = 'Configuration', 'm'  = 'ModuleStatus'
    'p' = 'Power'      , 's' = 'Setting'      , 'st' = 'Status'
    'r' = 'RunTimeInfo', 'v' = 'Version'
    
    Accessing via FEC name checks DB for devices on FEC and allows to
    execute dex on all devices. Asks for permission to proceed if there
    are more than a few devices on the FEC (if performance critical).
    
    Long HELP with option '-h'.
    
    positional arguments:
      Nomen | FecName       Nomen of device or name of specific FEC.
      Property              Property to call.
      Item                  Item to set or get.
    
    optional arguments:
      -h, --help            show this help message and exit
      -a, --caseSensitive   Read nomenclatures cAse sensitive.
      -b, --blackAndWhite   Disables all coloring. Just plain black and white.
                            Kind of boring, but good for white backgrounds.
      -c, --contextInfo     Read Config and ModuleStatus properties to get some
                            context for the state of the hardware and low level
                            information.
      -d, --showDetailedStatus
                            Prints the detailed status if evoking status property.
      -e ENV, --env ENV     ONLY IF 'dex' IS USED WITHOUT PREFIX (ddex, idex, pdex
                            have it already selected): ENV = dev | int | pro.
      -f FILEPATH, --file FILEPATH
                            Specify input file for batch processing.
      -i, --info            Call Acquisition and Setting property. (Syntactic
                            sugar, if you like.)
      -l, --list-properies  List properties of device.
      -m, --monitorSubscribe
                            Subscribe to property and get notified on change.
      -M FREQ, --monitorTime FREQ
                            Monitors the property. Calls it every FREQ seconds.
      -n, --neighbors       Read neighbors of the device (devices residing on the
                            same SCU) from DB and print them.
      -o, --nodalish        Access properties via numberdriven menu.
      -p, --proceed         Disables warning for performance critical calls and
                            proceeds.
      -s SEL, --selector SEL
                            Add selector SEL (only BPs supported) in the format
                            'pN' with 0 < N < 1024. For multiple processes (e.g. 3
                            to 7) use 'p3:7'. Special functions: Use '-scanlsa' to
                            ask LSA DB which BPs where supplied with data. Or
                            specify a property and use '-scandev' to ask the
                            device for which BPs the property has data (parameter
                            N: '-scandevN' with 0 < N < 1024, default: N=20).
                            Example: 'ddex NOMEN PROPERTY -scandev'.
      -u, --multipleExec    Enables execution of chosen functionality for all
                            devices of a fiven FEC name. Works only with FEC name,
                            not with '-n' option.
      -w, --weird           Invoke in weird mode. ;)
      -x DEVSERVER, --xternalDev DEVSERVER
                            Allows you to specify the server of the class manually
                            in the form 'deployUnitName.frontend123'. Does not use
                            the FESA DB.
      -z, --zzzz            Expand nomenclature.
    
    

fesa-dev-dump

  • description: dump data from FESA devices to file
  • usage: fesa-dev-dump [-h] [--pro|--dev|--int] [--prior] [-a] [-c] [-d] [-f] [-o FILE] [-p PROCESS] [-q] [-s SELECTOR] [-S SERVER] NOMEN [PROPERTY]
  • author: UK
  • tags: property, data
  • documentation: https://www-acc.gsi.de/wiki/FESA/FESA-Tools-fesa-dev-dump-load
  • help:
    usage: fesa-dev-dump [-h] [--pro|--dev|--int] [--prior]
                         [-a] [-c] [-d] [-f] [-o FILE] [-p PROCESS] [-q] [-s SELECTOR] [-S SERVER]
                         NOMEN [PROPERTY]
    
    dump data from FESA devices to file
    
    positional arguments:
      NOMEN                 device nomenclature
      PROPERTY              device property (optional, default: Setting)
    
    optional arguments:
      -h, --help            show this help message and exit
      --dev                 select development environment
      --int                 select integration environment
      --pro                 select production environment
      --prior               use previous version of program
      -a, --caseSensitive   read nomenclatures cAse sensitive
      -c, --computer        NOMEN is a front-end computer
      -d, --display_only    read data and display only, no writing to file
      -f, --force           do not prompt for dump action
      -o OUTPUT, --output OUTPUT
                            name of output-file (default: <nomen>.dmp)
      -p PROCESS, --process PROCESS
                            list of beam process numbers and ranges,
                              shortcut for -s P=<beam process numbers>
                              specify ranges with hyphen, like 4-17
                              e.g. -p 4,5,10-15,19,30-36
                              no spaces allowed in list
      -q, --quiet           do not display read data
      -s [SELECTOR], --selector [SELECTOR]
                            selector for data-indexing
                              C|T|S|P=<list of indexes and ranges>  no space between list elements
                              e.g. C=1,3,5-8   chain indexes 1,3,5,6,7,8
                              P=3,5-9 is equivalent to -p 3,5-9
      -S SERVER, --server SERVER
                            name of front-end server
      --version             show program's version number and exit
    
    

fesa-dev-load

  • description: load data which are dumped by fesa-dump
  • usage: fesa-dev-load [-h] [--pro|--dev|--int] [--prior] [-f] [-p PROCESS-list] [-q] [-s SELECTOR-list] [-S SERVER] [-v] [-n NOMEN] FILE
  • author: UK
  • tags: property, data
  • documentation: https://www-acc.gsi.de/wiki/FESA/FESA-Tools-fesa-dev-dump-load
  • help:
    usage: fesa-dev-load [-h] [--pro|--dev|--int] [--prior]
                         [-f] [-p PROCESS-list] [-q] [-s SELECTOR-list] [-S SERVER] [-v] [-n NOMEN]
                         FILE
    
    load data which are dumped by fesa-dump
    
    positional arguments:
      FILE                  dumped data file
    
    optional arguments:
      -h, --help            show this help message and exit
      --dev                 select development environment
      --int                 select integration environment
      --pro                 select production environment
      --prior               use previous version of program
      -f, --force           do not prompt for load action (take care!)
      -n NOMEN, --nomen NOMEN
                            list of nomenclatures, override nomen-entries from file
      -p PROCESS, --process PROCESS
                            list of beam process numbers and ranges,
                              shortcut for -s P=<beam process numbers>
                              ** override selectors from file **
                              specify ranges with hyphen, like 4-17
                              e.g. -p 4,5,10-15,19,30-36
                              no spaces allowed in list
      -q, --quiet           do not display written data
      -s [SELECTOR], --selector [SELECTOR]
                            selector for data-indexing
                              ** override selectors from file **
                              C|T|S|P=<list of indexes and ranges>  no space between list elements
                              e.g. C=1,3,5-8   chain indexes 1,3,5,6,7,8
                              -P=3,5-9 is equivalent to -p 3,5-9
      -S SERVER, --server SERVER
                            name of front-end server
      -v, --verbose         verbose, display data values
    
    

2. Device Information

archive_rader

  • description:
  • usage:
archive_reader --nomen=NOMEN --property=PROPERTY [time_point] [duration]
  • author: T.H.
  • tags: archive, diagnosis
  • version: 1.0
  • documentation: https://www-acc.gsi.de/wiki/FAIR/Intern/MASPArchiving
  • environment: pro
  • requires: Archiving System
  • help:
    Reads raw archived data from the Archiving System.
    
    usage: archive_reader --nomen=NOMEN --property=PROPERTY [time_point] [duration]
    
       --help/-h
          Display this help text
       --nomen
          nomen of the equipment
       --property
          name of the property
       time_point
          Year, month, date, hour, minute and second can
          be choosen individually. The default is the current date.
          Only parts that are explicitly stated are replaced in the default.
          The pattern is ^(Y|M|D|h|m|s)[0-9]{1,2}$
          Note that also for year only two digits have to be supplied (eg 2019->19)
          For example: M10 D1 h12 m0 s0 is October 1st 12:00:00 of the current year.
       duration
          duration is either in seconds or minutes, only two digits allowed.
          The pattern is ^[0-9]{1,2}(m|s)
          For example: 20 seconds: 20s, 30 minutes: 30m
          default duration is 30s
    
    

masp_archive_parser

  • description: Parses masp archive data
  • usage: masp_archive_parser [-h] file
  • author: T.H.
  • tags: masp, archiving
  • help:
    usage: masp_archive_parser [-h] file
    
    Parses masp archive data
    
    positional arguments:
      file        name of the file
    
    optional arguments:
      -h, --help  show this help message and exit
    
    

snoopy-spy

  • description: Live display of timing events and scheduled chains.
  • usage: snoopy-spy [-h] [--mode {GRAPH,CHAINS,BOTH}] [--detail DETAIL] [--update UPDATE] [--device DEVICE] [--fec FEC] [--ascii ASCII] {int,dev,pro}
  • author: T.H.
  • tags: timing,display
  • environment: int/pro
  • requires: WRSnoop instance, lsa-rest for mode == GRAPH
  • help:
    usage: snoopy-spy [-h] [--mode {GRAPH,CHAINS,BOTH}] [--detail DETAIL]
                      [--update UPDATE] [--device DEVICE] [--fec FEC]
                      [--ascii ASCII]
                      {int,dev,pro}
    
    Live display of timing events and scheduled chains.
    
    positional arguments:
      {int,dev,pro}         environment
    
    optional arguments:
      -h, --help            show this help message and exit
      --mode {GRAPH,CHAINS,BOTH}
      --detail DETAIL       number of lines per chain. 0 only shows timestamp of
                            last event (default: 100)
      --update UPDATE       waits for this number of notifications from the
                            WRSnoop (default: 20)
      --device DEVICE       the NOMEN of the WRSnoop (default: ZT00ZM01)
      --fec FEC             the FEC where the WRSnoop is running (default: )
      --ascii ASCII
    
    Note: To subsribe to a different instance than the default you have to supply
    both the --fec and --device arguments. eg: snoopy-spy pro --fec=fecl003
    --device=ZT00M02
    
    

3. Maintenance

pxe-config

  • description: Manage PXE boot symlinks in '/common/tftp/csco/pxe/pxelinux.cfg' for a specific host.
  • usage: pxe-config [-c][-r][-l]
  • author: Alexander Schwinn
  • tags: pxe,config,symlinks
  • environment: int/pro/dev
  • help:
    pxe-config [-c][-r][-l]
    
    This script will manage PXE boot symlinks in '/common/tftp/csco/pxe/pxelinux.cfg' for a specific host.
    
    Arguments:
    
      -c create PXE boot symlinks for host
         If no ramdisk is specified in the arguments, the latest ramdisk 'scuxl' will be used for that host.
         On the next reboot the host should load the specified ramdisk (if the host is setup for PXE boot)
      -r remove PXE boot symlinks for host
      -l list PXE boot symlinks for a host or a ramdisk. If no search term is specified, all symlinks will be listed
    
    Example:
      pxe-config -c scuxl0815 scuxl.enigma
      pxe-config -r scuxl0815
      pxe-config -c scuxl0815
      pxe-config -l scuxl0815
      pxe-config -l scuxl.enigma
      pxe-config -l
    
    Available OS images (Nov. 2019) :
    
         Name: scuxl
    
              The default ramdisk is a 'moving target', it will receive
              updates/upgrades from time to time. It will ship the same
              kernel as the asl cluster
              It is the default ramdisk because it was officially decided
              to have a 'moving target'.
              The downside of using a moving target is that maintenance
              updates of the ramdisk may lead to incompartibilities with
              the Timing firmware.
              So after a maintenance update it might happen that software
              on a FEC will refuse to work after a reboot. If you dont want
              to take that risk, you may want to use a fixed target ramdisk
    
         Name: scuxl.enigma
         Name: scuxl.doomsday
    
              Use one of these ramdisks if you want to stick to a specific
              target, e.g. guaranteed to work with a specific timing firmware.
              NOTE: This ramdisk may run a slighly different kernel than
              the asl cluster. This may lead to problems.
    
    
    

4. Development, Release, Rollout

autodoc

  • description: Generate tools overview from output of autodoc enabled tools
  • usage: autodoc [-h] [--tools TOOLS [TOOLS ...]] [--tagged_files TAGGED_FILES [TAGGED_FILES ...]] [--black_list BLACK_LIST] [--format FORMAT [FORMAT ...]] [--outfile OUTFILE] [--verbose] {generate}
  • author: T.H.
  • tags: doc,html,overview
  • version: 2.0
  • documentation: https://www-acc.gsi.de/wiki/Frontend/AutoDoc
  • help:
    usage: autodoc [-h] [--tools TOOLS [TOOLS ...]]
                   [--tagged_files TAGGED_FILES [TAGGED_FILES ...]]
                   [--black_list BLACK_LIST] [--format FORMAT [FORMAT ...]]
                   [--outfile OUTFILE] [--verbose]
                   {generate}
    
    Generate tools overview from output of autodoc enabled tools
    
    positional arguments:
      {generate}            
                            generate - generates tools overview from tools (--tools & --tagged_files). 
                                The output is stored in files named --outfile with extensions depending  
                                on the chosen output format (--format). 
                                No information will be collected from tools listed in the --black_list file.
                                (more options will be added later, currently this argument is redundant)
    
    optional arguments:
      -h, --help            show this help message and exit
      --tools TOOLS [TOOLS ...]
                            list of directories or paths to tools
      --tagged_files TAGGED_FILES [TAGGED_FILES ...]
                            list of files containing tools information in tagged format
      --black_list BLACK_LIST
                            black list file. Contains one tool per line that should be skipped
      --format FORMAT [FORMAT ...]
                            List of output formats to be generated. 
                            Each output will be stored in a seperate file with the respective extension. 
                            Possible formats are pretty, wiki, html, tagged.
                            Only .tagged files can be read later by autodoc.
                            
                            "Expert":
                            The output format for the individual tools and the overview can be selected separately.
                            pretty, wiki, html and tagged are shortcuts for pp, ww, hh, tt.
                            For example pw can be useful when generating wiki text for a single tool.
                            The first character selects the overview format:
                              p/t - no formatting. only concatenate formatted tools
                              w/h - wiki/html overview including a table of contents
                            The second character selects format of individual tools:
                              p - pretty (plain string for debugging, not actually pretty)
                              t - tagged
                              w - wiki
                              h - html
      --outfile OUTFILE
      --verbose             flag to enable verbose mode of generate and dump
    
    

daqt

  • description: Display analog values of ADDAC DAQs via Gnuplot for testing.
  • usage: daqt {SCU- target IP-address} [-h, --help] [-V, --version] [-S, --scan] [-n, --noreset] [-N, --nocommand] [-C =ARG, --continue =ARG] [-H, --high-resolution] [-P, --post-mortem] [-l ARG, --limit ARG] [-d ARG, --delay ARG] [-c ARG, --condition ARG] [-t, --trigger] [-E, --continuous-extern] [-e, --highres-extern] [-r, --restart] [-v, --verbose] [-z, --zoom] [-G ARG, --gnuplot ARG] [-T ARG, --terminal ARG] [-o ARG, --output ARG]
  • author: Ulrich Becker
  • tags: graphics,etherbone
  • version: 0.5
  • requires: Gnuplot, socat, LM32-firmware scu_control or daq_control
  • help:
    Usage: /common/usr/cscofe/bin//daqt <SCU- target IP-address> [global-options] [<slot-number> [device-options] <channel-number> [channel-options]] 
    
    Global-options can be overwritten by device-options and device options can be overwritten by channel-options.
    NOTE: The lowest slot-number begins at 1; the lowest channel-number begins at 1.
    
    Hot keys:
    s: Shows the currently configuration
    p: Triggering a post mortem event
    h: Triggering a high resolution event
    r: Reset
    c: Clears the data buffer
    i: Toggling receiving on / off
    l: Show currently RAM level
    Esc: Program termination
    
    Commandline options:
    
    -h, --help
       Print this help and exit
    
        --generate_doc_tagged
       Will need from autodoc.
    
    -V, --version
       Print the software version and exit
    
    -S, --scan
       Scanning of the entire SCU-bus for DAQ- devices and its channels and print the results as table and exit.
       The first column shows the slot number and the second column the number of channels.
       Output example:
          3 4
          9 4
          Means: DAQ in slot 3 found with 4 channels and DAQ in slot 9 found with 4 channels.
    
    -n, --noreset
       Omitting of the reset command.
       CAUTION: If this option appearing before the first argument <proto/host/port>
       then the reset command becomes omitted on program start and end,
       otherwise only on program end the reset command becomes omitted.
    
    -N, --nocommand
       Disables the command sending to LM32.
       That means the program runs in passive mode.
       In this case it will prerequisites that the GSI-SAFTLIB is the master.
       CAUTION: This option has to appear before the first argument <proto/host/port>,
       else the initializing commands will send never the less!
    
    -C [=PARAM], --continue [=PARAM]
       Starts the continuous mode 
       PARAM:
          1MS Sample rate   1 ms
          100US Sample rate 100 us
          10US Sample rate  10 us
       Default value is 1ms
       Example:
          C=100US
          Means: Continuous mode with sample rate of 100 us
    
    -H, --high-resolution
       Starts the high resolution mode
    
    -P, --post-mortem
       Starts the post-mortem mode
    
    -l <PARAM>, --limit <PARAM>
       Limits the maximum of data blocks in the continuousmode.
       The value zero (default) establishes the endless mode.
    
    -d <PARAM>, --delay <PARAM>
       PARAM sets the trigger delay in samples for the continuous mode
    
    -c <PARAM>, --condition <PARAM>
       PARAM sets the timing value of the trigger condition
    
    -t, --trigger
       Enables the trigger mode for continuous- and high-resolution mode
    
    -E, --continuous-extern
       Sets the trigger source for the continuous mode from the event-trigger (default)
       into the external trigger input
    
    -e, --highres-extern
       Sets the trigger source for the high-resolution mode from the event-trigger (default)
       into the external trigger input
    
    -r, --restart
       Restarts the high-resolution or post-mortem mode after an event
    
    -v, --verbose
       Be verbose
    
    -z, --zoom
       Zooming of the Y-axis in GNUPLOT.
    
    -G <PARAM>, --gnuplot <PARAM>
       Replacing of the default Gnuplot binary by the in PARAM given binary. Default is: /usr/bin/gnuplot
    
    -T <PARAM>, --terminal <PARAM>
       PARAM replaces the terminal which is used by Gnuplot. Default is: "X11 size 1200,600"
    
    -o <PARAM>, --output <PARAM>
       Setting the prefix and suffix file name for Gnuplot. PARAM is the path and name of the output file.
       NOTE: The final file name becomes generated as follows:
             <SUFFIX>_<SCU-name>_<slot number>_<channel number>_<wr-time stamp>.<PREFIX>
       Example: PARAM = myFile.png:
                result: myFile_scuxl0035_acc_gsi_de_3_1_12439792657334272.png
    
    
    

docfsm

  • description: Documentation and develop tool for visualizing of Finite State Machines from source code written in C or C++, via Graphviz and/or Image Magick.
  • usage: docfsm [-h, --help] [-v, --verbose] [-V, --version] [-t ARG, --transition ARG] [-e ARG, --trSelf ARG] [-d ARG, --declare ARG] [-i ARG, --init ARG] [-c ARG, --call ARG] [-r ARG, --return ARG] [-l, --list] [-I ARG, --include ARG] [-D ARG, --define ARG] [-U ARG, --undefine ARG] [--std ARG] [-p ARG, --cpp-path ARG] [-G ARG, --graph ARG] [-N ARG, --node ARG] [-E ARG, --edge ARG] [-s, --single] [-u, --nostategroups] [-f, --nofsmgroups] [-T, --notransitions] [-O, --noTrLabel] [-L, --trTooltip] [-n, --nomerge] [--lNodes] [--lEdges] [--lGraph] {soucefile(s)}
  • author: Ulrich Becker
  • tags: graphics
  • version: 1.4
  • documentation: https://github.com/UlrichBecker/DocFsm
  • requires: Graphviz and/or Image Magick
  • help:
    
    DocFsm is a documentation and reverse engineering tool for graphical presentation of
    finite state machines (FSM) from C and/or C++ sourcefiles.
    
    It translates C/C++ sourcefiles containing a FSM - respectively containing
    for the FSM defined macros - into the DOT-language.
    
    (c) 2017 - 2020 Ulrich Becker
    
    Usage: /common/usr/cscofe/bin//docfsm [options,...] <C/C++ sourcefile [C/C++ sourcefile ...]>
    
    Example 1: Creating a dot-file from a C sourcefile:
    /common/usr/cscofe/bin//docfsm myFsm.c > myFsm.gv
    
    Example 2: Creating a PDF from a C++11 sourcefile with blue and thick transitions:
    /common/usr/cscofe/bin//docfsm -E style=bold -E color=blue --std c++11 -I /path/to/my/additional/headers myFsm.cpp | dot -Tpdf -o myFsm.pdf
    
    Example 3: Displaying directly from source file via Image Magick:
    /common/usr/cscofe/bin//docfsm myFsm.cpp | display
    
    Options:
    
    -h, --help
       Print this help and exit.
    
        --generate_doc_tagged
       GSI specific option will used from GSI-Autodoc only. (www.gsi.de)
    
    -v, --verbose
       Be verbose.
    
    -V, --version
       Print version and exit.
    
    -t <PARAM>, --transition <PARAM>
       Overwrites the list of state transition keywords by the in PARAM given keyword.
       NOTE: For each new keyword use a separate option-label.
       E.g.: -t FSM_MY_TRANSITION -t FSM_MY_TRANSITION_NEXT ...
    
    -e <PARAM>, --trSelf <PARAM>
       Overwrites the list of state self-transition keywords by the in PARAM given keyword.
       NOTE: For each new keyword use a separate option-label.
       E.g.: -e FSM_MY_TRANSITION_SELF -e FSM_MY_TRANSITION_SELF_NEXT ...
    
    -d <PARAM>, --declare <PARAM>
       Overwrites the list of state deceleration keywords by the in PARAM given keyword.
       NOTE: For each new keyword use a separate option-label.
       E.g.: -d FSM_MY_DECLARE_STATE -d FSM_MY_DECLARE_STATE_X ...
    
    -i <PARAM>, --init <PARAM>
       Overwrites the list of state initialization keywords by the in PARAM given keyword.
       NOTE: For each new keyword use a separate option-label.
       E.g.: -i FSM_MY_DECLARE_STATE -i FSM_MY_DECLARE_STATE_X ...
    
    -c <PARAM>, --call <PARAM>
       Overwrites the list of keywords for sub-FSM calling by the in PARAM given keyword.
       NOTE: For each new keyword use a separate option-label.
       E.g.: -c FSM_MY_CALL -c FSM_MY_CALL_NEXT ...
    
    -r <PARAM>, --return <PARAM>
       Overwrites the list of keywords for return statements from sub-FSMs by the in PARAM given keyword.
       NOTE: For each new keyword use a separate option-label.
       E.g.: -r FSM_MY_RETURN -r FSM_MY_RETURN_NEXT ...
    
    -l, --list
       Shows all keywords and exit.
    
    -I <PARAM>, --include <PARAM>
       Add the directory PARAM to the list of directories to be searched for header files.
       This option will forwarded directly to the preprocessor as option "-I"
    
    -D <PARAM>, --define <PARAM>
       Predefine PARAM as a macro, with definition 1
       A already predfined macro is __DOCFSM__
       This option will forwarded directly to the preprocessor as option "-D"
    
    -U <PARAM>, --undefine <PARAM>
       Cancel any previous definition of PARAM, either built in or provided with a -D option.
       This option will forwarded directly to the preprocessor as option "-U"
    
        --std <PARAM>
       Specify the standard to which the code should conform.
       This option will forwarded directly to the preprocessor as option "-std="
    
    -p <PARAM>, --cpp-path <PARAM>
       Replaces the default preprocessor "cpp" by the in PARAM named preprocessor.
       This could be necessary for cross-compiling.
    
    -G <PARAM>, --graph <PARAM>
       Set global graph attributes.
       NOTE: For each additional attribute use a separate option-label.
       E.g.: -G rankdir=LR -G rotate=90 -G "label=\"My very nice finite state-machine!\"" ...
    
    -N <PARAM>, --node <PARAM>
       Set global default node (state) attributes.
       NOTE: For each additional attribute use a separate option-label.
       E.g.: -N color=red  -N shape=house ...
       The default attribute "shape=Mrecord" will overwritten in any cases.
    
    -E <PARAM>, --edge <PARAM>
       Set global default edge (transition) attributes.
       NOTE: For each additional attribute use a separate option-label.
       E.g.: -E color=pink -E style=dashed ...
    
    -s, --single
       If given, than in the case of more then one source-file no
       additional clusters per source-file will build.
       The MODULE's of all source-files will put together in a single graph.
       E.g.: -s myFsmPart1.cpp myFsmPart2.cpp
    
    -u, --nostategroups
       Despite the DocFsm attribute "GROUP" is set or not,
       when this option is set no no state-groups will build.
    
    -f, --nofsmgroups
       No split in FSM-groups, when unconnected states detected.
    
    -T, --notransitions
       Print states only, no transitions.
    
    -O, --noTrLabel
       Omit printing of transition text-labels.
    
    -L, --trTooltip
       Generates a tool-tip attribute for each transition from
       a given transition label-text.
    
    -n, --nomerge
       Do not merge transitions with the same target in the same state.
    
        --lNodes
       List all supported keywords of node-attributes and exit.
       Note if the option -v input at first so the short description will also shown.
    
        --lEdges
       List all supported keywords of edge-attributes and exit
       Note if the option -v input at first so the short description will also shown.
    
        --lGraph
       List all supported keywords of principal graph attributes and exit.
       Note if the option -v input at first so the short description will also shown.
    
    
    

fesa-instance

  • description: modify device parameters in FESA instance files
  • usage: fesa-instance [options] cmd-file additional information: fesa-instance -h
  • author: UK
  • tags: instance-file, XML, device-instance configuration
  • documentation: https://www-acc.gsi.de/wiki/FESA/FESA-Update-InstanceFiles
  • help:
    
    usage:  fesa-instance [options]  <cmd-file>
      expects instance files in <base directory>/src/test/<front-end node>/
              instance files: DeviceData*.instance
      -d <base directory>     e.g. ~/workspace/PowerSupply_DU/
      -n <front-end node>     e.g. scuxl0037
                              multiple nodes: use wildcards, BUT ALWAYS QUOTE (or ESCAPE) WILDCARDS!!
                                       quoted wildcards: like -n '*' or -n 'scuxl0??3'
                              default: all nodes ('*')
      -t                      test-only, displays modifications, no update of instance files
      -u                      write nomenclatures not contained in <cmd-file> to file <cmd-file>-add
      -s                      update nomenclature sorted (alphgabetical order)
      -b <bitmap-definitions> file with bitmap definitions, in XML format
      -r                      read entry in instance file
                                entry to be specified by options -e or -v
        -p <deploy-unit>        for option -r: read instance file from productive directory
                                  (nfs directory, used by front-ends)
                                  wildcards are supported (MUST BE QUOTED)
        -e <event mapping>      for option -r: read event mapping from instance files
                                  multiple options -v are supported
        -v <value-location>     for option -r: read value from instance files
                                  multiple options -e are supported
        -i                      input compatible output, output can be used as cmd-file
    
      cmd-files:
      example:
        A <accumulation-name>
          v <location>  <value>  [<dimension>]
          v <location>  <value>  [<dimension>]
            . . .
          e <event-mapping> <value>
          e <event-mapping> <value>
            . . .
        A <accumulation-name>
          v <location>  <value>  [<dimension>]
            . . .
        G <group name>
          n <device name>
          n <device name>
          n <device name>
          . . .
        d <nomenclature>
          v <location>  <value>  [<dimension>]
          v <location>  <value>  [<dimension>]
          a <accumulation-name>
          a <accumulation-name>
          e <event-mapping> <value>
          e <event-mapping> <value>
            . . .
        d <nomenclature>
          v <location>  <value>  [<dimension>]
          v <location>  <value>  [<dimension>]
          a <accumulation-name>
          a <accumulation-name>
          e <event-mapping> <value>
          e <event-mapping> <value>
            . . .
        g <group name>
          v <location>  <value>  [<dimension>]
          v <location>  <value>  [<dimension>]
          a <accumulation-name>
          a <accumulation-name>
          e <event-mapping> <value>
          e <event-mapping> <value>
            . . .
    
    location:
      location within device-instance element, separated by dot,
      e.g. configuration.description, configuration.acceptFilledSelectors, setting.inverter
    variable:
      given as <value> <dimension>, dimension is optional (default: None)
      values containing blanks must be quotet, single (') or double (") quotes are supported
    accumulation:
      grouping of commands, which are executed commonly
    group:
      grouping of devices, commands are executed for each device in the group
    
    

mdaqt

  • description: Display actual- and set-values of MIL function generators via Gnuplot.
  • usage: mdaqt {SCU- target IP-address} [-G ARG, --gnuplot ARG] [-L, --list] [-S, --scan] [-T ARG, --terminal ARG] [-V, --version] [-a, --auto] [-c, --continue] [-d, --deviation] [-h, --help] [-l, --always] [-s ARG, --style ARG] [-t ARG, --time ARG] [-v, --verbose] [-z, --zoom]
  • author: Ulrich Becker
  • tags: graphics,etherbone
  • version: 0.9
  • requires: Gnuplot, socat, LM32-firmware scu_control
  • help:
    MIL-DAQ Plotter
    (c) 2019 GSI; Author: Ulrich Becker <u.becker@gsi.de>
    Usage: /common/usr/cscofe/bin//mdaqt <SCU- target IP-address> [options] [slot channel [slot channel ...]]
    
    Hot keys:
    r: Reset zooming of all plot windows
    i: Toggling receiving on / off
    s: Toggling single shoot mode on / off
    Esc: Program termination
    
    Commandline options:
    
        --generate_doc_tagged
       Will need from autodoc.
    
    -G <PARAM>, --gnuplot <PARAM>
       Replacing of the default Gnuplot binary by the in PARAM given binary. Default is: /usr/bin/gnuplot
    
    -L, --list
       Lists all connected function generators.
       NOTE: The verbosity mode (option -v has to be set before) will show all function-generators,
       otherwise only MIL- function-generators will shown.
       
    
    -S, --scan
       Scanning for all connected function generators.
       NOTE: The verbosity mode (option -v has to be set before) will show all function-generators,
       otherwise only MIL- function-generators will shown.
       CAUTION: Don't use this option during function-generators are running! Otherwise the timing becomes disturbed 
       and the function-generators will stopped!
       If you will list the found function generators without scanning only, so use the option "-L" respectively "--list".
    
    -T <PARAM>, --terminal <PARAM>
       PARAM replaces the terminal which is used by Gnuplot. Default is: "X11 size 1200,600"
    
    -V, --version
       Print the software version and exit.
    
    -a, --auto
       Automatically building of channel plot windows.
       That means no further arguments of slot and channel number necessary.
    
    -c, --continue
       Plotting continuously and not when enough data present only.
    
    -d, --deviation
       Enabling of plotting the deviation graph: set value minus actual value.
    
    -h, --help
       Print this help and exit
    
    -l, --always
       Plots always the set-value, even within a gap.
       Within a gab the last valid set-value will used.
       NOTE: In general, a gap-plotting needs a actual LM32 firmware, written by UB.
    
    -s <PARAM>, --style <PARAM>
       Setting of the Gnuplot line-style default is: "lines"
    
    -t <PARAM>, --time <PARAM>
       Length of the X-axis (time axis) in a range of 1.0 to 300.0 in seconds.
       If this option not given, so the default value of 10.0 seconds will used.
    
    -v, --verbose
       Be verbose
    
    -z, --zoom
       Zooming of the Y-axis (voltage axis) in GNUPLOT (auto-scaling).
    
    --------------------------------------------------
    Example a:
       /common/usr/cscofe/bin//mdaqt scuxl4711 -ac
       or
       /common/usr/cscofe/bin//mdaqt tcp/scuxl4711 -ac
    
       Will make a plot of all found MIL-function-generators.
    
    Example b:
       Step 1: Scanning for connected MIL-function generators:
    
          /common/usr/cscofe/bin//mdaqt scuxl4711 -S
    
       Resut (e.g.):
          fg-39-1
          fg-39-2
          fg-39-129
          fg-39-130
       In this example four MIL- function generators was found.
    
       Step 2: Now we intend to see the plots of "fg-39-2" and "fg-39-130" only:
    
          /common/usr/cscofe/bin//mdaqt scuxl4711 -c 39 2 39 130
    
    NOTE:
       Prerequisite for this program is, that the port forwarder demon "socat" runs
       in the concerning SCU.
       If not already running so you can accomplish that by invoking the shell script "start-socat.sh".
    
    
    

snoopy-rec

  • description: Record timing events to be replayed with saft-dm.
  • usage: snoopy-rec [-h] [--file FILE] [--device DEVICE] [--start_gid START_GID] [--start_sid START_SID] [--start_bpid START_BPID] [--start_evtno START_EVTNO] [--stop_gid STOP_GID] [--stop_sid STOP_SID] [--stop_bpid STOP_BPID] [--stop_evtno STOP_EVTNO] [--max_events MAX_EVENTS] {int,pro}
  • author: T.H.
  • tags: timing,wrsnoop,development,testing
  • environment: pro/int
  • requires: WRSnoop FESA instance
  • help:
    usage: snoopy-rec [-h] [--file FILE] [--device DEVICE] [--start_gid START_GID]
                      [--start_sid START_SID] [--start_bpid START_BPID]
                      [--start_evtno START_EVTNO] [--stop_gid STOP_GID]
                      [--stop_sid STOP_SID] [--stop_bpid STOP_BPID]
                      [--stop_evtno STOP_EVTNO] [--max_events MAX_EVENTS]
                      {int,pro}
    
    Record timing events to be replayed with saft-dm.
    
    positional arguments:
      {int,pro}             environment (default=int)
    
    optional arguments:
      -h, --help            show this help message and exit
      --file FILE           output filename (default: stdout)
      --device DEVICE       NOMEN of the WRSnoop instance (default: ZT00ZM01)
      --start_gid START_GID
                            GroupId of start event (default: None)
      --start_sid START_SID
                            SequenceId of start event (default: None)
      --start_bpid START_BPID
                            BeamProcessId of start event (default: None)
      --start_evtno START_EVTNO
                            EventNumber of start event (default: None)
      --stop_gid STOP_GID   GroupId of start event (default: None)
      --stop_sid STOP_SID   SequenceId of start event (default: None)
      --stop_bpid STOP_BPID
                            BeamProcessId of start event (default: None)
      --stop_evtno STOP_EVTNO
                            EventNumber of start event (default: None)
      --max_events MAX_EVENTS
                            Limit of events to record. (default: None)
    
    Note: If no mask for the start_event is specified recording starts
    immediately. If no mask for the stop_event and no max_events is specified,
    1000 events are recorded. When no filename is specified, output is redirected
    to stdout, ie you will see each event listed twice.
    
    

5. Helpers

6. Others

Topic revision: r16 - 02 Sep 2020, TobiasHabermann
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback