HAAPI Commands

HAAPI Commands

Generated from FlexLib v4.2.18

High-availability amplifier API control

---

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

ha_api ...

Sends a ha_api command to the radio using the _radio object

Syntax:

C<seq>|ha_api <haapi_cmd>

Parameters:

Parameter	Description
<haapi_cmd>

Response Example:

R<seq>|0||

ha_api amplifier set mode=...

Sends a ha_api command to the radio using the _radio object

Syntax:

C<seq>|ha_api amplifier set mode=<mode>

Parameters:

Parameter	Description
<mode>	Valid values: STANDBY, OPERATE

Response Example:

R<seq>|0||