2.4. Command-line tools

Note

Command-line utilities must not be used in parallel with a WEB application.

For correct operation of the acquire, generate, and monitor tools, the correct FPGA image must be loaded. Please note that some applications can change the FPGA image loaded. To load the FPGA image, open a terminal on the Red Pitaya and execute the following command:

redpitaya> cat /opt/redpitaya/fpga/fpga_0.94.bit > /dev/xdevcfg

2.4.1. Signal generator utility

The Red Pitaya signal generator can be controlled through the generate command line utility.

redpitaya> generate
generate version 0.90-299-1278

Usage: generate   channel amplitude frequency <type>

    channel     Channel to generate a signal on [1, 2].
    amplitude   Peak-to-peak signal amplitude in Vpp [0.0 - 2.0].
    frequency   Signal frequency in Hz [0.0 - 6.2e+07].
    type        Signal type [sine, sqr, tri].

The performance of the signal generator differs from one Red Pitaya model to another. For more information, please refer to the Red Pitaya boards comparison.

2.4.2. Signal acquisition utility

The signal from Red Pitaya can be acquired through the acquire command line utility. It will return raw samples from the ADC buffer to standard output with no calibration compensation. Usage instructions:

redpitaya> acquire
acquire version 0.90-299-1278

Usage: acquire  size <dec>

    size     Number of samples to acquire [0 - 16384].
    dec      Decimation [1,8,64,1024,8192,65536] (default=1).

Example (acquire 1024 samples with decimation 8):

redpitaya> acquire 1024 8
    -148     -81
    -143     -84
    -139     -88
    -134     -82
    ...

The performance of the acquisition tool differs from one Red Pitaya model to another. Please see the Red Pitaya boards comparison for more information.

2.4.3. Monitor utility

2.4.3.1. Accessing system registers

The system registers can be accessed through the monitor utility. Usage instructions:

redpitaya>  monitor
monitor version 1.03-0-ab43ad0-ab43ad0

Usage:
    read addr: address
    write addr: address value
    read analog mixed signals: -ams
    set slow DAC: -sdac AO0 AO1 AO2 AO3 [V]

Example (system register reading):

redpitaya> monitor -ams
#ID         Desc            Raw                 Val
0           Temp(0C-85C)    0x00000b12          75.670
1           AI0(0-3.5V)     0x00000008          0.014
2           AI1(0-3.5V)     0x00000017          0.039
3           AI2(0-3.5V)     0x00000008          0.014
4           AI3(0-3.5V)     0x00000006          0.010
5           AI4(5V0)        0x000004f9          3.800
6           VCCPINT(1V0)    0x0000055e          1.006
7           VCCPAUX(1V8)    0x00000995          1.797
8           VCCBRAM(1V0)    0x00000561          1.009
9           VCCINT(1V0)     0x00000561          1.009
10          VCCAUX(1V8)     0x00000997          1.798
11          VCCDDR(1V5)     0x00000806          1.504
12          AO0(0-1.8V)     0x0000000f          0.173
13          AO1(0-1.8V)     0x0000004e          0.900
14          AO2(0-1.8V)     0x00000075          1.350
15          AO3(0-1.8V)     0x0000009c          1.800

You can find a more detailed description of the above-mentioned pins here. The –ams switch provides access to analog mixed signals including Zynq SoC temperature, auxiliary analog input reading, power supply voltages, and configured auxiliary analog output settings. The auxiliary analog outputs can be set through the monitor utility using the –SADC switch:

redpitaya> monitor -sdac 0.9 0.8 0.7 0.6

2.4.3.2. Accessing FPGA registers

Red Pitaya signal processing is based on two computational engines: the FPGA and the dual-core processor, to effectively split the tasks. Most of the high data rate signal processing is implemented within the FPGA building blocks. These blocks can be configured parametrically through registers. The FPGA registers are documented in the Red Pitaya HDL memory map document. The registers can be accessed using the described monitor utility. For example, the following sequence of monitor commands checks modifies, and verifies the acquisition decimation parameter (at address 0x40100014):

redpitaya> monitor 0x40100014
0x00000001
redpitaya>
redpitaya> monitor 0x40100014 0x8
redpitaya> monitor 0x40100014
0x00000008
redpitaya>

Note

The CPU algorithms communicate with the FPGA through these registers. Therefore, the user should be aware of possible interference with Red Pitaya applications which are reading or acting upon these same FPGA registers. For simple tasks, however, the monitor utility can be used by high-level scripts (Bash, Python, MATLAB, etc.) to communicate directly with the FPGA if necessary.

2.4.4. Bode Analyzer

The Bode Analyzer can be used from the console.

Note

The preparation of the environment can be found in this chapter.

root@rp-f01c35:~# bode
Too few arguments!

Bode analyzer version 1.04-133-feaf63b43, compiled at Fri Jan 22 04:25:24 2021

Usage:       bode [channel] [amplitude] [dc bias] [averaging] [count/steps] [start freq] [stop freq] [scale type]
or
   bode -calib

   channel            Channel to generate a signal on [1 / 2].
   amplitude          Signal amplitude in V [0 - 1, which means max 2Vpp].
   dc bias            DC bias/offset/component in V [0 - 1].
                     Max sum of amplitude and DC bias is (0-1]V.
   averaging          Number of samples per measurement [>1].
   count/steps        Number of measurements [>2].
   start freq         Lower frequency limit in Hz [3 - 62.5e6].
   stop freq          Upper frequency limit in Hz [3 - 62.5e6].
   scale type         0 - linear, 1 - logarithmic.
   -calib             Starts calibration mode. The calibration values will be saved in:/tmp/ba_calib.data
