FLDIGI Users Manual  4.0
Configure Scripting

Table of Contents


Configure Scripting

menu-files-config-scripts.png
Scripts
WARNING:
If you do anything with this option, ensure FLDIGI is configured to your preferences. Then generate a restore script. In doing so, any alterations performed below can be returned to it's intended state.
NOTICE:
Because of different hardware and Operating Systems it's advisable to avoid commands that are hardware/OS dependent when creating standard configuration scripts.

Configure scripting uses:

Net Operations
A script can be created for setting the rig frequency, waterfall offset, modem, rig mode, and custom macros. See Configure Script Commands for other available options.
Configuration Reset
After reset, a configure script can be executed to restore User Data. The commands available do not support a full restore. Some option may need manual entry. See Configure Script Commands for limits.

Executing Scripts

From FLDigi's main window select menu item File->Config Scripts->Execute. This will bring up a file browser. Search and select the file in question, then press [Open]. At this point the script will execute.


script_warning_dialogbox.png
Warning Report Dialog Box

If problems are encountered the above dialog box is used to inform the user. To ascertain the extent of the issue(s), select menu item Help->Event Log. The log entires will contain the reason and line number for each reported error.

Some issues reported are the result of preset data that is specific to a particular operating system. These can be safely ignored until configured to operate on your system.


script_error_log_entry.png
Error Report Log Entry

Some configuration options will required FLDigi restart. Ensure configuration is saved prior to restarting.


script_restart_notice.png
Restart FLDIGI notice
NOTE:
Some script commands are specific to operating system and hardware combination. If your system does not support these commands, they will be ignored. The easiest way to determine what your system supports is to generate a script and note it's content.

Generating Scripts

To generate a script the operator selects FLdigi's menu items File->Config Scripts->Generate. A file save dialog box is opened for the user to select a name and where the file is saved. Pressing [Save] initiates the process.

To create custom scripts there are two ways of doing this. With a Text editor (see Scripting Syntax) or changing the content/settings of FLDigi prior to the script generation.

If the latter is used, your are advised to generate a script prior to changing any of FLDigi's settings. Just in case restoration is needed.

Prior to editing any script file, take the time to read the relavent sections of this document. See Scripting Syntax and Example Script

NOTE:
Generated script contents are specific to the operating system and hardware available on the host machine. If a device is not supported on your system, script code will not be generated for it.



Configure Script Commands

FLDIGI

FREQ   |   MODE   |   WFHZ   |   RXID   |   TXID   |   SPOT   |   REV   |   AFC   |   LOCK   |   SQL   |   KPSQL   |   MODEM

OPERATOR

CALLSIGN   |   NAME   |   QTH   |   LOC   |   ANT

AUDIO DEVICE

OSS   |   OSS DEV   |   PA   |   PA PLAYBACK   |   PA CAPTURE   |   PUA   |   PUA SERVER

AUDIO SETTINGS

CAPTURE   |   PLAYBACK   |   CONVERTER   |   RX PPM   |   TX PPM   |   TX OFFSET

AUDIO RT CHANNEL

MONO AUDIO   |   MODEM LR   |   REV LR   |   PTT RT CHAN   |   QSK RT CHAN   |   FSK RT CHAN

AUDIO WAVE.SRATE

RIG HRDWR PTT

PTT RT CHAN   |   SERIAL PORT   |   DEVICE   |   RTS   |   DTR   |   RTSV   |   DTRV   |   START PTT DELAY   |   END PTT DELAY   |   UHROUTER   |   PARALLEL   |   INIT

RIGCAT

STATE   |   DESC FILE   |   DEV PATH   |   RETRIES   |   RETRY INT   |   WDELAY   |   IDELAY   |   BRATE   |   SBITS   |   ECHO   |   TOGGLE RTS PTT   |   TOGGLE DTR PTT   |   RESTORE   |   PTT COMMAND   |   RTS 12V   |   DTR 12V   |   HRDWR FC   |   VSP   |   INIT

HAMLIB

STATE   |   RIG   |   DEV PATH   |   RETRIES   |   RETRY INT   |   WDELAY   |   PWDELAY   |   BRATE   |   SBITS   |   SBAND   |   PTT COMMAND   |   DTR 12V   |   RTS 12V   |   HRDWR FC   |   SFTWR FC   |   ADV CONF   |   INIT

XMLRPC RC

STATE   |   BWDELAY   |   INIT

IO

LOCK   |   PORT   |   CSMA   |   KISS   |   KISS.IPA   |   KISS.IOPN   |   KISS.OPN   |   KISS.DP   |   KISS.BUSY   |   KISS.CONT   |   KISS.ATTEN   |   ARQ   |   ARQ.IPA   |   ARQ.IOPN   |   XMLRPC   |   XMLRPC.IPA   |   XMLRPC.IOPN

MISC NBEMS

TIMEOUT   |   OPEN BRWSR   |   STATE   |   OPEN MSG   |   OPEN FLMSG   |   PATH

ID

RSID.NOTIFY   |   RSID.SRCH BP   |   RSID.MARK PREV   |   RSID.DETECTOR   |   RSID.ALRT DIALOG   |   RSID.TX FREQ LOCK   |   RSID.FREQ CHANGE   |   RSID.ALLOW ERRORS   |   RSID.SQL OPEN   |   RSID.PRETONE   |   RSID.END XMT ID   |   VIDEO.ID MODE   |   VIDEO.VIDEO TXT   |   VIDEO.TEXT INPUT   |   VIDEO.SMALL FONT   |   VIDEO.500HZ   |   VIDEO.WIDTH LIMIT   |   VIDEO.CHAR ROW   |   CW.TX CALL   |   CW.DETECTOR   |   CW.SPEED   |  

