Skip to content

Commit

Permalink
Update SCPI commands
Browse files Browse the repository at this point in the history
  • Loading branch information
Nikolay committed Feb 22, 2024
1 parent e1413fc commit 550e3d4
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions appsFeatures/remoteControl/command_list.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,11 @@ Board control commands
| | ``SYSTem:BRD:Name?`` > ``STEMlab 125-14 v1.0`` | | Python: ``rp_GetVersion()`` | | |
| | | | | | |
+------------------------------------------------------+--------------------------------------------------+-----------------------------------------------------------+--------------------+
| | ``SYSTem:Help?`` > ``List of SCPI commands `` | | - | | Returns a list of all commands | in dev |
| | Examples: | | | | that the SCPI server can process. | |
| | ``SYSTem:Help?`` > ``*CLS\n*ESE\n...`` | | | | |
| | | | | | |
+------------------------------------------------------+--------------------------------------------------+-----------------------------------------------------------+--------------------+
| | - | | C: ``rp_IdGetDNA(uint64_t *dna)`` | Returns the unique DNA code of the FPGA chip. | 2.00-18 and up |
| | | | | | |
| | | | Python: ``rp_IdGetDNA()`` | | |
Expand Down Expand Up @@ -1346,10 +1351,10 @@ Data read
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| SCPI | API, Jupyter | DESCRIPTION | ECOSYSTEM |
+=============================================+==========================================================================================================================================+========================================================================================+====================+
| | ``ACQ:SOUR<n>:DATA:Start:End?`` | | C: ``rp_AcqGetDataPosRaw(rp_channel_t channel, uint32_t start_pos, uint32_t end_pos, int16_t* buffer, uint32_t* buffer_size)`` | | Read samples from start to end position. For API commands, the buffer for data | 1.04-18 and up |
| | ``ACQ:SOUR<n>:DATA:STArt:End?`` | | C: ``rp_AcqGetDataPosRaw(rp_channel_t channel, uint32_t start_pos, uint32_t end_pos, int16_t* buffer, uint32_t* buffer_size)`` | | Read samples from start to end position. For API commands, the buffer for data | 1.04-18 and up |
| | ``<start_pos>,<end_pos>`` | | ``rp_AcqGetDataPosV(rp_channel_t channel, uint32_t start_pos, uint32_t end_pos, float* buffer, uint32_t* buffer_size)`` | | storage and its size must also be provided. Use ``rp_createBuffer`` to allocate data | |
| | Example: | | Python: ``rp_AcqGetDataPosRaw(<channel>, <start_pos>, <end_pos>, <buffer>, <buffer_size>)`` | | for Python and *malloc* for C. API commands have two functions to return data in | |
| | ``ACQ:SOUR1:DATA:Start:End? 10,13`` > | | ``rp_AcqGetDataPosV(<channel>, <start_pos>, <end_pos>, <buffer>, <buffer_size>)`` | | Volts or RAW. | |
| | ``ACQ:SOUR1:DATA:STArt:End? 10,13`` > | | ``rp_AcqGetDataPosV(<channel>, <start_pos>, <end_pos>, <buffer>, <buffer_size>)`` | | Volts or RAW. | |
| | ``{123,231,-231}`` | | | | | |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| | - | | C: ``rp_AcqGetDataRawWithCalib(rp_channel_t channel, uint32_t pos, uint32_t* size, int16_t* buffer)`` | | Read ``<size>`` samples from the ``<pos>`` onwards. The data is returned in RAW | 1.04-18 and up |
Expand All @@ -1364,10 +1369,10 @@ Data read
| | | | | | | |
| | | | | | | |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| | ``ACQ:SOUR<n>:DATA:Start:N?`` | | C: ``rp_AcqGetDataRaw(rp_channel_t channel, uint32_t pos, uint32_t* size, int16_t* buffer)`` | | Read ``size`` samples from the ``<start_pos>`` onwards. | 1.04-18 and up |
| | ``ACQ:SOUR<n>:DATA:STArt:N?`` | | C: ``rp_AcqGetDataRaw(rp_channel_t channel, uint32_t pos, uint32_t* size, int16_t* buffer)`` | | Read ``size`` samples from the ``<start_pos>`` onwards. | 1.04-18 and up |
| | ``<start_pos>,<size>`` | | ``rp_AcqGetDataV(rp_channel_t channel, uint32_t pos, uint32_t* size, float* buffer)`` | | | |
| | Example: | | Python: ``rp_AcqGetDataRaw(<channel>, <pos>, <size>, <buffer>)`` | | | |
| | ``ACQ:SOUR1:DATA:Start:N? 10,3`` > | | ``rp_AcqGetDataV(<channel>, <pos>, <size>, <buffer>)`` | | | |
| | ``ACQ:SOUR1:DATA:STArt:N? 10,3`` > | | ``rp_AcqGetDataV(<channel>, <pos>, <size>, <buffer>)`` | | | |
| | ``{1.2,3.2,-1.2}`` | | | | | |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| | ``ACQ:SOUR<n>:DATA?`` | | C: ``rp_AcqGetOldestDataRaw(rp_channel_t channel, uint32_t* size, int16_t* buffer)`` | | Read the full buffer. | 1.04-18 and up |
Expand All @@ -1382,9 +1387,9 @@ Data read
| | ``{1.2,3.2,-1.2}`` | | ``rp_AcqGetOldestDataV(<channel>, <size>, <buffer>)`` | | If the trigger delay is set to zero, it will read m samples starting | |
| | | | | | from the trigger. | |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
| | ``ACQ:SOUR<n>:DATA:Last:N? <size>`` | | C: ``rp_AcqGetLatestDataRaw(rp_channel_t channel, uint32_t* size, int16_t* buffer)`` | | Read ``<size>`` samples before the trigger delay. | 1.04-18 and up |
| | ``ACQ:SOUR<n>:DATA:LATest:N? <size>`` | | C: ``rp_AcqGetLatestDataRaw(rp_channel_t channel, uint32_t* size, int16_t* buffer)`` | | Read ``<size>`` samples before the trigger delay. | 1.04-18 and up |
| | Example: | | ``rp_AcqGetLatestDataV(rp_channel_t channel, uint32_t* size, float* buffer)`` | | The trigger delay is set to zero by default (in samples or in seconds). | |
| | ``ACQ:SOUR1:DATA:Last:N? 3`` > | | Python: ``rp_AcqGetLatestDataRaw(<channel>, <size>, <buffer>)`` | | If the trigger delay is set to zero, it will read m samples before the trigger. | |
| | ``ACQ:SOUR1:DATA:LAT:N? 3`` > | | Python: ``rp_AcqGetLatestDataRaw(<channel>, <size>, <buffer>)`` | | If the trigger delay is set to zero, it will read m samples before the trigger. | |
| | ``{1.2,3.2,-1.2}`` | | ``rp_AcqGetLatestDataV(<channel>, <size>, <buffer>)`` | | | |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+

Expand Down

0 comments on commit 550e3d4

Please sign in to comment.