Output:      frequency [Hz], phase [deg], amplitude [dB]

To run the bode, you need to do 2 steps:

  1. Load the FPGA image of streaming

    redpitaya> cat /opt/redpitaya/fpga/fpga_0.94.bit > /dev/xdevcfg

  2. Launch a console application.

    root@rp-f09508:~# bode 1 1 0 1 10 1000 100000 0
1000.00     0.00025    0.34855
12000.00    0.00090    0.34481
23000.00    0.00209    0.32803
34000.00    0.00859    0.33696
45000.00    0.00335    0.26568
56000.00    -0.00580   0.38830
67000.00    -0.01751   0.36922
78000.00    0.00635    0.32767
89000.00    0.00521    0.38478
100000.00   -0.00933   0.36610

2.4.5. LCR meter

The LCR meter can be used from the console.

Note

The preparation of the environment can be found in this chapter.

root@rp-f01c35:~# lcr
Too few arguments!

LCR meter version 0.00-0000, compiled on Fri Aug 14 03:29:10 2020

Usage:       lcr [freq] [r_shunt]

   freq               Signal frequency used for measurement [ 100 , 1000, 10000 , 100000 ] Hz.
   r_shunt            Shunt resistor value in Ohms [ 10, 100, 1000, 10000, 100000, 1000000 ]. If set to 0, Automatic ranging is used.
                     Automatic ranging demands an Extenson module.

Output:      Frequency [Hz], |Z| [Ohm], P [deg], Ls [H], Cs [F], Rs [Ohm], Lp [H], Cp [F], Rp [Ohm], Q, D, Xs [H], Gp [S], Bp [S], |Y| [S], -P [deg]

To run the LCR meter, you need to do 2 steps:

  1. Load the FPGA image of streaming

    redpitaya> cat /opt/redpitaya/fpga/fpga_0.94.bit > /dev/xdevcfg

  2. Launch a console application.

    root@rp-f01c35:~# lcr 100 100000 -v
Frequency       100 Hz
Z       5.424000 kOmh
Phase   1.364216 deg
L(s)    205.533997 mH
C(s)    -12.324000 uF
R(s)    5.422000 kOmh
L(p)    0.000000 H
C(p)    0.000000 F
R(p)    5.425000 kOmh
Q       0.023815
D       -41.991112
X_s     129.141129
G_p     0.000184
B_p     0.000000
|Y|     0.000184
-P_Y    -1.364216 deg

2.4.6. Streaming application

The server for streaming can be started not only using the web interface but also through the command line.

root@rp-f07167:/# streaming-server
Missing parameters: Configuration file
Usage: streaming-server
        -b run service in the background
        -c path to the config file

To start the server, you need to do 3 steps:

  1. Load the FPGA image of streaming

    redpitaya> cat /opt/redpitaya/fpga/fpga_streaming.bit > /dev/xdevcfg
redpitaya> /opt/redpitaya/sbin/mkoverlay.sh stream_app

  2. Prepare a configuration file.

    Note

    In version 2.00, the configuration file has been moved to a new location: /root/.config/redpitaya/apps/streaming/streaming_config.json

  3. Launch a console application.

    root@rp-f07167:/# streaming-server -c /root/.streaming_config
streaming-server started
Lost rate: 0 / 763 (0 %)
Lost rate: 0 / 766 (0 %)
Lost rate: 0 / 766 (0 %)
Lost rate: 0 / 766 (0 %)

The configuration for streaming is automatically created and saved in the file: /root/.streaming_config during the editing of the parameters in the web application.

Note

Any changes to the web application will automatically modify the configuration file. If you want to save the configuration, then make a copy of the file.

Note

The server can be started in the background. To do this, use the -b parameter. In this mode, the application can be used as a service at system startup. Service information from the application is saved in the syslog file (by default, the Syslog is not installed on RP).

Note

Streaming always creates two files:

  • The first stores of streamed data

  • The second stores the data transfer report

Note

Streaming app sources are available here: streaming app.

Note

For streaming, two versions of clients are available - console and desktop for Linux and Windows operating systems. You can download them from the WEB streaming application on Red Pitaya itself. You can also build a version from source files under Mac OS using QT Creator.

2.4.7. LED enable/disable utility

The Red Pitaya LED indications can be enabled or disabled through the led_control command-line utility. Disabling LEDs is important for applications where the noise level needs to be reduced to its minimum.

Usage instructions:

root@rp-f09508:~# led_control

Usage: led_control -y[=State] | -r[=State] | -e [=State]

    -y    9 Yellow LED. Responsible for the status of reading the memory card.
    -r    Red LED, which is responsible for the heartbeat.
    -e    LEDs on the ethernet connector.

Optional parameter:
    State = [Off | On]  Turns LEDs on or off

To disable the LEDs:

root@rp-f09508:~# led_control -y=Off -e=Off -r=Off

To enable the LEDs:

root@rp-f09508:~# led_control -y=On -e=On -r=On