MACRO




Scripting Syntax

The script syntax is formated into a multi tier system using two variations. The first is a structured syntax. The second uses a hierarchy system employing dot '.' notation. The command text used closely mimics the GUI configuration panel tabs hierarchy and contents to easily discern the connection between commands and the effected settings.

Structured Commands

Each command ends with a colon (':'). This separates the command section with the paramater section. A command may or may not contain a paramater. Structured statements are terminated using "END:" statement.

<TOP_TIER>:
   <SUB_TIER>:<Parameter>
   <SUB_TIER>:<No Parameter>
END:

Dot Notation Commands

Each command ends with a colon (':'). This separates the command section with the paramater section. A command may or may not contain a paramater. The inclusion of a period ('.') within the command section denotes the separation of upper and lower tier segments.

<TOP_TIER>.<SUB_TIER>,...:<Parameter>
<TOP_TIER>.<SUB_TIER>,...:<No Parameter>

Parameters

Parameter content varies on the command used. The various parameters types are:

Script Files

The script file name is expected to contain a .txt extension. The editing of these files must utilize a true text editor¹. Preferably one that understands the various line ending sequences used between the different Operating Systems.

Note: 1
Windows: Notepad++, Geany
Macintosh: TextWrangler
Linux: Geany, Gedit, Pluma

http://en.wikipedia.org/wiki/Category:Windows_text_editors
http://en.wikipedia.org/wiki/Category:Linux_text_editors


FLDigi Commands

See Operating Controls and Displays

Frequency Control

Sets the RF Carrier frequency (effects rig control).

FREQ:<Real Number>

<Real Number> values are entered directly or as exponential notation. The following frequencies represent the same frequency value.

Frequency Value = Parameter Syntax

Mode

Sets the rig modulation mode (ie. USB, LSB, FM, etc). The actual values are dependent on the rig and the interface used.

MODE:<Character String>

Waterfall Offset (Hz)

Sets the audio tone offset in the waterfall.

WFHZ:<Integer>

Valid values range from 0 - 4000 +/- 50% of the bandwidth needed for the selected modem.

RxID

Enable or disable the use of RSID reception.

RXID:<ENABLE | DISABLE>

TxID

Enable or disable the use of RSID transmission.

TXID:<ENABLE | DISABLE>

Spot

Enable or disable the use of the PSKreporter mechanism.

SPOT:<ENABLE | DISABLE>

Rev

Enable or disable the use of upper and lower tone reversal. Allowing modems like MFSK to receive/transmit LSB signal while the rig is in USB. RSID will not decode when this option is selected and not all modems are supported.

REV:<ENABLE | DISABLE>

AFC

Enable or disable the use of Automatic Frequency Control.

AFC:<ENABLE | DISABLE>

Lk

Enable or disable the use of frequency lock. The behavior of this feature can be altered depending on the settings of the RSID / Video / ID Configuration panel.

LOCK:<ENABLE | DISABLE>

SQL

Enable or disable the use of the squelch.

SQL:<ENABLE | DISABLE>

KPSQL

Enable or disable the use of the KISS power squelch. This option is only available when KISS IO interface option is selected.

See Configure ARQ/KISS I/O

KPSQL:<ENABLE | DISABLE>

MODEM Control

Sets the desired modem to receive and transmit from. Some modems will not be available if KISS IO interface option is selected. See Mode Table under 'mode' column for proper modem parameter syntax.

MODEM:<Character String>

Examples

Structured Dot Notation
FLDIGI:
FREQ:14.070e+06
END:
FLDIGI.FREQ:3853.0e+03
FLDIGI:
MODE:DIG
END:
FLDIGI.MODE:DIG
FLDIGI:
WFHZ:1500
END:
FLDIGI.WFHZ:700
FLDIGI:
RXID:ENABLE
END:
FLDIGI.RXID:DISABLE
FLDIGI:
TXID:DISABLE
END:
FLDIGI.TXID:DISABLE
FLDIGI:
SPOT:DISABLE
END:
FLDIGI.SPOT:ENABLE
FLDIGI:
REV:DISABLE
END:
FLDIGI.REV:ENABLE
FLDIGI:
AFC:DISABLE
END:
FLDIGI.AFC:DISABLE
FLDIGI:
LOCK:DISABLE
END:
FLDIGI.LOCK:ENABLE
FLDIGI:
SQL:DISABLE
END:
FLDIGI.SQL:ENABLE
FLDIGI:
KPSQL:DISABLE
END:
FLDIGI.KPSQL:DISABLE
FLDIGI:
MODEM:BPSK31
END:
FLDIGI.MODEM:BPSK63


Operator Commands

See Configure Operator

Callsign:

OPERATOR.CALLSIGN:<Region Specific>

Name:

OPERATOR.NAME:<Your Name>

QTH:

OPERATOR.QTH:<City, State, Country, etc>

Locator:

Maidenhead Grid Locator. A series of alpha numerical characters representing a position on earth.

OPERATOR.LOC:<AAnnaann>

A: Uppercase characters
n: Numerical data (0-9)
a: Lowercase characters

Additional Information: http://www.arrl.org/grid-squares, or http://en.wikipedia.org/wiki/Maidenhead_Locator_System

