deploy: 34c7b10

analogdevicesinc · Dec 22, 2023 · 83023a4 · 83023a4
1 parent d5e1ed3
commit 83023a4
Show file tree

Hide file tree

Showing 7 changed files with 77 additions and 51 deletions.
diff --git a/main/_sources/libiio.md.txt b/main/_sources/libiio.md.txt
@@ -115,3 +115,7 @@ Output:
 ```bash
 ID: 0xa
 ```
+
+## libiio v1.X support
+
+**pyadi-iio** supports **libiio** v1.X and v0.X. However, the **libiio** python bindings are not available on PyPI for v1.X and they are currently unstable. If you require stable operation, please use **libiio** v0.X. Its also possible that not all ecosystem features are available yet for v1.X. Please report any issues you find with v1.X.
diff --git a/main/buffers/index.html b/main/buffers/index.html
diff --git a/main/genindex.html b/main/genindex.html
@@ -2716,7 +2716,7 @@ <h2>R</h2>
 </li>
           <li><a href="devices/adi.QuadMxFE_multi.html#adi.QuadMxFE_multi.QuadMxFE_multi.rx">(adi.QuadMxFE_multi.QuadMxFE_multi method)</a>
 </li>
-          <li><a href="buffers/index.html#adi.rx_tx.rx.rx">(adi.rx_tx.rx method)</a>
+          <li><a href="buffers/index.html#adi.rx_tx.rx_core.rx">(adi.rx_tx.rx_core method)</a>
 </li>
         </ul></li>
         <li><a href="devices/adi.adrv9002.html#adi.adrv9002.adrv9002.rx0_en">rx0_en (adi.adrv9002.adrv9002 property)</a>
@@ -2747,7 +2747,7 @@ <h2>R</h2>
 </li>
         <li><a href="devices/adi.adrv9002.html#adi.adrv9002.rx2">rx2() (in module adi.adrv9002)</a>
 </li>
-        <li><a href="buffers/index.html#adi.rx_tx.rx.rx_annotated">rx_annotated (adi.rx_tx.rx property)</a>
+        <li><a href="buffers/index.html#adi.rx_tx.rx_core.rx_annotated">rx_annotated (adi.rx_tx.rx_core property)</a>
 </li>
         <li><a href="devices/adi.adar1000.html#adi.adar1000.adar1000.adar1000_channel.rx_attenuator">rx_attenuator (adi.adar1000.adar1000.adar1000_channel property)</a>
 </li>
@@ -2766,12 +2766,12 @@ <h2>R</h2>
 </li>
           <li><a href="devices/adi.QuadMxFE_multi.html#adi.QuadMxFE_multi.QuadMxFE_multi.rx_buffer_size">(adi.QuadMxFE_multi.QuadMxFE_multi property)</a>
 </li>
-          <li><a href="buffers/index.html#adi.rx_tx.rx.rx_buffer_size">(adi.rx_tx.rx property)</a>
+          <li><a href="buffers/index.html#adi.rx_tx.rx_core.rx_buffer_size">(adi.rx_tx.rx_core property)</a>
 </li>
         </ul></li>
         <li><a href="devices/adi.ad9081.html#adi.ad9081.ad9081.rx_channel_6dB_digital_gains">rx_channel_6dB_digital_gains (adi.ad9081.ad9081 property)</a>
 </li>
-        <li><a href="buffers/index.html#adi.rx_tx.rx.rx_channel_names">rx_channel_names (adi.rx_tx.rx property)</a>
+        <li><a href="buffers/index.html#adi.rx_tx.rx_core.rx_channel_names">rx_channel_names (adi.rx_tx.rx_core property)</a>
 </li>
         <li><a href="devices/adi.ad9081.html#adi.ad9081.ad9081.rx_channel_nco_frequencies">rx_channel_nco_frequencies (adi.ad9081.ad9081 property)</a>
 
@@ -2785,9 +2785,11 @@ <h2>R</h2>
           <li><a href="devices/adi.ad9084.html#adi.ad9084.ad9084.rx_channel_nco_phases">(adi.ad9084.ad9084 property)</a>
 </li>
         </ul></li>
+        <li><a href="buffers/index.html#adi.rx_tx.rx_core">rx_core (class in adi.rx_tx)</a>
+</li>
         <li><a href="buffers/index.html#adi.rx_tx.rx_def">rx_def (class in adi.rx_tx)</a>
 </li>
