Client Commands

Client Commands

Generated from FlexLib v4.2.18

Client connection and session management

---

Wire Protocol

Commands follow the FlexRadio TCP wire protocol:

C[D]<seq_number>|<command> [sub-command] [parameters]

Where:

• C = Command prefix
• D = Optional debug flag
• <seq_number> = Sequence number for command tracking
• <command> = Primary command word
• [sub-command] = Optional sub-command
• [parameters] = Command-specific parameters

Responses follow the format:

R<seq_number>|<result_code>|<data>|[debug_info]

Where:

• R = Response prefix
• <seq_number> = Matching sequence number from command
• <result_code> = Result code (0 = success, non-zero = error)
• <data> = Command-specific response data
• [debug_info] = Optional debug information

Common Response Codes

Code	Meaning
0	Success
50000001	Unable to get foundation receiver assignment
50000003	License check failed
50000004	Parameter error
50000005	Incorrect number or type of parameters
50000016	Malformed command
5000002C	Incorrect number of parameters
50000032	Bad mode

---

Commands

client set

Syntax:

C<seq>|client set <parameter>=<value>

Parameter	Description
local_ptt	Set Local Ptt For Gui Client
send_reduced_bw_dax

Response Example:

R<seq>|0||

client ip

Syntax:

C<seq>|client ip

Response Example:

R<seq>|0||

client program ...

Syntax:

C<seq>|client program <api>

Parameters:

Parameter	Description
<api>

Response Example:

R<seq>|0||

client start_persistence off

Syntax:

C<seq>|client start_persistence off

Response Example:

R<seq>|0||

client low_bw_connect

Syntax:

C<seq>|client low_bw_connect

Response Example:

R<seq>|0||

client gui

Syntax:

C<seq>|client gui

Response Example:

R<seq>|0||

client gui ...

Syntax:

C<seq>|client gui <guiclientid>

Parameters:

Parameter	Description
<guiclientid>

Response Example:

R<seq>|0||

client udpport ...

Syntax:

C<seq>|client udpport <udpport>

Parameters:

Parameter	Description
<udpport>

Response Example:

R<seq>|0||

client disconnect

Disconnects all currently connected GUI clients from the radio

Syntax:

C<seq>|client disconnect

Response Example:

R<seq>|0||

client disconnect ...

Disconnects a single connected client given the client's handle

Syntax:

C<seq>|client disconnect <handle>

Parameters:

Parameter	Description
<handle>

Response Example:

R<seq>|0||

client set enforce_network_mtu=1 network_mtu=...

Syntax:

C<seq>|client set enforce_network_mtu=1 network_mtu=<mtu>

Parameters:

Parameter	Description
<mtu>

Response Example:

R<seq>|0||

client bind client_id=...

Bind G U I Client

Syntax:

C<seq>|client bind client_id=<client_id>

Parameters:

Parameter	Description
<client_id>

Response Example:

R<seq>|0||

client station ...

This event is raised when an existing GUIClient has been updated

Syntax:

C<seq>|client station <station_name>

Parameters:

Parameter	Description
<station_name>

Response Example:

R<seq>|0||