Operators Antenna Description

OPERATOR.ANT:<Antenna type, height, etc>

Examples

Structured Dot Notation
OPERATOR:
CALLSIGN:KK5VD
END:
OPERATOR.CALLSIGN:w1hkj
OPERATOR:
NAME:Robert
END:
OPERATOR.NAME:Dave
OPERATOR:
QTH:"Madison, AL"
END:
OPERATOR.QTH:"Toney, AL"
OPERATOR:
LOC:EM64pr
END:
OPERATOR.LOC:EM64
OPERATOR:
ANT:"Inverted 'V' @22FT AGL"
END:
OPERATOR.ANT:"15 EL LP @ 200 FT AGL"


Audio Device Commands

See Sound Card Configuration

OSS

Enable or disable OSS. This option is not available on all operating systems.

OSS:<ENABLE | DISABLE>

Device:

OSS DEV:<Character String>

Parameter:/dev/path

PortAudio

Enable or disable Port Audio. This option may or may not be available to all operating systems.

PA:<ENABLE | DISABLE>

Playback:

The device name is specific to the hardware installed.

PA PLAYBACK:<Integer>,<Character String>

Parameter:Menu Index, Device Name

Note:
Parameter Menu Index is specific to the fldigi/hardware combination. If the device name is available on other systems it will be set to the first occurrence of that device name.

Capture:

The device name is specific to the hardware installed.

PA CAPTURE:<Integer>,<Character String>

Note:
Parameter Menu Index is specific to the fldigi/hardware combination. If the device name is available on other systems it will be set to the first occurrence of that device name.

Parameter:Menu Index, Device Name

PulseAudio

Enable or disable Pulse Audio. This option is not available on all operating systems.

PUA:<ENABLE | DISABLE>

Server string:

PUA SERVER:<Character String>

Parameter: See Note: † below.

Examples

Structured Dot Notation
AUDIO DEVICE:
OSS:ENABLE
END:
AUDIO DEVICE.OSS:ENABLE
AUDIO DEVICE:
OSS DEV:/dev/path
END:
AUDIO DEVICE.OSS DEV:/dev/path
AUDIO DEVICE:
PA:ENABLE
END:
AUDIO DEVICE.PA:ENABLE
AUDIO DEVICE:
PA CAPTURE:2,"USB Audio CODEC"
END:
AUDIO DEVICE.PA CAPTURE:2,"USB Audio CODEC"
AUDIO DEVICE:
PA PLAYBACK:3,"USB Audio CODEC"
END:
AUDIO DEVICE.PA CAPTURE:3,"USB Audio CODEC"
AUDIO DEVICE:
PUA:ENABLE
END:
AUDIO DEVICE.PUA:ENABLE
AUDIO DEVICE:
PUA SERVER:†
END:
AUDIO DEVICE.PUA SERVER:†
Note: † Pulse Audio Server Strings
Pulse audio server string information can be found here:
http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/ServerStrings/


Audio Settings

See Sound Card Configuration

Capture Audio Sample Rate

Set the input signal sample rate. The sample rate availability is dependent on the ADC hardware.

Auto, Native, 8000,...

CAPTURE:<Character String>

Playback Audio Sample Rate

Set the output signal sample rate. The sample rate availability is dependent on the DAC hardware.

Auto, Native, 8000,...

PLAYBACK:<Character String>

Converter

CONVERTER:<Character String> Best, Medium, Fastest, Linear

Receive Audio PPM Correction

RX PPM:<Integer> negative, 0, positive values

Transmit Audio PPM Correction

TX PPM:<Integer> negative, 0, positive values

Transmit Audio Hertz Offset Correction

TX OFFSET:<Integer> negative, 0, positive values (Hertz)

Examples

Structured Dot Notation
AUDIO SETTINGS:
CAPTURE:48000
END:
AUDIO SETTINGS.CAPTURE:Auto
AUDIO SETTINGS:
PLAYBACK:8000
END:
AUDIO SETTINGS.PLAYBACK:Native
AUDIO SETTINGS:
CONVERTER:"Best"
END:
AUDIO SETTINGS.CONVERTER:"Fastest"
AUDIO SETTINGS:
RX PPM:17
END:
AUDIO SETTINGS.RX PPM:17
AUDIO SETTINGS:
TX PPM:17
END:
AUDIO SETTINGS.TX PPM:17
AUDIO SETTINGS:
TX OFFSET:17
END:
AUDIO SETTINGS.TX OFFSET:17


Audio Right Channel Commands

See Right Channel Audio Output

Mono audio output

Enable or disable monophonic signal output.

MONO AUDIO:<ENABLE | DISABLE>

Modem signal on left and right channels

Enable or disable audio signal to both left and right channels

MODEM LR:<ENABLE | DISABLE>

Reverse Left/Right channels

Enable or disable audio signal reversal on Left/Right channels.

REV LR:<ENABLE | DISABLE>

PTT tone on right audio channel

Enable or disable PTT use by suppling a signal on the right channel.

PTT RT CHAN:<ENABLE | DISABLE>

CW QSK signal on right channel

QSK RT CHAN:<ENABLE | DISABLE>

Pseudo-FSK on right audio channel

FSK RT CHAN:<ENABLE | DISABLE>

Examples

