Skip to content

Commit

Permalink
Updated doc for 2.0 ecosystem
Browse files Browse the repository at this point in the history
  • Loading branch information
n.danilyuk committed Mar 7, 2023
1 parent d568f1a commit 5b85d9c
Show file tree
Hide file tree
Showing 7 changed files with 450 additions and 238 deletions.
31 changes: 20 additions & 11 deletions appsFeatures/applications/streaming/appStreaming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Streaming
The Streaming application enables users to stream data from Red Pitaya to:

* A file saved on the Red Pitaya SD card
* A file saved on a remote computer via the ethernet protocol (UDP or TCP).
* A file saved on a remote computer via the ethernet protocol (UDP or TCP).

The user is able to set:

Expand Down Expand Up @@ -48,13 +48,13 @@ Start using the Red Pitaya streaming feature
#. Stream locally to a file

#. Set the app's properties & click RUN

.. figure:: img/to_file_settings.png
:width: 20%
:align: center

Example: streaming on ch1, 8 bit resolution, 5.208 MSps into TDMS file format

#. Press STOP to stop streaming

#. Click Browse to open the file browser and download the streaming data file
Expand Down Expand Up @@ -82,9 +82,9 @@ Start using the Red Pitaya streaming feature
.. figure:: img/tcp_settings.png
:width: 20%
:align: center

Example: streaming on ch1, 16 bit resolution 5 MSps, TCP

#. Run the streaming app on a remote computer (copy the IP address from the web interface and choose the required file format).

.. tabs::
Expand Down Expand Up @@ -124,7 +124,7 @@ Start using the Red Pitaya streaming feature
.. figure:: img/diadem_tdms_file_viewer.png
:width: 80%
:align: center

.. group-tab:: CSV

.. code-block:: console
Expand All @@ -135,10 +135,10 @@ Start using the Red Pitaya streaming feature
.. figure:: img/tcp_client3.png
:width: 50%
:align: center


The application saves data from the board in BIN format. This is a binary format. If the application has finished writing data correctly or there is enough free space on the disk, the conversion to CSV format will be automatic.

.. figure:: img/csv_list.png
:width: 50%
:align: center
Expand Down Expand Up @@ -185,7 +185,16 @@ You can also use the desktop version of the client for streaming

#. Download the client

|Streaming Client|
.. tabs::

.. group-tab:: OS version 1.04 or older

|Streaming Client|

.. group-tab:: OS version 2.00

Files with clients are in the streaming web application. You can download it from RP itself.


#. Unzip and run client

Expand All @@ -204,7 +213,7 @@ You can also use the desktop version of the client for streaming
.. figure:: img/qt2.png
:width: 50%
:align: center

.. |Streaming Client| raw:: html

<a href="https://downloads.redpitaya.com/downloads/Clients/streaming/desktop/" target="_blank">Desktop clients</a>
16 changes: 8 additions & 8 deletions appsFeatures/applications/streaming/appXCStreaming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ X-Channel Streaming
.. |br| raw:: html

<br>

********
Overview
********

X-Channel streaming is suitable for applications that require multiple acquisition or generation channels.

Red Pitaya X-Channel streaming software provides the ability to stream analog and digital signals to client PCs from several Red Pitaya devices simultaneously, with synchronised clock and trigger among all Red Pitayas in the system.
Red Pitaya X-Channel streaming software provides the ability to stream analog and digital signals to client PCs from several Red Pitaya devices simultaneously, with synchronised clock and trigger among all Red Pitayas in the system.

Streaming can be done in both directions. Users can stream acquired analog and digital signals from Red Pitaya devices to a client computer or stream analog and digital signals from the client to Red Pitaya device outputs. The X-Channel streaming software also provides the ability to control streaming completely remotely from client PCs.

Expand All @@ -35,7 +35,7 @@ The Red Pitaya STEMlab 125-14 X-Channel System consists of multiple STEMlab 125-
Notice that the Red Pitaya STEMlab 125-14 X-Channel System includes two types of devices:

* one STEMlab 125-14 MASTER device (standard STEMlab 125-14 device)
* one or more STEMlab 125-14 SLAVE devices denoted by an "S" sticker
* one or more STEMlab 125-14 SLAVE devices denoted by an "S" sticker

In order to achieve synchronization, the MASTER device provides a clock and trigger over the SATA S1 connector that is then connected to the S2 of the SLAVE 1 board. SLAVE1 then passes the clock forward to SLAVE 2, SLAVE2 to SLAVE 3, and so on (SLAVE N to SLAVE N+1). This way, we can achieve synchronisation of all boards in the system.

Expand All @@ -57,9 +57,9 @@ Connecting together
*******************

#. Connect all Red Pitayas to the same network via ethernet cables (switch or router that is connected to the client PC).

.. note::

Make sure that your network can provide enough throughput for all the data you are about to stream. It is also recommended to use a dedicated network only for the X-channel system.


Expand Down Expand Up @@ -109,12 +109,12 @@ In this example, we will acquire data from all 3 RP units, which gives us 6 RF i
1. Open the streaming app on the MASTER and all SLAVE boards via the WEB interface.

.. note::

The Streaming app can also be started via ssh by running **/opt/redpitaya/bin/streaming-server.run.sh** on the Red Pitaya.

2. Configure the streaming parameters and configuration.

Configuration can be set over the WEB interface UI, which is then stored in **/root/.streaming_config** on the Red Pitaya.
Configuration can be set over the WEB interface UI, which is then stored in **/root/.streaming_config** or **/root/.config/redpitaya/apps/streaming/streaming_config.json** (for version 2.00) on the Red Pitaya.

In this example, we will show how to set configuration remotely using an already prepared |test configuration| that will set all MASTERS and SLAVES to these settings.

Expand Down Expand Up @@ -226,7 +226,7 @@ In this example, we will show how to set configuration remotely using an already
.. |Audacity| raw:: html

<a href="https://www.audacityteam.org" target="_blank">Audacity</a>

.. figure:: img/audacity_2.png
:width: 80%

Expand Down
Binary file modified appsFeatures/applications/streaming/img/to_file_settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5b85d9c

Please sign in to comment.