Difference between revisions of "TCP/IP slice"

From SmartSDR Wiki
Jump to: navigation, search
(add get_error command)
(Add tx_error)
Line 59: Line 59:
 
|-
 
|-
 
! 00000000  
 
! 00000000  
| <error_value> || align="left" | <error_value> is the frequency offset in mHz.  Negative values indicate the receiver is tuned low in frequency
+
| <rx_error_value>,<tx_error_value> || align="left" | <rx_error_value> is the frequency offset in mHz for the receiver (tx for transmitter).  Negative values indicate the receiver is tuned low in frequency
 
|-
 
|-
 
! 50000005  
 
! 50000005  
Line 66: Line 66:
 
 
 
Response Example:
 
Response Example:
<pre>R21|0|+3.56432</pre>
+
<pre>R21|0|+3.56432,-11.346234</pre>
  
 
=== REMOVE ===
 
=== REMOVE ===

Revision as of 20:34, 19 December 2016

CREATE

Create a slice receiver. See SmartSDR Supported Modes for a complete list of supported modes

C[D]<seq_number>|slice c <frequency> <antenna> <mode>

<frequency>    = frequency in MHz, up to 15 significant digits
<antenna>      = antenna designator: ANT1, ANT2, RXA, RXB, or XVTR
<mode>         = alphanumeric mode designator: usb, lsb, cw, am ...

Example:

C21|slice c 10.0 ANT1 usb

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

Responses
Hex Response Message Debug Output / Meaning
00000000 <slice_rx> OK Slice receiver <num> created on <freq>MHz on port <port>
50000001   Unable to get foundation receiver assignment
50000003   License check failed, cannot create slice receiver
50000004   Slice parameter error
50000005   The number or type of parameters supplied is incorrect


<slice_rx> = the slice receiver number assigned to this slice receiver


Response Example:

R21|0|2|OK Slice receiver 2 created on 10.000 MHz on port ANT1

GET_ERROR

Returns the frequency error of a slice. Slices are tuned using a set of digital tuning elements that can be slightly off-frequency. This command will report the known difference in the requested and actual frequency. Note that this command is only useful if the radio is GPS locked or locked to a 10MHz reference. The result does not take into account any drift in the internal OCXO or TCXO. (v1.10.8 and later)

C[D]<seq_number>|slice get_error <slice_rx>

<slice_rx>    =  the slice receiver number to be removed.  Slice receivers are numbered starting with zero (0)

Example:

C21|slice get_error 0

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

Responses
Hex Response Message Debug Output / Meaning
00000000 <rx_error_value>,<tx_error_value> <rx_error_value> is the frequency offset in mHz for the receiver (tx for transmitter). Negative values indicate the receiver is tuned low in frequency
50000005   The number or type of parameters supplied is incorrect

Response Example:

R21|0|+3.56432,-11.346234

REMOVE

Remove (delete) a slice receiver

C[D]<seq_number>|slice r <slice_rx>

<slice_rx>    =  the slice receiver number to be removed.  Slice receivers are numbered starting with zero (0)

Example:

C19|slice r 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
534C9999   The slice number provided is invalid

Response Example:

R19|0||

TUNE

Tune the slice receiver to a new frequency

C[D]<seq_number>|slice t <slice_rx> <frequency>

<slice_rx>    =  the slice receiver number to be removed.  Slice receivers are numbered starting with zero (0)
<frequency>   =  the new frequency for the slice receiver specified in MHz

Example:

C12|slice t 1 14.2055

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

Responses
Hex Response Message Debug Output / Meaning
00000000 Successfully tuned 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||

LIST

Retrieve a list of slice receivers currently enabled. Note that the single letter after the slice command is a lower case L, not a number one.

C[D]<seq_number>|slice l

Example:

C41|slice l

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

Responses
Hex Response Message Debug Output / Meaning
00000000 <slice list> list of slice receivers provided

Response Example:

R41|0|0 1 3 4|

In this example, slice receivers 0, 1, 3 and 4 are all enabled and in use.

SET

Changes various operational parameters specific to the slice receiver.

C[D]<seq_number>|slice s <slice_rx> <parameter=value> [<parameter=value>...]

Example:

C41|slice s 0 nr=50

Parameters that can be set and the appropriate values are listed in the table below:

Parameter Value
active select (active=1) or deselect (active=0) the specified slice
anf automatic notch filter state (on or off)
anf_level automatic notch filter level: 0=OFF, range 0-100
dax dax channel to be used by the specified slice receiver
mode demodulation mode (See SmartSDR Supported Modes for a complete list of supported modes)
nb noise blanking state (on or off)
nb_level noise blanking level: 0=OFF, range 0-100
nr noise reduction state (on or off)
nr_level noise reduction level: 0=OFF, range 0-100
tx enable (tx=1) or disable (tx=0) transmission via the specified slice


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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK - update successful
5000000F Invalid DSP process (the process you attempted to set it not in this signal chain)
50000016 Malformed command
5000002D Bad field
5000002F Unimplemented mode (mode recognized, but not yet implemented)
50000030 Signal chain error - likely bad mode
50000032 Unrecognized mode (string)
50000033 Parameter out of range

Response Example:

R41|0|0 1 3 4|

In this example, slice receivers 0, 1, 3 and 4 are all enabled and in use.