Structured Dot Notation
AUDIO RT CHANNEL:
MONO AUDIO:DISABLE
END:
AUDIO RT CHANNEL.MONO AUDIO:DISABLE
AUDIO RT CHANNEL:
MODEM LR:DISABLE
END:
AUDIO RT CHANNEL.MODEM LR:DISABLE
AUDIO RT CHANNEL:
CONVERTER:"Best"
END:
AUDIO RT CHANNEL.CONVERTER:"Fastest"
AUDIO RT CHANNEL:
REV LR:DISABLE
END:
AUDIO RT CHANNEL.REV LR:DISABLE
AUDIO RT CHANNEL:
PTT RT CHAN:DISABLE
END:
AUDIO RT CHANNEL.PTT RT CHAN:DISABLE
AUDIO RT CHANNEL:
QSK RT CHAN:DISABLE
END:
AUDIO RT CHANNEL.QSK RT CHAN:DISABLE
AUDIO RT CHANNEL:
FSK RT CHAN:DISABLE
END:
AUDIO RT CHANNEL.FSK RT CHAN:DISABLE


Wav write sample rate

See WAV File Sample Rate

Sets the record wave file sample rate.

AUDIO WAVE.SRATE:<Integer>

Available Parameters: 8000, 11025, 16000, 22050, 24000, 44100, 48000

Structured Dot Notation
AUDIO WAVE:
SRATE:16000
END:
AUDIO WAVE.SRATE:16000


Hardware PTT Option Commands

See rig_config

PTT tone on right audio channel

PTT RT CHAN:<ENABLE | DISABLE>

Use separate serial port PTT

SERIAL PORT:<ENABLE | DISABLE>

Device:

DEVICE:<Character String>

Parameter: A device path (/dev/ptt)

Use RTS

RTS:<ENABLE | DISABLE>

Use DTR

DTR:<ENABLE | DISABLE>

RTS = +V

RTSV:<ENABLE | DISABLE>

DTR = +V

DTRV:<ENABLE | DISABLE>

PTT delays valid for all CAT/PTT types

START PTT DELAY:<Integer>

PTT delays valid for all CAT/PTT types

END PTT DELAY:<Integer>

Use uHRouter PTT

UHROUTER:<ENABLE | DISABLE>

Use parallel port PTT

PARALLEL:<ENABLE | DISABLE>

Initialize Changes

INIT:

Examples

Structured Dot Notation
RIG HRDWR PTT:
PTT RT CHAN:DISABLE
END:
RIG HRDWR PTT.PTT RT CHAN:DISABLE
RIG HRDWR PTT:
SERIAL PORT:DISABLE
END:
RIG HRDWR PTT.SERIAL PORT:DISABLE
RIG HRDWR PTT:
DEVICE:/dev/ptt
END:
RIG HRDWR PTT.DEVICE:COM1
RIG HRDWR PTT:
RTS:DISABLE
END:
RIG HRDWR PTT.RTS:DISABLE
RIG HRDWR PTT:
RTSV:DISABLE
END:
RIG HRDWR PTT.RTSV:DISABLE
RIG HRDWR PTT:
DTR:DISABLE
END:
RIG HRDWR PTT.DTR:DISABLE
RIG HRDWR PTT:
DTRV:DISABLE
END:
RIG HRDWR PTT.DTRV:DISABLE
RIG HRDWR PTT:
PARALLEL:DISABLE
END:
RIG HRDWR PTT.PARALLEL:DISABLE
RIG HRDWR PTT:
UHROUTER:DISABLE
END:
RIG HRDWR PTT.UHROUTER:DISABLE
RIG HRDWR PTT:
START PTT DELAY:1
END:
RIG HRDWR PTT.START PTT DELAY:1
RIG HRDWR PTT:
END PTT DELAY:1
END:
RIG HRDWR PTT.END PTT DELAY:1
RIG HRDWR PTT:
INIT:
END:
RIG HRDWR PTT.INIT:


RIGCAT Commands

See RigCAT xcvr control

Use RigCAT

STATE:<ENABLE | DISABLE>

Rig description file:

DESC FILE:<Character String>

Parameter:/directory/path/file.xml

Device:

DEV PATH:<Character String>

Parameter:/dev/path

Retries

RETRIES:<integer>

Retry interval (ms)

RETRY INT:<integer>

Write delay (ms)

WDELAY:<integer>

Init delay (ms)

IDELAY:<integer>

Baud rate:

BRATE:<integer>

Stopbits

SBITS:<integer>

Commands are echoed

ECHO:<ENABLE | DISABLE>

Toggle RTS for PTT

TOGGLE RTS PTT:<ENABLE | DISABLE>

Toggle DTR for PTT

TOGGLE DTR PTT:<ENABLE | DISABLE>

Restore Settings on Close

RESTORE:<ENABLE | DISABLE>

CAT command for PTT

PTT COMMAND:<ENABLE | DISABLE>

RTS +12 v

RTS 12V:<ENABLE | DISABLE>

DTR +12 v

DTR 12V:<ENABLE | DISABLE>

RTS/CTS flow control

HRDWR FC:<ENABLE | DISABLE>

VSP Enable

VSP:<ENABLE | DISABLE>

Initialize Changes

INIT:

Examples

