XmlRpc Control

As of version 3.0, various aspects of Fldigi's operation can be controlled remotely using XML-RPC. XML-RPC data is transported via simple HTTP and client implementations exist for most programming languages. A Perl client that can be used as a control script is included in the source tarball as scripts/fldigi-shell.

The following command line arguments become available when XML-RPC support is compiled into fldigi, as described in the build instructions:

--xmlrpc-server-address HOSTNAME
    Set the XML-RPC server address. The default is 127.0.0.1.

--xmlrpc-server-port PORT
    Set the XML-RPC server port. The default is 7362.

--xmlrpc-allow REGEX
    Allow only the methods whose names match REGEX

--xmlrpc-deny REGEX
    Allow only the methods whose names don't match REGEX

--xmlrpc-list
    List all available methods

The --xmlrpc-deny and --xmlrpc-allow switches can be used as a simple access control mechanism. REGEX specifies a POSIX extended regular expression. This invocation disables the methods that may cause fldigi to transmit:

--xmlrpc-deny 'main\.(tx|tune|run_macro)'

By default all methods are allowed.

The --xmlrpc-list switch outputs the method list and exits the program. If preceded by --xmlrpc-deny or --xmlrpc-allow, it shows the list of
methods as filtered by those switches.

The methods implemented in version 3.1 are listed below. The three columns are method name, signature (return_type:argument_types), and
description. Refer to the XML-RPC specification for the meaning of the signature characters (briefly: n=nil, b=boolean, i=integer, d=double,
s=string, 6=bytes, A=array, S=struct).

fldigi.list	A:n	Returns the list of methods
fldigi.name	s:n	Returns the program name
fldigi.version_struct	S:n	Returns the program version as a struct
fldigi.version	s:n	Returns the program version as a string
fldigi.name_version	s:n	Returns the program name and version
fldigi.config_dir	s:n	Returns the name of the configuration directory

modem.get_name	s:n	Returns the name of the current modem
modem.get_names	A:n	Returns all modem names
modem.get_id	i:n	Returns the ID of the current modem
modem.get_max_id	i:n	Returns the maximum modem ID number
modem.set_by_name	s:s	Sets the current modem. Returns old name
modem.set_by_id	i:i	Sets the current modem. Returns old ID
modem.set_carrier	i:i	Sets modem carrier. Returns old carrier
modem.inc_carrier	i:i	Increments the modem carrier frequency. Returns the new carrier
modem.get_carrier	i:n	Returns the modem carrier frequency
modem.get_afc_search_range	i:n	Returns the modem AFC search range
modem.set_afc_search_range	n:i	Sets the modem AFC search range. Returns the old value
modem.inc_afc_search_range	n:i	Increments the modem AFC search range. Returns the new value
modem.get_bandwidth	i:n	Returns the modem bandwidth
modem.set_bandwidth	n:i	Sets the modem bandwidth. Returns the old value
modem.inc_bandwidth	n:i	Increments the modem bandwidth. Returns the new value
modem.get_quality	d:n	Returns the modem signal quality in the range [0:100]
modem.search_up	n:n	Searches upward in frequency
modem.search_down	n:n	Searches downward in frequency

main.get_status1	s:n	Returns the contents of the first status field (typically s/n)
main.get_status2	s:n	Returns the contents of the second status field
main.get_sideband	s:n	Returns the current sideband
main.set_sideband	n:s	Sets the sideband to USB or LSB
main.get_frequency	d:n	Returns the RF carrier frequency
main.set_frequency	d:d	Sets the RF carrier frequency. Returns the old value
main.inc_frequency	d:d	Increments the RF carrier frequency. Returns the new value
main.get_afc	b:n	Returns the AFC state
main.set_afc	b:b	Sets the AFC state. Returns the old state
main.toggle_afc	b:n	Toggles the AFC state. Returns the new state
main.get_squelch	b:n	Returns the squelch state
main.set_squelch	b:b	Sets the squelch state. Returns the old state
main.toggle_squelch	b:n	Toggles the squelch state. Returns the new state
main.get_squelch_level	d:n	Returns the squelch level
main.set_squelch_level	d:d	Sets the squelch level. Returns the old level
main.inc_squelch_level	d:d	Increments the squelch level. Returns the new level
main.get_reverse	b:n	Returns the Reverse Sideband state
main.set_reverse	b:b	Sets the Reverse Sideband state. Returns the old state
main.toggle_reverse	b:n	Toggles the Reverse Sideband state. Returns the new state
main.get_lock	b:n	Returns the Transmit Lock state
main.set_lock	b:b	Sets the Transmit Lock state. Returns the old state
main.toggle_lock	b:n	Toggles the Reverse Sideband state. Returns the new state
main.get_trx_status	s:n	Returns transmit/tune/receive status
main.tx	n:n	Transmits
main.tune	n:n	Tunes
main.rsid	n:n	Waits for RSID
main.rx	n:n	Receives
main.abort	n:n	Aborts a transmit or tune
main.run_macro	n:i	Runs a macro
main.get_max_macro_id	i:n	Returns the maximum macro ID number

log.get_frequency	s:n	Returns the Frequency field contents
log.get_time_on	s:n	Returns the Time-On field contents
log.get_time_off	s:n	Returns the Time-Off field contents
log.get_call	s:n	Returns the Call field contents
log.get_name	s:n	Returns the Name field contents
log.get_rst_in	s:n	Returns the RST(r) field contents
log.get_rst_out	s:n	Returns the RST(s) field contents
log.get_serial_number	s:n	Returns the serial number field contents
log.get_state	s:n	Returns the State field contents
log.get_province	s:n	Returns the Province field contents
log.get_country	s:n	Returns the Country field contents
log.get_qth	s:n	Returns the QTH field contents
log.get_band	s:n	Returns the current band name
log.get_sideband	s:n	Returns the current sideband
log.get_notes	s:n	Returns the Notes field contents
log.get_locator	s:n	Returns the Locator field contents
log.get_az	s:n	Returns the AZ field contents
log.clear	n:n	Clears the contents of the log fields
log.set_call	n:s	Sets the Call field contents

text.get_rx_length	i:n	Returns the number of characters in the RX widget
text.get_rx	6:ii	Returns a range of characters (start, length) from the RX text widget
text.clear_rx	n:n	Clears the RX text widget
text.add_tx	n:s	Adds a string to the TX text widget
text.add_tx_bytes	n:6	Adds a byte string to the TX text widget
text.clear_tx	n:n	Clears the TX text widget

spot.get_auto	b:n	Returns the autospotter state
spot.set_auto	n:b	Sets the autospotter state. Returns the old state
spot.toggle_auto	n:b	Toggles the autospotter state. Returns the new state
spot.pskrep.get_count	i:n	Returns the number of callsigns spotted in the current session

Contents