Merge remote-tracking branch 'hex/master'
Conflicts: src/dialogs/confdialog.h src/xmlrpcpp/XmlRpcThread.cpp src/xmlrpcpp/XmlRpcThread.h src/xmlrpcpp/XmlRpcThreadedServer.cpp src/xmlrpcpp/XmlRpcThreadedServer.hpull/1/head
|
@ -4,11 +4,13 @@
|
|||
*Makefile.in
|
||||
aclocal.m4
|
||||
autom4te.cache/
|
||||
build-aux/compile
|
||||
build-aux/config.guess
|
||||
build-aux/config.sub
|
||||
build-aux/depcomp
|
||||
build-aux/install-sh
|
||||
build-aux/missing
|
||||
build-aux/test-driver
|
||||
config.log
|
||||
config.status
|
||||
configure
|
||||
|
@ -17,9 +19,11 @@ doc/guide.html
|
|||
po/POTFILES
|
||||
po/*.gmo
|
||||
po/stamp-po
|
||||
src/.deps/
|
||||
src/.deps
|
||||
src/*/.deps
|
||||
src/config.h
|
||||
src/config.h.in*
|
||||
src/*/.dirstamp
|
||||
src/flarq
|
||||
src/fldigi
|
||||
src/dl-fldigi
|
||||
|
|
2
AUTHORS
|
@ -32,4 +32,4 @@ EMAIL: s57ln (at) hamradio [dot] si
|
|||
|
||||
All authors can be contacted on the fldigi-devel mailing list:
|
||||
|
||||
WWW: http://lists.berlios.de/mailman/listinfo/fldigi-devel
|
||||
https://sourceforge.net/p/fldigi/mailman/fldigi-devel/
|
||||
|
|
4
INSTALL
|
@ -29,10 +29,6 @@ present on your system:
|
|||
* The PulseAudio sound backend is compiled if the development files
|
||||
for libpulse-simple, the PulseAudio simple API library, are present.
|
||||
|
||||
* The embedded XML-RPC web server is enabled if `configure' can find
|
||||
the C++ bindings for the libxmlrpc-c3 library. An example client
|
||||
can be found in scripts/fldigi-shell.
|
||||
|
||||
Once you have installed the required packages, the following commands
|
||||
should be sufficient to compile fldigi and install it under /usr/local:
|
||||
|
||||
|
|
135
NEWS
|
@ -1,3 +1,138 @@
|
|||
= Fldigi 3.22 release notes =
|
||||
|
||||
== Modems ==
|
||||
|
||||
* RTTY
|
||||
- Fixed decoder for baud rate > 110
|
||||
- modified DSP filter; filter length dependent on baud rate
|
||||
|
||||
* EmComm 8PSK modes
|
||||
Mode Baud WPM BW FEC ITU RSID-1 RSID-2
|
||||
8PSK125 125 310 125 Y 125HG1B 56 1037
|
||||
8PSK250 250 620 250 Y 250HG1B 56 1038
|
||||
8PSK500 500 1650 500 Y 500HG1B 56 1043
|
||||
8PSK1000 1000 3300 1000 N 1000HG1B 56 1047
|
||||
8PSK1200 1200 3540 1200 Y 1200HG1B 56 1058
|
||||
8PSK1333 1333 4300 1333 N 1333HG1B 56 1059
|
||||
|
||||
* PSK/PSKR squelch changed to fast attack / slow decay processing
|
||||
|
||||
* fft-scan - used to measure transceiver filter characteristics.
|
||||
- preferred noise source is wide band noise bridge.
|
||||
- open circuit antenna will suffice
|
||||
|
||||
* Analysis modem
|
||||
- added signal level to display and text file
|
||||
- removed debugging printf statement in cw.cxx file
|
||||
- restored "noise" controls to active state
|
||||
|
||||
== Macros ==
|
||||
|
||||
* Added information macro tags
|
||||
- <ANTENNA> my antenna
|
||||
- <BAND> current operating band
|
||||
* New modem tests based on a specified number of 5 letter code groups
|
||||
- <CPS_N:nnn>
|
||||
- <WAV_N:nnn>
|
||||
* <DELTA:+/-n.nnn> increment/decrement xcvr carrier
|
||||
* <FOCUS> force keyboard focus to frequency control.
|
||||
|
||||
|
||||
== User interface ==
|
||||
|
||||
* Added Dutch translation
|
||||
* Updated Polish translation
|
||||
* Touch Screen UI
|
||||
- user selectable macro button bar height
|
||||
- allow swapping Rx and Tx panels.
|
||||
- larger frequency control with max range into GHz values
|
||||
- modified single left click behavior. Single left click either
|
||||
. grabs QSO data
|
||||
. acts on "clickable" item.
|
||||
. starts drag sequence
|
||||
* Smeter / Power meter, added new meter viewers
|
||||
- annunciates values received from flrig / xmlrpc values
|
||||
- button to toggle between meter(s) and xvcr mode/bw controls
|
||||
* Freq Control
|
||||
- Modified keyboard events:
|
||||
. added progdefaults.sel_lsd
|
||||
selection of Right / Left arrow least significant digit
|
||||
Right Arrow + 1 LSD
|
||||
Left Arrow - 1 LSD
|
||||
Up Arrow + 10 * LSD
|
||||
Dn Arrow - 10 * LSD
|
||||
Shft Rt Arrow + 100 * LSD
|
||||
Shft Lft Arrow - 100 * LSD
|
||||
Shft Up Arrow + 1000 * LSD
|
||||
Shft Dn Arrow - 1000 * LSD
|
||||
. Added OFFCOLOR to background of group box to insure that all digit areas
|
||||
are contiguous with digit backgrounds.
|
||||
. added "focus" indicator that is more visible than the default fltk
|
||||
dotted line
|
||||
* Signal browsers
|
||||
- modified rtty and psk viewers to eliminate modem specific code in the
|
||||
UI elements
|
||||
- restricted psk multichannel viewer to modes
|
||||
. PSK31, PSK63, PSK63F and PSK125
|
||||
. QPSK31, QPSK63 and QPSK125
|
||||
* Removed Mixer controls and supporting code
|
||||
* Macro Buttons
|
||||
- Increase width of alternate macro button(s)
|
||||
- Added 2 row scheme, one above, one below text panel
|
||||
- Macro row(s) button height user adjustable
|
||||
* New User Exit Behavior - changed defaults for new user to force
|
||||
- confirm exit, save configuration & macros on first use
|
||||
- prompt dialogs thereafter until user changes configuration dialog selections
|
||||
- added UI configuration to new install Wizard
|
||||
|
||||
== XMLRPC control language ==
|
||||
|
||||
* Added xmlrpc commands
|
||||
- main.get_txid get state of txid switch
|
||||
- main.set_txid set state of txid switch
|
||||
- main.toggle_txid toggle state of txid switch
|
||||
- main.rx_only disables Tx.
|
||||
- main.rx_tx enables normal Rx/Tx operation
|
||||
* KISS/ARQ specific commands
|
||||
- io.in_use Returns the IO port in use (ARQ/KISS).
|
||||
- io.enable_kiss Switch to KISS I/O
|
||||
- io.enable_arq Switch to ARQ I/O
|
||||
|
||||
|
||||
== Other changes ==
|
||||
|
||||
* Thumb drive - updated documentation on thumb drive installation
|
||||
in folder FL_APPS
|
||||
* KISS interface
|
||||
- query and Set Kiss hardware commands
|
||||
- support bcast rsid over kiss socket
|
||||
- selectable modem options limited to 8 bit versions only (kiss i/o mode)
|
||||
- simple HDLC encapsulation frame for transmit/receive CRC data verification.
|
||||
- histogram based threshold detection.
|
||||
- user configurable inhibit transmit on busy frequencies for nn seconds
|
||||
- imposes transmit wait on valid frame reception
|
||||
- dual UDP ports for concurrent operation of programs using the same IP address.
|
||||
- transmit buffer cleared when data is available for more then 10 mins and
|
||||
has not been transmitted.
|
||||
- AX-25 decoding.
|
||||
- user configuration item to disable CSMA from config panel and kiss
|
||||
hardware frame.
|
||||
- KISS command to adjust KPSQL detection gain (for testing).
|
||||
- new xmlrpc command 'BUSY:<T|F>'
|
||||
* Waterfall display gain adjusted based on sample rate changes.
|
||||
- added DEBUG Logging command LOG_HEX(const char *buf, int len);
|
||||
D:,... ReadFromHostSocket: ..BUSY:. C0 06 42 55 53 59 3A C0
|
||||
* MEMMAP removed old Kachina rig control code
|
||||
* RsID time out Changed secondary time out to use real time vice RsID symbols
|
||||
* Documentation change to doxygen and included in repository.
|
||||
* Virtual serial ports - added /opt/vttySn usage for Linux
|
||||
- create a linked name to a virtual port (socat) with link defined as
|
||||
/opt/vttyS0 ...
|
||||
|
||||
== Bug fixes ==
|
||||
|
||||
* too numerous to list
|
||||
|
||||
= Fldigi 3.21 release notes =
|
||||
|
||||
== Modems ==
|
||||
|
|
17
README
|
@ -34,16 +34,9 @@ resources:
|
|||
|
||||
https://fedorahosted.org/fldigi/
|
||||
|
||||
|
||||
Fldigi's BerliOS project page can be found at:
|
||||
|
||||
http://developer.berlios.de/projects/fldigi/
|
||||
|
||||
|
||||
The GIT repository can be found at:
|
||||
|
||||
http://git.berlios.de/cgi-bin/gitweb.cgi?p=fldigi;a=summary
|
||||
|
||||
https://sourceforge.net/p/fldigi/fldigi/ci/master/tree/
|
||||
|
||||
For support, news and updates, join one or more of the following mailing lists
|
||||
and Yahoo groups. Stable releases are announced to all lists and groups; test
|
||||
|
@ -63,12 +56,8 @@ and Yahoo groups. Stable releases are announced to all lists and groups; test
|
|||
|
||||
* fldigi-alpha list
|
||||
Discussion of fldigi testing and related subjects
|
||||
http://lists.berlios.de/mailman/listinfo/fldigi-alpha
|
||||
https://sourceforge.net/p/fldigi/mailman/fldigi-alpha/
|
||||
|
||||
* fldigi-devel list
|
||||
Fldigi development topics
|
||||
http://lists.berlios.de/mailman/listinfo/fldigi-devel
|
||||
|
||||
* fldigi-announce list
|
||||
Fldigi announcements
|
||||
http://lists.berlios.de/mailman/listinfo/fldigi-announce
|
||||
https://sourceforge.net/p/fldigi/mailman/fldigi-devel/
|
||||
|
|
41
configure.ac
|
@ -8,11 +8,11 @@ AC_PREREQ(2.61)
|
|||
dnl major and minor must be integers; patch may
|
||||
dnl contain other characters or be empty
|
||||
m4_define(FLDIGI_MAJOR, [3])
|
||||
m4_define(FLDIGI_MINOR, [21])
|
||||
m4_define(FLDIGI_PATCH, [.80])
|
||||
m4_define(FLDIGI_MINOR, [22])
|
||||
m4_define(FLDIGI_PATCH, [.13])
|
||||
m4_define(FLARQ_MAJOR, [4])
|
||||
m4_define(FLARQ_MINOR, [3])
|
||||
m4_define(FLARQ_PATCH, [.4])
|
||||
m4_define(FLARQ_PATCH, [.5])
|
||||
|
||||
AC_INIT([dl-fldigi], FLDIGI_MAJOR.FLDIGI_MINOR[]FLDIGI_PATCH, [fldigi-devel@lists.berlios.de])
|
||||
|
||||
|
@ -46,7 +46,7 @@ AC_CANONICAL_HOST
|
|||
# define target, target_cpu, target_vendor, target_os
|
||||
AC_CANONICAL_TARGET
|
||||
|
||||
AM_INIT_AUTOMAKE([-Wall foreign std-options 1.9.6])
|
||||
AM_INIT_AUTOMAKE([-Wall -Wno-portability foreign std-options subdir-objects 1.9.6])
|
||||
m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
|
||||
AM_MAINTAINER_MODE
|
||||
AC_CONFIG_SRCDIR([src/main.cxx])
|
||||
|
@ -54,11 +54,11 @@ AC_CONFIG_HEADER([src/config.h])
|
|||
AC_CONFIG_MACRO_DIR([m4])
|
||||
|
||||
|
||||
FLDIGI_AUTHORS="Dave Freese, Stelios Bounanos, Leigh Klotz, Remi Chateauneu, and others"
|
||||
FLARQ_AUTHORS="Dave Freese"
|
||||
FLDIGI_AUTHORS="Dave Freese, Stelios Bounanos, and others"
|
||||
FLARQ_AUTHORS="Dave Freese, Robert Stiles, and others"
|
||||
PACKAGE_HOME="http://www.w1hkj.com/Fldigi.html"
|
||||
PACKAGE_DL="http://www.w1hkj.com/download.html"
|
||||
PACKAGE_PROJ="http://developer.berlios.de/project/showfiles.php?group_id=9149"
|
||||
PACKAGE_PROJ="http://sourceforge.net/projects/fldigi/files/"
|
||||
PACKAGE_NEWBUG="https://fedorahosted.org/fldigi/newticket"
|
||||
PACKAGE_DOCS="http://www.w1hkj.com/FldigiHelp/index.html"
|
||||
PACKAGE_GUIDE="http://www.w1hkj.com/beginners.html"
|
||||
|
@ -121,7 +121,7 @@ AC_FUNC_SELECT_ARGTYPES
|
|||
AC_TYPE_SIGNAL
|
||||
AC_FUNC_STRFTIME
|
||||
AC_FUNC_STRTOD
|
||||
AC_CHECK_FUNCS([getaddrinfo gethostbyname hstrerror gmtime_r localtime_r memmove memset mkdir select setenv snprintf socket socketpair strcasecmp strcasestr strchr strdup strerror strlcpy strncasecmp strrchr strstr strtol uname unsetenv vsnprintf])
|
||||
AC_CHECK_FUNCS([getaddrinfo gethostbyname hstrerror gmtime_r localtime_r memmove memset mkdir select setenv snprintf socket socketpair strcasecmp strcasestr strchr strdup strerror strlcpy strncpy strncmp strnlen strncasecmp strrchr strstr strtol uname unsetenv vsnprintf])
|
||||
|
||||
# Check for O_CLOEXEC
|
||||
AC_FCNTL_FLAGS
|
||||
|
@ -190,24 +190,25 @@ AC_FLDIGI_TLS
|
|||
# if falling back to Boost
|
||||
AC_FLDIGI_BIND
|
||||
|
||||
### std::hash or alternatives
|
||||
# Set ac_cv_std_hash or ac_cv_std_tr1_hash to yes/no
|
||||
# Define HAVE_STD_HASH or HAVE_STD_TR1_HASH in config.h
|
||||
# Substitute BOOST_CPPFLAGS and BOOST_LDFLAGS in Makefile
|
||||
# if falling back to Boost
|
||||
AC_FLDIGI_HASH
|
||||
|
||||
### FLTK
|
||||
# Substitute FLTK_CFLAGS and FLTK_LIBS in Makefile
|
||||
# Set FLUID variable
|
||||
# Set HAVE_FLUID Makefile conditional
|
||||
AC_FLDIGI_FLTK
|
||||
|
||||
### OSS
|
||||
# Set ac_cv_oss to yes/no
|
||||
# Define USE_OSS in config.h
|
||||
AC_FLDIGI_OSS
|
||||
|
||||
### libcurl
|
||||
# check if curl is available
|
||||
if test "x$ac_cv_want_fldigi" = "xyes"; then
|
||||
AC_FLDIGI_PKG_CHECK([curl], [libcurl >= 7.10.0], [no], [no])
|
||||
fi
|
||||
|
||||
|
||||
### libpng
|
||||
# Required if $ac_cv_want_fldigi is "yes"
|
||||
# Set ac_cv_png to yes/no (not used)
|
||||
|
@ -284,6 +285,15 @@ if test "x$ac_cv_want_fldigi" = "xyes"; then
|
|||
AC_FLDIGI_PKG_CHECK([ssl], [libssl], [no], [no])
|
||||
fi
|
||||
|
||||
### libflxmlrpc
|
||||
# Set ac_cv_flxmlrpc to yes/no
|
||||
# Define USE_FLXMLRPC in config.h
|
||||
# Substitute FLXMLRPC_CFLAGS and FLXMLRPC_LIBS in Makefile
|
||||
|
||||
AC_FLDIGI_PKG_CHECK([flxmlrpc], [flxmlrpc >= 0.1.0],
|
||||
[yes], [yes], [use external flxmlrpc library @<:@autodetect@:>@],
|
||||
[ENABLE_FLXMLRPC])
|
||||
|
||||
### libintl
|
||||
# Substitute INTL_CFLAGS in Makefile
|
||||
# Substitute INTL_LIBS in Makefile
|
||||
|
@ -336,10 +346,11 @@ if test "x$ac_cv_want_fldigi" = "xyes"; then
|
|||
AC_MSG_RESULT([ fldigi build options:
|
||||
|
||||
sndfile ..................... $ac_cv_sndfile
|
||||
oss ......................... $ac_cv_oss
|
||||
portaudio ................... $ac_cv_portaudio
|
||||
pulseaudio .................. $ac_cv_pulseaudio
|
||||
|
||||
flxmlrpc .................... $ac_cv_flxmlrpc
|
||||
|
||||
hamlib ...................... $ac_cv_hamlib
|
||||
])
|
||||
fi
|
||||
|
|
|
@ -3,14 +3,13 @@
|
|||
|
||||
ASCIIDOC_CONF = asciidoc.conf
|
||||
|
||||
ASCIIDOC_SRC = dl-fldigi.1.txt dl-fldigi-shell.1.txt flarq.1.txt guide.txt
|
||||
ASCIIDOC_MAN_DIST = dl-fldigi.1 dl-fldigi-shell.1 flarq.1
|
||||
ASCIIDOC_SRC = dl-fldigi.1.txt guide.txt
|
||||
ASCIIDOC_MAN_DIST = dl-fldigi.1
|
||||
ASCIIDOC_MAN_INST =
|
||||
ASCIIDOC_HTML =
|
||||
|
||||
if WANT_FLDIGI
|
||||
ASCIIDOC_MAN_INST += dl-fldigi.1
|
||||
ASCIIDOC_MAN_INST += dl-fldigi-shell.1
|
||||
ASCIIDOC_HTML += guide.html
|
||||
endif
|
||||
|
||||
|
@ -25,7 +24,7 @@ MOSTLYCLEANFILES = *.xml
|
|||
DISTCLEANFILES = $(ASCIIDOC_HTML)
|
||||
MAINTAINERCLEANFILES = $(ASCIIDOC_MAN_INST)
|
||||
|
||||
A2X_ARGS = --format=manpage --destination-dir=$(builddir)/../doc
|
||||
A2X_ARGS = --format=manpage
|
||||
if HAVE_ASCIIDOC_NO_XMLLINT
|
||||
A2X_ARGS += --no-xmllint
|
||||
endif
|
||||
|
@ -45,12 +44,14 @@ endif
|
|||
#$(ASCIIDOC_MAN_INST): asciidoc.conf
|
||||
# a2x $(A2X_ARGS) $@.txt
|
||||
#fldigi.1: fldigi.1.txt
|
||||
#dl-fldigi-shell.1: dl-fldigi-shell.1.txt
|
||||
|
||||
# The rest of the Makefile is enabled only if we have asciidoc
|
||||
if HAVE_ASCIIDOC
|
||||
|
||||
ASCIIDOC_ICONS_DIR ?= /usr/share/asciidoc/images/icons
|
||||
# Try to discover the correct iconsdir. Use the first one that
|
||||
# contains an entry matching `tip.*'.
|
||||
ASCIIDOC_ICONS_DIRS := /etc/asciidoc/icons /etc/asciidoc/images /etc/asciidoc/images/icons /etc/asciidoc/images/../icons \
|
||||
/usr/share/asciidoc/icons /usr/share/asciidoc/images /usr/share/asciidoc/images/icons
|
||||
ASCIIDOC_ICONS_DIR ?= $(dir $(firstword $(strip $(foreach f,$(addsuffix /tip*,$(ASCIIDOC_ICONS_DIRS)),$(wildcard $(f))))))
|
||||
# Additional attributes are defined in guide.conf
|
||||
ASCIIDOC_ARGS = --unsafe -a toc -a data-uri -a badges -a icons -a iconsdir=$(ASCIIDOC_ICONS_DIR)
|
||||
|
||||
|
|
|
@ -1,151 +0,0 @@
|
|||
FLDIGI-SHELL(1)
|
||||
===============
|
||||
|
||||
|
||||
== NAME ==
|
||||
fldigi-shell - program for controlling fldigi
|
||||
|
||||
|
||||
== SYNOPSIS ==
|
||||
*fldigi-shell* ['OPTIONS'] ['FILE']
|
||||
|
||||
|
||||
== DESCRIPTION ==
|
||||
The fldigi-shell program controls +fldigi(1)+ over HTTP via XML-encoded remote
|
||||
procedure calls (XML-RPC). It can call any XML-RPC method exported by fldigi,
|
||||
and also defines some useful commands of its own.
|
||||
|
||||
|
||||
== OPTIONS ==
|
||||
*-d*::
|
||||
Enable debug output.
|
||||
|
||||
*-u* 'URL'::
|
||||
Use 'URL' to access the server. Defaults to ``http://localhost:7362/RPC2'',
|
||||
which corresponds to fldigi's default listen address and port.
|
||||
|
||||
*-c* 'COMMAND'::
|
||||
Execute command 'COMMAND' and exit.
|
||||
|
||||
|
||||
== COMMANDS ==
|
||||
[NOTE]
|
||||
================================================================================
|
||||
The ``x:yz'' notation refers to the return type and argument type(s). They are:
|
||||
``n'' (nil), ``i'' (integer), and ``s'' (string).
|
||||
================================================================================
|
||||
|
||||
debug (n:n:)::
|
||||
Toggle debug output.
|
||||
|
||||
eval (s:s)::
|
||||
Evaluate Perl code.
|
||||
|
||||
exit (n:n)::
|
||||
Exit the shell.
|
||||
|
||||
help (n:n)::
|
||||
Print help for server (fldigi) methods and shell commands.
|
||||
|
||||
history (s:n)::
|
||||
Print command history.
|
||||
|
||||
modems (s:n)::
|
||||
List all modem names.
|
||||
|
||||
poll (s:i)::
|
||||
Poll for new received text every 'i' seconds. Defaults to '1'.
|
||||
|
||||
pskrqsy (n:si)::
|
||||
QSY to 'i'^th^ best frequency for grid 's'. The list of frequencies is
|
||||
retrieved from the PSK Reporter website; see *RESOURCES*. The grid square
|
||||
string may be left empty, and the index argument defaults to '0' (first
|
||||
frequency).
|
||||
|
||||
recvtext (s:n)::
|
||||
Get all received text.
|
||||
|
||||
reinit (n:n)::
|
||||
Fetch commands from the server and rebuild command list.
|
||||
|
||||
send (n:s)::
|
||||
Send text interactively, one line at a time.
|
||||
|
||||
sendchar (n:s)::
|
||||
Send text interactively, one character at a time.
|
||||
|
||||
sendfile (n:s)::
|
||||
Send text read from file 's'.
|
||||
|
||||
sendstr (n:s)::
|
||||
Send string 's'.
|
||||
|
||||
source (n:s)::
|
||||
Read commands from file 's'.
|
||||
|
||||
time (s:s)::
|
||||
Time a command.
|
||||
|
||||
wait (n:s)::
|
||||
Wait for server TRX state to become 's'.
|
||||
|
||||
|
||||
== EXTENDED DESCRIPTION ==
|
||||
The shell has three modes of operation:
|
||||
|
||||
. Interactive mode with history, tab completion and command line editing. This
|
||||
is the default mode when fldigi-shell is run without arguments.
|
||||
|
||||
. Batch mode for a single command with the *-c* option.
|
||||
|
||||
. Batch mode to ``source'' a file containing Perl code. Fldigi-shell commands
|
||||
can be called using ``execute("COMMAND [ARG ...]")'' calls.
|
||||
|
||||
|
||||
== FILES ==
|
||||
$HOME/.fldigi/shell-history::
|
||||
Contains the fldigi-shell command history.
|
||||
|
||||
|
||||
== EXAMPLES ==
|
||||
+while :; do fldigi-shell -c pskrqsy; sleep 900; done+::
|
||||
Change to the ``best frequency'' (see PSK Reporter) every fifteen minutes.
|
||||
|
||||
|
||||
== SEE ALSO ==
|
||||
fldigi(1), xmlrpc(1), readline(3), RPC::XML(3pm)
|
||||
|
||||
|
||||
== BUGS ==
|
||||
* Some additional command wrappers are needed.
|
||||
* Command completion should be enabled for the arguments of some commands.
|
||||
* The XML-RPC handling code should probably go in a separate module.
|
||||
* It should be possible to pass multiple '-c CMD' arguments.
|
||||
|
||||
|
||||
== RESOURCES ==
|
||||
Fldigi web site: http://www.w1hkj.com/Fldigi.html
|
||||
|
||||
The PSK Automatic Propagation Reporter site can be found at
|
||||
http://www.pskreporter.info/
|
||||
|
||||
The GNU Readline Library: http://directory.fsf.org/project/readline/
|
||||
|
||||
XML-RPC home page: http://www.xmlrpc.com/
|
||||
|
||||
|
||||
== AUTHOR ==
|
||||
Fldigi-shell and this manual page were written by Stelios Bounanos, +M0GLD+
|
||||
<sb[at]enotty(dot)net>.
|
||||
|
||||
|
||||
== COPYING ==
|
||||
License GPLv2+: GNU GPL version 2 or later.
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
// Emacs settings
|
||||
// Local Variables:
|
||||
// mode: doc
|
||||
// End:
|
||||
////////////////////////////////////////////////////////////////////////////////
|
|
@ -3,7 +3,7 @@ FLDIGI(1)
|
|||
|
||||
|
||||
== NAME ==
|
||||
fldigi - digital modem program for hamradio operators
|
||||
dl-fldigi - digital modem program for hamradio operators
|
||||
|
||||
|
||||
== SYNOPSIS ==
|
||||
|
@ -420,7 +420,7 @@ AGMemberList.txt or eqsl.txt::
|
|||
+ssh -L 7362:localhost:7362 remote-host xvfb-run fldigi -display :99+::
|
||||
Start fldigi on 'remote-host' under a ``fake'' X server. (The +xvfb-run(1)+
|
||||
utility is available on Debian systems). The remote ``headless'' fldigi is
|
||||
then controlled via XML-RPC on port 7362, e.g. using +fldigi-shell(1)+.
|
||||
then controlled via XML-RPC on port 7362, i.e from flrig, flamp etc.
|
||||
|
||||
+fldigi --benchmark-input 480000 --benchmark-modem 1+::
|
||||
Benchmark the DominoEX-4 modem with 480K audio samples.
|
||||
|
|
|
@ -0,0 +1,8 @@
|
|||
#!/bin/bash
|
||||
|
||||
# Distribution clean of documents
|
||||
|
||||
rm -rf pdf/
|
||||
rm -rf compressed_html/
|
||||
rm -rf user_docs/
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 24 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 32 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 7.7 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 6.6 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 4.7 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 16 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 38 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 3.9 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 22 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 19 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 18 KiB |
|
@ -0,0 +1,276 @@
|
|||
#!/bin/bash
|
||||
#
|
||||
# A simple script for creating/archiving doxygen documentation for FLArq
|
||||
|
||||
PRG_NAME="FLArq"
|
||||
|
||||
LATEX="0"
|
||||
DOXY="0"
|
||||
BUILD_PROG_DOCS="0"
|
||||
|
||||
if [ -z $1 ]; then
|
||||
BUILD_USER_DOCS="1"
|
||||
else
|
||||
BUILD_USER_DOCS="0"
|
||||
fi
|
||||
|
||||
macintosh_file_clean()
|
||||
{
|
||||
BASE_PATH=$1
|
||||
if [ -z $BASE_PATH ]; then
|
||||
BASE_PATH="${PWD}"
|
||||
fi
|
||||
|
||||
find $BASE_PATH -name ".DS_Store" -exec rm -rf {} \;
|
||||
}
|
||||
|
||||
doc_version()
|
||||
{
|
||||
if [ ! -f $1 ]; then
|
||||
echo "Doxyfile not found ($1)"
|
||||
echo "PWD=$PWD"
|
||||
VER_NUM="UNKNOWN_VERSION"
|
||||
return
|
||||
fi
|
||||
|
||||
VER_STR=`grep -e "PROJECT_NUMBER*=*" $1`
|
||||
|
||||
if [ -z $VER_STR ]; then
|
||||
VER_NUM="UNKNOWN_VERSION"
|
||||
return
|
||||
fi
|
||||
|
||||
VER_NUM="${VER_STR#*=}"
|
||||
VER_NUM="${VER_NUM#"${VER_NUM%%[![:space:]]*}"}"
|
||||
VER_NUM="${VER_NUM%"${VER_NUM##*[![:space:]]}"}"
|
||||
}
|
||||
|
||||
help()
|
||||
{
|
||||
echo ""
|
||||
echo "Use:"
|
||||
echo " make_docs.sh <user or help>"
|
||||
echo ""
|
||||
echo "default: user"
|
||||
echo "user: Generate user documentation"
|
||||
echo "help: This message"
|
||||
echo ""
|
||||
}
|
||||
|
||||
macintosh_file_clean()
|
||||
{
|
||||
BASE_PATH=$1
|
||||
if [ -z $BASE_PATH ]; then
|
||||
BASE_PATH="${PWD}"
|
||||
fi
|
||||
|
||||
find $BASE_PATH -name .DS_Store -exec rm -rf {} \;
|
||||
}
|
||||
|
||||
rename_file()
|
||||
{
|
||||
if [ -f "$1" ]; then
|
||||
mv "$1" "$2"
|
||||
fi
|
||||
}
|
||||
|
||||
make_dir()
|
||||
{
|
||||
echo "Make Dir: $1"
|
||||
|
||||
if [ -d "$1" ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
mkdir "$1"
|
||||
}
|
||||
|
||||
function check_dir()
|
||||
{
|
||||
if [ -d "$1" ]; then
|
||||
echo "1"
|
||||
return
|
||||
fi
|
||||
|
||||
echo "0"
|
||||
}
|
||||
|
||||
function check_file()
|
||||
{
|
||||
if [ -f "$1" ]; then
|
||||
echo "1"
|
||||
return
|
||||
fi
|
||||
|
||||
echo "0"
|
||||
}
|
||||
|
||||
check_doxy()
|
||||
{
|
||||
RESULTS=$(check_file "$PWD/Doxyfile")
|
||||
|
||||
if [ "$RESULTS" = "1" ]; then
|
||||
doxygen
|
||||
else
|
||||
echo "Doxyfile not found in directory $PWD"
|
||||
fi
|
||||
}
|
||||
|
||||
check_doxy_exec()
|
||||
{
|
||||
PROG_NAME=`which doxygen`
|
||||
EXEC_FILE=`basename $PROG_NAME`
|
||||
|
||||
if [ "$EXEC_FILE" != "doxygen" ]; then
|
||||
echo "Install doxygen to build documentation"
|
||||
DOXY="0"
|
||||
else
|
||||
echo "Found $PROG_NAME"
|
||||
DOXY="1"
|
||||
fi
|
||||
}
|
||||
|
||||
check_latex_exec()
|
||||
{
|
||||
PROG_NAME=`which latex`
|
||||
EXEC_FILE=`basename $PROG_NAME`
|
||||
|
||||
if [ "$EXEC_FILE" != "latex" ]; then
|
||||
echo "Install TeX/LaTeX to build pdf documentation"
|
||||
LATEX="0"
|
||||
else
|
||||
echo "Found $PROG_NAME"
|
||||
LATEX="1"
|
||||
fi
|
||||
}
|
||||
|
||||
pdf_docs()
|
||||
{
|
||||
if [ "$LATEX" = "1" ]; then
|
||||
|
||||
OP_DIR="$1"
|
||||
|
||||
RESULTS=$(check_dir "$OP_DIR")
|
||||
|
||||
if [ "$RESULTS" = "1" ]; then
|
||||
cd $OP_DIR
|
||||
make
|
||||
rename_file "refman.pdf" "$2"
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
compress_html()
|
||||
{
|
||||
if [ -z $1 ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
if [ -z $2 ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
TAR=`which tar`
|
||||
if [ -z $TAR ]; then
|
||||
echo "***************************************"
|
||||
echo "* Compression program 'tar' not found *"
|
||||
echo "***************************************"
|
||||
return
|
||||
fi
|
||||
|
||||
SAVE_NAME="compressed_html/$1_html.tar.bz2"
|
||||
|
||||
cd ".."
|
||||
echo "CWD=${PWD}"
|
||||
COMP_DIR="$2/html/"
|
||||
|
||||
RESULTS=$(check_dir "$COMP_DIR")
|
||||
|
||||
if [ "$RESULTS" = "1" ]; then
|
||||
$TAR -cvjf "$SAVE_NAME" "$COMP_DIR"
|
||||
fi
|
||||
}
|
||||
|
||||
for var in "$@"
|
||||
do
|
||||
case "$var" in
|
||||
prog)
|
||||
BUILD_PROG_DOCS="1"
|
||||
;;
|
||||
PROG)
|
||||
BUILD_PROG_DOCS="1"
|
||||
;;
|
||||
USER)
|
||||
BUILD_USER_DOCS="1"
|
||||
;;
|
||||
user)
|
||||
BUILD_USER_DOCS="1"
|
||||
;;
|
||||
*)
|
||||
help
|
||||
exit
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
check_doxy_exec
|
||||
|
||||
if [ "$DOXY" != "1" ]; then
|
||||
echo "**************************************"
|
||||
echo "* Install Doxygen to build documents *"
|
||||
echo "**************************************"
|
||||
exit
|
||||
fi
|
||||
|
||||
check_latex_exec
|
||||
|
||||
if [ "$LATEX" != "1" ]; then
|
||||
echo "********************************************"
|
||||
echo "* Install TeX/LaTeX to build PDF documents *"
|
||||
echo "********************************************"
|
||||
fi
|
||||
|
||||
|
||||
SCRIPT_PATH="$PWD/make_docs.sh"
|
||||
|
||||
echo "Looking for Script: $SCRIPT_PATH"
|
||||
|
||||
if [ -f "$SCRIPT_PATH" ]; then
|
||||
make_dir "pdf"
|
||||
make_dir "compressed_html"
|
||||
make_dir "programmer_docs"
|
||||
make_dir "user_docs"
|
||||
|
||||
# Additional files for html link references
|
||||
make_dir "user_docs/html"
|
||||
make_dir "user_docs/html/aux"
|
||||
cp ./user_src_doc/aux/*.* ./user_docs/html/aux
|
||||
|
||||
else
|
||||
echo "***********************************************************************"
|
||||
echo "* Change Directory to the ./make_doc.sh location then execute script. *"
|
||||
echo "***********************************************************************"
|
||||
exit
|
||||
fi
|
||||
|
||||
# User Manual
|
||||
if [ $BUILD_USER_DOCS -eq "1" ]; then
|
||||
(
|
||||
cd user_src_doc
|
||||
doc_version "${PWD}/Doxyfile"
|
||||
check_doxy
|
||||
( compress_html "${PRG_NAME}_${VER_NUM}_Users_Manual" "user_docs")
|
||||
pdf_docs "../user_docs/latex" "../../pdf/${PRG_NAME}_${VER_NUM}_Users_Manual.pdf"
|
||||
)
|
||||
fi
|
||||
|
||||
# Programmers Code Reference built from FLDIGI make_docs.sh script
|
||||
#if [ $BUILD_PROG_DOCS -eq "1" ]; then
|
||||
#(
|
||||
# cd prog_src_doc
|
||||
# doc_version "${PWD}/Doxyfile"
|
||||
# check_doxy
|
||||
# ( compress_html "${PRG_NAME}_${VER_NUM}_Code_Reference" "programmer_docs" )
|
||||
# pdf_docs "../../doc/programmer_docs/latex" "../../pdf/${PRG_NAME}_${VER_NUM}_Code_Reference.pdf"
|
||||
#)
|
||||
#fi
|
|
@ -0,0 +1,51 @@
|
|||
#
|
||||
#
|
||||
#
|
||||
# Copyright (C) 2014 Robert Stiles, KK5VD.
|
||||
#
|
||||
# Permission to use, copy, modify, and distribute this software and its
|
||||
# documentation under the terms of the GNU General Public License is hereby
|
||||
# granted. No representations are made about the suitability of this software
|
||||
# for any purpose. It is provided "as is" without express or implied warranty.
|
||||
# See the GNU General Public License for more details.
|
||||
#
|
||||
# Documents produced by Doxygen are derivative works derived from the
|
||||
# input used in their production; they are not affected by this license.
|
||||
|
||||
PROJECT_NAME = "FLARQ Users Manual"
|
||||
PROJECT_NUMBER = 4.3
|
||||
PROJECT_BRIEF =
|
||||
ALLEXTERNALS = NO
|
||||
CASE_SENSE_NAMES = NO
|
||||
DISABLE_INDEX = NO
|
||||
DOXYFILE_ENCODING = UTF-8
|
||||
ENABLE_PREPROCESSING = NO
|
||||
ENABLED_SECTIONS = logo_on
|
||||
EXTRACT_ALL = NO
|
||||
EXTRA_PACKAGES = graphicx caption subcaption float
|
||||
EXTRACT_PRIVATE = NO
|
||||
FILE_PATTERNS = *.cpp *.h *.doc *.txt
|
||||
GENERATE_HTML = YES
|
||||
GENERATE_HTMLHELP = NO
|
||||
GENERATE_LATEX = YES
|
||||
GENERATE_MAN = NO
|
||||
GENERATE_RTF = NO
|
||||
GENERATE_TREEVIEW = NO
|
||||
GENERATE_XML = NO
|
||||
HTML_COLORSTYLE_SAT = 0
|
||||
HTML_FOOTER =
|
||||
HTML_HEADER =
|
||||
IMAGE_PATH = ../images
|
||||
INPUT = index.txt
|
||||
OUTPUT_DIRECTORY = ../user_docs
|
||||
OUTPUT_LANGUAGE = English
|
||||
PDF_HYPERLINKS = YES
|
||||
PERL_PATH = /usr/bin/perl
|
||||
PROJECT_LOGO = ../images/flarqlogo.png
|
||||
QUIET = NO
|
||||
RECURSIVE = NO
|
||||
SEARCHENGINE = NO
|
||||
STRIP_CODE_COMMENTS = NO
|
||||
TAGFILES =
|
||||
USE_PDFLATEX = YES
|
||||
WARNINGS = YES
|
|
@ -0,0 +1,445 @@
|
|||
/******************************************************************************
|
||||
* Copyright (C) 2014 Robert Stiles, KK5VD.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software and its
|
||||
* documentation under the terms of the GNU General Public License is hereby
|
||||
* granted. No representations are made about the suitability of this software
|
||||
* for any purpose. It is provided "as is" without express or implied warranty.
|
||||
* See the GNU General Public License for more details.
|
||||
*
|
||||
* Documents produced by Doxygen are derivative works derived from the
|
||||
* input used in their production; they are not affected by this license.
|
||||
*
|
||||
* Requires Doxygen for HTML output
|
||||
* plus LiveTeX (LaTeX) for PDF output
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
|
||||
\mainpage FLARQ Users Manual - Version 4.3
|
||||
|
||||
\tableofcontents
|
||||
|
||||
<center>
|
||||
\image latex flarqlogo.png "" width=0.5in
|
||||
\image html flarqlogo.png ""
|
||||
</center>
|
||||
|
||||
<!--FLARQ User Manual-->
|
||||
\section sFlarqDesc Transceiver Control
|
||||
|
||||
|
||||
<b>F</b>ast <b>L</b>ight <b>A</b>utomatic <b>R</b>epeat re<b>Q</b>uest is a
|
||||
file transfer application that is based on the
|
||||
<a href="aux/ARQ2.pdf">ARQ specification</a> developed by Paul Schmidt,
|
||||
K9PS. It is capable of transmitting and receiving frames of ARQ data
|
||||
via either FLDIGI or MultiPsk on Windows, or FLDIGI on Linux/Macintosh OSX.
|
||||
The interaction between FLARQ and FLDIGI requires no operator intervention.
|
||||
Program data exchange between FLARQ and FLDIGI is accomplished using a
|
||||
localhost socket interface. The socket interface requires that one program
|
||||
act as the server and the other the client. FLARQ is a client program and
|
||||
FLDIGI is a server program.
|
||||
|
||||
FLARQ will not execute unless either FLDIGI (preferred) or MultiPsk is
|
||||
already running on the host computer. If MultiPsk is used it must be set
|
||||
to the "socket" mode before executing FLARQ. If you attempt to run FLARQ
|
||||
without FLDIGI already running you will view an information window asking
|
||||
you to first start FLDIGI.
|
||||
|
||||
The ARQ transfer must take place between two systems both of which are
|
||||
running the FLARQ / FLDIGI. The ARQ specification and the source code
|
||||
for FLARQ are GPL licensed. Other developers wishing to duplicate or
|
||||
expand upon the FLARQ ARQ implementation may freely do so.
|
||||
|
||||
FLARQ can be used with the following digital modem as the transport layer:
|
||||
|
||||
BPSK all baud rates<br>
|
||||
QPSK all baud rates<br>
|
||||
MFSK all baud rates<br>
|
||||
DOMINOEX 11 or faster (do not use FEC)<br>
|
||||
THOR all baud rates, 11 or faster recommended<br>
|
||||
MT63 - all baud rates, FLARQ timing should be increased to accommodate mt63
|
||||
latency<br>
|
||||
|
||||
Please note that Olivia IS NOT compatible with FLARQ transmissions. Olivia
|
||||
does not allow the transmission of the control codes required for FLARQ.
|
||||
|
||||
The main screen dialog for FLARQ is:
|
||||
|
||||
<center>
|
||||
\image latex maindialog.png "Main Dialog" width=5.5in
|
||||
\image html maindialog.png "Main Dialog"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
ARQ data is sent in data frames which clearly delineate from whom the data
|
||||
is being sent, it's purpose or type, the actual data, and a checksum value.
|
||||
The "Beacon" button will cause the transmission of the ARQ equivalent of a
|
||||
"CQ" frame which can be easily recognized by a receiving station. Upon
|
||||
receipt of the beacon frame a monitoring FLARQ will automatically insert
|
||||
the sending stations callsign into the edit box to the right of the
|
||||
"Connect" button. The receiving station can then press the "Connect"
|
||||
button and the connect process begins.
|
||||
|
||||
<center>
|
||||
|
||||
|Diamond Color | Indicator |
|
||||
|:------------:|:-------------------------|
|
||||
| WHITE | Not Connected |
|
||||
| YELLOW | Connecting |
|
||||
| GREEN | Connected - Receiving |
|
||||
| RED | Connected - Transmitting |
|
||||
| BLACK | Timed Out |
|
||||
|
||||
</center>
|
||||
|
||||
The state of the connection also appears in plain text to the right of the
|
||||
diamond indicator.
|
||||
|
||||
Pressing the "Beacon" button sends both the text and T/R commands to the
|
||||
modem program. The beacon will repeat with a wait time between transmissions
|
||||
set by the Beacon interval in seconds on the Configure dialog. During the
|
||||
silent period between beacon transmissions the Beacon button will show the
|
||||
count down timer. You can stop the beacon at any time it is in the count
|
||||
down mode by simply pressing that button or by pressing the Abort button.
|
||||
The default beacon interval is 60 seconds. The minimum is 15 seconds and
|
||||
the maximum 300 seconds. If you find that stations are having difficulty
|
||||
connecting to your beacon call then you probably need to increase the time
|
||||
between beacons to avoid ARQ collisions similar to doubling on voice. When
|
||||
FLARQ is in the Beacon mode the words BEACON ON, and the green light on the
|
||||
Beacon button will be lit.
|
||||
|
||||
The status bar at the bottom of the main dialog contains a status text
|
||||
message area to the left and a progress bar to the right. During a file
|
||||
transfer you will be notified of actions and also see the transfer percent
|
||||
completion in the progress bar.
|
||||
|
||||
\section sConfigure Configuring FLARQ
|
||||
|
||||
|
||||
Before using FLARQ (and upon its initial execution) you will have to enter
|
||||
some configuration parameters:
|
||||
|
||||
<center>
|
||||
\image latex configdialog.png "Configure Dialog" width=5.5in
|
||||
\image html configdialog.png "Configure Dialog"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
The highlighted field, "My Call" is the only one that you must fill in to
|
||||
start using the application. The folder locations for Text/Binary Files
|
||||
and also for the Mail Client files should all be OK as preconfigured for
|
||||
the operating system in use.
|
||||
|
||||
Read through the ARQ specification for additional detail. The Exponent is
|
||||
a 2^N factor which delineates the size of the text data block that is
|
||||
transmitted in a data frame. 2^5 is 32 and should be satisfactory for
|
||||
most s/n conditions. If you are experiencing many repeats you can lower
|
||||
the Exponent value. If the path between rx and tx stations is very good
|
||||
you could increase its value. FLARQ allows the following range of values:
|
||||
|
||||
<center>
|
||||
|
||||
|Exponent | Block size |
|
||||
|:-------:|:----------:|
|
||||
| 4 | 16 |
|
||||
| 5 | 32 |
|
||||
| 6 | 64 |
|
||||
| 7 | 128 |
|
||||
| 8 | 256 |
|
||||
|
||||
</center>
|
||||
|
||||
Retries specifies how many times a repeat request should be made before
|
||||
the link is declared DOWN.
|
||||
|
||||
Wait time is the time between retries.
|
||||
|
||||
Timeout is the time period during which NO RECEPTION of frames has occured
|
||||
before the link is declared DOWN.
|
||||
|
||||
The Tx delay is the time between the end of the Rx and the beginning of the
|
||||
Tx cycle for an ARQ exchange. One-half second should be more than
|
||||
sufficient for most transceivers. You might be able to lower the value
|
||||
for your rig. Older rigs may need the value increased.
|
||||
|
||||
Beacon text - will be transmitted with each beacon transmission.
|
||||
|
||||
Sylpheed Mail Client - Sylpheed stores the message files using numeric file
|
||||
names without extension. Check this box to insure that FLARQ stores the
|
||||
files in sequential numeric order without creating duplicates. This is
|
||||
primarily for Linux users. Windows users should leave this box unchecked
|
||||
unless they are using the Sylpheed Mail Client.
|
||||
|
||||
\section sConnecting Connecting
|
||||
|
||||
The normal connection process is that the station with traffic will request
|
||||
the connecting station to send a beacon. This tests the ability of the
|
||||
connecting station to forward. The station with traffic will then be the
|
||||
one to press the Connect button. The receiving station will see the
|
||||
beacon message displayed in the FLARQ text area and also see the beacon
|
||||
stations callsign appear in the callsign box. The connecting station
|
||||
presses the connect button and after a few automatic exchanges the diamond
|
||||
indicator to the right of the callsign turns green indicating that they
|
||||
are successfully connected. A connect may take a few retries if the
|
||||
transmission path s/n is marginal. During the connect process the diamond
|
||||
indicator will be yellow.
|
||||
|
||||
After the two stations are CONNECTED either operator may effect a file
|
||||
transfer. Who goes first may be negotiated using FLDIGI in a plain text
|
||||
mode or using the FLARQ "Plain Talk" facility, once connected. The FLDIGI
|
||||
T/R functions can be used in parallel with any ARQ transmissions. It might
|
||||
be best to conclude those negotiations before establishing the ARQ
|
||||
connection.
|
||||
|
||||
Either station may initiate a DISCONNECT process.
|
||||
|
||||
This is what the outgoing beacon will look like on FLDIGI:
|
||||
|
||||
|
||||
<center>
|
||||
\image latex beacon.png "Beacon Message" width=2.7in
|
||||
\image html beacon.png "Beacon Message"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
The \<soh\> and \<eot\> are control codes that surround every ARQ frame.
|
||||
FLDIGI recognizes that it is connected to FLARQ and shows the control codes as
|
||||
ASCII named equivalents since they are not normally printable.
|
||||
|
||||
The text will appear very similar on the receiving end of the exchange.
|
||||
|
||||
\section sTransfering Transferring files
|
||||
|
||||
You may transfer several different file types:
|
||||
|
||||
<center>
|
||||
\image latex SendMenu.png "Send - File Transfer" width=2.7in
|
||||
\image html SendMenu.png "Send - File Transfer"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
<ul>
|
||||
<li>Email - created using FLARQ's composer, Outlook Express,
|
||||
Outlook, Thunderbird, Sylpheed or any other email client,
|
||||
or received via the internet and handled by the email client.</li>
|
||||
<li>Text - any ASCII file which does not contain non-printable text</li>
|
||||
<li>Image - any image file, jpeg, png, bmp, etc.</li>
|
||||
<li>Binary - any file containing arbtrary data where each byte is
|
||||
anything from 00 hex to FF hex.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
\subsection ssTransferingTIB Transfering Text, Images or Binary Files
|
||||
|
||||
If you select Text, Image or Binary file for transfer a regular file picker
|
||||
dialog is opened. You can navigate anywhere in the file system to pick a
|
||||
file. The default location for the files are unique in Windows and
|
||||
Linux/MacOSX. In Linux the default location is in $HOME/ARQsend and in
|
||||
Windows it is c:\\NBEMS\\ARQsend. Move files to that location to make
|
||||
finding the target file easy. Use the file manager or move the file using
|
||||
command line processing in a terminal window. Image and binary files will be
|
||||
converted into ASCII text files using base64 conversion. This basically is
|
||||
the same type of conversion that an email client would perform on an image or
|
||||
binary attachment. The file is encoded using base64 coding at the sending
|
||||
end and then decoded back to its original form at the receiving end.
|
||||
At the conclusion of a satisfactory ARQ transfer the two files will be
|
||||
identical, including name and size. The target directory for received
|
||||
files is $HOME/ARQrcvd in Linux, and c:\\NBEMS\\ARQrcvd in Windows. The
|
||||
receiving station opens the c:\\NBEMS\\Mail\\ARQin folder and drags the
|
||||
incoming message placed there by FLARQ over to the Outlook Express email
|
||||
client, or just double-clicks on the .eml message to open it in the default
|
||||
email client. It is the reciprocal process from that which the sending
|
||||
station uses.
|
||||
|
||||
During the transfer the sending station transmits blocks of data. Each
|
||||
block has a header, data, checksum and trailing component. The receiving
|
||||
station acknowledges which blocks have been correctly received and which
|
||||
need retransmission. Missing blocks sometimes occur in the middle of the
|
||||
set of acknowledged blocks. The text in the FLARQ text window will only
|
||||
update as contiguous blocks are available. So you might see the update
|
||||
occur in what appears to be random intervals. As the sending and receiving
|
||||
stations go from receive-to-transmit-to-receive the diamond indicator will
|
||||
toggle from green to red and back to green.
|
||||
|
||||
|
||||
\subsection ssComposingEmail Composing Email
|
||||
|
||||
FLARQ has a built-in email composer that creates files with a minimum of
|
||||
email overhead. It is a text only composer with no attachment or other
|
||||
niceties associated with a normal email client. It does produce very
|
||||
small email files which is a benefit when transmitting files over slower
|
||||
modem baud rates. Click on the "Compose" menu item. That will open the
|
||||
following dialog:
|
||||
|
||||
<center>
|
||||
\image latex composer.png "Composer" width=5.25in
|
||||
\image html composer.png "Composer"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
Enter the email address of the destination addressee, the subject and the
|
||||
email body text. Then press "Save" to save the file for later transmission.
|
||||
|
||||
You can create a template for later use and then save the template by
|
||||
pressing SHIFT while clicking on the Save button. Here is an example of a
|
||||
template in preparation:
|
||||
|
||||
<center>
|
||||
\image latex wxstatus_tpl.png "Composer WX Template" width=5.25in
|
||||
\image html wxstatus_tpl.png "Composer WX Template"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
This file will be saved as "wxstatus.tpl". FLARQ recognizes the tpl
|
||||
extension as the template file. When you later click the Template button
|
||||
the new "wxstatus.tpl" template will be available to load and use in
|
||||
creating the wx status report. After opening a template you can either
|
||||
modify it and save as a new or overwrite the existing template, or you
|
||||
can save the filled-in template as a regular file for subsequent
|
||||
transmission.
|
||||
|
||||
\subsection ssUsingEmailClient Using Email client - Outlook Express
|
||||
|
||||
You can use Outlook Express for the email client to create outgoing ARQ
|
||||
traffic. Just remember that you should create all email traffic as ASCII
|
||||
text and not HTML text to reduce the size of the message body. You are
|
||||
going to send this via an RF link and not over the internet with a high
|
||||
speed connection.
|
||||
|
||||
Create your email just as you would for transfer over the internet and
|
||||
then save it in the Drafts folder. In Outlook Express, click Create
|
||||
Email and use the format, name\@phonenumber, such as information
|
||||
\@8005551212, for the address if it is to be delivered by phone, and is
|
||||
not an email. Save each message in the Drafts folder by clicking File,
|
||||
and then Save. Exit the composition window. Open the ARQout folder
|
||||
(located at c:\\NBEMS\\Mail\\ARQout) on the desktop along with Outlook
|
||||
Express as shown below. Then drag the message from the "To ... Subject"
|
||||
area of Outlook Express and drop it on the ARQout folder. This places
|
||||
them in a folder that FLARQ can locate.
|
||||
|
||||
<center>
|
||||
\image latex OLxpress.png "Outlook Express" width=5.5in
|
||||
\image html OLxpress.png "Outlook Express"
|
||||
\image latex ARQout.png "Outlook Express EMail Files" width=4.7in
|
||||
\image html ARQout.png "Outlook Express EMail Files"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
When you select the FLARQ menu item "Send / Email" a dialog will open
|
||||
that shows the contents of the messages that are in the ARQout folder:
|
||||
|
||||
|
||||
<center>
|
||||
\image latex SelectFromARQout.png "Select Message" width=5.25in
|
||||
\image html SelectFromARQout.png "Select Message"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
|
||||
Multiple email entries would appear on separate lines with scroll bars as
|
||||
appropriate. You highlight the desired file and then press "Send" or the
|
||||
Enter key to commence the file transfer. The email may contain attachments
|
||||
(which may be images) or be just plain text. Remember that this is a
|
||||
fairly slow transfer process so small is beautiful. If the email has
|
||||
images then it will be in html and base-64 format. That adds a lot of
|
||||
overhead to the email. "Cancel" aborts the email transfer process. After
|
||||
a successful transfer from sending to receiving station the email is
|
||||
automatically moved from the ARQout to the ARQsent folder. If you are
|
||||
using Outlook Express you can open the c:\\NBEMS\\Mail\\ARQsent folder the
|
||||
same way that the ARQout folder can be opened. At the receiving end the
|
||||
email will be placed in the Sylpheed ARQin folder. Sylpheed does not
|
||||
need to be executing for this to occur at either end.
|
||||
|
||||
\subsection ssUsingEmailClientSylpheed Using Email client - Sylpheed
|
||||
|
||||
FLARQ has been optimally designed to interoperate with Sylpheed as its
|
||||
email client for emergency communications of email traffic. When you
|
||||
install Sylpheed you will be asked to choose a default directory for the
|
||||
mail store. On Linux/MacOSX this should be the default $HOME/Mail. On Windows
|
||||
you should choose c:\\NBEMS\\Mail. Three additional folders are used for
|
||||
transferring files between the FLARQ application and Sylpheed.
|
||||
These are:
|
||||
|
||||
<ul>
|
||||
<li>ARQin</li>
|
||||
<li>ARQout, and</li>
|
||||
<li>ARQsent</li>
|
||||
</ul>
|
||||
|
||||
You can create these folders from within the Sylpheed application.
|
||||
|
||||
<center>
|
||||
\image latex sylpheed-arqout.png "Sylpheed EMail Client" width=3.09in
|
||||
\image html sylpheed-arqout.png "Sylpheed EMail Client"
|
||||
</center>
|
||||
<br>
|
||||
|
||||
The above image shows the folders already in place. If they were not
|
||||
present they could be created by right clicking on the "Mailbox (MH)"
|
||||
icon and selecting "Create new folder". Name each new folder as
|
||||
specified above and shown in the image. These folders are required
|
||||
for FLARQ to be able to work with the Sylpheed email messages. Each
|
||||
message in Sylpheed is a separate file. These are usually numbered
|
||||
sequentially in each of the Sylpheed folders. FLARQ manages the correct
|
||||
sequential naming of files as they are transferred in, out and moved
|
||||
between these three folders. If you run the FLARQ application before
|
||||
Sylpheed then the c:\\NBEMS\\Mail and the c:\\NBEMS\\Mail\\ARQin, ARQout, and
|
||||
ARQsent folders will be created by that application and will appear in the
|
||||
Sylpheed folder system.
|
||||
|
||||
To create a new email traffic you press the "Compose" button. Fill out the
|
||||
email as usual and then press the "Draft" button from within the composer.
|
||||
The new message for transfer via FLARQ is now in the Drafts folder shown
|
||||
above. Open that folder by clicking on it. Select the desired draft
|
||||
message and drag and drop in onto the ARQout folder icon. That's it!
|
||||
The message is now ready for FLARQ to perform the ARQ transfer.
|
||||
|
||||
Upon completion of the transfer FLARQ will move the message to the ARQsent
|
||||
folder. Sylpheed will not immediately recognize that the change has
|
||||
occured. That is easily accomplished by either changing to another folder
|
||||
and then back again or by right clicking on the ARQout (or ARQin, or
|
||||
ARQsent) folder icon and selecting "Update summary". Sylpheed will re-read
|
||||
the folder contents and adjust it's views accordingly.
|
||||
|
||||
Incoming traffic will be placed in the ARQin folder. You may have to refresh
|
||||
the folder as described above.
|
||||
|
||||
FLARQ can find and parse the newly created email document that has been moved
|
||||
or copied to the ARQout folder. If you select to send email a picker dialog
|
||||
will appear that lists all of the out going email traffic that is contained
|
||||
in the Sylpheed ARQout folder.
|
||||
|
||||
\subsection ssOtherClients Other Email clients
|
||||
|
||||
If you use an email client other than Sylpheed or Outlook Express you can
|
||||
transfer emails as above. Just be sure that the emails have file names
|
||||
with the extension "eml" as in "mytest_message.eml".
|
||||
|
||||
|
||||
\subsection ssAbortingTX Aborting a transmission
|
||||
|
||||
The transmission may be aborted by either the sending or the receiving
|
||||
station at any time during the file transfer. When Connected and
|
||||
transferring a file, the Connect button is re-labeled <b>Abort</b>. Since
|
||||
data is sent in multiple blocks the actual abort will take place at
|
||||
the conclusion of the current group transmission. Abort will cause
|
||||
the transfer to be interrupted. The connection will be maintained
|
||||
and a new transfer can be initiated if required.
|
||||
|
||||
\section sPlainTalk Plain Talk
|
||||
|
||||
After a connection is established the two stations can exchange text using
|
||||
the "Plain Talk" entry control at the bottom of the main dialog. Enter up
|
||||
to 80 characters and then press the Enter key to transmit the text. This
|
||||
text is sent UNPROTO, which means that NO repeat request will be made. The
|
||||
block is sent without any acknowledgement from the receiving station. This
|
||||
is not an ACK/NACK system, but meant only as a way of allowing quick
|
||||
operator to operator exchanges without having to disconnect and use the
|
||||
digital modem program keyboard entry. "Plain Talk"can be interspersed
|
||||
with normal ARQ file transfer blocks.
|
||||
|
||||
\ref sFlarqDesc "Top of Page"
|
||||
*/
|
|
@ -0,0 +1,9 @@
|
|||
#!/bin/bash
|
||||
|
||||
# Distribution clean of documents
|
||||
|
||||
rm -rf pdf/
|
||||
rm -rf compressed_html/
|
||||
rm -rf user_docs/
|
||||
rm -rf prog_docs/
|
||||
|
Po Szerokość: | Wysokość: | Rozmiar: 5.2 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 1.0 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 1.0 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 5.0 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 44 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 79 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 41 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 48 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 26 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 29 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 35 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 24 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 20 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 73 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 48 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 325 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 113 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 179 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 234 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 226 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 25 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 525 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 596 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 89 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 130 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 144 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 9.5 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 4.0 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 3.1 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 180 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 29 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 18 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 76 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 33 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 63 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 152 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 6.8 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 60 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 20 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 4.6 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 57 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 20 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 68 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 14 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 14 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 15 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 13 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 313 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 17 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 5.5 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 45 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 24 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 114 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 26 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 56 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 52 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 298 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 545 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 458 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 176 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 208 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 35 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 51 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 38 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 61 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 23 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 38 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 41 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 27 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 15 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 50 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 25 KiB |
Po Szerokość: | Wysokość: | Rozmiar: 45 KiB |