Difference between revisions of "TCP/IP amplifier"

From SmartSDR Wiki
Jump to: navigation, search
(SET)
Line 65: Line 65:
 
Response Example:
 
Response Example:
 
<pre>R44|0</pre>
 
<pre>R44|0</pre>
 +
 +
=== Amplifier subscriptions ===
 +
 +
To subscribe to amplifier notifications (status messages) see [[TCP/IP_sub#SUB_AMPLIFIER|Subscribe Amplifier]]

Revision as of 12:44, 14 December 2016

CREATE

Creates/registers a new amplifier associated with the client handle that created the connection

C[D]<seq_number>|amplifier create ip=<ip_string> port=<port> model=<model_string> 
           serial_num=<serial> ant=<radio_ant:amp_ant,...>

<ip_string>             = optional IPv4 quartet (used to control amp from radio)
<port>                  = port number that the amplifier is listening for commands
<model_string>          = model of amplifier (max length of 64 chars) (no spaces allowed)
<serial_num>            = serial number of amplifier (max length of 64 chars) (no spaces allowed)
<radio_ant:amp_ant,...> = a list of radio_antenna to amplifier_antenna pairs that  
                          specifies which radio antennas are connected to which amplifier 
                          antennas, must be separated by commas (no spaces allowed)

Example:

C44|amplifier create ip=192.168.20.209 port=9000 model=PowerGeniusXL serial_num=1284-2394-2345 
          ant=ANT1:PORTB,ANT2:PORTA

If an amplifier has already been created by a specific client connection and this command is re-issued - it will overwrite the previous amplifier settings.

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

Responses
Hex Response Message Debug Output / Meaning
00000000 OK

Response Example:

R44|0

SET

Sets specific settings/fields of a particular amplifier object by handle.

C[D]<seq_number>|amplifier set <handle> mode=<mode_string>

<handle>             = the handle of the amplifier (received from create status message)
<mode_string>        = operate or standby (specifies amplifier operational mode)

Example:

C44|amplifier set 0xA0F8467 mode=operate 

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

Responses
Hex Response Message Debug Output / Meaning
00000000   OK
500000A8   Invalid amplifier mode
500000A7   Invalid amplifier - could not find by handle

Response Example:

R44|0

Amplifier subscriptions

To subscribe to amplifier notifications (status messages) see Subscribe Amplifier