Skip to content

Commit

Permalink
deploy: 165ff17
Browse files Browse the repository at this point in the history
  • Loading branch information
tfcollins committed Jun 13, 2024
1 parent e88aa51 commit ae42557
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 1 deletion.
1 change: 1 addition & 0 deletions main/dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@ <h3>Test Functions and Fixtures<a class="headerlink" href="#test-functions-and-f
<ul>
<li class="toctree-l1"><a class="reference internal" href="test_attr.html">Attribute Tests</a><ul>
<li class="toctree-l2"><a class="reference internal" href="test_attr.html#test.attr_tests.attribute_check_range_readonly_with_depends"><code class="docutils literal notranslate"><span class="pre">attribute_check_range_readonly_with_depends()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="test_attr.html#test.attr_tests.attribute_check_range_singleval_with_depends"><code class="docutils literal notranslate"><span class="pre">attribute_check_range_singleval_with_depends()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="test_attr.html#test.attr_tests.attribute_multiple_values"><code class="docutils literal notranslate"><span class="pre">attribute_multiple_values()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="test_attr.html#test.attr_tests.attribute_multiple_values_available_readonly"><code class="docutils literal notranslate"><span class="pre">attribute_multiple_values_available_readonly()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="test_attr.html#test.attr_tests.attribute_multiple_values_device_channel"><code class="docutils literal notranslate"><span class="pre">attribute_multiple_values_device_channel()</span></code></a></li>
Expand Down
36 changes: 36 additions & 0 deletions main/dev/test_attr.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@
<ul>
<li><a class="reference internal" href="#">Attribute Tests</a><ul>
<li><a class="reference internal" href="#test.attr_tests.attribute_check_range_readonly_with_depends"><code class="docutils literal notranslate"><span class="pre">attribute_check_range_readonly_with_depends()</span></code></a></li>
<li><a class="reference internal" href="#test.attr_tests.attribute_check_range_singleval_with_depends"><code class="docutils literal notranslate"><span class="pre">attribute_check_range_singleval_with_depends()</span></code></a></li>
<li><a class="reference internal" href="#test.attr_tests.attribute_multiple_values"><code class="docutils literal notranslate"><span class="pre">attribute_multiple_values()</span></code></a></li>
<li><a class="reference internal" href="#test.attr_tests.attribute_multiple_values_available_readonly"><code class="docutils literal notranslate"><span class="pre">attribute_multiple_values_available_readonly()</span></code></a></li>
<li><a class="reference internal" href="#test.attr_tests.attribute_multiple_values_device_channel"><code class="docutils literal notranslate"><span class="pre">attribute_multiple_values_device_channel()</span></code></a></li>
Expand Down Expand Up @@ -323,6 +324,41 @@ <h1>Attribute Tests<a class="headerlink" href="#attribute-tests" title="Permalin
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="test.attr_tests.attribute_check_range_singleval_with_depends">
<span class="sig-prename descclassname"><span class="pre">test.attr_tests.</span></span><span class="sig-name descname"><span class="pre">attribute_check_range_singleval_with_depends</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depends</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repeats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sub_channel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#test.attr_tests.attribute_check_range_singleval_with_depends" title="Permalink to this definition">#</a></dt>
<dd><p>attribute_check_range_singleval_with_depends:
Write and read back integer class property with dependent write properties
This is performed a defined number of times and the value written
is randomly determined based in input parameters</p>
<dl class="simple">
<dt>parameters:</dt><dd><dl class="simple">
<dt>uri: type=string</dt><dd><p>URI of IIO context of target board/system</p>
</dd>
<dt>classname: type=string</dt><dd><p>Name of pyadi interface class which contain attribute</p>
</dd>
<dt>attr: type=string</dt><dd><p>Attribute name to be written. Must be property of classname</p>
</dd>
<dt>depends: type=dict</dt><dd><p>Dictionary of properties to write before value is written. Keys
are properties and values are values to be written</p>
</dd>
<dt>start: type=integer</dt><dd><p>Lower bound of possible values attribute can be</p>
</dd>
<dt>stop: type=integer</dt><dd><p>Upper bound of possible values attribute can be</p>
</dd>
<dt>step: type=integer</dt><dd><p>Difference between successive values attribute can be</p>
</dd>
<dt>tol: type=integer</dt><dd><p>Allowable error of written value compared to read back value</p>
</dd>
<dt>repeats: type=integer</dt><dd><p>Number of random values to tests. Generated from uniform distribution</p>
</dd>
<dt>sub_channel: type=string</dt><dd><p>Name of sub channel (nested class) to be tested</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="test.attr_tests.attribute_multiple_values">
<span class="sig-prename descclassname"><span class="pre">test.attr_tests.</span></span><span class="sig-name descname"><span class="pre">attribute_multiple_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repeats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sleep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sub_channel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#test.attr_tests.attribute_multiple_values" title="Permalink to this definition">#</a></dt>
Expand Down
2 changes: 2 additions & 0 deletions main/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1529,6 +1529,8 @@ <h2 id="A">A</h2>
<li><a href="devices/adi.adrf5720.html#adi.adrf5720.adrf5720.attenuation">attenuation (adi.adrf5720.adrf5720 property)</a>
</li>
<li><a href="dev/test_attr.html#test.attr_tests.attribute_check_range_readonly_with_depends">attribute_check_range_readonly_with_depends() (in module test.attr_tests)</a>
</li>
<li><a href="dev/test_attr.html#test.attr_tests.attribute_check_range_singleval_with_depends">attribute_check_range_singleval_with_depends() (in module test.attr_tests)</a>
</li>
<li><a href="dev/test_attr.html#test.attr_tests.attribute_multiple_values">attribute_multiple_values() (in module test.attr_tests)</a>
</li>
Expand Down
Binary file modified main/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit ae42557

Please sign in to comment.