FLDIGI User Manual Update

fldigi_doxygen/user_src_docs/Doxyfile

@@ -69,7 +69,7 @@ INPUT                = index.txt \
 	Wizard.txt Menus.txt ModeTable.txt CWkeying.txt  \
 	PseudoFSK.txt w5zit-interface.txt rigxml.txt commandline.txt \
 	buildinfo.txt xmlrpc-control.txt parseUALR.txt ualr-telnet.txt \
-	map.txt License.txt Recognitions.txt bpq32.txt
+	map.txt License.txt Recognitions.txt kiss_host_prgs.txt
 INCLUDE_PATH         = .
 EXAMPLE_PATH         = .
 OUTPUT_DIRECTORY     = ../user_docs

fldigi_doxygen/user_src_docs/bpq32.txt

@@ -1,41 +0,0 @@
-/**
-\page  bpq32_page Using BPQ32 with FLDIGI
-
-\tableofcontents
-
-\section sGeneralInfoBpq32 General Information, BPQ32
-
-Setting up FLDIGI to use BPQ32 require the use of the KISS I/O port.
-see \ref config_io_page page for instructions.
-
-BPQ32 is beyond the scope of this document. The following links are available
-for detailed information about the program and it's use with FLDIGI.
-
-Documentation:<br>
-<a href="http://www.cantab.net/users/john.wiseman/Documents/BPQ32%20Documents.htm">BPQ32 Documents</a>
-<br>
-and for a specific reference to FLDIGI (search for keyword FLDigi)
-<br>
-<a href="http://www.cantab.net/users/john.wiseman/Documents/BPQ32.html">BPQ32 Documents (FLDIGI)</a>
-<br>
-Installation files:<br>
-<a href="http://www.cantab.net/users/john.wiseman/Downloads/">Program and Support Data</a>
-<br>
-\par Note:
-	The Macintosh Binary located on John's website are for PowerPC systems.
-	Binaries for Intel systems are available on request by contacting
-	Robert, KK5VD kk5vd(at)yahoo(dot)com or via John's email listed below.
-
-BPQ32 is copyrighted &copy; work of John Wiseman, G8BPQ. Any inquires about
-the software can be directed to:
-
-john(dot)wiseman(at)cantab(dot)net
-
-
-<br>
-\ref bpq32_page "Return to Top of Page"
-<br>
-\ref main_page "Return to Main Page"
-
-*/
-

fldigi_doxygen/user_src_docs/configIO.txt

@@ -19,9 +19,9 @@ I/O configuration panel as seen above allows the user to select one of the IO
 interfaces.  Each of the two interface options are used for different
 purpose(s). ARQ is selected when the user requires the use of the
 FLDIGI suite of programs (FLARQ, FLMSG, FLAMP, etc). The KISS interface
-is used with Ax25/ARQ networking software.  Currently the only
-software tested and verified to work with FLDIGI's KISS interface is
-BPQ32. See \ref bpq32_page "Using BPQ32 with FLDIGI"
+is used with Ax25/ARQ networking software.  With the this interconnectivity
+multiple host programs are available to leverage this option. See
+\ref kiss_host_prgs_page "KISS Host Program(s) and FLDIGI"
 
 \par Note:
 Any changes to the IP Address and/or port numbers requires FLDIGI restart.
@@ -59,14 +59,16 @@ To select KISS I/O, mouse click on the [ ] Enable KISS check box.
 Setting and configuring IP address and ports numbers are described in the ARQ
 section.
 
-\subsubsection ssDualPort Dual Port
+\subsection ssAx25Decode Ax25 Decoding
 
-Since the data exchange protocol is based on UDP/IP (connectionless) loopback
-issues can arise if the two programs are hosted on the same machine. By
-allowing more then one port number. The loopback condition can be
-avoided.  Both programs must support dual port for proper communications.
+If the data received is using Ax25 protocol enabling this option translates
+the protocol into human readable form. Only available when KISS I/O selected.
 
-\subsubsection ssKISSCsma KISS I/O CSMA
+\par NOTE:
+	When actived, only valid ax25 data will be displayed to the receive
+	panel. No un-squelched random characters will be seen.
+
+\subsection ssKISSCsma KISS I/O CSMA
 
 Selecting this option enables Carrier Sense Multiple Access. Basically in
 conjunction with KPSQL it monitors for busy signals. When the frequency is
@@ -75,14 +77,86 @@ transmitting. This variance allows other CSMA stations time to monitor
 the frequency in an attempt to prevent/limit packet collisions. Only available
 when KISS I/O selected.
 
-\subsubsection ssAx25Decode Ax25 Decoding
+\subsection ssKISS KISS over IP
 