Structured Dot Notation
RIGCAT:
STATE:ENABLE
END:
RIG HRDWR PTT.STATE:ENABLE
RIGCAT:
DEV PATH:/dev/tty.usbserial-RT071600
END:
RIGCAT.DEV PATH:COM1
RIGCAT:
DESC FILE:/Users/.fldigi/rigs/FT-817.xml
END:
RIGCAT.DESC FILE:/Users/.fldigi/rigs/FT-817.xml
RIGCAT:
RETRIES:2
END:
RIGCAT.RETRIES:2
RIGCAT:
RETRY INT:500
END:
RIGCAT.RETRY INT:500
RIGCAT:
WDELAY:5
END:
RIGCAT.WDELAY:5
RIGCAT:
IDELAY:0
END:
RIGCAT.IDELAY:0
RIGCAT:
BRATE:4800
END:
RIGCAT.BRATE:4800
RIGCAT:
SBITS:1
END:
RIGCAT.SBITS:1
RIGCAT:
ECHO:DISABLE
END:
RIGCAT.ECHO:DISABLE
RIGCAT:
TOGGLE RTS PTT:DISABLE
END:
RIGCAT.TOGGLE RTS PTT:DISABLE
RIGCAT:
RESTORE:DISABLE
END:
RIGCAT.RESTORE:DISABLE
RIGCAT:
PTT COMMAND:DISABLE
END:
RIGCAT.PTT COMMAND:DISABLE
RIGCAT:
TOGGLE DTR PTT
END:
RIGCAT.TOGGLE DTR PTT
RIGCAT:
TOGGLE RTS PTT:DISABLE
END:
RIGCAT.TOGGLE RTS PTT:DISABLE
RIGCAT:
RTS 12V:DISABLE
END:
RIGCAT.RTS 12V:DISABLE
RIGCAT:
DTR 12V:DISABLE
END:
RIGCAT.DTR 12V:DISABLE
RIGCAT:
HRDWR FC:DISABLE
END:
RIGCAT.HRDWR FC:DISABLE
RIGCAT:
VSP:DISABLE
END:
RIGCAT.VSP:DISABLE
RIGCAT:
INIT:
END:
RIGCAT.INIT:


HAMLIB Commands

See Hamlib xcvr control

Use Hamlib

Enable to disable Hamlib Rig Control interface.

STATE:<ENABLE | DISABLE>

Rig:

Set the rig to control. The list of Rigs are derived from internal list provided by HAMLIB.

RIG:<Character String>

Parameter: HAMLIB Device Names

Device:

The device path for controlling the Rig.

DEV PATH:<Character String>

Parameter:Device path

Retries

The number of tries at sending commands to the Rig

RETRIES:<Interger>

Retry Interval (ms)

RETRY INT:<Interger>

Write delay (ms)

WDELAY:<Interger>

Post write delay (ms)

PWDELAY:<Interger>

Baud rate:

BRATE:<Interger>

Stopbits

SBITS:<Interger>

Sideband:

SBAND:<Character String>

PTT via Hamlib command

PTT COMMAND:<ENABLE | DISABLE>

DTR +12

DTR 12V:<ENABLE | DISABLE>

RTS +12

RTS 12V:<ENABLE | DISABLE>

RTS/CTS flow control

HRDWR FC:<ENABLE | DISABLE>

XON/XOFF flow control

SFTWR FC:<ENABLE | DISABLE>

Advanced configuration:

ADV CONF:<Character String>

Initialize Changes

INIT:

Parameters: None

Examples

Structured Dot Notation
HAMLIB:
STATE:DISABLE
END:
HAMLIB.STATE:DISABLE
HAMLIB:
RIG:"Yaesu FT-817 (Beta)"
END:
HAMLIB.RIG:"Yaesu FT-817 (Beta)"
HAMLIB:
DEV PATH:/dev/tty.usbserial-RT071600
END:
HAMLIB.DEV PATH:COM1
HAMLIB:
RETRIES:2
END:
HAMLIB.RETRIES:2
HAMLIB:
RETRY INT:10
END:
HAMLIB.RETRY INT:10
HAMLIB:
WDELAY:0
END:
HAMLIB.WDELAY:0
HAMLIB:
PWDELAY:5
END:
HAMLIB.PWDELAY:5
HAMLIB:
BRATE:4800
END:
HAMLIB.BRATE:4800
HAMLIB:
SBITS:1
END:
HAMLIB.SBITS:1
HAMLIB:
SBAND:"Rig mode"
END:
HAMLIB.SBAND:"Rig mode"
HAMLIB:
PTT COMMAND:DISABLE
END:
HAMLIB.PTT COMMAND:DISABLE
HAMLIB:
DTR 12V:DISABLE
END:
HAMLIB.DTR 12V:DISABLE
HAMLIB:
RTS 12V:DISABLE
END:
HAMLIB.RTS 12V:DISABLE
HAMLIB:
HRDWR FC:DISABLE
END:
HAMLIB.HRDWR FC:DISABLE
HAMLIB:
SFTWR FC:DISABLE
END:
HAMLIB.SFTWR FC:DISABLE
HAMLIB:
ADV CONF:
END:
HAMLIB.ADV CONF:
HAMLIB:
INIT:
END:
HAMLIB.INIT:


XMLRPC Rig Control Commands

See External program XmlRpc control

Use XML-RPC program

STATE:<ENABLE | DISABLE>

Mode/BW delay

BWDELAY:<Real Number>

Initialize Changes

INIT:

Parameters: None

Examples

Structured Dot Notation
XMLRPC RC:
STATE:DISABLE
END:
XMLRPC RC.STATE:DISABLE
XMLRPC RC:
BWDELAY:0.5
END:
XMLRPC RC.BWDELAY:0.5
XMLRPC RC:
INIT:
END:
XMLRPC RC.INIT:


IO