-        <li><a href="buffers/index.html#adi.rx_tx.rx.rx_destroy_buffer">rx_destroy_buffer() (adi.rx_tx.rx method)</a>
+        <li><a href="buffers/index.html#adi.rx_tx.rx_core.rx_destroy_buffer">rx_destroy_buffer() (adi.rx_tx.rx_core method)</a>
 </li>
         <li><a href="devices/adi.adrv9002.html#adi.adrv9002.adrv9002.rx_dma_mode">rx_dma_mode (adi.adrv9002.adrv9002 property)</a>
 </li>
@@ -2812,7 +2814,7 @@ <h2>R</h2>
         <li><a href="devices/adi.cn0554.html#adi.cn0554.cn0554.rx_enabled_channels">rx_enabled_channels (adi.cn0554.cn0554 property)</a>
 
         <ul>
-          <li><a href="buffers/index.html#adi.rx_tx.rx.rx_enabled_channels">(adi.rx_tx.rx property)</a>
+          <li><a href="buffers/index.html#adi.rx_tx.rx_core.rx_enabled_channels">(adi.rx_tx.rx_core property)</a>
 </li>
         </ul></li>
     </ul></td>
@@ -2904,7 +2906,7 @@ <h2>R</h2>
         <li><a href="devices/adi.cn0554.html#adi.cn0554.cn0554.rx_output_type">rx_output_type (adi.cn0554.cn0554 property)</a>
 
         <ul>
-          <li><a href="buffers/index.html#adi.rx_tx.rx.rx_output_type">(adi.rx_tx.rx property)</a>
+          <li><a href="buffers/index.html#adi.rx_tx.rx_core.rx_output_type">(adi.rx_tx.rx_core property)</a>
 </li>
         </ul></li>
         <li><a href="devices/adi.adar1000.html#adi.adar1000.adar1000.adar1000_channel.rx_phase">rx_phase (adi.adar1000.adar1000.adar1000_channel property)</a>
@@ -3350,7 +3352,7 @@ <h2>T</h2>
 </li>
         <li><a href="buffers/index.html#adi.rx_tx.tx">tx (class in adi.rx_tx)</a>
 </li>
-        <li><a href="buffers/index.html#adi.rx_tx.tx.tx">tx() (adi.rx_tx.tx method)</a>
+        <li><a href="buffers/index.html#adi.rx_tx.tx_core.tx">tx() (adi.rx_tx.tx_core method)</a>
 </li>
         <li><a href="devices/adi.adrv9002.html#adi.adrv9002.adrv9002.tx0_en">tx0_en (adi.adrv9002.adrv9002 property)</a>
 </li>
@@ -3390,7 +3392,7 @@ <h2>T</h2>
 </li>
         <li><a href="devices/adi.adar1000.html#adi.adar1000.adar1000.tx_bias_state">tx_bias_state (adi.adar1000.adar1000 property)</a>
 </li>
-        <li><a href="buffers/index.html#adi.rx_tx.tx.tx_channel_names">tx_channel_names (adi.rx_tx.tx property)</a>
+        <li><a href="buffers/index.html#adi.rx_tx.tx_core.tx_channel_names">tx_channel_names (adi.rx_tx.tx_core property)</a>
 </li>
         <li><a href="devices/adi.ad9081.html#adi.ad9081.ad9081.tx_channel_nco_frequencies">tx_channel_nco_frequencies (adi.ad9081.ad9081 property)</a>
 
@@ -3448,7 +3450,9 @@ <h2>T</h2>
 </li>
         <li><a href="devices/adi.ad937x.html#adi.ad937x.ad9375.tx_clgc_tx_rms_chan1">tx_clgc_tx_rms_chan1 (adi.ad937x.ad9375 property)</a>
 </li>
-        <li><a href="buffers/index.html#adi.rx_tx.tx.tx_cyclic_buffer">tx_cyclic_buffer (adi.rx_tx.tx property)</a>
+        <li><a href="buffers/index.html#adi.rx_tx.tx_core">tx_core (class in adi.rx_tx)</a>
+</li>
+        <li><a href="buffers/index.html#adi.rx_tx.tx_core.tx_cyclic_buffer">tx_cyclic_buffer (adi.rx_tx.tx_core property)</a>
 </li>
         <li><a href="devices/adi.ad9081.html#adi.ad9081.ad9081.tx_dac_en">tx_dac_en (adi.ad9081.ad9081 property)</a>
 </li>
