Difference between revisions of "TCP/IP message"

From SmartSDR Wiki
Jump to: navigation, search
(just a copy of something else -- still in progress)
 
(addition of messages command)
Line 1: Line 1:
IN PROGRESS -- temporary save
 
 
 
 
 
=== MESSAGE ===
 
=== 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.
 
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  
+
C[D]<seq_number>|message severity=<severity> "<message>"
 +
 
 +
<severity>  = severity of message (see table below)
 +
<message>    = message to be delivered
 
</pre>
 
</pre>
 +
 +
Severity Values:
 +
{|  align="center"  class="wikitable sortable" style="border:#73BF73; background: #F5FFF5;"
 +
! style="background:#CEF2CE" | Severity  !! style="background:#82D982" align="left" | Meaning
 +
|-
 +
| info ||  align="left" | Informational message, no action required
 +
|-
 +
| warning || align="left" | Warning condition
 +
|-
 +
| error || align="left" | Error condition that will typically prevent operation
 +
|}
 +
 +
 
Example:
 
Example:
<pre>C16|info</pre>
+
<pre>C16|message severity=error "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
Line 19: Line 31:
 
|-
 
|-
 
! 00000000  
 
! 00000000  
| <list> || align="left" | List of radio specific parameters
+
| || align="left" | OK message received
|}
+
|}
 
+
+
<list> = list of antennas separated by commas
+
+
 
 
 
Response Example:
 
Response Example:
<pre>R16|0|model="FLEX-6700",chassis_serial="K00000000",mbtrx_pcb="PC-0062",mbtrx_pcbrev="E",
+
<pre>R16|0</pre>
mbtrx_bom="B-0064",mbtrx_bomrev="A",mbtrx_serial="B28154-07 LF",mbpa_pcb="",mbpa_rev="",
+
mbpa_bom="",mbpa_bomrev="",mbpa_serial="",name="",callsign="N5AC",gps="Warming Up",
+
scu=2,slice=8,software_ver=0.0.3,mac=00:18:31:78:4F:B4,ip=192.168.30.136,
+
netmask=255.255.255.0,gateway=192.168.30.1,location=""
+
</pre>
+
 
+
{|  align="center"  class="wikitable sortable" style="border:#73BF73; background: #F5FFF5;"
+
! style="background:#CEF2CE" | Parameter  !! style="background:#82D982" align="left" | Value
+
|-
+
| model2 ||  align="left" | Radio model number
+
|-
+
| chassis_serial || align="left" | Radio serial number (on outside of chassis)
+
|-
+
| mbtrx_pcb || align="left" | MBTRX main board model number
+
|-
+
| mbtrx_pcbrev || align="left" | MBTRX main board revision number
+
|-
+
| mbtrx_bom || align="left" | MBTRX main board bill of materials (BOM) number
+
|-
+
| mbtrx_bomrev || align="left" | MBTRX main board bill of materials (BOM) revision number
+
|-
+
| mbtrx_serial || align="left" | MBTRX main board serial number
+
|-
+
| mbpa_pcb || align="left" | MBPA main board model number
+
|-
+
| mbpa_pcbrev || align="left" | MBPA main board revision number
+
|-
+
| mbpa_bom || align="left" | MBPA main board bill of materials (BOM) number
+
|-
+
| mbpa_bomrev || align="left" | MBPA main board bill of materials (BOM) revision number
+
|-
+
| mbpa_serial || align="left" | MBPA main board serial number
+
|-
+
| name || align="left" | User assigned name of this radio
+
|-
+
| callsign || align="left" | Callsign of radio owner
+
|-
+
| gps || align="left" | Status of the on-board GPS (see GPS table below)
+
|-
+
| scu || align="left" | Number of SCUs in this radio
+
|-
+
| slice || align="left" | Number of slice receivers in this radio
+
|-
+
| software_ver || align="left" | Version of the software in the radio (firmware)
+
|-
+
| mac || align="left" | MAC Address for the radio's Ethernet connector
+
|-
+
| ip || align="left" | IP Address for the radio's Ethernet connector
+
|-
+
| netmask || align="left" | Netmask Address for the radio's Ethernet connector
+
|-
+
| gateway || align="left" | Gateway IP address for the radio's Ethernet connector
+
|-
+
| location || align="left" | User supplied location of the radio
+
|}
+
 
+
GPS Values
+
 
+
{|  align="center"  class="wikitable sortable" style="border:#73BF73; background: #F5FFF5;"
+
! style="background:#CEF2CE" | Value  !! style="background:#82D982" align="left" | Meaning
+
|-
+
| Not Present ||  align="left" | No GPS is present in the radio
+
|-
+
| Warming Up || align="left" | The GPS TCXO is warming up and no lock has been achieved
+
|-
+
| Holdover || align="left" | The GPS has lost a sky view and is in holdover mode
+
|-
+
| Locking || align="left" | The GPS has acquired satellites and is locking
+
|-
+
| Hold Phase || align="left" | The GPS has a lock but is reacquiring the TCXO phase
+
|-
+
| Locked || align="left" | The GPS has a good view of the sky and is locked
+
|}
+

Revision as of 20:08, 8 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> "<message>"

<severity>   = severity of message (see table below)
<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 "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