Difference between revisions of "TCP/IP unsub"

From SmartSDR Wiki
Jump to: navigation, search
(UNSUB SCU)
(Remove prior unsub commands and put a pointer to the single sub list to prevent having to keep two lists in sync)
Line 1: Line 1:
=== UNSUB SLICE ===
+
Unsubscribe stops a subscription that is in process for the objects that are listed in the unsub commandSubscriptions provide status messages for objects that are changed in the radio, typically by the radio itself or by other clients (CAT, other GUI clients, etc.).  The general format of the unsubscribe command is:
Unsubscribe to data from all or a specific slice receiverWhen any of the data that defines the slice receiver changes, no status update will be sent to the client.  
+
<pre>
+
C[D]<seq_number>|unsub slice <slice_rx|all>
+
  
<slice_rx|all>  = the number of the slice receiver to unsubscribe to or the word "all" to unsubscribe to all
 
</pre>
 
Example:
 
<pre>C21|unsub slice all</pre>
 
 
See [[SmartSDR TCP/IP API#Response Format|Response Format]] for details on the format of the response messages from the radio
 
 
{| class="wikitable" style="text-align:center"
 
|+Responses
 
|-
 
! Hex Response !! Message !! Debug Output / Meaning
 
|-
 
! 00000000
 
|  || align="left" | OK subscription removed
 
|-
 
! 5000002C
 
| &nbsp; || align="left" | Incorrect number of parameters
 
|}
 
 
Response Example:
 
<pre>R21|0|</pre>
 
 
=== UNSUB FOUNDATION ===
 
Unsubscribe to data from all or a specific foundation receiver.  When any of the data that defines the foundation receiver changes, no status update will be sent to the client. 
 
 
<pre>
 
<pre>
C[D]<seq_number>|unsub foundation <foundation_rx|all>
+
C[D]<seq_number>|unsub <object> <object_id|all>
  
<foundation_rx|all>  = the number of the foundation receiver to unsubscribe to or the word "all" to unsubscribe to all
+
<object>        = the object that is the target of the command such as 'slice' or 'display'
 +
<object_id|all>  = the specific number or identifier of the object to be unsubscribed from or the word "all" to unsubscribe to all
 
</pre>
 
</pre>
Example:
 
<pre>C21|unsub foundation all</pre>
 
 
See [[SmartSDR TCP/IP API#Response Format|Response Format]] for details on the format of the response messages from the radio
 
 
{| class="wikitable" style="text-align:center"
 
|+Responses
 
|-
 
! Hex Response !! Message !! Debug Output / Meaning
 
|-
 
! 00000000
 
|  || align="left" | OK subscription removed
 
|-
 
! 5000002C
 
| &nbsp; || align="left" | Incorrect number of parameters
 
|}
 
 
Response Example:
 
<pre>R21|0|</pre>
 
 
=== UNSUB SCU ===
 
Unsubscribe to data from all or a specific SCU.  When any of the data that defines the SCU changes, no status update will be sent to the client. 
 
<pre>
 
C[D]<seq_number>|unsub scu <slice_rx|all>
 
 
<slice_rx|all>  = the number of the scu to unsubscribe to or the word "all" to unsubscribe to all
 
</pre>
 
Example:
 
<pre>C21|unsub scu all</pre>
 
 
See [[SmartSDR TCP/IP API#Response Format|Response Format]] for details on the format of the response messages from the radio
 
 
{| class="wikitable" style="text-align:center"
 
|+Responses
 
|-
 
! Hex Response !! Message !! Debug Output / Meaning
 
|-
 
! 00000000
 
|  || align="left" | OK subscription removed
 
|-
 
! 5000002C
 
| &nbsp; || align="left" | Incorrect number of parameters
 
|}
 
 
Response Example:
 
<pre>R21|0|</pre>
 
 
=== UNSUB METER ===
 
Unsubscribe to a specific meter.  The list of meters must be obtained first by selecting the [[Metering_protocol|Meter List]] command and obtaining a list of meters.
 
<pre>
 
C[D]<seq_number>|sub meter <meter_id>
 
 
<meter_id>    =  the identifier of the meter
 
</pre>
 
Example:
 
<pre>C19|unsub meter 1</pre>
 
 
See [[SmartSDR TCP/IP API#Response Format|Response Format]] for details on the format of the response messages from the radio
 
 
{| class="wikitable" style="text-align:center"
 
|+Responses
 
|-
 
! Hex Response !! Message !! Debug Output / Meaning
 
|-
 
! 00000000
 
| || align="left" | Successfully unsubscribed from the meter
 
|}
 
  
Response Example:
+
The complete list of objects that can be subscribed to / unsubscribed from can be found in the [[TCP/IP_sub|sub command page]] noting that the command unsub should replace the sub command seen on that page.
<pre>R19|0||</pre>
+
  
 
== Notes ==
 
== Notes ==
 
<references/>
 
<references/>

Revision as of 09:41, 6 December 2016

Unsubscribe stops a subscription that is in process for the objects that are listed in the unsub command. Subscriptions provide status messages for objects that are changed in the radio, typically by the radio itself or by other clients (CAT, other GUI clients, etc.). The general format of the unsubscribe command is:

C[D]<seq_number>|unsub <object> <object_id|all>

<object>         = the object that is the target of the command such as 'slice' or 'display'
<object_id|all>  = the specific number or identifier of the object to be unsubscribed from or the word "all" to unsubscribe to all

The complete list of objects that can be subscribed to / unsubscribed from can be found in the sub command page noting that the command unsub should replace the sub command seen on that page.

Notes