Changeset 903


Ignore:
Timestamp:
Jun 11, 2012 4:19:37 PM (10 years ago)
Author:
jemian
Message:

work-in-progress, we now have a test file

Location:
specdomain/src/test
Files:
1 added
2 edited

Legend:

Unmodified
Added
Removed
  • specdomain/src/test/sphinx_shutter.mac

    r902 r903  
    77# common/shutter
    88# ==============
    9 #
     9# 
    1010# NAME
    1111#   shutter.mac
    12 #
     12# 
    1313# SUMMARY
    1414#   Commands to control a fast photon shutter.
    15 #
     15# 
    1616# DESCRIPTION
    1717#   The macro causes the fast photon shutter to be opened immediately prior to
     
    1919#   delay time assures that the shutter is fully open before issuing the
    2020#   count command.
     21#
    2122#   The photon shutter is controlled via an EPICS binary output channel, and
    2223#   the shutter status is optionally monitored via a binary input channel (in
    2324#   which case the delay time is not used, but the monitor signal is used to
    2425#   check for completion of the opening process).
    25 #
     26# 
    2627# AUTHOR
    2728#   Christian M. Schlepuetz (CS, cschlep)
    28 #
     29# 
    2930# CREATION DATE
    3031#   2004/11/06
    31 #
     32# 
    3233# COPYRIGHT
    3334#   Copyright 2006-2011 by the above authors (see AUTHOR/AUTHORS)
    34 #
     35# 
    3536#   This program is free software: you can redistribute it and/or modify
    3637#   it under the terms of the GNU General Public License as published by
    3738#   the Free Software Foundation, either version 3 of the License, or
    3839#   (at your option) any later version.
    39 #
     40# 
    4041#   This program is distributed in the hope that it will be useful,
    4142#   but WITHOUT ANY WARRANTY; without even the implied warranty of
    4243#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    4344#   GNU General Public License for more details.
    44 #
     45# 
    4546#   You should have received a copy of the GNU General Public License
    4647#   along with this program.  If not, see http://www.gnu.org/licenses/.
    47 #
    48 # VERSION
     48#
     49# VERSION::
     50#
    4951#   $. Date: 2010-11-04 19:06:06 -0400 (Thu, 04 Nov 2010) $
    5052#   $. Author: cschlep $
    5153#   $. URL: file:///data/svn/software/spec/trunk/common/shutter.mac $
    5254#   $. Revision: 17 $
    53 #
     55# 
    5456# DEPENDENCIES
    5557#   Chained macro definitions affected by this macro:
     
    5759#   - user_getcounts
    5860#   - cleanup_always
    59 #
     61# 
    6062# HISTORY
    6163#   2004/11/06 (CS):
    62 #   - modified the first original version to comply with naming and format
     64#   
     65#   - modified the first original version to comply with naming and format
    6366#     conventions
    6467#   - implemented help-file support and wrote help texts.
    65 #
    66 #   2010/03/30 (CS):
    67 #   - added the following global variables to make macro more easily portable:
    68 #
    69 #     SHUTTER_CONTROL_PV      # EPICS PV name for the shutter control (bo)
    70 #     SHUTTER_CONTROL_OPEN    # EPICS control value for open shutter
    71 #     SHUTTER_CONTROL_CLOSED  # EPICS control value for closed shutter
    72 #     SHUTTER_STATUS_PV       # EPICE PV name for the shutter status (bi)
    73 #     SHUTTER_STATUS_OPEN     # EPICS status value for open shutter
    74 #     SHUTTER_STATUS_CLOSED   # EPICS status value for closed shutter
    75 #     SHUTTER_IS_ON           # flag for automatic shutter control
    76 #     SHUTTER_SLEEP_TIME      # SPEC sleep time after opening shutter
    77 #
     68#     2010/03/30 (CS):
     69#   - added the following global variables to make macro more easily portable::
     70#
     71#           SHUTTER_CONTROL_PV      # EPICS PV name for the shutter control (bo)
     72#           SHUTTER_CONTROL_OPEN    # EPICS control value for open shutter
     73#           SHUTTER_CONTROL_CLOSED  # EPICS control value for closed shutter
     74#           SHUTTER_STATUS_PV       # EPICE PV name for the shutter status (bi)
     75#           SHUTTER_STATUS_OPEN     # EPICS status value for open shutter
     76#           SHUTTER_STATUS_CLOSED   # EPICS status value for closed shutter
     77#           SHUTTER_IS_ON           # flag for automatic shutter control
     78#           SHUTTER_SLEEP_TIME      # SPEC sleep time after opening shutter
     79#
    7880#   2010/07/23 (CS):
    7981#   - added SVN keywords (replacing CVS keywords)
    80 #
     82# 
    8183#   2011/12/19 (CS):
    8284#   - reformatted code documentation to work with ROBODoc
    8385#   - added shutter_setup with following internal macros:
     86#
    8487#     * _shutter_print_setup
    8588#     * _shutter_set_option
    8689#     * _clear_screen
     90#
    8791#   - replaced SHUTTER_STATUS* with SHUTTER_MONITOR*
    8892#   - replaced global variables _OPEN with _OPEN_VAL and
     
    137141# =============================
    138142#
    139 # SUMMARY
    140 #   Displays the shutter help text.
     143# Displays the shutter help text.
    141144#
    142 # USAGE
     145# usage::
     146#
    143147#   > sh_help
    144148#
    145 # NOTE
     149# .. note::
    146150#   The help text is generated by simply displaying the text file
    147151#   shutter_mac.txt, which should reside in the same directory as shutter.mac.
  • specdomain/src/test/test_doc.rst

    r902 r903  
    1717::
    1818
    19         #===============================================================
    20         # file lp.mac
    21         # Written by X. Jiao 06/02/2005 Version 1.0
    22         #
    23         # Generic SPEC macros
    24         #
    25         # used to send the output of spec commands to the printer
    26         #==============================================================
    27         def lp '
    28                 close("/var/tmp/foo1")
    29                 unix("rm -f /var/tmp/foo1")
    30                 on("/var/tmp/foo1")
    31                 fprintf("/var/tmp/foo1","\n$*\n%s\n",date())
    32                 $*
    33                 off("/var/tmp/foo1")
    34                 u a2ps -f7 /var/tmp/foo1 |lpr
    35                 u rm /var/tmp/foo1
    36                 printf("$* has been sent to printer\n")
    37                
     19        ###############################################################################
     20        #        User macros to configure spec with the Image Server program
     21        ###############################################################################
     22       
     23        def ccdhelp '
     24            printf("\nUser macros for the BCDA ccd package\n")
     25            printf("\t%c%sccdsetup\n",27,"[1m")
     26            # ...
    3827        '
    3928       
Note: See TracChangeset for help on using the changeset viewer.