See Configure ARQ/KISS I/O

Lock

Used to lock the panel from user GUI access. Has no effect on script commands.

LOCK:<ENABLE | DISABLE>

Enable ARQ or KISS IO Access

Select the active IO port for data operation between programs.

PORT:<Character String>

Parameters:

ARQ: Used to control the FL Suite of auxiliary programs.

KISS: KISS protocol over UDP/IP interface

AX25 Decode

Enable or disable Ax25 decoding. Only available when the KISS IO port is active.

AX25D:<ENABLE | DISABLE>

Enable CSMA

Enable or disable Carrier Sense Multiple Access. Only available when the KISS IO port is active.

CSMA:<ENABLE | DISABLE>

KISS Sub Command

KISS related sub commands.

IP Address

IP address for program to program communication

IPA:<Character String>

I/O

IP address I/O port number for program to program communication

IOPN:<Integer>

O

IP address Output port number for program to program communication. Required when FLDigi and auxiliary programs reside on the same host.

OPN:<Integer>

Dual Port

Enable or disable the use of dual port io.

DP:<ENABLE | DISABLE>

Enable Busy Channel

Enable or disable busy channel. Allows for the cooperative use of the frequency.

BUSY:<ENABLE | DISABLE>

Continue After (sec)

The number of seconds the frequency must be clean clear before transmissions resume. Enabled by busy channel activation.

CONT:<Integer>

KPSQL Attenuation

Controls the gain sensitivity of the KISS Power Squelch (KPSQL). The attenuation is measure in fractions. If the value is '4' then the gain is reduced to 1/4th. Maximum gain (sensitivity) requires a value of 1.

ATTEN:<Integer>

ARQ Sub Command

ARQ sub commands

IP Address

IP address for program to program communication

IPA:<Character String>

Port

IP address I/O port number for program to program communication

IOPN:<Integer>

XMLRPC Sub Command

IP Address

IP address for program to program communication

IPA:<Character String>

Port

IP address I/O port number for program to program communication

IOPN:<Integer>

Examples

Structured Dot Notation
IO:
LOCK:ENABLE
END:
IO.LOCK:ENABLE
IO:
PORT:ARQ
END:
IO.PORT:ARQ
IO:
AX25D:DISABLE
END:
IO.AX25D:DISABLE
IO:
CSMA:DISABLE
END:
IO.CSMA:DISABLE


Structured Dot Notation
IO:
KISS:
IPA:127.0.0.1
END:
END:
IO.KISS.IPA:127.0.0.1
IO:
KISS:
IOPN:7342
END:
END:
IO.KISS.IOPN:7342
IO:
KISS:
OPN:7343
END:
END:
IO.KISS.OPN:7343
IO:
KISS:
DP:DISABLE
END:
END:
IO.KISS.DP:DISABLE
IO:
KISS:
BUSY:DISABLE
END:
END:
IO.KISS.BUSY:DISABLE
IO:
KISS:
CONT:3
END:
END:
IO.KISS.CONT:3
IO:
KISS:
ATTEN:2
END:
END:
IO.KISS.ATTEN:2


Structured Dot Notation
IO:
ARQ:
IPA:127.0.0.1
END:
END:
IO.ARQ.IPA:127.0.0.1
IO:
ARQ:
IOPN:7322
END:
END:
IO.ARQ.IOPN:7322


Structured Dot Notation
IO:
XMLRPC:
IPA:127.0.0.1
END:
END:
IO.XMLRPC.IPA:127.0.0.1
IO:
XMLRPC:
IOPN:7362
END:
END:
IO.XMLRPC.IOPN:7362


Misc NBEMS Commands

See NBEMS (flmsg / flwrap) interface

Enable

NBEMS data file interface

STATE:<ENABLE | DISABLE>

Open message folder

OPEN MSG:<ENABLE | DISABLE>

Open with flmsg

OPEN FLMSG:<ENABLE | DISABLE>

FLMsg executable path

PATH:<Character String>

Parameter: Directory and file name to the executable file location.

Open in browser

OPEN BRWSR:<ENABLE | DISABLE>

Timeout (secs)

TIMEOUT:<Character String>

Examples

Structured Dot Notation
MISC NBEMS:
STATE:DISABLE
END:
MISC NBEMS.STATE:DISABLE
MISC NBEMS:
OPEN MSG:DISABLE
END:
MISC NBEMS.OPEN MSG:DISABLE
MISC NBEMS:
OPEN FLMSG:ENABLE
END:
MISC NBEMS.OPEN FLMSG:ENABLE
MISC NBEMS:
OPEN BRWSR:DISABLE
END:
MISC NBEMS.OPEN BRWSR:DISABLE
MISC NBEMS:
TIMEOUT:4.0
END:
MISC NBEMS.TIMEOUT:4.0
MISC NBEMS:
PATH:c:/applications/nbems/flmsg
END:
MISC PATH:c:/applications/nbems/flmsg

ID

See RSID / Video / ID Configuration

RsID

Notify only

Notify operator of RSID reception, disabling waterfall, frequency, and modem changes.

NOTIFY:<ENABLE | DISABLE>

Searches passband

Search the entire band pass for RSID signatures (Enabled). Otherwise search center frequency +/- 200Hz

SRCH BP:<ENABLE | DISABLE>

Mark prev freq/mode

Annotate on receive panel previous frequency and modem on RSID reception.

MARK PREV:<ENABLE | DISABLE>

Disables detector

Ignore RSID tone sequence.

