Merge pull request #29 from Lightsaver7/master

General update
RedPitaya · Apr 5, 2023 · 4035ffc · 4035ffc
2 parents 10a658d + 7c687d4
commit 4035ffc
Show file tree

Hide file tree

Showing 27 changed files with 190 additions and 178 deletions.
diff --git a/appsFeatures/examples/acqRF-exm1.rst b/appsFeatures/examples/acqRF-exm1.rst
@@ -1,3 +1,5 @@
+.. _trig_threshold_example:
+
 Triggering with treshold on channel
 ###################################
 
@@ -7,11 +9,8 @@ Triggering with treshold on channel
 Description
 ***********
 
-This example shows how to acquire 16k samples of a signal on fast analog inputs. The signal will be acquired when the internal trigger condition is met. The time length of the acquired signal depends on the time scale of a buffer that can be set with a decimation factor. The decimations and time scales of a buffer are given in the |sample rate and decimation|. Voltage and frequency ranges depend on the Red Pitaya model. 
-
-.. |sample rate and decimation| raw:: html
+This example shows how to acquire 16k samples of a signal on fast analog inputs. The signal will be acquired when the internal trigger condition is met. The time length of the acquired signal depends on the time scale of a buffer that can be set with a decimation factor. The decimations and time scales of a buffer are given in the :ref:`sample rate and decimation <s_rate_and_dec>`. Voltage and frequency ranges depend on the Red Pitaya model. 
 
-    <a href="https://redpitaya.readthedocs.io/en/latest/appsFeatures/examples/acqRF-samp-and-dec.html#sampling-rate-and-decimations" target="_blank">table</a>
 
 Required hardware
 *****************
@@ -104,7 +103,7 @@ The code is written in MATLAB. In the code, we use SCPI commands and TCP client
                 end
             end
                 
-            % % WILL BE IMPLEMENTED IN FUTURE BETA
+            % % UNIFIED OS
             % % wait for fill adc buffer
             % while 1
             %     fill_state = writeread(RP,'ACQ:TRIG:FILL?')
@@ -200,7 +199,7 @@ The code is written in MATLAB. In the code, we use SCPI commands and TCP client
             end
             
             
-            % % WILL BE IMPLEMENTED IN FUTURE BETA
+            % % UNIFIED OS
             % % wait for fill adc buffer
             % while 1
             %     fill_state = writeread(RP,'ACQ:TRIG:FILL?')
@@ -299,7 +298,7 @@ The code is written in MATLAB. In the code, we use SCPI commands and TCP client
                 end
             end
             
-            % % WILL BE IMPLEMENTED IN FUTURE BETA
+            % % UNIFIED OS
             % % wait for fill adc buffer
             % while 1
             %     fill_state = writeread(RP,'ACQ:TRIG:FILL?')
@@ -394,7 +393,7 @@ The code is written in MATLAB. In the code, we use SCPI commands and TCP client
                 end
             end
 
-            % % WILL BE IMPLEMENTED IN FUTURE BETA
+            % % UNIFIED OS
             % % wait for fill adc buffer
             % while 1
             %     fill_state = writeread(RP,'ACQ:TRIG:FILL?')
@@ -439,11 +438,7 @@ Code - C
 .. note::
 
     Although the C code examples don't require the use of the SCPI server, we have included them here to demonstrate how the same functionality can be achieved with different programming languages. 
-    Instructions on how to compile the code are |compiling and running C|.
-
-.. |compiling and running C| raw:: html
-
-    <a href="https://redpitaya.readthedocs.io/en/latest/developerGuide/software/build/comC.html#compiling-and-running-c-applications" target="_blank">here</a>
+    Instructions on how to compile the code are :ref:`here <comC>`.
 
 .. tabs::
 
@@ -505,7 +500,7 @@ Code - C
                             }
                     }
                     
