source: pvMail/doc/source/index.rst @ 933

Last change on this file since 933 was 933, checked in by jemian, 10 years ago

report the documentation build date rather than SVN revision number

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.3 KB
Line 
1.. $Id: index.rst 933 2012-06-14 20:42:54Z jemian $
2
3PvMail
4==================================
5
6https://subversion.xray.aps.anl.gov/bcdaext/pvMail/doc/build/html/index.html
7
8PvMail was built to watch (monitor) an EPICS PV and send an email
9when the value of that PV changes from 0 to 1. 
10
11..      sidebar:: IMPORTANT:
12
13        PvMail *only* triggers when the trigger_PV makes a transition from 0 to 1.
14       
15        * It will ignore transitions (in floating-point PVs) to
16          1.0000... that do not come directly from 0.0000...
17          If you wish to watch a PV that presents values other than 0 and 1,
18          then use a calculation PV as the trigger which results in a
19          transition from 0 to 1.
20        * Reset the value of the trigger_PV to 0 to resume watching
21          for the next triggered event.
22
23The PV being watched (that *triggers* the sending of the email)
24can be any EPICS record type or field
25that results in a value of 0 (zero) that changes to 1 (one).  This
26includes these EPICS records (and possibly more):
27*ai*, *ao**bi*, *bo*, *calcout*, *scalcout*, *swait*, ...
28
29When an event causes an email to be triggered, PvMail will retrieve
30the value of another PV that is the first part of the message to be
31sent.  Additional metadata will be appended to the message.
32
33.. note::
34        Email is sent using a call to the ``sendmail`` program on the native OS.
35        This almost certainly precludes its use on Windows systems.
36        The GUI or command-line versions will operate but likely no email
37        is sent.  Also, the host computer must allow and be configured for
38        sending email to the intended recipients.
39
40PvMail provides either a command-line interface or a graphical user
41interface.  Both are accessed from the same command, using different
42command-line options.  The command-line version is intended to run
43as a background program, it has no user interaction but logs all its
44output into a log file.  The GUI version provides a screen to edit
45each of the parameters before the background process is started. 
46It also provides buttons to start and stop the background process.
47
48Overview of Contents
49========================
50
51.. toctree::
52   :maxdepth: 2
53   
54   contents
55
56
57Glossary
58========
59
60:index:`CA`
61    EPICS Channel Access protocol
62
63:index:`CLI`
64    command-line interface
65
66:index:`EPICS`
67    http://www.aps.anl.gov/epics
68
69:index:`GUI`
70    graphical user interface
71
72:index:`IOC`
73    EPICS Input/Output Controller, the EPICS server
74
75:index:`message PV`
76    EPICS PV that provides the text to be sent by email,
77    additional metadata is appended to this text
78
79:index:`OS`
80    operating system
81
82:index:`PV`
83    EPICS process variable
84
85:index:`PyEpics`
86    Python package to manage connections with PVs served by an EPICS IOC
87
88:index:`Traits`
89    Python package to simplify construction of a GUI
90
91:index:`trigger PV`
92    EPICS PV that signals an email is to be sent
93
94
95Dependencies
96============
97
98This software was built with various standard Python packages
99available in Python 2.7.  Additionally, this program uses:
100
101.. index:: PyEpics
102
103*PyEpics* (EPICS interface)
104        http://cars9.uchicago.edu/software/python/pyepics3/
105
106.. index:: Traits
107
108*Traits* (GUI library)
109        http://code.enthought.com/projects/traits/
110
111Both of these are available for
112`easy_install <http://packages.python.org/distribute/easy_install.html>`_ 
113from the Python Package Index (http://pypi.python.org/pypi).
114
115
116*This documentation was built:* |today|
Note: See TracBrowser for help on using the repository browser.