Difference between revisions of "TCP/IP message"

From SmartSDR Wiki
Jump to: navigation, search
(addition of messages command)
(add message code parameter)
Line 2: Line 2:
 
The message command allows one client to send a message to other clients that will provide important information to the clients.  Today, messages displayed in this way generally do not persist on the client: they are shown briefly and then they are removed from the display.
 
The message command allows one client to send a message to other clients that will provide important information to the clients.  Today, messages displayed in this way generally do not persist on the client: they are shown briefly and then they are removed from the display.
 
<pre>
 
<pre>
C[D]<seq_number>|message severity=<severity> "<message>"
+
C[D]<seq_number>|message severity=<severity> code=<code_value> "<message>"
  
<severity>   = severity of message (see table below)
+
<severity>   = severity of message (see table below)
 +
<code_value>  = hexadecimal error code to be interpreted by other clients
 
<message>    = message to be delivered
 
<message>    = message to be delivered
 
</pre>
 
</pre>
Line 21: Line 22:
  
 
Example:
 
Example:
<pre>C16|message severity=error "Amplifier over temperature"</pre>
+
<pre>C16|message severity=error code=0xFE0000012 "Amplifier over temperature"</pre>
  
 
See [[SmartSDR TCP/IP API#Response Format|Response Format]] for details on the format of the response messages from the radio
 
See [[SmartSDR TCP/IP API#Response Format|Response Format]] for details on the format of the response messages from the radio

Revision as of 03:34, 9 December 2016

MESSAGE

The message command allows one client to send a message to other clients that will provide important information to the clients. Today, messages displayed in this way generally do not persist on the client: they are shown briefly and then they are removed from the display.

C[D]<seq_number>|message severity=<severity> code=<code_value> "<message>"

<severity>    = severity of message (see table below)
<code_value>  = hexadecimal error code to be interpreted by other clients
<message>     = message to be delivered

Severity Values:

Severity Meaning
info Informational message, no action required
warning Warning condition
error Error condition that will typically prevent operation


Example:

C16|message severity=error code=0xFE0000012 "Amplifier over temperature"

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK message received

Response Example:

R16|0