SmartSDR Status Responses - flexradio/smartsdr-api-docs GitHub Wiki

Slice receiver responses always start with the standard status header and are followed by the word 'slice' and the slice number that corresponds to the update. Each status line will only contain updates for a single slice. Here is the format for a slice update:

S<client>|slice <slice_rx> <field_value_pair> ...

<client>            = the hexadecimal client that precipitated the change to the value
<slice_rx>          = the slice receiver being updated
<field_value_pair>  = a field name and its new value, may occur one or more times

Not all field-value-pairs are required in an update and in many situations only one field will be provided. For example, when tuning only the frequency is likely to be emitted. The field-value-pairs are available in this list:

Example slice status response:

SA4E3D1C9|slice 2 in_use=1 RF_frequency=1.44 antenna_id=5 mode=USB wide=1 filter_lo=0.0003 filter_hi=0.0024

Panadapter responses always start with the standard status header and are followed by the words 'display pan' and the output stream that corresponds to the panadapter. This stream identification number is provided on creation of the panadapter and is the unique handle for manipulating and receiving status on the panadapter. Each status line will only contain updates for a single panadapter. Here is the format for a panadapter update:

S<client>|display pan <stream_id> <field_value_pair> ...

<client>            = the hexadecimal client that precipitated the change to the value
<stream_id>         = the 32-bit hexadecimal stream ID for the panadapter, such as 0x11223344
<field_value_pair>  = a field name and its new value, may occur one or more times

Not all field-value-pairs are required in an update and in many situations only one field will be provided. The field-value-pairs are available in this list:

Example slice status response:

SA4E3D1C9|display pan 0x40000000 center=1.3 bandwidth=0.384 x_pixels=300 y_pixels=200 fps=20

The FLEX-6000 uses an interlock model that prevents the transmitter from keying unless interlock conditions are met. The status of the interlock and the transmitter are sent to the client to assist in displaying the status and helping the operator troubleshoot the interlock status. Here is the format for a interlock update:

S0|interlock state=<state> [reason=<reason>] [source=<source>] [timeout=<timeout_ms>]
            [acc_txreq_enable=<T|F>] [rca_txreq_enable=<T|F>] [acc_txreq_polarity=<T|F>] [rca_txreq_polarity=<T|F>]

<state>         = the current interlock state. Always shown
<reason>        = if the radio is unable to transmit, a reason why it cannot.  Only shown when there is an interlock problem
<source>        = if the radio is transmitting, the source of the PTT.  Only shown when the radio is transmitting
<T|F>           = 'T' for TRUE or 'F' for FALSE when used with enables.  For TXREQ line polarity, 'T' indicates that it is OK to transmit when this line is +V and 'F' when 0 V.

See the Interlock State Transition Diagram for details on state transitions

Example slice status response:

S0|interlock state=TRANSMITTING source=RCA