deploy: 3947494

Araneidae · Araneidae · commit e9ea25cb15d8 · 2024-04-24T07:39:48.000Z
diff --git a/master/.buildinfo b/master/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 26d55bb3ceef6b30795ea534f7b46de6
+config: 7e4261d78c827700da0b005d4fb87ed8
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/master/.doctrees/environment.pickle b/master/.doctrees/environment.pickle
diff --git a/master/.doctrees/reference/api.doctree b/master/.doctrees/reference/api.doctree
diff --git a/master/_modules/epicsdbbuilder/recordbase.html b/master/_modules/epicsdbbuilder/recordbase.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>epicsdbbuilder.recordbase &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>epicsdbbuilder.recordbase &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
diff --git a/master/_modules/index.html b/master/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Overview: module code &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/_modules/softioc/asyncio_dispatcher.html b/master/_modules/softioc/asyncio_dispatcher.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>softioc.asyncio_dispatcher &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>softioc.asyncio_dispatcher &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
@@ -95,6 +95,7 @@ <h1>Source code for softioc.asyncio_dispatcher</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">logging</span>
 <span class="kn">import</span> <span class="nn">threading</span>
 <span class="kn">import</span> <span class="nn">atexit</span>
+<span class="kn">import</span> <span class="nn">signal</span>
 
 <div class="viewcode-block" id="AsyncioDispatcher"><a class="viewcode-back" href="../../reference/api.html#softioc.asyncio_dispatcher.AsyncioDispatcher">[docs]</a><span class="k">class</span> <span class="nc">AsyncioDispatcher</span><span class="p">:</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">loop</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">debug</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
@@ -140,6 +141,17 @@ <h1>Source code for softioc.asyncio_dispatcher</h1><div class="highlight"><pre>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">__shutdown</span><span class="p">()</span>
 
+    <span class="k">def</span> <span class="nf">wait_for_quit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="n">stop_event</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Event</span><span class="p">()</span>
+
+        <span class="k">def</span> <span class="nf">signal_handler</span><span class="p">(</span><span class="n">signum</span><span class="p">,</span> <span class="n">frame</span><span class="p">):</span>
+            <span class="n">stop_event</span><span class="o">.</span><span class="n">set</span><span class="p">()</span>
+
+        <span class="n">signal</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="n">signal</span><span class="o">.</span><span class="n">SIGINT</span><span class="p">,</span> <span class="n">signal_handler</span><span class="p">)</span>
+        <span class="n">signal</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="n">signal</span><span class="o">.</span><span class="n">SIGTERM</span><span class="p">,</span> <span class="n">signal_handler</span><span class="p">)</span>
+
+        <span class="n">stop_event</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
+
     <span class="k">async</span> <span class="k">def</span> <span class="nf">__inloop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">started</span><span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">loop</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">get_running_loop</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">__interrupt</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Event</span><span class="p">()</span>
diff --git a/master/_modules/softioc/builder.html b/master/_modules/softioc/builder.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>softioc.builder &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>softioc.builder &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
diff --git a/master/_modules/softioc/device.html b/master/_modules/softioc/device.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>softioc.device &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>softioc.device &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
diff --git a/master/_modules/softioc/softioc.html b/master/_modules/softioc/softioc.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>softioc.softioc &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>softioc.softioc &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
@@ -444,6 +444,15 @@ <h1>Source code for softioc.softioc</h1><div class="highlight"><pre>
 
     <span class="k">if</span> <span class="n">call_exit</span><span class="p">:</span>
         <span class="n">safeEpicsExit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="non_interactive_ioc"><a class="viewcode-back" href="../../reference/api.html#softioc.softioc.non_interactive_ioc">[docs]</a><span class="k">def</span> <span class="nf">non_interactive_ioc</span><span class="p">():</span>
+    <span class="sd">&#39;&#39;&#39;Function to run the IOC in non-interactive mode. This mode is useful for</span>
+<span class="sd">    running the IOC as a background process without user interaction.</span>
+<span class="sd">    This function expects a stop signal. When it receives one, the IOC stops.</span>
+<span class="sd">    &#39;&#39;&#39;</span>
+    <span class="n">device</span><span class="o">.</span><span class="n">dispatcher</span><span class="o">.</span><span class="n">wait_for_quit</span><span class="p">()</span>
+    <span class="n">safeEpicsExit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span></div>
 </pre></div>
 
            </div>