-                    /* FUTURE BETA
+                    /* UNIFIED OS
                     bool fillState = false;
                     while(!fillState){
                         rp_AcqGetBufferFillState(&fillState);
@@ -571,7 +566,7 @@ Code - C
                             }
                     }
                     
-                    /* FUTURE BETA
+                    /* UNIFIED OS
                     bool fillState = false;
                     while(!fillState){
                         rp_AcqGetBufferFillState(&fillState);
@@ -608,7 +603,7 @@ Using just SCPI commands:
 
         .. code-block:: python
 
-            #!/usr/bin/python3
+            #!/usr/bin/env python3
 
             import sys
             import redpitaya_scpi as scpi
@@ -631,7 +626,7 @@ Using just SCPI commands:
                 if rp_s.rx_txt() == 'TD':
                     break
             
-            ## FUTURE BETA
+            ## UNIFIED OS
             # while 1:
             #     rp_s.tx_txt('ACQ:TRIG:FILL?')
             #     if rp_s.rx_txt() == '1':
@@ -650,7 +645,7 @@ Using just SCPI commands:
 
         .. code-block:: python
 
-            #!/usr/bin/python3
+            #!/usr/bin/env python3
 
             import sys
             import redpitaya_scpi as scpi
@@ -674,7 +669,7 @@ Using just SCPI commands:
                 if rp_s.rx_txt() == 'TD':
                     break
 
-            ## FUTURE BETA
+            ## UNIFIED OS
             # while 1:
             #     rp_s.tx_txt('ACQ:TRIG:FILL?')
             #     if rp_s.rx_txt() == '1':
@@ -693,7 +688,7 @@ Using just SCPI commands:
 
         .. code-block:: python
         
-            #!/usr/bin/python3
+            #!/usr/bin/env python3
 
             import sys
             import redpitaya_scpi as scpi
@@ -717,7 +712,7 @@ Using just SCPI commands:
                 if rp_s.rx_txt() == 'TD':
                     break
 
-            ## FUTURE BETA
+            ## UNIFIED OS
             # while 1:
             #     rp_s.tx_txt('ACQ:TRIG:FILL?')
             #     if rp_s.rx_txt() == '1':
@@ -736,7 +731,7 @@ Using just SCPI commands:
 
         .. code-block:: python
 
-            #!/usr/bin/python3
+            #!/usr/bin/env python3
 
             import sys
             import redpitaya_scpi as scpi
@@ -761,7 +756,7 @@ Using just SCPI commands:
                 if rp_s.rx_txt() == 'TD':
                     break
 
-            ## FUTURE BETA
+            ## UNIFIED OS
             # while 1:
             #     rp_s.tx_txt('ACQ:TRIG:FILL?')
             #     if rp_s.rx_txt() == '1':
@@ -796,15 +791,15 @@ Using just SCPI commands:
             plot.show()
 
 
-Using functions (will be implemented soon):
+Using functions:
 
 .. tabs::
 
     .. tab:: ASCII/VOLTS mode
 
         .. code-block:: python
 
-            #!/usr/bin/python3
+            #!/usr/bin/env python3
 
             import sys
             import redpitaya_scpi as scpi
@@ -828,7 +823,7 @@ Using functions (will be implemented soon):
                 if rp_s.rx_txt() == 'TD':
                     break
             
-            ## FUTURE BETA
+            ## UNIFIED OS
             # while 1:
             #     rp_s.tx_txt('ACQ:TRIG:FILL?')
             #     if rp_s.rx_txt() == '1':
@@ -846,7 +841,7 @@ Using functions (will be implemented soon):
 
         .. code-block:: python
 
-            #!/usr/bin/python3
+            #!/usr/bin/env python3
 
             import sys
             import redpitaya_scpi as scpi
@@ -871,7 +866,7 @@ Using functions (will be implemented soon):
                 if rp_s.rx_txt() == 'TD':
                     break
 
-            ## FUTURE BETA
+            ## UNIFIED OS
             # while 1:
             #     rp_s.tx_txt('ACQ:TRIG:FILL?')
             #     if rp_s.rx_txt() == '1':
@@ -888,7 +883,7 @@ Using functions (will be implemented soon):
 
         .. code-block:: python
         
-            #!/usr/bin/python3
+            #!/usr/bin/env python3
 
             import sys
             import redpitaya_scpi as scpi
@@ -913,7 +908,7 @@ Using functions (will be implemented soon):
                 if rp_s.rx_txt() == 'TD':
                     break
 
-            ## FUTURE BETA
+            ## UNIFIED OS
             # while 1:
             #     rp_s.tx_txt('ACQ:TRIG:FILL?')
             #     if rp_s.rx_txt() == '1':
@@ -956,7 +951,7 @@ Using functions (will be implemented soon):
                 if rp_s.rx_txt() == 'TD':
                     break
 
-            ## FUTURE BETA
+            ## UNIFIED OS
             # while 1:
             #     rp_s.tx_txt('ACQ:TRIG:FILL?')
             #     if rp_s.rx_txt() == '1':

diff --git a/appsFeatures/examples/acqRF-exm2.rst b/appsFeatures/examples/acqRF-exm2.rst
@@ -6,13 +6,9 @@ Description
 
 This example shows how to instantly acquire 16k samples of a signal on fast analog inputs.
 The time length of the acquired signal depends on the time scale of a buffer that can be set with a decimation factor.
-The decimations and time scales of a buffer are given in the |sample rate and decimation|.
+The decimations and time scales of a buffer are given in the :ref:`sample rate and decimation <s_rate_and_dec>`.
 Voltage and frequency ranges depend on the Red Pitaya model. 
 
-.. |sample rate and decimation| raw:: html
-
-    <a href="https://redpitaya.readthedocs.io/en/latest/appsFeatures/examples/acqRF-samp-and-dec.html#sampling-rate-and-decimations" target="_blank">table</a>
-
 
 Required hardware
 *****************
@@ -98,7 +94,7 @@ Code - MATLAB®
         end
     end
     
-    % % FUTURE BETA
+    % % UNIFIED OS
     % % wait for fill adc buffer
     % while 1
     %     fill_state = writeread(RP,'ACQ:TRIG:FILL?')
@@ -138,7 +134,7 @@ Using just SCPI commands:
 
 .. code-block:: python
     
-    #!/usr/bin/python3
+    #!/usr/bin/env python3
     
     import sys
     import redpitaya_scpi as scpi
@@ -157,7 +153,7 @@ Using just SCPI commands:
         if rp_s.rx_txt() == 'TD':
             break
     
-    ## FUTURE BETA
+    ## UNIFIED OS
     # while 1:
     #     rp_s.tx_txt('ACQ:TRIG:FILL?')
     #     if rp_s.rx_txt() == '1':
@@ -172,11 +168,11 @@ Using just SCPI commands:
     plot.ylabel('Voltage')
     plot.show()
 
-Using functions (will be implemented soon):
+Using functions:
 
 .. code-block:: python
     
-    #!/usr/bin/python3
+    #!/usr/bin/env python3
     
     import sys
     import redpitaya_scpi as scpi
@@ -199,7 +195,7 @@ Using functions (will be implemented soon):
         if rp_s.rx_txt() == 'TD':
             break
     
-    ## FUTURE BETA
+    ## UNIFIED OS
     # while 1:
     #     rp_s.tx_txt('ACQ:TRIG:FILL?')
     #     if rp_s.rx_txt() == '1':

diff --git a/appsFeatures/examples/acqRF-exm3.rst b/appsFeatures/examples/acqRF-exm3.rst
@@ -6,11 +6,7 @@ Triggering on external trigger
 Description
 ***********
 
-This example shows how to acquire 16k samples of a signal on fast analog inputs. The signal will be acquired when the external trigger condition is met. The time length of the acquired signal depends on the time scale of a buffer that can be set with a decimation factor. The decimations and time scales of a buffer are given in the |sample rate and decimation|. Voltage and frequency ranges depend on the Red Pitaya model. 
-
-.. |sample rate and decimation| raw:: html
-
-    <a href="https://redpitaya.readthedocs.io/en/latest/appsFeatures/examples/acqRF-samp-and-dec.html#sampling-rate-and-decimations" target="_blank">table</a>
+This example shows how to acquire 16k samples of a signal on fast analog inputs. The signal will be acquired when the external trigger condition is met. The time length of the acquired signal depends on the time scale of a buffer that can be set with a decimation factor. The decimations and time scales of a buffer are given in the :ref:`sample rate and decimation <s_rate_and_dec>`. Voltage and frequency ranges depend on the Red Pitaya model. 
 
 
 Required hardware
@@ -96,7 +92,7 @@ Code - MATLAB®
         end
     end
     
-    % % FUTURE BETA
+    % % UNIFIED OS
     % % wait for fill adc buffer
     % while 1
     %     fill_state = writeread(RP,'ACQ:TRIG:FILL?')
@@ -136,7 +132,7 @@ Using just SCPI commands:
 
 .. code-block:: python
     
-    #!/usr/bin/python3
+    #!/usr/bin/env python3
     
     import sys
     import redpitaya_scpi as scpi
@@ -155,7 +151,7 @@ Using just SCPI commands:
         if rp_s.rx_txt() == 'TD':
             break
     
-    ## FUTURE BETA
+    ## UNIFIED OS
     # while 1:
     #     rp_s.tx_txt('ACQ:TRIG:FILL?')
     #     if rp_s.rx_txt() == '1':
@@ -171,11 +167,11 @@ Using just SCPI commands:
     plot.show()
 
 
-Using functions (will be implemented soon):
+Using functions:
 
 .. code-block:: python
     
-    #!/usr/bin/python3
+    #!/usr/bin/env python3
     
     import sys
     import redpitaya_scpi as scpi
@@ -198,7 +194,7 @@ Using functions (will be implemented soon):
         if rp_s.rx_txt() == 'TD':
             break
     
-    ## FUTURE BETA
+    ## UNIFIED OS
     # while 1:
     #     rp_s.tx_txt('ACQ:TRIG:FILL?')
     #     if rp_s.rx_txt() == '1':