CW Commands

CW Commands

Generated from FlexLib v4.2.18

Morse code keying

---

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

cw pitch ...

The CW pitch from 100 Hz to 6000 Hz

Syntax:

C<seq>|cw pitch <cwpitch>

Parameters:

Parameter	Description
<cwpitch>

Response Example:

R<seq>|0||

cw ptt ... time=0x... index=... client_handle=0x...

Syntax:

C<seq>|cw ptt <state> time=0x<timestamp> index=<netcwstream> client_handle=0x<cwguiclienthandle>

Parameters:

Parameter	Description
<state>	Valid values: None, Receive, Ready, NotReady, PTTRequested, Transmitting, TXFault, Timeout, StuckInput, UnkeyRequested
<timestamp>
<netcwstream>
<cwguiclienthandle>

Response Example:

R<seq>|0||

cw key ... time=0x... index=... client_handle=0x...

Syntax:

C<seq>|cw key <state> time=0x<timestamp> index=<netcwstream> client_handle=0x<cwguiclienthandle>

Parameters:

Parameter	Description
<state>	Valid values: None, Receive, Ready, NotReady, PTTRequested, Transmitting, TXFault, Timeout, StuckInput, UnkeyRequested
<timestamp>
<netcwstream>
<cwguiclienthandle>

Response Example:

R<seq>|0||

cw key immediate ...

C W Key Immediate

Syntax:

C<seq>|cw key immediate <state>

Parameters:

Parameter	Description
<state>	Valid values: None, Receive, Ready, NotReady, PTTRequested, Transmitting, TXFault, Timeout, StuckInput, UnkeyRequested

Response Example:

R<seq>|0||

cw wpm ...

The CW speed in words per minute (wpm) from 5 to 100

Syntax:

C<seq>|cw wpm <cwspeed>

Parameters:

Parameter	Description
<cwspeed>

Response Example:

R<seq>|0||

cw break_in_delay ...

The CW breakin delay in milliseconds (ms) from 0 ms to 2000 ms

Syntax:

C<seq>|cw break_in_delay <cwdelay>

Parameters:

Parameter	Description
<cwdelay>

Response Example:

R<seq>|0||

cw break_in ...

Enables or disables CW breakin mode, which turns on the transmitter by a key or paddle closure rather than using PTT

Syntax:

C<seq>|cw break_in <cwbreakin>

Parameters:

Parameter	Description
<cwbreakin>

Response Example:

R<seq>|0||

cw sidetone ...

Enables or disables the CW Sidetone

Syntax:

C<seq>|cw sidetone <cwsidetone>

Parameters:

Parameter	Description
<cwsidetone>

Response Example:

R<seq>|0||

cw iambic ...

Enables or disables the Iambic keyer for CW

Syntax:

C<seq>|cw iambic <cwiambic>

Parameters:

Parameter	Description
<cwiambic>

Response Example:

R<seq>|0||

cw mode 0

Enables or disables CW Iambic Mode A

Syntax:

C<seq>|cw mode 0

Response Example:

R<seq>|0||

cw mode 1

Enables or disables CW Iambic Mode B

Syntax:

C<seq>|cw mode 1

Response Example:

R<seq>|0||

cw cwl_enabled ...

Enables or disables CWL. CWU (default) active when disabled.

Syntax:

C<seq>|cw cwl_enabled <cwl_enabled>

Parameters:

Parameter	Description
<cwl_enabled>

Response Example:

R<seq>|0||

cw swap ...

Swaps the CW dot-dash paddles when true

Syntax:

C<seq>|cw swap <cwswappaddles>

Parameters:

Parameter	Description
<cwswappaddles>

Response Example:

R<seq>|0||

cw synccwx ...

Get a reference to the CWX object

Syntax:

C<seq>|cw synccwx <synccwx>

Parameters:

Parameter	Description
<synccwx>

Response Example:

R<seq>|0||