diff --git a/master/_sources/reference/api.rst.txt b/master/_sources/reference/api.rst.txt
@@ -120,6 +120,12 @@ Test Facilities`_ documentation for more details of each function.
 ..  autofunction:: generalTimeReport
 ..  autofunction:: eltc
 
+.. autofunction:: non_interactive_ioc
+
+When used with a service manager, use python's -u option or the environment
+variable PYTHONUNBUFFERED=TRUE. This ensures that python output, i.e. stdout
+and stderr streams, is sent directly to the terminal.
+
 ..  attribute:: exit
 
     Displaying this value will invoke ``epicsExit()`` causing the IOC to
diff --git a/master/_static/documentation_options.js b/master/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '4.5.0+15.g4388c69',
+    VERSION: '4.5.0+16.g3947494',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/master/explanations/asyncio-cothread-differences.html b/master/explanations/asyncio-cothread-differences.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>What are the differences between asyncio and cothread? &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>What are the differences between asyncio and cothread? &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/explanations/why-use-pythonSoftIOC.html b/master/explanations/why-use-pythonSoftIOC.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Why use pythonSoftIOC? &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Why use pythonSoftIOC? &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/genindex.html b/master/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Index &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
@@ -322,6 +322,10 @@ <h2 id="M">M</h2>
 
 <h2 id="N">N</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/api.html#softioc.softioc.non_interactive_ioc">non_interactive_ioc() (in module softioc.softioc)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/api.html#softioc.builder.NP">NP() (in module softioc.builder)</a>
 </li>
diff --git a/master/how-to/make-publishable-ioc.html b/master/how-to/make-publishable-ioc.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Create a Publishable IOC &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Create a Publishable IOC &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/how-to/read-data-from-ioc.html b/master/how-to/read-data-from-ioc.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Read data from an IOC &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Read data from an IOC &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/how-to/use-asyncio-in-an-ioc.html b/master/how-to/use-asyncio-in-an-ioc.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Use asyncio in an IOC &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Use asyncio in an IOC &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/how-to/use-soft-records.html b/master/how-to/use-soft-records.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Use soft records in an IOC &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Use soft records in an IOC &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/index.html b/master/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pythonSoftIOC &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>pythonSoftIOC &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
diff --git a/master/objects.inv b/master/objects.inv
diff --git a/master/py-modindex.html b/master/py-modindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Python Module Index &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
diff --git a/master/reference/api.html b/master/reference/api.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>API &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>API &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
@@ -416,6 +416,17 @@ <h2>Top Level IOC Interface: <a class="reference internal" href="#module-softioc
 and any other value means yes.</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="softioc.softioc.non_interactive_ioc">
+<span class="sig-prename descclassname"><span class="pre">softioc.softioc.</span></span><span class="sig-name descname"><span class="pre">non_interactive_ioc</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/softioc/softioc.html#non_interactive_ioc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#softioc.softioc.non_interactive_ioc" title="Permalink to this definition"></a></dt>
+<dd><p>Function to run the IOC in non-interactive mode. This mode is useful for
+running the IOC as a background process without user interaction.
+This function expects a stop signal. When it receives one, the IOC stops.</p>
+</dd></dl>
+
+<p>When used with a service manager, use python’s -u option or the environment
+variable PYTHONUNBUFFERED=TRUE. This ensures that python output, i.e. stdout
+and stderr streams, is sent directly to the terminal.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="softioc.softioc.exit">
 <span class="sig-prename descclassname"><span class="pre">softioc.softioc.</span></span><span class="sig-name descname"><span class="pre">exit</span></span><a class="headerlink" href="#softioc.softioc.exit" title="Permalink to this definition"></a></dt>
diff --git a/master/reference/contributing.html b/master/reference/contributing.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Contributing &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Contributing &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/search.html b/master/search.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Search &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
diff --git a/master/searchindex.js b/master/searchindex.js
diff --git a/master/tutorials/creating-an-ioc.html b/master/tutorials/creating-an-ioc.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Creating an IOC &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Creating an IOC &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
diff --git a/master/tutorials/installation.html b/master/tutorials/installation.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation Tutorial &mdash; pythonSoftIOC 4.5.0+15.g4388c69 documentation</title>
+  <title>Installation Tutorial &mdash; pythonSoftIOC 4.5.0+16.g3947494 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