@@ -3462,7 +3466,7 @@ <h2>T</h2>
         </ul></li>
         <li><a href="buffers/index.html#adi.rx_tx.tx_def">tx_def (class in adi.rx_tx)</a>
 </li>
-        <li><a href="buffers/index.html#adi.rx_tx.tx.tx_destroy_buffer">tx_destroy_buffer() (adi.rx_tx.tx method)</a>
+        <li><a href="buffers/index.html#adi.rx_tx.tx_core.tx_destroy_buffer">tx_destroy_buffer() (adi.rx_tx.tx_core method)</a>
 </li>
         <li><a href="devices/adi.adrv9002.html#adi.adrv9002.adrv9002.tx_dma_mode">tx_dma_mode (adi.adrv9002.adrv9002 property)</a>
 </li>
@@ -3512,7 +3516,7 @@ <h2>T</h2>
         </ul></li>
         <li><a href="devices/adi.ad937x.html#adi.ad937x.ad9371.tx_enable_int8">tx_enable_int8 (adi.ad937x.ad9371 property)</a>
 </li>
-        <li><a href="buffers/index.html#adi.rx_tx.tx.tx_enabled_channels">tx_enabled_channels (adi.rx_tx.tx property)</a>
+        <li><a href="buffers/index.html#adi.rx_tx.tx_core.tx_enabled_channels">tx_enabled_channels (adi.rx_tx.tx_core property)</a>
 </li>
         <li><a href="devices/adi.adrv9002.html#adi.adrv9002.adrv9002.tx_ensm_mode_chan0">tx_ensm_mode_chan0 (adi.adrv9002.adrv9002 property)</a>
 </li>

diff --git a/main/index.html b/main/index.html
@@ -530,6 +530,7 @@ <h1>Sections<a class="headerlink" href="#sections" title="Permalink to this head
 <li class="toctree-l1"><a class="reference internal" href="libiio.html">libiio Direct Access</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="libiio.html#libiio-entry-points">libiio Entry Points</a></li>
 <li class="toctree-l2"><a class="reference internal" href="libiio.html#examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libiio.html#libiio-v1-x-support">libiio v1.X support</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>

diff --git a/main/libiio.html b/main/libiio.html
@@ -426,6 +426,10 @@ <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this head
 </pre></div>
 </div>
 </section>
+<section id="libiio-v1-x-support">
+<h2>libiio v1.X support<a class="headerlink" href="#libiio-v1-x-support" title="Permalink to this heading"></a></h2>
+<p><strong>pyadi-iio</strong> supports <strong>libiio</strong> v1.X and v0.X. However, the <strong>libiio</strong> python bindings are not available on PyPI for v1.X and they are currently unstable. If you require stable operation, please use <strong>libiio</strong> v0.X. Its also possible that not all ecosystem features are available yet for v1.X. Please report any issues you find with v1.X.</p>
+</section>
 </section>
 
         </article>
@@ -486,6 +490,7 @@ <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this head
 <li><a class="reference internal" href="#">libiio Direct Access</a><ul>
 <li><a class="reference internal" href="#libiio-entry-points">libiio Entry Points</a></li>
 <li><a class="reference internal" href="#examples">Examples</a></li>
+<li><a class="reference internal" href="#libiio-v1-x-support">libiio v1.X support</a></li>
 </ul>
 </li>
 </ul>

diff --git a/main/objects.inv b/main/objects.inv
diff --git a/main/searchindex.js b/main/searchindex.js
-Original file line number
+Diff line change
@@ Expand Up / @@ -115,3 +115,7 @@ Output: @@
     ```bash
     ID: 0xa
     ```
+    ## libiio v1.X support
+    **pyadi-iio** supports **libiio** v1.X and v0.X. However, the **libiio** python bindings are not available on PyPI for v1.X and they are currently unstable. If you require stable operation, please use **libiio** v0.X. Its also possible that not all ecosystem features are available yet for v1.X. Please report any issues you find with v1.X.