TCP/IP display pan

From SmartSDR Wiki
Jump to: navigation, search

CREATE

Create a panadapter display.

Only the GUI client may create a Panadapter successfully today. Issue #2323 has been added to address this bug.

C[D]<seq_number>|display pan c freq=<frequency> [ant=[antenna]] [x=[width]] [y=[height]]

<frequency>    = frequency in MHz, up to 15 significant digits
[antenna]      = (optional) antenna port designator (ANT1, ANT2, RX_A, RX_B, XVTR)
[width]     = (optional) the width of the display in pixels
[height]     = (optional) the height of the display in pixels

Example:

C21|display pan c 10.0 1 800 400

See Response Format for details on the format of the response messages from the radio

Responses
Hex Response Message Debug Output / Meaning
00000000 <panadapter stream id>,<waterfall stream id>
50000001   Unable to get foundation receiver assignment
50000003   License check failed, cannot create slice receiver
50000005   The number or type of parameters supplied is incorrect
50000016   Malformed command (unable to parse the frequency, or similar field
5000002C   Incorrect number of parameters
5000002D   Bad field


<panadapter stream id> = the 32-bit hex ID number of the stream to be used as a reference in the client. Your client implementation should save this value so that it can be used in subsequent "set" commands.

<waterfall stream id> = similar reference to the waterfall stream that is automatically created with the Pandapter object.


Response Example:

R21|0|0x40000000,0x42000000

REMOVE

Remove (delete) a panadapter display

C[D]<seq_number>|display pan r <stream_id>

<stream_id>    =  the panadapter stream ID returned in the prior create command

Example:

C19|display pan r 0x40000000

See Response Format for details on the format of the response messages from the radio

Responses
Hex Response Message Debug Output / Meaning
00000000 Successfully deleted panadapter
50000005   The number or type of parameters supplied is incorrect
534C9999   The slice number provided is invalid

Response Example:

R19|0||

RFGAIN_INFO

Retrieve settings that govern the RF Gain control in the radio. Since the RF Gain is a function of hardware implementations, each radio may have different control settings. This command retrieves the details that will make implementation of a control surface possible.

C[D]<seq_number>|display pan rfgain_info <stream_id>

<stream_id>    =  the panadapter stream ID returned in the prior create command

Example:

C21|display pan rfgain_info 0x40000000

See Response Format for details on the format of the response messages from the radio

Responses
Hex Response Message Debug Output / Meaning
00000000 <low>,<high>,<step>[,<marker>]... the response contains the details needed to implement a control
<low> 
low setting for the control
<high> 
high setting for the control
<step> 
the increment between steps, or granularity of the control
<marker> 
the locations of one or more markers to be placed on the control if possible. Each will be separated from the next by a comma

Response Example:

R21|0|-10,30,10,0,20

In this case the control should have setting that go from -10 to 30 in steps of 10 (so -10, 0, 10, 20, 30) and there should be a market at 0 and 20 if possible.

SET

Change parameters that affect the panadapter display or underlying hardware

C[D]<seq_number>|display pan s <stream_id> <param=value> [<param=value>...]

<stream_id>    =  the panadapter stream ID returned in the prior create command
<param=value>  =  a parameter and new value to be changed (one or more of these)

Example:

C12|display pan s xpixels=1000 ypixels=500
Parameter Meaning and Values
Valid set parameters
center change center frequency in MHz of the panadapter display (14.100, for example)
bandwidth change bandwidth in MHz of the panadapter display (0.100, for example)
xpixels change the width of the panadapter display in pixels (1000, for example)
ypixels change the height of the panadapter display in pixels (500, for example)
fps change the desired number of frames of panadapter data per second to be received (15-30 frames per second is typical)
min_dbm change the minimum (y-pixel-min) of the display in dBm (-150.0, for example)
max_dbm change the maximum (y-pixel-max) of the display in dBm (0.0, for example)
port change the target port number for the data[1]
ant change the antenna for this display. The valid list of antennas can be retrieved with the TCP/IP antenna list command
rfgain change the rfgain for the SCU. The valid range for this command must be found using the rfgain_info command.[2]
average change the level of averaging displayed <0-100>
band set which band is being used for the panafall. If specifying a regular HF band, command takes the form of band=<num> . If specifying a XVTR band, command takes the form of band=x<num>
reset_band reset the band
auto_center auto center the panadapter <1|0>


See Response Format for details on the format of the response messages from the radio

Responses
Hex Response Message Debug Output / Meaning
00000000 Successfully deleted slice receiver
50000005   The number or type of parameters supplied is incorrect
5000000C   The frequency requested is out of range
5000000D   Invalid slice receiver number
5000001D   Insufficient resources to tune to that frequency (requires new minimixer, not available)
534C9999   The slice number provided is invalid

Response Example:

R12|0||

Notes

  1. Generally you should filter based on VITA-49 packet headers, not port. Some microcontroller implementations may require port filtering, though
  2. Preamp and attenuator selection and settings are calculated automatically by SmartSDR based on this parameter