deploy: 906e058

DiamondLightSource · Nov 27, 2023 · 974dd9c · 974dd9c
1 parent 3496d36
commit 974dd9c
Show file tree

Hide file tree

Showing 27 changed files with 163 additions and 42 deletions.
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: 32b519292b81778488b1942ec76ad27a
+config: e8a92f52203ac96b90d0edf9920ed782
 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.4.0+1.gdad702c documentation</title>
+  <title>epicsdbbuilder.recordbase &mdash; pythonSoftIOC 4.4.0+4.g906e058 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.4.0+1.gdad702c documentation</title>
+  <title>Overview: module code &mdash; pythonSoftIOC 4.4.0+4.g906e058 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.4.0+1.gdad702c documentation</title>
+  <title>softioc.asyncio_dispatcher &mdash; pythonSoftIOC 4.4.0+4.g906e058 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/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.4.0+1.gdad702c documentation</title>
+  <title>softioc.builder &mdash; pythonSoftIOC 4.4.0+4.g906e058 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.4.0+1.gdad702c documentation</title>
+  <title>softioc.device &mdash; pythonSoftIOC 4.4.0+4.g906e058 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" />
@@ -104,6 +104,7 @@ <h1>Source code for softioc.device</h1><div class="highlight"><pre>
     <span class="n">signal_processing_complete</span><span class="p">,</span>
     <span class="n">recGblResetAlarms</span><span class="p">,</span>
     <span class="n">db_put_field</span><span class="p">,</span>
+    <span class="n">db_get_field</span><span class="p">,</span>
 <span class="p">)</span>
 <span class="kn">from</span> <span class="nn">.device_core</span> <span class="kn">import</span> <span class="n">DeviceSupportCore</span><span class="p">,</span> <span class="n">RecordLookup</span>
 
@@ -175,6 +176,26 @@ <h1>Source code for softioc.device</h1><div class="highlight"><pre>
     <span class="k">def</span> <span class="nf">_write_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
         <span class="n">record</span><span class="o">.</span><span class="n">write_val</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
+    <span class="k">def</span> <span class="nf">get_field</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">):</span>
+        <span class="sd">&#39;&#39;&#39; Returns the given field value as a string.&#39;&#39;&#39;</span>
+        <span class="k">assert</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;_record&quot;</span><span class="p">),</span> \
+            <span class="s1">&#39;get_field may only be called after iocInit&#39;</span>
+
+        <span class="n">data</span> <span class="o">=</span> <span class="p">(</span><span class="n">c_char</span> <span class="o">*</span> <span class="mi">40</span><span class="p">)()</span>
+        <span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span> <span class="o">+</span> <span class="n">field</span>
+        <span class="n">db_get_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">fields</span><span class="o">.</span><span class="n">DBF_STRING</span><span class="p">,</span> <span class="n">addressof</span><span class="p">(</span><span class="n">data</span><span class="p">),</span> <span class="mi">1</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">_string_at</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="mi">40</span><span class="p">)</span>
+
+    <span class="k">def</span> <span class="nf">set_field</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+        <span class="sd">&#39;&#39;&#39;Sets the given field to the given value. Value will be transported as</span>
+<span class="sd">        a DBF_STRING.&#39;&#39;&#39;</span>
+        <span class="k">assert</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;_record&quot;</span><span class="p">),</span> \
+            <span class="s1">&#39;set_field may only be called after iocInit&#39;</span>
+
+        <span class="n">data</span> <span class="o">=</span> <span class="p">(</span><span class="n">c_char</span> <span class="o">*</span> <span class="mi">40</span><span class="p">)()</span>
+        <span class="n">data</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">&#39;</span><span class="se">\0</span><span class="s1">&#39;</span>
+        <span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span> <span class="o">+</span> <span class="n">field</span>
+        <span class="n">db_put_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">fields</span><span class="o">.</span><span class="n">DBF_STRING</span><span class="p">,</span> <span class="n">addressof</span><span class="p">(</span><span class="n">data</span><span class="p">),</span> <span class="mi">1</span><span class="p">)</span>
 
 <div class="viewcode-block" id="ProcessDeviceSupportIn"><a class="viewcode-back" href="../../reference/api.html#softioc.builder.ProcessDeviceSupportIn">[docs]</a><span class="k">class</span> <span class="nc">ProcessDeviceSupportIn</span><span class="p">(</span><span class="n">ProcessDeviceSupportCore</span><span class="p">):</span>
     <span class="n">_link_</span> <span class="o">=</span> <span class="s1">&#39;INP&#39;</span>

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.4.0+1.gdad702c documentation</title>
+  <title>softioc.softioc &mdash; pythonSoftIOC 4.4.0+4.g906e058 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/_sources/reference/api.rst.txt b/master/_sources/reference/api.rst.txt
@@ -578,6 +578,27 @@ class which provides the methods documented below.
         Note that channel access puts to a Python soft IOC input record are
         completely ineffective, and this includes waveform records.
 
+    ..  method:: get_field(field)
+
+        This returns the named field from the record. An exception will be raised
+        if the field cannot be found.
+
+        Note that this function can only be used after the IOC has been initialized.
+        If you need to retrieve a field's value before that, access it directly via
+        an attribute e.g. ``my_record.EGU``. (This will not work after the IOC is
+        initialized)
+
+    ..  method:: set_field(field, value)
+
+        This sets the given field to the given value. The value will
+        always be converted to a Python String, which is then interpreted by
+        EPICS as a DBF_STRING type. Note that values can be no longer than 39 bytes.
+
+        Note that this function can only be used after the IOC has been initialized.
+        If you need to set a field's value before that, set it directly as an attribute
+        on the record e.g. ``my_record.EGU``. (This will not work after the IOC is
+        initialized)
+
 Working with OUT records
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -599,4 +620,25 @@ Working with OUT records
 
         Returns the value associated with the record.
 
+    ..  method:: get_field(field)
+
+        This returns the named field from the record. An exception will be raised
+        if the field cannot be found.
+
+        Note that this function can only be used after the IOC has been initialized.
+        If you need to retrieve a field's value before that, access it directly via
+        an attribute e.g. ``my_record.EGU``. (This will not work after the IOC is
+        initialized)
+
+    ..  method:: set_field(field, value)
+
+        This sets the given field to the given value. The value will
+        always be converted to a Python String, which is then interpreted by
+        EPICS as a DBF_STRING type. Note that values can be no longer than 39 bytes.
+
+        Note that this function can only be used after the IOC has been initialized.
+        If you need to set a field's value before that, set it directly as an attribute
+        on the record e.g. ``my_record.EGU``. (This will not work after the IOC is
+        initialized)
+
 .. _epics_device: https://github.com/Araneidae/epics_device
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.4.0+1.gdad702c',
+    VERSION: '4.4.0+4.g906e058',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',