DETECTOR:<ENABLE | DISABLE>

Disable alert dialog

Display Dialog box indicating reception of RSID tone sequence (Enabled).

ALRT DIALOG:<ENABLE | DISABLE>

Retain tx freq lock

Retain frequency/waterfall transmit position on modem switches (enabled).

TX FREQ LOCK:<ENABLE | DISABLE>

Disable freq change

Do not change frequency when RSID tones received.

FREQ CHANGE:<ENABLE | DISABLE>

Allow errors

Adjust RSID reception accuracy at the expense of sensitivity.

ALLOW ERRORS:<Character String>

Parameters: Low, Medium, High

Squelch open (sec)

On RSID reception disable squelch for n seconds.

SQL OPEN:<Integer>

Parameters: 0 - 20

Pre-Signal Tone Seconds

On RSID reception disable squelch for n seconds.

PRETONE:<Real Number>

Parameters: 0.0 - 10.0 in 0.1/1.0 increments

End of xmt ID

Transmit an RSID tone sequence at the end of the data transmission.

END XMT ID:<ENABLE | DISABLE>

Video

Transmit mode ID

Enable/Disable the transmission of video text modem name.

ID MODE:<ENABLE | DISABLE>

Transmit video text

Enable/Disable the transmission of custom video text.

VIDEO TXT:<ENABLE | DISABLE>

Custom Video Text Input

Enable/Disable the transmission of custom video text.

TEXT INPUT:<Character String>

Use small font

Enable/Disable the of small font for video text.

SMALL FONT:<ENABLE | DISABLE>

500 Hz limit

Enable/Disable 500 Hz video width limit

500HZ:<ENABLE | DISABLE>

Mode width limit

Enable/Disable video width limit based on modem bandwidth use.

WIDTH LIMIT:<ENABLE | DISABLE>

Chars/Row:

Maximum number of video text character per "line"

CHAR ROW:<Integer>

Parmeters: 1 - 8 Characters

CW

Transmit callsign

Enable/Disable post callsign CW ID

TX CALL:<ENABLE | DISABLE>

Speed (WPM):

Enable/Disable post callsign CW ID transmit speed

SPEED:<Integer>

Parameters: 15 - 40 WPM

NOTE:
Check the specifications imposed by your country on the maximum speed allowing for CW identifing.

Examples

Structured Dot Notation
ID:
RSID:
NOTIFY:DISABLE
END:
END:
ID.RSID.NOTIFY:DISABLE
ID:
RSID:
SRCH BP:DISABLE
END:
END:
ID.RSID.SRCH BP:DISABLE
ID:
RSID:
MARK PREV:DISABLE
END:
END:
ID.RSID.MARK PREV:DISABLE
ID:
RSID:
DETECTOR:DISABLE
END:
END:
ID.RSID.DETECTOR:DISABLE
ID:
RSID:
ALRT DIALOG:DISABLE
END:
END:
ID.RSID.ALRT DIALOG:DISABLE
ID:
RSID:
TX FREQ LOCK:DISABLE
END:
END:
ID.RSID.TX FREQ LOCK:DISABLE
ID:
RSID:
FREQ CHANGE:DISABLE
END:
END:
ID.RSID.FREQ CHANGE:DISABLE
ID:
RSID:
ALLOW ERRORS:Medium
END:
END:
ID.RSID.ALLOW ERRORS:Medium
ID:
RSID:
SQL OPEN:5
END:
END:
ID.RSID.SQL OPEN:5
ID:
RSID:
PRETONE:0.000
END:
END:
ID.RSID.PRETONE:0.000
ID:
RSID:
END XMT ID:DISABLE
END:
END:
ID.RSID.END XMT ID:DISABLE


Structured Dot Notation
ID:
VIDEO:
ID MODE:DISABLE
END:
END:
ID.VIDEO.ID MODE:DISABLE
ID:
VIDEO:
VIDEO TXT:DISABLE
END:
END:
ID.VIDEO.VIDEO TXT:DISABLE
ID:
VIDEO:
TEXT INPUT:CQ
END:
END:
ID.VIDEO.TEXT INPUT:CQ
ID:
VIDEO:
SMALL FONT:ENABLE
END:
END:
ID.VIDEO.SMALL FONT:ENABLE
ID:
VIDEO:
500HZ:ENABLE
END:
END:
ID.VIDEO.500HZ:ENABLE
ID:
VIDEO:
WIDTH LIMIT:ENABLE
END:
END:
ID.VIDEO.WIDTH LIMIT:ENABLE
ID:
VIDEO:
CHAR ROW:8
END:
END:
ID.VIDEO.CHAR ROW:8


Structured Dot Notation
ID:
CW:
TX CALL:DISABLE
END:
END:
ID.CW.TX CALL:DISABLE
ID:
CW:
SPEED:18
END:
END:
ID.CW.SPEED:18


Load Macro Command

See Macros

The Macro command is a structured command only, dot notation is not supported.

MACRO,row,column,label
<Macro Content>
END:

Parameters:
row - This is the macro bar number seen to the right of the macro buttons (1-4)
column - The physical macro button position from left to right (1-12).
label - The marco buttons label. See Macro Display Symbols for special label glyphs.

No syntax checking is performed for the macro content. User responsibility.

macrobuttons.png
Macro Bar

The following example sets the first button in the first macro bar as seen above.

MACRO:1,1,"CQ @>|"
<TXRSID:on><TX>
cq cq cq de <MYCALL> <MYCALL> <MYCALL> pse k
<RX>
END:


