source: pvMail/doc/build/html/gui.html @ 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:mime-type set to text/html
File size: 7.2 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.py: graphical user interface &mdash; PvMail (v3.0, 2012-06-14) 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:     '(v3.0, 2012-06-14)',
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 (v3.0, 2012-06-14) documentation" href="index.html" />
29    <link rel="up" title="Contents" href="contents.html" />
30    <link rel="next" title="EPICS test database" href="test_database.html" />
31    <link rel="prev" title="pvMail.py: command-line interface" href="cli.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="test_database.html" title="EPICS test database"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="cli.html" title="pvMail.py: command-line interface"
48             accesskey="P">previous</a> |</li>
49        <li><a href="index.html">PvMail (v3.0, 2012-06-14) documentation</a> &raquo;</li>
50          <li><a href="contents.html" accesskey="U">Contents</a> &raquo;</li> 
51      </ul>
52    </div>
53      <div class="sphinxsidebar">
54        <div class="sphinxsidebarwrapper">
55  <h4>Previous topic</h4>
56  <p class="topless"><a href="cli.html"
57                        title="previous chapter">pvMail.py: command-line interface</a></p>
58  <h4>Next topic</h4>
59  <p class="topless"><a href="test_database.html"
60                        title="next chapter">EPICS test database</a></p>
61  <h3>This Page</h3>
62  <ul class="this-page-menu">
63    <li><a href="_sources/gui.txt"
64           rel="nofollow">Show Source</a></li>
65  </ul>
66<div id="searchbox" style="display: none">
67  <h3>Quick search</h3>
68    <form class="search" action="search.html" method="get">
69      <input type="text" name="q" />
70      <input type="submit" value="Go" />
71      <input type="hidden" name="check_keywords" value="yes" />
72      <input type="hidden" name="area" value="default" />
73    </form>
74    <p class="searchtip" style="font-size: 90%">
75    Enter search terms or a module, class or function name.
76    </p>
77</div>
78<script type="text/javascript">$('#searchbox').show(0);</script>
79        </div>
80      </div>
81
82    <div class="document">
83      <div class="documentwrapper">
84        <div class="bodywrapper">
85          <div class="body">
86           
87  <div class="section" id="pvmail-py-graphical-user-interface">
88<span id="gui"></span><h1>pvMail.py: graphical user interface<a class="headerlink" href="#pvmail-py-graphical-user-interface" title="Permalink to this headline">¶</a></h1>
89<p id="index-0">The PvMail program GUI is started from the command line with the <tt class="docutils literal"><span class="pre">-g</span></tt>
90or <tt class="docutils literal"><span class="pre">--gui</span></tt> command-line options.
91If either GUI option is used, then the positional arguments
92(<tt class="docutils literal"><span class="pre">triggerPV</span> <span class="pre">messagePV</span> <span class="pre">email&#64;address</span></tt>) are optional.
93Without either GUI option, the
94command-line interface is started.:</p>
95<div class="highlight-python"><pre>$ ./pvMail.py -g &amp;</pre>
96</div>
97<div class="admonition tip">
98<p class="first admonition-title">Tip</p>
99<p class="last">Usually, you want to run the GUI as a background task by appending
100the ampersand (<tt class="docutils literal"><span class="pre">&amp;</span></tt>) on the command line, as shown above.</p>
101</div>
102<div class="figure">
103<img alt="_images/gui.png" src="_images/gui.png" style="width: 300pt;" />
104<p class="caption">GUI of the <em>PvMail</em> application</p>
105</div>
106<p>The GUI provides editable text entry widgets for each of the required
107command-line terms (a.k.a. <em>positional arguments</em>):
108<tt class="docutils literal"><span class="pre">trigger_PV</span> <span class="pre">message_PV</span> <span class="pre">email_addresses</span></tt>.
109The list of email addresses is separated.  The GUI provides a tool
110to add additional address or remove addresses.</p>
111<div class="admonition warning">
112<p class="first admonition-title">Warning</p>
113<p class="last">At present, the GUI provides few visual cues
114about the success of PV connections or even
115that the program is working.  This will be fixed soon.</p>
116</div>
117<p>The GUI also shows (using <em>True</em> or <em>False</em> text) whether or not
118the PV monitor process is running.</p>
119<div class="admonition warning">
120<p class="first admonition-title">Warning</p>
121<p class="last">If either of the PVs fails to connect, it is likely that the GUI may
122become confused whether or not it is running.  In such cases, press
123the <em>Stop</em> button, then press the <em>Run</em> button to try to restart monitoring.</p>
124</div>
125<p>All PvMail monitoring will be stopped if the GUI window is closed.
126At present, there is no feature to detach or reattach a monitor set.
127Also, PvMail can only monitor a single set of PVs using the current design.
128A request to enhance this capability is on the TODO list (see <a class="reference internal" href="info.html#todo"><em>TODO items for the next release</em></a>).</p>
129<p>At the bottom of the GUI panel, a status line is shown.  At present, this
130does not indicate the status of the monitoring process.  Again,
131this will be fixed soon.</p>
132</div>
133
134
135          </div>
136        </div>
137      </div>
138      <div class="clearer"></div>
139    </div>
140    <div class="related">
141      <h3>Navigation</h3>
142      <ul>
143        <li class="right" style="margin-right: 10px">
144          <a href="genindex.html" title="General Index"
145             >index</a></li>
146        <li class="right" >
147          <a href="py-modindex.html" title="Python Module Index"
148             >modules</a> |</li>
149        <li class="right" >
150          <a href="test_database.html" title="EPICS test database"
151             >next</a> |</li>
152        <li class="right" >
153          <a href="cli.html" title="pvMail.py: command-line interface"
154             >previous</a> |</li>
155        <li><a href="index.html">PvMail (v3.0, 2012-06-14) documentation</a> &raquo;</li>
156          <li><a href="contents.html" >Contents</a> &raquo;</li> 
157      </ul>
158    </div>
159    <div class="footer">
160        &copy; Copyright (c) 2009-2012, UChicago Argonne, LLC (see LICENSE file for details).
161      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
162    </div>
163  </body>
164</html>
Note: See TracBrowser for help on using the repository browser.