-If the data received is using Ax25 protocol enabling this option translates
-the protocol into human readable form. Only available when KISS I/O selected.
+FLDIGI supports KISS data tranfers over two types of IP communications.
+UDP (connectionles) and TCP (connection). Each method have is avantages
+and disavantages.  If you wish to know more about the differences performing
+a search on the internet using key words:
 
-\par NOTE:
-	When actived, only valid ax25 data will be displayed to the receive
-	panel. No un-squelched random characters will be seen.
+"TCP/IP UDP/IP"
+
+If you are a programmer a good source and free documentation on the subject
+can be found by performing a search on these keywords:
+
+"Beej's Guide to Network Programming"
+
+\subsubsection ssUDPIP Connectionless UDP/IP [UDP]
+
+Selecting UDP/IP envoks a connectionless communications path. Host software
+must support UDP/IP data transfers in order to use this option.
+
+\subsubsection ssDualPort Dual Port [DP]
+
+Used with UDP/IP communications and does not functions with TCP/IP
+connections.
+
+Since the data exchange protocol is based on UDP/IP (connectionless) a
+loopback issue can arise if the two programs are hosted on the same machine.
+By allowing more then one port number the loopback condition can be avoided.
+Host programs must support dual port for proper communications.
+
+\subsubsection ssTCPIP Connection TCP/IP [TCP]
+
+TCP connections are far more reliable then UDP since the protocol confirms data
+transfers between programs.  UDP communications on the same machine is
+generally a non issue though. It's normally an issues when distance and
+congestion comes into play as packet might timeout in the transfer process.
+TCP/IP can resend the data where UDP doesn't.
+
+Select TCP/IP if the host program supports it.
+
+\subsubsection ssLISTEN_BIND Listen/Bind
+
+When selected (checked) with TCP/IP the interface will wait/listen for TCP/IP
+connections from the host program. If unchecked the user will press the start
+button and FLDIGI will attempt to connect to the host program multiple time
+over a ten second period.
+
+If the connection fails the user should ensure the FLDIGI/host program is
+running and configured correctly.
+
+The Binding is a operating system process for a given IP address and port
+number. The binding of an address/port number can only occur once on the same
+machine no matter how many programs use the same address and port number. If
+you are getting errors as a results of binding it's possible another program
+on the same machine has bound the address/port number already. Unchecking this
+option may help in this circumstance.  Listen/Bind is required if you want
+FLDIGI to wait for connections.
+
+To start the Listening state pressing the start button is required. In the
+event the host programs disconnects FLDIGI will return to Listen state unless
+the user selects the Stop button. The Start and Stop button is the same button
+that is renamed depending the connection state.
+
+\subsubsection ssAutoConnect Auto Connect [AC]
+
+Auto connect is used to connect to the host program on start up. Configure
+KISS interface as needed then enable (check) the [x] AC option. Press the
+[Save] button at the botton of the configuration panel in order for it to
+take effect on the next restart. This is a useful option in the event of
+power failures.
+
+\subsubsection ssInhibit7bit Inhibit 7bit Modem
+
+Selecting this option will disable the warning message reported by FLDIGI
+in the event there is a change to a modem type that is not KISS IO compatible.
+The invalid modem will be ignored and FLDIGI will remain in the current valid
+modem.  Deselecting this option allows the operator to approve the modem
+change.
+
+This is an option that should be disabled when FLDIGI is used in an automated
+state as FLDIGI will wait indefinitely for a response from the operator.
 
 \subsubsection ssBusyChannel Busy Channel
 
@@ -104,7 +178,7 @@ card to audio card connection.
 KPSQL monitors for differences in the signal strength within the bandpass
 of the modem. Making it tolerant to AGC variations from the radio.
 
-\subsubsection ssModemSelection  Modem Selection Kiss I/O
+\subsection ssModemSelection  Modem Selection Kiss I/O
 
 Use of the KISS I/O places a limit on the number of available modems. These
 modems support 8 bit transfers. The slowest of these modems have been omitted
@@ -113,6 +187,8 @@ MT63 at various baud rates. Any attempt to select a modem not supported FLDIGI
 will ignore the request. If you are unsure, open the event log under the Help
 menu and note a message indicating that particular modem is not supported.
 
+See \ref ssInhibit7bit to change the behaviour of this modem check.
+
 <br>
 \image html invalid_kiss_io_modem.png "Invalid Modem for KISS I/O"
 \image latex invalid_kiss_io_modem.png "Invalid Modem for KISS I/O" width=5.5in

fldigi_doxygen/user_src_docs/index.txt