Example Script

NOTE:
This example script may report errors if used as is. Modification is required to meet your particular setup.
FLDIGI_CONFIG
# Fldigi Generated Config Script
# Created: Wed Jan 21 15:44:14 2015

FLDIGI:
   FREQ:1.407000000e+07
   MODE:USB
   WFHZ:1500
   RXID:DISABLE
   TXID:DISABLE
   SPOT:ENABLE
   REV:DISABLE
   AFC:DISABLE
   LOCK:DISABLE
   SQL:DISABLE
   KPSQL:DISABLE
   MODEM:BPSK31
END:
OPERATOR:
   CALLSIGN:kk5vd
   QTH:Robert
   NAME:"Madison, AL"
   LOC:EM64or
   ANT:"Invert 'V' @ 22FT AGL"
END:
AUDIO DEVICE:
   PA:ENABLE
   PA CAPTURE:2,"USB Audio CODEC"
   PA PLAYBACK:3,"USB Audio CODEC"
END:
AUDIO SETTINGS:
   CAPTURE:Auto
   PLAYBACK:Auto
   CONVERTER:"Medium Sinc Interpolator"
   RX PPM:17
   TX PPM:17
   TX OFFSET:0
END:
AUDIO RT CHANNEL:
   MONO AUDIO:DISABLE
   MODEM LR:DISABLE
   REV LR:DISABLE
   PTT RT CHAN:DISABLE
   QSK RT CHAN:DISABLE
   FSK RT CHAN:DISABLE
END:
AUDIO WAVE:
   SRATE:16000
END:
RIG HRDWR PTT:
   PTT RT CHAN:DISABLE
   SERIAL PORT:DISABLE
   DEVICE:/dev/ptt
   RTS:DISABLE
   RTSV:DISABLE
   DTR:DISABLE
   DTRV:DISABLE
   PARALLEL:DISABLE
   UHROUTER:DISABLE
   START PTT DELAY:1
   END PTT DELAY:1
   INIT:
END:
RIGCAT:
   STATE:ENABLE
   DEV PATH:/dev/tty.usbserial-RT071600
   DESC FILE:/Users/.fldigi/rigs/FT-817.xml
   RETRIES:2
   RETRY INT:500
   WDELAY:5
   IDELAY:0
   BRATE:4800
   SBITS:1
   ECHO:DISABLE
   TOGGLE RTS PTT:DISABLE
   RESTORE:DISABLE
   PTT COMMAND:DISABLE
   TOGGLE DTR PTT:DISABLE
   TOGGLE RTS PTT:DISABLE
   RTS 12V:DISABLE
   DTR 12V:DISABLE
   HRDWR FC:DISABLE
   VSP:DISABLE
   INIT:
END:
HAMLIB:
   STATE:DISABLE
   RIG:"Yaesu FT-817  (Beta)"
   DEV PATH:/dev/tty.usbserial-RT071600
   RETRIES:2
   RETRY INT:10
   WDELAY:0
   PWDELAY:5
   BRATE:4800
   SBITS:1
   SBAND:"Rig mode"
   PTT COMMAND:DISABLE
   DTR 12V:DISABLE
   RTS 12V:DISABLE
   HRDWR FC:DISABLE
   SFTWR FC:DISABLE
   ADV CONF:
   INIT:
END:
XMLRPC RC:
   STATE:DISABLE
   BWDELAY:0.500
   INIT:
END:
IO:
   LOCK:ENABLE
   PORT:ARQ
   AX25D:DISABLE
   CSMA:DISABLE
   KISS:
      IPA:127.0.0.1
      IOPN:7342
      OPN:7343
      DP:DISABLE
      BUSY:DISABLE
      CONT:3
      ATTEN:2
   END:
   ARQ:
      IPA:127.0.0.1
      IOPN:7322
   END:
   XMLRPC:
      IPA:127.0.0.1
      IOPN:7362
   END:
END:
MISC NBEMS:
   STATE:ENABLE
   OPEN MSG:DISABLE
   OPEN FLMSG:ENABLE
   PATH:/Applications/flmsg-2.0.6AB.app/Contents/MacOS/flmsg
   OPEN BRWSR:ENABLE
   TIMEOUT:2.000
END:
ID:
   RSID:
      NOTIFY:DISABLE
      SRCH BP:DISABLE
      MARK PREV:ENABLE
      DETECTOR:DISABLE
      ALRT DIALOG:DISABLE
      TX FREQ LOCK:DISABLE
      FREQ CHANGE:DISABLE
      ALLOW ERRORS:Medium
      SQL OPEN:5
      PRETONE:0.000
      END XMT ID:DISABLE
   END:
   VIDEO:
      ID MODE:DISABLE
      VIDEO TXT:DISABLE
      TEXT INPUT:CQ
      SMALL FONT:ENABLE
      500HZ:ENABLE
      WIDTH LIMIT:ENABLE
      CHAR ROW:8
   END:
   CW:
      TX CALL:DISABLE
      SPEED:18
   END:
END:

MACRO:1,1,"CQ"
<TXRSID:on><TX>
cq cq cq de <MYCALL> <MYCALL> <MYCALL>/qrp pse k
<RX>
END:

MACRO:1,2,"ANSWER"
<TX><CALL> <CALL> de <MYCALL> <MYCALL> <MYCALL> kn
<RX>
END:


Return to Top of Page
Return to Main Page