source: pvMail/doc/build/html/index.html @ 932

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

moving to new address: xor --> xray

  • Property svn:mime-type set to text/html
File size: 10.0 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>PvMail &mdash; PvMail 3 (3.0-r801) documentation</title>
12   
13    <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
14    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '',
19        VERSION:     '3 (3.0-r801)',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="_static/jquery.js"></script>
26    <script type="text/javascript" src="_static/underscore.js"></script>
27    <script type="text/javascript" src="_static/doctools.js"></script>
28    <link rel="top" title="PvMail 3 (3.0-r801) documentation" href="#" />
29    <link rel="next" title="Contents" href="contents.html" /> 
30  </head>
31  <body>
32    <div class="related">
33      <h3>Navigation</h3>
34      <ul>
35        <li class="right" style="margin-right: 10px">
36          <a href="genindex.html" title="General Index"
37             accesskey="I">index</a></li>
38        <li class="right" >
39          <a href="py-modindex.html" title="Python Module Index"
40             >modules</a> |</li>
41        <li class="right" >
42          <a href="contents.html" title="Contents"
43             accesskey="N">next</a> |</li>
44        <li><a href="#">PvMail 3 (3.0-r801) documentation</a> &raquo;</li> 
45      </ul>
46    </div>
47      <div class="sphinxsidebar">
48        <div class="sphinxsidebarwrapper">
49  <h3><a href="#">Table Of Contents</a></h3>
50  <ul>
51<li><a class="reference internal" href="#">PvMail</a></li>
52<li><a class="reference internal" href="#overview-of-contents">Overview of Contents</a><ul>
53</ul>
54</li>
55<li><a class="reference internal" href="#glossary">Glossary</a></li>
56<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
57</ul>
58
59  <h4>Next topic</h4>
60  <p class="topless"><a href="contents.html"
61                        title="next chapter">Contents</a></p>
62  <h3>This Page</h3>
63  <ul class="this-page-menu">
64    <li><a href="_sources/index.txt"
65           rel="nofollow">Show Source</a></li>
66  </ul>
67<div id="searchbox" style="display: none">
68  <h3>Quick search</h3>
69    <form class="search" action="search.html" method="get">
70      <input type="text" name="q" />
71      <input type="submit" value="Go" />
72      <input type="hidden" name="check_keywords" value="yes" />
73      <input type="hidden" name="area" value="default" />
74    </form>
75    <p class="searchtip" style="font-size: 90%">
76    Enter search terms or a module, class or function name.
77    </p>
78</div>
79<script type="text/javascript">$('#searchbox').show(0);</script>
80        </div>
81      </div>
82
83    <div class="document">
84      <div class="documentwrapper">
85        <div class="bodywrapper">
86          <div class="body">
87           
88  <div class="section" id="pvmail">
89<h1>PvMail<a class="headerlink" href="#pvmail" title="Permalink to this headline">¶</a></h1>
90<p><a class="reference external" href="https://subversion.xray.aps.anl.gov/bcdaext/pvMail/doc/build/html/index.html">https://subversion.xray.aps.anl.gov/bcdaext/pvMail/doc/build/html/index.html</a></p>
91<p>PvMail was built to watch (monitor) an EPICS PV and send an email
92when the value of that PV changes from 0 to 1.</p>
93<div class="sidebar">
94<p class="first sidebar-title">IMPORTANT:</p>
95<p>PvMail <em>only</em> triggers when the trigger_PV makes a transition from 0 to 1.</p>
96<ul class="last simple">
97<li>It will ignore transitions (in floating-point PVs) to
981.0000... that do not come directly from 0.0000...
99If you wish to watch a PV that presents values other than 0 and 1,
100then use a calculation PV as the trigger which results in a
101transition from 0 to 1.</li>
102<li>Reset the value of the trigger_PV to 0 to resume watching
103for the next triggered event.</li>
104</ul>
105</div>
106<p>The PV being watched (that <em>triggers</em> the sending of the email)
107can be any EPICS record type or field
108that results in a value of 0 (zero) that changes to 1 (one).  This
109includes these EPICS records (and possibly more):
110<em>ai</em>, <em>ao</em><em>bi</em>, <em>bo</em>, <em>calcout</em>, <em>scalcout</em>, <em>swait</em>, ...</p>
111<p>When an event causes an email to be triggered, PvMail will retrieve
112the value of another PV that is the first part of the message to be
113sent.  Additional metadata will be appended to the message.</p>
114<div class="admonition note">
115<p class="first admonition-title">Note</p>
116<p class="last">Email is sent using a call to the <tt class="docutils literal"><span class="pre">sendmail</span></tt> program on the native OS.
117This almost certainly precludes its use on Windows systems.
118The GUI or command-line versions will operate but likely no email
119is sent.  Also, the host computer must allow and be configured for
120sending email to the intended recipients.</p>
121</div>
122<p>PvMail provides either a command-line interface or a graphical user
123interface.  Both are accessed from the same command, using different
124command-line options.  The command-line version is intended to run
125as a background program, it has no user interaction but logs all its
126output into a log file.  The GUI version provides a screen to edit
127each of the parameters before the background process is started.
128It also provides buttons to start and stop the background process.</p>
129</div>
130<div class="section" id="overview-of-contents">
131<h1>Overview of Contents<a class="headerlink" href="#overview-of-contents" title="Permalink to this headline">¶</a></h1>
132<div class="toctree-wrapper compound">
133<ul>
134<li class="toctree-l1"><a class="reference internal" href="contents.html">Contents</a><ul>
135<li class="toctree-l2"><a class="reference internal" href="cli.html">pvMail.py: command-line interface</a></li>
136<li class="toctree-l2"><a class="reference internal" href="cli.html#command-line-parameters">command-line parameters</a></li>
137<li class="toctree-l2"><a class="reference internal" href="gui.html">pvMail.py: graphical user interface</a></li>
138<li class="toctree-l2"><a class="reference internal" href="test_database.html">EPICS test database</a></li>
139<li class="toctree-l2"><a class="reference internal" href="pvMail/modules.html">PvMail as a Python package</a></li>
140<li class="toctree-l2"><a class="reference internal" href="pvMail/modules.html#pvmail-source-code-documentation">PvMail source code documentation</a></li>
141<li class="toctree-l2"><a class="reference internal" href="info.html">More Information</a></li>
142<li class="toctree-l2"><a class="reference internal" href="info.html#todo-items-for-the-next-release">TODO items for the next release</a></li>
143<li class="toctree-l2"><a class="reference internal" href="license.html">License</a></li>
144</ul>
145</li>
146</ul>
147</div>
148</div>
149<div class="section" id="glossary">
150<h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h1>
151<dl class="docutils">
152<dt><span class="target" id="index-0"></span>CA</dt>
153<dd>EPICS Channel Access protocol</dd>
154<dt><span class="target" id="index-1"></span>CLI</dt>
155<dd>command-line interface</dd>
156<dt><span class="target" id="index-2"></span>EPICS</dt>
157<dd><a class="reference external" href="http://www.aps.anl.gov/epics">http://www.aps.anl.gov/epics</a></dd>
158<dt><span class="target" id="index-3"></span>GUI</dt>
159<dd>graphical user interface</dd>
160<dt><span class="target" id="index-4"></span>IOC</dt>
161<dd>EPICS Input/Output Controller, the EPICS server</dd>
162<dt><span class="target" id="index-5"></span>message PV</dt>
163<dd>EPICS PV that provides the text to be sent by email,
164additional metadata is appended to this text</dd>
165<dt><span class="target" id="index-6"></span>OS</dt>
166<dd>operating system</dd>
167<dt><span class="target" id="index-7"></span>PV</dt>
168<dd>EPICS process variable</dd>
169<dt><span class="target" id="index-8"></span>PyEpics</dt>
170<dd>Python package to manage connections with PVs served by an EPICS IOC</dd>
171<dt><span class="target" id="index-9"></span>Traits</dt>
172<dd>Python package to simplify construction of a GUI</dd>
173<dt><span class="target" id="index-10"></span>trigger PV</dt>
174<dd>EPICS PV that signals an email is to be sent</dd>
175</dl>
176</div>
177<div class="section" id="dependencies">
178<h1>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h1>
179<p>This software was built with various standard Python packages
180available in Python 2.7.  Additionally, this program uses:</p>
181<dl class="docutils" id="index-11">
182<dt><em>PyEpics</em> (EPICS interface)</dt>
183<dd><a class="reference external" href="http://cars9.uchicago.edu/software/python/pyepics3/">http://cars9.uchicago.edu/software/python/pyepics3/</a></dd>
184</dl>
185<dl class="docutils" id="index-12">
186<dt><em>Traits</em> (GUI library)</dt>
187<dd><a class="reference external" href="http://code.enthought.com/projects/traits/">http://code.enthought.com/projects/traits/</a></dd>
188</dl>
189<p>Both of these are available for
190<a class="reference external" href="http://packages.python.org/distribute/easy_install.html">easy_install</a>
191from the Python Package Index (<a class="reference external" href="http://pypi.python.org/pypi">http://pypi.python.org/pypi</a>).</p>
192</div>
193
194
195          </div>
196        </div>
197      </div>
198      <div class="clearer"></div>
199    </div>
200    <div class="related">
201      <h3>Navigation</h3>
202      <ul>
203        <li class="right" style="margin-right: 10px">
204          <a href="genindex.html" title="General Index"
205             >index</a></li>
206        <li class="right" >
207          <a href="py-modindex.html" title="Python Module Index"
208             >modules</a> |</li>
209        <li class="right" >
210          <a href="contents.html" title="Contents"
211             >next</a> |</li>
212        <li><a href="#">PvMail 3 (3.0-r801) documentation</a> &raquo;</li> 
213      </ul>
214    </div>
215    <div class="footer">
216        &copy; Copyright (c) 2009-2012, UChicago Argonne, LLC (see LICENSE file for details).
217      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
218    </div>
219  </body>
220</html>
Note: See TracBrowser for help on using the repository browser.