TCP/IP sub

From SmartSDR Wiki
Jump to: navigation, search

Overview

This command will subscribe to messages produced by SmartSDR to inform a client of the status of certain objects. Once a subscription has been enabled, status messages will be sent to the client for changes in the object that is the target of the subscription. In the event that a subscription request is made for an object that does not exist, the following response will be generated:

Responses
Hex Response Message Debug Output / Meaning
500000A3 Invalid subscription object name

To unsubscribe from an object, use the unsub command. This will revert the previous subscription command and discontinue status messages about the object.

SUB AMPLIFIER

Subscribe to status of any amplifiers that have registered with the radio over TCP/IP. (v1.10.8 and later)

C[D]<seq_number>|sub amplifier <handle|all>

<handle|all>  = the 32-bit handle of the amplifier (if it is known) or all to subscribe to all amplifiers

Example:

C21|sub amplifier all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB ATU

Subscribe to status of the internal antenna tuner (ATU) when present.

C[D]<seq_number>|sub atu all

Example:

C21|sub atu all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB AUDIO_STREAM

Subscribe to data from all or a specific audio stream.

C[D]<seq_number>|sub audio_stream <stream_id|all>

< stream_id |all>  = the stream id to subscribe to or the word "all" to subscribe to all

Example:

C21|sub audio_stream all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB CWX

Subscribe to changes to the CWX memories that are able to transmit specific CW phrases on command.

C[D]<seq_number>|sub cwx all

Example:

C21|sub cwx all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB DAX

Subscribe to changes to a specific DAX audio channel or all DAX channels.

C[D]<seq_number>|sub dax <dax_channel|all>

<dax_channel|all>  = the DAX audio channel to subscribe to or the word "all" to subscribe to all

Example:

C21|sub dax_channel all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB DAX_IQ

Subscribe to changes to a specific DAX I/Q channel or all DAX I/Q channels.

C[D]<seq_number>|sub dax_iq <dax_iq_channel|all>

<dax_iq_channel|all>  = the DAX I/Q channel to subscribe to or the word "all" to subscribe to all

Example:

C21|sub dax_iq_channel all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB FOUNDATION

Subscribe to data from all or a specific foundation receiver. When any of the data that defines the foundation receiver changes, a status update will be sent to the client. This allows a client to keep track of objects in the radio. For example if a client is displaying panadapter 1 and another client moves the panadapter, the subscription will allow the second client to get an update on the new frequency.

C[D]<seq_number>|sub foundation <foundation_rx|all>

<foundation_rx|all>  = the number of the foundation receiver to subscribe to or the word "all" to subscribe to all

Example:

C21|sub foundation all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB GPS

Subscribe to data from the on-board GPS receiver (must be present). Data provided is from the GPS data strings that come from the engine and include latitude, longitude, grid square, altitude, satellites tracked and in-view, speed, frequency error, GPS status, track angle and the current time. This command will only function on FLEX-6000 that is GPS capable. On platforms that are not GPS capable (FLEX-6300, for example), the incorrect parameters response will be generated.

C[D]<seq_number>|sub gps all

Example:

C21|sub gps all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters or platform not capable of GPS operation

Response Example:

R21|0|

SUB MEMORIES

Subscribe to changes, additions and deletions to the memory table.

C[D]<seq_number>|sub memories all

Example:

C19|sub memories all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 Successfully subscribed to the meter

Response Example:

R19|0||

SUB METER

Subscribe to a specific meter. The list of meters must be obtained first by selecting the Meter List command and obtaining a list of meters.

C[D]<seq_number>|sub meter <meter_id>

<meter_id>    =  the identifier of the meter

Example:

C19|sub meter 1

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

Responses
Hex Response Message Debug Output / Meaning
00000000 Successfully subscribed to the meter

Response Example:

R19|0||

SUB PAN

Subscribe to data from all panadapters. When any of the data that defines any panadapter changes, a status update will be sent to the client.

C[D]<seq_number>|sub pan all>

Example:

C21|sub pan all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB RADIO

Subscribe to radio-wide data. Radio-wide data includes a number of types of information not bound to other objects including:

  • file upload/download status
  • client registrations/deregistrations
  • interlock status (for transmitter state and ability to transmit)
  • Tracking Notch Filters (TNF)
  • Memories
  • Profiles
  • Radio status including:
 * number of slices available
 * filter sharpness state
 * network parameters
 * lineout gain
 * remote on enable status
 * PLL for adjustment of frequency standard
 * radio nickname
 * binaural status (radio-wide)
 * full duplex status
 * RTTY mark frequency default
 * security including enforcement of private IP connections
  • TURF (for region transmit frequency rules)
C[D]<seq_number>|sub radio all>

Example:

C21|sub radio all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB SCU

Subscribe to data from all or a specific SCU. When any of the data that defines the SCU, a status update will be sent to the client. This allows a client to keep track of objects in the radio. For example if a client is displaying SCU 1 and another client enables the preamp, the subscription will allow the second client to get an update on the preamp status.

C[D]<seq_number>|sub scu <slice_rx|all>

<slice_rx|all>  = the number of the scu to subscribe to or the word "all" to subscribe to all

Example:

C21|sub scu all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB SLICE

Subscribe to data from all or a specific slice receiver. When any of the data that defines the slice receiver changes, a status update will be sent to the client. This allows a client to keep track of objects in the radio. For example if a client is displaying slice receiver 1 and another client moves the receiver, the subscription will allow the second client to get an update on the new position of the slice receiver.

C[D]<seq_number>|sub slice <slice_rx|all>

<slice_rx|all>  = the number of the slice receiver to subscribe to or the word "all" to subscribe to all

Example:

C21|sub slice all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB TX

Subscribe to data from the transmitter including power settings, speech processor status, mic levels, VOX status, transmit frequency and power, etc.

C[D]<seq_number>|sub tx all

Example:

C21|sub tx all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB USB_CABLE

Subscribe to updates in the USB cable table or status of any of the current USB cables. (requires SmartSDR v1.10 or later)

C[D]<seq_number>|sub usb_cable all

Example:

C21|sub usb_cable all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

SUB XVTR

Subscribe to data from the transverter objects.

C[D]<seq_number>|sub xvtr <unit|all>

<unit|all>  = the unit number of the transverter object or the word "all" to subscribe to all

Example:

C21|sub xvtr all

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK subscription registered
5000002C   Incorrect number of parameters

Response Example:

R21|0|

Notes