-
Notifications
You must be signed in to change notification settings - Fork 0
Slice Commands
Generated from FlexLib v4.2.18
Receiver slice control, tuning, and configuration
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
| 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 |
Click Tune Request
Syntax:
C<seq>|slice m <clicked_freq_mhz> pan=0x<streamid>
Parameters:
| Parameter | Description |
|---|---|
<clicked_freq_mhz> |
|
<streamid> |
Response Example:
R<seq>|0||
Request Slice Blocking
Creates a new receiver slice. The radio returns the index of the created slice in the response data field.
A FLEX-6300 supports a maximum of 2 slices. A FLEX-6500 or FLEX-6700 supports up to 4. Attempting to create more slices than the radio supports returns an error response.
Response data: <index> — the zero-based index of the newly created slice.
Syntax:
C<seq>|slice create
Response Example:
R<seq>|0||
Sets one or more operational parameters on the specified slice receiver. Multiple
parameter=value pairs may be sent in a single command.
Syntax:
C<seq>|slice set <index> <parameter>=<value>
| Parameter | Description |
|---|---|
active |
Gets or sets the whether the Slice is the Active Slice. |
rxant |
Gets or sets the receive antenna for the slice as a string: "ANT1", "ANT2", "RX_A", "RX_B", "XVTR" |
txant |
Gets or sets the transmit antenna for the slice as a string: "ANT1", "ANT2", "XVTR" |
mode |
Gets or sets the demodulation mode for the slice as a string: "USB", "DIGU", "LSB", "DIGL", "CW", "DSB", "AM", "SAM", "FM" |
dax |
Gets or sets the DAX Channel for the Slice, from 0 to 8 |
rtty_mark |
Gets or sets the Slice RTTY Mark offset |
rtty_shift |
Gets or sets the Slice RTTY Shift offset |
digl_offset |
Gets or sets the Slice DIGL offset |
digu_offset |
Gets or sets the Slice DIGL offset |
audio_pan |
Gets or sets the left-right pan for the Slice audio from 0 to 100. A value of 50 pans evenly between left and right. |
audio_level |
Sets the Slice audio level from 0 to 100. |
audio_mute |
Gets or sets the mute state of the Slice. When true, the Slice audio is muted. |
anf |
Enables or disables the auto-notch filter (ANF) for the Slice. |
apf |
Enables or disables the auto-peaking filter (APF) for the Slice. |
anf_level |
Gets or sets the auto-notch filter (ANF) level from 0 to 100. |
apf_level |
Gets or sets the auto-peaking filter (APF) level from 0 to 100. |
diversity |
Enables or disables the simple Diversity reception for the Slice. Only available for the FLEX-6700 and FLEX-6700R. |
wnb |
Enables or disables the Wideband Noise Blanker (WNB) for the Slice. |
nb |
Enables or disables the Noise Blanker (NB) for the Slice. |
wnb_level |
Gets or sets the Wideband Noise Blanker (WNB) level from 0 to 100. |
nb_level |
Gets or sets the Noise Blanker (NB) level from 0 to 100. |
nr |
Enables or disables the Noise Reduction (NR) for the Slice. |
nr_level |
Gets or sets the Noise Reduction (NR) level from 0 to 100 for the Slice. |
lms_nr |
Enables or disables the lms legacy noise reduction (NRL) for the slice. |
lms_nr_level |
Gets or sets the lms legacy Noise Reduction (NRL) level from 0 to 100 for the slice. |
lms_anf |
Enables or disables the lms legacy auto-notch filter (ANFL) for the slice. |
lms_anf_level |
Gets or sets the lms legacy auto-notch filter (ANFL) level from 0 to 100 for the slice. |
speex_nr |
Enables or disables spectral subtraction noise reduction (NRS) for the slice. |
speex_nr_level |
Gets or sets spectral subtraction noise reduction (NRS) level from 0 to 100 of the slice. |
rnnoise |
Enables or disables AI noise reduction (RNN) for the slice. |
anft |
Enables or disables FFT-based automatic notch filter (ANFT) for the slice. |
nrf |
Enables or disables Noise Reduction w/ Filter (NRF, better NR) for the slice. |
nrf_level |
Gets or sets Noise Reduction w/ filter (NRF) level from 0 to 100 for the slice. |
agc_mode |
Gets or sets the current AGC mode for the Slice. Valid values: None, Off, Slow, Medium, Fast
|
agc_threshold |
Gets or sets the current AGC mode for the Slice. |
agc_off_level |
|
tx |
|
loopa |
|
loopb |
|
rit_on |
|
rit_freq |
|
xit_on |
|
xit_freq |
|
step |
|
record |
Enables or disables audio recording for the Slice. |
play |
Enables or disables audio recording playback for the Slice. |
fm_tone_mode |
|
fm_tone_value |
Used to set the value of the FM Tone. In most cases this is the repeater tone.S |
fm_deviation |
Controls the FM deviation for a given slice. If the slice is also the transmitter it updates the transmit FM deviation as well. |
dfm_pre_de_emphasis |
Gets or sets whether de-emphasis is enabled on RX and if the slice is the transmitter then it also controls pre-emphasis. |
squelch |
Gets or sets whether the squelch algorithm is on for a given slice. |
squelch_level |
Gets or sets the squelch level for modes with squelch. 0 - 100 is valid. |
tx_offset_freq |
Gets or sets the offset frequency of the transmitter. |
fm_repeater_offset_freq |
Gets or sets the OffsetFrequency used for transmitting a wide split in FM. |
repeater_offset_dir |
Gets or sets the direction that the TX Offset will be applied in. |
fm_tone_burst |
Gets or sets whether the FM 1750 Hz PL tone is enabled (EU only) |
esc |
|
esc_phase_shift |
|
esc_gain |
Response Example:
R<seq>|0||
Sets the RF gain for the SCU on which this Slice is on (-10, 0 , 10, 20, 30)
Syntax:
C<seq>|slice set<index> rfgain=<rfgain>
Parameters:
| Parameter | Description |
|---|---|
<index> |
|
<rfgain> |
Response Example:
R<seq>|0||
Gets or sets whether or not the Slice is locked. When locked, the Slice frequency cannot be changed.
Note: Variable 'cmd' has multiple assignments; only one branch captured
Syntax:
C<seq>|slice unlock <index>
Parameters:
| Parameter | Description |
|---|---|
<index> |
Response Example:
R<seq>|0||
Tunes the slice to the specified frequency in MHz. Frequency is expressed as a
decimal value with up to 6 significant digits (e.g., 14.225000).
The radio will not tune outside its hardware-supported frequency range and will
return error 50000004 if the frequency is out of range.
Syntax:
C<seq>|slice tune <index> <freq>
Parameters:
| Parameter | Description |
|---|---|
<index> |
|
<freq> |
Response Example:
R<seq>|0||
The diversity Slice is associated with this Slice, if this Slice is a diversity Slice parent or child. If this Slice is a diversity parent, DiversitySlicePartner will be the diversity child Slice and vice versa.
Syntax:
C<seq>|slice auto_tune <index>
Parameters:
| Parameter | Description |
|---|---|
<index> |
Response Example:
R<seq>|0||
The diversity Slice is associated with this Slice, if this Slice is a diversity Slice parent or child. If this Slice is a diversity parent, DiversitySlicePartner will be the diversity child Slice and vice versa.
Syntax:
C<seq>|slice auto_tune <index> int=<isintermittent>
Parameters:
| Parameter | Description |
|---|---|
<index> |
|
<isintermittent> |
Response Example:
R<seq>|0||
Syntax:
C<seq>|slice set <index>step_list=
Parameters:
| Parameter | Description |
|---|---|
<index> |
Response Example:
R<seq>|0||
Gets or sets whether the FM 1750 Hz PL tone is enabled (EU only)
Syntax:
C<seq>|slice remove <index>
Parameters:
| Parameter | Description |
|---|---|
<index> |
Response Example:
R<seq>|0||
Send Waveform Command
Syntax:
C<seq>|slice waveform_cmd <index> <s>
Parameters:
| Parameter | Description |
|---|---|
<index> |
|
<s> |
Response Example:
R<seq>|0||
Core Radio Control
Client and Connectivity
Audio and CW
Display and Data
System and Utilities
- Amplifier Commands
- Antenna Commands
- ATU Commands
- Equalizer Commands
- Filter Commands
- Information Commands
- Interlock Commands
- Keepalive Commands
- License Commands
- Memory Commands
- Meter Commands
- MOX Commands
- Ping Commands
- Subscription Commands
- TNF Commands
- Transverter Commands
- USB Cable Commands
- Waveform Commands
- HAAPI Commands
- ALE Commands