source: pvMail/doc/build/html/test_database.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: 9.8 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>EPICS test database &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="PvMail as a Python package" href="pvMail/modules.html" />
31    <link rel="prev" title="pvMail.py: graphical user interface" href="gui.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="pvMail/modules.html" title="PvMail as a Python package"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="gui.html" title="pvMail.py: graphical user 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  <h3><a href="index.html">Table Of Contents</a></h3>
56  <ul>
57<li><a class="reference internal" href="#">EPICS test database</a><ul>
58<li><a class="reference internal" href="#starting-softioc">starting: softIoc</a></li>
59<li><a class="reference internal" href="#watching-camonitor">watching: camonitor</a></li>
60<li><a class="reference internal" href="#changing-a-pv-caput">changing a PV: caput</a></li>
61<li><a class="reference internal" href="#test-db">test.db</a></li>
62</ul>
63</li>
64</ul>
65
66  <h4>Previous topic</h4>
67  <p class="topless"><a href="gui.html"
68                        title="previous chapter">pvMail.py: graphical user interface</a></p>
69  <h4>Next topic</h4>
70  <p class="topless"><a href="pvMail/modules.html"
71                        title="next chapter">PvMail as a Python package</a></p>
72  <h3>This Page</h3>
73  <ul class="this-page-menu">
74    <li><a href="_sources/test_database.txt"
75           rel="nofollow">Show Source</a></li>
76  </ul>
77<div id="searchbox" style="display: none">
78  <h3>Quick search</h3>
79    <form class="search" action="search.html" method="get">
80      <input type="text" name="q" />
81      <input type="submit" value="Go" />
82      <input type="hidden" name="check_keywords" value="yes" />
83      <input type="hidden" name="area" value="default" />
84    </form>
85    <p class="searchtip" style="font-size: 90%">
86    Enter search terms or a module, class or function name.
87    </p>
88</div>
89<script type="text/javascript">$('#searchbox').show(0);</script>
90        </div>
91      </div>
92
93    <div class="document">
94      <div class="documentwrapper">
95        <div class="bodywrapper">
96          <div class="body">
97           
98  <div class="section" id="epics-test-database">
99<h1>EPICS test database<a class="headerlink" href="#epics-test-database" title="Permalink to this headline">¶</a></h1>
100<p>To test the program during its development, a test database
101(<a class="reference internal" href="#test-database"><em>test.db</em></a>)
102was prepared.  The database creates two PVs:</p>
103<dl class="docutils">
104<dt><tt class="docutils literal"><span class="pre">pvMail:trigger</span></tt></dt>
105<dd>the PV to watch</dd>
106<dt><tt class="docutils literal"><span class="pre">pvMail:message</span></tt></dt>
107<dd>the message to be sent</dd>
108</dl>
109<div class="section" id="starting-softioc">
110<h2>starting: softIoc<a class="headerlink" href="#starting-softioc" title="Permalink to this headline">¶</a></h2>
111<p>Start the database by adding it to an existing EPIC IOC configuration
112or by starting a soft IOC using the <tt class="docutils literal"><span class="pre">softIoc</span></tt> program <span class="target" id="index-0"></span>softIOC
113from EPICS base.
114Here is an example of how that looks from a Linux command shell:</p>
115<div class="highlight-bash"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
1162
1173
1184
1195
1206
1217
1228</pre></div></td><td class="code"><div class="highlight"><pre><span class="nv">$ </span>softIoc -d test.db
123Starting iocInit
124<span class="c">############################################################################</span>
125<span class="c">## EPICS R3.14.12 $Date: Wed 2010-11-24 14:50:38 -0600$</span>
126<span class="c">## EPICS Base built Feb 27 2011</span>
127<span class="c">############################################################################</span>
128iocRun: All initialization <span class="nb">complete</span>
129epics&gt;
130</pre></div>
131</td></tr></table></div>
132<div class="admonition note">
133<p class="first admonition-title">Note</p>
134<p class="last">Here, the shell prompt is signified by the <tt class="docutils literal"><span class="pre">$</span></tt> symbol.</p>
135</div>
136</div>
137<div class="section" id="watching-camonitor">
138<h2>watching: camonitor<a class="headerlink" href="#watching-camonitor" title="Permalink to this headline">¶</a></h2>
139<p>Once the EPICS IOC is started and the PVs are available,
140it is possible to watch them
141for any changes from the command line using the <tt class="docutils literal"><span class="pre">camonitor</span></tt> <span class="target" id="index-1"></span>camonitor
142application from EPICS base:</p>
143<div class="highlight-python"><pre>$ camonitor pvMail:trigger pvMail:message
144    pvMail:trigger                 &lt;undefined&gt; off UDF INVALID
145    pvMail:message                 &lt;undefined&gt; pvMail default message UDF INVALID</pre>
146</div>
147<div class="admonition note">
148<p class="first admonition-title">Note</p>
149<p class="last">Do not be concerned about the <tt class="docutils literal"><span class="pre">UDF</span> <span class="pre">INVALID</span></tt> notices, they will disappear
150once the PVs have been written to at least once.</p>
151</div>
152</div>
153<div class="section" id="changing-a-pv-caput">
154<h2>changing a PV: caput<a class="headerlink" href="#changing-a-pv-caput" title="Permalink to this headline">¶</a></h2>
155<p>You can test changing the value of the trigger PV using the <tt class="docutils literal"><span class="pre">caput</span></tt> <span class="target" id="index-2"></span>caput
156application from EPICS base:</p>
157<div class="highlight-python"><pre>$ caput pvMail:trigger 1
158    Old : pvMail:trigger                 off
159    New : pvMail:trigger                 on</pre>
160</div>
161</div>
162<div class="section" id="test-db">
163<span id="test-database"></span><h2>test.db<a class="headerlink" href="#test-db" title="Permalink to this headline">¶</a></h2>
164<p id="index-3">Here is the full listing of the test EPICS database used for program development.</p>
165<div class="highlight-text"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
166 2
167 3
168 4
169 5
170 6
171 7
172 8
173 9
17410
17511
17612
17713
17814
17915
18016
18117
18218
18319
18420
18521
18622
18723
18824
18925
19026
19127</pre></div></td><td class="code"><div class="highlight"><pre>########### SVN repository information ###################
192# $Date: 2011-11-25 20:16:30 -0600 (Fri, 25 Nov 2011) $
193# $Author: jemian $
194# $Revision: 659 $
195# $URL: https://subversion.xray.aps.anl.gov/bcdaext/pvMail/src/PvMail/test.db $
196# $Id: test.db 659 2011-11-26 02:16:30Z jemian $
197########### SVN repository information ###################
198
199# EPICS database to use while testing and developing pvMail.py code
200
201#  /APSshare/epics/base-3.14.12.1/bin/linux-x86-el5-debug/softIoc -d test.db
202#
203#  IOC:     softIoc -d test.db
204#  client:  camonitor pvMail:{trigger,message}
205#  pvMail:  pvMail.py  pvMail:trigger pvMail:message prjemian@gmail.com,jemian@anl.gov
206
207<span class="hll">record(bo, &quot;pvMail:trigger&quot;)
208</span>{
209        field(DESC, &quot;trigger PV&quot;)
210        field(ZNAM, &quot;off&quot;)
211        field(ONAM, &quot;on&quot;)
212}
213<span class="hll">record(stringout, &quot;pvMail:message&quot;)
214</span>{
215        field(DESC, &quot;message to be sent by email&quot;)
216        field(VAL,  &quot;pvMail default message&quot;)
217}
218</pre></div>
219</td></tr></table></div>
220</div>
221</div>
222
223
224          </div>
225        </div>
226      </div>
227      <div class="clearer"></div>
228    </div>
229    <div class="related">
230      <h3>Navigation</h3>
231      <ul>
232        <li class="right" style="margin-right: 10px">
233          <a href="genindex.html" title="General Index"
234             >index</a></li>
235        <li class="right" >
236          <a href="py-modindex.html" title="Python Module Index"
237             >modules</a> |</li>
238        <li class="right" >
239          <a href="pvMail/modules.html" title="PvMail as a Python package"
240             >next</a> |</li>
241        <li class="right" >
242          <a href="gui.html" title="pvMail.py: graphical user interface"
243             >previous</a> |</li>
244        <li><a href="index.html">PvMail (v3.0, 2012-06-14) documentation</a> &raquo;</li>
245          <li><a href="contents.html" >Contents</a> &raquo;</li> 
246      </ul>
247    </div>
248    <div class="footer">
249        &copy; Copyright (c) 2009-2012, UChicago Argonne, LLC (see LICENSE file for details).
250      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
251    </div>
252  </body>
253</html>
Note: See TracBrowser for help on using the repository browser.