Skip to content

Commit

Permalink
Docs. Add note and link in C code
Browse files Browse the repository at this point in the history
  • Loading branch information
n.dnailyuk committed Oct 20, 2020
1 parent 06e3ee3 commit ba0aada
Show file tree
Hide file tree
Showing 13 changed files with 67 additions and 7 deletions.
7 changes: 6 additions & 1 deletion doc/appsFeatures/examples/acqRF-exm1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@ and press run.
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* Red Pitaya C API example Acquiring a signal from a buffer
Expand All @@ -131,7 +136,7 @@ Code - C
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include "redpitaya/rp.h"
#include "rp.h"
int main(int argc, char **argv){
Expand Down
7 changes: 6 additions & 1 deletion doc/appsFeatures/examples/ana-exm1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,19 @@ MATLAB editor, save project and press run.
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* Read analog voltage on slow analog input */
#include <stdio.h>
#include <stdlib.h>
#include "redpitaya/rp.h"
#include "rp.h"
int main (int argc, char **argv) {
float value [4];
Expand Down
7 changes: 6 additions & 1 deletion doc/appsFeatures/examples/ana-exm2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,19 @@ MATLAB editor, save project and press run.
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* Set analog voltage on slow analog output */
#include <stdio.h>
#include <stdlib.h>
#include "redpitaya/rp.h"
#include "rp.h"
int main (int argc, char **argv) {
float value [4];
Expand Down
2 changes: 1 addition & 1 deletion doc/appsFeatures/examples/dig-exm1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Code - C
.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html`_
Instructions on how to compile the code are here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
Expand Down
9 changes: 7 additions & 2 deletions doc/appsFeatures/examples/dig-exm3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,18 @@ MATLAB editor, save project and press run.
Code - C
********


.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
#include <stdio.h>
#include <stdlib.h>
#include "redpitaya/rp.h"
#include "rp.h"
int main (int argc, char **argv) {
rp_pinState_t state;
Expand Down
5 changes: 5 additions & 0 deletions doc/appsFeatures/examples/genRF-exm1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ MATLAB editor, save project and press run.
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* Red Pitaya C API example Generating continuous signal
Expand Down
7 changes: 6 additions & 1 deletion doc/appsFeatures/examples/genRF-exm2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,12 @@ MATLAB editor, save project and press run.
Code - C
********


.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* Red Pitaya C API example Generating signal pulse on an external trigger
Expand Down
5 changes: 5 additions & 0 deletions doc/appsFeatures/examples/genRF-exm3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ and press run.
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* Red Pitaya external trigger pulse generation Example */
Expand Down
5 changes: 5 additions & 0 deletions doc/appsFeatures/examples/genRF-exm4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ and press run.
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
#include <stdio.h>
Expand Down
5 changes: 5 additions & 0 deletions doc/appsFeatures/examples/genRF-exm5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ and press run.
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* Red Pitaya external trigger pulse generation Example */
Expand Down
5 changes: 5 additions & 0 deletions doc/appsFeatures/examples/i2c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ Required hardware
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* @brief This is a simple application for testing IIC communication on a RedPitaya
Expand Down
5 changes: 5 additions & 0 deletions doc/appsFeatures/examples/spi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ Required hardware
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* @brief This is a simple application for testing SPI communication on a RedPitaya
Expand Down
5 changes: 5 additions & 0 deletions doc/appsFeatures/examples/uart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ Required hardware
Code - C
********

.. note::

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 here -> `link <https://redpitaya.readthedocs.io/en/latest/developerGuide/comC.html>`_

.. code-block:: c
/* @brief This is a simple application for testing UART communication on a RedPitaya
Expand Down

0 comments on commit ba0aada

Please sign in to comment.