@@ -18,7 +18,7 @@
 
 /*!
 
-\mainpage FLDIGI Users Manual - Version 3.23.09
+\mainpage FLDIGI Users Manual - Version 3.23.10
 \anchor main_page
 
 <center>

fldigi_doxygen/user_src_docs/kiss_host_prgs.txt

@@ -0,0 +1,70 @@
+/**
+\page  kiss_host_prgs_page Using KISS compatible programs with FLDIGI
+
+\tableofcontents
+
+The below listed host programs make use of FLDIGI extended KISS TNC hardware
+commands. While any KISS over IP compatible program should work, only the
+following have been tested by the developers of FLDIGI.
+
+Setting up FLDIGI to use KISS require the use of the KISS I/O port.
+see \ref config_io_page page for instructions.
+
+
+\section sGeneralInfoBpq32 BPQ32
+
+BPQ32 is beyond the scope of this document. The following links are available
+for detailed information about the program and it's use with FLDIGI.
+
+Documentation:<br>
+<a href="http://www.cantab.net/users/john.wiseman/Documents/BPQ32%20Documents.htm">BPQ32 Documents</a>
+<br>
+and for a specific reference to FLDIGI (search for keyword FLDigi)
+<br>
+<a href="http://www.cantab.net/users/john.wiseman/Documents/BPQ32.html">BPQ32 Documents (FLDIGI)</a>
+<br>
+Installation files:<br>
+<a href="http://www.cantab.net/users/john.wiseman/Downloads/">Program and Support Data</a>
+<br>
+\par Note:
+	The Macintosh Binary located on John's website are for PowerPC systems.
+	Binaries for Intel systems are available on request by contacting
+	Robert, KK5VD kk5vd(at)yahoo(dot)com or via John's email listed below.
+
+Any inquires about the software can be directed to:
+
+John Wiseman, G8BPQ
+john(dot)wiseman(at)cantab(dot)net
+
+\section sGeneralInfoUIChat UIChat
+
+For those who have used FLDIGI's FSQ interface, Mitch Winkle AB4MW has created
+a Java application that mimics FSQ interface while allowing the operator to
+use any of FLDIGI 8 bit KISS compatible modems.
+
+Mitch's Blog:
+https://plus.google.com/communities/110418910579764092090
+
+Program and Source code:
+https://sourceforge.net/projects/uichat/
+
+
+\section sGeneralInfoYAAC YAAC - "Yet Another APRS Client"
+
+Andrew Pavlin, KA2DDO has created a APRS client and Internet gateway
+package. Details about this software can be found in the following links.
+
+YAAC website:
+http://www.ka2ddo.org/ka2ddo/YAAC.html
+
+YAAC source code:
+https://sourceforge.net/projects/yetanotheraprsc/
+
+
+<br>
+\ref kiss_host_prgs_page "Return to Top of Page"
+<br>
+\ref main_page "Return to Main Page"
+
+*/
+

fldigi_doxygen/user_src_docs/kiss_io_command.txt

@@ -60,6 +60,7 @@ Command                          | Use
 <b>SQLS:</b>\<0-100\>            | Set SQL Level (percent)
 <b>TRXSBCAST:</b>\<ON\|OFF\>     | Enable/disable TX/RX state change broadcast (default: OFF)
 <b>TXBEBCAST:</b>\<ON\|OFF\>     | Enable/disable TX buffer empty broadcast (default: OFF)
+<b>TXLOCK:</b>\<ON\|OFF\>        | Enable/disable TX waterfall position lock.
 <b>WFF:</b>\<integer value\>     | Move TXRX cursor to frequency on waterfall.
 
 \verbatim
@@ -105,8 +106,9 @@ Command / Return Status                                   | Use
 <b>SQLP:</b>     FLDIGI returns SQLP:\<0-100\>            | Current Symbol Quality Level (Currently Not returning valid data)
 <b>SQLS:</b>     FLDIGI returns SQLS:\<0-100\>            | Set SQL Level Query (percent)
 <b>TNC:</b>      FLDIGI returns TNC:FLDIGI \<Version Number\> | Returns the version number of FLDIGI
-<b>TRXS:</b>     FLDIGI returns TRXS:\<RX\|TX\>           | Returns the current RX/TX state of FLDIGI
+<b>TRXS:</b>     FLDIGI returns TRXS:\<RX\|TX\>           | Return the current RX/TX state of FLDIGI
 <b>TXBUF:</b>    FLDIGI returns TXBUF:\<count\>           | Return the number of byte in the transmit queue
+<b>TXLOCK:</b>   FLDIGI returns TXLOCK:\<ON\|OFF\>        | Return TX waterfall position lock state.
 <b>WFBW:</b>     FLDIGI returns WFBW:\<LOWER HZ\>,\<UPPER HZ\> | Return the active waterfall bandwidth
 <b>WFF:</b>      FLDIGI returns WFF:\<integer value\>     |  Current modem position on waterfall (center)