diff --git a/.gitignore b/.gitignore index 877df94b..f3036352 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/AUTHORS b/AUTHORS index 84a564b9..d656f4df 100644 --- a/AUTHORS +++ b/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/ diff --git a/ChangeLog b/ChangeLog index 97af7795..dd9d8f63 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,1017 +1,1109 @@ -=Version 3.21.80= +=Version 3.22.13= -2014-03-19 David Freese +2015-07-18 David Freese - d3aa1cc: FreeBSD nitems - ca39b53: Cabrillo time off - 819a3ee: Change Fl_ListBox - 6baa7d1: Restore Fl_Choice - cee5d0e: Olivia select fix - 0a7e37c: ComboBox - 36da549: fluid update + 7bdf051: FSQ bug fix + 9319676: XMLRPC commands -=Version 3.21.79= +=Version 3.22.12= - 2d189bd: RigCAT initialize - b391b02: Modem cleanup - 720f88d: Missing build script - ea4042e: Choice-->ListBox - 632d5ae: combobox-listbox - 3204698: FreeBSD One More Time - 01dffcb: RTTY normalize - 89bb26d: Sound.cxx cleanup - 4d30c67: Portaudio ring buffer - 0cff262: Headers update - 4e55345: Portaudio error reporting + 1579ef6: FSQ heard parser + f61f7d7: fsq modem + dfb9318: FreqControl focus + e477621: trx exit -2014-01-28 Kamal Mostafa - 58aeb6a: Avoid nitems fltk kfreebsd collision +=Version 3.22.11= -2014-01-13 David Freese + 7d881bf: flrig xmlrpc update - 3b9ace3: modem timing test - 1af2407: XMLRPC seg fault - 2817731: Mailing address +2015-06-07 Kamal Mostafa -2014-01-11 John Phelps + 40a6dcb: BUILD_{DATE,USER,HOST} - aad3a84: 64 bit stacktrace -2014-01-11 David Freese +=Version 3.22.10= - b778b42: Developer update - 440c65f: CW timing +2015-06-01 David Freese -=Version 3.21.78= + dfc430f: FTextView styles bug - 05e0bfc: SKED macro - 52ba259: FreeBSD issues - c0ba6f8: WF max size - 4e085ba: PSKR softbits -2013-11-09 Andrej Lajovic +=Version 3.22.09= - 0621261: CharsetDistiller - 8f5640b: UTF-8 -2013-11-08 Arvo Järve +2015-05-28 Kamal Mostafa - 3425ce0: RigCAT close - 74c6533: Save Wordwrap + dac5bf4: Fl_Text_Display -2013-11-05 David Freese +2015-04-28 David Freese - 0d1a309: ARQ timeouts - eeacf5e: Deutsch - c474790: DTMF - 1cca53a: WF latency + c34a613: Cabrillo/Export dialogs -=Version 3.21.77= +=Version 3.22.08= - 665f195: Load preferences - 7dcfc50: Waterfall race condition + 2bda963: Analysis + 967e7c5: rx/tx queues + b5aa6a3: flxmlrpc -2013-10-22 John Phelps +2015-04-16 Dave Freese - 0b8143b: MFSK HF Long Modes * Added MFSK64L and MFSL128L new modes * 6.25 Second interleaver for very-robust HF reception * Assigned new RSIDs * Mode MFSK-64L : 1026 * Mode MFSK-128L : 1029 + 28839d7: call focus -2013-10-20 David Freese +2015-04-14 David Freese - e0d91cb: Waterfall improvements + a4d4faa: 599 update + 41beca0: US units + 91ab73f: olivia cxx + a45006d: fldigi-shell + ee19668: Write log + 8d4f0ef: Config dialog -2013-10-19 Remi Chateauneu - 1e39501: Fix test_process on MacOS - fb5c891: Various speed-ups, fixes and cleanups +=Version 3.22.07= -2013-10-16 David Freese + b78b683: Macro edit + 06515a8: Multi-psk + ae560e7: Vista SignaLink driver + c79bfd7: Image update + 3c264e2: Command line + 68f88ee: SSB default signal + 5ca7182: Digiscope resize + b522d83: FSF address - d56a7f4: Cfft removal - a322875: fldigi.pot update - adc6128: Multi-channel decode - 267b914: fft filter - 1bad52f: g_fft - 9b62e1b3: WF fft - 6d79e55: rsid fft - d600d02: Wefax Config tab - 683b364: Autostart programs - bb91898: RsID Error Control - 1eaba46: Macro tag Image -2013-09-17 Kamal Mostafa +=Version 3.22.06= - 51ead20: Avoid-nitems-fltk-kfreebsd-collision.patch -2013-09-14 David Freese +2015-03-21 Robert Stiles - 8159199: MFSKpic improvements - 78d11dd: ADIF log database - dbabd63: MFSK update - 3d400ae: Thor update + fe27da9: UTF-8 Rx display +2015-03-21 David Freese -=Version 3.21.76= + 15ca512: 8psk modes + e48c2fe: Macro Editor Fonts + 2424904: R-L channel input + e5148c0: QSY documentation + f219812: Sound File Generate + 35ef2ed: devices_text mutex - e743f37: AMP end of text - e640b53: ARQ mode character set - e875d6e: RsID, Macro Queue, DTMF transmit management - e618ecf: Xmlrpc method signatures - 6e8f57a: RsID fo computation +2015-02-18 Robert Stiles + aedc628: Bug fixes/Comments + cbc9975: Check IO and delay prior to autoexec prgs + 003707f: Rename local variables -=Version 3.21.75= +2015-02-17 David Freese - 30915e4: xmlrpcpp methods - 7037ad6: RSID update - fce7654: Error exit - 263f540: fltk 1.1.x - 433ec86: Sound File + edee64a: pa names + 4ba7b78: Main dialog resize + 279115c: Rig Viewer Frame + 3eb8e41: Code merge/PortAudio Script return error + b15f5d9: Update translation files + 31e231b: Exit trx loop +2015-02-08 Robert Stiles -=Version 3.21.74= + 1155d8d: Documentation Update + 814bed3: Configure Script Engine - d17f1b1: initialize active_modem - bdbaf78: XML parser - 6fcf6bd: 64 bit compile warnings - 1a870d9: Automake bug +2015-02-08 David Freese + ad52857: Macros + fffc57c: French po + 375e98f: CW QSK Tune + 3ebf3db: flrig xml client + 423ac70: TimeOn button + 3041a20: QSY clickable -=Version 3.21.73= - 627bddc: qrunner mod - 98b61eb: Pskmail-test +=Version 3.22.05= -2013-07-24 John Phelps + 2c9b493: TX Lock + 7c95822: video ID + b93ea4e: fftfilt + ed4f49d: Port audio index + 645e7f9: CW output level + 7cc119d: Documentation + 93d2da8: MFSK squelch + 9c8d515: Rx display + b1ac562: Log fields + d67d1ab: Native file chooser + 6d11c02: ADIF temp log - 989a111: Doxygen for fldigi * Added scripts to generate Doxygen documentation from fldigi git repository / source * Also executes "cppcheck" and includes those results on Doxygen page (if installed on system) * Generates patches and log for the last 125 commits: includes links on Doxygen page -2013-07-24 David Freese +=Version 3.22.04= - 86bb08b: CPPcheck errors - 4a9724c: Modem class - 3b9dff0: Rigcat Thread - 55df4c7: Missing header - 65640ca: fldigi-shell - 59a9029: Fl::focus on OS X - edc0c9f: Data files - 6794811: KML thread - fe82181: Fl::flush - 59d9fbb: ADIF_RW thread - dfb6eaa: trx semaphore - 35e8135: Digiscope buffer + 2c3b965: xmlrpc -2013-07-07 Robert Stiles - c75ac9a: Portaudio exceptions +=Version 3.22.03= -2013-07-07 David Freese + d47ef8a: Berlios + b986d9d: CW configuration + 3ff2301: DTMF + 0a8f4a3: FFT filter + 3c7b69e: CW xmt filter - 18534e4: mxe-win32 regex - 0f5ede7: PSKMAIL/ARQ socket - e624bc0: Thor update - 07f9cb8: record_loader fix - 6e16b41: Code cleanup - 50c1c12: Pskmail Notify RsID - 4b9c578: MFSK shut down +2014-12-17 Robert Stiles -2013-06-27 Robert Stiles + 5dc3851: ARQ/KISS IO state conflict (part 2) * Ensure all state flags reflect selected mode. * Toggle IO mode in software. - af5e09a: Cwidth test for zero +2014-12-17 David Freese -2013-06-21 David Freese + fa582c9: Window title + 103c039: Xmt Audio Stream + 6947d33: RX Text + 0612ec9: OpenBSD + d344fac: LOGGER EXPORT + d5e257d: Documentation + b767b48: LOG lookup + 1359a59: Lion/Yosemite madness + e77aafe: MT63 Olivia Peak signal + 3a00dfc: HTML strings + 311925b: rtty xmt shape + 4298f2d: es nl pl files + 54917d2: WIN32 error reports - b6ee3f7: XMLRPC - 389c189: MXE compile +2014-11-15 Robert Stiles -2013-06-19 Stefan Fendt + c3e87f0: KPQSL / SQL state conflict + a488e72: Documentation Update - dfc2bd8: RTTY decoder -2013-06-09 Dennis Engdahl +=Version 3.22.02= - 7d62b22: RigCAT user commands -2013-06-08 David Freese +2014-11-11 David Freese - 3850862: TX state - 9b26ff6: pskmail events - e12a373: * Changed extended rsid iaw doc/rsid_codes.gnumeric + 18c20d7: Freq Control + 36ba341: CW + 68ba89b: PO files + 3060d42: fltk-1.3.3 compatibility + 068f030: RTTY + 75c2f79: nu rigctl area + 2e2ce97: channel width + 1fb74a1: cty.dat confusion + ac1befb: KISS log overflow + 8c49c64: New install crash + 4371ed3: EmComm 8PSK modes + bf41f90: MT63 doc + 55ff390: viewers + 91674b8: psk pskr squelch + 3dfbfba: Listbox initializers -2013-06-01 Remi Chateauneu +2014-10-29 Arvo Järve - 982f335: KML/Synop/RTTY/Navtex - 3bb70e4: Port to MXE / MingW - 34b3baf: QSL VIA - 6cd7017: XML parser + 4118783: Info Macro Tags -2013-05-31 David Freese +2014-10-27 David Freese - 2c9c73f: ARQ support changes - f8e26f3: xmlrpcpp - 237cc8f: PortAudio - dc7173c: SysV ARQ interface - 1ea46c6: METAR format - e1004fc: RSID logic + 9293e55: Analysis update + 90dd8f1: v21 v22 synch + 10cc3c5: Modem tests + da27f0b: Button colors + b16672f: Modes Menu + cba4a01: Delayed Bandwidth + 29af73c: embedded browser -=Version 3.21.72= +=Version 3.22.01= + + 263257a: RX single click + 9bbef87: Macro Buttons + b123fc1: Thumb drive + 01bc010: Power Squelch + e7de40b: Documentation update + 287e692: TxID control via xmlrpc + 880df3d: Analysis modem + +2014-10-17 John Phelps + + 91bda2b: Gray-mapped 8PSK and soft-decision - Upgraded 8psk to Gray mapped constellation - Implemented Soft-Decision decoder based on Gray constellation - Even when the received phase is distorted by +- 1 phase-position: - One of the bits is still known with 100% certianty. - Only up to 1 bit can be in error. - Increased gain for noisy/weak/HF channels + +2014-10-16 Robert Stiles + + 60c78c0: XMLRPC Character measurement issues with 8PSK modems + +2014-10-16 David Freese + + 5040224: View/Hide Smeter + d103209: CW matched filter + ea853a8: flarq update + e7d9cc4: 8PSK/16PSK modes + 6fcf11d: KISS interface + + +=Version 3.22.00= + + a798037: Remove Mixer controls + f3f8c9a: FTextDisplay + 674da9c: Freq Control + bfb001b: Touch Screen UI + d7bb247: UI macrobars + cad1c86: VSP boolean + +2014-10-06 Robert Stiles + + c4bfed9: Tabulated Widgets Font/Font Size Changes + 80dc81b: Documentation + +2014-10-06 David Freese + + 1dd39cc: PACKAGE_PROJ + 98cd7af: Win32 warnings + 93b76d4: UI tweaks + ec3177b: Hide Packet Modem + 9f2b358: Record loader + bbce20e: Delta macro + 38d9bab: MEMMAP + 3ef0433: WF drop rate + 7448535: RsID time out + 03ef903: Wizard crash fix + +2014-10-06 Stelios Bounanos + + d7fe297: Fix log format string warnings + 382452a: Build system fixes + +2014-10-06 David Freese + + 4ad7967: Default font + 632eb8a: Power meter + 1bf6f49: Smeter + 73cdc07: regex.c fix + eb3eb25: fft-scan + 5176ffb: home directory + 830a1cb: Analysis modem + 38d1589: TRX limit check + a0f43c9: Win32 Socket::close + cf16c3a: SITORB tx issue + +2014-08-29 Robert Stiles + + 67a744b: Doxygen Inclusion + +2014-08-29 David Freese + + 82aeba5: ARQ stx handshake + 4503c99: Virtual ports + d40998f: New User Exit Behavior + 7d683d3: hash-fix + a94a13b: RnA Analysis + a1c3f7a: Phase accumulator + 947ebc9: Base Directories + 913bb52: WF Height/Speed + f272e83: RX Only + 515b54f: RTTY mem leak + 65af716: Olivia/Contestia custom + 4cc2ee5: ARQ abort + a64d623: RTTY Custom Shift + 1ae5143: Spotter seg fault + 129afe6: TX monitor + 13e1cd5: Audio selectors for PORTAUDIO + 9e555aa: M4 tr1 detect + bb91c8a: ttyACMxx identification + 5ee22c8: Olivia critical section + 5004516: MT63 critical section + 0a79e20: Logbook fields + f294b58: Hamlib selector + 0fd3cc4: Combobox Add to List + 2efdf5c: RTTY macro + 0421813: clang compatibility + ea5bcb9: FreeBSD nitems + da7a43a: Cabrillo time off + df3c010: Change Fl_ListBox + eaafc91: Restore Fl_Choice + 9a7dfe5: Olivia select fix + 4bbf427: fluid update + 04808d2: ComboBox + c056cc8: RigCAT initialize + 37bd0d2: Modem cleanup + e5fed09: Missing build script + 6762423: Choice-->ListBox + 8fef9bb: combobox-listbox + 481be5c: FreeBSD One More Time + 309988d: RTTY normalize + bd42895: Sound.cxx cleanup + 2add988: Portaudio ring buffer + d244947: Headers update + c9f6df0: Portaudio error reporting + +2014-01-31 Kamal Mostafa + + 8a1d12f: Avoid nitems fltk kfreebsd collision + +2014-01-31 David Freese + + 5f7d521: XMLRPC seg fault + 5754566: Mailing address + +2014-01-31 John Phelps + + a1d20d5: 64 bit stacktrace + +2014-01-31 David Freese + + 86bffb9: Developer update + 678f66b: modem timing test + 2ca21dd: CW timing + 1bcc31c: SKED macro + 92ab4b6: FreeBSD issues + a987fe5: PSKR softbits + 50018ff: WF max size + 4cbabee: packet update + f967edf: Waterfall correction + +2013-11-16 Arvo Järve + + 1f77efb: RigCAT close + +2013-11-16 Andrej Lajovic + + d903090: CharsetDistiller + ab0a464: UTF-8 + +2013-11-16 Arvo Järve + + 80b0902: Save Wordwrap + +2013-11-16 David Freese + + 6313bf7: ARQ timeouts + 37affbc: Deutsch + 42ccd2a: fldigi.pot update + e4398da: DTMF + affa919: WF latency + 07652b1: Load preferences + +2013-10-29 John Phelps + + 45fc679: MFSK HF Long Modes * Added MFSK64L and MFSL128L new modes * 6.25 Second interleaver for very-robust HF reception * Assigned new RSIDs * Mode MFSK-64L : 1026 * Mode MFSK-128L : 1029 + +2013-10-29 David Freese + + f7ea783: Waterfall race condition + 35a6486: Waterfall improvements + +2013-10-29 Remi Chateauneu + + fc8abd4: Fix test_process on MacOS + e52626b: Various speed-ups, fixes and cleanups - a933da1: RsID Timeout - ff1d69a: PSKMAIL - 531c40c: Colors/Fonts Dialog - 8be3913: Developer List +2013-10-19 David Freese + 200db3b: Multi-channel decode + 1a89352: Cfft removal + 5c9f5a2: fft filter + 59b16c4: rsid fft + da36c7b: WF fft + b8f4242: g_fft + 1afceb0: Autostart programs -=Version 3.21.71= +2013-09-22 Kamal Mostafa - d9e2c6f: About update - 603e6a7: Wavefile generate - 4c7ffd7: MT63 mode selection - bae6d2c: ARQ server + 7515787: Avoid-nitems-fltk-kfreebsd-collision.patch -2013-04-30 Remi Chateauneu +2013-09-22 David Freese - 9750f38: xmlrpc-c removal + 2112e85: RsID Error Control + 863375d: Macro tag Image + f5215cb: MFSKpic improvements + 06424bd: ADIF log database + 5c1ee46: MFSK update + 0e1e201: Thor update + 87f110b: AMP end of text + 5b8dae6: ARQ mode character set + 97ffdb0: RsID, Macro Queue, DTMF transmit management + 13120c8: Xmlrpc method signatures + 034bc3e: RsID fo computation + a038411: xmlrpcpp methods + fa9de70: Error exit + 262053b: RSID update + 108ffd4: Sound File + d5f460c: fltk 1.1.x + d73fc93: initialize active_modem + a5f657d: CW Farnsworth + 9ea6687: XML parser + 2cb46f4: 64 bit compile warnings + 1774707: Automake bug + 5972d94: qrunner mod + 706df57: Pskmail-test + 42b2b3f: Rigcat Thread -2013-04-30 David Freese +2013-08-02 John Phelps - a2624eb: Signal Browser Colors - 0bc251a: QRZ query - 816aea5: Rigsupport - 54708a2: PO file update - 6b28784: eQSL url - acd5297: PSKMAIL + 39e8532: Doxygen for fldigi * Added scripts to generate Doxygen documentation from fldigi git repository / source * Also executes "cppcheck" and includes those results on Doxygen page (if installed on system) * Generates patches and log for the last 125 commits: includes links on Doxygen page +2013-08-02 David Freese -=Version 3.21.70= + ba3dad0: CPPcheck errors + 6e66d2c: Modem class + 607a696: Missing header + a4a1ee7: fldigi-shell + d9de4b6: Fl::focus on OS X + 5394ffb: KML thread + a6f8acc: Data files + eb287d6: Fl::flush + d3e0feb: ADIF_RW thread + 1a9a42d: trx semaphore + bb7ce32: Digiscope buffer - ab4e0f2: Contestia/Olivia - 45be148: Tabs Colors +2013-08-02 Robert Stiles -2013-04-13 Arvo Järve + 957a1b4: Portaudio exceptions - 89e1df1: Double Click bug fix +2013-08-02 David Freese -2013-04-12 David Freese + f13f26c: mxe-win32 regex + 1ff3a7f: Thor update + b66a887: record_loader fix - efce800: RTTY update - e2b050e: Fltk backward compatibility - 27e753e: Compiler warning fix +2013-08-02 Remi Chateauneu -2013-04-11 Kamal Mostafa + 2b9f6af: KML/Synop/RTTY/Navtex - 5f770be: Fix glob_t usage +2013-08-02 David Freese -2013-04-11 David Freese + 32b0543: PSKMAIL/ARQ socket + 9bde2c6: Code cleanup + 04bcbf9: Pskmail Notify RsID + 1e77d1e: MFSK shut down - 1e94067: Spotting - fc68397: ADIF case +2013-08-02 Robert Stiles + f9267b9: Cwidth test for zero -=Version 3.21.69= +2013-08-02 David Freese - 524864e: QSO NBR/NXT macro tag - 303681e: TX lower case - 69bab69: WX parser - 6e5a68d: Signal Browser - 2ecbeca: Compiler Warnings - 5134b81: Free BSD mods - f794566: flstring - 92ede71: RTTY filters - 6e9a943: Serial by-id - 5a2c244: RTTY tx symbol shaper - 093796f: Misc NBEMS mods + f3863c4: Packet timeops + 3661031: MXE compile + 3777182: XMLRPC -2013-02-28 Arvo Järve +2013-08-02 Stefan Fendt - b088667: CRC16 and ANSII char set + b5f77b6: RTTY decoder -2013-02-27 David Freese +2013-08-02 Dennis Engdahl - c586219: High Speed Playback - 0a9823d: RTTY config tab + 24b9c70: RigCAT user commands -2013-02-11 Arvo Järve ES1JA +2013-08-02 David Freese - cd2fdd7: * Added BAND macro tag + 96b8a49: TX state + 009b118: pskmail events + aca2b0b: * Changed extended rsid iaw doc/rsid_codes.gnumeric + +2013-08-02 Remi Chateauneu -2013-02-09 David Freese + 2886b9f: Port to MXE / MingW + 833f561: QSL VIA + 633674c: XML parser - 64f04d8: Dbl Click for Xchg In - a7f42b9: Status Reports +2013-08-02 David Freese -2013-02-09 Remi Chateauneu + 1b9f1d0: ARQ support changes + fd56e10: xmlrpcpp + 5a92877: PortAudio + 5539f2c: SysV ARQ interface + 9a63e0a: RsID + 8b84443: METAR format + 2140c90: RSID logic + ffcdeb1: PSKMAIL + b03bde8: RsID Timeout + 9e259e6: Colors/Fonts Dialog + 5b184a0: Developer List + 4adb556: About update + c836420: ARQ server + 4729da1: Wavefile generate + ac83021: MT63 mode selection - 5d6d921: RTTY tx code +2013-05-20 Remi Chateauneu -2013-02-09 David Freese + c648263: xmlrpc-c removal - 163f1f6: RTTY no LF +2013-05-20 David Freese + 6131426: Signal Browser Colors + 97c2c19: QRZ query + 7bad521: Rigsupport + 0ac9199: eQSL url + cc11225: PSKMAIL + 799444f: Contestia/Olivia + 848481b: Tabs Colors -=Version 3.21.68= +2013-05-20 Arvo Järve + fe31558: Double Click bug fix -2013-02-08 Remi Chateauneu +2013-05-20 David Freese - efe6687: RTTY bug fix + 9dd563a: RTTY update + fe1e10a: Fltk backward compatibility + b168ea7: Compiler warning fix -2013-02-07 David Freese +2013-05-20 Kamal Mostafa - 2a6bfee: RTTY filters - 48dcf51: Hang on start - 72dd5f2: Analysis - 55b76e9: rigMEM - be3dd1f: WF only ESC abort + 3fcac6e: Fix glob_t usage -2013-02-03 John Phelps +2013-05-20 David Freese - 4a8e3ca: WF only null pointer fix + 417ce51: RTTY filters + d6fc193: RTTY tx symbol shaper + c5c4b11: Spotting + 8fb7b80: ADIF case + b7dcd87: QSO NBR/NXT macro tag + 2c5f422: TX lower case + 3d33980: WX parser + f636509: Signal Browser + af77a52: Compiler Warnings + ab422bb: Free BSD mods + 3ed4099: Serial by-id + 860444b: Misc NBEMS mods -2013-02-02 David Freese +2013-05-19 Arvo Järve - 48ed1f0: RTTY config tab - f684b91: RTTY stop bits + 8c55811: CRC16 and ANSII char set +2013-05-19 David Freese -=Version 3.21.67= - - 645acab: PSK viewer - 63323a4: Contest fields - f3abd4c: RigCAT INIT/CLOSE - 4af6dcd: Olivia FEC reset - 0d4d55d: RTTY FSK modem - b8fd4db: Status / Tx Level Controls - - -=Version 3.21.66= - - 305fa6d: Thor reset - d2dea40: File Selector - f83a413: Macros - d12f7da: CW modem - 282886b: User configurable items - - -=Version 3.21.65= - - 7680b05: High Speed / Multi-Carrier Modems - - -=Version 3.21.64= - + 75a8e09: High Speed Playback + 9d791d2: flstring + 793c1cb: RTTY config tab + 63b4eb3: RTTY stop bits + 4dc9bc9: RTTY FSK modem + 1444a63: PSK viewer + 65c53fb: Contest fields + dc65247: RigCAT INIT/CLOSE + 5a24121: Olivia FEC reset + 4ad148b: Status / Tx Level Controls + 6642866: Macros + 6063b56: File Selector + dc6b084: CW modem + 14329e5: High Speed / Multi-Carrier Modems + ce1d5c2: User configurable items 2012-12-26 Makoto Fujiwara - 0322dc9: NetBSD compile error + 2a22c31: NetBSD compile error 2012-12-15 David Freese - 05b3ad0: Dup Cty lookup - b02da36: Get RX buffer - d52579b: Capture Alt-F4 + 6fe5fee: Dup Cty lookup + 2a3d1ae: Get RX buffer + 2004343: Util.h mod + 1884f2f: Capture Alt-F4 + 2719b0f: Macros LOG LNW EXEC +2012-12-03 Remi Chateauneu -=Version 3.21.63= + 836c5c3: Progress widget - 972865e: Macros LOG LNW EXEC - 01ef002: ARQ Socket - 261b7fb: Default char set - 614a542: NBEMS.DIR - cb820ae: RTTY CR-CR-LF - de390ac: Control-V/Z +2012-11-25 David Freese - -=Version 3.21.62= - - fec0ead: Pause-break - 2ca1bf7: WF-only-escape - 326a75d: REPEAT Macro - 44e6ae6: MT63 Long - - -=Version 3.21.61= - - -2012-11-08 Dave Freese (none) - - c7f2918: ARQ server - -2012-11-04 David Freese - - e388b7b: DistCheck cleanup - - -=Version 3.21.60= - - a239363: FLTK-1.1.x - 7bd9355: Libtiniconv + 2252cab: ARQ Socket + 5b9e09f: NBEMS modes + cb82ed8: Escape aborts 2012-10-31 John Phelps - 13fa1a0: Allow xmit of EOT character - - -=Version 3.21.59= - + 51db482: Allow xmit of EOT character 2012-10-29 Andrej Lajovic - 0c1f371: UTF-8 overhaul + 87afa66: UTF-8 overhaul 2012-10-26 David Freese - 1d6469f: Thumbdrive - - -=Version 3.21.58= - - 6875022: Escape aborts - - -=Version 3.21.57= - - d925c85: Escape aborts clean start - 0366447: TLF arq - d85631b: Logbook Dialogs - - -=Version 3.21.56= - - 320fc54: ARQ rx/tx - - -=Version 3.21.55= - - 06e5ed5: View browser - 1390d0b: FLAMP interface fix - - -=Version 3.21.54= - + 600db9e: Thumbdrive + 0fa9396: TLF arq + 5ac5065: Logbook Dialogs + c17590e: ARQ rx/tx + 9006fde: View browser + 2a0f09d: FLAMP interface fix 2012-10-04 Andrej Lajovic - 1abb9b9: UTF-8 wide characters - 1b8cccd: flarq bug fix - bad1660: Add_tx_char + 7bdf035: UTF-8 wide characters + 6706da0: flarq bug fix + 1d7f8c2: Add_tx_char +2012-10-03 David Freese -=Version 3.21.53= - + d43f564: UI update + caac757: Code merge fixes 2012-10-02 Kamal Mostafa - 199978a: Fix crash if no OSS mixer support + e203c4e: Fix crash if no OSS mixer support 2012-10-02 David Freese - a698359: Logbook Call width + 1880cfe: Logbook Call width 2012-09-29 Andrej Lajovic - a8a148f: Log file update - 946bbb8: UTF-8 char echo - bab4a53: Hamlib sideband menu + 2a391bc: Log file update + 3e0dac7: UTF-8 char echo + e84c5ce: Hamlib sideband menu +2012-09-11 David Freese -=Version 3.21.52= - - -2012-09-21 David Freese - - f8a6e1c: ASCII table correction - - -=Version 3.21.51= - - 638a3c2: flmsg/flamp stream processing - 8a41aad: DominoEX varicode - de95906: WRAP binary files + 14346a7: flmsg/flamp stream processing + 1bfdfee: flmsg cmd line params + 6142046: DominoEX varicode + d02f714: WRAP binary files 2012-08-31 Andrej Lajovic - 8fdb2ca: Backspaces patch + e6ee942: Backspaces patch 2012-08-31 Daniel F1RMB - 8d38260: UI enhancements + 6d6c7b3: UI enhancements 2012-08-31 David Freese - 29c9c6a: Combo update - a30ad34: Extract timeout - 7286512: ASCII tables - e765c4e: Socket send on Linux + 4cb619d: Combo update + ad43c73: Extract timeout + 22ad2be: ASCII tables + 4cf9425: Socket send on Linux 2012-08-07 Kamal Mostafa - 8ab2f6e: fix spelling error + db78661: fix spelling error 2012-08-04 David Freese - 2f7de4d: Logbook dialog initial size - - -=Version 3.21.50= - - 5b175c1: RsID Multiple + 57801e9: Logbook dialog initial size + ede0fd8: RsID Multiple 2012-08-02 David J Vanecek - eeaa755: Open BSD fixes + 9025bea: Open BSD fixes 2012-07-12 David Freese - e212c36: Restore post signal rsid + 07d5d89: Restore post signal rsid 2012-07-08 Kamal Mostafa - f45a09b: Tango icon: Restore missing weather_clear_icon - - -=Version 3.21.49= - + dae167e: Tango icon: Restore missing weather_clear_icon 2012-07-07 David Freese - ba1ec30: RTTY metric - 77bb7a1: Logbook Colors-Fonts - f2c18cb: RX Text backspace - - -=Version 3.21.48= - - e94e2f2: HAMQTH Session ID + b36a5e8: RTTY metric + 143cb1c: Logbook Colors-Fonts + 9f5250f: RX Text backspace + 55c0372: HAMQTH Session ID 2012-06-29 Kamal Mostafa - b8eb04c: Tango icon pixmaps update to version 0.8.90 (public domain) + 24b8bcc: Tango icon pixmaps update to version 0.8.90 (public domain) +2012-06-28 David Freese -=Version 3.21.47= - - -2012-06-29 David Freese - - e4a180a: RTTY ASCII - - -=Version 3.21.46= - - ce90378: CW Farnsworth - ae08433: Merge log records + 47b5bf6: Merge log records 2012-06-26 Leonardo - 0ddb867: Wavefile playback + ff063eb: Wavefile playback +2012-06-14 David Freese -=Version 3.21.45= - - -2012-06-16 David Freese - - 817f299: ANTENNA macro tag - a3f236a: fltk-1.1.10 compatibility - 91ac4a9: APPLE about - - -=Version 3.21.44= - - 39cad15: Polish translation - 25fcf8d: file-chooser - 990492b: Main Panel Controls Colors-Fonts - bdacdd8: HamQTH - cdc22d6: WEFAX/NAVTEX config - c3162ed: Log Entries - cb392e4: Fork open file descriptors - -2012-05-31 Remi Chateauneu - - a28eb60: WEFAX update - -2012-05-31 David Freese - - 81a9f43: Logbook Update - ed638a5: Navtex - - -=Version 3.21.43= - - -2012-05-30 Kamal Mostafa - - 39998f7: Fix TX text clear after macro - -2012-05-28 David Freese - - c7f11f4: CW decoder update - 0c113b6: Rigio thread + 0dbf248: Polish translation + 91cdbe4: file-chooser + b7200d6: HamQTH + 909f3fa: Main Panel Controls Colors-Fonts + 6280de9: WEFAX/NAVTEX config + 9b3dabd: Fork open file descriptors + e9587fe: Logbook Update + 686e8b5: Wefax/Navtex + f47119c: CW decoder update + ff25bae: Rigio thread + 52f27c8: WEFAX mingw32 fixes 2012-05-10 Remi Chateauneu - 967cc68: sfft speedup + a3435a7: sfft speedup +2012-05-08 John Phelps -=Version 3.21.42= + 93e0a1b: DominoEX-THOR mods +2012-05-03 Remi Chateauneu -2012-04-08 David Freese + 350f83e: Viterbi and filter speed-up. + 4200036: Wefax - 1089250: Auto file directory - 8bdd45e: Cmd line help - ccc4d5d: FreqControl paste - fc870d5: Base directory - e298249: psk comments +2012-04-06 David Freese + 7041a5e: FreqControl paste + ede22f5: Base directory + 5c71fdf: Check for updates + cd04cad: Notch indicator color + ca5ff49: ARQ Parse Mode + c3f315b: Path separator + a7169ea: Debug changes + 39edf75: Clear sent text + 1abbedf: Control-Z fault + 0d3265f: Notch + 7f2cfbe: EXEC macro -=Version 3.21.41= +2012-03-02 Remi Chateauneu - 1779db5: Check for updates - 0d2e7c3: Notch indicator color - 970b00d: ARQ Parse Mode - d4e5caa: Path separator - d7dfbdb: Debug changes - 80d67e3: Clear sent text - 815d27a: Control-Z fault - bd14450: Notch - d1defa3: EXEC macro + e2eb292: Wefax fixes, AFC, speedup. +2012-03-02 David Freese -=Version 3.21.40= + 23e315b: Save Macro - Windows + 331ff2e: About copyright date + c9df726: MFSK pic dnd + 4a0833e: Merge record logic error - 3318229: Save Macro - Windows - 2dc3120: About copyright date +2012-02-19 Remi Chateauneu + 490058b: Wefax bin images + debugging. -=Version 3.21.39= +2012-02-15 David Freese - 29ccdeb: Win7 Open Logbook - 74da509: MFSK pic dnd - c2998df: Merge record logic error - 24c470e: OSX Lion shutdown - b7ff115: Cyrillic-UTF8 chars - bf8046d: QSK test - 1364186: Weather report + d2d254e: Weather report +2012-02-13 Remi Chateauneu -=Version 3.21.38= + ccee94d: Wefax AFC. - 9327490: Control sizing - df3bf09: eQSL - 13b7107: OS X file chooser - 5122c7b: Control key parsing - 3c0bcd8: Control-shortcuts - b940e9c: WX international +2012-02-12 David Freese + eae67ba: OSX Lion shutdown + dedc82a: OSX Lion shutdown + b609cb6: Config Dialog -=Version 3.21.37= +2012-02-08 Remi Chateauneu - c4336b7: Macro filename - ba5b5d5: Callsign query - 2af9ebc: WX Celsius - 62d9f42: Weather tag - 3fc748e: Inline tags - 3ae8ee9: OS-X native file chooser + 548f941: Navtex AFC * Automatic Frequency Control. * Now the input frequency can be changed. +2012-02-06 David Freese -=Version 3.21.36= + 0d287c6: Cyrillic-UTF8 chars - 5cc14a1: rigcat serial test - 4c0526a: Macro load display - 5cbed0c: File-dir selection - 59e8dc9: Rx text wrap - 2dfd6fd: UTF-8 rx suppress - c36983e: Get WX - 22e1f8b: Update to fltk.m4 - 890013c: rigCAT closure - 56104f4: GCC-4.7 fixes - e7ab7e2: Missing files - 3b02bb3: RX last line - 6e81738: Debug text - 0f87d87: View browser find control - b6a8332: Rx text wrap - f1abc9e: Find chars fwd/back - 6102e0c: Corner controls - 2281325: Fltk-1.3.0 - 847fdd3: Rig cat close - 672f4ee: OpBrowser font - 5f8b712: Tune abort +2012-02-05 Remi Chateauneu + 268d0f3: Wefax AFC and GUI -=Version 3.21.35= +2012-02-05 David Freese + fbca133: QSK test +2012-02-01 Remi Chateauneu -=Version 3.21.34= + f2268b8: Navtex enhancements. - a70c0fe: VAC PTT delay - 62532af: Mono audio - a7f741b: VSP boolean +2012-02-01 David Freese + 7c60aa8: Weather report + e78677c: Control sizing + 9d12f24: eQSL + 9882ad4: OS X file chooser + 9df3370: WX international + 46e4468: Macro filename + 4a7468f: Callsign query + afc9487: WX Celsius + 60bac3c: Weather tag + 56fb067: Inline tags + 4187215: OS-X native file chooser + 48998ff: rigcat serial test + 19d9b1a: Macro load display + 03c289c: File-dir selection + e0d4f89: Rx text wrap + dc190c4: UTF-8 rx suppress + 92f313d: Get WX -=Version 3.21.33= +2012-01-18 Remi Chateauneu - a68d917: Right Channel audio - 00d4308: WEFAX update - 96188fa: WARN status colors + 25b4499: WEFAX windows show/hide bug fix. +2012-01-18 Pavel Milanes Costa -=Version 3.21.32= + 16856e0: es.po update - 422c0b1: Italian po file update +2012-01-17 David Freese + + dd1416d: Update to fltk.m4 + 7a0ffda: GCC-4.7 fixes + +2012-01-15 Remi Chateauneu + + 2989baf: WEFAX : Noise reduction, less disk space. + +2012-01-13 David Freese + + bcc5e9f: Missing files + f8d7da3: RX last line + e3d80a6: Debug text + b3e675c: View browser find control + 419a236: Find chars fwd/back + 444eb6b: Corner controls + +2012-01-08 Remi Chateauneu + + 6b7067e: Wefax b/w fix + +2012-01-08 David Freese + + 23b9a17: Fltk-1.3.0 + +2012-01-06 Remi Chateauneu + + ae36352: Wefax GUI enhancement. + +2012-01-06 David Freese + + e1c991f: Rig cat close + 14d24d6: OpBrowser font + fd60201: Tune abort + faff489: VAC PTT delay + ca82dac: Mono audio + 9409d6c: NAVTEX check-TESTS + +2011-12-11 Remi Chateauneu + + acd15ca: Navtex code cleanup and warnings. + cf895e9: Added Navtex deviation in waterfall. + +2011-12-09 David Freese + + 773c413: Right Channel audio + 8d54e28: NAVTEX modem + 0c064c6: WEFAX update + 87cc9d4: WARN status colors 2011-12-03 Remi Chateauneu - e7d5ccf: Modem class update - 38112d8: QsoRec comparisons + ee1ab43: Modem class update + 8d647fc: QsoRec comparisons 2011-12-02 David Freese - e707094: Cty.dat - 6821e78: Contestia 64/1000 - ff596a0: Call lookups - - -=Version 3.21.31= - - dcbae1e: Spanish translation file - 136bcc2: Compile warnings - 7beb7c1: ver2int - 8a7c4bf: Main thread hang - 2f2fe0a: UI changes - - -=Version 3.21.30= - - 30951fb: Merge dups - ee4c5b4: Logbook dirty boolean - 2335f76: Tx Attenuator Control - dfe3a7b: HamQTH app ident - - -=Version 3.21.29= - - b97bbde: eQSL QTH nickname - 2edfc77: Merge Logs - 9de5095: ADIF i/o tweaks - 77e1eb1: Call lookup - - -=Version 3.21.28= - - ed74b9b: ADIF/EQSL thread shutdown - d3e47a3: Ignore slash postamble - 9100837: Log Export by date - f6888ee: ADIF file integrity test - - -=Version 3.21.27= - - a2184aa: Log r/w improvements + 6ac3b34: Cty.dat + 0c2b4fc: Contestia 64/1000 + 3dd38d1: Call lookups + 0263d0a: Compile warnings + ce6c399: ver2int + 14fb480: UI changes + b968647: Main thread hang + f575215: Merge dups + 4dd27c2: Logbook dirty boolean + ac9c15b: Tx Attenuator Control + 25036db: HamQTH app ident + 6d4326d: eQSL QTH nickname + 972cba1: Merge Logs update + 7d95b7b: Merge Logs + fe62681: ADIF i/o tweaks + e0bf128: Call lookup + 9eca86a: ADIF/EQSL thread shutdown + 7b04a17: Ignore slash postamble + f50c79f: Log Export by date + 48f71f1: ADIF integrity check + d35ed7d: Logbook menu + c297198: Log r/w + 3e970b9: ADIF write_log 2011-11-15 Remi Chateauneu - b3a89c7: WEFAX error logging fix + 4103a07: WEFAX error logging fix 2011-11-15 David Freese - 9269c9a: Restore Log Sort - - -=Version 3.21.26= - - ee27d64: eQSL update - - -=Version 3.21.25= - - 50fa414: guard lock + ff34b3c: Restore Log Sort + 4aca1f1: eQSL update + 389ce71: eQSL thread 2011-11-12 Remi Chateauneu - 8baf07b: Wefax enhancements. - 11d699e: Use Logbook record + dab85dc: Wefax enhancements. + 21bcc18: Use Logbook record 2011-11-12 David Freese - c2ba559: eQSL + 7f30f29: eQSL + 2dae98d: eQSL + b0e37af: Exec macro + 3288d8d: QRZ on-line lookup + bf88127: HamQTH update + 15ff024: HamQTH + b5e788e: Auto-send + 2d1d484: RSID defaults + db2803d: NBEMS-FLMSG Directories + 9fd70bc: Resize fault + bcdc9cf: RSID limit fault + ece4fb7: DTMF debug + 0b041f6: Multi QSY bug fix + cb5ddcd: Multi QSY + f63a77a: Common QSY + 8630feb: Revert qsy patch + 6bc6fc8: HamQTH lookup + f96fb25: Packet debug + cf3bed3: REV macro tag + 39ebd8b: RTTY bandwidth + 5c0da52: MFSK soft decode +2011-10-06 Remi Chateauneu -=Version 3.21.24= + 7542ae9: Multi-QSY - 16fc289: Exec macro - 0859928: QRZ on-line lookup +2011-10-06 David Freese + ee1747d: MACRO code cleanup + 153e1e8: + ddab268: ... + 0388d6a: !Queue reset + fdf5fe0: Timer delay + 3df6c3a: Olivia tone/bw choices + e3e2703: Macro Edit + 58c1bd8: Macro Editor + 6b39f52: WWV xmt mode + 1c8cfca: Scheduled Macro + ca4c595: RTTY baud + bf7ff41: CW/RTTY init fault + 75aa9a8: NULL modem + 502e62e: - 047543a: HamQTH - 2ffb4a5: Auto-send + 7b2ecb6: PACKET long blobs +2011-09-09 David Freese -=Version 3.21.22= + 1f6398e: Delayed macro timing + 9a26985: Log Server lookup + 6a03241: Delayed Tags +2011-09-06 Chris Sylvain -2011-10-28 Pavel Milanes Costa + 31bfb98: PACKET max level - b66a4d7: es.po update +2011-09-05 David Freese -2011-10-28 David Freese - - 269ae3a: RSID defaults - 1b3e852: NBEMS-FLMSG Directories - - -=Version 3.21.21= - - 3163fd2: Resize fault - - -=Version 3.21.20= - - fba599c: RSID limit fault - c32fa63: DTMF debug - - -=Version 3.21.19= - - 7046d49: HamQTH lookup - - -=Version 3.21.18= - - 1247488: REV macro tag - 9c13f6f: RTTY bandwidth - - -=Version 3.21.17= - - 4ac5f6b: MFSK soft decode - 07baee2: MACRO code cleanup - 4d13cb4: ... - - -=Version 3.21.16= - - 3e554f8: !Queue reset - 8ac0558: Timer delay - - -=Version 3.21.15= - - d0e1c5f: Log Menu Items - cebc292: Macro Editor - 960e580: WWV xmt mode - bb258cd: Inline macro tags - d2c33e4: RTTY baud - ab472e0: CW/RTTY init fault - 5a9607a: Control-Z bug fix - c565815: CW QSK - 405816e: Log Server lookup - -2011-09-04 Remi Chateauneu - - e0ee3a9: Added wefax::adjust_metric method. - 261275e: modem::display_metric now sets the member modem::m - - -=Version 3.21.14= - - -2011-09-03 David Freese - - 166fe59: DTMF decoder - 49e2dd2: CW Prosign defaults + 563d667: Inline macro tags + 7184fb8: DTMF decoder + d6eae02: CW Prosign defaults 2011-08-30 Remi Chateauneu - ff18562: Macros code cleanup + 3f08ee9: Macros code cleanup 2011-08-30 David Freese - 74364ee: DTMF class - 5af9f3a: DTMF encoder - 39fe31b: Wide Cursor Tracks + ff3b0b2: DTMF class + 3113c68: DTMF encoder +2011-08-16 Chris Sylvain -=Version 3.21.13= + 4942a0b: Packet audio boost +2011-08-14 David Freese -2011-08-07 Pavel Milanes Costa + 8826d4f: Wide Cursor Tracks + 4f0acd0: Log resort add record + fd8d86f: New Macro Tags + 4478165: RTTY MARK coloring + 60947aa: RTTY MARK frequency + 381b809: QSY macros - 5f3c3da: Update to Spanish translation +2011-07-13 Remi Chateauneu -2011-08-07 David Freese + f9a459a: Added wefax::adjust_metric method. + 1da9ed1: modem::display_metric now sets the member modem::m - 75de2ce: New Macro Tags - 5e50597: RTTY MARK coloring - 836c082: RTTY MARK frequency - ab822e7: QSY macros +2011-07-10 David Freese + 07c12e0: TX Attenuator -=Version 3.21.12= +2011-06-29 Pierfrancesco Caci - f92dbf5: XMLRPC linking error + 12714eb: CW Offset optional + +2011-06-29 David Freese + + c2d0b93: Pkt compile warnings + +2011-06-29 Remi Chateauneu + + dc9edc1: WEFAX compiler warnings + 406a5ea: Wefax improvements + 732f12d: Wefax fixes + cfbfe22: Added XML-RPC functions for Wefax + +2011-06-27 David Freese + + f77b48a: XMLRPC linking error 2011-06-26 Pierfrancesco Caci - df89c3c: Swap mode/frequency change from frequency list + eda79c4: Swap mode/frequency change from frequency list -2011-06-17 David Freese +2011-06-18 David Freese - a741be8: Logbook client for fllog server - 3c14dc7: Logbook County + b0c6941: XLOG save with xmllog + 13819f5: Logbook server + 360eedb: Logbook client + 27b16f2: Logbook County 2011-06-11 Kamal Mostafa - 4e192b5: Mode_info table restrictions - -2011-06-08 David Freese - - 24ce84e: TX Attenuator - d634026: View-Hide menu item - - -=Version 3.21.11= - + 6e0cd5f: Mode_info table restrictions 2011-06-06 Pierfrancesco Caci - 97bbddf: K3 CW-QSY + af057a4: K3 CW-QSY -2011-05-29 David Freese +2011-06-06 David Freese - 4633907: LOG.ADIF export + 6440654: TX attenuator + 2b89e69: LOG.ADIF export + ec6104e: Duplicate #defines +2011-05-23 Kamal Mostafa -=Version 3.21.10= + 8c066af: GNU/Hurd build fix +2011-05-23 David Freese -2011-05-14 Pavel Milanes Costa + ff3e162: Spot-notifier - bc7c0cf: PO files update +2011-05-23 John Phelps, KL4YFD -2011-05-14 Kamal Mostafa + ab1602b: High baud rate Dom/Thor - e000ac1: Conf dialog cosmetics +2011-05-23 Chris Sylvain -2011-05-04 David Freese + 4931d1d: Packet Modem - dca7182: Duplicate defines +2011-03-23 David Freese -2011-04-19 Kamal Mostafa - - 50febcc: GNU/Hurd build fix - - -=Version 3.21.9= - - -2011-04-17 David Freese - - 625c8f9: Spot-notifier - fd48d9a: Olivia tone/bw choices - - -=Version 3.21.8= - - c3aacd3: Config defaults - 3fb1a42: No rig mode selection - - -=Version 3.21.7= - - c200173: wo save status - - -=Version 3.21.6= - - -2011-03-18 Pavel Milanes Costa - - a4ba568: es.po update - -2011-03-18 David Freese - - 3d4ea9c: flmsg auto start - - -=Version 3.21.5= - - e7a403a: Wrap File reception - 29c6fc0: EXEC win32 macro tag + b74102f: Config defaults + 485a633: No rig mode selection + f6bb403: wo save status + e04d5f6: flmsg auto start + 91d9385: Wrap File reception + c054ee6: EXEC win32 macro tag 2011-03-06 Stelios Bounanos - 3114075: Fix socket/getaddrinfo support + e987c66: Fix socket/getaddrinfo support =Version 3.21.4= @@ -2151,7 +2243,7 @@ 2009-02-25 Stelios Bounanos - a2fc0c8db: Add better support for proportional fonts + a2fc0c8: Add better support for proportional fonts f6466f2: Fix font name/number compatibility code eb1ec8a: Fix printf format string diff --git a/INSTALL b/INSTALL index 76fd4bf6..ea277eeb 100644 --- a/INSTALL +++ b/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: diff --git a/NEWS b/NEWS index ac7513a7..54e08d86 100644 --- a/NEWS +++ b/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 + - my antenna + - current operating band + * New modem tests based on a specified number of 5 letter code groups + - + - + * increment/decrement xcvr carrier + * 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:' + * 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 == diff --git a/README b/README index abe06de5..a2269923 100644 --- a/README +++ b/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/ diff --git a/configure.ac b/configure.ac index ca013497..dc93a934 100644 --- a/configure.ac +++ b/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 diff --git a/doc/Makefile.am b/doc/Makefile.am index 3124135a..0ebc37d8 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -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) diff --git a/doc/dl-fldigi-shell.1.txt b/doc/dl-fldigi-shell.1.txt deleted file mode 100644 index e9d42ab7..00000000 --- a/doc/dl-fldigi-shell.1.txt +++ /dev/null @@ -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+ -. - - -== COPYING == -License GPLv2+: GNU GPL version 2 or later. - - -//////////////////////////////////////////////////////////////////////////////// -// Emacs settings -// Local Variables: -// mode: doc -// End: -//////////////////////////////////////////////////////////////////////////////// diff --git a/doc/dl-fldigi.1.txt b/doc/dl-fldigi.1.txt index 00fa5ce0..feeac6f6 100644 --- a/doc/dl-fldigi.1.txt +++ b/doc/dl-fldigi.1.txt @@ -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. diff --git a/flarq_doxygen/distclean.sh b/flarq_doxygen/distclean.sh new file mode 100755 index 00000000..710f4243 --- /dev/null +++ b/flarq_doxygen/distclean.sh @@ -0,0 +1,8 @@ +#!/bin/bash + +# Distribution clean of documents + +rm -rf pdf/ +rm -rf compressed_html/ +rm -rf user_docs/ + diff --git a/flarq_doxygen/images/ARQout.png b/flarq_doxygen/images/ARQout.png new file mode 100644 index 00000000..a4e7f986 Binary files /dev/null and b/flarq_doxygen/images/ARQout.png differ diff --git a/flarq_doxygen/images/OLxpress.png b/flarq_doxygen/images/OLxpress.png new file mode 100644 index 00000000..e6171f85 Binary files /dev/null and b/flarq_doxygen/images/OLxpress.png differ diff --git a/flarq_doxygen/images/SelectFromARQout.png b/flarq_doxygen/images/SelectFromARQout.png new file mode 100644 index 00000000..0566bce7 Binary files /dev/null and b/flarq_doxygen/images/SelectFromARQout.png differ diff --git a/flarq_doxygen/images/SendMenu.png b/flarq_doxygen/images/SendMenu.png new file mode 100644 index 00000000..dace2671 Binary files /dev/null and b/flarq_doxygen/images/SendMenu.png differ diff --git a/flarq_doxygen/images/beacon.png b/flarq_doxygen/images/beacon.png new file mode 100644 index 00000000..09e3b79d Binary files /dev/null and b/flarq_doxygen/images/beacon.png differ diff --git a/flarq_doxygen/images/composer.png b/flarq_doxygen/images/composer.png new file mode 100644 index 00000000..0273b595 Binary files /dev/null and b/flarq_doxygen/images/composer.png differ diff --git a/flarq_doxygen/images/configdialog.png b/flarq_doxygen/images/configdialog.png new file mode 100644 index 00000000..c88ba58e Binary files /dev/null and b/flarq_doxygen/images/configdialog.png differ diff --git a/flarq_doxygen/images/flarqlogo.png b/flarq_doxygen/images/flarqlogo.png new file mode 100644 index 00000000..479f103c Binary files /dev/null and b/flarq_doxygen/images/flarqlogo.png differ diff --git a/flarq_doxygen/images/maindialog.png b/flarq_doxygen/images/maindialog.png new file mode 100644 index 00000000..b82940f0 Binary files /dev/null and b/flarq_doxygen/images/maindialog.png differ diff --git a/flarq_doxygen/images/sylpheed-arqout.png b/flarq_doxygen/images/sylpheed-arqout.png new file mode 100644 index 00000000..3a4f0606 Binary files /dev/null and b/flarq_doxygen/images/sylpheed-arqout.png differ diff --git a/flarq_doxygen/images/wxstatus_tpl.png b/flarq_doxygen/images/wxstatus_tpl.png new file mode 100644 index 00000000..1505a063 Binary files /dev/null and b/flarq_doxygen/images/wxstatus_tpl.png differ diff --git a/flarq_doxygen/make_docs.sh b/flarq_doxygen/make_docs.sh new file mode 100755 index 00000000..a43389dc --- /dev/null +++ b/flarq_doxygen/make_docs.sh @@ -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 " + 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 diff --git a/flarq_doxygen/user_src_doc/Doxyfile b/flarq_doxygen/user_src_doc/Doxyfile new file mode 100644 index 00000000..0ed47121 --- /dev/null +++ b/flarq_doxygen/user_src_doc/Doxyfile @@ -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 diff --git a/flarq_doxygen/user_src_doc/aux/ARQ2.pdf b/flarq_doxygen/user_src_doc/aux/ARQ2.pdf new file mode 100644 index 00000000..5267f7a7 Binary files /dev/null and b/flarq_doxygen/user_src_doc/aux/ARQ2.pdf differ diff --git a/flarq_doxygen/user_src_doc/index.txt b/flarq_doxygen/user_src_doc/index.txt new file mode 100644 index 00000000..699dee1e --- /dev/null +++ b/flarq_doxygen/user_src_doc/index.txt @@ -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 + +
+\image latex flarqlogo.png "" width=0.5in +\image html flarqlogo.png "" +
+ + +\section sFlarqDesc Transceiver Control + + +Fast Light Automatic Repeat reQuest is a +file transfer application that is based on the +ARQ specification 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
+QPSK all baud rates
+MFSK all baud rates
+DOMINOEX 11 or faster (do not use FEC)
+THOR all baud rates, 11 or faster recommended
+MT63 - all baud rates, FLARQ timing should be increased to accommodate mt63 +latency
+ +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: + +
+\image latex maindialog.png "Main Dialog" width=5.5in +\image html maindialog.png "Main Dialog" +
+
+ +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. + +
+ +|Diamond Color | Indicator | +|:------------:|:-------------------------| +| WHITE | Not Connected | +| YELLOW | Connecting | +| GREEN | Connected - Receiving | +| RED | Connected - Transmitting | +| BLACK | Timed Out | + +
+ +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: + +
+\image latex configdialog.png "Configure Dialog" width=5.5in +\image html configdialog.png "Configure Dialog" +
+
+ +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: + +
+ +|Exponent | Block size | +|:-------:|:----------:| +| 4 | 16 | +| 5 | 32 | +| 6 | 64 | +| 7 | 128 | +| 8 | 256 | + +
+ +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: + + +
+\image latex beacon.png "Beacon Message" width=2.7in +\image html beacon.png "Beacon Message" +
+
+ +The \ and \ 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: + +
+\image latex SendMenu.png "Send - File Transfer" width=2.7in +\image html SendMenu.png "Send - File Transfer" +
+
+ +
    +
  • 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.
    • +
  • Text - any ASCII file which does not contain non-printable text
    • +
  • Image - any image file, jpeg, png, bmp, etc.
    • +
  • Binary - any file containing arbtrary data where each byte is + anything from 00 hex to FF hex.
    • +
+ + +\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: + +
+\image latex composer.png "Composer" width=5.25in +\image html composer.png "Composer" +
+
+ +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: + +
+\image latex wxstatus_tpl.png "Composer WX Template" width=5.25in +\image html wxstatus_tpl.png "Composer WX Template" +
+
+ +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. + +
+\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" +
+
+ +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: + + +
+\image latex SelectFromARQout.png "Select Message" width=5.25in +\image html SelectFromARQout.png "Select Message" +
+
+ + +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: + +
    +
  • ARQin
    • +
  • ARQout, and
    • +
  • ARQsent
    • +
+ +You can create these folders from within the Sylpheed application. + +
+\image latex sylpheed-arqout.png "Sylpheed EMail Client" width=3.09in +\image html sylpheed-arqout.png "Sylpheed EMail Client" +
+
+ +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 Abort. 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" +*/ diff --git a/fldigi_doxygen/distclean.sh b/fldigi_doxygen/distclean.sh new file mode 100755 index 00000000..af335ba6 --- /dev/null +++ b/fldigi_doxygen/distclean.sh @@ -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/ + diff --git a/fldigi_doxygen/images/8psk500f-pilot.png b/fldigi_doxygen/images/8psk500f-pilot.png new file mode 100644 index 00000000..3944fc77 Binary files /dev/null and b/fldigi_doxygen/images/8psk500f-pilot.png differ diff --git a/fldigi_doxygen/images/8psk500f-spectrum-pilot.png b/fldigi_doxygen/images/8psk500f-spectrum-pilot.png new file mode 100644 index 00000000..ca42c99e Binary files /dev/null and b/fldigi_doxygen/images/8psk500f-spectrum-pilot.png differ diff --git a/fldigi_doxygen/images/8psk500f-spectrum.png b/fldigi_doxygen/images/8psk500f-spectrum.png new file mode 100644 index 00000000..f935eb70 Binary files /dev/null and b/fldigi_doxygen/images/8psk500f-spectrum.png differ diff --git a/fldigi_doxygen/images/8psk500f.png b/fldigi_doxygen/images/8psk500f.png new file mode 100644 index 00000000..94565dae Binary files /dev/null and b/fldigi_doxygen/images/8psk500f.png differ diff --git a/fldigi_doxygen/images/CWkeyingCircuit.png b/fldigi_doxygen/images/CWkeyingCircuit.png new file mode 100644 index 00000000..ce4c52b1 Binary files /dev/null and b/fldigi_doxygen/images/CWkeyingCircuit.png differ diff --git a/fldigi_doxygen/images/CabrilloSetup.png b/fldigi_doxygen/images/CabrilloSetup.png new file mode 100644 index 00000000..7ad9224a Binary files /dev/null and b/fldigi_doxygen/images/CabrilloSetup.png differ diff --git a/fldigi_doxygen/images/ColorsFonts-buttons.png b/fldigi_doxygen/images/ColorsFonts-buttons.png new file mode 100644 index 00000000..7be852c6 Binary files /dev/null and b/fldigi_doxygen/images/ColorsFonts-buttons.png differ diff --git a/fldigi_doxygen/images/ColorsFonts-dsp.png b/fldigi_doxygen/images/ColorsFonts-dsp.png new file mode 100644 index 00000000..91ffe4ea Binary files /dev/null and b/fldigi_doxygen/images/ColorsFonts-dsp.png differ diff --git a/fldigi_doxygen/images/ColorsFonts-fkeys.png b/fldigi_doxygen/images/ColorsFonts-fkeys.png new file mode 100644 index 00000000..fd1a1fa8 Binary files /dev/null and b/fldigi_doxygen/images/ColorsFonts-fkeys.png differ diff --git a/fldigi_doxygen/images/ColorsFonts-log.png b/fldigi_doxygen/images/ColorsFonts-log.png new file mode 100644 index 00000000..6ddc4e57 Binary files /dev/null and b/fldigi_doxygen/images/ColorsFonts-log.png differ diff --git a/fldigi_doxygen/images/ColorsFonts-rxtx.png b/fldigi_doxygen/images/ColorsFonts-rxtx.png new file mode 100644 index 00000000..74afe8ab Binary files /dev/null and b/fldigi_doxygen/images/ColorsFonts-rxtx.png differ diff --git a/fldigi_doxygen/images/ColorsFonts-siglvl.png b/fldigi_doxygen/images/ColorsFonts-siglvl.png new file mode 100644 index 00000000..b3d8bb0b Binary files /dev/null and b/fldigi_doxygen/images/ColorsFonts-siglvl.png differ diff --git a/fldigi_doxygen/images/ColorsFonts-tabs.png b/fldigi_doxygen/images/ColorsFonts-tabs.png new file mode 100644 index 00000000..d38f1f7b Binary files /dev/null and b/fldigi_doxygen/images/ColorsFonts-tabs.png differ diff --git a/fldigi_doxygen/images/DXCC_list.png b/fldigi_doxygen/images/DXCC_list.png new file mode 100644 index 00000000..1b018d5a Binary files /dev/null and b/fldigi_doxygen/images/DXCC_list.png differ diff --git a/fldigi_doxygen/images/DataFilesSources.png b/fldigi_doxygen/images/DataFilesSources.png new file mode 100644 index 00000000..553cb65d Binary files /dev/null and b/fldigi_doxygen/images/DataFilesSources.png differ diff --git a/fldigi_doxygen/images/Dual-fldigi.png b/fldigi_doxygen/images/Dual-fldigi.png new file mode 100644 index 00000000..11f2bfc5 Binary files /dev/null and b/fldigi_doxygen/images/Dual-fldigi.png differ diff --git a/fldigi_doxygen/images/ExportSetup.png b/fldigi_doxygen/images/ExportSetup.png new file mode 100644 index 00000000..5e449a77 Binary files /dev/null and b/fldigi_doxygen/images/ExportSetup.png differ diff --git a/fldigi_doxygen/images/FLDigiWindow.png b/fldigi_doxygen/images/FLDigiWindow.png new file mode 100644 index 00000000..7272fb71 Binary files /dev/null and b/fldigi_doxygen/images/FLDigiWindow.png differ diff --git a/fldigi_doxygen/images/FLDigiWindowHtml.png b/fldigi_doxygen/images/FLDigiWindowHtml.png new file mode 100644 index 00000000..d94845f7 Binary files /dev/null and b/fldigi_doxygen/images/FLDigiWindowHtml.png differ diff --git a/fldigi_doxygen/images/FindReception.png b/fldigi_doxygen/images/FindReception.png new file mode 100644 index 00000000..18897d7d Binary files /dev/null and b/fldigi_doxygen/images/FindReception.png differ diff --git a/fldigi_doxygen/images/FreqAnal.png b/fldigi_doxygen/images/FreqAnal.png new file mode 100644 index 00000000..dccbc058 Binary files /dev/null and b/fldigi_doxygen/images/FreqAnal.png differ diff --git a/fldigi_doxygen/images/Google-Maps-Kml.png b/fldigi_doxygen/images/Google-Maps-Kml.png new file mode 100644 index 00000000..696f8ebb Binary files /dev/null and b/fldigi_doxygen/images/Google-Maps-Kml.png differ diff --git a/fldigi_doxygen/images/GoogleEarth.png b/fldigi_doxygen/images/GoogleEarth.png new file mode 100644 index 00000000..31ed5921 Binary files /dev/null and b/fldigi_doxygen/images/GoogleEarth.png differ diff --git a/fldigi_doxygen/images/Icom_FSK.png b/fldigi_doxygen/images/Icom_FSK.png new file mode 100644 index 00000000..e3c67b6e Binary files /dev/null and b/fldigi_doxygen/images/Icom_FSK.png differ diff --git a/fldigi_doxygen/images/KML-Config.png b/fldigi_doxygen/images/KML-Config.png new file mode 100644 index 00000000..11a50ade Binary files /dev/null and b/fldigi_doxygen/images/KML-Config.png differ diff --git a/fldigi_doxygen/images/KML-Directory.png b/fldigi_doxygen/images/KML-Directory.png new file mode 100644 index 00000000..defcaad4 Binary files /dev/null and b/fldigi_doxygen/images/KML-Directory.png differ diff --git a/fldigi_doxygen/images/KML-Logo.png b/fldigi_doxygen/images/KML-Logo.png new file mode 100644 index 00000000..0783749d Binary files /dev/null and b/fldigi_doxygen/images/KML-Logo.png differ diff --git a/fldigi_doxygen/images/Level-Indicator.png b/fldigi_doxygen/images/Level-Indicator.png new file mode 100644 index 00000000..ac25a864 Binary files /dev/null and b/fldigi_doxygen/images/Level-Indicator.png differ diff --git a/fldigi_doxygen/images/MultiChannelBPSKOScope.png b/fldigi_doxygen/images/MultiChannelBPSKOScope.png new file mode 100644 index 00000000..0df2c64f Binary files /dev/null and b/fldigi_doxygen/images/MultiChannelBPSKOScope.png differ diff --git a/fldigi_doxygen/images/MultiChannelBPSKWaterfall.png b/fldigi_doxygen/images/MultiChannelBPSKWaterfall.png new file mode 100644 index 00000000..6dcab9b6 Binary files /dev/null and b/fldigi_doxygen/images/MultiChannelBPSKWaterfall.png differ diff --git a/fldigi_doxygen/images/Navtex-Choosing-Stations-File.png b/fldigi_doxygen/images/Navtex-Choosing-Stations-File.png new file mode 100644 index 00000000..815ab399 Binary files /dev/null and b/fldigi_doxygen/images/Navtex-Choosing-Stations-File.png differ diff --git a/fldigi_doxygen/images/Navtex-Choosing.png b/fldigi_doxygen/images/Navtex-Choosing.png new file mode 100644 index 00000000..54057fdf Binary files /dev/null and b/fldigi_doxygen/images/Navtex-Choosing.png differ diff --git a/fldigi_doxygen/images/Navtex-Config-Tab-With-Kml.png b/fldigi_doxygen/images/Navtex-Config-Tab-With-Kml.png new file mode 100644 index 00000000..16d8b3f5 Binary files /dev/null and b/fldigi_doxygen/images/Navtex-Config-Tab-With-Kml.png differ diff --git a/fldigi_doxygen/images/Navtex-Configuration.png b/fldigi_doxygen/images/Navtex-Configuration.png new file mode 100644 index 00000000..d72f05cd Binary files /dev/null and b/fldigi_doxygen/images/Navtex-Configuration.png differ diff --git a/fldigi_doxygen/images/Navtex-Logged-Contacts.png b/fldigi_doxygen/images/Navtex-Logged-Contacts.png new file mode 100644 index 00000000..a9366837 Binary files /dev/null and b/fldigi_doxygen/images/Navtex-Logged-Contacts.png differ diff --git a/fldigi_doxygen/images/Navtex-Reception.png b/fldigi_doxygen/images/Navtex-Reception.png new file mode 100644 index 00000000..3b769a25 Binary files /dev/null and b/fldigi_doxygen/images/Navtex-Reception.png differ diff --git a/fldigi_doxygen/images/Notification-Events.png b/fldigi_doxygen/images/Notification-Events.png new file mode 100644 index 00000000..7714bd21 Binary files /dev/null and b/fldigi_doxygen/images/Notification-Events.png differ diff --git a/fldigi_doxygen/images/Notifications.png b/fldigi_doxygen/images/Notifications.png new file mode 100644 index 00000000..cb876d21 Binary files /dev/null and b/fldigi_doxygen/images/Notifications.png differ diff --git a/fldigi_doxygen/images/Notifier-popup.png b/fldigi_doxygen/images/Notifier-popup.png new file mode 100644 index 00000000..fb97b269 Binary files /dev/null and b/fldigi_doxygen/images/Notifier-popup.png differ diff --git a/fldigi_doxygen/images/Notifier-rxtext.png b/fldigi_doxygen/images/Notifier-rxtext.png new file mode 100644 index 00000000..06ba1d09 Binary files /dev/null and b/fldigi_doxygen/images/Notifier-rxtext.png differ diff --git a/fldigi_doxygen/images/Olivia32-1000.png b/fldigi_doxygen/images/Olivia32-1000.png new file mode 100644 index 00000000..0661ec5f Binary files /dev/null and b/fldigi_doxygen/images/Olivia32-1000.png differ diff --git a/fldigi_doxygen/images/Opening-DataFiles-Menu.png b/fldigi_doxygen/images/Opening-DataFiles-Menu.png new file mode 100644 index 00000000..daf60d81 Binary files /dev/null and b/fldigi_doxygen/images/Opening-DataFiles-Menu.png differ diff --git a/fldigi_doxygen/images/RTTY-Config-Tab-With-Synop.png b/fldigi_doxygen/images/RTTY-Config-Tab-With-Synop.png new file mode 100644 index 00000000..563c2dc8 Binary files /dev/null and b/fldigi_doxygen/images/RTTY-Config-Tab-With-Synop.png differ diff --git a/fldigi_doxygen/images/RTTY-demodulator.png b/fldigi_doxygen/images/RTTY-demodulator.png new file mode 100644 index 00000000..25698f15 Binary files /dev/null and b/fldigi_doxygen/images/RTTY-demodulator.png differ diff --git a/fldigi_doxygen/images/RWM+25361ppm.png b/fldigi_doxygen/images/RWM+25361ppm.png new file mode 100644 index 00000000..edb13c70 Binary files /dev/null and b/fldigi_doxygen/images/RWM+25361ppm.png differ diff --git a/fldigi_doxygen/images/RWMpost-cal-x5.png b/fldigi_doxygen/images/RWMpost-cal-x5.png new file mode 100644 index 00000000..e9917807 Binary files /dev/null and b/fldigi_doxygen/images/RWMpost-cal-x5.png differ diff --git a/fldigi_doxygen/images/RWMpre-cal.png b/fldigi_doxygen/images/RWMpre-cal.png new file mode 100644 index 00000000..c6d02d60 Binary files /dev/null and b/fldigi_doxygen/images/RWMpre-cal.png differ diff --git a/fldigi_doxygen/images/Reception.png b/fldigi_doxygen/images/Reception.png new file mode 100644 index 00000000..8a95217f Binary files /dev/null and b/fldigi_doxygen/images/Reception.png differ diff --git a/fldigi_doxygen/images/SavedWAVFileSampleRate.png b/fldigi_doxygen/images/SavedWAVFileSampleRate.png new file mode 100644 index 00000000..100929dc Binary files /dev/null and b/fldigi_doxygen/images/SavedWAVFileSampleRate.png differ diff --git a/fldigi_doxygen/images/TX-level.png b/fldigi_doxygen/images/TX-level.png new file mode 100644 index 00000000..6f4b5cba Binary files /dev/null and b/fldigi_doxygen/images/TX-level.png differ diff --git a/fldigi_doxygen/images/Thor-1.png b/fldigi_doxygen/images/Thor-1.png new file mode 100644 index 00000000..31649b5b Binary files /dev/null and b/fldigi_doxygen/images/Thor-1.png differ diff --git a/fldigi_doxygen/images/Transmit_A.png b/fldigi_doxygen/images/Transmit_A.png new file mode 100644 index 00000000..06d80fbb Binary files /dev/null and b/fldigi_doxygen/images/Transmit_A.png differ diff --git a/fldigi_doxygen/images/UI-minimized.png b/fldigi_doxygen/images/UI-minimized.png new file mode 100644 index 00000000..17bc6066 Binary files /dev/null and b/fldigi_doxygen/images/UI-minimized.png differ diff --git a/fldigi_doxygen/images/UTF8-Example.png b/fldigi_doxygen/images/UTF8-Example.png new file mode 100644 index 00000000..77a1527b Binary files /dev/null and b/fldigi_doxygen/images/UTF8-Example.png differ diff --git a/fldigi_doxygen/images/W5ZIT-interface.png b/fldigi_doxygen/images/W5ZIT-interface.png new file mode 100644 index 00000000..97f53dd1 Binary files /dev/null and b/fldigi_doxygen/images/W5ZIT-interface.png differ diff --git a/fldigi_doxygen/images/Wefax-Configuration.png b/fldigi_doxygen/images/Wefax-Configuration.png new file mode 100644 index 00000000..81caae3b Binary files /dev/null and b/fldigi_doxygen/images/Wefax-Configuration.png differ diff --git a/fldigi_doxygen/images/Wefax-Detached-Windows.png b/fldigi_doxygen/images/Wefax-Detached-Windows.png new file mode 100644 index 00000000..6c5f6e8e Binary files /dev/null and b/fldigi_doxygen/images/Wefax-Detached-Windows.png differ diff --git a/fldigi_doxygen/images/Wefax-Display-And-Receive.png b/fldigi_doxygen/images/Wefax-Display-And-Receive.png new file mode 100644 index 00000000..104f9ba6 Binary files /dev/null and b/fldigi_doxygen/images/Wefax-Display-And-Receive.png differ diff --git a/fldigi_doxygen/images/Wefax-File-Received.png b/fldigi_doxygen/images/Wefax-File-Received.png new file mode 100644 index 00000000..9df21af4 Binary files /dev/null and b/fldigi_doxygen/images/Wefax-File-Received.png differ diff --git a/fldigi_doxygen/images/Wefax-Sending.png b/fldigi_doxygen/images/Wefax-Sending.png new file mode 100644 index 00000000..5d3d464e Binary files /dev/null and b/fldigi_doxygen/images/Wefax-Sending.png differ diff --git a/fldigi_doxygen/images/Wefax-Tab.png b/fldigi_doxygen/images/Wefax-Tab.png new file mode 100644 index 00000000..a68a9bf7 Binary files /dev/null and b/fldigi_doxygen/images/Wefax-Tab.png differ diff --git a/fldigi_doxygen/images/Xmt-Pix.png b/fldigi_doxygen/images/Xmt-Pix.png new file mode 100644 index 00000000..74d27b00 Binary files /dev/null and b/fldigi_doxygen/images/Xmt-Pix.png differ diff --git a/fldigi_doxygen/images/Xmt-Pix1.png b/fldigi_doxygen/images/Xmt-Pix1.png new file mode 100644 index 00000000..6c5e16a6 Binary files /dev/null and b/fldigi_doxygen/images/Xmt-Pix1.png differ diff --git a/fldigi_doxygen/images/Xmt-Pix3.png b/fldigi_doxygen/images/Xmt-Pix3.png new file mode 100644 index 00000000..0f130bc1 Binary files /dev/null and b/fldigi_doxygen/images/Xmt-Pix3.png differ diff --git a/fldigi_doxygen/images/Xmt-Pix4.png b/fldigi_doxygen/images/Xmt-Pix4.png new file mode 100644 index 00000000..fb5b2c31 Binary files /dev/null and b/fldigi_doxygen/images/Xmt-Pix4.png differ diff --git a/fldigi_doxygen/images/activity-reports.png b/fldigi_doxygen/images/activity-reports.png new file mode 100644 index 00000000..b86d5e99 Binary files /dev/null and b/fldigi_doxygen/images/activity-reports.png differ diff --git a/fldigi_doxygen/images/browser-panel.png b/fldigi_doxygen/images/browser-panel.png new file mode 100644 index 00000000..5de464b4 Binary files /dev/null and b/fldigi_doxygen/images/browser-panel.png differ diff --git a/fldigi_doxygen/images/config-WX.png b/fldigi_doxygen/images/config-WX.png new file mode 100644 index 00000000..902dfd50 Binary files /dev/null and b/fldigi_doxygen/images/config-WX.png differ diff --git a/fldigi_doxygen/images/config-audio-devices.png b/fldigi_doxygen/images/config-audio-devices.png new file mode 100644 index 00000000..af9181d9 Binary files /dev/null and b/fldigi_doxygen/images/config-audio-devices.png differ diff --git a/fldigi_doxygen/images/config-audio-mixer.png b/fldigi_doxygen/images/config-audio-mixer.png new file mode 100644 index 00000000..cd4487ff Binary files /dev/null and b/fldigi_doxygen/images/config-audio-mixer.png differ diff --git a/fldigi_doxygen/images/config-audio-right.png b/fldigi_doxygen/images/config-audio-right.png new file mode 100644 index 00000000..b7360f53 Binary files /dev/null and b/fldigi_doxygen/images/config-audio-right.png differ diff --git a/fldigi_doxygen/images/config-audio-settings.png b/fldigi_doxygen/images/config-audio-settings.png new file mode 100644 index 00000000..e36d4025 Binary files /dev/null and b/fldigi_doxygen/images/config-audio-settings.png differ diff --git a/fldigi_doxygen/images/config-contestia.png b/fldigi_doxygen/images/config-contestia.png new file mode 100644 index 00000000..bd802d64 Binary files /dev/null and b/fldigi_doxygen/images/config-contestia.png differ diff --git a/fldigi_doxygen/images/config-cw-general.png b/fldigi_doxygen/images/config-cw-general.png new file mode 100644 index 00000000..48e30617 Binary files /dev/null and b/fldigi_doxygen/images/config-cw-general.png differ diff --git a/fldigi_doxygen/images/config-cw-prosign-popup.png b/fldigi_doxygen/images/config-cw-prosign-popup.png new file mode 100644 index 00000000..b5b04f08 Binary files /dev/null and b/fldigi_doxygen/images/config-cw-prosign-popup.png differ diff --git a/fldigi_doxygen/images/config-cw-prosigns.png b/fldigi_doxygen/images/config-cw-prosigns.png new file mode 100644 index 00000000..796f7202 Binary files /dev/null and b/fldigi_doxygen/images/config-cw-prosigns.png differ diff --git a/fldigi_doxygen/images/config-cw-qsk.png b/fldigi_doxygen/images/config-cw-qsk.png new file mode 100644 index 00000000..fd64f937 Binary files /dev/null and b/fldigi_doxygen/images/config-cw-qsk.png differ diff --git a/fldigi_doxygen/images/config-domino.png b/fldigi_doxygen/images/config-domino.png new file mode 100644 index 00000000..af5f555f Binary files /dev/null and b/fldigi_doxygen/images/config-domino.png differ diff --git a/fldigi_doxygen/images/config-eqsl.png b/fldigi_doxygen/images/config-eqsl.png new file mode 100644 index 00000000..c21914a7 Binary files /dev/null and b/fldigi_doxygen/images/config-eqsl.png differ diff --git a/fldigi_doxygen/images/config-feldhell.png b/fldigi_doxygen/images/config-feldhell.png new file mode 100644 index 00000000..8b25a3c4 Binary files /dev/null and b/fldigi_doxygen/images/config-feldhell.png differ diff --git a/fldigi_doxygen/images/config-fsq.png b/fldigi_doxygen/images/config-fsq.png new file mode 100644 index 00000000..f4f95325 Binary files /dev/null and b/fldigi_doxygen/images/config-fsq.png differ diff --git a/fldigi_doxygen/images/config-id-cw-modes.png b/fldigi_doxygen/images/config-id-cw-modes.png new file mode 100644 index 00000000..17034978 Binary files /dev/null and b/fldigi_doxygen/images/config-id-cw-modes.png differ diff --git a/fldigi_doxygen/images/config-id-cw.png b/fldigi_doxygen/images/config-id-cw.png new file mode 100644 index 00000000..f0b5f869 Binary files /dev/null and b/fldigi_doxygen/images/config-id-cw.png differ diff --git a/fldigi_doxygen/images/config-id-rsid.png b/fldigi_doxygen/images/config-id-rsid.png new file mode 100644 index 00000000..abf986c7 Binary files /dev/null and b/fldigi_doxygen/images/config-id-rsid.png differ diff --git a/fldigi_doxygen/images/config-id-rx-modes.png b/fldigi_doxygen/images/config-id-rx-modes.png new file mode 100644 index 00000000..9bf1786d Binary files /dev/null and b/fldigi_doxygen/images/config-id-rx-modes.png differ diff --git a/fldigi_doxygen/images/config-id-video-modes.png b/fldigi_doxygen/images/config-id-video-modes.png new file mode 100644 index 00000000..6d4cede2 Binary files /dev/null and b/fldigi_doxygen/images/config-id-video-modes.png differ diff --git a/fldigi_doxygen/images/config-id-video.png b/fldigi_doxygen/images/config-id-video.png new file mode 100644 index 00000000..e6a7d3f5 Binary files /dev/null and b/fldigi_doxygen/images/config-id-video.png differ diff --git a/fldigi_doxygen/images/config-id-xmt-modes.png b/fldigi_doxygen/images/config-id-xmt-modes.png new file mode 100644 index 00000000..42946ff6 Binary files /dev/null and b/fldigi_doxygen/images/config-id-xmt-modes.png differ diff --git a/fldigi_doxygen/images/config-io-arq.png b/fldigi_doxygen/images/config-io-arq.png new file mode 100644 index 00000000..aad4c26f Binary files /dev/null and b/fldigi_doxygen/images/config-io-arq.png differ diff --git a/fldigi_doxygen/images/config-io-kiss.png b/fldigi_doxygen/images/config-io-kiss.png new file mode 100644 index 00000000..b6400bbc Binary files /dev/null and b/fldigi_doxygen/images/config-io-kiss.png differ diff --git a/fldigi_doxygen/images/config-io-locked.png b/fldigi_doxygen/images/config-io-locked.png new file mode 100644 index 00000000..c08d01bb Binary files /dev/null and b/fldigi_doxygen/images/config-io-locked.png differ diff --git a/fldigi_doxygen/images/config-io-xmlrpc.png b/fldigi_doxygen/images/config-io-xmlrpc.png new file mode 100644 index 00000000..8c6e2e50 Binary files /dev/null and b/fldigi_doxygen/images/config-io-xmlrpc.png differ diff --git a/fldigi_doxygen/images/config-io.png b/fldigi_doxygen/images/config-io.png new file mode 100644 index 00000000..6cbcfb68 Binary files /dev/null and b/fldigi_doxygen/images/config-io.png differ diff --git a/fldigi_doxygen/images/config-misc-cpu.png b/fldigi_doxygen/images/config-misc-cpu.png new file mode 100644 index 00000000..adac5e0c Binary files /dev/null and b/fldigi_doxygen/images/config-misc-cpu.png differ diff --git a/fldigi_doxygen/images/config-misc-dtmf.png b/fldigi_doxygen/images/config-misc-dtmf.png new file mode 100644 index 00000000..8516adac Binary files /dev/null and b/fldigi_doxygen/images/config-misc-dtmf.png differ diff --git a/fldigi_doxygen/images/config-misc-kml.png b/fldigi_doxygen/images/config-misc-kml.png new file mode 100644 index 00000000..996340e6 Binary files /dev/null and b/fldigi_doxygen/images/config-misc-kml.png differ diff --git a/fldigi_doxygen/images/config-misc-nbems.png b/fldigi_doxygen/images/config-misc-nbems.png new file mode 100644 index 00000000..84e0563f Binary files /dev/null and b/fldigi_doxygen/images/config-misc-nbems.png differ diff --git a/fldigi_doxygen/images/config-misc-spotting.png b/fldigi_doxygen/images/config-misc-spotting.png new file mode 100644 index 00000000..70f736bb Binary files /dev/null and b/fldigi_doxygen/images/config-misc-spotting.png differ diff --git a/fldigi_doxygen/images/config-misc-sweet.png b/fldigi_doxygen/images/config-misc-sweet.png new file mode 100644 index 00000000..61f33445 Binary files /dev/null and b/fldigi_doxygen/images/config-misc-sweet.png differ diff --git a/fldigi_doxygen/images/config-misc-textio.png b/fldigi_doxygen/images/config-misc-textio.png new file mode 100644 index 00000000..ac033c5e Binary files /dev/null and b/fldigi_doxygen/images/config-misc-textio.png differ diff --git a/fldigi_doxygen/images/config-modem-navtex.png b/fldigi_doxygen/images/config-modem-navtex.png new file mode 100644 index 00000000..f3bd4960 Binary files /dev/null and b/fldigi_doxygen/images/config-modem-navtex.png differ diff --git a/fldigi_doxygen/images/config-modem-scan.png b/fldigi_doxygen/images/config-modem-scan.png new file mode 100644 index 00000000..7a03fb91 Binary files /dev/null and b/fldigi_doxygen/images/config-modem-scan.png differ diff --git a/fldigi_doxygen/images/config-mt63.png b/fldigi_doxygen/images/config-mt63.png new file mode 100644 index 00000000..c8cf217b Binary files /dev/null and b/fldigi_doxygen/images/config-mt63.png differ diff --git a/fldigi_doxygen/images/config-olivia.png b/fldigi_doxygen/images/config-olivia.png new file mode 100644 index 00000000..4c0d5383 Binary files /dev/null and b/fldigi_doxygen/images/config-olivia.png differ diff --git a/fldigi_doxygen/images/config-operator.png b/fldigi_doxygen/images/config-operator.png new file mode 100644 index 00000000..3aacbdd2 Binary files /dev/null and b/fldigi_doxygen/images/config-operator.png differ diff --git a/fldigi_doxygen/images/config-psk-general.png b/fldigi_doxygen/images/config-psk-general.png new file mode 100644 index 00000000..00502517 Binary files /dev/null and b/fldigi_doxygen/images/config-psk-general.png differ diff --git a/fldigi_doxygen/images/config-psk-mail.png b/fldigi_doxygen/images/config-psk-mail.png new file mode 100644 index 00000000..37dd3468 Binary files /dev/null and b/fldigi_doxygen/images/config-psk-mail.png differ diff --git a/fldigi_doxygen/images/config-qrz.png b/fldigi_doxygen/images/config-qrz.png new file mode 100644 index 00000000..5d83b3e7 Binary files /dev/null and b/fldigi_doxygen/images/config-qrz.png differ diff --git a/fldigi_doxygen/images/config-rig-hamlib.png b/fldigi_doxygen/images/config-rig-hamlib.png new file mode 100644 index 00000000..59801a45 Binary files /dev/null and b/fldigi_doxygen/images/config-rig-hamlib.png differ diff --git a/fldigi_doxygen/images/config-rig-hardware.png b/fldigi_doxygen/images/config-rig-hardware.png new file mode 100644 index 00000000..a5e7acfb Binary files /dev/null and b/fldigi_doxygen/images/config-rig-hardware.png differ diff --git a/fldigi_doxygen/images/config-rig-rigcat.png b/fldigi_doxygen/images/config-rig-rigcat.png new file mode 100644 index 00000000..ceaafd0d Binary files /dev/null and b/fldigi_doxygen/images/config-rig-rigcat.png differ diff --git a/fldigi_doxygen/images/config-rig-xmlrpc.png b/fldigi_doxygen/images/config-rig-xmlrpc.png new file mode 100644 index 00000000..fef18f5e Binary files /dev/null and b/fldigi_doxygen/images/config-rig-xmlrpc.png differ diff --git a/fldigi_doxygen/images/config-rtty-classic-scope.png b/fldigi_doxygen/images/config-rtty-classic-scope.png new file mode 100644 index 00000000..43e07e19 Binary files /dev/null and b/fldigi_doxygen/images/config-rtty-classic-scope.png differ diff --git a/fldigi_doxygen/images/config-rtty-pseudo-scope.png b/fldigi_doxygen/images/config-rtty-pseudo-scope.png new file mode 100644 index 00000000..09285e06 Binary files /dev/null and b/fldigi_doxygen/images/config-rtty-pseudo-scope.png differ diff --git a/fldigi_doxygen/images/config-rtty-rx.png b/fldigi_doxygen/images/config-rtty-rx.png new file mode 100644 index 00000000..60639847 Binary files /dev/null and b/fldigi_doxygen/images/config-rtty-rx.png differ diff --git a/fldigi_doxygen/images/config-rtty-synop.png b/fldigi_doxygen/images/config-rtty-synop.png new file mode 100644 index 00000000..6777e43d Binary files /dev/null and b/fldigi_doxygen/images/config-rtty-synop.png differ diff --git a/fldigi_doxygen/images/config-rtty-tx.png b/fldigi_doxygen/images/config-rtty-tx.png new file mode 100644 index 00000000..9ce1db6d Binary files /dev/null and b/fldigi_doxygen/images/config-rtty-tx.png differ diff --git a/fldigi_doxygen/images/config-thor.png b/fldigi_doxygen/images/config-thor.png new file mode 100644 index 00000000..0f3df7f0 Binary files /dev/null and b/fldigi_doxygen/images/config-thor.png differ diff --git a/fldigi_doxygen/images/config-ui-browser.png b/fldigi_doxygen/images/config-ui-browser.png new file mode 100644 index 00000000..59b804c1 Binary files /dev/null and b/fldigi_doxygen/images/config-ui-browser.png differ diff --git a/fldigi_doxygen/images/config-ui-contest.png b/fldigi_doxygen/images/config-ui-contest.png new file mode 100644 index 00000000..2218faca Binary files /dev/null and b/fldigi_doxygen/images/config-ui-contest.png differ diff --git a/fldigi_doxygen/images/config-ui-general.png b/fldigi_doxygen/images/config-ui-general.png new file mode 100644 index 00000000..aee535de Binary files /dev/null and b/fldigi_doxygen/images/config-ui-general.png differ diff --git a/fldigi_doxygen/images/config-ui-lan.png b/fldigi_doxygen/images/config-ui-lan.png new file mode 100644 index 00000000..490cdb1b Binary files /dev/null and b/fldigi_doxygen/images/config-ui-lan.png differ diff --git a/fldigi_doxygen/images/config-ui-macros.png b/fldigi_doxygen/images/config-ui-macros.png new file mode 100644 index 00000000..a2122b40 Binary files /dev/null and b/fldigi_doxygen/images/config-ui-macros.png differ diff --git a/fldigi_doxygen/images/config-ui-qso-logging.png b/fldigi_doxygen/images/config-ui-qso-logging.png new file mode 100644 index 00000000..487a3248 Binary files /dev/null and b/fldigi_doxygen/images/config-ui-qso-logging.png differ diff --git a/fldigi_doxygen/images/config-ui-rxtext-2.png b/fldigi_doxygen/images/config-ui-rxtext-2.png new file mode 100644 index 00000000..ce3a4385 Binary files /dev/null and b/fldigi_doxygen/images/config-ui-rxtext-2.png differ diff --git a/fldigi_doxygen/images/config-ui-tabs.png b/fldigi_doxygen/images/config-ui-tabs.png new file mode 100644 index 00000000..bad2f3b0 Binary files /dev/null and b/fldigi_doxygen/images/config-ui-tabs.png differ diff --git a/fldigi_doxygen/images/config-ui-touch.png b/fldigi_doxygen/images/config-ui-touch.png new file mode 100644 index 00000000..4b7e9b1d Binary files /dev/null and b/fldigi_doxygen/images/config-ui-touch.png differ diff --git a/fldigi_doxygen/images/config-ui-wf-controls-2.png b/fldigi_doxygen/images/config-ui-wf-controls-2.png new file mode 100644 index 00000000..cb86dfeb Binary files /dev/null and b/fldigi_doxygen/images/config-ui-wf-controls-2.png differ diff --git a/fldigi_doxygen/images/config-ui-wf-controls.png b/fldigi_doxygen/images/config-ui-wf-controls.png new file mode 100644 index 00000000..5c63cae5 Binary files /dev/null and b/fldigi_doxygen/images/config-ui-wf-controls.png differ diff --git a/fldigi_doxygen/images/config-wf-display.png b/fldigi_doxygen/images/config-wf-display.png new file mode 100644 index 00000000..34d1da35 Binary files /dev/null and b/fldigi_doxygen/images/config-wf-display.png differ diff --git a/fldigi_doxygen/images/config-wf-fft.png b/fldigi_doxygen/images/config-wf-fft.png new file mode 100644 index 00000000..7775011d Binary files /dev/null and b/fldigi_doxygen/images/config-wf-fft.png differ diff --git a/fldigi_doxygen/images/config-wf-mouse.png b/fldigi_doxygen/images/config-wf-mouse.png new file mode 100644 index 00000000..9489bae4 Binary files /dev/null and b/fldigi_doxygen/images/config-wf-mouse.png differ diff --git a/fldigi_doxygen/images/connect-to-logserver.png b/fldigi_doxygen/images/connect-to-logserver.png new file mode 100644 index 00000000..2e9e265b Binary files /dev/null and b/fldigi_doxygen/images/connect-to-logserver.png differ diff --git a/fldigi_doxygen/images/contest-fields.png b/fldigi_doxygen/images/contest-fields.png new file mode 100644 index 00000000..66586e5e Binary files /dev/null and b/fldigi_doxygen/images/contest-fields.png differ diff --git a/fldigi_doxygen/images/cw-00-30.png b/fldigi_doxygen/images/cw-00-30.png new file mode 100644 index 00000000..a25fbb59 Binary files /dev/null and b/fldigi_doxygen/images/cw-00-30.png differ diff --git a/fldigi_doxygen/images/cw-00-40.png b/fldigi_doxygen/images/cw-00-40.png new file mode 100644 index 00000000..68ec37e4 Binary files /dev/null and b/fldigi_doxygen/images/cw-00-40.png differ diff --git a/fldigi_doxygen/images/cw-120-30.png b/fldigi_doxygen/images/cw-120-30.png new file mode 100644 index 00000000..233912c1 Binary files /dev/null and b/fldigi_doxygen/images/cw-120-30.png differ diff --git a/fldigi_doxygen/images/cw-30-30.png b/fldigi_doxygen/images/cw-30-30.png new file mode 100644 index 00000000..4074e98c Binary files /dev/null and b/fldigi_doxygen/images/cw-30-30.png differ diff --git a/fldigi_doxygen/images/cw-60-30.png b/fldigi_doxygen/images/cw-60-30.png new file mode 100644 index 00000000..23a11acd Binary files /dev/null and b/fldigi_doxygen/images/cw-60-30.png differ diff --git a/fldigi_doxygen/images/cw_status_1.png b/fldigi_doxygen/images/cw_status_1.png new file mode 100644 index 00000000..7b2e7569 Binary files /dev/null and b/fldigi_doxygen/images/cw_status_1.png differ diff --git a/fldigi_doxygen/images/cw_status_2.png b/fldigi_doxygen/images/cw_status_2.png new file mode 100644 index 00000000..56a7f665 Binary files /dev/null and b/fldigi_doxygen/images/cw_status_2.png differ diff --git a/fldigi_doxygen/images/dcf77-0.png b/fldigi_doxygen/images/dcf77-0.png new file mode 100644 index 00000000..61a5a1b6 Binary files /dev/null and b/fldigi_doxygen/images/dcf77-0.png differ diff --git a/fldigi_doxygen/images/dcf77-0zoom.png b/fldigi_doxygen/images/dcf77-0zoom.png new file mode 100644 index 00000000..8aab91cf Binary files /dev/null and b/fldigi_doxygen/images/dcf77-0zoom.png differ diff --git a/fldigi_doxygen/images/dcf77-1000.png b/fldigi_doxygen/images/dcf77-1000.png new file mode 100644 index 00000000..adb1ea0b Binary files /dev/null and b/fldigi_doxygen/images/dcf77-1000.png differ diff --git a/fldigi_doxygen/images/dcf77-65zoom.png b/fldigi_doxygen/images/dcf77-65zoom.png new file mode 100644 index 00000000..483bd484 Binary files /dev/null and b/fldigi_doxygen/images/dcf77-65zoom.png differ diff --git a/fldigi_doxygen/images/digiscope-cw.png b/fldigi_doxygen/images/digiscope-cw.png new file mode 100644 index 00000000..27258686 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-cw.png differ diff --git a/fldigi_doxygen/images/digiscope-domexA.png b/fldigi_doxygen/images/digiscope-domexA.png new file mode 100644 index 00000000..fe49ac99 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-domexA.png differ diff --git a/fldigi_doxygen/images/digiscope-domexB.png b/fldigi_doxygen/images/digiscope-domexB.png new file mode 100644 index 00000000..16e120c1 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-domexB.png differ diff --git a/fldigi_doxygen/images/digiscope-mfsk.png b/fldigi_doxygen/images/digiscope-mfsk.png new file mode 100644 index 00000000..e534db84 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-mfsk.png differ diff --git a/fldigi_doxygen/images/digiscope-psk-high.png b/fldigi_doxygen/images/digiscope-psk-high.png new file mode 100644 index 00000000..aa33c9bb Binary files /dev/null and b/fldigi_doxygen/images/digiscope-psk-high.png differ diff --git a/fldigi_doxygen/images/digiscope-psk-history-amplitude.png b/fldigi_doxygen/images/digiscope-psk-history-amplitude.png new file mode 100644 index 00000000..67b6aab9 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-psk-history-amplitude.png differ diff --git a/fldigi_doxygen/images/digiscope-psk-history.png b/fldigi_doxygen/images/digiscope-psk-history.png new file mode 100644 index 00000000..43cd4fb8 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-psk-history.png differ diff --git a/fldigi_doxygen/images/digiscope-psk-low.png b/fldigi_doxygen/images/digiscope-psk-low.png new file mode 100644 index 00000000..fe7c3da5 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-psk-low.png differ diff --git a/fldigi_doxygen/images/digiscope-psk-nosig.png b/fldigi_doxygen/images/digiscope-psk-nosig.png new file mode 100644 index 00000000..243849bc Binary files /dev/null and b/fldigi_doxygen/images/digiscope-psk-nosig.png differ diff --git a/fldigi_doxygen/images/digiscope-psk.png b/fldigi_doxygen/images/digiscope-psk.png new file mode 100644 index 00000000..768643ab Binary files /dev/null and b/fldigi_doxygen/images/digiscope-psk.png differ diff --git a/fldigi_doxygen/images/digiscope-rtty-2.png b/fldigi_doxygen/images/digiscope-rtty-2.png new file mode 100644 index 00000000..25a83102 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-rtty-2.png differ diff --git a/fldigi_doxygen/images/digiscope-rtty.png b/fldigi_doxygen/images/digiscope-rtty.png new file mode 100644 index 00000000..73787e62 Binary files /dev/null and b/fldigi_doxygen/images/digiscope-rtty.png differ diff --git a/fldigi_doxygen/images/docked-rig-control.png b/fldigi_doxygen/images/docked-rig-control.png new file mode 100644 index 00000000..5096d286 Binary files /dev/null and b/fldigi_doxygen/images/docked-rig-control.png differ diff --git a/fldigi_doxygen/images/dominoex-1.png b/fldigi_doxygen/images/dominoex-1.png new file mode 100644 index 00000000..45494c78 Binary files /dev/null and b/fldigi_doxygen/images/dominoex-1.png differ diff --git a/fldigi_doxygen/images/dominoex-1a.png b/fldigi_doxygen/images/dominoex-1a.png new file mode 100644 index 00000000..49d18775 Binary files /dev/null and b/fldigi_doxygen/images/dominoex-1a.png differ diff --git a/fldigi_doxygen/images/dominoex-2.png b/fldigi_doxygen/images/dominoex-2.png new file mode 100644 index 00000000..cf1fe351 Binary files /dev/null and b/fldigi_doxygen/images/dominoex-2.png differ diff --git a/fldigi_doxygen/images/dominoex-3.png b/fldigi_doxygen/images/dominoex-3.png new file mode 100644 index 00000000..867e9fd9 Binary files /dev/null and b/fldigi_doxygen/images/dominoex-3.png differ diff --git a/fldigi_doxygen/images/eight-psk-signal-oscope.png b/fldigi_doxygen/images/eight-psk-signal-oscope.png new file mode 100644 index 00000000..e70abd9f Binary files /dev/null and b/fldigi_doxygen/images/eight-psk-signal-oscope.png differ diff --git a/fldigi_doxygen/images/eight-psk-signal-waterfall.png b/fldigi_doxygen/images/eight-psk-signal-waterfall.png new file mode 100644 index 00000000..ce5e75c8 Binary files /dev/null and b/fldigi_doxygen/images/eight-psk-signal-waterfall.png differ diff --git a/fldigi_doxygen/images/event-log-debug.png b/fldigi_doxygen/images/event-log-debug.png new file mode 100644 index 00000000..60dd018e Binary files /dev/null and b/fldigi_doxygen/images/event-log-debug.png differ diff --git a/fldigi_doxygen/images/event-log-error.png b/fldigi_doxygen/images/event-log-error.png new file mode 100644 index 00000000..030c100c Binary files /dev/null and b/fldigi_doxygen/images/event-log-error.png differ diff --git a/fldigi_doxygen/images/event-log-info.png b/fldigi_doxygen/images/event-log-info.png new file mode 100644 index 00000000..5c52ca06 Binary files /dev/null and b/fldigi_doxygen/images/event-log-info.png differ diff --git a/fldigi_doxygen/images/event-log-menu.png b/fldigi_doxygen/images/event-log-menu.png new file mode 100644 index 00000000..618531c9 Binary files /dev/null and b/fldigi_doxygen/images/event-log-menu.png differ diff --git a/fldigi_doxygen/images/event-log-quiet.png b/fldigi_doxygen/images/event-log-quiet.png new file mode 100644 index 00000000..ee8d1eb5 Binary files /dev/null and b/fldigi_doxygen/images/event-log-quiet.png differ diff --git a/fldigi_doxygen/images/event-log-verbose.png b/fldigi_doxygen/images/event-log-verbose.png new file mode 100644 index 00000000..244463e8 Binary files /dev/null and b/fldigi_doxygen/images/event-log-verbose.png differ diff --git a/fldigi_doxygen/images/event-log-warning.png b/fldigi_doxygen/images/event-log-warning.png new file mode 100644 index 00000000..36fc29f2 Binary files /dev/null and b/fldigi_doxygen/images/event-log-warning.png differ diff --git a/fldigi_doxygen/images/event-log.png b/fldigi_doxygen/images/event-log.png new file mode 100644 index 00000000..171875b4 Binary files /dev/null and b/fldigi_doxygen/images/event-log.png differ diff --git a/fldigi_doxygen/images/fafhjagc.png b/fldigi_doxygen/images/fafhjagc.png new file mode 100644 index 00000000..cbab7aa9 Binary files /dev/null and b/fldigi_doxygen/images/fafhjagc.png differ diff --git a/fldigi_doxygen/images/farnsworth.png b/fldigi_doxygen/images/farnsworth.png new file mode 100644 index 00000000..0e0ff655 Binary files /dev/null and b/fldigi_doxygen/images/farnsworth.png differ diff --git a/fldigi_doxygen/images/fcfhfacc.png b/fldigi_doxygen/images/fcfhfacc.png new file mode 100644 index 00000000..1bac7527 Binary files /dev/null and b/fldigi_doxygen/images/fcfhfacc.png differ diff --git a/fldigi_doxygen/images/feld-hell.png b/fldigi_doxygen/images/feld-hell.png new file mode 100644 index 00000000..3908ac27 Binary files /dev/null and b/fldigi_doxygen/images/feld-hell.png differ diff --git a/fldigi_doxygen/images/fldigi-controls.png b/fldigi_doxygen/images/fldigi-controls.png new file mode 100644 index 00000000..3917c705 Binary files /dev/null and b/fldigi_doxygen/images/fldigi-controls.png differ diff --git a/fldigi_doxygen/images/folder-palettes.png b/fldigi_doxygen/images/folder-palettes.png new file mode 100644 index 00000000..47da4779 Binary files /dev/null and b/fldigi_doxygen/images/folder-palettes.png differ diff --git a/fldigi_doxygen/images/folder-working.png b/fldigi_doxygen/images/folder-working.png new file mode 100644 index 00000000..b4e73b74 Binary files /dev/null and b/fldigi_doxygen/images/folder-working.png differ diff --git a/fldigi_doxygen/images/fsq-allcall-popup.png b/fldigi_doxygen/images/fsq-allcall-popup.png new file mode 100644 index 00000000..a1a43a87 Binary files /dev/null and b/fldigi_doxygen/images/fsq-allcall-popup.png differ diff --git a/fldigi_doxygen/images/fsq-config-tab.png b/fldigi_doxygen/images/fsq-config-tab.png new file mode 100644 index 00000000..154153dd Binary files /dev/null and b/fldigi_doxygen/images/fsq-config-tab.png differ diff --git a/fldigi_doxygen/images/fsq-directed-mode-examples.png b/fldigi_doxygen/images/fsq-directed-mode-examples.png new file mode 100644 index 00000000..74704e2c Binary files /dev/null and b/fldigi_doxygen/images/fsq-directed-mode-examples.png differ diff --git a/fldigi_doxygen/images/fsq-directed-mode.png b/fldigi_doxygen/images/fsq-directed-mode.png new file mode 100644 index 00000000..811b77ec Binary files /dev/null and b/fldigi_doxygen/images/fsq-directed-mode.png differ diff --git a/fldigi_doxygen/images/fsq-directed-popup.png b/fldigi_doxygen/images/fsq-directed-popup.png new file mode 100644 index 00000000..6ffa1467 Binary files /dev/null and b/fldigi_doxygen/images/fsq-directed-popup.png differ diff --git a/fldigi_doxygen/images/fsq-heard-list.png b/fldigi_doxygen/images/fsq-heard-list.png new file mode 100644 index 00000000..07059daa Binary files /dev/null and b/fldigi_doxygen/images/fsq-heard-list.png differ diff --git a/fldigi_doxygen/images/fsq-image-rx.png b/fldigi_doxygen/images/fsq-image-rx.png new file mode 100644 index 00000000..6896e678 Binary files /dev/null and b/fldigi_doxygen/images/fsq-image-rx.png differ diff --git a/fldigi_doxygen/images/fsq-image-xmt.png b/fldigi_doxygen/images/fsq-image-xmt.png new file mode 100644 index 00000000..bdc5ee6f Binary files /dev/null and b/fldigi_doxygen/images/fsq-image-xmt.png differ diff --git a/fldigi_doxygen/images/fsq-main-dialog.png b/fldigi_doxygen/images/fsq-main-dialog.png new file mode 100644 index 00000000..a12237b5 Binary files /dev/null and b/fldigi_doxygen/images/fsq-main-dialog.png differ diff --git a/fldigi_doxygen/images/fsq-mon-dialog.png b/fldigi_doxygen/images/fsq-mon-dialog.png new file mode 100644 index 00000000..5d224a8e Binary files /dev/null and b/fldigi_doxygen/images/fsq-mon-dialog.png differ diff --git a/fldigi_doxygen/images/fsq-relay-examples.png b/fldigi_doxygen/images/fsq-relay-examples.png new file mode 100644 index 00000000..f46bdd3e Binary files /dev/null and b/fldigi_doxygen/images/fsq-relay-examples.png differ diff --git a/fldigi_doxygen/images/fsq-rx-image-corrected.png b/fldigi_doxygen/images/fsq-rx-image-corrected.png new file mode 100644 index 00000000..11b80dcb Binary files /dev/null and b/fldigi_doxygen/images/fsq-rx-image-corrected.png differ diff --git a/fldigi_doxygen/images/fsq-rx-image-raw.png b/fldigi_doxygen/images/fsq-rx-image-raw.png new file mode 100644 index 00000000..f8fe6074 Binary files /dev/null and b/fldigi_doxygen/images/fsq-rx-image-raw.png differ diff --git a/fldigi_doxygen/images/fsq-s2n.png b/fldigi_doxygen/images/fsq-s2n.png new file mode 100644 index 00000000..a2c8e452 Binary files /dev/null and b/fldigi_doxygen/images/fsq-s2n.png differ diff --git a/fldigi_doxygen/images/fsq-tones.png b/fldigi_doxygen/images/fsq-tones.png new file mode 100644 index 00000000..bcc3ac9f Binary files /dev/null and b/fldigi_doxygen/images/fsq-tones.png differ diff --git a/fldigi_doxygen/images/fsq-undirected-mode.png b/fldigi_doxygen/images/fsq-undirected-mode.png new file mode 100644 index 00000000..050176ae Binary files /dev/null and b/fldigi_doxygen/images/fsq-undirected-mode.png differ diff --git a/fldigi_doxygen/images/fsq-varicode.png b/fldigi_doxygen/images/fsq-varicode.png new file mode 100644 index 00000000..056c6a50 Binary files /dev/null and b/fldigi_doxygen/images/fsq-varicode.png differ diff --git a/fldigi_doxygen/images/init-rig-setup.png b/fldigi_doxygen/images/init-rig-setup.png new file mode 100644 index 00000000..e656db50 Binary files /dev/null and b/fldigi_doxygen/images/init-rig-setup.png differ diff --git a/fldigi_doxygen/images/invalid_kiss_io_modem.png b/fldigi_doxygen/images/invalid_kiss_io_modem.png new file mode 100644 index 00000000..fb0cdfc7 Binary files /dev/null and b/fldigi_doxygen/images/invalid_kiss_io_modem.png differ diff --git a/fldigi_doxygen/images/io_modem_packet.png b/fldigi_doxygen/images/io_modem_packet.png new file mode 100644 index 00000000..86e59979 Binary files /dev/null and b/fldigi_doxygen/images/io_modem_packet.png differ diff --git a/fldigi_doxygen/images/k0og.png b/fldigi_doxygen/images/k0og.png new file mode 100644 index 00000000..b07c8431 Binary files /dev/null and b/fldigi_doxygen/images/k0og.png differ diff --git a/fldigi_doxygen/images/limited_modes.png b/fldigi_doxygen/images/limited_modes.png new file mode 100644 index 00000000..d3e654ad Binary files /dev/null and b/fldigi_doxygen/images/limited_modes.png differ diff --git a/fldigi_doxygen/images/log-buttons.png b/fldigi_doxygen/images/log-buttons.png new file mode 100644 index 00000000..562fd735 Binary files /dev/null and b/fldigi_doxygen/images/log-buttons.png differ diff --git a/fldigi_doxygen/images/log-contest-min.png b/fldigi_doxygen/images/log-contest-min.png new file mode 100644 index 00000000..618971ba Binary files /dev/null and b/fldigi_doxygen/images/log-contest-min.png differ diff --git a/fldigi_doxygen/images/log-contest.png b/fldigi_doxygen/images/log-contest.png new file mode 100644 index 00000000..e39a0ecb Binary files /dev/null and b/fldigi_doxygen/images/log-contest.png differ diff --git a/fldigi_doxygen/images/log-it.png b/fldigi_doxygen/images/log-it.png new file mode 100644 index 00000000..feae845d Binary files /dev/null and b/fldigi_doxygen/images/log-it.png differ diff --git a/fldigi_doxygen/images/log-qso-min.png b/fldigi_doxygen/images/log-qso-min.png new file mode 100644 index 00000000..5cb771d8 Binary files /dev/null and b/fldigi_doxygen/images/log-qso-min.png differ diff --git a/fldigi_doxygen/images/log-qso.png b/fldigi_doxygen/images/log-qso.png new file mode 100644 index 00000000..9cee7d66 Binary files /dev/null and b/fldigi_doxygen/images/log-qso.png differ diff --git a/fldigi_doxygen/images/logbook.png b/fldigi_doxygen/images/logbook.png new file mode 100644 index 00000000..2fd8af9b Binary files /dev/null and b/fldigi_doxygen/images/logbook.png differ diff --git a/fldigi_doxygen/images/macro-editor.png b/fldigi_doxygen/images/macro-editor.png new file mode 100644 index 00000000..c5937f0a Binary files /dev/null and b/fldigi_doxygen/images/macro-editor.png differ diff --git a/fldigi_doxygen/images/macrobuttons.png b/fldigi_doxygen/images/macrobuttons.png new file mode 100644 index 00000000..bed9218d Binary files /dev/null and b/fldigi_doxygen/images/macrobuttons.png differ diff --git a/fldigi_doxygen/images/main-dialog-browser.png b/fldigi_doxygen/images/main-dialog-browser.png new file mode 100644 index 00000000..86b60587 Binary files /dev/null and b/fldigi_doxygen/images/main-dialog-browser.png differ diff --git a/fldigi_doxygen/images/main-dialog-newinstall.png b/fldigi_doxygen/images/main-dialog-newinstall.png new file mode 100644 index 00000000..f7dc8ee2 Binary files /dev/null and b/fldigi_doxygen/images/main-dialog-newinstall.png differ diff --git a/fldigi_doxygen/images/menu-8psk.png b/fldigi_doxygen/images/menu-8psk.png new file mode 100644 index 00000000..e5adcea5 Binary files /dev/null and b/fldigi_doxygen/images/menu-8psk.png differ diff --git a/fldigi_doxygen/images/menu-configure.png b/fldigi_doxygen/images/menu-configure.png new file mode 100644 index 00000000..fd083bce Binary files /dev/null and b/fldigi_doxygen/images/menu-configure.png differ diff --git a/fldigi_doxygen/images/menu-contestia.png b/fldigi_doxygen/images/menu-contestia.png new file mode 100644 index 00000000..7e49ce0d Binary files /dev/null and b/fldigi_doxygen/images/menu-contestia.png differ diff --git a/fldigi_doxygen/images/menu-dominoex.png b/fldigi_doxygen/images/menu-dominoex.png new file mode 100644 index 00000000..5ed75e61 Binary files /dev/null and b/fldigi_doxygen/images/menu-dominoex.png differ diff --git a/fldigi_doxygen/images/menu-files-audio.png b/fldigi_doxygen/images/menu-files-audio.png new file mode 100644 index 00000000..f520a651 Binary files /dev/null and b/fldigi_doxygen/images/menu-files-audio.png differ diff --git a/fldigi_doxygen/images/menu-files-config-scripts.png b/fldigi_doxygen/images/menu-files-config-scripts.png new file mode 100644 index 00000000..c379621a Binary files /dev/null and b/fldigi_doxygen/images/menu-files-config-scripts.png differ diff --git a/fldigi_doxygen/images/menu-files-folders.png b/fldigi_doxygen/images/menu-files-folders.png new file mode 100644 index 00000000..c869feb5 Binary files /dev/null and b/fldigi_doxygen/images/menu-files-folders.png differ diff --git a/fldigi_doxygen/images/menu-files-macros.png b/fldigi_doxygen/images/menu-files-macros.png new file mode 100644 index 00000000..84def8c5 Binary files /dev/null and b/fldigi_doxygen/images/menu-files-macros.png differ diff --git a/fldigi_doxygen/images/menu-files-menu.png b/fldigi_doxygen/images/menu-files-menu.png new file mode 100644 index 00000000..38d9ee1b Binary files /dev/null and b/fldigi_doxygen/images/menu-files-menu.png differ diff --git a/fldigi_doxygen/images/menu-files-text.png b/fldigi_doxygen/images/menu-files-text.png new file mode 100644 index 00000000..d096075f Binary files /dev/null and b/fldigi_doxygen/images/menu-files-text.png differ diff --git a/fldigi_doxygen/images/menu-hell.png b/fldigi_doxygen/images/menu-hell.png new file mode 100644 index 00000000..b1d20c0a Binary files /dev/null and b/fldigi_doxygen/images/menu-hell.png differ diff --git a/fldigi_doxygen/images/menu-help.png b/fldigi_doxygen/images/menu-help.png new file mode 100644 index 00000000..3ead59f3 Binary files /dev/null and b/fldigi_doxygen/images/menu-help.png differ diff --git a/fldigi_doxygen/images/menu-linux.png b/fldigi_doxygen/images/menu-linux.png new file mode 100644 index 00000000..42185bdb Binary files /dev/null and b/fldigi_doxygen/images/menu-linux.png differ diff --git a/fldigi_doxygen/images/menu-logbook-adif.png b/fldigi_doxygen/images/menu-logbook-adif.png new file mode 100644 index 00000000..07cee68d Binary files /dev/null and b/fldigi_doxygen/images/menu-logbook-adif.png differ diff --git a/fldigi_doxygen/images/menu-logbook-reports.png b/fldigi_doxygen/images/menu-logbook-reports.png new file mode 100644 index 00000000..fbc948e9 Binary files /dev/null and b/fldigi_doxygen/images/menu-logbook-reports.png differ diff --git a/fldigi_doxygen/images/menu-logbook.png b/fldigi_doxygen/images/menu-logbook.png new file mode 100644 index 00000000..50fa38a3 Binary files /dev/null and b/fldigi_doxygen/images/menu-logbook.png differ diff --git a/fldigi_doxygen/images/menu-mfsk.png b/fldigi_doxygen/images/menu-mfsk.png new file mode 100644 index 00000000..2c6d6eb3 Binary files /dev/null and b/fldigi_doxygen/images/menu-mfsk.png differ diff --git a/fldigi_doxygen/images/menu-mt63.png b/fldigi_doxygen/images/menu-mt63.png new file mode 100644 index 00000000..c783abfc Binary files /dev/null and b/fldigi_doxygen/images/menu-mt63.png differ diff --git a/fldigi_doxygen/images/menu-navtex.png b/fldigi_doxygen/images/menu-navtex.png new file mode 100644 index 00000000..440d7bd5 Binary files /dev/null and b/fldigi_doxygen/images/menu-navtex.png differ diff --git a/fldigi_doxygen/images/menu-olivia.png b/fldigi_doxygen/images/menu-olivia.png new file mode 100644 index 00000000..1aaf6abc Binary files /dev/null and b/fldigi_doxygen/images/menu-olivia.png differ diff --git a/fldigi_doxygen/images/menu-opmode.png b/fldigi_doxygen/images/menu-opmode.png new file mode 100644 index 00000000..058e23a5 Binary files /dev/null and b/fldigi_doxygen/images/menu-opmode.png differ diff --git a/fldigi_doxygen/images/menu-popup-edit-field.png b/fldigi_doxygen/images/menu-popup-edit-field.png new file mode 100644 index 00000000..6e883411 Binary files /dev/null and b/fldigi_doxygen/images/menu-popup-edit-field.png differ diff --git a/fldigi_doxygen/images/menu-psk-multi-carrier.png b/fldigi_doxygen/images/menu-psk-multi-carrier.png new file mode 100644 index 00000000..61d0cb1c Binary files /dev/null and b/fldigi_doxygen/images/menu-psk-multi-carrier.png differ diff --git a/fldigi_doxygen/images/menu-psk.png b/fldigi_doxygen/images/menu-psk.png new file mode 100644 index 00000000..c5e6a13e Binary files /dev/null and b/fldigi_doxygen/images/menu-psk.png differ diff --git a/fldigi_doxygen/images/menu-pskr.png b/fldigi_doxygen/images/menu-pskr.png new file mode 100644 index 00000000..59dd89fb Binary files /dev/null and b/fldigi_doxygen/images/menu-pskr.png differ diff --git a/fldigi_doxygen/images/menu-qpsk.png b/fldigi_doxygen/images/menu-qpsk.png new file mode 100644 index 00000000..996fea44 Binary files /dev/null and b/fldigi_doxygen/images/menu-qpsk.png differ diff --git a/fldigi_doxygen/images/menu-rtty.png b/fldigi_doxygen/images/menu-rtty.png new file mode 100644 index 00000000..c6ec9861 Binary files /dev/null and b/fldigi_doxygen/images/menu-rtty.png differ diff --git a/fldigi_doxygen/images/menu-rx-popup-contest-long.png b/fldigi_doxygen/images/menu-rx-popup-contest-long.png new file mode 100644 index 00000000..4d5227fb Binary files /dev/null and b/fldigi_doxygen/images/menu-rx-popup-contest-long.png differ diff --git a/fldigi_doxygen/images/menu-rx-popup-contest-short.png b/fldigi_doxygen/images/menu-rx-popup-contest-short.png new file mode 100644 index 00000000..0b104f71 Binary files /dev/null and b/fldigi_doxygen/images/menu-rx-popup-contest-short.png differ diff --git a/fldigi_doxygen/images/menu-rx-popup-long.png b/fldigi_doxygen/images/menu-rx-popup-long.png new file mode 100644 index 00000000..448d5649 Binary files /dev/null and b/fldigi_doxygen/images/menu-rx-popup-long.png differ diff --git a/fldigi_doxygen/images/menu-rx-popup-short.png b/fldigi_doxygen/images/menu-rx-popup-short.png new file mode 100644 index 00000000..9c0ca127 Binary files /dev/null and b/fldigi_doxygen/images/menu-rx-popup-short.png differ diff --git a/fldigi_doxygen/images/menu-scan.png b/fldigi_doxygen/images/menu-scan.png new file mode 100644 index 00000000..20d1eb1f Binary files /dev/null and b/fldigi_doxygen/images/menu-scan.png differ diff --git a/fldigi_doxygen/images/menu-thor.png b/fldigi_doxygen/images/menu-thor.png new file mode 100644 index 00000000..61c23884 Binary files /dev/null and b/fldigi_doxygen/images/menu-thor.png differ diff --git a/fldigi_doxygen/images/menu-throb.png b/fldigi_doxygen/images/menu-throb.png new file mode 100644 index 00000000..79ff1c63 Binary files /dev/null and b/fldigi_doxygen/images/menu-throb.png differ diff --git a/fldigi_doxygen/images/menu-tx-popup.png b/fldigi_doxygen/images/menu-tx-popup.png new file mode 100644 index 00000000..69875630 Binary files /dev/null and b/fldigi_doxygen/images/menu-tx-popup.png differ diff --git a/fldigi_doxygen/images/menu-tx-popup2.png b/fldigi_doxygen/images/menu-tx-popup2.png new file mode 100644 index 00000000..a061e710 Binary files /dev/null and b/fldigi_doxygen/images/menu-tx-popup2.png differ diff --git a/fldigi_doxygen/images/menu-view-controls.png b/fldigi_doxygen/images/menu-view-controls.png new file mode 100644 index 00000000..8a7af5fd Binary files /dev/null and b/fldigi_doxygen/images/menu-view-controls.png differ diff --git a/fldigi_doxygen/images/menu-view-waterfall.png b/fldigi_doxygen/images/menu-view-waterfall.png new file mode 100644 index 00000000..7e82b7af Binary files /dev/null and b/fldigi_doxygen/images/menu-view-waterfall.png differ diff --git a/fldigi_doxygen/images/menu-view.png b/fldigi_doxygen/images/menu-view.png new file mode 100644 index 00000000..f663269e Binary files /dev/null and b/fldigi_doxygen/images/menu-view.png differ diff --git a/fldigi_doxygen/images/menu-wefax.png b/fldigi_doxygen/images/menu-wefax.png new file mode 100644 index 00000000..e03d7d1c Binary files /dev/null and b/fldigi_doxygen/images/menu-wefax.png differ diff --git a/fldigi_doxygen/images/menu_op_mode_packet.png b/fldigi_doxygen/images/menu_op_mode_packet.png new file mode 100644 index 00000000..602893ff Binary files /dev/null and b/fldigi_doxygen/images/menu_op_mode_packet.png differ diff --git a/fldigi_doxygen/images/mfsk-9db-x2.png b/fldigi_doxygen/images/mfsk-9db-x2.png new file mode 100644 index 00000000..b74253fd Binary files /dev/null and b/fldigi_doxygen/images/mfsk-9db-x2.png differ diff --git a/fldigi_doxygen/images/mfsk-9db.png b/fldigi_doxygen/images/mfsk-9db.png new file mode 100644 index 00000000..bbf17518 Binary files /dev/null and b/fldigi_doxygen/images/mfsk-9db.png differ diff --git a/fldigi_doxygen/images/mfskpix-bee.png b/fldigi_doxygen/images/mfskpix-bee.png new file mode 100644 index 00000000..54ef0338 Binary files /dev/null and b/fldigi_doxygen/images/mfskpix-bee.png differ diff --git a/fldigi_doxygen/images/middle.png b/fldigi_doxygen/images/middle.png new file mode 100644 index 00000000..1aabe217 Binary files /dev/null and b/fldigi_doxygen/images/middle.png differ diff --git a/fldigi_doxygen/images/mt63-1000.png b/fldigi_doxygen/images/mt63-1000.png new file mode 100644 index 00000000..00d30f49 Binary files /dev/null and b/fldigi_doxygen/images/mt63-1000.png differ diff --git a/fldigi_doxygen/images/mt63-500.png b/fldigi_doxygen/images/mt63-500.png new file mode 100644 index 00000000..3dd7128a Binary files /dev/null and b/fldigi_doxygen/images/mt63-500.png differ diff --git a/fldigi_doxygen/images/narrow.png b/fldigi_doxygen/images/narrow.png new file mode 100644 index 00000000..86d87799 Binary files /dev/null and b/fldigi_doxygen/images/narrow.png differ diff --git a/fldigi_doxygen/images/properties-mint-1.png b/fldigi_doxygen/images/properties-mint-1.png new file mode 100644 index 00000000..6a416c4d Binary files /dev/null and b/fldigi_doxygen/images/properties-mint-1.png differ diff --git a/fldigi_doxygen/images/properties-mint.png b/fldigi_doxygen/images/properties-mint.png new file mode 100644 index 00000000..da206cf8 Binary files /dev/null and b/fldigi_doxygen/images/properties-mint.png differ diff --git a/fldigi_doxygen/images/properties-win8-1.png b/fldigi_doxygen/images/properties-win8-1.png new file mode 100644 index 00000000..6cdba0ca Binary files /dev/null and b/fldigi_doxygen/images/properties-win8-1.png differ diff --git a/fldigi_doxygen/images/properties-win8-2.png b/fldigi_doxygen/images/properties-win8-2.png new file mode 100644 index 00000000..c456d259 Binary files /dev/null and b/fldigi_doxygen/images/properties-win8-2.png differ diff --git a/fldigi_doxygen/images/properties-win8.png b/fldigi_doxygen/images/properties-win8.png new file mode 100644 index 00000000..62bcf929 Binary files /dev/null and b/fldigi_doxygen/images/properties-win8.png differ diff --git a/fldigi_doxygen/images/psk-signal-oscope.png b/fldigi_doxygen/images/psk-signal-oscope.png new file mode 100644 index 00000000..d5ee73e8 Binary files /dev/null and b/fldigi_doxygen/images/psk-signal-oscope.png differ diff --git a/fldigi_doxygen/images/psk-signal-waterfall.png b/fldigi_doxygen/images/psk-signal-waterfall.png new file mode 100644 index 00000000..0849588b Binary files /dev/null and b/fldigi_doxygen/images/psk-signal-waterfall.png differ diff --git a/fldigi_doxygen/images/psk-waterfallx1.png b/fldigi_doxygen/images/psk-waterfallx1.png new file mode 100644 index 00000000..419361f7 Binary files /dev/null and b/fldigi_doxygen/images/psk-waterfallx1.png differ diff --git a/fldigi_doxygen/images/psk-waterfallx2.png b/fldigi_doxygen/images/psk-waterfallx2.png new file mode 100644 index 00000000..44737e73 Binary files /dev/null and b/fldigi_doxygen/images/psk-waterfallx2.png differ diff --git a/fldigi_doxygen/images/psk-waterfallx4.png b/fldigi_doxygen/images/psk-waterfallx4.png new file mode 100644 index 00000000..5d313e40 Binary files /dev/null and b/fldigi_doxygen/images/psk-waterfallx4.png differ diff --git a/fldigi_doxygen/images/qpsk-signal-oscope.png b/fldigi_doxygen/images/qpsk-signal-oscope.png new file mode 100644 index 00000000..e5d26f13 Binary files /dev/null and b/fldigi_doxygen/images/qpsk-signal-oscope.png differ diff --git a/fldigi_doxygen/images/qpsk-signal-waterfall.png b/fldigi_doxygen/images/qpsk-signal-waterfall.png new file mode 100644 index 00000000..1d75e2db Binary files /dev/null and b/fldigi_doxygen/images/qpsk-signal-waterfall.png differ diff --git a/fldigi_doxygen/images/rtty-spectrum.png b/fldigi_doxygen/images/rtty-spectrum.png new file mode 100644 index 00000000..5885f6cb Binary files /dev/null and b/fldigi_doxygen/images/rtty-spectrum.png differ diff --git a/fldigi_doxygen/images/rtty-transmit.png b/fldigi_doxygen/images/rtty-transmit.png new file mode 100644 index 00000000..4cd0bb4c Binary files /dev/null and b/fldigi_doxygen/images/rtty-transmit.png differ diff --git a/fldigi_doxygen/images/rtty_overdrive.png b/fldigi_doxygen/images/rtty_overdrive.png new file mode 100644 index 00000000..ed648410 Binary files /dev/null and b/fldigi_doxygen/images/rtty_overdrive.png differ diff --git a/fldigi_doxygen/images/script_error_log_entry.png b/fldigi_doxygen/images/script_error_log_entry.png new file mode 100644 index 00000000..ec08e855 Binary files /dev/null and b/fldigi_doxygen/images/script_error_log_entry.png differ diff --git a/fldigi_doxygen/images/script_restart_notice.png b/fldigi_doxygen/images/script_restart_notice.png new file mode 100644 index 00000000..c6a5b168 Binary files /dev/null and b/fldigi_doxygen/images/script_restart_notice.png differ diff --git a/fldigi_doxygen/images/script_warning_dialogbox.png b/fldigi_doxygen/images/script_warning_dialogbox.png new file mode 100644 index 00000000..095fc8c0 Binary files /dev/null and b/fldigi_doxygen/images/script_warning_dialogbox.png differ diff --git a/fldigi_doxygen/images/show-popup.png b/fldigi_doxygen/images/show-popup.png new file mode 100644 index 00000000..4b349ec8 Binary files /dev/null and b/fldigi_doxygen/images/show-popup.png differ diff --git a/fldigi_doxygen/images/show-popup2.png b/fldigi_doxygen/images/show-popup2.png new file mode 100644 index 00000000..43478331 Binary files /dev/null and b/fldigi_doxygen/images/show-popup2.png differ diff --git a/fldigi_doxygen/images/sql_kpsql_kiss_io_disabled.png b/fldigi_doxygen/images/sql_kpsql_kiss_io_disabled.png new file mode 100644 index 00000000..5ebc9e11 Binary files /dev/null and b/fldigi_doxygen/images/sql_kpsql_kiss_io_disabled.png differ diff --git a/fldigi_doxygen/images/sql_kpsql_kiss_io_enabled.png b/fldigi_doxygen/images/sql_kpsql_kiss_io_enabled.png new file mode 100644 index 00000000..1f7df1d8 Binary files /dev/null and b/fldigi_doxygen/images/sql_kpsql_kiss_io_enabled.png differ diff --git a/fldigi_doxygen/images/sql_kpsql_level_control.png b/fldigi_doxygen/images/sql_kpsql_level_control.png new file mode 100644 index 00000000..0f973790 Binary files /dev/null and b/fldigi_doxygen/images/sql_kpsql_level_control.png differ diff --git a/fldigi_doxygen/images/stereo-plug.png b/fldigi_doxygen/images/stereo-plug.png new file mode 100644 index 00000000..e3a3c311 Binary files /dev/null and b/fldigi_doxygen/images/stereo-plug.png differ diff --git a/fldigi_doxygen/images/support_data_dialog.png b/fldigi_doxygen/images/support_data_dialog.png new file mode 100644 index 00000000..ae1f783e Binary files /dev/null and b/fldigi_doxygen/images/support_data_dialog.png differ diff --git a/fldigi_doxygen/images/support_data_menu_item.png b/fldigi_doxygen/images/support_data_menu_item.png new file mode 100644 index 00000000..e8efb899 Binary files /dev/null and b/fldigi_doxygen/images/support_data_menu_item.png differ diff --git a/fldigi_doxygen/images/symbols.png b/fldigi_doxygen/images/symbols.png new file mode 100644 index 00000000..853f9eb5 Binary files /dev/null and b/fldigi_doxygen/images/symbols.png differ diff --git a/fldigi_doxygen/images/tty-split-ops.png b/fldigi_doxygen/images/tty-split-ops.png new file mode 100644 index 00000000..0b99766a Binary files /dev/null and b/fldigi_doxygen/images/tty-split-ops.png differ diff --git a/fldigi_doxygen/images/vid-large.png b/fldigi_doxygen/images/vid-large.png new file mode 100644 index 00000000..dcdbd98a Binary files /dev/null and b/fldigi_doxygen/images/vid-large.png differ diff --git a/fldigi_doxygen/images/vid-small.png b/fldigi_doxygen/images/vid-small.png new file mode 100644 index 00000000..7dd254aa Binary files /dev/null and b/fldigi_doxygen/images/vid-small.png differ diff --git a/fldigi_doxygen/images/view-menu.png b/fldigi_doxygen/images/view-menu.png new file mode 100644 index 00000000..d037473f Binary files /dev/null and b/fldigi_doxygen/images/view-menu.png differ diff --git a/fldigi_doxygen/images/visible_modes.png b/fldigi_doxygen/images/visible_modes.png new file mode 100644 index 00000000..78f77804 Binary files /dev/null and b/fldigi_doxygen/images/visible_modes.png differ diff --git a/fldigi_doxygen/images/w1aw-rtty-80.png b/fldigi_doxygen/images/w1aw-rtty-80.png new file mode 100644 index 00000000..5c579a1f Binary files /dev/null and b/fldigi_doxygen/images/w1aw-rtty-80.png differ diff --git a/fldigi_doxygen/images/w4tv/Icom_FSK.png b/fldigi_doxygen/images/w4tv/Icom_FSK.png new file mode 100644 index 00000000..a29e6e01 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/Icom_FSK.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz.png b/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz.png new file mode 100644 index 00000000..8ac9b5d0 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz_2K.png b/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz_2K.png new file mode 100644 index 00000000..3d2ed99a Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz_2K.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz_5K.png b/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz_5K.png new file mode 100644 index 00000000..1647f295 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_70W_1000Hz_5K.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_70W_2stop.png b/fldigi_doxygen/images/w4tv/fldigi_70W_2stop.png new file mode 100644 index 00000000..cb2d0aa4 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_70W_2stop.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_70W_2stop_wide.png b/fldigi_doxygen/images/w4tv/fldigi_70W_2stop_wide.png new file mode 100644 index 00000000..b393e878 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_70W_2stop_wide.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK-1dB.png b/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK-1dB.png new file mode 100644 index 00000000..86d176d9 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK-1dB.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK-1r5dB.png b/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK-1r5dB.png new file mode 100644 index 00000000..75eccd39 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK-1r5dB.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK.png b/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK.png new file mode 100644 index 00000000..0adb3514 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_Icom_AFSK.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz.png b/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz.png new file mode 100644 index 00000000..ef444366 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz_2K.png b/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz_2K.png new file mode 100644 index 00000000..2c7638be Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz_2K.png differ diff --git a/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz_5K.png b/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz_5K.png new file mode 100644 index 00000000..469932d6 Binary files /dev/null and b/fldigi_doxygen/images/w4tv/fldigi_saturated_input_1000Hz_5K.png differ diff --git a/fldigi_doxygen/images/w5zit-ts2000-interface.png b/fldigi_doxygen/images/w5zit-ts2000-interface.png new file mode 100644 index 00000000..3b7aa0f8 Binary files /dev/null and b/fldigi_doxygen/images/w5zit-ts2000-interface.png differ diff --git a/fldigi_doxygen/images/wefax-Receive-Embeded.png b/fldigi_doxygen/images/wefax-Receive-Embeded.png new file mode 100644 index 00000000..5e26a7ba Binary files /dev/null and b/fldigi_doxygen/images/wefax-Receive-Embeded.png differ diff --git a/fldigi_doxygen/images/wefax-rx-window-detached.png b/fldigi_doxygen/images/wefax-rx-window-detached.png new file mode 100644 index 00000000..b3335cfd Binary files /dev/null and b/fldigi_doxygen/images/wefax-rx-window-detached.png differ diff --git a/fldigi_doxygen/images/wefax-tx-rx-embeded.png b/fldigi_doxygen/images/wefax-tx-rx-embeded.png new file mode 100644 index 00000000..ee0741cc Binary files /dev/null and b/fldigi_doxygen/images/wefax-tx-rx-embeded.png differ diff --git a/fldigi_doxygen/images/wide.png b/fldigi_doxygen/images/wide.png new file mode 100644 index 00000000..0c10cf97 Binary files /dev/null and b/fldigi_doxygen/images/wide.png differ diff --git a/fldigi_doxygen/images/wizard-page_1.png b/fldigi_doxygen/images/wizard-page_1.png new file mode 100644 index 00000000..bbb3373f Binary files /dev/null and b/fldigi_doxygen/images/wizard-page_1.png differ diff --git a/fldigi_doxygen/images/wizard-page_2-Operator-Information.png b/fldigi_doxygen/images/wizard-page_2-Operator-Information.png new file mode 100644 index 00000000..20205996 Binary files /dev/null and b/fldigi_doxygen/images/wizard-page_2-Operator-Information.png differ diff --git a/fldigi_doxygen/images/wizard-page_3-AudioDevices-Device.png b/fldigi_doxygen/images/wizard-page_3-AudioDevices-Device.png new file mode 100644 index 00000000..18de73e8 Binary files /dev/null and b/fldigi_doxygen/images/wizard-page_3-AudioDevices-Device.png differ diff --git a/fldigi_doxygen/images/wizard-page_4-txControl-RigCat.png b/fldigi_doxygen/images/wizard-page_4-txControl-RigCat.png new file mode 100644 index 00000000..56900f8a Binary files /dev/null and b/fldigi_doxygen/images/wizard-page_4-txControl-RigCat.png differ diff --git a/fldigi_doxygen/images/wizard-page_5-Tabular-Data.png b/fldigi_doxygen/images/wizard-page_5-Tabular-Data.png new file mode 100644 index 00000000..fb85e041 Binary files /dev/null and b/fldigi_doxygen/images/wizard-page_5-Tabular-Data.png differ diff --git a/fldigi_doxygen/images/wwv1-lgneg.png b/fldigi_doxygen/images/wwv1-lgneg.png new file mode 100644 index 00000000..104a5c13 Binary files /dev/null and b/fldigi_doxygen/images/wwv1-lgneg.png differ diff --git a/fldigi_doxygen/images/wwv2-000ppm.png b/fldigi_doxygen/images/wwv2-000ppm.png new file mode 100644 index 00000000..ce202680 Binary files /dev/null and b/fldigi_doxygen/images/wwv2-000ppm.png differ diff --git a/fldigi_doxygen/images/wwv2-125ppm.png b/fldigi_doxygen/images/wwv2-125ppm.png new file mode 100644 index 00000000..43638eae Binary files /dev/null and b/fldigi_doxygen/images/wwv2-125ppm.png differ diff --git a/fldigi_doxygen/images/wwv2-lgpos.png b/fldigi_doxygen/images/wwv2-lgpos.png new file mode 100644 index 00000000..f7d23448 Binary files /dev/null and b/fldigi_doxygen/images/wwv2-lgpos.png differ diff --git a/fldigi_doxygen/images/wwv3.png b/fldigi_doxygen/images/wwv3.png new file mode 100644 index 00000000..913ac3aa Binary files /dev/null and b/fldigi_doxygen/images/wwv3.png differ diff --git a/fldigi_doxygen/images/xbeg-xend.png b/fldigi_doxygen/images/xbeg-xend.png new file mode 100644 index 00000000..412c3cb7 Binary files /dev/null and b/fldigi_doxygen/images/xbeg-xend.png differ diff --git a/fldigi_doxygen/make_docs.sh b/fldigi_doxygen/make_docs.sh new file mode 100755 index 00000000..14199ef1 --- /dev/null +++ b/fldigi_doxygen/make_docs.sh @@ -0,0 +1,353 @@ +#!/bin/bash +# +# A simple script for creating/archiving doxygen documentation for FLDigi + +PRG_NAME="FLDigi" + +LATEX="0" +DOXY="0" +BUILD_PROG_DOCS="0" +BUILD_USER_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 " + echo "" + echo "default: user" + echo "user: Generate user documentation" + echo "help: This message" + echo "" +} + +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" + TAR=`which tar` + if [ -z $TAR ]; then + echo "***************************************" + echo "* Compression program 'tar' not found *" + echo "***************************************" + return + fi + DIR=`dirname "$2"` + FILE=`basename "$2" .pdf` + ( cd $DIR + $TAR -cvzf "${FILE}_pdf.tgz" "${FILE}.pdf" ) + 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 + + echo "PWD=$PWD" + cd "../$2" + + RESULTS=$(check_dir "$COMP_DIR") + + SAVE_NAME="../compressed_html/$1_html.tgz" + + if [ "$RESULTS" = "1" ]; then + $TAR -cvzf "$SAVE_NAME" "html/" + fi +} + +copy_files() +{ + SRC="images" + DST="user_docs/latex" + + echo "********************************************************" + echo "* Copying required images to LaTeX folder" + echo "* Source $PWD/$SRC" + echo "* Destination $PWD/$DST" + echo "********************************************************" + + cp $SRC/event-log-debug.png $DST/event-log-debug.png + cp $SRC/event-log-error.png $DST/event-log-error.png + cp $SRC/event-log-info.png $DST/event-log-info.png + cp $SRC/event-log-quiet.png $DST/event-log-quiet.png + cp $SRC/event-log-verbose.png $DST/event-log-verbose.png + cp $SRC/event-log-warning.png $DST/event-log-warning.png + cp $SRC/digiscope-psk-nosig.png $DST/digiscope-psk-nosig.png + cp $SRC/digiscope-psk.png $DST/digiscope-psk.png + cp $SRC/digiscope-psk-low.png $DST/digiscope-psk-low.png + cp $SRC/digiscope-psk-high.png $DST/digiscope-psk-high.png + cp $SRC/digiscope-psk-history.png $DST/digiscope-psk-history.png + cp $SRC/digiscope-psk-history-amplitude.png $DST/digiscope-psk-history-amplitude.png + cp $SRC/wwv3.png $DST/wwv3.png + cp $SRC/wwv1-lgneg.png $DST/wwv1-lgneg.png + cp $SRC/wwv2-000ppm.png $DST/wwv2-000ppm.png + cp $SRC/wwv2-lgpos.png $DST/wwv2-lgpos.png + cp $SRC/wwv2-125ppm.png $DST/wwv2-125ppm.png + cp $SRC/dcf77-0.png $DST/dcf77-0.png + cp $SRC/dcf77-0zoom.png $DST/dcf77-0zoom.png + cp $SRC/dcf77-1000.png $DST/dcf77-1000.png + cp $SRC/dcf77-65zoom.png $DST/dcf77-65zoom.png + cp $SRC/RWMpre-cal.png $DST/RWMpre-cal.png + cp $SRC/RWM+25361ppm.png $DST/RWM+25361ppm.png + cp $SRC/RWMpost-cal-x5.png $DST/RWMpost-cal-x5.png + + + DST="user_docs/html" + + echo "********************************************************" + echo "* Copying required images to HTML folder" + echo "* Source $PWD/$SRC" + echo "* Destination $PWD/$DST" + echo "********************************************************" + + cp $SRC/event-log-debug.png $DST/event-log-debug.png + cp $SRC/event-log-error.png $DST/event-log-error.png + cp $SRC/event-log-info.png $DST/event-log-info.png + cp $SRC/event-log-quiet.png $DST/event-log-quiet.png + cp $SRC/event-log-verbose.png $DST/event-log-verbose.png + cp $SRC/event-log-warning.png $DST/event-log-warning.png + cp $SRC/digiscope-psk-nosig.png $DST/digiscope-psk-nosig.png + cp $SRC/digiscope-psk.png $DST/digiscope-psk.png + cp $SRC/digiscope-psk-low.png $DST/digiscope-psk-low.png + cp $SRC/digiscope-psk-high.png $DST/digiscope-psk-high.png + cp $SRC/digiscope-psk-history.png $DST/digiscope-psk-history.png + cp $SRC/digiscope-psk-history-amplitude.png $DST/digiscope-psk-history-amplitude.png + cp $SRC/wwv3.png $DST/wwv3.png + cp $SRC/wwv1-lgneg.png $DST/wwv1-lgneg.png + cp $SRC/wwv2-000ppm.png $DST/wwv2-000ppm.png + cp $SRC/wwv2-lgpos.png $DST/wwv2-lgpos.png + cp $SRC/wwv2-125ppm.png $DST/wwv2-125ppm.png + cp $SRC/dcf77-0.png $DST/dcf77-0.png + cp $SRC/dcf77-0zoom.png $DST/dcf77-0zoom.png + cp $SRC/dcf77-1000.png $DST/dcf77-1000.png + cp $SRC/dcf77-65zoom.png $DST/dcf77-65zoom.png + cp $SRC/RWMpre-cal.png $DST/RWMpre-cal.png + cp $SRC/RWM+25361ppm.png $DST/RWM+25361ppm.png + cp $SRC/RWMpost-cal-x5.png $DST/RWMpost-cal-x5.png + +} + +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 + + HTML="fldigi_${VER_NUM}_user_manual_html" + + make_dir "pdf" + make_dir "compressed_html" + make_dir "user_docs" + make_dir "user_docs/latex" + make_dir "user_docs/html" + make_dir "prog_docs" + make_dir "prog_docs/latex" + make_dir "prog_docs/html" + + ( cd doxygen; copy_files ) + +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_docs + 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 +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" "prog_docs" ) + pdf_docs "../prog_docs/latex" "../../pdf/${PRG_NAME}_${VER_NUM}_Code_Reference.pdf" +) +fi diff --git a/fldigi_doxygen/prog_src_doc/Doxyfile b/fldigi_doxygen/prog_src_doc/Doxyfile new file mode 100644 index 00000000..9322c802 --- /dev/null +++ b/fldigi_doxygen/prog_src_doc/Doxyfile @@ -0,0 +1,54 @@ +# +# +# +# Copyright (C) 2013 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 = "FLDIGI Programmers Manual" +PROJECT_NUMBER = 3.21 +PROJECT_BRIEF = +ALLEXTERNALS = NO +CASE_SENSE_NAMES = NO +DISABLE_INDEX = NO +DOXYFILE_ENCODING = UTF-8 +INPUT_ENCODING = UTF-8 +ENABLE_PREPROCESSING = NO +ENABLED_SECTIONS = logo_on +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRA_PACKAGES = graphicx caption subcaption float +FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.h *.hh *.hxx *.hpp *.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 ../../src +INCLUDE_PATH = . +EXAMPLE_PATH = . +OUTPUT_DIRECTORY = ../prog_docs +OUTPUT_LANGUAGE = English +PDF_HYPERLINKS = YES +PERL_PATH = /usr/bin/perl +QUIET = NO +RECURSIVE = YES +SEARCHENGINE = NO +STRIP_CODE_COMMENTS = NO +TAGFILES = +USE_PDFLATEX = YES +WARNINGS = YES + diff --git a/fldigi_doxygen/prog_src_doc/debug.txt b/fldigi_doxygen/prog_src_doc/debug.txt new file mode 100644 index 00000000..411654ea --- /dev/null +++ b/fldigi_doxygen/prog_src_doc/debug.txt @@ -0,0 +1 @@ +ASSERT: "tok==TK_WHITESPACE" in docparser.cpp (4716) diff --git a/fldigi_doxygen/prog_src_doc/index.txt b/fldigi_doxygen/prog_src_doc/index.txt new file mode 100644 index 00000000..efa47e5c --- /dev/null +++ b/fldigi_doxygen/prog_src_doc/index.txt @@ -0,0 +1,91 @@ +// ===================================================================== +// FLDIGI - Programmers Code Reference Doxygen Main Page Documentation +// +// index.txt +// +// Author(s): +// Robert Stiles, KK5VD, Copyright (C) 2013 +// +// This is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; either version 3 of the License, or +// (at your option) any later version. +// +// This software is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with the program; if not, write to the +// +// Free Software Foundation, Inc. +// 51 Franklin Street, Fifth Floor +// Boston, MA 02110-1301 USA. +// +// ===================================================================== + +/*! + +\mainpage FLDIGI - Programmers Code Reference + +\section depLibs Dependency Libraries +Fast Light Tool Kit Version 1.3.x: + http://fltk.org + +Libsndfile: + http://www.mega-nerd.com/libsndfile/ + +Libsamplerate: + http://www.mega-nerd.com/SRC/ + +Audio input/output: + portaudio: (Mac OSX, and ???) + http://www.portaudio.com + + or (depends on OS type/version) + + pulseaudio: (???) + http://www.freedesktop.org/wiki/Software/PulseAudio + +xmlrpc-c: + http://xmlrpc-c.sourceforge.net + +Hamlib: (optional) + version 1.2.12S: (needed for static linking of driver modules) + + version 1.2.15.3 (latest): (does not support static linking of driver modules) + http://sourceforge.net/apps/mediawiki/hamlib/index.php?title=Main_Page + +png: + http://www.libpng.org + +pkg-config: + http://www.freedesktop.org/wiki/Software/pkg-config + + +Possible other required libs/tools, depends on your OS vendor and development tools. + +libtool: + http://www.gnu.org/software/libtool/ + +jpeg: + http://www.ijg.org + +zlib; + http://www.zlib.net + +gettext: + http://www.gnu.org/software/gettext/ + +automake: + http://www.gnu.org/software/automake/ + +autoconf: + http://www.gnu.org/software/autoconf/ + +m4: + http://www.gnu.org/software/m4/ + +*/ + diff --git a/fldigi_doxygen/user_src_docs/CW.txt b/fldigi_doxygen/user_src_docs/CW.txt new file mode 100644 index 00000000..c244819b --- /dev/null +++ b/fldigi_doxygen/user_src_docs/CW.txt @@ -0,0 +1,129 @@ +/** +\page cw_page CW + +\tableofcontents + +\section cw_freq Carrier Frequency + +Fldigi generates CW by inserting a keyed tone at the current +waterfall audio frequency. The CW carrier frequency is the USB +carrier + the audio frequency, or the LSB carrier - +the audio frequency. If fldigi is tracking and receiving a CW +signal on the waterfall your transmitted signal will be exactly on the +frequency of the other operator. You probably cannot use your +transceivers CW filter unless that filter can be used with the SSB mode.
+
+ +\section qsk_tab_key QSK and the TAB KEY + +If you are operating QSK with a separate transmitter / receiver you can +very quickly stop your transmit signal with the TAB key. In +the CW mode only the TAB key causes the program to skip over the remaining +text in the transmit text buffer. The text that is skipped will +be color coded blue. The program remains in the transmit mode +(PTT enabled), but since the buffer is now empty no A2 CW signal is +generated. Code transmission will then restart with the very +next keyboard closure of a valid CW character. +
+ +\section pause_transmit Pausing transmit + +The Pause/Break momentarily key stops sending text. Pressing it again +resumes transmission. +
+ +\section abort_transmit Aborting transmit + +The Escape key is used to immediately stop text transmission. The Tx buffer +is cleared. +
+ +\section wpm_adjustements WPM adjustment + +In CW mode the status bar is changed to include a transmit WPM adjuster. Use +the arrow buttons or the mouse. Mouse wheel up/down changes transmit WPM +by +/- 1. Hold the shift and mouse mouse wheel changes transmit WPM +by +/- 10. The "*" button immediately to the right of the WPM adjuster is +used to toggle between the current and the default transmit WPM. +
+ +The transmit WPM can also be adjusted with three hot keys: +
+ +
    +
  • Numeric keypad "+" increases the transmit WPM by 1
    • +
  • Numeric keypad "-" decreases the transmit WPM by 1
    • +
  • Numeric keypad "*" toggles between the selected transmit WPM and the +default transmit WPM
    • +
+ +The "Default" control on the CW tab sets that default value. If during a +QSO you needed to slow down to give the other op a better chance to +copy what you are sending, just hit the "*" on the numeric keypad and +the CW code will immediately switch to sending CW at the set default +value (18 wpm in this example). Press the "*" again to return to +back to the CW speed that you were previously using. +
+ +Each time the transmit WPM is changed the receive decoder WPM tracking +is reset to the new transmit WPM. This allows you to quickly +force the decoder to a new WPM range. +
+ +\image html cw_status_1.png "The Rx and Tx WPM are shown in the status bar." +\image latex cw_status_1.png "The Rx and Tx WPM are shown in the status bar." width=2.2in + +
+ +\image html cw_status_2.png "* indicates that default WPM is selected" +\image latex cw_status_2.png "* indicates that default WPM is selected" width=3.0in + +\section sec_farnsworth Farnsworth keying + +You might want to use farnsworth keying to provide a character rate that is +faster than the word per minute rate.
+ +\image html farnsworth.png "Farnworth Timing" +\image latex farnsworth.png "Farnworth Timing" width=5.0in +
+ +Set the F-WPM slider to tthe character rate and enable the Use +Farnsworth timing check box. When the TX WPM is set to a speed +below the Farnsworth value then the character rate will be at the +Farnsworth setting and the word rate will be at the TX WPM rate. +You can also set the TX WPM and F-WPM from within a \ref macro_page. +
+ +\section cw_config CW configuration + +The \ref cw_configuration_page is easily reached from the Config menu or +by right clicking on the left most entry in the status bar (CW). +
+ +\section sub_prosigns Prosigns + +The prosigns are configurable \(see \ref cw_configuration_page \). The +defaults are: +
+ +PROSIGN | KEYBOARD | DISPLAYED AS +:------: | :-------: | :--------: +BT | = | \ +AA | ~ | \ +AR | > | \ +AS | < | \ +HM | { | \ +INT | & | \ +SK | % | \ +KN | + | \ +VE | } | \ + + + +
+\ref cw_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/CWkeying.txt b/fldigi_doxygen/user_src_docs/CWkeying.txt new file mode 100644 index 00000000..f7afdc5c --- /dev/null +++ b/fldigi_doxygen/user_src_docs/CWkeying.txt @@ -0,0 +1,70 @@ +/** +\page cw_keying_page CW Keying + +\tableofcontents + +\image html config-cw-qsk.png "Timing and QSK" +\image latex config-cw-qsk.png "Timing and QSK" width=5.0in +
+ +Click on the Configure menu item to open the fldigi configuration +dialog. Click on the Modems tab and then on the QSK tab. + +
    +
  1. Set the Pre Timing and Post Timing to zero.
    2. +
  2. Activate the QSK feature by clicking "QSK on right channel".
    3. +
+ +Click the CW tab and adjust the CW settings to your preference. Use the Test +char and the Send continuous controls to ease the adjustment process. +
+ +FLdigi is now ready to generate a 1600 hertz CW tone on the right channel of +the stereo audio out of your sound card. +
+ +The left channel will be the normal raised cosine shaped CW wave form +that you may use for your side tone. +
+ +The following circuit may be used to take the FLdigi QSK OUT signal from the +right channel of your SOUND CARD to key your transmitter or a QSK circuit. +
+ +\image html CWkeyingCircuit.png "CW Keying Circuit" +\image latex CWkeyingCircuit.png "CW Keying Circuit" width=6.5in +
+ + +NOTE: +L1 - Radio Shack has two items that may be used for this isolation transformer. +
+ +
    +
  • Catalog # 270-054
    • +
  • Catalog # 273-1374
    • +
+ +Attach an audio cable from the Rt. Channel out of the your computer's +SOUND CARD to the input of this QSK INTERFACE CIRCUIT (input of L1). + +Attach another cable from the output of this circuit to your Rig's Keying +Jack.mall> + +Every CW tone that is generated by FLdigi is rectified by this +FULL WAVE VOLTAGE DOUBLER circuit. The resultant voltage turns the Q1 +transistor on and "grounds" the collector, which takes the RIG'S CW +KEYING JACK to ground and "keys" the transmitter. + +You can adjust the start and stop timing of the QSK circuit relative to the +CW waveform with the "pre" and "post" settings. + + +
+\ref cw_keying_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + diff --git a/fldigi_doxygen/user_src_docs/ConfigID.txt b/fldigi_doxygen/user_src_docs/ConfigID.txt new file mode 100644 index 00000000..477c38e2 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigID.txt @@ -0,0 +1,126 @@ +/** +\page id_configuration_page RSID / Video / ID Configuration + +\tableofcontents + +\image html config-id-rsid.png "RSID Config Panel" +\image latex config-id-rsid.png "RSID Config Panel" width=5.0in + +Fldigi offers several ways to identify the operator or mode that is being +used. This is particularly useful when using a hard to recognize +mode such as \ref thor_page "Thor", \ref olivia_page "Olivia" +or \ref mt63_page "MT63". +
+ +\section subsec_reed_solomon_id Reed Solomon Identifier + +RSID, Reed Solomon IDentifier +is a special transmission designed by Patrick Lindecker, F6CTE, for the +modem program MultiPsk. It has been adapted to other modem +programs. Fldigi's implementation is compatible with the MultiPsk +RSID, but provides a slight variation. You can transmit RSID at +both the beginning and end of a transmission. The detection of +RSID normally only occurs in the near vicinity of the current waterfall +tracking point. This cuts down on extraneous RSID detections when the +band is crowded and several RSID signals might be present. If you want +fldigi to search the entire waterfall for RSID signals you can do so by +enabling the "Detector searches entire passband". You start the +search for a signal based on RSID by using the main panel switch. +The RSID detector is a separate decoder that operates in parallel with all +other modem decoders. If you select the "Mark previous frequency and +mode" a restore link will be inserted into the RX text upon detecting +an RSID signal. Clicking on this link restores the previous +frequency and mode of operation. You elect to disable the RSID +upon first detection. You also have the option of just receiving +notification when an RSID signal is detected. The notification +occurs with a pop-up message box. +
+ +You can select which modes will include the transmitted RS identifier, +and which modes will react to a received and decoded RS identifier. +
+ +The mode to identifier relationships are selected by pressing the associated +"modes" button. + +\image html config-id-rx-modes.png "Receive Modes" +\image latex config-id-rx-modes.png "Receive Modes" width=2.37in +
+ +\image html config-id-xmt-modes.png "Transmit Modes" +\image latex config-id-xmt-modes.png "Transmit Modes" width=2.37in + +\section subsec_video_text Video Text +
+ +Transmitted video text will appear as a sequence of characters on the +waterfall.The text can be a brief mode identifier or some user specified +text. You can use a small font that always appears as a 2 +character wide sequence or a larger font that can be 1 to 4 characters +wide. You should be aware that the video signal is a constant +energy signal and the content will be spread across multiple +characters. The highest s/n at the receiving end will be for 1 +character wide video. Small font at 2 character width is next in +s/n performance followed by 2 character large font etc. You can +select which modes will include the video text preamble. You can +limit the horizontal (frequency width) of the video signal in one of +several inclusive ways. +
+ +
    +
  • Number of characters per row of text
    • +
  • Constrain to be less than or equal to 500 Hz
    • +
  • Constrain to be within the bandwidth limits of the mode in use
    • +
+ +Fldigi uses abbreviated acronyms for the mode and it's characteristics +when you are transmitting the mode ID using a video text. Here +are two examples, one in small and the other in large font.
+ +\image html vid-small.png "Small Font" +\image latex vid-small.png "Small Font" width=1.2in +
+ +\image html vid-large.png "Large Font" +\image latex vid-large.png "Large Font" width=2.3in +
+ +Notice that Olivia 16-500 is abbreviated to OL-16/500 and that the +number of characters is limited to 8 per row. You might want to +use the large characters by default if you routinely have QSO's with +operators using older digital mode programs or one whose waterfall +visual is not on a par with fldigi's. +
+ +\image html config-id-video.png "Video ID Config Panel" +\image latex config-id-video.png "Video ID Config Panel" width=5.0in +
+ +\image html config-id-video-modes.png "Video ID Modes" +\image latex config-id-video-modes.png "Video ID Modes" width=1.8in + +\section subsec_cw_postamble CW Postamble +
+ +You can transmit your callsign in CW as a postamble to all modes except of +CW (a bit redundant to do that). You can select which modes will +include the CW postamble. +
+ +
+\image html config-id-cw.png "CW Postamble ID Config Panel" +\image latex config-id-cw.png "CW Postamble ID Config Panel" width=5.0in +
+ +\image html config-id-cw-modes.png "CW ID Modes" +\image latex config-id-cw-modes.png "CW ID Modes" width=1.7in +
+ +
+ +\ref id_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/ConfigMisc.txt b/fldigi_doxygen/user_src_docs/ConfigMisc.txt new file mode 100644 index 00000000..a45c3409 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigMisc.txt @@ -0,0 +1,202 @@ +/** +\page miscellaneous_configuration_page Miscellaneous Configuration +\tableofcontents +
+ +\section subsec_sweet_spot Sweet spot +
+ +\image html config-misc-sweet.png "Misc Sweet Spot Config" +\image latex config-misc-sweet.png "Misc Sweet Spot Config" width=5.0in +
+ +The sweet spot is the audio frequency at which your transceiver +provides the best filtering for a particular signal type. You can +specify the value of the sweet spot for CW, RTTY and all others. +You can also elect to have the audio cursor placed at the sweet +spot when changing modes. The sweet spot is used for the +\ref operating_controls_page "QSY function". + +The K3 A1A lower sideband can be selected for any transceiver that only +provides LSB in the CW mode. +
+ +\section subsec_callsig_spotting Callsign spotting +
+\image html config-misc-spotting.png "Callsign spotting" +\image latex config-misc-spotting.png "Callsign spotting" width=5.0in +
+ +Fldigi allows you to automatically participate in a spotting network +maintained by Philip Gladstone. You can see what the web based reporter +looks like by visiting this web site: http://pskreporter.info/pskmap?W1HKJ +or by simply selecting the menu item "Help / Reception reports...". +
+ +Fldigi will continuously scan for spotted callsigns in the decoded text and +send reports in the background if you check the "Automat..." option. +
+ +Reports will also (or only) be sent when you log the QSO into the logbook. +
+ +If you have rig control enabled the reported rig frequency will also be +sent to the spotting network. Do not change the Host and Port +numbers unless these are changed by Philip. +
+ +You need to press the Initialize to begin reporting spot information. +You will receive a warning message if you did not enter your antenna +information on the Operator tab. +
+ +If your CPU performance is marginal you can disable spotting when no +signal browser is visible. +
+ +\section subsec_cpu_performance CPU performance +
+ +\image html config-misc-cpu.png "Misc CPU" +\image latex config-misc-cpu.png "Misc CPU" width=5.0in +
+ +When fldigi is executed for the first time it does some tests to determine +the performance factor for your central processor unit. If it +determines that the cpu is below a critical speed it tries to +compensate by modifying some of its timing and algorithms. If you +are using a "slow" cpu the "Slow cpu" check box will be enabled. +You can also manually check this box if you find that fldigi is +not performing well on some of the more esoteric modes such as PSK250, +MFSK32, etc. +
+ + +\section subsec_text_io Text i/o +
+ +\image html config-misc-textio.png "Misc Text I/O" +\image latex config-misc-textio.png "Misc Text I/O" width=5.0in +
+ +Fldigi can perform automatic capture of the Rx text stream. The simplest +is to simply capture all incoming text to a file. Select this +from the lower of the two frames. The Rx file is named +"textout.txt" and is written to the directory as shown above. The +file can be used to review an execution session, or it can be accessed +by an external program. For example it could be parsed to provide +a text to speech conversion. +
+ +\section subsec_nbems_flxxx_interface NBEMS (flmsg / flwrap) interface +
+ +\image html config-misc-nbems.png "Config Misc NBEMS" +\image latex config-misc-nbems.png "Config Misc NBEMS" width=5.0in +
+ +The NBEMS suite of programs, fldigi, flarq, flwrap and flmsg provide the +emergency operator with a set of tools to assist in the transfer of data files +over HF and VHF radio.Additional information on flarq is available here: +
+ + + +The reception of a flwrap and flmsg files can be automated by selecting +the "Enable detection & extraction" option. The wrap program +can then be used to test for validity and data extraction at some later +time. fldigi can recognize flmsg data files and automatically +open the flmsg program with the newly received data stream. It +can also transfer the data stream to flmsg and instruct flmsg to save +the data file, unwrap and decode it, display the data in a fully +formatted html page and then exit. Pressing "Locate flmsg" +performs differently on the different OS that are supported. +
+ +
    +
  • Linux - a file finder is opened to the /usr/local/bin/ +folder. Select the flmsg executable and the entry box is +correctly populated
    • + +
  • Windows - a file finder is opened to the "C:\Program Files\" +folder. Drill down to the most current flmsg folder and then +select the flmsg.exe file. The entry box will be correctly +populated.
    • + +
  • OS X - a file browser is opened to the "Applications" +folder. Locate the flmsg icon, and right click on it. +Select "Show Package Contents". Double click "Contents". +Double click on "MacOS". You will be viewing an icon labeled +"flmsg". Drag and drop the icon on to the "flmsg:" entry box and +the the value will be correctly entered.
    • +
+ +\section subsec_dtmf_decoding DTMF decoding +
+ +\image html config-misc-dtmf.png "Misc DTMF Decoding" +\image latex config-misc-dtmf.png "Misc DTMF Decoding" width=5.0in +
+ +Fldigi can encode and decode DTMF tone sequences. Enable this check box +to display the decoded tone sequence in the Rx panel. DTMF encoding is +accomplished by a \ref macros_sub_page "MACRO" tag.
+
+ +\section subsec_wx_rss_xml WX rss-xml queries +
+ +\image html config-WX.png "Misc WX" +\image latex config-WX.png "Misc WX" width=5.0in +
+ +Fldigi provides an automated query of a specified RSS-XML feed to obtain and +format weather data. The report is added to the transmit text stream +using the appropriate \ref macros_sub_page "MACRO" tag. The report +for the above configuration is: +
+ +\verbatim +Huntsville, Madison County Executive Airport, AL, United States (KMDQ) 34-51-41N 086-33-26W +Cond: overcast +Wind: 210 at 12 mph 19 kph +Temp: 62 F 17 C +Baro: 30.04 in Hg 1017 mbar +\endverbatim + +The full report option creates this report: + +\verbatim +Huntsville, Madison County Executive Airport, AL, United States (KMDQ) 34-51-41N 086-33-26W +Feb 29, 2012 - 07:15 AM EST / 2012.02.29 1215 UTC +Wind: from the SSW (210 degrees) at 12 MPH (10 KT) gusting to 17 MPH (15 KT):0 +Visibility: 10 mile(s):0 +Sky conditions: overcast +Temperature: 62 F (17 C) +Dew Point: 60 F (16 C) +Relative Humidity: 93% +Pressure (altimeter): 30.04 in. Hg (1017 hPa) +\endverbatim +
+ +The "Search on web" button will open your browser toGreg Thompson's +global listing +of METAR station. +
+ +RSS feeds for world wide airports can be searched here + +http://www.airrouting.com/content/AirportLocatorForm.aspx. +
+ +\ref miscellaneous_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + + diff --git a/fldigi_doxygen/user_src_docs/ConfigOperator.txt b/fldigi_doxygen/user_src_docs/ConfigOperator.txt new file mode 100644 index 00000000..74121201 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigOperator.txt @@ -0,0 +1,36 @@ +/** +\page operator_configuration_page Configure Operator +\tableofcontents +
+ +\image html config-operator.png "Operator" +\image latex config-operator.png "Operator" width=5.0in + +Enter your personal information on the Operator tab of the +configuration dialog. This information is used by some of +the macro expanders. +
+ +\par NOTE: + Thor and DominoEX secondary text field are initially set to the + operator callsign. On subsequent changes to the callsign, these fields are + not updated. See \ref thor_configuration_page and + \ref domino_ex_configuration_page for the location of the secondary text + entry fields. + +The antenna information is required if you elect to report to the spotting web +site, PSK reporter. +
+ +Your locator data is also used for automatically computing Azimuth to a +remote locator when that is available from an on-line database Call query. +
+ +
+\ref operator_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + diff --git a/fldigi_doxygen/user_src_docs/ConfigUI-WF-controls.txt b/fldigi_doxygen/user_src_docs/ConfigUI-WF-controls.txt new file mode 100644 index 00000000..22a8e254 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigUI-WF-controls.txt @@ -0,0 +1,32 @@ +/** +\page ui_configuration_waterfall_controls_page User Interface Configuration - WF Controls + +\tableofcontents + +\image html config-ui-tabs.png "UI Tabs" +\image latex config-ui-tabs.png "UI Tabs" width=5.0in +
+ +\image html config-ui-wf-controls.png "UI Configure - WF Controls" +\image latex config-ui-wf-controls.png "UI Configure - WF Controls" width=5.0in +
+ +You can configure the appearance of fldigi in a variety of ways, +including the suppression of unused waterfall controls. +
+ +\image html config-ui-wf-controls-2.png "UI Configure - WF Controls 2" +\image latex config-ui-wf-controls-2.png "UI Configure - WF Controls 2" width=3.0in +
+ +Before adjusting these settings it is recommended that you enable this +menu item. You can then see the effect of enabling and disabling the +various selection boxes. + +
+\ref ui_configuration_waterfall_controls_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/ConfigUI-browser.txt b/fldigi_doxygen/user_src_docs/ConfigUI-browser.txt new file mode 100644 index 00000000..2126ca91 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigUI-browser.txt @@ -0,0 +1,86 @@ +/** +\page ui_configuration_broswer_page User Interface Configuration - Browser + +\tableofcontents + +\image html config-ui-browser.png "UI Browser Configuration" +\image latex config-ui-browser.png "UI Browser Configuration" width=5.0in +
+ +\image html browser-panel.png "Browser Panel" +\image latex browser-panel.png "Browser Panel" width=5.0in +
+ +Fldigi can display multiple decoded signals in both PSK and RTTY modes. +The multi-channel display is either a separate dialog or an embedded resizable +panel. + +1) select the number of 100 Hz channels you want visible
+2) select the start frequency for the browser (your transceiver may +not rx signals below this value)
+3) select the inactivity timeout for the browser. After this +number of seconds the channel will be cleared and prepared for the next +detection cycle.
+4) select what kind of label annotation you want on each line
+5) select the font and font size to be used in the browser
+6) You can enter any text you want to search for in the +Seek Regular Expression widget. This text can be a simple text +snippet such as "CQ" or any regular expression. When the regex is +satisfied in a channel the text color for that channel is changed to +red. With a regex you can specify a more generic pattern, which means +that you can match more things and your search is somewhat noise tolerant. +Here is an example for a CQ from a US station (should match most +callsigns): +
+ +\verbatim +>cq.+[aknw][a-z]?[0-9][a-pr-z][a-z]{1,2} +\endverbatim +
+ +This says "cq followed by at least one character, followed by one A, +K, N, or W, followed by an optional letter, followed by a digit, +followed by a letter that is not q, followed by one or two letters". +The search is case-insensitive. +
+ +All plain text is a valid regular expression, unless you really had +been looking for these metacharacters: +
+ +\verbatim +>.[{()\*+?|^$
+\endverbatim +
+ +These will have to be escaped with a backslash.
+ +7) select whether you want a marquee type of continuous scrolling, or simply + clear the line when it is filled.
+8) select whether you want the lowest frequency at the bottom (checked) or + the top of browser panel
+9) select whether you want the audio stream history buffer to be played back + when you select an active channel. The first-in first-out audio + history represents the previous 2 minutes of received audio.
+10) Both the background and slider highlight colors can be selected for the +signal browser detection level control. The default colors are shown +in these images.
+11) You can set the 2 levels of text hi-lighting that is used in the browser +lines
+ +
    +
  • HiLite 1 - Text color when the regular expression evaluator finds the +target text
    • +
  • HiLite 2 - Text color when your call sign appears in that receive +channel
    • +
+12) You can set the background colors for the odd/even lines and the line selection color
+ +
+\ref ui_configuration_broswer_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + diff --git a/fldigi_doxygen/user_src_docs/ConfigUI-contest.txt b/fldigi_doxygen/user_src_docs/ConfigUI-contest.txt new file mode 100644 index 00000000..28bc3e76 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigUI-contest.txt @@ -0,0 +1,44 @@ +/** +\page ui_configuration_contest_page User Interface Configuration - Contest + +\tableofcontents + + + +\image html config-ui-tabs.png "UI Tabs" +\image latex config-ui-tabs.png "UI Tabs" width=4.0in +
+ + +Fldigi supports a generic but robust set of contest functions. In +addition to serial-in and serial-out you can capture and transmit three +exchange sequences unique to a specific contest. Enter the +exchange you want to send for each of the three. You can force +the RST in/out to always be 599. That seems to be a norm for many +contests. When operating in a CW contest you can have fldigi send +cut numbers, T for 0, N for nine. +
+ +\image html config-ui-contest.png "UI Contest" +\image latex config-ui-contest.png "UI Contest" width=5.0in +
+ +The serial number can be set to use leading zeros. You can specify the +starting number for the sequence and how many digits are sent, ie: +0024. Pressing Reset will set the starting number to the QSO logging +serial out field. See \ref contest_how_to_page "Contest How To" for more +info. +
+ +You can check for duplicates by any combination of the specified named +fields. You can also specify that the duplicate had to occur with a +given time interval. Some VHF contests allow a duplicate CALL after +a given time interval. +
+ +\ref ui_configuration_contest_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/ConfigUI-general.txt b/fldigi_doxygen/user_src_docs/ConfigUI-general.txt new file mode 100644 index 00000000..4b34050a --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigUI-general.txt @@ -0,0 +1,93 @@ +/** +\page ui_configuration_general_page User Interface Configuration - General + +\tableofcontents + +\image html config-ui-tabs.png "UI Tabs" +\image latex config-ui-tabs.png "UI Tabs" width=5.0in +
+ +\image html config-ui-general.png "General UI Config Panel" +\image latex config-ui-general.png "General UI Config Panel" width=5.0in +
+ +Fldigi offers tips on the use of nearly every aspect of its operation. +These are particularly useful when you first use the program, but +after you are familiar with it's operation they tend to get in the way. +You can turn them off by de-selecting "Show tooltips" +
+ +Some users prefer to not have icons on the menu system. You can turn +them off also. +
+ +Fldigi offers three different look and feel based on the parent Fast Light +Toolkit graphics interface; "base", "gtk+" and "plastic". These +can be combined with command line specifiers for the default background +and foreground colors to create a user unique look to fldigi. You +will probably discover that the default colors and the gtk+ UI scheme +are to be preferred. +
+ +Fldigi has internationalization files for French, Italian and +Spanish. These control the contents of various menu items and +labels. Linux users should build and install fldigi from source +to gain access to these. Windows users should select the language +of choice from the list, press the "Save" button and then close and +restart fldigi. The "UI language" selector is only present on the +Windows version of fldigi. The percentage indicates the +completeness of the translation. +
+ +CW, RTTY (baudot), THROB, +and CONTESTIA are modes that only transmit in upper case +characters. They also have a very limited set of non-alpha +characters. A screen full of UPPERCASE characters can be +stressful. Select this option to print all of this text in lower +case +
+ +Select the configuration items to allow prompting when exiting the +program. Note that the prompts are only active if the menu item +File/Exit is used. +
+ +You can elect to have the program check for updates every time it is +started. You can also manually check for updates from the "Help / +Check for updates" menu item. +
+ +\section visible_modes Visible Modes + +\image html visible_modes.png "Visible Modes" +\image latex visible_modes.png "Visible Modes" width=1.8in +
+ +You may not want to use all possible modes when operating fldigi. +Press the "Visible modes" button and open the mode selector dialog. +
+ +The use of this dialog should be obvious after a few clicks here and there. +
+ +\section limit_modes Limit Modes + +\image html limited_modes.png "Limit Modes" +\image latex limited_modes.png "Limit Modes" width=0.96in +
+ +By deselecting all but CW, PSK31, PSK63 and RTTY +the Op_Mode menu is uncluttered of all the other modes. The WWV +and Freq Analysis modes are always visible. When a subset of the +entire mode bank is selected a new menu item is added to the Op_Mode +menu, "Show all modes". This is a toggle to restore all modes to +the menu. The inverse toggle is "Show fewer modes." +
+ +
+\ref ui_configuration_general_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/ConfigUI-logging.txt b/fldigi_doxygen/user_src_docs/ConfigUI-logging.txt new file mode 100644 index 00000000..fbff272f --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigUI-logging.txt @@ -0,0 +1,138 @@ +/** +\page ui_configuration_logging_page User Interface Configuration - Logging + +\tableofcontents + +\image html config-ui-tabs.png "UI Tabs" +\image latex config-ui-tabs.png "UI Tabs" width=5.0in +
+ + +\image html config-ui-qso-logging.png "QSO Logging" +\image latex config-ui-qso-logging.png "QSO Logging" width=5.0in +
+ +\section captureing_log_data Capturing Log data + +Fldigi has a built in logbook. You can request to be prompted whenever +there is an unsaved entry in the qso log area. You can also elect to +whether to clear all of the qso fields when the log is saved or to leave them +intact. +Auto-fill Country and Azimuth uses the data found in the file +"cty.dat" that you should download and place in the fldigi default +folder. You can force the callsign field to be upper case +independent of capture or keyboard entry. You enter your default +Transmit Power which is used for the logbook record. +
+ +Fldigi has various ways to transfer data in the Rx panel to the qso logging +fields. The default is to use a Shift-Left-Click paradigm. You can also +elect to use a single left click method if you prefer. The word pointed to by +the cursor is parsed to determine it's intended field use; call, RSQ, operator +name, and QTH. The call will be overwritten, but the other log fields need to +be blank for the data transfer to be accomplished. Each data item is considered +to be a single word normally delimited by the space, tab or end-of-line character. +You can add word delimiter characters in the designated text box. The default is +to add *-,.; to the normal delimiters. This is a useful tool for extracting +contest exchange data. The exchange might be RST, STATE and NAME. The station +being worked might send this as 599-NJ-Bozo. Clicking on the 599 NJ and Bozo +would treat each as a separate word. You may also right click on a word (or a +phrase that has been highlighted by dragging the cursor over the text). That +will open a pop-up menu with selections to transfer the data into a number of +different log fields. +
+ +You can elect to have the RST in/out preset to 599 after you clear the QSO +entry fields. +
+ +If you check the "callsign tooltips in received text" then the Rx +text area will popup an information box whenever the mouse is held over +a callsign for more than 2 seconds. The popup will look like one +of the following: +
+ +\section pop_ups Pop ups + +\image html show-popup.png "Pop ups" +\image latex show-popup.png "Pop ups" width=2.75in +
+ +\image html show-popup2.png "Pop ups 2" +\image latex show-popup2.png "Pop ups 2" width=2.75in +
+ +\section country_files Country Files + +The data is derived by parsing the callsign and referral to both the +logbook and the "cty.dat" file. If the station was previously +worked the operator's name and azimuth/distance will be computed from +the logbook gridsquare entry (Loc). Otherwise the +azimuth/distance is computed from the data in the cty.dat file. +
+ +This file is maintained by, and can be downloaded from the following web site: +
+ +http://www.country-files.com/
+ +The default location for this file is in the fldigi default files +folder. You have the option of changing that file location by +either entering the new folder pathname in the edit control, or by +using the "Browse" or "Default" button. If you change the +contents of cty.dat while fldigi is running you should force fldigi to +reload the data from the file. This data is normally only read +when the program starts. +
+ +\section internal_logbook Internal Logbook + +Fldigi has an internal logbook. That log should be used for single +operator operations. There may be times that you need to share a +log, either between programs on a single computer, or with other +operators running fldigi on other computers on a LAN (or even WAN). +
+ +In lieu of the internal logbook you can elect to use a common logbook +server. This logbook is maintained by a separate logbook program, +fllog. fllog +provides access to read, query and update records via an xmlrpc socket +interface. fllog provides the server function and connecting applications +are clients. +
+ +You need to specify both the socket address and socket port. The +defaults are as shown and are for the instance when both fllog and +fldigi are on a single computer. Unless configured otherwise, +fllog will always use the port address 8421. +
+ +\section logbook_network_address Logbook Network Address +
+ +\image html config-ui-lan.png "Network Address" +\image latex config-ui-lan.png "Network Address" width=2.25in +
+ +My home network has IP address assignments as shown. If fllog were +running on the mini-mac (fl-mac) and fldigi running on the linux-dev +machine. I would enter the server address 192.168.1.94 into the fldigi +configuration for the Client/Server Logbook. +
+ +\image html connect-to-logserver.png "Connect to Server" +\image latex connect-to-logserver.png "Connect to Server" width=1.36in +
+ +The "Logbook/Connect to server" menu item allows you to connect to the +remote logbook. If successful then the toggle remains checked and +the menu items for accessing the internal logbook are disabled. +
+ +
+\ref ui_configuration_logging_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/ConfigUI-macros.txt b/fldigi_doxygen/user_src_docs/ConfigUI-macros.txt new file mode 100644 index 00000000..44fb270c --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigUI-macros.txt @@ -0,0 +1,62 @@ +/** +\page ui_configuration_macros_page User Interface Configuration - Macros + +\tableofcontents + +\image html config-ui-tabs.png "UI Tabs" +\image latex config-ui-tabs.png "UI Tabs" width=5.0in +
+ +\image html config-ui-macros.png "UI Configure - Macros" +\image latex config-ui-macros.png "UI Configure - Macros" width=5.0in +
+ +Access to a macro is gained by pressing the associated function +key. There are actually 48 separate macros that can be +created. With the default configuration you rotate between the +sub-sets of 12 using the numbered button to the right of the macro bar, +or by selecting a set with the Alt-1, Alt-2, Alt-3 or Alt-4 key +combination. (on OS X use the Option-1 etc.) +
+ +The default user interface is a single macro bar of 12 buttons located just +above the waterfall panel. There are times when you need ready access +to more than 12 macro functions. When a 2 row configuration is +selected the original row is forced to the Alt-1, or first sub-set of +macros, and it's numeric rotate button is disabled. The second or +SHIFTED macro button row can be rotate through Alt-2 ... Alt-4 using +either it's numeric button or the Alt-\#key combination. The +fldigi macro bar positions will change immediately so you can see the +selection. +
+ +With 2 rows shown you obtain access to the primary set with normal +Function key press. The secondary set is accessed by a +SHIFT-Function-key press. +
+ +You edit any macro definition by using a mouse right-click on it's button. +
+ +You can also select to use the mouse wheel to rotate through the macro +sub-sets. When checked you simply hover the mouse over the macro +bar and roll the mouse wheel. +
+ +Fldigi manages multiple files that contain macro definitions. You may +want to have the last used macro file be the one available the next time you +start fldigi. If so, simply enable the "load last used Macro file on +startup" check box. You can also choose to display which macro file was +loaded at startup or when a new macro file is loaded. A brief message +indicating which file was loaded will be written to the Rx text area if +this option is selected. +
+ + +
+\ref ui_configuration_macros_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/ConfigWaterfall.txt b/fldigi_doxygen/user_src_docs/ConfigWaterfall.txt new file mode 100644 index 00000000..c87f5dd2 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ConfigWaterfall.txt @@ -0,0 +1,130 @@ +/** +\page ui_configuration_waterfall_page Waterfall Configuration + +\tableofcontents + +\image html config-ui-tabs.png "UI Tabs" +\image latex config-ui-tabs.png "UI Tabs" width=5.0in +
+ +\image html config-wf-display.png "UI Waterfall Display" +\image latex config-wf-display.png "UI Waterfall Display" width=5.0in +
+ +The waterfall palette or color scheme can be altered to suit your +personal tastes and visual needs. When fldigi is first started it +creates a wide range of pre-built palettes in the $HOME/.fldigi folder. +The "Load" button gives you access to those palettes. You +may change any palette by clicking on the various color buttons beneath +the palette sample. A color picker opens for you to select the +color by various means including specifying the RGB values. If +you create a palette that suits you better than any of the prebuilt +ones you can "Save" the palette. +
+ +The waterfall cursor is a set of markers on the frequency scale +that are spaced a signal bandwidth apart. You canadd a pair +of lines that drop down from those two markers for the full +height of the waterfall by selecting Cursor BW. You can add a +center line cursor to this pair of BW line by selecting Cursor Center line. +You can also add a set of BW lines that straddle the received +signal tracking point by selecting Bandwidth tracks. All three of these +options are color selectable. Click on the colored button below the +check box and a color selection dialog will open. +
+ +The frequency scale defaults to RF frequency. You can select to show +audio frequencies. +
+ +You can monitor the transmitted audio waveform and also set the level of +the monitored signal. This IS NOT your final transmitted signal! +
+ +Fldigi can set a notch from the waterfall when used with flrig and a +transceiver that supports CAT control of a manual notch filter. +When the notch is engaged a dotted vertical line is placed on the +waterfall at the notch location. You can configure the color of +the dotted notch indicator. +
+ +\section configure_fft_waterfall FFT Waterfall + +\image html config-wf-fft.png "UI Waterfall Display" +\image latex config-wf-fft.png "UI Waterfall Display" width=5.0in +
+ +You can extinguish the display of received signals below a particular audio +frequency. +
+ +Fldigi's waterfall FFT has a bin size of 1 Hz. With an FFT +of 8192 and a sampling rate of 8000 it takes almost a second to +accumulate enough data to perform the full FFT. A waterfall that +dropped at one scan line per second would be hard on the viewer, so +fldigi uses a first-in-first-out (FIFO) 8192 byte buffer for the FFT data. +512 byte audio blocks move through the buffer with each successive +read of the sound card. The full buffer of 8192 samples is used to +compute the FFT. That means that data in the FFT can have a +latency of 8 scans. This provides excellent frequency resolution but +poor time resolution (the vertical waterfall appearance). +The latency control allows you to select the number of 512 byte blocks that +are used for the FFT. The default latency is set to 4. You should be able to +achieve a reasonable compromise between the time and frequency +domain resolutions. +
+ +FFT averaging can be used to smooth the waterfall display in the frequency +domain. +
+ +The FFT Prefilter or window function is used to reduce aliasing in the +FFT computation. +
+ +The default prefilter for the Fast Fourier Transform associated with the +waterfall is Blackman. You can try the other windowing filter. +Under some conditions you might prefer one of those. The Blackman window has +proven best for my setup. +
+ +\section waterfall_mouse_behavior Waterfall Mouse Behavior + +\image html config-wf-mouse.png "UI Waterfall Mouse Behavior" +\image latex config-wf-mouse.png "UI Waterfall Mouse Behavior" width=5.0in +
+ +The mouse behavior in the waterfall panel can be controlled to suit your +particular operating style. You might want to replay the saved +audio history every time you either left click to select or right click +to preview a particular signal. You can move the transceiver +frequency in increments of 100 Hz by dragging the waterfall scale. +You can also choose to insert a line of text into the Rx panel +each time you left click a waterfall signal. The text can include +expandable macro tags. +
+ +\subsection waterfall_mouse_behavior_tailoring Waterfall Mouse Behavior Tailoring + +The mouse wheel behavior can also be tailored to your liking: +
+ +
    +
  • None - no mouse wheel activity in waterfall panel
    • +
  • AFC range or BW - adjust the AFC range/BW up/down
    • +
  • Squelch level - adjust the squelch level up/down
    • +
  • Signal search - search up / down for next signal in current mode
    • +
  • Modem carrier - adjust the audio tracking point +/- Hz increments
    • +
  • Modem - select modem type from a full rotary of available modems
    • +
  • Scroll - move the waterfall left/right in 100 Hz increments (for 2x, 4x expanded waterfall view)
    • +
+ + +
+\ref ui_configuration_waterfall_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + diff --git a/fldigi_doxygen/user_src_docs/Contest-How-To.txt b/fldigi_doxygen/user_src_docs/Contest-How-To.txt new file mode 100644 index 00000000..b492c835 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Contest-How-To.txt @@ -0,0 +1,481 @@ +/** +\page contest_how_to_page Contest - How To + +\tableofcontents + + +Fldigi supports a basic contesting format. Select the menu item +View/Contest fields to see how the QSO entry entry fields change for +contest data. You will see that fldigi has fields to support +received and sent contest numbers as well as generic contest exchange +information. +
+ +\section contest_fields Contest Fields +\image html contest-fields.png "Contest Fields" +\image latex contest-fields.png "Contest Fields" width=4.5in +
+ +The serial number out (\#Out) is automatically initialized and updated by +the built-in serial number generator. You can enter the +appropriate exchange information via the keyboard or mouse. Text +in the Rx pane can be selected by the usual left-click-swipe of +highlighting. Then right click anywhere after highlighting the +desired text and a popup menu will appear allowing you to select the +destination QSO field. Make your selection and the info is placed +in the correct text box. Note that the popup menu changes with +the QSO logging view and also with a change in "Quick entry". A +full description is found in the description of operating the + \ref qso_log_book_page "Logbook". The important thing to note for contest +operation is that the Call and Serial \# are single word captures. The Xchg +capture can be either single word or multiple word (mark / right click). If +the Xchg field has text contents then the new capture is appended to +end of the current text in that field. That means you can point +to the word representing the field, right click and select from the menu. +You do not need to highlight the text for the word capture. You can very +rapidly fill in the serial number and the exchange data (even if multi value) +by simply pointing and right clicking on the desired word. +
+ +\image html config-ui-contest.png "UI Contest" +\image latex config-ui-contest.png "UI Contest" width=4.5in +
+ +To set up fldigi for contesting you will need to open configure contest. +the 1st row contains what info you want sent with the appropriate macro +tag. ie...if the contest requires RST and name you would fill in the +Exchange Out box with your name. The contents of this field are accessed from +a macro with the \ tag. You will also need to check the RST +always 599 box as this is the de-facto signal report in contests. +
+ +If you are participating in a CW contest you may want to select the "Send CW cut +numbers", cut numbers is the norm for a CW contest. The cut +numbers will send N for 9 and T for zero. +
+ +The next box contains the needed requirements to use serial numbers for +a contest. You will always want to use leading zeros, start with 1 and use 3 +digits. Press reset to initialize the \#Out QSO field to the Start number. +
+ +Check the appropriate fields for determining if this is a duplicate call. If +a duplicate is detected the Call entry will be highlighted as shown in +the "Dup Color" button. Pressing this button opens a color selector so +you may customize the color. There are many choices to alert you to a +duplicate contact. The duplicate is based on the logical AND of all of the +fields to be checked. The DUPE is cleared when you press the +clear QSO log button (the brush icon). +
+ +After you have filled in all the required information, make sure you save and +close. +
+ +Remember YOU MUST click the Reset button in the Serial number panel for the +serial number counter to be initialized. You should also press +the QSO clear button (broom) in the QSO entry widget for the other +changes to take effect. +
+ +It would be best to create a new log for each contest. You create a new +log by selecting the menu item File/Logs/New logbook. The default new log +name will be newlog.adif on Linux and newlog.adi on Windows. You can rename +the new log file now or later by using the system file manager or when you +save the log. The import/export feature of fldigi will allow you to export +the log into your everyday logging software or the built-in fldigi logbook. +
+ +\section restarting_contest_session Restarting a contest session + +You might have closed down fldigi in the middle of a contest, everyone +needs a break now and then. You then start fldigi and want to +continue the contest. Here are the steps to insure that you +continue operations with no glitches. +
+ +
    +
  • Load your macro file that contains your contest macros (more on that below)
    • +
  • Select the menu item View/Contest fields
    • +
  • Select the menu item View/Logbook
    • +
  • Make sure you have the contest logbook open ... if not then this is the +time to open that logbook database.
    Select the menu item "File/Logs/Open +logbook..." and find your log data file.
    • +
  • Look at the last record and check the serial number sent. Enter that +number plus one in the Start entry on the config contest tab (see above).
    • +
  • Press the Reset button in that panel.
    • +
+ +You are ready to keep on contesting +
+ +\section remembering_a_contact Remembering a contact + +If you are copying a potential contact but you are not being heard you can +save fldigi's modem state using one of two methods +
+ +
    +
  1. double click the signal on the waterfall
    2. +
  2. right click on the Rx panel and select "Insert marker"
    3. +
+ +A line of text will be inserted at the end of the Rx text buffer. It will +appear similar to this: +
+ +\<\<2008-12-30T10:06Z BPSK-31 @ 3580000+0781\>\> +
+ +The date-time, the mode, the transceiver operating frequency and the audio +offset will be recorded. The text line is in blue and behaves in +a way that you might expect a url reference to behave in a web browser +window. Work a few more contacts (even on a different band or +frequency) and then scroll the Rx pane to that special divider. + Left click on the line of text and fldigi will restore the +transceiver to its frequency, change the mode to the saved mode and put +the waterfall cursor at the audio offset frequency. Changing the +transceiver frequency will only work if you are using CAT control of +your transceiver. If you are not using CAT control the mode and +waterfall cursor will still be restored. +
+ +There is no limit to the number of divider lines that can be inserted into +the Rx pane. They will all be removed when the Rx pane is cleared. +
+ +\section saving_session Saving the entire session + +Select the menu item "File/Logs/Log all RX/TX text". If this toggle menu +is checked your entire session of received and sent text will be saved +to a file in the fldigi default files folder. It will be given a +name synonymous with the date and time is is started, ie: +fldigi20081230.log. You can review this log by selecting the menu +item "File/Show config" which will open your OS default file explorer +to the fldigi files folder. The file is an ASCII text file. +
+ +The format of the daily log is shown in Working Logs. +
+ +\section contesting_macro_tips Contesting Macro Tips +
+ +OK, now we have fldigi setup for basic contesting, lets move on to some +ideas on macros to use. I tend to make generic one size +fits all macros. I recommend that you make a new macro file, mine is +named contest.mdf, this will give you 48 macros to use based on the +type of contest you are entering. Take a good look at the examples I +have listed, you will notice there are no commas, hyphens or other +extraneous items. I have seen just about every example of a poorly +thought out macro there is or has ever been dreamed up. Classic +examples are: +
+ +
    +
  • w3nr you are 599 in Alabama your serial number is 001-001-001 how copy ??
    • +
  • hello ed thanks for the call you are 599-599-001-001-001 QTH Alabama back +to you
    • +
+ +The list goes on and on. Just think, you have to try and capture the +exchange, try it and you will see what I mean. +
+ +When you enter a contest you have to decide whether you are going to sit on +one frequency and call CQ (Run) or are you going to tune the band +looking for stations to work (S&P). So lets set up some macros that +should cover both cases. +
+ +Several new macro tags have been created to facilitate contesting, these +include the following tags. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
\add QSO data to the logbook & +clear the QSO data fields
\insert current contest serial number into the text stream
\increment contest serial number
\decrement contest serial number
\contest exchange
\current log time in Zulu HHMM format
\local date time
\LDT in iso-8601 format
\Zulu date time
\ZDT in iso-8601 format
\
+ 		actual time of execution of the macro ... useful where exact times are used to match contest log submissions
+
\
+ 		save entire contents of the expanded macro text to the "Exchange Out" field in the logbook
+
\
+ 		mark the beginning of a text string that is to be saved to the "Exchange Out" field in the logbook
+
\
+ 		mark the end of the text string that + is to be saved to the "Exchange Out" field in the logbook +
+note: \ and the \...\ macro tags are +mutually exclusive +
+\...\ is given priority if both all three are specified +in a single macro +
+
+
+ +See \ref macros_sub_page "Macros" for additional information on editing +and using the fldigi macro system. +
+ +\section run_macros RUN Macros + +We need just a few, starting with a CQ macro - Put this in the F1 key definition +
+ +\verbatim + +cq test de cq k + +\endverbatim +
+ +Notice that I left 2 spaces between my call and 3 spaces at the end before the +k. This will make it easier for a station to grab my call and the k on +the end eliminates garbage characters before my macro finishes. The +tx/rx are on separate lines as I want to be sure my macro is on a line +by itself and not mixed in with screen garbage. +
+ +Now the exchange macro - Put this in the F2 key definition
+
+ +\verbatim + + 599 k + +\endverbatim + +Why do I have his call at the beginning as well as the end, to make sure I +have copied his call correctly. You will also see that I have not as +yet logged the contact,why, well are you sure he does not need to +correct his call or ask for a repeat. +
+ +You are asked to repeat the exchange, you can just re-send the exchange macro, +this verifies all of the information. Now he sends you his info and if you have +copied it correctly you need a TU macro. - Put this in the F3 key definition. +
+ +\verbatim + +qsl tu qrz test k + +\endverbatim + +Here we have done all the necessary items to complete the exchange. Notice +that I did not log the contact until after everything was correct. I +have fldigi set to clear on save, so when the \ part of the +macro executes the QSO area is cleared. +
+ +Thats the end of my RUN macro setup, told you it was rather simplistic and +generic. +
+ +\section s_p_macros S \& P Macros + +I rarely if ever use S&P, but there are times I +need to, especially if my QSO rate drops while running. Again the macros are +very generic with only the needed info. If band conditions warrant you may +want to send your call 3 times. Put this in the F5 key definition +
+ +\verbatim + + k + +\endverbatim + +Why just my call ?? Well I assume the other guy already knows his call ! +
+ +The exchange macro is basically the same as the RUN macro. Put this one in the F6 key definition
+
+ +\verbatim + +599 k + +\endverbatim + + +As you see I have not as yet logged the QSO or incremented the serial +number. This is the final S&P macro. Put this one in the F7 key +definition. +
+ +\verbatim + +\endverbatim + +Now this is the most important macro you will ever need......trust me. Put it +where you won't fail to find it. How about F9 ? +
+ +\verbatim + +agn agn k + +\endverbatim + + +You will see that it is used many times during a contest, especially with +weak stations and heavy QRN/QRM. +
+ +\ + +
    +
  • +time sent in Tx stream
    • +
  • +repeat execution of \ before a \ macro or a save to +log button press will resend the original time
    • +
  • +\ macro or a save-to-log button press appends the QSOTIME to +the STX_STRING field in the adif log record and clears the QSOTIME. +
    +
    • +
+\ +
    +
  • +use at end of a contest exchange to save the entire exchange string in STX_STRING
    • +
  • +usurps QSOTIME if both are contained in same macro text, ie: +"\ \ \\" will send an +exchange as 599 024 1125 if RST = 599, Counter = 024 and time of +execution is 1125
    • +
  • +repeats the same as \
    • +
  • +\ macro or a a save-to-log button press saves the associated +macro text (after expansion). QSOTIME and the saved exchange text +are cleared after the save occurs.
    • +
+ + +An example of the SAVEXCHG macro tag
+ +\verbatim + +\endverbatim + + +Where RST = 599, CNTR = 0125, XOUT = AL, QSOTIME = 1433
+
+ +Will save this string to the Exchange Out field in the +logbook: "599 0125 AL 1433" +
+ +Please note that you should not include any text or macro tags that are +not to be a part of Exchange Out. If your macro had this: +
+ +\verbatim + UR de k +\endverbatim + + +Where CALL = W3NR, MYCALL = W1HKJ
+
+ +the saved Exchange Out field would contain: "W3NR UR 599 0125 AL 1433 de W1HKJ k" +
+ +Probably not what you want. Use separate function keys for the +"\CALL ..." and the "de \ k\" or use the next +set of macro tags +
+ +\verbatim +... +\endverbatim + + +These two macro tags are delimiters for capturing the transmitted exchange +data, for example: +
+ +\verbatim + de QSL K +\endverbatim + + +Will place the expanded \ \ \ into the +Exchange Out field of the logbook when the contact is saved. This is +much better illustrated with a screen shot. This one shows the macro +editor contents, the logbook entry in Exchange Out, and the transmit +text buffer. +
+
+ +\image html xbeg-xend.png "Exchange Begin-End" +\image latex xbeg-xend.png "Exchange Begin-End" width=6.0in +
+ +
+\ref contest_how_to_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + diff --git a/fldigi_doxygen/user_src_docs/Contestia.txt b/fldigi_doxygen/user_src_docs/Contestia.txt new file mode 100644 index 00000000..99000f4e --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Contestia.txt @@ -0,0 +1,68 @@ +/** +\page contestia_page Contestia + +\tableofcontents + +Fldigi can operate on the following Contestia modes without special setup +by the operator: +
+ +Mode | Symbole Rate \(Baud\) | Typing speed \(WPM\) | Bandwidth \(Hz\) +:---------------: | :-----------: | :-----------: | :---------: +Contestia 4-250 | 62.5 | ~ 40 | 250 +Contestia 8-250 | 31.25 | ~ 30 | 250 +Contestia 4-500 | 125 | ~ 78 | 500 +Contestia 8-500 | 62.5 | ~ 60 | 500 +Contestia 16-500 | 31.25 | ~ 30 | 500 +Contestia 8-1000 | 125 | ~ 117 | 1000 +Contestia 16-1000 | 62.5 | ~ 78 | 1000 +Contestia 32-1000 | 31.25 | ~ 48 | 1000 + +Unusual combinations of symbol rate and bandwidth can be selected +using the \ref contestia_configuration_page tab. +
+ +Contestia is a digital mode directly derived from Olivia that is not +quite as robust - but more of a compromise between speed and +performance. It was developed by Nick Fedoseev, UT2UZ, in 2005. It +sounds almost identical to Olivia, can be configured in as many ways, +but has essentially twice the speed. + +Contestia has 40 formats just like Olivia - some of which are +considered standard and they all have different characteristics. The +formats vary in bandwidth (125,250,500,1000, and 2000hz) and number of +tones used (2,4,8,16,32,64,128, or 256). The standard Contestia formats +(bandwidth/tones) are 125/4, 250/8, 500/16, 1000/32, and 2000/64. +The most commonly used formats right now seem to be 250/8, 500/16, and +1000/32. +
+ +Contestia performs very well under weak signal conditions. It handles +QRM, QRN, and QSB very well also. It decodes below the noise level but +Olivia still outperforms it in this area by about 1.5 - 3db depending +on configuration. + +It is twice as fast as Olivia per configuration. It is an excellent +weak signal, ragchew, QRP, and DX digital mode. When ragchewing under +fair or better conditions it can be more preferable to many hams than +Olivia because of the faster speed. For contests it might also be a +good mode IF the even faster configurations such as 1000/8 or 500/4 are +used. + +Contestia get it's increased speed by using a smaller symbol block size +(32) than Olivia (64) and by a using 6bit decimal character set rather +than 7bit ASCII set that Olivia does. Therefore, it has a reduced +character set and does not print out in both upper and lower case (like +RTTY). Some traffic nets might not want to use this mode because it +does not support upper and lower case characters and extended +characters found in many documents and messages. For normal digital +chats and ham communications that does not pose any problem. + + +
+\ref contestia_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/DXCC_list.txt b/fldigi_doxygen/user_src_docs/DXCC_list.txt new file mode 100644 index 00000000..fc26c7d0 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/DXCC_list.txt @@ -0,0 +1,77 @@ +/** +\page dxcc_list_page DXCC List etal + +\tableofcontents + +Fldigi uses several data files that are not included with the +distribution. These must be downloaded from the list maintenance +web sites for the most current data. These lists include: +
+ + + + + + + + + + + + + + + + + + + + + + +
List Data
+ 		List Name
+ 		Web source
+
DXCC
+ 		cty.dat
+ 		+ http://www.country-files.com/cty/ +
+
LOTW
+ 		lotw1.txt
+ 		+ http://www.hb9bza.net/lotw/lotw1.txt +
+
EQSL
+ 		AGMemberList.txt
+ 		+ http://www.eqsl.cc/QSLcard/DownloadedFiles/AGMemberList.txt +
+
+
+ +These files should be downloaded and placed in the fldigi files +directory. The most convenient way to open the fldigi files +directory is via the menu item "File / Show config". +
+ +The DXCC list browser is shown by selecting the menu item +"View / Countries". +
+ +\image html DXCC_list.png "DXCC List" +\image latex DXCC_list.png "DXCC List" width=4.0in +
+ + +You can sort the list by Country, Continent, ITU or CQ zone by clicking on +the various column headers. +
+ +
+\ref dxcc_list_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/DigiWWV.txt b/fldigi_doxygen/user_src_docs/DigiWWV.txt new file mode 100644 index 00000000..4562f8ca --- /dev/null +++ b/fldigi_doxygen/user_src_docs/DigiWWV.txt @@ -0,0 +1,332 @@ +/** +\page digiscope_display_wwv_mode Digiscope Display - WWV mode + +\tableofcontents + +The WWV mode is used to measure the offset of the sound card oscillator. +It does this by comparing the timing loop for the sound card measurements +against the clock tick signal that is transmitted by WWV and WWVH. The +sampling rate for the sound card should be set to "native". The sound card +samples the signal and returns the values in 512 blocks. This block +sampling is what sets the basic timing mechanism for the thread that +reads the sound card, sends data to the waterfall, and sends data to +the modem signal processing functions. A process of filtering is +used that simultaneously reduces the sampling rate. Most modern +soundcards will use 44100 or 48000 as the native smampling rate. +That sample rate in down converted to 1000 using a decimation in time +type FIR. The resulting signal is then power detected and +further filtered with a filter called a moving average filter. The moving +average is very good at detecting the edge of a pulse such as the 1 second +tick transmitted by WWV. This output is then displayed in a manner very +similar to a FAX signal. Each scan line represents the received signal +over a 1 second interval. The bright white line is the time tick. You can +see a very slight slope from left to right as the signal goes from top to +bottom of the display. +
+ +Open the configure dialog box to the "SndCrd" tab. You are going +to be adjusting the "Rx corr Rate" while you observe the effect of this +control on the slope of the time tick line. +
+ +Tune in WWV or WWVH on 2.5, 5.0, 10.0 or 15.0 MHz in the AM mode. This +seems to give the best signal view. Select the WWV modem and allow the data +to begin to accumulate in the digiscope display. When you can clearly see +the bright tick line, move the cursor to the bottom of the line and left +click at that position. That will resync the digiscope display and put the +ensuing tick marks at the center line red graticule. +
+ +Then right click anywhere in the digiscope display. That changes +the zoom level to show more detail regarding the slope of the time tick +line. The zoom level increases by a factor of 5. Right +clicking again restores the original zoom level. I recommend +making the adjustments to the Rx corr Rate control in the x5 zoom level. +
+ +If the slope of the time tick line is positive you will need to apply a +negative value to the Rx corr Rate. If it is negative then a +positive correction is needed. +
+ +Start with a correction of 0 ppm and observe the slope. Try a +value of 1000 ppm and observe the slope. Again, try a -1000 ppm +correction and observe the slope. The following are some observations +made on 10 MHz WWV, DCF-77 and RWM under less than ideal conditions. +
+ +\image html wwv3.png "WWV corrected 20 minute trace 5x scale" +\image latex wwv3.png "WWV corrected 20 minute trace 5x scale" width=1.25in + + +\htmlonly + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +-1000 ppm WWV
+ +5x scale		 + +
+ +0 ppm WWV
+ +5x scale		 + +
+ ++1000 ppm WWV
+ +5x scale		 + + ++120 ppm WWV
+ +5x scale
+ +
+ +0 ppm DCF-77
+ +1x scale		 + +
+ +0 ppm DCF-77
+ +5x scale		 + +
+ ++1000 ppm DCF-77
+ +1x scale		 + +
+ ++65 ppm DCF-77
+ +5x scale
+ +
+ +RWM uncorrected
+ +1x scale		 + +
+ +RWM
+25361 ppm
+ +1x scale		 + +
+ +RWM
+25361 ppm
+ +5x scale		 +
+
+ +\endhtmlonly + +\latexonly + +\begin{figure}[H] + + \centering + + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{wwv1-lgneg.png} + \caption{0 ppm WWV 5x scale} + \label{fig:wwv1_lgneg} + \end{subfigure} ~ + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{wwv2-000ppm.png} + \caption{+1000 ppm WWV 5x scale} + \label{fig:wwv2_000ppm} + \end{subfigure} ~ + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{wwv2-lgpos.png} + \caption{-1000 ppm WWV 5x scale} + \label{fig:wwv2_lgpos} + \end{subfigure} ~ + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{wwv2-125ppm.png} + \caption{+120 ppm WWV 5x scale} + \label{fig:wwv2_125ppm} + \end{subfigure} + + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{dcf77-0.png} + \caption{0 ppm DCF-77 1x scale} + \label{fig:dcf77_0} + \end{subfigure} ~ + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{dcf77-0zoom.png} + \caption{0 ppm DCF-77 5x scale} + \label{fig:dcf77_0zoom} + \end{subfigure} ~ + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{dcf77-1000.png} + \caption{+1000 ppm DCF-77 1x scale} + \label{fig:dcf77_1000} + \end{subfigure} ~ + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{dcf77-65zoom.png} + \caption{+65 ppm DCF-77 5x scale} + \label{fig:dcf77_65zoom} + \end{subfigure} + + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{RWMpre-cal.png} + \caption{RWM uncorrected 1x scale} + \label{fig:RWMpre_cal} + \end{subfigure} ~ + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{RWM+25361ppm.png} + \caption{RWM +25361 ppm 1x scale} + \label{fig:RWM_25361ppm} + \end{subfigure} ~ + \begin{subfigure}[t]{0.25\textwidth} + \centering + \includegraphics[width=0.75in]{RWMpost-cal-x5.png} + \caption{RWM +25361 ppm 5x scale} + \label{fig:RWMpost_cal_x5} + \end{subfigure} + + \caption{PSK Digiscopes} + \label{fig:psk_digiscopes} +\end{figure} + +\endlatexonly +
+ +You can see that my sound card requires a positive correction since the +slope is negative with a 0 ppm entry. The required correction of ++120 ppm was determined by guessing the needed correction to be close +to 1/10 of the -1000 ppm slope and then adjusting for a steady track +along the red graticule. The DCF-77 images were provided by +Walter, DL8FCL. The RWM images were provided by Andy G3TDJ. +
+ +You can left click on the tick line anytime you want to recenter the +signal. That will aid in making your visual observation. +
+ +When you are finished, the Rx corr Rate entry is the correct one for +your sound card. Save the configuration for future fldigi use. +
+ +Andy also provided information on the RWM transmissions: +
+ + +RWM details extracted from http://www.irkutsk.com/radio/tis.htm +
+ +Station RWM - Main characteristics +
+ +Location: Russia, Moscow +
+ +55 degr. 44' North , 38 degr. 12' East +
+ +Standard frequencies : 4996, 9996 and 14996 kHz +
+ +Radiated power: 5kW on 4996 and 9996 kHz; 8kW on 14996 kHz +
+ +Period of operation: 24 hours per day, except 08.00-16.00 msk for maintenance as below: +
+ +on 4996 kHz : 1st wednesday of the 1st month of quater; +
+ +on 9996 kHz : 2nd wednesday of the 1st month of the quater; +
+ +on 14996 kHz : 3rd wednesday of each odd month; +
+ +Coverage: 20 degr. - 120 degr. East +
+ +35 degr. - 75 degr. North +
+ +Time signals A1X are given every second of 100 ms duration with a frequency +of 1 Hz. Minute pip is extended to 500 ms. +
+ +Hourly transmission schedule +
+ + m:s - m:s + +00:00 - 07:55 -- MON signals (no modulation) +
+08:00 - 09:00 -- transmitter is signed off +
+09:00 - 10:00 -- station's identification is sent by Morse Code +
+10:00 - 19:55 -- A1X signals and identification of DUT1+dUT1 +
+20:00 - 29:55 -- DXXXW signals +
+30:00 - 37:55 -- N0N signals (no modulation) +
+38:00 - 39:00 -- transmitter is signed off +
+39:00 - 40:00 -- station's identification is sent by Morse Code +
+40:00 - 49:55 -- A1X signals and identification of DUT1+dUT1 +
+50:00 - 59:55 -- DXXXW signals + +
+See \ref wwv_tx_mode "Transmitting Simulated WWV Timing Tone" + +
+ +\ref digiscope_display_wwv_mode "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/DigiscopeDisplay.txt b/fldigi_doxygen/user_src_docs/DigiscopeDisplay.txt new file mode 100644 index 00000000..9dcea595 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/DigiscopeDisplay.txt @@ -0,0 +1,252 @@ +/** +\page digiscope_display_page Digiscope Display + +\tableofcontents + +Fldigi provides several different views +of the decoded signal with its waterfall, text and a scope displays. The +scope display is either a separate moveable, resizable dialog that is opened +from the "View/Digiscope" menu item or a docked scope. +
+ +\section cw_scope CW +
+ + + +\image html digiscope-cw.png "Digiscope CW" +\image latex digiscope-cw.png "Digiscope CW" width=1.0in +
+ +The CW signal will consist of the time domain amplitude detected signal. The +horizontal timing is dependent on CW speed, so that the display will appear +similar independent of CW speed. +
+ +\image html digiscope-cw.png "Digiscope CW" +\image latex digiscope-cw.png "Digiscope CW" width=1.0in +
+ +\section domino_ex_scope DominoEX / Thor + +\image html digiscope-domexA.png "Digiscope DominoEX \& Thor" +\image latex digiscope-domexA.png "Digiscope DominoEX \& Thor" width=1.0in +
+ +DominoEX and Thor have two alternate views available on the digiscope +display. You can toggle between the views by left clicking on the +digiscope display area. The triangular view shows data propogation +through the interleave filter. As signal s/n degrades this display +will become more wavy. +
+ +\image html digiscope-domexB.png "Digiscope DominoEX \& Thor" +\image latex digiscope-domexB.png "Digiscope DominoEX \& Thor" width=1.0in +
+ +The second view is the decoded data stream viewed in the frequency +domain. The dots will be very distinct when the signal is fully +acquired and decoding properly. It will be fuzzy when the decoder is +not locked or there is interference present. +
+ +\section mfsk_scope MFSK + +\image html digiscope-mfsk.png "Digiscope MSFK" +\image latex digiscope-mfsk.png "Digiscope MSFK" width=1.0in +
+ +This is what you expect to see for all of the MFSK type modes. The +number of steps in the slant lines will change with the various modes, +but they will all have the same general appearance. If the signal +is mistuned the sloped lines will become bowed and distorted. +
+ +\section psk_scope PSK + +The digiscope display just to the right of the waterfall displays +signal quality in various formats. The display for PSK modes is +the vector scope: +
+ +
+\htmlonly + + + + + + + + + + + + + + + +
+
+		 +
+ +
+
+
+
The +display with no signal or below squelch level. If the SQL is off +this display will be random vectors driven by noise.
+		 + +
+
+
The display with a normal psk31 signal. The vector flips between 0 and 6 o'clock
+		 + +
+
+
AFC off and receive carrier set below the center of the received signal
+		 +
+
+
+		 + +
+
+
+AFC off and receive carrier set above the center of the received signal.
+		 + +
+
+
AFC enabled, Fading History Display Mode Selected (left click on scope)
+		 + +
+
+
AFC enabled, Fading History / Amplitude Display Mode Selected (2nd left click on scope)
+		 +
+
+\endhtmlonly +
+ +\latexonly + +\begin{figure}[H] + + \centering + + \begin{subfigure}[t]{0.3\textwidth} + \centering + \includegraphics[width=1.0in]{digiscope-psk-nosig.png} + \caption{The display with no signal or below squelch level. If the + SQL is off this display will be random vectors driven by noise. } + \label{fig:digiscope_psk_nosig} + \end{subfigure} ~ + \begin{subfigure}[t]{0.3\textwidth} + \centering + \includegraphics[width=1.0in]{digiscope-psk.png} + \caption{The display with a normal psk31 signal. The vector flips between 0 and 6 o'clock} + \label{fig:digiscope_psk} + \end{subfigure} ~ + \begin{subfigure}[t]{0.3\textwidth} + \centering + \includegraphics[width=1.0in]{digiscope-psk-low.png} + \caption{AFC off and receive carrier set below the center of the received signal} + \label{fig:digiscope_psk_low} + \end{subfigure} + + \begin{subfigure}[t]{0.3\textwidth} + \centering + \includegraphics[width=1.0in]{digiscope-psk-high.png} + \caption{AFC off and receive carrier set above the center of the received signal.} + \label{fig:digiscope_psk_high} + \end{subfigure} ~ + \begin{subfigure}[t]{0.3\textwidth} + \centering + \includegraphics[width=1.0in]{digiscope-psk-history.png} + \caption{AFC enabled, Fading History Display Mode Selected (left click on scope)} + \label{fig:digiscope_psk_history} + \end{subfigure} ~ + \begin{subfigure}[t]{0.3\textwidth} + \centering + \includegraphics[width=1.0in]{digiscope-psk-history-amplitude.png} + \caption{AFC enabled, Fading History / Amplitude Display Mode Selected (2nd left click on scope)} + \label{fig:digiscope_psk_history_amp} + \end{subfigure} + + \caption{PSK Digiscopes} + \label{fig:psk_digiscopes} + +\end{figure} + +\endlatexonly + +
+ +You can see the effect of mistuning by slewing the carrier carrier +control moving from low to high over the signal . You must do +this with AFC off. Engage the AFC and the vectors will +immediately snap to vertical positions. +
+ +You can alter the appearance of the phase vectors by left clicking on +the digiscope display. One click will give you a history of phase +vectors that fade with time. A second click will give you a +history of phase vectors that both fade with time and are amplitude +significant. The third click returns you to the original phase +vector display. +
+ +The effect is the same with QPSK signals except you will see 4 vectors that +are 90 degrees from each other. +
+ +\section sec_rtty RTTY +
+ + +\image html digiscope-rtty.png "Digiscope RTTY" +\image latex digiscope-rtty.png "Digiscope RTTY" width=1.0in +
+ +The signal can be viewed in two different ways on the digiscope. This +is the time domain representation of the detected FSK signal. The +two yellow lines represent the MARK and SPACE frequencies. This +display is for Baudot, 45.45 baud, 182 Hz shift. If the +transmitting station were transmitting at 200 Hz shift the signal +extremes would lie above and below the yellow lines. Try tuning +across the RTTY signal with the AFC disabled. You will see the +signal move above and below the yellow lines as you tune. Then +enable the AFC and the signal should rapidly move into the center +region of the display. This signal was about 3 - 6 dB above the +noise floor. It looked marginal on the waterfall but still gave +good copy. + +\image html digiscope-rtty-2.png "Digiscope RTTY" +\image latex digiscope-rtty-2.png "Digiscope RTTY" width=1.0in +
+ +This is the other digiscope display for RTTY. You obtain this view by +left clicking anywhere in the digiscope display window. You can +toggle back and forth between these views. The MARK / SPACE +frequencies are represented by the quadrature ellipses. When the +RTTY signal is properly tuned in the lines will be in quadrature and +aligned as shown. Tune across the RTTY signal and the MARK/SPACE +lines will rotate around the center. If the sending station is +using a shift that is smaller than you have the decoder setting then +the two lines will close toward the NW/SE quadrants. If the +sending station is using a shift that is greater than the decoder +setting then the two lines will close toward the NE/SW quadrants. + + +
+\ref digiscope_display_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/DominoEX.txt b/fldigi_doxygen/user_src_docs/DominoEX.txt new file mode 100644 index 00000000..156a729c --- /dev/null +++ b/fldigi_doxygen/user_src_docs/DominoEX.txt @@ -0,0 +1,67 @@ +/** +\page domino_ex_page DominoEX + +\tableofcontents + +The modem code for dominoEX uses a wide band multiple frequency +detector that can lock on and detect the incoming signal even when +badly mistuned. Frequency domain oversampling is used to allow +proper tone detection without the need for AFC. The AFC control does +not alter the decoder in any way. +
+ + +The waterfall and digiscope will appear as: +
+ +\image html dominoex-1.png "DominoEX" +\image latex dominoex-1.png "DominoEX" width=6.5in +
+ +The text displayed in the status area is +the secondary text being sent by the transmitting station. When +the keyboard buffer is empty the dominoEX modem transmits text from the +secondary text buffer. Your secondary text buffer can be edited +on the DominoEX configuration tab. +
+ +The digiscope display represents the tone pairs moving through the tone +filters. You can also use an alternate digiscope display (left click on +the digiscope display area). +
+ +\image html dominoex-1a.png "DominoEX" +\image latex dominoex-1a.png "DominoEX" width=1.0in +
+ +In this display mode the red line represents the center of the multiple +tone bins that are in the detector. The dots will be blurry if the AFC is +not locked on and become very distinct when AFC lock has been achieved. The +tone dots will move from bottom to top (opposite the direction of the +waterfall). +
+ +This is the same signal mistuned:
+
+ +\image html dominoex-1a.png "DominoEX Mistuned" +\image latex dominoex-1a.png "DominoEX Mistuned" width=1.0in +
+ +and with the signal badly mistuned: +
+ +\image html dominoex-3.png "DominoEX Mistuned" +\image latex dominoex-3.png "DominoEX Mistuned" width=6.0in +
+ +See \ref domino_ex_configuration_page "DominoEX Configuration". +
+ +
+\ref domino_ex_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/Doxyfile b/fldigi_doxygen/user_src_docs/Doxyfile new file mode 100644 index 00000000..4ab5b391 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Doxyfile @@ -0,0 +1,81 @@ +# +# +# +# Copyright (C) 2013 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 = "FLDIGI Users Manual" +PROJECT_NUMBER = 3.22 +PROJECT_BRIEF = +ALLEXTERNALS = NO +CASE_SENSE_NAMES = NO +DISABLE_INDEX = NO +DOXYFILE_ENCODING = UTF-8 +INPUT_ENCODING = UTF-8 +ENABLE_PREPROCESSING = NO +ENABLED_SECTIONS = logo_on +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRA_PACKAGES = graphicx caption subcaption float +FILE_PATTERNS = *.cpp *.h *.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 ../images/w4tv +INPUT = index.txt \ + fldigi_configuration.txt fldigi_logging.txt \ + fldigi_macros.txt fldigi_modems.txt fldigi_operating.txt \ + fldigi_developer.txt \ + New-Install.txt thumb_drive.txt colorsandfonts.txt \ + configcallsigndb.txt configContestia.txt configCW.txt \ + configDomEX.txt configFH.txt configFSQ.txt ConfigID.txt configIO.txt ConfigMisc.txt \ + configModemScan.txt configMT63.txt configOlivia.txt ConfigOperator.txt \ + configPSK.txt \ + configRTTY.txt configThor.txt ConfigUI-browser.txt \ + ConfigUI-contest.txt ConfigUI-general.txt ConfigUI-logging.txt \ + ConfigUI-macros.txt configUITouch.txt ConfigUI-WF-controls.txt \ + ConfigWaterfall.txt configure_scripting.txt kiss_io_command.txt \ + SoundCardSetup.txt Contest-How-To.txt cabrilloreporter.txt \ + Logbook.txt LogExports.txt working_logs.txt Macros.txt \ + InlineMacroTags.txt atMacroTags.txt advanced_qsy.txt execmacro.txt CW.txt \ + DominoEX.txt hell.txt Contestia.txt MFSK.txt MT63.txt FSQ.txt \ + Navtex.txt psk.txt Olivia.txt RTTYFSK.txt Thor.txt \ + throb.txt tune.txt WEFAX.txt WWV-xmt.txt FrequencyAnalysis.txt \ + DigiscopeDisplay.txt DigiWWV.txt MousingKeyboardShortcuts.txt \ + Multiples.txt Notifier.txt OperatingControls.txt RST-RSQ.txt \ + Spotter.txt Synop.txt TransceiverControl.txt UTF8.txt \ + pskmail_config.txt PskViewer.txt DXCC_list.txt \ + KeyboardAndKeys.txt KML.txt support_data.txt Installing.txt WindowsOS.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 +INCLUDE_PATH = . +EXAMPLE_PATH = . +OUTPUT_DIRECTORY = ../user_docs +OUTPUT_LANGUAGE = English +PDF_HYPERLINKS = YES +PERL_PATH = /usr/bin/perl +QUIET = NO +RECURSIVE = NO +SEARCHENGINE = NO +STRIP_CODE_COMMENTS = NO +TAGFILES = +USE_PDFLATEX = YES +WARNINGS = YES + diff --git a/fldigi_doxygen/user_src_docs/FSQ.txt b/fldigi_doxygen/user_src_docs/FSQ.txt new file mode 100644 index 00000000..72dd9471 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/FSQ.txt @@ -0,0 +1,688 @@ +/** +\page fsq_page FSQ + +\tableofcontents + +FSQ, Fast Simple QSO, is an Incremental-Frequency-Keyed mode using an offset +differential modulation scheme similar to DominoEX, and Thor. It is a unique +mode for fldigi users in that it is a line by line transmission rather than +character by character. FSQ uses 33 tones spaced by 3 times the 3 baud symbol +rate or 8.8 Hz. The offset rotation of the IFKP sequence offers improved +performance under NVIS conditions, because the rotation significantly reduces +the risk of adjacent symbols causing inter-symbol interference. + +fldigi can operate on the following FSQ modes without special setup by the +operator: +
+ +
+ +Mode | Symbol Rate | WPM | Bandwidth +:------:|:-----------:|:---:|:----------: +FSQ 2 | 1.95 baud | ~20 | 290 Hz +FSQ 3* | 2.93 baud | ~30 | 290 Hz +FSQ 4.5 | 3.91 baud | ~40 | 290 Hz +FSQ 6 | 5.86 baud | ~60 | 290 Hz + +
+* - FSQ-3 is the base rate. + +At the time of this release there is only one other amateur modem application +that supports FSQ, FSQCALL, written by Con Wassilieff, ZL2AFP. FSQ is an invention +of Murray Greenman, ZL1BPU. Both Murray and Con were very supportive during +the development and testing of fldigi's FSQ implementation. + +fldigi-fsq supports the undirected, directed and image modes of FSQCALL. + +This FSQ help content borrows shamelessly from Murray Greenman's (ZL1BPU) +"FSQ Explained" document. + +
+
+\image html fsq-main-dialog.png "fsq main dialog" +\image latex fsq-main-dialog.png "fsq main dialog" width=4.0in +
+
+The main dialog fsq user interface provides an Rx-text panel, a Tx-text panel, +a "Heard" list, fsq specific control buttons, and a signal to noise indicator. + +The Rx-text panel displays all decoded text in the UnDirected Mode. The Tx-text +panel is for entering all transmitted text, including directives. These two panels +can be resized vertically by dragging the dividing bar which separates them. + +
+ + + + + + + + + +The Rx-text panel displays only recognized text in the Directed Mode. The text +parser must be satisfied that the sending stations callsign/crc8 agree and that +the directed station callsign is your own or "allcall". FSQ is case sensitive, +and your sending case must match the senders case, i.e. w1hkj and W1HKJ are not +the same for the purposes of FSQ Directed Mode. + +fldigi-FSQ is active and will respond to directed triggers when the SELCAL button is lit. +Toggling the SELCAL button to "sleep" causes the FSQ parser to only respond to the +∗ trigger. When the ∗ trigger is received the program will return to +the active SELCAL state. + +
+\image html fsq-heard-list.png "Heard List Panel" +\image latex fsq-heard-list.png "Heard List Panel" width=1.5in +
+ +The "Heard" list displays the callsign, s/n, and time of reception of all correctly +decoded transmissions. + +
+\section coding_and_modulation Modulation Scheme + +FSQ is designed to use 32 tone differences between 33 equally spaced tones; so it is +possible to allocate 29 different individual differences directly to the most +frequently used characters. These characters are all lower case, a-z, plus the +most common punctuation symbols: space, full stop (period), and new line (CR/LF). +The three ‘spare’ differences are used to define further code tables. + +The total alphabet includes upper case and a reasonable range of symbols, +yielding a total alphabet of 104 ASCII characters. The extra characters are +allocated to three additional code tables, which are sent as two sequential +tone differences. These are characterized by an initial difference, describing +the character, and a continuation difference, defining the code table. + +When the receiver sees a tone difference in the range 0 – 29, followed by another +in the range 0 – 29, it recognises a single-tone character (lower case etc). +If the tone difference is followed by a difference in the range 30 – 31, it uses +the second difference to decide which code table to select the character from, +and the first difference to choose the character from that table. The encoding +process is the reverse of this. + +
+\image html fsq-varicode.png "FSQ Varicode Table" +\image latex fsq-varicode.png "FSQ Varicode Table" width=5.0in +
+ +IFK codes the data (the initial and continuation codes) as differences between +two tones, rather than as an absolute tone. This is the MFSK equivalent of +differential BPSK, as used in PSK31, etc. MFSK modes such as Piccolo, Coquelet +and MFSK16 use direct MFSK modulation, assigning the code directly to a tone +number. These modes may suffer from more inter-symbol interference than desirable, +cannot tolerate frequency drift, and can be difficult to tune. + +FSQ uses very narrow tone spacing. IFK+ reduces inter-symbol interference by +ensuring that the chance of the same or an adjacent tone being used for +sequential symbols would be very remote. + +Since the tones always change due to the differential action and the tone +rotation of IFK+, there is no opportunity for the tones to remain the same for +two consecutive symbols, which allows the sync-less process to operate correctly. +For example, without IFK+, repeated space characters could be seen as a single +character. + +Finally, since the coding is differential, any drift and frequency offset is +cancelled out during decoding. IFK+ can handle frequency drift of about a third +of the tone spacing per symbol, or in FSQ about 18 Hz drift per second at 6 baud. +Frequency error tolerance is a matter of decoder design, but ± 50 Hz is tolerated +easily by FSQ. + +IFK+, an acronym for Offset Incremental Frequency Keying, was suggested by +Murray Greenman ZL1BPU (2009), and first used in DominoEX. With each symbol +transmitted, as well as adding the difference from the alphabet-coding table +to the previous tone number, an addition rotation offset is added. In the case +of FSQ, this value is ONE. + +Only one tone is transmitted at a time. + +In order for the first difference (first character) to be correctly decoded, a +dummy tone needs to be transmitted first. This could be the lowest tone, but in +fact any permitted tone will suffice since only the difference to the next tone +is important. The software simply sends a space character to achieve this. + +\section transmit_functions Transmit Functions + +The user types text into the Tx panel, which can be edited before transmission. +Transmission starts when an ENTER character is pressed. It will also start as a +result of one of the automatic processes, such as ‘Sounding’ or automated replies. + +The characters in the Tx panel are then encoded, and transmitted at +the currently set symbol rate. As they are transmitted, the characters are +transferred to the receive pane as a record of what has been transmitted. + +BOT Sequence + +At the start of transmission in directed and non-Directed Mode, the BOT sequence, +a SPACE followed by a LINEFEED, is sent. The space serves as a dummy symbol to +allow the next tone difference to be measured. The LF character ensures that +reception starts on a new line. + +In Directed Mode, the LF also serves as one delimiter for the callsign search +algorithm. The other delimiter is the colon that follows the callsign. This also +locates the two callsign checksum characters. + +EOT Sequence + +At the end of transmission in UnDirected Mode, the transmitter is simply turned +off once the last useful character is sent. In Directed Mode, however, a special +character sequence is sent just before the transmission stops, to signal EOT. + +The BS (backspace) character is not required in FSQ, so the corresponding character +in the table has been reallocated as an EOT marker. + +The purpose of the EOT sequence is to cause the Squelch to close quickly in Directed +Mode. Print will continue through fades without fldigi closing and stopping print +partway through a sentence. If the sentence transmission were to finish without +the EOT, the squelch would close slowly, and junk would print unnecessarily. The +EOT ‘shorts out’ the Squelch time constant, closing the Squelch instantly. + +The transmission consists of 33 tones spaced 8.7890625 Hz, resulting in a spread +of tones of 290.0390625 Hz. Using the ITU-R SM.1138 assessment method, the signal +easily meets 300 Hz useful bandwidth, at all signalling speeds, and its ITU +Emission Designator is therefore 300HF1B. + +In Directed mode, a conventional network model CSMA protocol decides when the +station may have access to the radio channel. This protocol defines three classes +of message (chat, responses and soundings), and applies priorities to them. +Priority is provided by means of delays after Squelch has closed. In addition, +to limit clashes between stations wanting access for the same priority message, +random delays are also added. + +
+ +Priority | Delay | Message Type +:-------:|:-------:|:-------------------------------: + 1 | Short | Chat sentences + 2 | Med | Automated responses to commands + 3 | Long | Sounding + +
+ +Sounding + +In Directed Mode, the user may elect to send regular ‘soundings’. These are very +short messages with no trigger command and no message body. The message consists +only of the callsign, colon and checksum of the FSQCall preamble. + +These sentences do not print at any station, but appear in the Heard List and are +logged in the Heard Log. This allows all stations on the channel to know what other +stations are there with minimum use of channel bandwidth. + +Sounding is sent with the lowest message priority. Sounding is essentially +random, although the time between Sounds is selectable at 1, 10 and 30 minute +intervals. The start time is set by user action, and essentially random. + +\section fsq_protocol FSQ Protocol + +FSQ is designed as a ‘chat’ mode, not a long-over QSO mode. It is capable of +sending multiple sentences in each transmission, but it is easiest and quickest +when just one sentence is sent. + +Each transmission starts with the fldigi station callsign (converted to lowercase). + +For example, if the user (say zl1xyz) types: + + Hello John – how are you this evening + +The software actually transmits: + + zl1xyz:Hello John – how are you this evening + +Nothing could be simpler. Every station within range will print this message. + +Performance + +There is no error correction involved, so users rely on the inherent robustness +of the mode, and if there are errors, either due to ‘typos’ or reception errors, +the users will quickly recognise these. If an error causes confusion, they can +always ask for a repeat. + +Operating 20W on the 40m band during the middle of the day, an automated station +300 km away was used to return transmitted sentences. From 250 words transmitted, +at 6 baud, 223 were returned correct (89.2% copy), while at 3 baud, copy was 100%. +For practical purposes, 80% copy is considered adequate for a comfortable QSO. + +Tests using an ionospheric simulator bear these measurements out. Reception is +essentially 100% for white-noise tests with the signal above –15dB S/N. + +\section directed_mode Directed Mode + +FSQ Directed Mode operates as a simple extension of the FSQ protocol. The +preamble is changed a little, a direction (address and command) is applied, and +finally a short EOT signal is added to the end of each message. These differences +are simple to apply, as the user only needs to learn a few simple commands and +remember to add a direction and command to each sentence. The rest is automatic. + +Further, directed sentences in FSQ mode can be read easily in undirected FSQ mode, +and undirected text is visible in the monitor panel which can be viewed in +Directed Mode. In Directed Mode, only text directed to your callsign will print +in the Rx panel, and only commands directed to your station will be responded to. + +
+\image html fsq-mon-dialog.png "FSQ Monitor Panel - a Directed Mode Sentence" +\image latex fsq-mon-dialog.png "FSQ Monitor Panel - a Directed Mode Sentence" width=3.5in +
+ +The Monitor Panel is only shown during Directed Mode operation. It is minimized +when Undirected Mode is in use. All incoming traffic is printed on the Monitor +Panel. This includes both Directed and Undirected traffic. The decoding is +affected by the fldigi squelch setting. + +You may see what appears to be a perfectly good Directed data stream on the Monitor +Panel which never appears on the Rx Panel. When this occurs, the data stream has +failed to parse correctly: +
    +
  1. the BOT is missing or corrupt, +
  2. the CRC8 check has failed, +
  3. the EOT is missing or corrupt, +
  4. or it is not directed to your callsign or allcall. +
+ +FSQCall Preamble + +The FSQCall preamble consists of the sending station’s callsign, a colon, and a +two character hexadecimal checksum. For example, the simplest transmission, a +Sounding message, consists of only this. For example: + + zl1bpu:b6 + +The checksum is a standard CCITT CRC8 calculated on the callsign and the colon. +The maximum callsign length is 16 characters, and the CRC is capable of detecting +up to four errors in this distance reliably. Pseudo-callsigns (such as place +names or personal names) can be used, which is very convenient for Public Service +and Emergency applications. + +Directions and Triggers + +All FSQ Directed Mode messages, apart from the Sounding, carry at least one +direction and a trigger. The direction is the callsign or callsigns of the +recipient station or stations, in other words, where the message is directed. +The trigger is one of a short list of one-letter commands sent to the directed +station, which define what it should do with the message. There may or may not +be a message body following the directions and triggers. + +Here are some simple examples: +
+\image html fsq-directed-mode-examples.png "Directed Mode Examples" +\image latex fsq-directed-mode-examples.png "Directed Mode Examples" width=3.0in +
+ +In the first example, ZL1BPU is simply chatting to ZL1ABC. He starts typing by +giving the direction, the other station’s callsign. The trigger used is a space, +which is understood by the receiving station as an invitation to print the message +that follows. + +The second example illustrates how you can send the same sentence to two stations. +There is also an ‘all stations’ direction (allcall) that can be used to send +messages and some commands to all stations within range. + +The third is an example of a simple automated query. It is the FSQ way of asking +for a signal report. The queried station will respond with your s/n report as +measured by the FSQ program that is being used. + +Error Checking + +FSQ Directed Mode sentences are checked at the receiver in two ways. First, the +sender’s callsign is checked against the checksum received: if this is incorrect, +the sentence is rejected. If it is correct, the rest of the sentence is checked +to find the recipient’s callsign. If this is not received correctly, the sentence +is again rejected. If the callsign is received correctly, only the remainder of +the message following the recipient’s callsign is printed or acted upon. + +When (and if) the incoming message is displayed, the preamble is shown without +the checksum, so it looks like the preamble in the UnDirected Mode. However, the +callsign displayed is in this case the callsign verified by the checksum. + +Checking the validity of the originator’s callsign ensures that the message is +correctly attributed, is correctly logged, and most significantly, responses can +be sent to the correct station. + +Logging + +In Directed Mode, FSQ maintains a log of all stations heard, in chronological +order. With each entry, verified callsign, the date/time, and measured SNR are +recorded in CSV (comma separated value) format. This is suitable for examination +as a spreadsheet. The heard log file is named "fsq_heard_log.txt" and is located +in the fldigi.files/temp folder. + +A complete audit log of transactions is also maintained in Directed Mode. This +includes regular time stamps, all raw received text, and all transmitted sentences. +The audit log is named "fsq_audit_log.txt" and is located in the fldigi.files/temp +folder. + +Directed Callsigns +
    +
  1. Each station responds to three ‘callsigns’. +
  2. The operator callsign (fldigi converts operator call to lowercase). +
  3. The ‘callsign’ allcall, to which the software will act upon certain messages, +including chat, file and image transfer, and alerts. This mechanism is widely +used in nets to send chat to everyone in range. +
  4. The ‘callsign’ cqcqcq is recognised as a legitimate chat ‘callsign’. +
+
+Use of Lower Case + +FSQ is case sensitive, so messages directed (for example) to ‘ZL1EE’ will not +be recognised by the station with its callsign set to ‘zl1ee’. Lower case is not +mandatory for operator callsigns, but is encouraged for these reasons: +
    +
  1. Lower case is quicker and easier to type. +
  2. Lower case is faster to send (most characters are sent in one symbol). +
  3. The error rate is half that of upper case characters. +
+
+ + +\section fsq_triggers Triggers + +All the command triggers (currently) consist of one reserved character. These +are taken from a pool of characters that are not permitted in callsigns. As far +as possible, the characters have a meaning easily associated with the character. + +This list shows all the reserved characters, and their current or planned use. +Blank entries are reserved, with no currently planned application. + +
+ +CHAR | ASCII | USE +:-----:|:-----:|:-------------------------------------------: +Space | 32 | Directed chat +! | 33 | Repeat command +\" | 34 | -- +# | 35 | Message or file transfer +$ | 36 | Request Heard List +% | 37 | Receive image +& | 38 | Report QTC message +‘ | 39 | -- +( | 40 | -- +) | 41 | -- +∗ | 42 | Restore FSQ to ACTIVE from SLEEP ++ | 43 | Message retreive +, | 44 | -- +- | 45 | Message delete (1) +. | 46 | -- +: | 58 | Reserved, not used. +; | 59 | Relay command +< | 60 | Reduce sending speed += | 61 | Reserved for ECC file transfer +\> | 62 | Increase sending speed +? | 63 | Report reception +@ | 64 | Report QTH (or position) message +[ | 91 | Used in file transfers +\ | 92 | -- +] | 93 | Used in file transfers +^ | 94 | Report FSQ program version +_ | 95 | Report the squelch setting in dB (1) +` | 96 | -- +{ | 123 | -- +\| | 124 | Send Alert +} | 125 | -- +~ | 126 | Delayed Repeat command +
+(1) not supported + +\section fsq_commands Commands + +Command sentences consist of a direction followed immediately by a command. +Multiple directions can be used in the same sentence under limited circumstances. +Two directions in the same sentence, which are understood by the same station, +will cause confusion, and only the second will be responded to. For example, one +should not send ‘zl1xyz@ allcall message’, as the first part will be ignored by +station zl1xyz. + +Command Syntax + +The syntax for currently defined commands is listed below. + +
    +
  • callsign text Addressee station starts to print text. No trigger character used except space following callsign. You MUST use a space or the trigger will not be recognised. +
  • callsign? text (Is station hearing me?) Addressee station starts to print text. When squelch closes, station responds: origin_callsign snr=xxdB +
  • callsign\* Switches station to ACTIVE if FSQSEL is in SLEEP. Addressee station starts to print. When squelch closes, station responds: callsign: Active +
  • callsign! message (Repeat my message) Addressee station starts to print. When squelch closes, station responds: callsign: message. This is a simple relay mechanism. message may contain further trigger commands. +
  • callsign~ message (Repeat my message later) Addressee station starts to print. When squelch closes, after a delay of about 15 seconds, station responds: callsign: message This delayed relay is useful when stations mentioned in message can hear and respond to the original message. +
  • callsign; [relay_to]{trigger}{message} Relay my message to the 'relay_to' station. See Relay section for details. +
  • callsign!sendto message Relay message to the 'sendto' station. Addressee station starts to print. When squelch closes, station relays the message. +
  • callsign#[nnn] (Send file to station) Addressee station starts to print. Text following [nnn] will be saved in or appended to text file nnn.txt in the same folder as the log/audit files. When squelch closes, station responds callsign: Ack if the message stored OK. There is no response if the message was not received. [nnn] can be alpha, numeric or mixed. +
  • callsign#[filename.txt] (Send file to station) Addressee station starts to print. File is opened from menu, and filename appended to message before file body text, File will be saved in or appended to text file filename.txt in the same folder as the log/audit files. When squelch closes, station responds callsign: if the message stored OK. There is no response if the message was not received. [nnn] can be alpha, numeric or mixed. +
  • callsign\@ (Request station position or location information) Addressee station starts to print. When squelch closes, station responds with pre-recorded sentence, typically containing QTH information. This could be GPS position, locator, or physical address. This is the message stored and retreived by the QTH button. +
  • callsign& (Request station message) Addressee station starts to print. When squelch closes, station responds with pre-recorded sentence, typically containing station information or an 'Out to Lunch' message. This is the message stored by the QTC button. +
  • callsign^ (Request Software Version) Addressee station starts to print. When squelch closes, station responds with current FSQCALL software version. +
  • callsign% (Send image) Addressed station receives the command to record +an analog graphic image. The Rx Image Dialog will open and the image painted as it +is being received. Images are in color or grey scale and always +displayed in native size.. Images can be directed to allcall. +
  • callsign|message (Send alert) Addressee station starts to print. Alert pop-up box containing message is placed on the screen. When the operator closes this dialog, a response transmission is made: origin_callsign Alert ack +
  • cqcqcq text (Call for general chat) Following text prints. +
  • allcall text (All stations print) Following text prints at all stations. +
  • callsign\> or callsign\< (Speed change) +\> increases speed, \< decreases speed at target station. +Response is origin_callsign: 4.5 baud (or whatever the new speed is). +If the speed is already at the maximum or minimum speed, the response is the same, +and there is no speed change. +
  • allcall#[nnn] (Send file to all stations) All stations within range start to print. +Text following [nnn] will be saved in or appended to text file nnn.txt. When +squelch closes, station responds callsign: Ack if the message stored OK. There +is no response if the message was not received. allcall#[filename.txt] works the +same as callsign#[filename.txt]. +
+
+ +\section relaying_message Relaying messages + +This is a relay mechanism which preserves the origin callsign as the message propagates +so that any response can be relayed back to that station. message can contain further +trigger commands. + +Originating station: relay_callsign; dest_callsign message + +\image html fsq-relay-examples.png "Relay Examples" +\image latex fsq-relay-examples.png "Relay Examples" width=4.5in + +\section fsq_keyboard_keys Special keys + +Pressing the F1 key will transfer the "last call" selected from the heard list to the +Tx panel. "last call" defaults to allcall on program startup. + +Pressing the F2 key will transfer the last command to the Tx panel. The last command +is an empty string on program startup. + +\section fsq_heard Heard List + +The FSQ heard list is automatically added to, modified, and aged in accordance +with the FSQ user configuration parameters. Each time a valid callsign/crc8 pair +is discovered it is either added to the heard list, or it's entry is updated with +the last GMT and signal-to-noise ratio. + +A single click on a heard list entry will make it the "last call" string. + +A double click on a heard list entry will also add the call to the Tx panel. If multiple +heard list entries are double clicked each one is added to the Tx panel separated by +a space. + +
+\image html fsq-heard-list.png "Heard List" +\image latex fsq-heard-list.png "Heard List" width=1.5in +
+ +Heard list entries have an associated pop-up menu, available by right-clicking on +the desired entry: + +
+
+ \image html fsq-undirected-mode.png "Undirected Mode" + \image latex fsq-undirected-mode.png "Undirected Mode" width=1.5in +
+ \image html fsq-directed-mode.png "Directed Mode" + \image latex fsq-directed-mode.png "Directed Mode" width=1.5in +
+ + + + +
+ \image html fsq-allcall-popup.png "All Call Menu" + \image latex fsq-allcall-popup.png "All Call Menu" width=2.0in + + \image html fsq-directed-popup.png "Directed Menu" + \image latex fsq-directed-popup.png "Directed Menu" width=2.0in +
+
+ +\section fsq_image_mode Image Mode + +fldigi-fsq has the ability to transmit and receive small digital images selected +from those stored on the disk. The image transmission is similar to but not +compatible with the MFSKpic modes. FSQ images are always transmitted in a fixed +width to height ratio. The W x H format is not limited to a single ratio, nor is +it limited to just color, or just gray scale. + +The start of the picture is signalled digitally, and the receiver simply captures +data continuously for W lines of H pixels, as requested, resulting in a WxH pixel +image, then reception stops. + +The images are approximately in 4:3 or 3:4 aspect ratio. Images must be sent and +received in Directed Mode, and can be sent to just one recipient, to several +recipients, or everyone on the channel, just as with other messages. + +Available image aspect ratios / formats include: + +
    +
  • 160x120 color (1) +
  • 320x240 color (1) +
  • 640x480 grey (1) +
  • 640x480 color (1) +
  • 240x300 color +
  • 240x300 grey +
  • 120x150 color +
  • 120x150 grey +
+(1) compatible with the program FSQCALL + +Narrow-Band Images + +FSQ Image Mode was designed for NVIS propagation on the lower HF bands. +Unlike SSTV, the pictures are sent relatively slowly, in a narrow bandwidth +(1/4 of SSTV), and as a result the picture signal to noise ratio is generally +better than SSTV for the same transmission power. As a guideline, FSQ signals +(before the picture is started) need to be about +10dB SNR for noise-free picture +reception. + +FSQ pictures also offer significantly better reception than SSTV under NVIS +conditions. Because there is no picture sync, there is no risk of the picture +tearing due to timing changes, or breaking up during selective fades. All that +happens is that the image may noise up momentarily, but will stay correctly +aligned. The mode is also significantly less affected by ghosting. + +Image Format + +The image mode sampling rate is 12,000 samples/sec, the same as the text mode. +Each pixel consists of 10 samples, and there are P pixels/line. Therefore the +line period is 10 x P/12000 seconds, or the line rate 12000/(10 x P) lines/sec. +In colour, each line is sent three times, in BGR order. + +As an example, if there were 320 pixels per line, and 240 lines, the line rate +would be 3.75 lines/sec, and 240 x 3 (for RGB) lines would take 192 seconds, or +3.2 minutes for a colour picture containing 76,800 pixels. + +There is no horizontal (line) sync sent with the picture, and no vertical sync +at the start of the picture. As a result, it is possible for reception to start +slightly earlier or later than the standard delay from the time of the command, +depending on the relative speed of the computers used at either end. This has +two effects: first, the picture may be recorded shifted left or right, and the +pixel colour order may be wrong. This is easily fixed after reception using the +Phase control. + +If the sound cards in the transmitting and receiving computers differ markedly +in sample rate, the resulting picture can also be skewed. A small timing +difference is enough to cause a noticeable slant in the picture. This is easily +fixed after reception using the Slant control. High quality sound cards should +be better than 5ppm, and result in barely noticeable slant, but some cheaper +computer built-in sound modules may be rather worse. If you plan to send FSQ +images you should calibrate your sound card to WWV. + +Receive Image + +
+\image html fsq-image-rx.png "Image Reception" +\image latex fsq-image-rx.png "Image Reception" width=4.5in +
+ +Reception is completely automatic. Provided the software is in Directed Mode, and +the sending station uses the correct callsign and trigger command, the decoder +will identify the picture start, and record the picture. In doing so, it +automatically opens a separate "FSQ Rx Image" dialog. + +Demodulation uses a phase detection algorithm based on quadrature demodulation +using the current and previous samples at 12000 samples/sec. All the samples are +converted to pixels and stored, but only the average over every 10 samples is +displayed. + +The raw image is stored in a temporary buffer of expanded size, which allows +fine adjustment of the slant and phase to be made before the image is sampled +and displayed. + +If the transmitting station goes off the air or reception is lost during +recording of a picture, the recording will continue until the necessary number +of samples has been made, then reception stops. + +\image html fsq-rx-image-raw.png "Received - no correction" +\image latex fsq-rx-image-raw.png "Received - no correction" width = 4.0in + +The Rx Image dialog controls from left to right are: +- Reset: clears all rx data +- Phase adjustment: moves image left and right +- Slant adjustment: slews image diagonally +- Save: saves the image to the fldigi image folder with a date-time stamped file name +- Close: closes the image dialog + +\image html fsq-rx-image-corrected.png "Received - phase corrected" +\image latex fsq-rx-image-corrected.png "Received - phase corrected" width = 4.0in + +Image phase and slant should not be adjusted before the picture reception has +finished, as then only part of the image will be corrected. + +Transmit Image + +Access to the transmit image functions is only available via the heard list pop-up +menus. Right click on the recipient call sign and select the "Send Image to ..." item +from the pop-up menu. + +
+\image html fsq-image-xmt.png "Image Transmission" +\image latex fsq-image-xmt.png "Image Transmission" width=4.5in +
+ +A file open dialog is displayed when the "Load" button is pressed on the TX Image +dialog. This allows the user to select any image in a number of different standard +formats. The image is rendered to the selected image size using a resampling process. +fldigi will try to force fit the image to the selected aspect ratio. You should +try to work with images that are in a 4:3 or a 3:4 aspect ratio. The selected +image does not need to be the same size. Fldigi will enlarge or reduce the image +using a resampling technique to fit the selected image size. The example photo +of Star Gazer lilies is a 3.2 MB file, 3008 x 2000 pixels. It was taken in my lily +patch in June 2014. + +Once the image has been loaded, the user starts the transmission by pressing the +"Xmt" button on the transmit image dialog. fldigi formats the correct command +sequence and starts the transmission. + +The recipient callsign for image transmission can be a single callsign, or allcall. +Sending to a single recipient or to allcall is accomplished as described above. To +send to multiple addresses you must add their callsigns to the Tx panel, separated +by spaces and with a trailing space. Then press the Xmt button on the Tx Image dialog. + +fldigi returns to the receive mode at the conclusion of the image transfer. + +\section fsq_rsid Disable RxID + +You will probably want to disable the RxID detector during FSQ operations. If RxID +is enabled and an RsID signal is detected the program will switch to the mode +specified by the RxID. That will completely alter the user interface. + +\ref fsq_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" +*/ + diff --git a/fldigi_doxygen/user_src_docs/FrequencyAnalysis.txt b/fldigi_doxygen/user_src_docs/FrequencyAnalysis.txt new file mode 100644 index 00000000..116eaa88 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/FrequencyAnalysis.txt @@ -0,0 +1,54 @@ +/** +\page frequency_analyzer_page Frequency Analyzer + +\tableofcontents +
+
+ +Fldigi can be used to accurately measure the frequency of a remote signal +that is transmitting a steady carrier. +
+ +\image html FreqAnal.png "Frequency Analyzer" +\image latex FreqAnal.png "Frequency Analyzer" width=6.5in +
+ +I have set the sound card up using the WWV modem and have it adjusted +for the proper PPM offset on receive. I followed the frequency calibration +procedure that ICOM recommends for the IC-746PRO, adjusting WWV at +10 MHz for a zero beat. +
+ +Then fldigi was used in the "Freq Analysis" mode to track the WWV carrier +at 10 MHz. In this mode the decoder is merely a very narrow band +AFC tracking filter. The filter bandwidth is set to 2 Hz and the +tracking time constants to about 5 seconds. Future releases will +probably make both of these user adjustable. When the signal is +being tracked the digiscope (right hand display) will be a horizontal +line. If the signal is very noisy and tracking difficult the +digiscope will jump and become wavy. You can see from the above +image that I am tracking about 0.22 Hz high on WWV. I have +repeated this measurement at various times during the day and on +various days with nearly the same result. So I am comfortable +with knowing that my local oscillator is just a little low (that is why +the Frequency reads high). +
+ +ARRL frequently announces a frequency measurement test (FMT) which takes +place on 160, 80 and 40 meters. This is a chance to test your +skills in frequency measurement. You should be able to make a +submission to the FMT using this technique. Make corrections to the FMT +transmission based upon your WWV measurement. You may have to adjust +for other local oscillator effects as well. If you have some good +ways to measure and correct for these I would be glad to share them +with the other fldigi users. +
+ +
+\ref frequency_analyzer_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + diff --git a/fldigi_doxygen/user_src_docs/InlineMacroTags.txt b/fldigi_doxygen/user_src_docs/InlineMacroTags.txt new file mode 100644 index 00000000..4559d9af --- /dev/null +++ b/fldigi_doxygen/user_src_docs/InlineMacroTags.txt @@ -0,0 +1,198 @@ +/** +\page inline_macro_page Inline Macros + +\tableofcontents + + +The following macro tags will be parsed and acted upon then they occur +during the transmission of the macro. +
+ + Tag | Description +:------------------------: | :----------------- +\ | CW words per minute +\ | CW post delay +\ | CW pre delay +\\ | CW rise/decay time +\ | Change to specified modem with parameters +\ | Move audio carrier to mode sweet spot frequency +\ | Move audio carrier to specific audio frequency +\ | Move to specific RF and Audio frequency +\ | Transmit idle signal for specified number of seconds +\ | Wait (no audio) for specified number of seconds +\ | CW - ww = WPM, optional ff = Farnsworth wpm + +
+ +Note that each of these tags is identical to their immediate mode +counterparts. The exception is the addition of the exclamation +mark following the leading '\<'. The use of these tags is best +explained by example. +
+ + +\section cw_code_practice CW Code Practice Transmission + +\verbatim + + +NOW IS THE TIME - now 180 wpm + +FOR ALL GOOD MEN TO COME TO THE AID of their country. +now 30 wpm +de k + +\endverbatim +
+ +
    +
  • Modem type is changed to CW before start of transmission (\) + does not have the addition of the ! symbol
    • +
  • Audio carrier is changed to 600 Hertz
    • +
  • Transmit WPM set to 30 words per minute, followed by text
    • +
  • Transmit is silent for 2 seconds
    • +
  • Rise time, pre and post delays are adjusted and the WPM changed to 180 + words per minute
    • +
  • Text is sent at 180 WPM
    • +
  • WPM changed to 30 words per minute, followed by identification string + and signoff
    • +
  • Return to receive
    • +
+ +This is a more complex macro that might be used for a code practice +transmission such as the W1AW broadcast on 3580 KHz.
+
+ +\verbatim + + + + + + + + +end of broadcast de k + +\endverbatim +
+ +\section qsy_test QSY:ffff.f:aaaa test + +\verbatim + + + +RYRYRYRYRYRY de k + +\endverbatim +
+ +
    +
  • Change modem type to NULL to suppress sending any signal when +transmit enabled. This is necessary to allow the transmit data +stream to be processed.
    • +
  • Send frequency change command to transceiver, new frequency is 3583.0 + kHz. Set audio frequency to 1750 Hz
    • +
  • Change modem to RTTY, 170 Hz shift, 45.45 Baud, 5 Bit code (standard + Baudot)
    • +
  • Send RY... text
    • +
  • Return to receive
    • +
+ +\section advanced_qsy Advanced QSY operations + +Several QSY frequencies or ranges of frequencies provided by one increment, +can be proposed, in which case the first frequency after the current +frequency is chosen. + +\ref advanced_qsy_page +
+ +\section arrl_style_broadcast ARRL style broadcast in multiple modes + +\verbatim + + + + + + + +\endverbatim +
+ +
    +
  • Change modem type to NULL to suppress transmission and start the Tx + data stream processor
    • +
  • Send frequency change command to transceiver, new frequency is +3594 kHz, audio frequency 915 Hz. Note that this puts the MARK tone at +1000 Hz.
    • +
  • Change modem to RTTY 170 Hz shift, 45.45 baud (default is 5 bits). + Idle for 2 seconds.
    • +
  • Send the file contents of specified file
    • +
  • Change to NULL modem. Turns off the RTTY diddle ... audio stream is + silent.
    • +
  • Change audio frequency to 1000 Hz. Idle for 5 seconds (complete + silence of transmit)
    • +
  • Change modem type to BPSK-31. Send BPSK idle for 2 seconds
    • +
  • Send the file contents of specified file
    • +
  • Return to receive (note that the \ can appear anywhere +is the macro definition as it is executed when the macro text is +parsed). \ is always moved to the end of the Tx +buffer. It could also have appeared anywhere in the macro string.
    • +
+ +\section appearance_tx_buffer Appearance of tx buffer + +\verbatim +^! +^!^! +QST de W1HKJ +Test bulletin for 9/7/2011 +QST de W1HKJ SK + +^!^!^!^!^! +QST de W1HKJ +Test bulletin for 9/7/2011 +QST de W1HKJ SK + +^r +\endverbatim +
+ +This is the contents of the ARRL broadcast macro text at the time the +macro button is pressed. Each of the \ +
+ +\verbatim + + + + +QST DE W1HKJ +TEST BULLETIN FOR 9/7/2011 +QST DE W1HKJ SK + + + + + + + +QST de W1HKJ +Test bulletin for 9/7/2011 +QST de W1HKJ SK +\endverbatim + +
+\ref inline_macro_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/Installing.txt b/fldigi_doxygen/user_src_docs/Installing.txt new file mode 100644 index 00000000..e9dad569 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Installing.txt @@ -0,0 +1,30 @@ +/** +\page install_from_source_page Installing from Source + +\tableofcontents + +The developers recommend that you build either fldigi from source or install +from the repository associated with your distribution. The repository may +not be immediately available for the most current version number. In that +case you can try installing the binary distribution. Keep in mind that the +version numbers of the dependent shared libraries must match those on the +machine used to create the binary. + +The source code for fldigi is very large and has a number of dependencies +that must be satisfied before a successful compile. If you are not familiar +with compiling and linking source code you should probably practice on a +simpler package before treading these waters. Please refer to the following +web site for information on building for +Linux, Windows and OS X. +
+ +Fldigi WIKI - build instructions +
+ +
+\ref install_from_source_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/KML.txt b/fldigi_doxygen/user_src_docs/KML.txt new file mode 100644 index 00000000..20843410 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/KML.txt @@ -0,0 +1,444 @@ +/** +\page kml_page KML + +\tableofcontents + +\image html KML-Logo.png "KML Logo" +\image latex KML-Logo.png "KML Logo" width=1.0in +
+ +Section data_source Data sources +
+ +Keyhole +Markup Language + +(KML) is an XML file format for geographic visualization in +two-dimensional maps such as Google Maps and three-dimensional earth +browsers such as Google Earth +or Marble. +
+ +Fldigi can generate data with geographical locations, which can be used to +generate KML data. This list might expand in the future + +
    +
  • The emitting station of a + Navtex message.
    • +
  • The origin of a SYNOP + weather report.
    • +
  • The Maidenhead locator of the user, as entered in fldigi user's + profile.
    • +
+
+ +\section kml_generation_navtex KML generation from Navtex messages + +\image html config-modem-navtex.png "Navtex configuration tab with KML option" +\image latex config-modem-navtex.png "Navtex configuration tab with KML option" width=5.0in +
+ +Each Navtex message comes with the code of the sending station, also +called origin. + +These messages are displayed, in KML files, at the coordinates of the +sender. That is: KML placemarks are created or updated with these +coordinates. Fldigi parses the Navtex reports, uses the station identifier +to make a lookup in the Navtex stations file which contains geographical +coordinates. These coordinates are used to create KML placemarks. +
+ +More explanation about how station coordinates are used, are given at +the \ref navtex_and_sitorb_page "Navtex page". +
+ +Navtex messages are quite often sent with embedded coordinates of the event +they describe (Ship wreck, oil exploration etc...). For example: +\"LIGHT BUOY MARKING DANGEROUS WRECK 58-01.2 NORTH 005-27.1 WEST\" +or \"THREE MEN OVERBOARD IN PSN 39-07,7N 026-39,2E\" . A +future version will parse the content of the message, extracting raw +coordinates, and will display a graphic entity at the location of the +described event. +
+ +\section kml_generation_synop KML generation from SYNOP reports + +SYNOP is a code used for reporting weather +information and as such, is used to broadcast meteorological data by +radio. One of the most important emitter is +Deutsche Wetterdienst which transmits them in RTTY, +and fldigi is able to decode them and generate KML placemarks at the +location of the weather information. +
+ + +\section kml_file_structure KML files structure +
+ +The KML data are made of different files + +
+ + + + + + + + + + + + + + + + + + + + + +
fldigi.kmlEntry point. Only this one has to be loaded. It never +changes.
styles.kmlKML style sheet. Freely changeable by the user, for +example to customize the icons.
User.kmlLocation of the user based on +his/her Maidenhead +locator.
Synop.kmlSynop weather reports displayed at the location of the +WMO station, or ship, or buoy.
Navtex.kmlNavtex reports, displayed at the place of the emitting +station. A future version will plot the position of the coordinates +indicated in the Navtex messages themselves.
+
+ +
+\section extended_data Extended data + +When creating a new placemark, written in of the KML data files +(Synop.kml, Navtex.kml etc... ) data are sent to +the KML module in the form of key-value pairs and are written into two forms: +
+ +
    +
  • HTML content, in the \ tag, + surrounded by CDATA directives. The HTML format is chosen + exclusively for display purpose and might change at any new version.
    • +
  • Regular \ XML tags: These data + are internally used by Fldigi to reload the previous session. The + format is stable and can be used by external applications. All useful + data are saved.
    • +
+ + +\section paramaters Parameters + +\image html config-misc-kml.png "KML configuration tab" +\image latex config-misc-kml.png "KML configuration tab" width=5.0in +
+ +Fldigi maintains in a internal container, a set of placemarks which are data +associated to geographical coordinates, an unique name, a set of +key-value pairs and a timestamp. At regular intervals, a thread is +woken up to save these geographical data to a KML file, in a +specific directory. At this moment, a process can be started, running +an external command. Depending on the type of data, a given +file name will be used. +
+ +All KML files are accessible from an unique KML +filename. Placemarks are identified with an unique name, for +example a vessel name, or their WMO identifier. Placemark with a moving +position such as ships, can have their path visualized because they +still cen be identified in two different reports. These reports can be +kept as separate, or they can be merged into a single placemark: This +depends on the distance between two placemarks with the same name, +compared to the merging distance parameter. +
+ +Data can be kept for a given retention time, +after which delay they are purged. At startup, former KML data can be +reloaded, or cleaned up. Data as key-value pairs associated to a given +placemarks can be displayed several ways. +
+ +All these parameters are controlled by the KML configuration tab. +
+ + +\section destination_directory Destination directory + +\image html KML-Directory.png "Directory of generated KML files" +\image latex KML-Directory.png "Directory of generated KML files" width=4.0in +
+ +The default destination directory where KML files are saved is a +subdirectory called /kml in the fldigi users directory. For example on +Linux: $HOME/.fldigi/kml/ and +\/fldigi.files/kml on Windows™. This +destination can be freely changed. +
+ +The file fldigi.css is created at installation, and is not changed +later. Therefore it is possible to customize it by adding specific +icons. +
+ +The file fldigi.kml is created by fldigi when it is not there, +or when the refresh interval is changed. +
+ +If this destination directory is accessible from the internet, then it can +be published to Google Maps.
+ +Note: + +Files updates are atomic. This means that a file is not accessible by a +reader until it is completely written and closed. This is achieved by +writing into temporary files, which are atomically renamed (POSIX +function rename() ) at the end of operation. +
+
+ +Therefore, the KML destination directory can safely be accessed by one +writer and multiple readers. Several sessions of fldigi might also updates +different KML files, as long as the main fldigi.kml file is +not changed. + +\section kml_root_file KML root file + +This is the default name of the entry file of the generated KML document, +which by default is fldigi.kml. If it does not exist, it is generated with +the list of possible source of KML data (Synop, +Navtex etc...). If Google +Earth or Marble +are installed on your machine, then they are associated to the file +extension .kml and you just need to click on fldigi.kml to visualize +it. It is automatically refreshed when fldigi adds new Synop weather +reports or Navtex messages to it. +
+ + +\section kml_refresh_interval KML refresh interval + +This delay, in seconds, is used at two places: +
+ +
    +
  • This is the frequency at + which new KML files are created, if new data is available
    • +
  • This is the refresh interval specified in the KML file with + tag \.
    • +
+
+ +This should not be too small, especially if the data files are big, otherwise +fldigi will spend most of its time refreshing KML data, and accordingly +Google Earth or Marble, reloading them. + +\section clean_up_on_startup Cleanup on startup + +By default, at startup, fldigi reloads the existing KML files, extracting +the key-value pairs contained in the "ExtendedData" tags. However, it +is possible to force fldigi to restart from scratch. +
+ + +\section merge_distance Merging distance + +Different reports with the same placemark name can be merged into a +single report if their distance is below a given threshold which is the +merging distance. Otherwise, separate placemarks are created and joined +by a red line, visible in the KML document. +
+ +\section kml_ballon_display_type KML balloon display type + +Reports are inserted in the KML document one after the other. These +description data are visible as KML balloons, or when getting +placemark properties. If they have the same name and are within the merging +distance, they will form a single placemark. The descriptions of each +report will be displayed and merged by three possible ways. +
+ +\subsection plain_text Plain text + +Description are inserted without any HTML formatting. Only special HTML +entities such as ampersands are reformatted. This is especially useful +if the KML document is later converted to GPX, because many GPS devices +are not able to display HTML data. +
+ +\subsection html_tables HTML tables + +Each description of placemark is transformed into a HTML table labelled +with the time stamp of the insertion. Here is an example of two Navtex +messages from the same station at different times: +
+ + + + + + + + + + + + + + + + + + +
2013-02-14 23:18
CallsignOST
CountryBelgium
LocatorJO11JE
Message number35
Frequency0
ModeTOR
Message191533 UTC NOV ;
+WZ 1196
+SELF CANCELING. CANCEL WZ 1192 (GA92) (MA33).
+WALKER LIGHTBUOY NORMAL CONDITIONS RESTORED."
2013-02-14 23:13
CallsignOST
CountryBelgium
LocatorJO11JE
Message number35
Frequency0
ModeTOR
Message... etc ...
+
+ +\subsection distance_html_matrix Distinct HTML matrix + +For the same KML placemark, the key will typically the same for all +reports. More, some data are numeric. This is therefore convenient to +group them in matrices: +
+ +Here is an example for SYNOP weather data, made of three reports:
+
+ + + + + + + + + + + + + + + + + + + + +

2012-12-16 00:002012-12-17 06:002012-12-18 00:00
Dewpoint temperature
UndefinedUndefined
Figure
11
HumidityUnspecified

Precipitations
Omitted, no observationOmitted, no observation
Pressure changeNot specifiedNot specifiedNot specified
Sea level pressure994 hPa1000 hPa1013 hPa
Ship average speed0 knots0 knots
Ship directionCalmCalm
Station type
Automated station. No observation (No 7WW)Automated station. No observation (No 7WW)
Temperature9.5 deg C9.3 deg C10.3 deg C
Value
37
Visibility
4 km4 km
Wave height3.6 meters4.7 meters
Waves height3.5 meters4.5 meters
Waves period8 seconds8 seconds
Wind direction
265 degrees275 degrees
Wind speed
33 knots (Estimated)15 knots (Estimated)
+
+ + +\section data_retention_time Data Retention Time + +Data may be automatically purged based on their time-stamp and a maximum +retention time in hours. If the retention time is zero, then data are kept +for ever. +
+ + +\section command_run_kml Command run on KML creation + +This command is executed at regular times, by default 180 seconds, and +only if new data was written to any KML files. The first time this +command is run, its process id is stored. Next time this command must +be run, we check if this process is still running. If yes, no new +process is created. + +

+The intention is to handle the same way, programs +which should always be running, for example KML visualizers, and on the +other hand, one-shot scripts or converters. Typical situations are: +

+ +
    +
  • Starting a program such + as Google + Earth or Marble, only once per + session.
    • +
  • They will be automatically restarted if they crash, because + their process identifier + is not present anymore.
    • +
  • Run as needed conversion programs such as GpsBabel, to + another format (GPX). Or a FTP transfer to a remote platform, for + inclusion of KML files in Google Maps.
    • +
  • Accordingly, do not restart this conversion process as long + it is not finished (FTP transfers might take long)
    • +
+ + + +\subsection example_of_commands Example of commands + +\subsubsection ftp_transfer FTP Transfer + +A new transfer - and +a new process - must be initiated at each KML file save. A script is +created for this purpose, and the command can be: +
+ + +fldigi/scripts/ftp_kml_files.sh ftpperso.free.fr MyFtpUserName +MyPassword kml +
+ +\image html Google-Maps-Kml.png "KML files displayed in Google Maps" +\image latex Google-Maps-Kml.png "KML files displayed in Google Maps" width=6.0in +
+ + +An obvious use is to save these file to a remote machine where they +can be accessed with a public URL. This URL can then be given as CGI +parameter to Google Maps +which will display the placemarks on a map. There +are limitations +on the maximum size of KML files which have to be smaller than 10 megabytes. +
+ +Note that KML files are for the moment not compressed into KMZ files. +
+ +An FTP copy is not necessary if the destination directory for KML files +storage is public (That is, accessible from the Internet). + +\subsubsection launch_google_earth Launch google-earth + +The program will only be launched once, because its process id is still +present. The command can be: +
+ +googleearth $HOME/.fldigi/kml/fldigi.kml +
+ +It is possible to change the icons by customizing the file +styles.kml. +
+ +\image html GoogleEarth.png "Google Earth" +\image latex GoogleEarth.png "Google Earth" width=6.0in +
+ + +\subsubsection gps_babel_conversion GPS Babel conversion + +The command GpsBabel, +for example, will selectively convert the KML file of Synop +reports. It is generally advised to generate plain text description +tags in the KML files, because GPS devices might not be able to +correctly display HTML data. The command can be: +
+ +gpsbabel -i kml -f $HOME/.fldigi/kml/Synop.kml -o gpx -F out.gpx +
+ +The generated files can for example be fed +into Xastir. +
+ +
+\ref kml_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/KeyboardAndKeys.txt b/fldigi_doxygen/user_src_docs/KeyboardAndKeys.txt new file mode 100644 index 00000000..f3fab511 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/KeyboardAndKeys.txt @@ -0,0 +1,113 @@ +/** +\page keyboard_operation_page Keyboard Operation + +\tableofcontents + +The transmit buffer for fldigi is type ahead which means that you +can be typing text while the program is sending an earlier part of your +transmitted message. + +Newly entered text appears in black and text which has been transmitted +is changed to red. You can backspace into the red area. When you do and +the modem in use supports the BS character it will be sent to the receiving +station. If you monitor PSK and MFSK signals you will often find operators +backspacing over previously sent text. It's probably just as easy to just +send XXX and retype that part of the message, but we have gotten used to +word processors, email, etc. that allow us to send perfect (right) text, so +we expect our digital modems to do the same. Let's see, what was that +prosign often used in CW for oooops. +
+ +All of the alpha numeric keys perform as you would expect, entering +text into the transmit buffer. There is one very important +exception: +
+ +The caret "^" symbol. This is used in the macro expansion routine +and also used by the transmit buffer evaluator. A ^r puts fldigi into +receive mode. So you can enter the ^r (caret followed by the r) at the end +of your transmit buffer and when the sent character cursor (red chars) gets to +that point the program will clear the text and return to the receive +mode. +
+ +You can load the transmit buffer with any ASCII Text file of your +choice. Merely right click in the buffer window and select from +the pop-up menu. You can also short cut to the ^r from +this popup. +
+ +Many ops (including me) do not like to be tied to a mouse. The +fldigi text widget supports some short cuts to make your life easier: +
+ +
    +
  • Pause/Break - a transmit / receive - pause button.
    • +
      +
    • if you are in the receive mode and press the Pause/Break key the + program will switch to the transmit mode. It will begin transmitting + characters at the next point in the transmit buffer following the red + (previously sent text). If the buffer only contains unsent text, + then it will begin at the first character in the buffer. If the + buffer is empty, the program will switch to transmit mode and + depending on the mode of operation will send idle characters or + nothing at all until characters are entered into the buffer.
      • + +
    • if you are in the transmit mode and press the Pause/Break key + the program will switch to the receive mode. There may be a slight + delay for some modes like MFSK, PSK and others that require you to + send a postamble at the end of a transmission. The transmit text + buffer stays intact, ready for the Pause/Break key to return you to + the transmit mode.
      • + +
    • Think of the Pause/Break key as a software break-in capability.
      • +
    + +
  • Esc -
    • +
      +
    • Abort transmission. - immediately returns the program to receive, + sending the required postamble for those modes requiring it. The + transmit buffer is cleared of all text.
      • + +
    • Triple press on Esc - terminates the current transmission without + sending a postamble - The PANIC button.
      • +
    + +
  • Ctrl-R will append the ^r (return to receive) at the end of the + current text buffer.
    • + +
  • Ctrl-T will start transmitting if there is text in the transmit + text window.
    • + +
  • Alt/Meta-R will perform the same function as the Pause/Break key
    • + +
  • Tab moves the cursor to the end of the transmitted text (which + also pauses tx). A tab press at that position moves the cursor to the + character following the last one transmitted. CW operation is slightly + different, see the help for \ref cw_page .
    • + +
  • Ctrl + three digits will insert the ASCII character designated by + that entry.
    • + +
+ +\section function_keys Function Keys + +Keys F1 through F12 are used to invoke the macro F1 - F12. You +can also just click on the macro key button associated with that +function key. There are 4 sets of 12 macros. If you press the numbered +button on the macro button bar the next set of macros are referenced by +the F1 - F12. A right click on the numbered button provides a reverse +rotation through the 4 sets of macro keys. The respective macro set can be +made available by pressing the Alt-1, Alt-2, Alt-3 or Alt-4 key +combination. Note that this is not Alt-F1 etc. +
+ + +
+\ref keyboard_operation_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/License.txt b/fldigi_doxygen/user_src_docs/License.txt new file mode 100644 index 00000000..253d5252 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/License.txt @@ -0,0 +1,51 @@ +/** +\page license_page License(s) + +\tableofcontents + +
+\section source_code_copyright Copyright + +Copyright © +
+ +
    +
  • 2006 through 2014 Dave Freese, W1HKJ
    • +
  • 2007, 2008, 2009 Stelios Bounanos, M0GLD
    • +
  • 2007, 2008, 2009 Leigh Klotz Jr., WA5ZNU
    • +
  • 2007, 2008, 2009 Joe Veldhuis, N8FQ
    • +
  • 2008, 2009 Stephane Fillod, F8CFE
    • +
  • 2009 John Douyere, VK2ETA
    • +
  • 2013 Remi Chateauneu, F4ECW
    • +
  • 2013, 2014 Robert Stiles, KK5VD
    • +
  • 2014, John Phelps - KL4YFD
    • +
+ +This application and all supporting documentation is free software; +you can redistribute it and/or modify it under the terms of the GNU +Library General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any +later version. +
+ +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Library General Public License for more details. +
+ +You should have received a copy of the GNU Library General Public +License along with the source code for fldigi; if not, write to the +
+ Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor + Boston, MA 02110-1301 USA. +
+ +
+\ref license_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/LogExports.txt b/fldigi_doxygen/user_src_docs/LogExports.txt new file mode 100644 index 00000000..8dc7b568 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/LogExports.txt @@ -0,0 +1,58 @@ +/** +\page exporting_logbook_data Exporting Logbook Data + +\tableofcontents + + +Fldigi provides automatic export of log records as they are recorded. On +Linux the data is forwarded to Xlog compatible programs using the SysV +message queue system. On Windows the records are exported via a temporary +file structure and are accepted by Logger32. +
+ +The user may also export all or selected records consisting of all or +selected fields. Access to this export function of available from the +menu "File/Log/Export ADIF", "File/Log/Export Text", +and "File/Log/Export CSV". +
+ +\section export_adif Export ADIF + +Selecting the Export ADIF menu item opens the following dialog:
+
+ +\image html ExportSetup.png "Export Setup" +\image latex ExportSetup.png "Export Setup" width=6.5in +
+ +If you want to export every record press the "Check All" in the left +panel. You can also select and deselect individual records. Choose which +fields you want to export with the right panel controls. Press the OK +button to continue or Cancel to abort the operation. A file chooser dialog +will open which allows you to specify the name and location of the exported +file. Use the extension ".adi" on Windows and ".adif" on the other OS's. +
+ +\section export_text_csv Export Text / CSV + +The same Export Setup dialog is used for Text and CSV exports. +
+ +
The Text export produces a simple space delimited file with columns set +at locations dictated by the field size for each field that is exported. It +is suitable for use with a word processing program or for printing a hardcopy +of your activities. +
+ +The CSV is a "Character Separated Value" file with the TAB character used +as the field separator. This type of file can be imported into nearly all +spreadsheet programs such as Gnumeric, Open Office or MS Excel. +
+ +
+\ref exporting_logbook_data "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/Logbook.txt b/fldigi_doxygen/user_src_docs/Logbook.txt new file mode 100644 index 00000000..0cca54b0 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Logbook.txt @@ -0,0 +1,242 @@ +/** +\page qso_log_book_page QSO Logbook + +\tableofcontents + + +Fldigi maintains a large set of QSO logbook fields that will probably be +sufficient for casual operating, contesting and some certificate logging. All +of the fields that are captured in the logbook are maintained in an ADIF +database that can be read by any logbook program that can read the ADIF text +format. +
+ +\section list_of_log_fields List of Log Fields + +The complete set of logbook fields are: +
+ +ADIF FIELD | | USE +:--------- |:-:| :---------------------------------------------- +BAND | | QSO band (computed from frequency) +CALL | * | contacted stations call sign +COMMENT | * | comment field for QSO +COUNTRY | * | contacted stations DXCC entity name +CQZ | | CQ zone +DXCC | | contacted stations DXCC country code +FREQ | * | QSO frequency in MHz +GRIDSQUARE | * | contacted stations Maidenhead Grid Square (Loc) +IOTA | | Islands On The Air +IOTA | | Islands-On-The-Air designator +ITUZ | | ITU zone +MODE | | QSO mode +MYXCHG | | sent contest exchange +NAME | * | contacted operators name +QSLRDATE | | QSL received date +QSLSDATE | | QSL sent date +QSO_DATE | * | QSO data at start of contact +QTH | * | contacted stations city +RST_RCVD | * | received signal report +RST_SENT | * | sent signal report +SRX | * | QSO received serial number +STATE | * | contacted stations state +STX | * | QSO transmitted serial number +TIME_OFF | * | end time of QSO in HHMM format +TIME_ON | * | start time of QSO in HHMM format +TX_PWR | * | power transmitted by this station +VE_PROV | * | 2 letter abbreviation for Canadian Province +XCHG1 | * | received contest exchange +
+ +\* - These fields are either captured on the main dialog, computed from +internal values, or determined by configuration. +
+ +The data in the fldigi logbook can be exported to external text files; +ADIF, text, and CSV (comma separated value). The ADIF can be +read by any ADIF compatible logbook program. The text output is +suitable for use in a wordprocessor and for printing. The CSV can +be read into many spreadsheet programs such as Excel, Open Office or +Gnumeric. +
+ +\section digital_mode_signal_reports Digital Modes Signal Reports + +Fldigi does not enforce any rules on signal reporting. It could very +well do so for many of the modes in which signal quality is inherently +measured as a part of the decoder. Learning how to evaluate a +signal, to properly report it, and then help in correcting deficiencies +should be the goal of every amateur operator. Please read further +on using both \ref rst_rsq_page "RST and RSQ signal reports". +
+ +\section capturing_qso_data Capturing QSO Data + +Fldigi supports two QSO capture panels. The first for casual QSO logging +
+ +\image html log-qso.png "QSO capture panel" +\image latex log-qso.png "QSO capture panel" width=6.5in +
+ +and the second for contest fields +
+ +\image html log-contest.png "Contest capture panel" +\image latex log-contest.png "Contest capture panel" width=6.5in +
+ +You might prefer a more minimal view of the logging fields. You can select +to completely suppress the log panel or to use a single line view as in +either of these two: +
+ +\image html log-qso-min.png "Minimal QSO Capture Panel" +\image latex log-qso-min.png "Minimal QSO Capture Panel" width=6.5in +
+ +\image html log-contest-min.png "Minimal Contest Capture Panel" +\image latex log-contest-min.png "Minimal Contest Capture Panel" width=6.5in +
+ +These are selectable from the View menu: +
+ +\image html menu-view.png "View menu" +\image latex menu-view.png "View menu" width=1.5in +
+ +These three buttons are associated with logbook entries. +
+ +
    +
  • The globe button provides access + to \ref callsign_db_configuration_page "QRZ queries"
    • +
  • The brush button clears all of the logging entries
    • +
  • The save-into button saves the current logging entries into the + logbook
    • +
+
+ +\image html log-buttons.png "Log Buttons" +\image latex log-buttons.png "Log Butons" width=0.5in +
+ +The frequency, Off (time off), and \#Out are filled by the program. All +the others can be populated by manual keyboard entry or by +selection from the Rx panel. The time off, Off, is continuously +update with the current GMT. The time on, On, will be filled in +when the Call is updated, but can be modified later by the operator. +
+ +A right click on the Rx panel brings up a context sensitive menu that will +reflect which of the two QSO capture views you have open. +
+ + +\image html menu-rx-popup-long.png "Normal Menu" +\image latex menu-rx-popup-long.png "Normal Menu" width=1.0in +
+ +\image html menu-rx-popup-contest-short.png "Contest Menu" +\image latex menu-rx-popup-contest-short.png "Contest Menu" width=1.0in +
+ +If you highlight text in the Rx pane then the menu selection will operate +on that text. If you simply point to a word of text and right +click then the menu selection will operate on the single word. +
+ +Certain fields may also be populated with automatic parsing, Call, Name, QTH +and Loc. You point to the Rx pane word and then either +double-left-click or hold a shift key down and left click. The +program will attempt to parse the word as a regular expression to +populate the Call, Name, QTH, and Loc fields in that order. It +may place some non standard calls into the Loc field if they qualify as +a proper Maidenhead Grid Square, such as MM55CQ. That may be a +special event station, but it also looks like a grid square locator +value. You need to decide when that occurs and use the pop up +menu for those special cases. The first non-Call non-Loc word +will fill the Name field and subsequent qualify words will go into the +QTH field. +
+ +A highlighted section of text, can always be copied +to the clipboard for subsequent pasting elsewhere. The Copy menu +item will be active when text in the Rx pane has been highlighted. That +text can also be saved to a file. Use the \"Save as...\" menu item for that +purpose. All data fields in fldigi share a common set of keyboard +shortcuts. Linux users will recognize these as familiar Emacs +shortcuts. There is also a small popup menu that can be opened for each +field by right clicking the contents with the mouse: +
+ +\image html menu-popup-edit-field.png "Menu Popup Edit Field" +\image latex menu-popup-edit-field.png "Menu Popup Edit Field" width=1.6in +
+ +Highlighted text will be overwritten when a paste is selected. Otherwise the +clipboard will be pasted at the current cursor position. +
+ +You can query on-line and local CD based data base systems for data +regarding a Call. Set up your query using +the \ref callsign_db_configuration_page "Callsign DB configuration tab". +You make the query by either clicking on the globe button, or +selecing "Look up call" from the menu. The latter will also move +the call to the Call field and make the query. +
+ +If you have previously worked a station the logbook will be searched for the +most recent qso and fill the Name, Qth and other fields from the logbook. If +the logbook dialog is open that last QSO will be selected for viewing in the +logbook. +
+ +You open the logbook by selecting from the Logbook menu; Logbook/View. The +logbook title bar will show you which logbook you currently have open. +Fldigi can maintain an unlimited (except for disk space) number of logbooks. +
+ +\image html logbook.png "Log Book" +\image latex logbook.png "Log Book" width=6.0in +
+ +
+You can resize the dialog to suit your screen size and operating needs. +Fldigi will remember the placement and size for subsequent use. +
+ +You can create new entries, update existing entries, and delete entries +using this dialog. You can also search for an entry by callsign. The browser +can be sorted by Date, Callsign, Frequency or Mode. The sort can +be forward or backward with the most recent being the default selected +entry after each sort. You execute the sort by clicking on the +column button at the top of the column to be sorted. Each click +causes the sort to reverse. I like to view my log with the most +recent at the top. You might want to view it with the most recent on the +bottom. +
+ +There are no frills such as keeping track of DXCC +worked, fancy printouts etc. Fldigi's logbook is primarily a +capture function. You can export your data for use with an +external database or for uploading to LOTW or eQSL. Data from +those sources can also be used for importing into the logbook. +
+ +Exporting logbook data: \ref exporting_logbook_data "Log Exports". +
+ +Cabrillo reporting: \ref cabrillo_report_page "Contest Reports". +
+ + +
+\ref qso_log_book_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + + diff --git a/fldigi_doxygen/user_src_docs/MFSK.txt b/fldigi_doxygen/user_src_docs/MFSK.txt new file mode 100644 index 00000000..cb036f44 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/MFSK.txt @@ -0,0 +1,216 @@ +/** +\page mfsk_page MFSK + +\tableofcontents + +MFSK16 and MFSK8 are multi-frequency shift keyed (MFSK) modes with low symbol +rate. A single carrier of constant amplitude is stepped (between 16 or 32 tone +frequencies respectively) in a constant phase manner. As a result, no +unwanted sidebands are generated, and no special amplifier linearity +requirements are necessary. The tones selected are set by the +transmitted (4 or 5 bit) bit pattern and a gray-code table. + +The mode has full-time Forward Error Correction, so it is very robust. Tuning +must be very accurate, and the software will not tolerate differences between +transmit and receive frequency. The mode was designed for long path HF DX, +and due to its great sensitivity is one of the best for long distance QSOs +and skeds. MFSK8 has improved sensitivity, but is very difficult to tune, +and suffers more from Doppler. It is useful as the band fades out. +
+ +MFSK-32 and MFSK-64 are high baud rate and wide bandwidth modes designed for +use on VHF and UHF. These are very useful for send large documents or files +when some transmission errors are can be tolerated. +
+ +This is an example of properly tuned MFSK16 signal with a s/n of +approximately 9 dB. +
+ + +\image html mfsk-9db.png " MFSK16 signal" +\image latex mfsk-9db.png " MFSK16 signal" width=6.0in +
+ +The same signal viewed with the waterfall expanded to the x2 factor.
+ +\image html mfsk-9db-x2.png " MFSK16 signal" +\image latex mfsk-9db-x2.png " MFSK16 signal" width=1.5in +
+ + +\section mfsk_picture_mode MFSK Picture Mode + +Fldigi can send and receive images using all MFSK baud rates. When operating +with other modem programs you should limit sending pictures to the MFSK-16 +baud rate. The program can send and receive MFSK images in both black and +white and in 24 bit color. The transmission mode for MFSKpic is similar +to FAX. +
+ +Reception of an MFSKpic transmission is fully automatic. The +MFSKpic transmission has a preamble sent which will be visible on the +text screen. The preamble reads as "Pic:WWWxHHH;" or "Pic:WWWxHHHC;" for b/w +or color respectively. The WWW and HHH are numbers specifying the width and +height of the picture in pixels. +
+ +The successful reception of a MFSKpic is highly dependent on s/n +conditions. The data is transmitted as an FM modulated signal and +is subject to burst and phase noise on the transmission path. It +can provide excellent photo transmission on a really good path. +
+ +\image html mfskpix-bee.png "Received MFSK Image" +\image latex mfskpix-bee.png "Received MFSK Image" width=2.0in +
+ +This is an example of a photo received on a bench test. The received +image is an exact replica of the transmitted image. The color depth is +a full 24 bits. +
+ +Images should be carefully selected for size before beginning a +transmission. To calculate the transmit time for an image use the +following formula: +
+ +Time(sec) = W * H / 1000 for black and white +
+ +Time(sec) = W * H * 3 / 1000 for color +
+ +Where the W and H are the dimensions of the photo in pixels. A +200 x 200 image will take 120 seconds to transmit in color and 40 +seconds to transmit in b/w. The symbol rate for this mode is 1000 +data bytes per second. The color image consists of 3 bytes; red, +blue and green for each pixel. +
+ +\image html k0og.png "Picture received from K0OG" +\image latex k0og.png "Picture received from K0OG" width=2.0in + +This is an example of a picture received live on 80 meters (thanks K0OG) +
+ +Received images are saved in the default folder $HOME/.fldigi/images +(Linux) or \/fldigi.files/images (Windows). +
+ +\section mfsk_tx_image Transmitting an Image + + +\image html Xmt-Pix.png "Xmit Picture Dialog box" +\image latex Xmt-Pix.png "Xmit Picture Dialog box" width=3.0in +
+ +You can only transmit an image while in the MFSK-16 mode. The +image can be prepared for transmission while in the receive mode. Right click +in the transmit text box and select "Send Image" from the popup menu. This +will open up the transmit image dialog which will be blank to start. +
+ +Press the "Load" button and a file selection dialog will allow you to +select a suitable image for transmit. The file selection dialog +also has a preview capability so you will see what the image looks like. +
+ +You may also open a window manager file browser and drag and drop an image +to the center part of the Send image dialog. +
+ +The "X1" button is a three-way toggle that allows you to transmit an image +file in +
+X1 - normal and compatible with other modem programs +
+X2 - double speed, and
X4 - quadruple speed. X2 and X4 are fldigi +specific image modes. +
+ +\image html Xmt-Pix1.png "Xmit Picture Dialog Box with Image" +\image latex Xmt-Pix1.png "Xmit Picture Dialog Box with Image" width=3.0in +
+ +The Send image dialog after the image was drag and dropped onto the +dialog. +
+ +The properties box said this image was 120 x 119 24 bit +color. So it should take 42.8 seconds to transmit in full color. You can +send a color or a b/w image in either color mode or b/w mode. If you +transmit a color image in b/w the program will convert the image before +transmitting. If you transmit a b/w image as full color you are in effect +transmitting redundant information, but it can be done. I selected +the "XmtClr" button for a trial run. Pressing either the "XmtClr" +or "XmtGry" will put the program and the transceiver into the transmit +mode if it was in the receive mode. The image is cleared and then repainted +as the transmission proceeds. You see the same image progression that +the receiving station should see. The main display also displays the \% +completion on the status bar. Hold the mouse over either the +XmtClr or the XmtGry button and the tooltip will tell you the transmit +time for this image. +
+ +You may abort the transmission at any time by pressing the "Abort Xmt" +button. That will return you to the text mode for MFSK. You +will then have to toggle the T/R button if you want to return to +receive. +
+ +\image html Xmt-Pix3.png "Received MFSK Image" +\image latex Xmt-Pix3.png "Received MFSK Image" width=1.5in +
+ +The receiving program decodes the "Pic:110x119C;" as a color picture +110 wide by 119 high. Here is shown being received on a computer +running Vista Home Premium. +
+ + +\image html Xmt-Pix4.png "Waterfall of a MFSK Image" +\image latex Xmt-Pix4.png "Waterfall of a MFSK Image" width=3.5in + +This is what the waterfall will look like during the reception of an +MFSK-16 image. +
+ +The actual spectrum signature will vary with the image bytes being +transmitted. The waterfall scale is in the x4 mode and the above +photo was being transmitted in 24 bit color for this screenshot. The +waterfall clearly shows that the image transmission is within the bandwidth +occupied by MFSK-16. +
+ +\section mfsk_picture_slant Picture with a slant + +If either the send, receive or both ends of the transmission are using an +uncalibrated sound card whose sampling rate is not an exact multiple of +8000 Hz the resulting picture at the receive end will appear slanted. The +degree of slant is directly related to the accumulation of the frequency +error at both ends of the transfer. Stations wishing to send and receive +MFSK pic's should calibrate their sound card. +The \ref digiscope_display_wwv_mode "WWV calibration mode" is used to +measure and set the parts per million (ppm) correction factor for the +sound card. +
+ +Your sound system may be fully corrected, but the sending station may have +an uncorrected sound card. You can usually correct for small +errors in the following way. After the full picture is received +move the mouse to bottom left or right corner of the slanted images +(the corner that clearly visible). Then left click on that +corner. The program will correct for the slant. The +correction will not be perfect but it may help to make the image more +viewable. +
+ + +
+\ref mfsk_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/MT63.txt b/fldigi_doxygen/user_src_docs/MT63.txt new file mode 100644 index 00000000..d90e8138 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/MT63.txt @@ -0,0 +1,154 @@ +/** +\page mt63_page MT63 + +\tableofcontents + +MT63 is an Orthogonal Frequency Division Multiplexed mode consisting of 64 +parallel carriers each carrying part of the transmitted signal. + The tones are differential BPSK modulated. MT63 employs a +unique highly redundant Forward Error Correction system which +contributes to it robustness in the face of interference and facing. + The tones have synchronous symbols, and are raised cosine +moduled. This mode requires a very linear transmitter. Over-driving leads to +excessive bandwidth and poorer reception. +
+ +The mode is very tolerant of tuning and fldigi will handle as much as 100 +Hz of mistuning. This is very important since MT63 is often used +in very low Signal to Noise ratios. There are three standard modes: +
+ +
+ +Mode | Symbol Rate | Typing Speed | Bandwidth +:--------:|:-----------:|:------------------:|:---------: +MT63-500 | 5.0 baud | 5.0 cps (50 wpm) | 500 Hz +MT63-1000 | 10.0 baud | 10.0 cps (100 wpm) | 1000 Hz +MT63-2000 | 20 baud | 20.0 cps (200 wpm) | 2000 Hz + +
+
+ +In addition there are two interleaver options (short and long) which can +be set on the \ref mt63_configuration_page "MT63 configuration tab". The +default calling mode is MT63-1000. If the short interleaver is used then +one can expect some compromise in robustness. The long interleaver results +in somewhat excessive latency (delay between overs) for keyboard +chatting. MT63-1000 with the long interleaver has a latency of 12.8 seconds. +
+ +You can change from receive to transmit immediately upon seeing the other +stations signal disappear from the waterfall. You do not need to +wait until the receive text completes. Any remaining data in the +interleaver will be flushed and the associated receive text printed +quickly to the Rx pane. Tx will commence right after the buffer +is flushed. +
+ +MT63 may be operated in the default fixed audio frequency mode. In this +mode you are not allowed to randomly place of the signal on the waterfall. +Your transmit signal, and also the received signal should be centered at +750 Hz for MT63-500, 1000 Hz for MT63-1000, and 1500 Hz for MT63-2000. If +you click on the waterfall to move the tracking point it will be restored +to the required position. + +The default mode, MT63-1000, looks like this on fldigi's waterfall. + +\image html mt63-1000.png "MT63-1000" +\image latex mt63-1000.png "MT63-1000" width=1.75in +
+ +You can also elect to operate the MT63 modem in a "manual tune" mode +(\ref mt63_configuration_page "MT63 configuration tab"). +The manual tune allows you to place both the Rx and the Tx signal to be +anywhere within the confines of your SSB bandwidth. This screen +shot shows this capability: +
+ +\image html mt63-500.png "MT63-500 with QRM" +\image latex mt63-500.png "MT63-500 with QRM" width=6.0in +
+ +This view also demonstrates how immune MT63 is to interference. +The multiple PSK31 signals that appear on top of the MT63 signal did +not degrade the decoder. MT63 is usually used above 14073 MHz to avoid the +possibility of this type of mode conflict.
+ +

Edited excerpts from Pawel Jalocha's official mt63 code release

+ +The MT63 modem is intended for amateur radio as a conversation (RTTY +like) mode where one station transmits and one or more other stations +can listen. In short, the modem transmits 64 tones in its baudrate specific +bandwidth. The differential bipolar phase modulation is used to encode 10 +bits of information per second on each tone. The user data in the form of +7-bit ASCII characters is encoded as a set of 64-point Walsh functions. The +bits are interleaved over 32 symbols (3.2 seconds) to provide resistance +against both pulse and frequency selective noise or fading. The character +rate equals to the symbols rate thus the modem can transmit 10 7-bit +characters per second. +
+ +This modem can as well run in two other modes obtained by simple time +scaling, the possible modes are summarized here: +
+ +
+ +Bandwidth | Symbol Rate | Character Rate | Interleave / Char. +:--------:|:-----------:|:--------------:|:------------------: +500 Hz | 5 baud | 5 char / sec | 6.4 or 12.8 sec +1000 Hz | 10 baud | 10 char / sec | 3.2 or 6.4 sec +2000 Hz | 20 baud | 20 char / sec | 1.6 or 3.2 sec + +
+
+ +For each mode the interleave factor can be doubled thus each character +becomes spread over twice as long period of time. +
+ +The MT63 modem is made for single side band operation. The audio +generated by the modem (sound card output) is applied to the SSB +modulator. On the receiver side, the output of the SSB demodulator is +put into the sound card input. The envelope of the MT63 signal is not +constant as in other multi-tone systems - it is rather +noise-like. One must be careful not to overdrive the transmitter. +
+ +The receiver of the MT63 is self-tuning and self-synchronizing thus the +radio operator is only required to tune into the signal with +/- 100 Hz +accuracy. The modem will tell the actual frequency offset +after it is synchronized. The operator should not try to correct +this offset unless he is able to tune the radio receiver very slowly, +because MT63 as a low rate phase modulated system cannot tolerate sudden +frequency changes. Signal synchronization is improved by filtering the timing +measurement of the received signal. For very low signal to noise ratios you +can improve the synchronization by selecting "Long Receive Integration" factor. +Think of the process as a digital AFC. PSK31 does something very similar. One +would expect there to be some correlation since mt63 is the equivalent of 64 +simultaneous binary phase shift signals. The synchronizer filtering can be +reduced to 1/2 it's normal value by selecting "Long Receive Integration". It +takes twice as long for decoding to begin and the synchronizer is more immune +to noise. +
+ +You probably never need to enable "Long Receive Integration" unless you are +trying to receive an mt63 signal buried in the noise. +
+ +The MT63 is a synchronous system and it relies on the sampling rate to +be the same at the receiver and the transmitter. At least the sampling +rates should not be different by more that 10-4. +
+ +If you have calibrated your sound card to +\ref digiscope_display_wwv_mode "WWV", then you will meet this requirement. +
+ +
+\ref mt63_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/Macros.txt b/fldigi_doxygen/user_src_docs/Macros.txt new file mode 100644 index 00000000..bbbdf193 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Macros.txt @@ -0,0 +1,448 @@ +/** +\page macros_sub_page Macros + +\tableofcontents + +Macros are short text statements that contain imbedded references to text +data used by the program fldigi. Macro definition files(s) are located +in the $HOME/.fldigi/macros/ directory and all have the extention ".mdf". The +default set of macros are contained in the +file $HOME/.fldigi/macros/macros.mdf. + +Fldigi will create this file with a set of default macros on its first +execution. +
+ +Fldigi supports up to 48 macro definitions in sets of 12. Macro +definitions are not recursive, that is; a macro cannot reference +another macro or itself. +
+ +The imbedded references are similar to those used by DigiPan and other +fine modem programs. The imbedded reference is an uppercase plain +text descriptor contained with the \<\> brackets. +
+ + +\section macro_tags Macro tags + +
+ +Macro | Description +:---------: | :---------------------------- +\ | my frequency +\ | mode +\ | configuration call +\ | configuration locator +\ | configuration name +\ | configuration QTH +\ | my RST +\ | configuration antenna +\ | Fldigi version +
+ +Macro | Description +:---------: | :---------------------------- +\ | other stations callsign +\ | S/N or other data contained in first info field of status bar +\ | IMD or other data contained in second info field of status bar +\ | other stations locator +\ | other stations name +\ | other stations QTH +\ | other stations RST +
+ +Macro | Description +:---------: | :---------------------------- +\ | map other stations locator on google +\ | map other stations address, latitude-longitude
locator as specified +
|
+\ | clear RX pane +\ | clear TX pane +
+ +Macro | Description +:---------: | :---------------------------- +\ | rig freq has keyboard focus +
+ +Macro | Description +:---------: | :---------------------------- +\ | text to NAME/QTH +\ | Digitalk On, Off, Toggle; this is a Windows only tag
and Digitalk must be running +\ | save QSO data to logbook immediately +\ | log at xmt time +\ | clear log fields +\ |submit the current log entry to www.eQSL.cc This macro tag
should be put before \ or \ +
+ +Macro | Description +:---------: | :---------------------------- +\ | insert current logbook time HHMM, ie 0919 +\ | insert current local date-time in iso-8601 format, ie 2011-08-28 04:16-0500 +\ | insert Local date-time, ie 2011-08-28 04:16-0500 +\ | insert Zulu date-time in iso-8601 format, ie 08/28/2011 04:16 CDT +\ | insert Zulu date-time, ie 2011-08-28 09:16Z +\ | insert local time, ie 0416 +\ | insert zulu time, ie 0916Z +\ | insert local date, ie 2011-08-28 +\ | insert Zulu date, ie 2011-08-28 +\
\ | insert current weather data from METAR as specified on
WX configuration tab. see WX configure replace xxxx with the 4 letter
METAR designator for a report on a station other than the one specified on
the weather configuration tab. +
+ +Macro | Description +:---------: | :---------------------------- +\ | insert current value of contest counter +\ | decrement contest counter +\ | increment contest counter +\ | send exchange in string +\ | send exchange out string +\ | mark exchange in start +\ | mark exchange in end +\ | save marked text to contest exchange in +
+ +Macro | Description +:-------: | :---------------------------- +\ | receive +\ | transmit +\ | toggle Transmit / Receive +
+ +Macro | Description +:--------: | :---------------------------- +\ | search UP for next signal +\ | search DOWN for next signal +
+ +Macro | Description +:---------: | :---------------------------- +\ | return to waterfall cursor to sweet spot +\ | move waterfall cursor to freq NNNN Hz +\ | same as left-clk on QSY button +\ | same as right-clk QSY button +\ | Qsy to transceiver frequency in kHz, optional waterfall
(Audio) frequency in Hz (If not specified, it i not changed). Several QSY
frequencies, or ranges of frequencies provided by one increment, can be
proposed, in which case the first frequency after the current frequency
is chosen. +
+ +Macro | Description +:---------: | :---------------------------- +\ | send CAT command to transceiver to change to a valid mode +\ | send CAT command to transceiver to change to a valid filter
width example to QSY to sweetspot (center of bandpass filter) and select
narrow filter +
+ +Macro | Description +:---------: | :---------------------------- +\ | insert text file; a file selection box will open when this tag is
selected during editing +\ | insert image file; a file selection box will open when this
tag is selected during editing +\ | insert image file; transmit in grey scale +\ | transmit video text +
+ +Macro | Description +:----------------------: | :---------------------------- +\ | transmit idle signal for NN.nn sec +\ | repeat this macro every NN sec +\ | transmit single tone tune signal for NN sec +\ | insert delay of NN seconds before transmitting +\ | repeat macro continuously +\ | schedule execution to begin at time and optionally
date specified +
+ +Macro | Description +:-------------------: | :---------------------------- +\ | transmit a CW callsign identifier +\ | transmit mode ID using waterfall video text +\ | transmit video text defined on ID configuration tab +\ | transmit RSID on, off, toggle +\ | receive RSID on, off, toggle +\ | transmit multiple RsID bursts
NN < 0 will transmit NN bursts for current modem and then return to Rx
NN > 0 will transmit NN bursts for current modem and continue in Tx
NN = 0 will transmit 1 bursts and continue (same as NN = 1) +\ | tones transmit DTMF tone sequence at start of
transmission; options W-wait n msec, default 0 L-tone symbol length n
in msec; default 50 msec '-', ' ' and ',' insert silence symbol
eg: \ +
+ +Macro | Description +:------------------------: | :---------------------------- +\ | CW QSK post-timing in milliseconds +\ | CW QSK pre-timing in milliseconds +\ | CW rise time in milliseconds +\ | CW WPM, ww = word rate, optional ff = Farnsworth rate +
+ +Macro | Description +:------------------------: | :---------------------------- +\ | RigCAT user commands +\ | hex hex ... are sequential hexadecimal values
string is Ascii char sequence retnbr
is number of bytes in xcvr response ':retnbr'
is optional; retnbr set to 0 if missing +
+ +Macro | Description +:-----------------: | :---------------------------- +\ | AFC on, off, toggle +\ | lock waterfall cursor; on, off, toggle +\ | Reverse on, off, toggle +
+ +Macro | Description +:--------------: | :---------------------------- +\ | Insert current operating info with "text" into Rx stream, ie:
info text <<2013-01-12T21:18Z RTTY @ 14005000+0760>> which can be used to
return to a mode, rf, audio frequency. +\ | Cause transmission to pause at place of occurance in macro
text. "Pause/Break" key on keyboard resumes transmission +\ | set fldigi tx attenuator to value -30 dB <= val <= 0 +\ | allow macro to contain a comment field; everything
between \< and \> is ignored by macro parser +\ | save the current macro definitions to the current file +
+ +Macro | Description +:---------: | :---------------------------- +\ | load a new macro defs file; file prompt when editing macro + +
+ +Macro | Description +:--------------: | :---------------------------- +\ | modem timing test internal string +\ | modem timing test, spec' file +\ | modem timing test, string 's' + +
+ +Macro | Description +:--------------: | :---------------------------- +\ | WAV file; internal string +\ | WAV file; spec' file +\ | WAV file; string 's' + +
+ +
+ +\verbatim + * Added macro to insert QRG text into Rx stream + + * Added save macro tag + * Added export strings + - FLDIGI_LOG_FILE - current logbook file name + - FLDIGI_MACRO_FILE - current macro file name + * Added tag + - returns to receive, but does not clear Tx buffer + * Added tag to control + transmit attenuator control from within a macro. + * Added macro tag + a do nothing that disappears from the transmitted + text +\endverbatim + +
+ +\section modem_macro_tags Modem macro tags + +Macro tags are also assigned to each supported modem type and sub-modem type +that is supported by fldigi: + +
+ +
+ +
|
| Data Modems |
|
+:--------------------- : | :--------------------: | :-------------: | :------------------: | :------------------: + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | | + | | | |
+ +
+
+ +\section other_modems Other Modems + +The following modems perform other functions not involving data +transportation: +
+ +
+Non Data Modems | Description +:--------------: | :--------------: + | Null modem - Rx stream is discarded. Tx stream is silent but PTT is enabled + | SSB modem (place holder) + | \ref frequency_analyzer_page "Analyze Frequency" + | \ref fft_scan_page "Waterfall Power Measurement Frequency Scan" + | \ref digiscope_display_wwv_mode "Calibrate Sound Card" +
+
+ +Local references are specified during the program configuration and can +be changed during program operation. +
+ +Remote references are all part of the qso log field definitions and are +routinely changed from contact to contact. +
+ +Global references are for items like Greenwich Mean Time. +
+ +The macros.mdf file can be edited with any ascii text editor such as +kedit, gedit, geany, nano etc. But it is much easier to use the +built-in macro editor provided in the program. +
+ +\section macro_editor Macro Editor + +Right click on any macro key (or the alternate set) and a macro editing +dialog opens with the current copy of that macro and its label. This looks +very similar to the DigiPan macro editor at the urging +of Skip Teller, KH6TY. +
+ +\image html macro-editor.png "Macro Editor" +\image latex macro-editor.png "Macro Editor" width=6.0in +
+ +The Text box is a mini-editor with a very limited set of control +functions. You can mark, bound and select text for deletion +(ctrl-X), copy (ctrl-C), and paste (ctrl-V). Marked text can also +be deleted with the delete or the backspace keys. Marked text +modification can also be invoked by using the mouse right click after +highlighting. +
+ +The macro reference in the pick list can be transfered to the current editing +cursor location. Highlight the desired macro reference and then press the +double \<\< arrow key for each occurance of the reference to be put into +the macro text. You can change the label name but any more than 8 +characters may exceed the width of the button for the default sized +main dialog. +
+ +The \ and \ macro tags should have the NN +replaced with the time interval in seconds. +
+ +
\\CQ CQ de +\ \ k\\
+
+ +
    +
  • will enable the PTT
    • +
  • cause 5 seconds of idle signal
    • +
  • send the CQ CQ de W1HKJ W1HKJ k
    • +
  • disable PTT
    • +
  • and count down 20 seconds before repeating the macro
    • +
  • after sending the text the count down timer button (upper right + hand corner of main dialog) will display the current timer value in + seconds. Press this button to disable the timer.
    • +
  • the timer be disabled if the Escape key is pressed, the T/R is + pressed, and macro key is pressed, or if a callsign is copied from the + Rx text area to the callsign logbook entry.
    • +
  • the time will be disabled if any mouse activity occurs in the + waterfall control.
    • +
+
+ +The label associated with each macro key can be individually annotated +with a symbol. Here are the symbols that are recognized by the +button label drawing routine: +
+ +\section macro_display_symbols Macro Display Symbols + +
+\image html symbols.png "Symbols" +\image latex symbols.png "Symbols" width=2.5in +
+
+
+ +The @ sign may also be followed by the following optional +"formatting" characters, in this order: +
+ +
    +
  • '#' forces square scaling, rather than distortion to the widget's + shape.
    • +
  • +[1-9] or -[1-9] tweaks the scaling a little bigger or smaller.
    • +
  • '$' flips the symbol horizontally, '%' flips it vertically.
    • +
  • [0-9] - rotates by a multiple of 45 degrees. '5' and '6' do no + rotation while the others point in the direction of that key on a + numeric keypad. '0', followed by four more digits rotates the symbol by + that amount in degrees.
    • +
+ +Thus, to show a very large arrow pointing downward you would use the +label string "@+92-\>". + +Here are my macro buttons suitably annotated: +
+ +\image html macrobuttons.png "Macro Buttons" +\image latex macrobuttons.png "Macro Buttons" width=6.0in +
+ +There are 4 sets of 12 macro functions. You can move between the +4 sets using the keyboard and the mouse. + +
    +
  1. Left click on the "1" button to move to set #2. Right click + on the "1" button to move to set #4.
    2. +
  2. Move + the mouse to anywhere on the macro buttons. Use the scroll wheel + to move forward & backward through the macro sets
    3. +
  3. Press the Alt-1, Alt-2, Alt-3 or Alt-4 to immediately change to + that macro set.
    4. +
+
    +
  • The label for CQ is "CQ @\>|", denoting that both + \ and \ are present in the macro text.
    • +
+
    +
  • The label for QSO is "QSO @\>\>", denoting that only + \ is present in the macro text.
    • +
+
    +
  • The label for KN is "KN @||", denoting that only + \ is present in the macro text.
    • +
+
+ +You could use any label that is symbolic to the function required. +Refer to the +FLTK web site +for a full list of label types. +
+ +If you modify the macros and do not save them ("Files/Save Macros" on +the main window) fldigi will prompt you to save the macros when you +exit the program if you have the +\ref ui_configuration_general_page "Exit Prompts" option selected. +
+ +\section contest_macro_tags Contest macro tags + +Refer to \ref contest_how_to_page "Contest-How-To" +
+ +
+\ref macros_sub_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/Menus.txt b/fldigi_doxygen/user_src_docs/Menus.txt new file mode 100644 index 00000000..5805ed29 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Menus.txt @@ -0,0 +1,557 @@ +/** +\page menus_page Menus + +\tableofcontents + + +\section menu_heirarchy Menu Heirarchy + +\image html menu-linux.png "Menu" +\image latex menu-linux.png "Menu" width=5.5in +
+ +
+\subsection s_files Files + +
+\subsubsection s_folders Folders + +\image html menu-files-folders.png "Folders" +\image latex menu-files-folders.png "Folders" width=2.6in +
+ +
    +
  • Fldigi config... - open the OS native file explorer to + the folder containing the fldigi operating & data files.
    • +
  • NBEMS files... - open the OS native file explorer to the folder + containing the NBEMS data files
    • +
  • FLMSG files... - open the OS native file explorer to the folder + containing the NBEMS/FLAMP data files
    • +
  • Data files. See \ref supporting_data_files_page
    • +
+ +
+\subsubsection s_macros Macros + +\image html menu-files-macros.png "Macros" +\image latex menu-files-macros.png "Macros" width=2.25in +
+ +
    +
  • Open Macros - open a macro definition file ... changes the MACRO + keys immediately
    • +
  • Save Macros - save the current macro definitions to a designated + file
    • +
+ +Additional information: +
+\ref macro_page +
+\ref ui_configuration_macros_page +
+ +
+\subsubsection s_text_capture Text Capture + +\image html menu-files-text.png "Text Capture" +\image latex menu-files-text.png "Text Capture" width=2.8in +
+ +Capture all received and transmitted text to a date-time stamped file. Each +day's data will be stored in a single file in which the text is appended: +fldigiYYYYMMDD.log. This file will be in the "Fldigi config..." folder which +can be accessed per the File/Folders menu item. A brief example log of Rx +data: +
+ +\verbatim +--- Logging started at Wed Jan 5 18:42:51 2011 UTC --- +RX 14071955 : PSK31 (2011-01-05 18:42Z): d dx sk S +RX 14071756 : PSK31 (2011-01-05 18:42Z): PSE -lr dACQ CQ de WX1GRS WX1GRS +RX 14071756 : PSK31 (2011-01-05 18:42Z): CQ CQ de WX1GRS WX1GRS +RX 14071756 : PSK31 (2011-01-05 18:42Z): CQ CQ de WX1GRS WX1GRS +RX 14071756 : PSK31 (2011-01-05 18:42Z): PSE K aie = +--- Logging stopped at Wed Jan 5 18:43:04 2011 UTC --- + +Each line contains the program state, RX or TX, the frequency, the mode, +the date-time, and the data stream. +\endverbatim + +
+ +
+\subsubsection s_audio Audio + +\image html menu-files-audio.png "Audio" +\image latex menu-files-audio.png "Audio" width=2.4in +
+ +
    +
  • Rx Capture - allows capturing the incoming audio to a wav file
    • +
  • Tx Generate - allows capturing the generated tx audio to a wav file
    • +
  • Playback - playback a previously captured or generated wav file
    • +
+ +
+\subsubsection s_exit Exit + +\image html menu-files-audio.png "Exit" +\image latex menu-files-audio.png "Exit" width=2.4in +
+ +Exit - exit the program closing down the various interfaces in a nice +controlled manner. +
+ +
+\subsection s_scripts Configure Scripts + +Executing and Generating Scripts + +\image html menu-files-config-scripts.png "Config Scripts" +\image latex menu-files-config-scripts.png "Config Scripts" width=2.0in +
+ +Additional information: +
+\ref configure_script_page +
+\ref sConfigScriptCmds +
+ +
+\subsection s_op_mode Op Mode + +Op Mode - the current operating mode will show as a highlighted menu item. + +\image html menu-opmode.png "Op Mode" +\image latex menu-opmode.png "Op Mode" width=1.0in +
+ +
+\subsubsection s_op_mode_cw CW + +
+CW - receive CW 5 to 200 WPM and transmit on any audio frequency using AF CW. +
+ +Additional information: +
+\ref cw_page +
+\ref cw_configuration_page +
+ + +
+\subsubsection s_op_mode_contestia Contestia + +\image html menu-contestia.png "Contestia" +\image latex menu-contestia.png "Contestia" width=0.75in +
+Additional information: +
+\ref contestia_page +
+\ref contestia_configuration_page +
+\ref contestia_table "Contestia Mode Table" +
+ +
+\subsubsection s_op_mode_domino_ex DominoEX + +\image html menu-dominoex.png "DominoEX" +\image latex menu-dominoex.png "DominoEX" width=1.0in +
+ +Additional information: +
+\ref domino_ex_page +
+\ref domino_ex_configuration_page +
+\ref domino_ex_table "DominoEX Mode Table" +
+ +
+\subsubsection s_op_mode_hell Hell + +\image html menu-hell.png "Hell" +\image latex menu-hell.png "Hell" width=1.0in +
+ +Additional information: +
+\ref feld_hell_page +
+\ref feld_hell_configuration_page +
+\ref hell_modes "Hell Mode Table" +
+ +
+\subsubsection s_op_mode_msfk MSFK + +\image html menu-mfsk.png "MSFK" +\image latex menu-mfsk.png "MSFK" width=0.75in +
+ +Additional information: +
+\ref mfsk_page +
+\ref mfsk_table "MSFK Mode Table" +
+ +
+\subsubsection s_op_mode_mt63 MT-63 + +\image html menu-mt63.png "MT63" +\image latex menu-mt63.png "MT63" width=0.75in +
+ +Additional information: +
+\ref mt63_page +
+\ref mt63_configuration_page +
+\ref mt63_table "MT-63 Mode Table" +
+ +
+\subsubsection s_op_mode_psk PSK + +\image html menu-psk.png "PSK" +\image latex menu-psk.png "PSK" width=0.75in +
+ +\image html menu-psk-multi-carrier.png "Multi Carrier PSK" +\image latex menu-psk-multi-carrier.png "Multi Carrier PSK" width=0.75in +
+ +Additional information: +
+\ref psk_page +
+\ref psk_table "PSK Mode Table" +
+ +
+\subsubsection s_op_mode_pskr PSKR + +\image html menu-pskr.png "PSKR" +\image latex menu-pskr.png "PSKR" width=1.75in +
+ +All PSKR modes are phase shift keying, with FEC and interleaving. +
+ +Additional information: +
+\ref psk_page +
+\ref pskr_table "PSK/PSKR Mode Table" +
+ +
+\subsubsection s_op_mode_qpsk QPSK + +\image html menu-qpsk.png "QPSK" +\image latex menu-qpsk.png "QPSK" width=0.75in +
+ +Additional information: +
+\ref psk_page +
+\ref qpsk_table "QPSK Mode Table" +
+ +
+\subsubsection s_op_mode_8psk 8PSK + +\image html menu-8psk.png "8PSK" +\image latex menu-8psk.png "8PSK" width=0.75in +
+ +Additional information: +
+\ref psk_page +
+\ref eight_psk_table "8PSK Mode Table" +
+ +
+\subsubsection s_op_mode_olivia Olivia + +\image html menu-olivia.png "Olivia" +\image latex menu-olivia.png "Olivia" width=0.75in +
+ +Additional information: +
+\ref olivia_page +
+\ref olivia_configuration_page +
+\ref olivia_table "Olivia Mode Table" +
+ + +
+\subsubsection s_op_mode_rtty RTTY + +\image html menu-rtty.png "RTTY" +\image latex menu-rtty.png "RTTY" width=0.75in +
+ +Additional information: +
+\ref rtty_page +
+\ref rtty_fsk_configuration_page +
+\ref rtty_table "RTTY Mode Table" +
+ + +
+\subsubsection s_op_mode_thor THOR + +\image html menu-thor.png "THOR" +\image latex menu-thor.png "THOR" width=0.75in +
+ +Additional information: +
+\ref thor_page +
+\ref thor_configuration_page +
+\ref thor_table "Thor Mode Table" +
+ +
+\subsubsection s_op_mode_throb THROB + +\image html menu-throb.png "throb" +\image latex menu-throb.png "throb" width=0.75in +
+ +Additional information: +
+\ref throb_page +
+\ref throb_table "Throb Mode Table" +
+ +
+\subsubsection s_op_mode_wefax WEFAX + +\image html menu-wefax.png "WEFAX" +\image latex menu-wefax.png "WEFAX" width=1.0in +
+ +Additional information: +
+\ref wefax_page +
+ +
+\subsubsection s_op_mode_navtex NAVTEX / SITOR + +\image html menu-navtex.png "NAVTEX / SITOR" +\image latex menu-navtex.png "NAVTEX / SITOR" width=0.6in +
+ +Additional information: +
+\ref navtex_and_sitorb_page +
+ +
+\subsubsection s_op_mode_other SSB, WWV, Freq Anal, and Freq Scan + +\image html menu-scan.png "Analysis / Scan" +\image latex menu-scan.png "Analysis / Scan" width=0.6in + +
    +
  • SSB - fldigi does not transmit, but can be used for rig control, + signal frequency analysis and logging
    • +
  • WWV - special receive only modem used for calibrating sound card
    • +
  • Freq Scan - Evaluate Rx/Codec Signal Path
    • +
  • Freq Anal - used for carrier detection and frequency measurement
    • +
+
+ +Additional information: +
+\ref frequency_analyzer_page +
+\ref digiscope_display_wwv_mode +
+\ref fft_scan_page +
+ +
+\subsection s_configure Configure + +\image html menu-configure.png "Configure" +\image latex menu-configure.png "Configure" width=1.4in +
+ +See \ref configuration_page Page +
+ +
+\subsection s_view View + +\image html menu-view.png "View" +\image latex menu-view.png "View" width=1.4in +
+ +\image html menu-view-controls.png "View Controls" +\image latex menu-view-controls.png "View Controls" width=3.5in +
+ +\image html menu-view-waterfall.png "View Waterfall" +\image latex menu-view-waterfall.png "View Waterfall" width=2.9in +
+ +
    +
  • View/Hide Channels - Opens / Closes muli-signal viewer, shares space + with Rx/Tx panels
    • +
  • Floating Scope - Opens up a resizable, moveable scope display
    • +
  • MFSK Image - Opens the MFSK picture image (if being received)
    • +
  • Weather Fax Image - Opens WEFAX send/receive dialog
    • +
  • Signal browser - open the psk/rtty viewer dialog to display up to 30 + simultaneously decoded psk signals Dialog viewer contains shared + data / control with the View/Hide Channel viewer
    • +
  • Countries - DXCC entities
    • +
  • Controls
    • +
      +
    • Full - show all logbook and rig controls
      • +
    • Rig control and logging - minimizes the logging panel for + normal QSO entries
      • +
    • Rig control and contest - minimizes the logging panel for + Contest entries
      • +
    • None - removes the Rig Control / Log panel from the main + User Interface
      • +
    • Contest fields - Display alternate 2nd line in qso logging + area; provides access to contest logging fields
      • +
    +
  • Waterfall
    • +
      +
    • Docked scope - toggles the visibility of the docked scope + display to the right of the waterfall
      • +
    • Min WF Controls - toggles the visibility of various waterfall + controls as configured by the user
      • +
    +
+
+ +
+\subsection s_logbook Logbook + +\image html menu-logbook.png "Logbook" +\image latex menu-logbook.png "Logbook" width=1.0in +
+ +\image html menu-logbook-adif.png "Logbook ADIF" +\image latex menu-logbook-adif.png "Logbook ADIF" width=2.25in +
+ +\image html menu-logbook-reports.png "Logbook Reports" +\image latex menu-logbook-reports.png "Logbook Reports" width=2.3in +
+ +
    +
  • View - open the logbook dialog
    • +
  • New - create a new logbook
    • +
  • Open - open an existing logbook
    • +
  • Save - save the current logbook
    • +
  • ADIF / Merge - merge adif data from an ADIF file
    • +
  • ADIF / Export - export selected or all logbook records to an ADIF + formated file - see \ref exporting_logbook_data "Log Exports".
    • +
  • Reports / Text ... - export selected or all logbook records to a + text file suitable for printing
    • +
  • Reports / CSV ... - export selected or all logbook records to a + tab delimited file
    • +
  • Reports / Cabrillo ... - create a Cabrillo contest report. + - see \ref cabrillo_report_page "Cabrillo Reports".
    • +
+
+ +
+\subsection s_help Help + +\image html menu-help.png "Help" +\image latex menu-help.png "Help" width=1.9in +
+ +
    +
  • Beginners' Guide
    • +
  • On line documentation... - open up default browser to the on-line + Help site
    • +
  • Fldigi web site... - open up default browser to the www.w1hkj.com + primary web page
    • +
  • Reception reports... - open up browser to the http://pskreporter.info + web page preset to your callsign
    • +
  • Command line options - display a list of all + \ref command_line_switches_page "command line switches" available to the + fldigi user
    • +
  • Audio device info - displays information about all audio devices + detected on the computer system
    • +
  • Build info - displays all relevant information regarding the + compilation and link for the application + - \ref build_info_page "build info"
    • +
  • Event log - opens a text display window that records various events + depending on the level of reporting depth selected. This is a useful + window for reporting problems with the program to the developers.
    • +
  • Check for updates... fldigi silently opens a download web site, + checks and reports on whether a new version is available.
    • +
  • About - Version number and a little about the programmers
    • +
+ +
+ +
+\subsection s_other Spot, Tx RSID, Rx RSID, and Tune Buttons + +\image html menu-linux.png "Menu" +\image latex menu-linux.png "Menu" width=6.0in + +
    +
  • Spot button - The "Spot" light button is visible if callsign spotting + is enabled. Use this button to toggle the callsign spotting reporter + on and off. It is automatically turned off when playback is selected + in the Files menu. The main window text is not searched if the viewer + is active, i.e., if it is displayed and the current modem is PSK. + See PskReporter + and Notifier. +
  • RxID button - toggles the detection + of \ref id_configuration_page "Reed Solomon Identification" codes.
    • +
  • TxID button - toggles the transmission of the RSID signal.
    • +
  • Tune button - toggles the "Tune" mode which causes fldigi to + insert a tone at the current waterfall frequency. The peak-to-peak + amplitude of this tone is the standard by which you should + \ref tune_page "set your transmitter drive" or adjust your antenna + matching network.
    • +
  • The right most button is normally not visible. This is the + count-down timer button that is enabled when a macro button has been + configured to repeat after a specified number of seconds. This + button shows the count-down to the next transmission. Pressing + the button disables the count and restores fldigi to normal keyboard + operation.
    • +
+ + +
+\ref menus_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/ModeTable.txt b/fldigi_doxygen/user_src_docs/ModeTable.txt new file mode 100644 index 00000000..fcfaa89d --- /dev/null +++ b/fldigi_doxygen/user_src_docs/ModeTable.txt @@ -0,0 +1,214 @@ +/** +\page mode_table_page Mode Table + +\tableofcontents + +\section psk_table PSK + + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:--------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +PSK31 | 31.25 | 50 | 80.00% | 31 | 1-PSK |
| 31HG1B | 1 |
+PSK63 | 62.5 | 100 | 80.00% | 63 | 1-PSK |
| 63HG1B | 2 |
+PSK125 | 125 | 200 | 80.00% | 125 | 1-PSK |
| 125HG1B | 4 |
+PSK250 | 250 | 400 | 80.00% | 250 | 1-PSK |
| 250HG1B | 126 |
+PSK250C6 | 250 | 2400 | 80.00% | 2000 | 6-PSK |
| 2000HG1B | 263 | 63 +PSK500 | 500 | 800 | 80.00% | 500 | 1-PSK |
| 500HG1B | 173 |
+PSK500C2 | 500 | 1600 | 80.00% | 1200 | 2-PSK |
| 1200HG1B | 263 | 27 +PSK500C4 | 500 | 3200 | 80.00% | 2600 | 4-PSK |
| 2600HG1B | 263 | 28 +PSK800C2 | 800 | 2300 | 80.00% | 1400 | 2-PSK |
| 2300HGB1 | 263 | 57 +PSK1000 | 1000 | 1600 | 80.00% | 1800 | 1-PSK |
| 1800HG1B | 263 | 50 +PSK1000C2 | 1000 | 3200 | 80.00% | 3600 | 2-PSK |
| 3600HG1BC | 263 | 52 +
+ +\section pskr_table PSKR / PSK-FEC + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:--------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +PSK63FEC | 62.5 | 55 | 80.00% | 63 | 1-PSK |
| 63HG1B | 22 |
+PSK63RC4 | 63 | 220 | 80.00% | 330 | 4-PSKR |
| 330HG1BC | 263 | 1 +PSK63RC5 | 63 | 275 | 80.00% | 416 | 5-PSKR |
| 416HG1BC | 263 | 2 +PSK63RC10 | 63 | 550 | 80.00% | 850 | 10-PSKR |
| 850HG1BC | 263 | 3 +PSK63RC20 | 63 | 1100 | 80.00% | 1725 | 20-PSKR |
| 1725HG1BC | 263 | 4 +PSK63RC32 | 63 | 1760 | 80.00% | 2775 | 32-PSKR |
| 2775HG1BC | 263 | 5 +
+ + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +PSK125R | 125 | 110 | 80.00% | 125 | 1-PSKR |
| 125HG1B | 183 |
+PSK125RC4 | 125 | 352 | 80.00% | 650 | 3-PSKR |
| 650HG1B | 10 |
+PSK125RC5 | 125 | 440 | 80.00% | 825 | 4-PSKR |
| 700HG1BC | 11 |
+PSK125RC10 | 125 | 1100 | 80.00% | 1700 | 10-PSKR |
| 1700HG1BC | 12 |
+PSK125RC16 | 125 | 1760 | 80.00% | 2750 | 16-PSKR |
| 2750HG1BC | 13 |
+
+ + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +PSK250R | 250 | 220 | 80.00% | 250 | 1-PSKR |
| 250HG1B | 186 |
+PSK250RC2 | 250 | 440 | 80.00% | 600 | 2-PSKR |
| 600HG1BC | 263 | 20 +PSK250RC3 | 250 | 660 | 80.00% | 950 | 3-PSKR |
| 950HG1BC | 263 | 21 +PSK250RC5 | 250 | 1100 | 80.00% | 1650 | 5-PSKR |
| 1760HG1BC | 263 | 22 +PSK250RC6 | 250 | 1320 | 80.00% | 2000 | 6-PSKR |
| 2000HG1BC | 263 | 65 +PSK250RC7 | 250 | 1540 | 80.00% | 2350 | 7-PSKR |
| 2350HG1BC | 263 | 23 +
+ + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +PSK500R | 500 | 440 | 80.00% | 500 | 1-PSKR |
| 500-HG1BC | 187 |
+PSK500RC2 | 500 | 880 | 80.00% | 1400 | 2-PSKR |
| 1400HG1BC | 263 | 24 +PSK500RC3 | 500 | 1320 | 80.00% | 1900 | 3-PSKR |
| 1900HG1BC | 263 | 25 +PSK500RC4 | 500 | 1760 | 80.00% | 2600 | 4-PSKR |
| 2600HG1BC | 263 | 26 +
+ + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +PSK800RC2 | 800 | 1280 | 80.00% | 1400 | 2-PSKR |
| 800HGB1C | 263 | 54 +
+ + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +PSK1000R | 1000 | 880 | 80.00% | 1800 | 1-PSKR |
| 1800HG1B | 263 | 51 +PSK1000RC2 | 1000 | 1760 | 80.00% | 3600 | 2-PSKR |
| 3600HG1BC | 263 | 53 +
+ +\section qpsk_table QPSK + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +QPSK31 | 31.25 | 50 | 80.00% | 31 | 1-QPSK |
| 31H0G1B | 110 |
+QPSK63 | 62.5 | 100 | 80.00% | 63 | 1-QPSK |
| 63HG1B | 3 |
+QPSK125 | 125 | 200 | 80.00% | 125 | 1-QPSK |
| 125HG1B | 5 |
+QPSK250 | 250 | 400 | 80.00% | 250 | 1-QPSK |
| 250HG1B | 127 |
+QPSK500 | 500 | 800 | 80.00% | 500 | 1-QPSK |
| 500HG1B |
|
+
+ +\section eight_psk_table 8PSK + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +8PSK125 | 125 | 620 | 80.00% | 125 | 1-8PSK |
| 250HG1B | 56 | 1066 +8PSK250 | 250 | 620 | 80.00% | 250 | 1-8PSK |
| 250HG1B | 56 | 1071 +8PSK500 | 500 | 1650 | 80.00% | 500 | 1-8PSK |
| 500HG1B | 56 | 1076 +8PSK1000 | 1000 | 3300 | 80.00% | 1000 | 1-8PSK |
| 1000HG1B | 56 | 1047 +8PSK125F | 125 | 620 | 80.00% | 125 | 1-8PSK |
| 250HG1B | 56 | 1037 +8PSK250F | 250 | 620 | 80.00% | 250 | 1-8PSK |
| 250HG1B | 56 | 1038 +8PSK500F | 500 | 1650 | 80.00% | 500 | 1-8PSK |
| 500HG1B | 56 | 1043 +8PSK1000F | 1000 | 3300 | 80.00% | 1000 | 1-8PSK |
| 1000HG1B | 56 | 1078 +8PSK1200F | 1200 | 4200 | 80.00% | 1200 | 1-8PSK |
| 1200HG1B | 56 | 1058 +
+ +\section contestia_table Contestia + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:---------------: | :---: | :-: | :--------: | :-----: | :--------: | :----: | :-----: | :----: | :----: +CONTESTIA-4-250 | 62.5 | 40 | 100.00% | 250 | 4-FSK | -10 dB | 250HF1B | 55 |
+CONTSTIA-8-250 | 31.25 | 30 | 100.00% | 250 | 8-FSK | -13 dB | 250HF1B | 49 |
+CONTESTIA-4-500 | 125 | 78 | 100.00% | 500 | 4-FSK | -8 dB | 500HF1B | 54 |
+CONTESTIA-8-500 | 62.5 | 60 | 100.00% | 500 | 8-FSK | -10 dB | 500HF1B | 52 |
+CONTESTIA-16-500 | 31.25 | 30 | 100.00% | 500 | 16-FSK | -12 dB | 500HF1B | 50 |
+CONTESTIA-8-1000 | 125 | 117 | 100.00% | 1000 | 8-FSK | -5 dB | 1K00F1B | 117 |
+CONTESTIA-16-1000 | 62.5 | 78 | 100.00% | 1000 | 16-FSK | -9 dB | 1K00F1B | 53 |
+CONTESTIA-32-1000 | 31.25 | 48 | 100.00% | 1000 | 32-FSK | -12 dB | 1K00F1B | 51 |
+
+ +\section domino_ex_table DominoEX + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :--: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +DominoEX4 | 3.9 | 29 | 100.00% | 173 |
|
| 173HF1B | 84 |
+DominoEX5 | 5.4 | 44 | 100.00% | 244 |
|
| 244HF1B | 85 |
+DominoEX8 | 7.8 | 58 | 100.00% | 346 |
|
| 346HF1B | 86 |
+DominoEX11 | 10.8 | 80 | 100.00% | 262 |
|
| 262HF1B | 87 |
+DominoEX16 | 15.6 | 115 | 100.00% | 355 |
|
| 355HF1B | 88 |
+DominoEX22 | 21.5 | 160 | 100.00% | 524 |
|
| 524HF1B | 90 |
+DominoEX44 | 43 | 312 | 100.00% | 1600 |
|
| 1600HF1B | 263 | 45 +DominoEX88 | 86 | 614 | 100.00% | 1600 |
|
| 1600HF1B | 263 | 46 +
+ +\section mfsk_table MFSK + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:----: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +MFSK4 | 3.9 | 18 | 100.00% | 154 | 32-FSK |
| 154HF1B |
|
+MFSK8 | 7.8 | 36 | 100.00% | 316 | 32-FSK |
| 316HF1B | 60 |
+MFSK11 | 10.8 | 40 | 100.00% | 218 | 16-FSK |
| 218HF1B | 148 |
+MFSK16 | 15.6 | 58 | 100.00% | 316 | 16-FSK |
| 316HF1B | 57 |
+MFSK22 | 21.5 | 80 | 100.00% | 435 | 16-FSK |
| 435HF1B | 152 |
+MFSK31 | 31.3 | 55 | 100.00% | 330 | 8-FSK |
| 330HF1B |
|
+MFSK32 | 31.3 | 120 | 100.00% | 630 | 16-FSK |
| 630HF1B | 147 |
+MFSK64 | 63 | 240 | 100.00% | 1260 | 16-FSK |
| 1260HF1B | 263 | 30 +MFSK128 | 125 | 480 | 100.00% | 1920 |
|
| 1920HF1B | 263 | 31 +MFSK64L | 63 | 240 | 100.00% | 1260 | 16-FSK |
| 1260HF1B | 263 | 30 +MFSK128L | 125 | 480 | 100.00% | 1920 |
|
| 1920HF1B | 263 | 31 +
+ +\section mt63_table MT-63 + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------: | :---: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +MT63-500 | 5 | 50 | 80.00% | 500 | 64 x 2-PSK |
| 500HJ2DEN | 9 |
+MT63-1000 | 10 | 100 | 80.00% | 1000 | 64 x 2-PSK |
| 1K00J2DEN | 12 |
+MT63-2000 | 20 | 200 | 80.00% | 2000 | 64 x 2-PSK |
| 2K00J2DEN | 15 |
+
+ +\section olivia_table Olivia + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:------------: |:---: |:---:| :--------: | :-----: | :--------: | :----: | :-------: | :----: | :----: +OLIVIA-4-250 | 63 | 20 | 100.00% | 250 | 4-FSK | -12 dB | 250HF1B | 75 |
+OLIVIA-8-250 | 31 | 15 | 100.00% | 250 | 8-FSK | -14 dB | 250HF1B | 69 |
+OLIVIA-4-500 | 125 | 40 | 100.00% | 500 | 4-FSK | -10 dB | 500HF1B | 74 |
+OLIVIA-8-500 | 63 | 30 | 100.00% | 500 | 8-FSK | -11 dB | 500HF1B | 72 |
+OLIVIA-16-500 | 31 | 20 | 100.00% | 500 | 16-FSK | -13 dB | 500HF1B | 70 |
+OLIVIA-8-1000 | 125 | 58 | 100.00% | 1000 | 8-FSK | - 7 dB | 1K00F1B | 116 |
+OLIVIA-16-1000 | 63 | 40 | 100.00% | 1000 | 16-FSK | -10 dB | 1K00F1B | 73 |
+OLIVIA-32-1000 | 31 | 24 | 100.00% | 1000 | 32-FSK | -12 dB | 1K00F1B | 71 |
+
+ +\section rtty_table RTTY + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:------: | :---:| :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +RTTY 45 | 45 | 60 | 100.00% | 270 |
|
| 270HF1B | 39 |
+RTTY 50 | 50 | 66 | 100.00% | 270 |
|
| 270HF1B | 40 |
+RTTY 75N | 75 | 100 | 100.00% | 370 |
|
| 370HF1B | 41 |
+RTTY 75W | 75 | 100 | 100.00% | 870 |
|
| 870HF1B |
|
+
+ +\section thor_table THOR + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-------:| :--: | :-: | :--------: | :-----: | :--------: | :--: | :-------: | :----: | :----: +THOR4 | 3.9 | 14 | 100.00% | 173 |
|
| 173HF1B | 136 |
+THOR5 | 5.4 | 22 | 100.00% | 244 |
|
| 244HF1B | 139 |
+THOR8 | 7.8 | 28 | 100.00% | 346 |
|
| 346HF1B | 137 |
+THOR11 | 10.8 | 40 | 100.00% | 262 |
|
| 262HF1B | 143 |
+THOR16 | 15.6 | 58 | 100.00% | 355 |
|
| 355HF1B | 138 |
+THOR22 | 21.5 | 78 | 100.00% | 524 |
|
| 524HF1B | 145 |
+THOR25X4 | 24.3 | 88 | 100.00% | 1800 | 4x tone spacing, 2 sec interleave |
| 1800HF1B | 263 | 40 +THOR50X1 | 48.6 | 176 | 100.00% | 900 | 1 sec interleave |
| 900HF1B | 263 | 41 +THOR50X2 | 48.5 | 176 | 100.00% | 1800 | 2x tone spacing, 1 sec interleave |
| 1800HF1B | 263 | 42 +THOR100 | 97 | 352 | 100.00% | 1800 | 0.5 sec interleave |
| 1800HF1B | 263 | 43 +
+ +\section throb_table THROB + + Mode | Baud | WPM | Duty Cycle | BW (Hz) | Modulation | S/N | ITU | RSID-1 | RSID-2 +:-----: | :---: | :-: | :--------: | :-----: | :----------: | :---: | :-------: | :----: | :----: +THROB1 | 1 | 10 | 80.00% | 72 | 1/2 of 9-FSK |
| 72H0F1B | 43 |
+THROB2 | 2 | 20 | 80.00% | 72 | 1/2 of 9-FSK |
| 72H0F1B | 44 |
+THROB4 | 4 | 30 | 80.00% | 144 | 1/2 of 9-FSK |
| 144HF1B | 45 |
+THROBX1 | 1 | 10 | 80.00% | 94 | 2 of 11-FSK |
| 94H0F1B | 46 |
+THROBX2 | 2 | 20 | 80.00% | 94 | 2 of 11-FSK |
| 94H0F1B | 47 |
+THROBX4 | 4 | 40 | 80.00% | 188 | 2 of 11-FSK |
| 188HF1B | 146 |
+
+ + + +
+\ref mode_table_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/MousingKeyboardShortcuts.txt b/fldigi_doxygen/user_src_docs/MousingKeyboardShortcuts.txt new file mode 100644 index 00000000..387942b9 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/MousingKeyboardShortcuts.txt @@ -0,0 +1,199 @@ +/** +\page mouse_and_keyboard_shortcuts_page Mouse and Keyboard Shortcuts + +\tableofcontents + + +Fldigi has a bewildering number of keyboard and mouse shortcuts, some +of which may help make your particular style of operation more +efficient. You do not need to know them all to make effective use +of the program! +
+ +\section main_window Main window +
+ +\subsection text_input_fields Text input fields +
+ +Most text fields use a combination of CUA (PC) and Unix-style +keybindings. Text can be marked, copied, pasted, saved to a file +as well as transfer to other main panel controls. A right click +on any text control will open a context sensitive menu for that +particular control. A full list can be found on the +FLTK web site +
+ +The received/transmitted text widgets use CUA key bindings with some +modifications: + +\subsubsection rx_text RX text + +This widget is read-only and ignores shortcuts that would modify its contents. +See \ref qso_log_book_page "logbook" for details on the Rx right click +popup menu system. +
+ +\subsubsection tx_text TX text + +The text that has already been sent is protected, but can be deleted one +character at a time with the Backspace key. Right clicking on the Tx text +panel opens the following popup menu: +
+ +\image html menu-tx-popup.png "Fldigi Receiving Editing Tx text" +\image latex menu-tx-popup.png "Fldigi Receiving Editing Tx text" width=1.0in +
+ +\image html menu-tx-popup2.png "Fldigi Transmitting" +\image latex menu-tx-popup2.png "Fldigi Transmitting" width=1.0in +
+ +
    +
  • Transmit
    put the program into the transmit operation

    • +
  • Receive
    during a transmit or tune, end the transmit and restore + receive operation

    • +
  • Abort
    during a transmit, receive without waiting for the modem to + finish sending

    • +
  • Send image
    for MFSK only, send an image using MFSKpic mode

    • +
  • Clear
    clear all of the text

    • +
  • Cut
    delete the marked text (by left click drag over text)

    • +
  • Copy
    copy the marked text to the clipboard

    • +
  • Paste
    the clipboard text to the current text insertion point

    • +
  • Insert file
    select a file from file browser to insert in text at + insertion point

    • +
  • Word wrap
    turn word wrap on/off

    • +
+ +The Tx panel is fully drag and drop aware. That means you can add a +file to the transmit text by simply opening up a file manager +(different for different OS and choice of desktop). Select the +file from the manager and then drag and drop it onto the Tx panel. The mouse +pointer will move the cursor insert point for the drop. +
+ +A number of additional shortcuts can be found in the +\ref keyboard_operation_page "Keyboard Operation" section. + + +\subsection waterfall_display Waterfall display +
+ +Most of fldigi's unusual shortcuts are specific to this widget. +
+ + +\subsubsection waterfall_display_keyboard Waterfall display - Keyboard + +
    +
  • Shift Left/Right - move the b/w marker by 1 Hz
    • +
  • Ctrl Left/Right - move the b/w marker by 10 Hz
    • +
+ +\subsubsection waterfall_display_mouse Waterfall display - Mouse + +
    +
  • Left click/drag - move the b/w marker to, and start decoding at + the cursor frequency
    • +
  • Right click/drag - as above, but return to previous position on + release
    • +
  • Middle click - toggle AFC
    • +
  • Ctrl-Left click - replay audio history at b/w marker position
    • +
  • Ctrl-Right click - replay at cursor frequency and return on + button release
    • +
  • Ctrl-Middle click copy the frequency under the cursor to + the currently selected (or first) channel in the PSK viewer, and + select the next channel
    • +
  • Shift-Left click/drag same as unmodified left click; no signal + search
    • +
  • Shift-Right click/drag likewise, with a return to the previous + frequency when the button is released, no signal search
    • +
  • Shift-mouse wheel - move the squelch slider
    • +
  • Scroll wheel usage is dependent upon the + configuration (see \ref ui_configuration_waterfall_controls_page "ConfigWaterfall")
    • +
      +
    • None - no mouse wheel activity in waterfall panel
      • +
    • AFC range or BW - adjust the AFC range/BW up/down
      • +
    • Squelch level - adjust the squelch level up/down
      • +
    • Modem carrier - adjust the audio tracking point +/- Hz increments
      • +
    • Modem - select modem type from a full rotary of available modems
      • +
    • Scroll - move the waterfall left/right in 100 Hz increments + (for 2x, 4x expanded waterfall view)
      • +
    • Ctrl-mouse wheel - change the AFC search width in PSK modes, + or the bandwidth in CW and FeldHell
      • +
    +
  • Ctrl-Alt-Left click on the mouse when the mouse pointer is + in the waterfall - if operating with flrig and a supported transceiver + such as the FT-950, will set the transceiver manual notch frequency to + the frequency under the mouse cursor. Repeat the Ctrl-Alt-Left click + to disengage the notch. Disengagement is not dependent on where the + cursor is on the waterfall, just that it be in the waterfall.
    • +
+ +\subsubsection waterfall_store_button Waterfall "Store" button + +
    +
  • Left click - Add a new item for the current frequency and modem
    • +
  • Shift-Left click - Delete all items
    • +
  • Middle click - Select last item in menu
    • +
+ +
    +
  • Right click - Pop up menu
    • +
      +
    • Left/right click - Select item (and switch to that + frequency/modem)
      • +
    • Shift-Left/right click Delete item
      • +
    • Middle click - Update (replace) item
      • +
    +
+ +\subsubsection digiscope_display Digiscope display + +
    +
  • Mouse wheel - Change AFC/BW, same as Ctrl-mouse wheel on the waterfall
    • +
+ +\subsubsection rig_control_window Rig control window + +There are some shortcuts in addition to those described in the \ref rig_control_page "Rig Control" + + +\subsubsection frequency_display Frequency display + +
    +
  • Left/Right arrow key - change the frequency by one 1 Hz
    • +
  • Up/Down arrow key - change the frequency by 10 Hz
    • +
+ +\subsubsection frequency_list Frequency list + +
    +
  • Shift-Left click - delete the line under the cursor
    • +
  • Middle click - replace the line under the cursor with the current frequency/mode/modem
    • +
+ + +\subsubsection psk_viewer_window PSK viewer window + +
    +
  • Besides the bindings mentioned in the \ref signal_browser_page "PSK Viewer" + section, there are mouse shortcuts to change the nominal frequency of a + viewer channel:
    • +
      +
    • Middle click copy the current waterfall b/w marker frequency + to the channel under the cursor, overwriting that channel's nominal + frequency
      • +
    • Right click - restore a channel's nominal frequency
      • +
    • Right click on Clear - as above, for all channels
      • +
    +
+ + +
+\ref mouse_and_keyboard_shortcuts_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/Multiples.txt b/fldigi_doxygen/user_src_docs/Multiples.txt new file mode 100644 index 00000000..d722d947 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Multiples.txt @@ -0,0 +1,51 @@ +/** +\page operating_multiple_copies_page Operating Multiple Copies + +\tableofcontents + +\image html Dual-fldigi.png "Multiple Copies of FLDIGI" +\image latex Dual-fldigi.png "Multiple Copies of FLDIGI" width=6.0in +
+ +There are times that you may need to simultaneously operate two or more +instances of fldigi. Or you might simply want to maintain two +different configurations based on hardware usage. +
+ +The screen shot shows how this is done on Vista, but the process is +nearly the same on XP, Win7 and Linux. When you install fldigi it +creates a desktop icon launcher. Most of the Linux window +managers allow you to create a desktop launch icon. Make as many +copies of the launcher as needed for your applications and rename them +accordingly. Then change the executable target entry to include +the \ref command_line_switches_page "command line switch" '--config-dir' +followed by the full pathname of the folder that will hold that +particular configuration. You do not need to create that folder +as fldigi will do so the first time it is launched from that desktop +icon. +
+ +If the various configurations all use independent hardware, i.e. sound +cards and rig control ports, then you can have them operating +simultaneously. Each instance will have it's own configuration +files, status file, macros, and logbook. It is possible to have +each instance use the same logbook, but then simultaneous operation is +not possible as the logbook file is not currently designed to allow +that type of sharing. +
+ +If each instance will be paired with a separate flarq (similarly set up +for multiple operation) then you will also need to add the command line +switch for \ref command_line_switches_page "arq-server address and port". +The same is true for use with applications that talk to fldigi via it's +xml-rpc socket port. You change the address/port pairs on both +the fldigi launcher and the paired application such as flarq or flrig. +
+ +
+\ref operating_multiple_copies_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/Navtex.txt b/fldigi_doxygen/user_src_docs/Navtex.txt new file mode 100644 index 00000000..ea126b3b --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Navtex.txt @@ -0,0 +1,188 @@ +/** +\page navtex_and_sitorb_page NAVTEX and SITOR-B + +\tableofcontents + +\image html Navtex-Choosing.png "Op Mode Select" +\image latex Navtex-Choosing.png "Op Mode Select" width=1.1in +
+ + +NAVTEX (Navigational Telex) is an international automated service for +delivery of meteorological and marine safety information to ships. These +broadcasts are sent with the +SITOR collective B-mode +(Also known as AMTOR-B or AMTOR-FEC), using the +CCIR 476 + character set. SITOR-B is also used in amateur radio, + where it is known as AMTOR-B or AMTOR-FEC. +
+ + +It transmits at 100 baud FSK modulation with a frequency shift of 170 Hz. The +frequencies are: +
+ +
    +
  • 518 kHz : International frequency, always in English.
    • +
  • 490 kHz : Regional transmission, in local languages (Not used in the United States).
    • +
  • 4209.5 kHz : Marine Safety Information.
    • +
+
+ +The implementation reflects this structure: The Navtex +modem is a specialization of the SITOR-B modem. Fldigi supports +both modes. We will specify when their behaviors are different. +
+ +\section transmitting_text Transmitting a text + +Transmitting a text is done with the usual GUI. The only difference +between the SITOR-B and Navtex modes, is that data (Whether sent +with the GUI or with XML/RPC) are untouched in SITOR-B. In Navtex, +on the contrary: +
+ +
    +
  • They are preceded by a phasing signal of several seconds.
    • +
  • A \"ZCZC B1B2B3B4\" + preamble is sent.
    • +
  • Then the original message is transmitted.
    • +
  • ... followed by the "NNNN" terminator,
    • +
  • ... and another phasing signal.
    • +
+ +\section receiving_text Receiving a text + +The only difference between the SitorB and Navtex modes, is that +messages are processed (Parsed and optionally stored) only in Navtex +mode. Here is a typical transmission showing: +
+ +
    +
  • The end of a previous message : "NNNN"
    • +
  • The preamble of a new message: "EA85": 85th + navigational warning ('A') of the Niton station in England ('E').
    • +
  • The message itself, without the terminator (Which should come soon).
    • +
+
+ + +The modem has some flexibility when interpreting messages, and is able to +deal with missing or incomplete preamble and terminator. +
+ + +\image html Navtex-Reception.png "Navtex Reception" +\image latex Navtex-Reception.png "Navtex Reception" width=6.0in +
+ +\section automatic_frequency_control AFC: Automatic Frequency Control + +As shown in the reception screen hard-copy, it is possible to tick +"AFC". The consequence is that the frequency is continuously +monitored. +
+ + +\section logging_navtex_data Logging Navtex data to ADIF files + + +Navtex messages are delimited with the usual separators ZCZC and NNNN. +Their format is: +
+ + +ZCZC B1B2B3B4
(message text ...)
NNNN
+ + +These four characters are: +
+ +
    +
  • B1 : The + station origin, used for lookups in the Navtex stations file. The same + character is associated to several stations. Therefore, we use other + criteria such as the frequency and the distance to the receiver, to + eliminate the ambiguity. It is therefore important to specify correctly + your Maidenhead locator.
    • +
  • B2 : The subject indicator, used by the receiver to identify + the message class, such as ice reports or meteorological messages.
    • +
  • B3B4: A serial number between 00 and 99.
    • +
+ +\section navtex_config Configuration + +\image html Navtex-Configuration.png "Navtex Configuration" +\image latex Navtex-Configuration.png "Navtex Configuration" width=6.0in +
+ +As for any modem, there is a specific configuration tab for Navtex which allows: +
+ +
    +
  • To specify whether messages should be stored in the current + Adif log file.
    • +
  • To choose the Text file containing stations definitions.
    • +
+ +\section adif_journal ADIF journal file + +\image html Navtex-Logged-Contacts.png "Logging Contacts" +\image latex Navtex-Logged-Contacts.png "Logging Contacts" width=6.0in +
+ +Navtex messages can be logged to the ADIF file. This is done with other +extra data: +
+ +
    +
  • Date and time of the contact.
    • +
  • Frequency and mode.
    • +
  • Station name, country, Maidenhead locator + and callsign deduced from the message header and the Navtex stations + file (See below). The locator is calculated using the station + coordinates.
    • +
  • The message content itself. Note that + carriage-returns which cannot be displayed on a single line, are + transformed into a tilda "~".
    • +
+
+ +\section station_file Stations file + +\image html Navtex-Choosing-Stations-File.png "Choosing Stations File" +\image latex Navtex-Choosing-Stations-File.png "Choosing Stations File" width=5.0in +
+ +The emitter station is extracted from the Navtex message, and used to +extract latitude, longitude, station name and other characteristics from +a file containing well-known station, data/NAVTEX_Stations.csv. It is +possible to edit this text file, or to choose another one. +
+ +\section xml_rpc_functions XML/RPC functions + +Two XML/RPC functions are create: + +
+ + + + + + + + + +
navtex.get_messageReturns next Navtex/SitorB message with a max delay in seconds passed +as an integer parameter. Empty string if timeout.
navtex.send_messageSend a Navtex/SitorB message, passed as a string. Returns an empty +string if OK otherwise an error message
+ +
+\ref navtex_and_sitorb_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/New-Install.txt b/fldigi_doxygen/user_src_docs/New-Install.txt new file mode 100644 index 00000000..2ef73b21 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/New-Install.txt @@ -0,0 +1,138 @@ +/** +\page new_installation_page New Installation + +\tableofcontents + + +fldigi's opening screen looks like the following when starting fldigi for the +first time or when setting up a second or subsequent instance using the +--config-dir command line switch. The Wizard has been completed and the +callsign, W1HKJ, entered. +
+
+ +\image html main-dialog-newinstall.png "Main Dialog New Install" +\image latex main-dialog-newinstall.png "Main Dialog New Install" width=6.0in +
+ + +Fldigi will create a working files folder, multiple sub folders and also +populate them with a set of default files. The working files folder is +different on the different OS. + +
+| Operating System | Folder/Directory | +| :---------------: | :----------------------------------------------------- | +| Windows | C:\\Documents and Settings\\\\\fldigi.files | +| Vista | C:\\Users\\\\\fldigi.files | +| Linux | /home/\/.fldigi | +| Macintosh | /Users/User_Login_Name/.fldigi | +
+
+ +After closing the application the working folder will contain the following +folders and files: +
+ +\image html folder-working.png "Working Folder" +\image latex folder-working.png "Working Folder" width=6.0in +
+ +The help, images, logs, scripts and temp folders will be empty. They +will contain program created files as you use the program or you may +post files in those folders for use by fldigi. Images to be sent +with the MFSK pic mode should be placed in images. Your logbook +database will appear in logs. If you are running on Linux then +you can use various scripts to enhance the macro language that fldigi +supports. The temp directory holds files that are transitory and +you can safely delete those files between sessions. The 5 files +that appear initially are: +
+ + + + + + + + + + + + + + + + + + + + + + + +
fldigi.prefscontains +variables that describe the status of fldigi when last used. This +is an ASCII text file that you can safely read. You should not +edit or change this file.
fldigiYYYYMMDD.logthis is an historical log of all the received and transmitted text +during the day for which the log refers
fldigi_def.xmlcontains +variables that relate to all of fldigi's configurable items. This +is an ASCII text file that conforms with the XML specification. + You can safely read this file but should not edit or change it.
frequencies2.txtan ASCII text file that contains the default (and / or modified) +entries for fldigi's rig control process
+\ref working_logs_page "status_log.txt" +a +log of events for the most current fldigi execution. This file +will contain information relative to any errors that my occur and is +important for debugging purposes.
+
+ +The macros folder contains a single file: macros.mdf. This is +an ASCII text file that contains the default macro definitions. + After running fldigi for a while and creating your own sets of +macro definitions there will be additional *.mdf files located here. +
+ +The palettes folder contains the following files: +
+ +\image html folder-palettes.png "Folder Palettes" +\image latex folder-palettes.png "Folder Palettes" width=5.0in +
+ + +
Each +of these is a palette definition file that is used to modify the +appearance of the waterfall. Fldigi has a palette editor that +enables you to modify these default files or to create your own. + The file format of these files is identical to the palette files +used by DigiPan. The final color rendition might be a little +different as a result of using different painting functions. The +file digipan.pal contains:
+
+ + + + + +
0; 0; 0
0; 0; 62
0; 0;126
0; 0;214
145;142; 96
181;184; 48
223;226;105
254;254; 4
+
+
+ +Don't bother trying to modify these using an editor. The palette editor +is much easier to use and will keep you from wrecking havoc with the +program. +
+ +The easiest way to find the working files folder is to start fldigi and then +select the menu item File/Show config. +
+ + +
+\ref new_installation_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/Notifier.txt b/fldigi_doxygen/user_src_docs/Notifier.txt new file mode 100644 index 00000000..f9b94b9a --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Notifier.txt @@ -0,0 +1,312 @@ +/** +\page notifier_page Notifier + +\tableofcontents + + +This dialog available is used to specify search patterns and alerts that are triggered +when the decoded Rx text matches those patterns. This only happens +when the Spot button on the main window is activated, as with the PSK +Reporter client. +
+ +\image html Notifications.png "Notifications" +\image latex Notifications.png "Notifications" width=5.0in +
+ +First, here's how it works in general. You specify a regular +expression (RE) that contains one or more parenthesised capturing +groups. Fldigi's spotter matches it against the incoming text (main +window or Signal Browser, so it works with both PSK and RTTY) and, if +the RE matches, it performs one or more of the following: +
+ +Displays an alert window with some text and a "go to that frequency" button. +
+ +Enters some arbitrary text into the Transmit pane. The text may +contain \s and these will be expanded as usual. +
+ +Runs a program (Unix/Linux only for now). +
+ +The text described by the capturing group(s) can be used in all of the +above. There is an example of this at the end of this page. +
+ +Not everyone is at ease in writing regular expressions for the notifier +to act upon. So a few "canned" searches are coded into the +notifier and are selected from the event chooser at the upper left of +the dialog. +
+ +\image html Notification-Events.png "Notification Event Types" +\image latex Notification-Events.png "Notification Event Types" width=2.0in +
+ +
    +
  1. My Callsign de CALL. Can be used to alert you when CALL calls you.
    2. +
  2. Station heard twice. Pretty much the same search that the PSK reporter client does.
    3. +
  3. Custom text search. This reveals an input field where you type your own RE.
    4. +
  4. RSID reception.
    5. +
+
+ +Both (1) and (2) are special cases of (3), but with some extra +processing available because in each case fldigi knows what it has just +found. +
+
+ +The Filter pane is available for the first two event types only, i.e. +not the custom text search. In this pane you can specify some +properties that the spotted callsign must have for the actions to take +place: +
+ + +a) The Callsign radio button reveals a text field when selected. If you +enter something in that field, the event will be accepted only if the text +matches the spotted callsign (I may change this to a RE match). +
+ +b) The "DXCC entity" radio button reveals a button that brings up a +list of DXCC entities. Select entities by clicking or +dragging. If you select any at all, the spotted callsign's +country will have to be one of those or the event will be +ignored. Having no entities selected is the same as selecting all +of them, i.e. any country, but is a more efficient. +
+ +The entity list can be sorted by clicking on the row headers, and there is a +right click context menu that can (de)select by continent and CQ zone. The +buttons and search fields at the bottom behave as you'd expect. +
+ +The list is also available with the menu item "View / Countries" in the +main window. +
+ +You need cty.dat for all this to work +
+ +c) The "Not worked before" check button +asserts that, if you have selected (a) above, the callsign must not be +in your logbook. Same with (b), but now you must not have had any +QSOs with stations from that country in the log. +
+ +d) The "LotW user" and "eQSL user" buttons specify that the callsign +must be on one of these two lists (the documentation explains where to +get the user lists from and where to put the files). +
+
+ +The Action pane is where you choose how fldigi will alert you when an event +matches the filter bits. +
+ +a) The text in the "Show alert text" box, if not empty, is shown in a pop-up +window. The alert window has a timer and dismisses itself after a +configurable time interval (the "Hide after" control). The user can +click anywhere inside the window to stop the timer. + +\image html Notifier-popup.png "Notifier Popup" +\image latex Notifier-popup.png "Notifier Popup" width=4.0in +
+ + +The button next to the text box enters the default alert text for the event +you have selected. There are a few variables that are substituted +when the window is displayed: +
+ +For all three event types: $MODEM (modem name), $DF_HZ (dial +frequency), $RF_HZ (actual receive frequency), $RF_KHZ, $AF_HZ (modem +audio frequency) +
+ +For the 1st event type (my call): $CALLSIGN, $TEXT (all matched text). +
+ +For the 2nd event type (station): $CALLSIGN, $TEXT, $COUNTRY. +
+ +For the 3rd event type (custom): you're on your own here, but fldigi +will helpfully list all the possible substrings found in your RE. +
+ +The whole text is passed through strftime(3) so you can customize the +date. Here's a reference for the % characters: +
+ + +http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html +
+ +b) The "Append to TX text" box -- self explanatory. The same variable +substitutions apply, as well as macro expansion. The nearby button shows +the macro editor. The appended rx text is clickable. Clicking it will move +the waterfall frequency (and transceiver if under CAT) to the detected +signal and change to the indicated mode. +
+ +\image html Notifier-rxtext.png "Notifier RX Text" +\image latex Notifier-rxtext.png "Notifier RX Text" width=5.0in +
+ +c) The "Run program" field and browse button are only available on Unix +systems. Field contents are passed to the shell ("/bin/sh -c"), +as with system(3). No variable or \\backref substitution is done +for this field, but all substrings are exported as environment +variables, such as FLDIGI_NOTIFY_STR_1. The usual \ +macro variables are also there and your ~/.fldigi/scripts directory +will be in the shell's path. Try it out with a test script for +the full list of variables. +
+ +d) The trigger limit box specifies how much time must pass +between subsequent invocations of whatever actions you have +specified. +
+
+ +The Duplicates pane has a check button that displays the rest of that +group when checked. If you enable this, fldigi will remember what +it has seen and ignore the event if it is a duplicate. The other +controls in that pane determine what constitutes a duplicate: +
+ +a) The menu tells fldigi what to look +at. For the first two event types, the menu will display "Callsign", +and for the custom search it will contain a list of \\X references +for the RE. +
+ +b) The time box is also essential; it determines how close the events must +be in time to be considered duplicates. +
+ +c) The Band and Mode check boxes further restrict the comparison.
+
+ +An example: + +You are looking at callsigns, with a dup time of 600s, and both Band +and Mode checked. A callsign is found once and fldigi alerts +you. Now if this callsign is spotted again, less than 600s later +and in the same band and mode, it is a duplicate and will be +ignored. With (say) Band and Mode unchecked, it is a duplicate +regardless of frequency band or mode as long as it's heard before the +600s elapse. +
+ +Three of the four buttons at the bottom left are pretty much +self-explanatory. Add to the list an event you have just +specified, or select an event from the list and Remove it, or change +some of its parameters and Update it. +
+ +The Test... button allows you to test an event with some text of your +choice. This is particularly useful with the custom text search, +as it's too easy to enter a RE that will never match. The dialog +will show you the default test string for the two fixed event +types. Careful: the "Station heard twice" event type expects a +non-alphanumeric character at the end of its input. The default +test string has a space at the end. +
+ +If nothing happens, it may be because you have not specified any +actions, or because the event's filter does not match, or because the +trigger limit or dup handling are preventing the actions from happening. In +the latter case, updating an event will reset its dup +data. But it's better to add the dup and trigger limits at the +end, after you've tested the event. +
+ +The list at the bottom of the window shows the events you have +added. All contents are saved in the file ~/.fldigi/notify.prefs. +
+ +The list has a context menu for quick access to Update, Remove, and +Toggle. The first two have the same effect as clicking on the button of +the same name. +
+ +The Toggle item lets you flip the "Enabled" status of an event: this is +like selecting an event, clicking on the "Enabled" button in the Event +pane to (de)activate it, and then clicking "Update". Disabled +events are kept on the list but are not registered with the spotter and +so they are never triggered. +
+ +If you disable all the events and there is nothing else using the +spotter (e.g. PSK Reporter), the Spot button will disappear from the +main window. +
+ +A 2nd example: + +Here's how to do the "my call" event using the custom text search: +
+ +a) Select "Custom text search" in the event pane +
+ +b) In the RE box, enter (without the quotes or leading white space): +
+ +\"\.+de[[:space:]]+([[:alnum:]]?[[:alpha:]/]+[[:digit:]]+[[:alnum:]/]+)\" + +and remember to replace \ with your callsign.
+ +c) In the actions pane you can now use \0 for the whole text matched by +the above RE, and \1 for the first capturing group (the callsign). +
+ +d) Select "\1" in the duplicates menu if you want dup filtering. +
+ +e) Test with \"\ de \\" and you should see the +alert window with the text you specified. +
+ +Addional examples: + +Add a "My callsign de CALL" event with a script that will do something to +get your attention when someone calls you. +
+ +Add a "Station heard twice" with the DXCC filter and the "Not worked +before" option. Also set the LotW or eQSL options if desired. +
+ +Add a "Station heard twice" with no callsign/dxcc/etc. filter but with +duplicate filtering. Write a script that sends the data to a DX +cluster or similar. +
+ +Here is a simple Perl script that uses notify-send (in the package +libnotify-bin on Debian) to display desktop notification +"bubbles". A better version would use the libnotify bindings for +Perl or Python directly. + +\verbatim +-----------------------------snip +#!/usr/bin/perl +exec("notify-send", "-t", "5000", "-i", "/usr/share/pixmaps/fldigi.xpm", + "Heard " . $ENV{"FLDIGI_NOTIFY_CALLSIGN"} . " ($ENV{FLDIGI_NOTIFY_COUNTRY})", + $ENV{"FLDIGI_NOTIFY_STR_0"}); +snip---------------------------- +\endverbatim + + + +
+\ref notifier_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/Olivia.txt b/fldigi_doxygen/user_src_docs/Olivia.txt new file mode 100644 index 00000000..2d8a69c4 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Olivia.txt @@ -0,0 +1,197 @@ +/** +\page olivia_page Olivia + +\tableofcontents + + +fldigi can operate on the following Olivia modes without special setup by the +operator: +
+ +
+ +Mode | Symbol Rate | Typing Speed | Bandwidth +:-------------:|:-----------:|:-------------------:|:----------: +Olivia 8-250 | 31.25 baud | 1.46 cps (14.6 wpm) | 250 Hz +Olivia 8-500 | 62.5 baud | 2.92 cps (29.2 wpm) | 500 Hz +Olivia 16-500 | 31.25 baud | 1.95 cps (19.5 wpm) | 500 Hz +Olivia 32-1000 | 31.25 baud | 2.44 cps (24.4 wpm) | 1000 Hz + +
+
+ +Unusual combinations of symbol rate and bandwidth can be selected +using the \ref olivia_configuration_page "Olivia configuration tab". +
+ +These are unconnected, simplex chat modes with full time Forward Error +Correction. Olivia is a very robust mode with low error rates, +but the penalty can be an annoyingly slow transfer of information. If you are +a one finger typist then Olivia is your cup of tea. The tones are spaced the +same as the baud rate, for example 31.25 Hz for the default baud rates. The +default calling mode is 32-1000. It has the following appearance on +fldigi's waterfall: +
+ +\image html Olivia32-1000.png "Olivia 32/1000" +\image latex Olivia32-1000.png "Olivia 32/1000" width=3.0in +
+ +Excerpts from the web pages of +Gary, WB8ROL + +
+ +Oliva Mode is a little different than PSK, RTTY, and many other digital +modes. Below are tips on how to maximize your use of this mode. +
+ +Disable your software squelch or turn it down as low as you can +
+ +Generally turn your squelch setting in your software off or set it as +low as it will go. You will see some "garbage" letters get printed out +if there is NO Olivia signal present but it doesn't harm anything. When +an Olivia signal is there it will start decoding it and print out the +text without garbage at that time. It doesn't do much good to use a +digital mode like Olivia that can decode signals -14 db below the noise +lever IF you squelch it AT the noise level! It would be like +getting a pair of high power binoculars and using them only in a 10x10 +room with no windows. +
+ +Be Patient! +
+ +When you call CQ on this mode be patient and wait at least 45-60 +seconds before you put out another call. When the other person who +hears your CQ clicks on the waterfall it may take 4-20 seconds or even +longer before they might actually start decoding your signal. +That varies a lot depending on the software they are using AND value +they have their Sync Integration Period set to. +
+ +The Sync Integration Period setting determines how "deep" the Olivia +decoding algorithm searches in the noise to get the signal. A +higher settings takes longer BUT usually decodes with more accuracy - +at least to a point. However, a higher setting (since it does +more work and takes longer) will increase the delay factor. So, +when you finish your CQ and your transmitter switches to receive - the +station listening to you (depending on his Sync Integration Periods +setting) MAY NOT finish decoding your CQ for another 4-20 +seconds. The same applies during a QSO when you pass it back to +the other guy for his turn -- be patient if he doesn't come back right +away because his software may still be decoding your signal long after +you stopped transmitting. +
+ +It DOES NOT PAY to be impatient on this mode and send SHORT CQ's or NOT +wait at least 45-60 seconds between CQ's. Generally a a 2x2 CQ +sent at least 2 or 3 times is going to work much better for you than a +short one. Below is the normal CQ I use though on real fast Olivia +formats (like 500/4) I will do a 3x3 and send it 3 times. +
+ +CQ CQ de WB8ROL WB8ROL +
+CQ CQ de WB8ROL WB8ROL +
+CQ CQ de WB8ROL WB8ROL pse K +
+ +Don't set your Sync Integration Period setting TOO high +
+ +If you set your Sync Integration Period too high it MAY take minutes +before your software will start decoding a signal AND there is no or +little benefit to doing that past a certain point. I usually set +mine so that the delay factor is abut 15-20 seconds. I can time +this delay factor by sending a very short test and then when it is done +and the software switches back to receive - time the number of seconds +before you see random garbage start appearing on the screen (assuming +you have your SQUELCH OFF). For the standard Olivia modes like +2000/64, 1000/32, 500/16, 250/8, and 125/4 that usually means my Sync +Integration Period is set between 3-5 most of the time. If I use +the faster formats I set it higher often between 6-10. As long as +my delay factor is approx. 15-20 seconds. Any higher than that and I +don't see any real improvement in the quality of the decoding. +But play with your own settings and see what does best for you. +If you leave it always on one setting, though, and use standard and non +standard formats of Olivia you are short changing yourself. +
+ +Generally keep your Search (Tune Margin) setting to about 8 +
+ +The setting of 8 is usually good for most situations and this setting +is usually not all that critical. However, under a few band +conditions it might (or might not) help to temporarily adjust +this. If you find other Olivia signals very very close to you - +almost adjacent or even overlapping it might help to reduce this +setting to 4 or even 2. This setting determines how far, either +side of your center frequency, Olivia will search for a signal to +decode. If you reduce this when another Olivia signal is close or +overlapping it may keep it from locking onto the other signal instead +of yours. Also .... if you are trying to decode an extremely weak +signal and can't even tell exactly WHERE to click on the waterfall +because the trace is too faint or non existent then it might help to +increase this setting to 16 or 32 temporarily. Then it would perhaps +decode the signal even if you were OFF his center frequency by a large +margin. +
+ +If the slow speed of Olivia bothers you some ... +
+ +If you find yourself wanting things to go a little faster then start +using more (ham) common abbreviations like "hw" for how and "ur" for +your. Don't waste time sending words like "the" and "and" all the +time. An example : The weather here is nice and sunny today and +the high will get to 85 degrees --- instead send : Wx nice + sunny - +high 85 deg -- No need to spell out everything and use superfluous +words like the, and, many others. And why use words like HERE and +TODAY in the above context when the other station already knows you are +telling the weather for YOUR QTH for TODAY. You aren't writing a +novel, an article, or in a spelling bee. Also after you establish +the QSO don't send BOTH calls all the time at the beginning and end of +every transmission. After the QSO is in progress come back to the +station like this : .. de WB8ROL -- instead of : W9ZZZ de +WB8ROL -- and when you sent it back to the other guy send : BTU - +de WB8ROL KN -- That will help speed things up too. You +don't need to send the other stations call sign continually to fulfill +your legal obligation to identify your own station. +
+ +Don't be afraid to switch to a NON standard Olivia format if +conditions warrant it. +
+ +If signals are real strong and you prefer to be sending and receiving +at a faster speed - don't be afraid to ask the other station if they +would like to speed things up and switch to another Olivia format - +even a non-standard one. If you, for instance, were talking to me +on 500/16 Olivia format and we both had very strong signals and not +much QRM, QRN, etc. then ask me if I would like to go to 500/8 format +or even 500/4 format. 500/16 format is approximately 20wpm while +500/8 is close to 30wpm and 500/4 close to 40wpm. If you do end up +switching to the faster modes you may also want to increase your Sync +Integration Period setting substantially too - to maintain the best +quality decoding. If not, you might get more errors in the +decoded text. And if the band conditions become worse - go back +to the original format AND remember to reset your Sync Integration +Period setting or the delay in decoding will be way too long! +Also, if the band starts getting real crowded and say, for example, you +were on 500/16 mode - you might suggest to the other station to switch +to 250/4 mode (increase Sync Integration Period setting too) to save +space and be a "good neighbor" to all the other operators nearby. +250/4 is the SAME speed as 500/16 and nearly as sensitive with the +correct settings. +
+ + +
+\ref olivia_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" +*/ + diff --git a/fldigi_doxygen/user_src_docs/OperatingControls.txt b/fldigi_doxygen/user_src_docs/OperatingControls.txt new file mode 100644 index 00000000..cfa5ff78 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/OperatingControls.txt @@ -0,0 +1,362 @@ +/** +\page operating_controls_page Operating Controls and Displays + +\tableofcontents + + +\image html fldigi-controls.png "FLDIGI Controls" +\image latex fldigi-controls.png "FLDIGI Controls" width=6.0in +
+ +The main display for fldigi is the waterfall display shown above in color +and in scale x1. +
+ +The button WF toggles the display between a waterfall, a spectrum +display and an oscilloscope type view of the Rx and Tx signals. This +button acts as a rotary. Left clicking moves the display selection in one +direction and right clicking in the other direction. The three display modes +are WF - waterfall, FFT - spectrum (Fast Fourier Transform) +and Sig - oscilloscope time domain. Let the mouse cursor hover over +any one of the controls and a small hint box will open to help you navigate +the various controls. +
+ +The Norm button controls the speed of the waterfall drop. This is +also a rotary type of button control. The speeds available are SLOW, NORM, +FAST and PAUSE. The load on the cpu will be directly proportional to this +selection. If your cpu is slow you might want to select the SLOW +or PAUSE option for the waterfall. +
+ +The scale control (X1, X2, X4) expands or contracts the view into the +fast fourier transform that is displayed on the waterfall or the FFT +display. fldigi always computes the FFT to a 1 Hz resolution, and +displays the results according to the scale control. +
+ +\image html psk-waterfallx1.png "PSK Waterfall X1 scale" +\image latex psk-waterfallx1.png "PSK Waterfall X1 scale" width=1.75in +
+ +\image html psk-waterfallx2.png "PSK Waterfall X2 scale" +\image latex psk-waterfallx2.png "PSK Waterfall X2 scale" width=2.5in +
+ +\image html psk-waterfallx4.png "PSK Waterfall X4 scale" +\image latex psk-waterfallx4.png "PSK Waterfall X4 scale" width=3.0in +
+ +
The next three controls are positional conrols for the waterfall. The +waterfall can display 4096 data points, where each one can be thought +of as a spectral line at the equivalent Hertz. The ratio is actually +8000/8192 and is related to the ratio of sound card sampling rate to +Fast Fourier Transform length. This ratio changes for some modems +that require a sampling rate other than 8000 Hz. The left arrow key +will shift the display to the right (displays a lower section of the +spectrum). The right arrow key moves the display higher in frequency. + These two buttons are repeating buttons. Hold them down and the +display slews at about 20 shifts / sec. The center button with +the two vertical block lines is a "center the signal" button. The current +cursor (red signal cursor in the waterfall) will be centered in the +display area. + +NOTE: these controls are only functional if +the current waterfall or spectrum view is smaller than the full view +available. This is usually the case when the X2 or X4 expansion +is selected. But it also might be the case when the width of the +main dialog is reduced so that the waterfall display does not extend +over the entire available width. + +Try moving the cursor around in the waterfall +area. You will see a set of yellow cursor blocks that show the center +point and bandwidth of the current operating mode (psk31 = 31.25 Hz for +example). To capture a received signal just click near the signal and +the AFC will perform a multi-step acquisition. This will be very fast +and should not require additional operator intervention. Casual tuning + You can take a look at any received signal on the waterfall by +right-clicking and holding the mouse button on or near the signal. + The modem will begin to decode that signal if it is in the +currently selected mode. The text will be a unique color on the +Rx text widget so that you can discern the difference between casual +and normal tracking. Release the mouse button and the tracking +returns to the previously selected normal tracking point. +
+ +Audio History Fldigi maintains a history buffer of the received +audio. This buffer is approximately 2 minutes in duration. After tracking +commences on a signal you can decode the audio history for that signal. The +audio history is invoked by a Ctrl-Left click anywhere on the waterfall. You +can also invoke the audio history for the casual tuning mode by pressing +Ctrl-Right click on the waterfall. +
+ +The next control is your transceive audio frequency. In the display above +you can see that the audio signal is 1500 Hz. The red cursor is +centered beneath 14071.500 Mhz. The transceiver was set to 14070 Mhz. The +arrow key pairs move up/down in cycles and tens of cycles. You can +fine tune the receive point using this control. +
+ +The next two controls to the right of the audio frequency control are for the +receive signal processing. The one that reads -10 is the max signal +level for the waterfall/spectrum display. The one that reads 51 is for +the range over which that control will display signals. Both of these +are in dB. The default of -10 / 40 is a good starting point, but you +need to adjust these for band conditions. You can see the impact of +these controls most easily by putting the main display area in the +spectrum mode. Changes in these controls will effect the +waterfall instantly and for all past history displayed on the +waterfall. You do not have to wait for new signal data to observe +the affect. +
+ +The QSY button is very specific to transceivers interfaced with either +hamlib, rigcat or when fldigi is used with flrig. Each transceiver has a sweet +spot associated with its bandwidth controller. For the FT950 is 1500 when the +transceiver is set to PKT-U. As the transceivers bandwidth is changed the +changes occur centered at this frequency. Set the "Sweet spot" frequency +(Config / Misc / Sweet Spot) to 1500. Let's say that I just started copying a +rare dx at 1758 Hz and I wanted to put the signal at the sweet spot so I could +easily narrow the receiver bandwidth. Click on the signal on the waterfall. +Let the AFC capture and then press the QSY button. The tranceiver frequency +will be shifted and the fldigi audio tracking point shifted in unison such +that the signal is now at the receivers sweet spot. Very fast and very +convenient! The QSY button will be dimmed and not activated if you do not have +a method of transceiver control enabled for your transceiver. Right click on +the QSY button to undo the action. +
+ +This can also be achieved with the \ and \ macro tags. If you +combine these two with the \ command you can center the signal in +the passband and also narrow the transceiver passband, i.e. when used with the +FT950 +
+
    +
  • \\
    • +
  • \\
    • +
+ +The M\> button allows you to +store, recall and manage mode/frequency pairs. If you want to +save the current mode and frequency simply left click the button. + A right click will enable a popup menu from which you can select +a previously stored set. You can quickly move between modes and +audio sub carrier using this technique. A shift-left click will +clear the memory. When the popup menu is visible you left click +on an entry to select it. You can shift-left click on an entry to +delete that single entry. +
+ +The T/R button should be self-explanatory. It's your +transmit/receive button. Action is immediate, so if you were transmiting some +text and hit the button the PTT is disabled, the transmit text area cleared +and the program returned to receive mode. The T/R button is a +"lighted button" that shows when transmitting. All other lighted buttons +show YELLOW when they are in the active state. +
+ +The Lck button locks the transmit audio frequency to its present +value. You can then continue to QSY around your transmit position. I have +used this to reply to a DX station that wanted a +500 Hz response. The DX +was at 690 Hz audio, and wanted a response at +500. I moved the display +cursor (or the audio frequency control) to 1190 Hz. Hit the Lck button +and then went back to 690 with the waterfall cursor. Now the program +is receiving on 690 Hz and transmitting on 1190 Hz. Caught him on the +first try. Use this button also as a Master Station +control. Not all rigs are equal in their VFO performance. Some +exhibit a shift between receive and transmit. If this occurs then the +stations find themselves chasing each other with every t/r exchange. + Locking your transmit frequency with this control will inhibit that +from happening. Be sure to disable the control when that qso is over or +you may forget and transmit over top of another qso! +
+ +If the "Lck" is enabled the TX frequency does not follow the AFC action +applied to the RX frequency. +
+ +For transceivers which are either hamlib or memmap enabled, if the "Qsy" +button is pressed BOTH the RX and TX frequencies are changed to synchronize +to where the RX was positioned. +
+ +Perhaps some numbers will help to make that a little clearer. +
+ + +"Lck" | Before "Qsy" |
| After "Qsy" |
+:----:|:---------------:|:---------------:|:---------------:|:---------------: +
| RX | TX | RX | TX +OFF | 1002 / 7071.002 | 1002 / 7071.002 | 1500 / 7071.002 | 1500 / 7071.002 +ON | 1002 / 7071.002 | 1000 / 7071.000 | 1500 / 7071.002 | 1500 / 7071.002 +ON | 1000 / 7071.000 | 1800 / 7071.800 | 1500 / 7071.000 | 1500 / 7071.000 + +
+ +With "Lk" off the TX audio frequency is always synchronized with the +RX frequency. +
+ +With "Lk" on the TX audio frequency is fixed with respect to the RX +frequency UNLESS the "Qsy" button is pressed in which case it shifts to +the RX frequency, the Transceiver VFO is shifted and both the RX and TX +audio frequencies are shifted to put both into the middle of the +transceiver passband. The TX continues to be locked, but at the new +audio frequency. +
+ +If the "Lk" is ON moving the cursor around will ONLY AFFECT the RX +frequency and NOT the TX frequency. +
+ + +\image html sql_kpsql_level_control.png "SQL/KPSQL Level Adjustment" +\image latex sql_kpsql_level_control.png "SQL/KPSQL Level Adjustment" width=1.5in +
+ +The AFC and SQL buttons enable or disable the respective +function in the software. The slider just above the AFC \& SQL controls +is the squelch level control. The bar indicator just above it is the +equivalent of received signal level and relates on a 1:1 basis with the +squelch level slider. The SQL button illuminates YELLOW when the SQL is +selected, but the signal is below the squelch level. It illuminates +GREEN when the the SQL is selected and the signal is above the squelch level. +
+ +The indicator just to the left of the AFC button is the overload +indicator. It will be GREEN if your audio drive to sound card is +satisfactory, YELLOW if the audio signal is marginally high and turn red +when it is in overload. Back down the mixer control or the audio pad from +the rig to computer. Fldigi will not perform well if the sound card is +over driven. You will see ghost signals on the waterfall and the modem +decoders will not work correctly. +
+ +\image html sql_kpsql_kiss_io_enabled.png "KISS IO enabled" +\image latex sql_kpsql_kiss_io_enabled.png "KISS IO enabled" width=3.4in +
+ +\image html sql_kpsql_kiss_io_disabled.png "ARQ IO enabled" +\image latex sql_kpsql_kiss_io_disabled.png "ARQ IO enabled" width=3.4in +
+ +KPSQL squelch operates on the power aspect of a signal unlike SQL which +measures the reception quality of the signal. For KPSQL to operate correctly +the waterfall speed setting must set to either NORM or FAST, FAST being +the better option. The level setting slider is active for KPSQL when the +KPSQL button is enabled (indicated by either a yellow or green square on the +button surface). When disabled the slider adjustment effects SQL. KPSQL +operates using two different threshold detection methods. With +KPSQL button selected the user sets the threshold using the slider to the +right of the vertical level indicator. With KPSQL deselected the detection +level reverts to the histogram method. This method automatically adjust +the threshold to just above the noise level and is used when the utmost +signal sensitivity is desired. + +SQL and KPSQL functional differences: +
+SQL - Inhibits character reception.
+KPSQL - Inhibits the data transfer to the modem modulator.
+ +Receive audio level should be adjusted so that the overload indicator does +not illuminate red. When observing the received signals on the oscilloscope +view you should expect that they do not exceed a peak-to-peak amplitude of +3/4 of the full display height. +
+ +\section mode_status_indicators Mode Status Indicators + +The lower left corner of the main display (MFSK-16) in the view above is +actually a button disquised as a status panel. This button +responds to the mouse in several ways: +
+ +
    +
  • Left Click - opens a quick pick list of associated modem types; you can + switch to a new modem type from this popup menu
    • +
  • Right Click - opens the configuration dialog at the tab associated with + the current modem type
    • +
  • Scroll Wheel - rotates forward and backwards through the various modem + types in accordance with the modem menu heirarchy. Stop at the one you + want and you are now in that mode
    • +
+ +The next status indicator to the right provides information relative to the +current modem, for PSK it indicates the received signal strength in dB. +
+ +The third status indicator from the left provides additional information +relative to the current modem, IMD for PSK measured in dB. +
+ +Note that for PSK these values are only measured during periods when the +PSK idle signal is being received. +
+ +\section transmit_level_attenuator Transmit level attenuator +
+ +\image html TX-level.png "TX level" +\image latex TX-level.png "TX level" width=2.5in +
+ +It is often difficult to adjust the audio drive for the point where ALC +is just barely active. Mixer controls are OK, but not usually +designed for very small changes. They are after all designed for +adjusting listening levels. fldigi provides the ability to +control the audio drive in increments of 0.1 dB over a 30 dB +range. This control is located in the bottom right corner of the main dialog: +
+ +Set this control for -6 dB and then adjust the sound card mixer control +for the best ALC level you can achieve. Then adjust the Tx-level +control for best "just visible" ALC on the transceiver. That +should give you a very clean PSK signal. +
+ +\section operating_split Operating split with fldigi / flrig +
+ +\image html tty-split-ops.png "TTY Split Ops" +\image latex tty-split-ops.png "TTY Split Ops" width=4.5in +
+ +Note: In the above example most features are disable as they are not +available for the indicated radio. + + +On flrig: + +Unless specifically supported by the transceiver and implemented in flrig. + +
    +
  • VFO A is always the RX frequency.
    • +
  • VFO B is always the TX frequency.
    • +
  • Left Click on the A/B swaps A & B VFO frequencies.
    • +
  • Right Click on the A/B assignes A VFO frequency to B VFO.
    • +
  • Using the mouse wheel adjust VFO B to where you want to transmit.
    • +
  • Click the SPLIT button, it will change color when it is active.
    • +
  • Press the VFO B button to listen on the Tx frequency, + be sure to press Split again before capturing that rare DX station.
    • +
+ +On fldigi: + +
    +
  • Tune the waterfall cursor to the Rx signal
    • +
  • Transmit as usual, be sure you are not doubling.
    • +
+ +See FLRIG Help for +specific operating procedures. + +Some additional information can also be found here +\ref rig_control_page "Rig Control Page" + +
+\ref operating_controls_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/PseudoFSK.txt b/fldigi_doxygen/user_src_docs/PseudoFSK.txt new file mode 100644 index 00000000..618f3b7d --- /dev/null +++ b/fldigi_doxygen/user_src_docs/PseudoFSK.txt @@ -0,0 +1,63 @@ +/** +\page pseudo_fsk_page Pseudo FSK + +\tableofcontents + +
+ + +Using the FLdigi Pseudo FSK (Rt. Channel) function to key a transmitter +
+ +\image html config-rtty-tx.png "RTTY TX Configure" +\image latex config-rtty-tx.png "RTTY TX Configure" width=5.0in +
+ +Select the PseudoFSK check boxes. +
+ +FLdigi is now ready to generate a 1000 hertz tone burst signal on the +right channel of the stereo audio out of your sound card. +
+ +This tone burst is on when the RTTY bit is on and off when the RTTY bit is +off. The left channel will be the normal AFSK signal. +
+ +The following circuit may be used to take the FLdigi PSEUDO-FSK signal from +the right channel of your SOUND CARD to key your transmitter's FSK +input line. You may find it necessary to invert the sense of the keying +signal. +
+ +\image html CWkeyingCircuit.png "CW Keying Circuit" +\image latex CWkeyingCircuit.png "CW Keying Circuit" width=6.0in +
+ +NOTE: + +L1 - Radio Shack has two items that may be used for this isolation +transformer. + +Catalog # 270-054, and Catalog # 273-1374 + +Attach an audio cable from the Rt. Channel out of the your computer's +SOUND CARD to the input of this FSK INTERFACE CIRCUIT (input of L1). +
+ +Attach another cable from the output of this circuit to your +Rig's Keying FSK Jack. +
+ +Every PSEUDO-FSK tone that is generated by FLdigi is rectified by this FULL +WAVE VOLTAGE DOUBLER circuit. The resultant voltage turns the Q1 transistor +on and "grounds" the collector. + + +
+\ref pseudo_fsk_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/PskViewer.txt b/fldigi_doxygen/user_src_docs/PskViewer.txt new file mode 100644 index 00000000..2e05b9dc --- /dev/null +++ b/fldigi_doxygen/user_src_docs/PskViewer.txt @@ -0,0 +1,122 @@ +/** +\page signal_browser_page Signal Browser + +\tableofcontents + +
+ +PSK and RTTY signals can be viewed in a multi-channel context. +You can open an embedded or a separate dialog to access the +browser. These browsers can help to locate a signal of interest +on a busy band. The browsers can be visible at any time, but are only +active when fldigi is in one of the PSK or RTTY modes. Open the external +by clicking on the View/Signal browser menu item. +
+ +\image html view-menu.png "View Menu" +\image latex view-menu.png "View Menu" width=2.0in +
+ +It looks like this: +
+ +\image html browser-panel.png "Browser Panel" +\image latex browser-panel.png "Browser Panel" width=4.25in +
+ +Toggle the visibility of the embedded viewer by selecting the +View/Hide Channels on the same menu list. Your main fldigi +screen then opens a browser panel on the left side of the Tx/Rx panel(s). +
+ +\image html main-dialog-browser.png "Main Dialog Browser" +\image latex main-dialog-browser.png "Main Dialog Browser" width=6.0in +
+ +This panel can be resized horizontally by dragging the interface between the +browser and the Rx panel to the left and right. You can drag all the way to +the left to close the panel (or use the menu button). The drag to the +right is limited to prevent sizing the Rx/Tx panels below their allowable +limits. +
+ +The browser can decode up to 30 simultaneous signals. As each signal is +acquired within a 100 Hz channel width it is printed on the associated +line. The user can elect to have each line annotated with +
+ +a channel number,
+the waterfall audio frequency,
+the transceiver HF frequency + waterfall, or
+no annotation.
+
+ +Left click on a line of received text to move the waterfall frequency +and Rx panel tracking to that signal. The contents of the line of +text is transferred to the Rx text widget, and the main signal processing loop +begins to track and decode that signal. Right click on a line of received +text and that line is cleared and the channel reset for a new +detection. You may have to do this occasionally if the detector +for that channel has locked on to a sideband of a PSK signal. +This is most likely to occur when the received signal as a marginal or +bad IMD. Use the >Clear button to clear and reset all of the +channels. Channel signal detection and processing should restart +immediately. +
+ +Configuring the browser: +
+ +\image html config-ui-browser.png "Browser Configure" +\image latex config-ui-browser.png "Browser Configure" width=5.0in +
+ +
    +
  1. select the number of 100 Hz channels you want visible
    2. +
  2. select the start frequency for the browser (your transceiver may not + rx signals below this value)
    3. +
  3. select the inactivity timeout for the browser. After this + number of seconds the channel will be cleared and prepared for the next + detection cycle.
    4. +
  4. select whether you want a Marque type of continuous scrolling, or simply + clear the line when it is filled.
    5. +
  5. select what kind of label annotation you want on each line
    6. +
  6. select the font and font size to be used in the browser
    7. +
  7. You can enter any text you want to search for in the Seek + Regular Expression widget. +
    + This text can be a simple text snippet such as "CQ" or any + regular expression. With a regex you can specify a more generic pattern, + which means that you can match more things and your search is somewhat noise + tolerant. Here is an example for a CQ from a US station (should match most + callsigns): +
    +
    + cq.+[aknw][a-z]?[0-9][a-pr-z][a-z]{1,2} +
    +
    + This says "cq followed by at least one character, followed by one A, + K, N, or W, followed by an optional letter, followed by a digit, + followed by a letter that is not q, followed by one or two letters". + The search is case-insensitive. +
    + All plain text is a valid regular expression, unless you really had been + looking for these metacharacters: +
    +
    + .[{()\*+?|^$ +
    +
    + These will have to be escaped with a backslash.
    8. +
+ +
+
+\ref signal_browser_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + + + diff --git a/fldigi_doxygen/user_src_docs/RST-RSQ.txt b/fldigi_doxygen/user_src_docs/RST-RSQ.txt new file mode 100644 index 00000000..de8a1f87 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/RST-RSQ.txt @@ -0,0 +1,105 @@ +/** +\page rst_rsq_page RST and RSQ Reporting + +\tableofcontents + + +\section rst RST + +Is the traditional Readability, Strength, Tone reporting system used for +CW operations for nearly as long as amateurs have enjoyed the airwaves. +
+ +\subsection rst_readability READABILITY + +
    +
  1. Unreadable
    2. +
  2. Barely readable, occasional words distinguishable
    3. +
  3. Readable with considerable difficulty
    4. +
  4. Readable with practically no difficulty
    5. +
  5. Perfectly readable (that is 100% print in todays jargon)
    6. +
+ +\subsection rst_signal_strength SIGNAL STRENGTH + +
    +
  1. Faint signals, barely perceptible
    2. +
  2. Very weak signals
    3. +
  3. Weak signals
    4. +
  4. Fair signals
    5. +
  5. Fairly good signals
    6. +
  6. Good signals
    7. +
  7. Moderately strong signals
    8. +
  8. Strong signals
    9. +
  9. Extremely strong signals
    10. +
+ +\subsection rst_tone TONE + +
    +
  1. Sixty cycle AC or less, very rough and broad
    2. +
  2. Very rough AC, very harsh and broad
    3. +
  3. Rough AC tone, rectified but not filtered
    4. +
  4. Rough note, some trace of filtering
    5. +
  5. Filtered rectified ac, but strongly ripple modulated
    6. +
  6. Filtered tone, definite trace of ripple modulation
    7. +
  7. Near pure tone, trace of ripple modulation
    8. +
  8. Near perfect tone, slight trac of modulation
    9. +
  9. Perfect tone, no trace of ripple, or modulation of any kind
    10. +
+ +\section rsq RSQ + + +Give the report as RSQ for digital modes, but especially BPSK and QPSK; see: + +http://www.psb-info.net/RSQ-Reporting-Table.html +
+ + +\subsection rsq_readability READABILITY + +
    +
  1. 0% undecipherable
    2. +
  2. 20% occasional words distinguishable
    3. +
  3. 40% considerable difficulty, many missed characters
    4. +
  4. 80% practically no difficulty, occasional missed characters
    5. +
  5. 95%+ perfectly readable
    6. +
+ +\subsection rsq_strength STRENGTH + +
    +
  1. Barely perciptible trace
    2. +
  2. n/a
    3. +
  3. Weak trace
    4. +
  4. n/a
    5. +
  5. Moderate trace
    6. +
  6. n/a
    7. +
  7. Strong trace
    8. +
  8. n/a
    9. +
  9. Very strong trace
    10. +
+ +\subsection rsq_quality QUALITY + +
    +
  1. Splatter over much of the visible waterfall
    2. +
  2. n/a
    3. +
  3. Multiple visible pairs
    4. +
  4. n/a
    5. +
  5. One easily visible pair
    6. +
  6. n/a
    7. +
  7. One barely visible pair
    8. +
  8. n/a
    9. +
  9. Clean signal - no visible unwanted sidebar pairs
    10. +
+ + + +
+\ref rst_rsq_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/RTTYFSK.txt b/fldigi_doxygen/user_src_docs/RTTYFSK.txt new file mode 100644 index 00000000..1f350703 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/RTTYFSK.txt @@ -0,0 +1,258 @@ +/** +\page rtty_page RTTY + +\tableofcontents + +The RTTY modulator and demodulator have been extensively changed with +version 3.21.67. The new design was a cooperative effort of +Stefan, DO2SMF, and Dave, W1HKJ with extensive testing performed by Ed, +W3NR, and Dick, AA5VU. Chen, W7AY, was a silent contributor to +the design by virtue of his excellent technical papers on RTTY +modulation and demodulation, which he so generously placed in the +public domain. +
+ +fldigi can operate on a wide range of RTTY symbol rates and bandwidths. The +selection of symbol rate and bandwidth is made on +the \ref rtty_fsk_configuration_page "RTTY configuration tab". The three most +common in amateur radio use can be selected from the mode menu. These are +
+ +
+ +Mode | Symbol Rate | Typing Speed | Bandwidth +:------:|:-----------:|:------------------:|:----------: +RTTY 45 | 45.45 baud | 6.0 cps (60 wpm) | 270 Hz +RTTY 50 | 50.0 baud | 6.6 cps (66 wpm) | 280 Hz +RTTY 75 | 75.0 baud | 10.0 cps (100 wpm) | 370 Hz + +
+
+ +These modes were a result of mechanical and electrical +designs of the early TTY machines. The 45.45 baud and 75 baud +machines were for the US / Canadian market and used 60 Hz +synchronous motors. The 50 baud machines were for the European +market and used 50 Hz synchronous motors. +
+
+ +fldigi can encode and decode many other symbol rates and bandwidths. "Custom" +combinations are set up on the RTTY configuration tab. You +probably will never have to do that unless you like experimenting with +unusual RTTY modes. +
+ +\section rtty_modulator RTTY modulator + + +All of the modem signals that fldigi produces are audio signals. That +includes the RTTY signal. fldigi can encode and decode an RTTY signal +that is anywhere within the passband of the sideband transceiver. It is +not limited to the traditional tone pairs around 2100 Hz. Each of +the generated Mark / Space signals are on-off-keyed (OOK), bandwidth +limited signals. The resultant waveform is not an FM type signal +of constant amplitude. Therefore the transmit audio and RF +amplifiers must be linear, just like the requirement for PSK signals. +There are performance gains using this approach. The principal being a +reduction in inter symbol interference which gives much improved +performance by the receiver. The waterfall, time domain, and +spectrum signatures of the transmitted signal look like this: +
+ +\image html w1aw-rtty-80.png "W1AW on air signal" +\image latex w1aw-rtty-80.png "W1AW on air signal" width=3.5in +
+ +\image html rtty-transmit.png "AFSK signal " +\image latex rtty-transmit.png "AFSK signal " width=3.5in +
+ +\image html rtty-spectrum.png "Spectrum" +\image latex rtty-spectrum.png "Spectrum" width=1.5in +
+ + + + +You must operate your transceiver in the USB +mode for the fldigi RTTY signal to be the correct polarity. If your +transceiver is set to LSB then use the fldigi "Rev" button to reverse +the sense of the mark and space signals. +
+ +You must maintain transmitter LINEARITY in the AUDIO AMPLIFIERs. +Do not think that you can improve performance by over driving the audio +input. A good operating procedure for most transceivers is the +set the audio level to the level for which there is just barely a hint +of ALC. Then reduce the input to 80% of that power level. +Over driving an AFSK signal is as disastrous as over driving a PSK +signal. This is an actual on air signal that was being over +driven (but not on purpose): +
+ + +\image html rtty_overdrive.png "Overdriven RTTY Signal" +\image latex rtty_overdrive.png "Overdriven RTTY Signal" width=6.0in +
+ + +Joe also performed a series of tests on an Icom 706 mkIIg transceiver. The +results of those tests are very enlightening. +
+ +"Two views - the 2 KHz span and a 10 KHz span. The 10 KHz span +shows the one failing of the IC-706mkIIg and other rigs with analog +modulation - opposite sideband and carrier leakage. This one +isn't too bad but one can see carrier at -50 dBc and opposite sideband +at -55 dBc +/-. I do use a high audio frequency to minimize +harmonic issues. +
+ +For fun I've attached versions at 70 W in 10K, 5K, and 2K spans. The narrow +spans clearly show the benefits of reducing the audio until output power +drops 1.5 dB. +
+ +Audio was connected to the IC-706mkIIg via the "DATA" jack rather +than the mic connector or "Mod In" pin of the ACC jack. Using this +input avoids several potential problems - including the constant +swapping between mic and digital connections and remembering to turn off the +compressor when switching to digital operation. The "Data" input is +also 6 dB less sensitive than "Mod in" making it that much less likely +that one will significantly over drive the the transceiver and create +distortion in the audio stages ahead of the modulator". +
+ + +The green area is 400 Hz wide. + +
+ +\image html Icom_FSK.png "Image A" +\image latex Icom_FSK.png "Image A" width=4.0in + +
+ +Transceiver operated in FSK mode
+Power: 100 W
+ +
+ +\image html fldigi_Icom_AFSK.png "Image B" +\image latex fldigi_Icom_AFSK.png "Image B" width=4.0in + +
+ +Transceiver in USB, fldigi AFSK audio drive
+Space at 2125, Mark at 2295 Hz
+Power: 100 Watts, ALC just extinguished
+ +
+ +\image html fldigi_Icom_AFSK-1dB.png "Image C" +\image latex fldigi_Icom_AFSK-1dB.png "Image C" width=4.0in + +
+ +Transceiver in USB, fldigi AFSK audio drive
+Space at 2125, Mark at 2295 Hz
+Power: reduced to 80 Watts (-1 dB)
+ +
+ +\image html fldigi_Icom_AFSK-1r5dB.png "Image D - 2 K span" +\image latex fldigi_Icom_AFSK-1r5dB.png "Image D - 2 K span" width=4.0in + +
+ +Transceiver in USB, fldigi AFSK audio drive
+Space at 2125, Mark at 2295 Hz
+Power: reduced to 70 Watts (-1.5 dB) + +
+ +\image html fldigi_70W_1000Hz.png "Image F - 10 K span" +\image latex fldigi_70W_1000Hz.png "Image F - 10 K span" width=4.0in + +
+ +Transceiver in USB, fldigi AFSK audio drive
+Space at 830 Hz, Mark at 1000 Hz
+Power: 70 Watts. The LSB leakage is clearly
+seen at approximately -55 dB
+ +
+ +\image html fldigi_70W_1000Hz_5K.png "Image G - 5 K span" +\image latex fldigi_70W_1000Hz_5K.png "Image G - 5 K span" width=4.0in + +
+ +Transceiver in USB, fldigi AFSK audio drive
+Space at 830 Hz, Mark at 1000 Hz
+Power: 70 Watts. The LSB leakage is clearly
+seen at approximately -55 dB.
+ +
+ +\image html fldigi_70W_2stop.png "Image H - 2 K span" +\image latex fldigi_70W_2stop.png "Image H - 2 K span" width=4.0in + +
+ +Transceiver in USB, fldigi AFSK audio drive
+Space at 830 Hz, Mark at 1000 Hz
+Stop Bits set to 2 vice 1.5
+Power: 70 Watts. Compare this to image D
+
+ +\section rtty_demodulator RTTY demodulator + +Fldigi's demodulator uses a design based on theoretical work published by +Kok Chen, W7AY, + +http://www.w7ay.net/site/Technical/ATC/. +
+ + +\image html RTTY-demodulator.png "Demodulator" +\image latex RTTY-demodulator.png "Demodulator" width=5.0in +
+ +The mark and space signals are +converted to base band and then filtered in a low pass filter. +Each filter is a variant of Chen's enhanced Nyquist filter. It is +implemented using a Fast Overlap-and-Add Fourier Transform. +
+ +Each time the baud rate is selected the program must "rebuild" the +digital RTTY filter. The filter parameters are optimized for the +baud rate. +
+ +The detector is an optimized Automatic Threshold Correcting (ATC) type +described in Chen's paper. +
+ +To start decoding a signal simply left click on the signal and the AFC should +lock on to the signal. +
+ +The digiscope display will extinguish when the Rx signal level falls below +the squelch setting. +
+ +It is possible to use fldigi to generate the keying waveform for use with an +FSK type of transmitter. See \ref pseudo_fsk_page "Pseudo FSK for a +description of how this can be accomplished. +
+ +See \ref rtty_fsk_configuration_page "RTTY Configuration Page" + +
+\ref rtty_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/Recognitions.txt b/fldigi_doxygen/user_src_docs/Recognitions.txt new file mode 100644 index 00000000..8d62b6e8 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Recognitions.txt @@ -0,0 +1,146 @@ +/** +\page recognitions_page Recognitions + +\tableofcontents + +This software would not have been possible without the contribution of many +programmers who have given their best to the open source community. The +application is built upon the foundation of the Fast Light Tool +Kit (http://www.fltk.org), a wonderfully fast and efficient graphical user +interface design library. Many have asked what the Fast Light means. There +are probably as many answers as there are programmers using the toolkit. I +prefer to think of it as lightning fast and light on the code size. Take a +look at the size of the executable for fldigi and then compare it with +similar applications. I think you will be surprised by how small it is for +what it does. +
+ +The active current development team consists of: +
+ +
    +
  • Dave Freese - W1HKJ
    • +
  • Stelios Bounanos - M0GLD
    • +
  • Remi Chateauneu - F4ECW
    • +
  • Leigh Klotz - WA5ZNU
    • +
  • Stéphane Fillod - F8CFE
    • +
  • John Douyere - VK2ETA
    • +
  • Joe Veldhuis - N8FQ
    • +
  • Chris Sylvain - KB3CS
    • +
  • Gary Robinson - WB8ROL
    • +
  • Stefan Fendt - DO2SMF
    • +
  • John Phelps - KL4YFD
    • +
  • Andrej Lajovic - S57LN
    • +
  • Robert Stiles - KK5VD
    • +
+ +Localization files: +
+
+   Español    Spanish   Pavel Milanes Costa CO7WT
+                        Christian W. Correa HK4QWC
+   Deutsch    German    Marc Richter        DF2MR
+   Français   French    Stéphane Fillod     F8CFE
+   Italiano   Italian   Pierfrancesco Caci  IK5PVX
+   Język      Polish    Roman Bagiński      SP4JEU
+   Nederlands Dutch     Peter van der Post  PA1POS
+
+
+ +Several authors have placed their digital modem code and signal +processing code in the public domain and their source was either an +inspiration or in some cases formed the backbone of the code used +in Fldigi. +
+ +
    +
  • AE4JY - WinPsk - a windows application
    • +
  • Tomi Manninen, OH2BNS - gmfsk - a great digital modem program for Linux
    • +
  • Hamish Moffatt, VK3SB - dominoEX code originally for gmfsk
    • +
  • Dr. Steven W. Smith - author of "Digital Signal Processing", who + has kindly placed an entire book on digital signal processing on the + internet. (http://www.dspguide.com)
    • +
+
+ +If you make a side-by-side comparison between gmfsk and fldigi source code +you will see that they follow the same general structure. The primary +difference is that gmfsk is written in the C language and uses the gnome/gtk +libraries for the user interface. Fldigi is a C++ application that +uses the Fast Light Tool Kit (Fltk) gui library. The design +of Fldigi puts emphasis on separating the user interface from the +sound card and transceiver input/output operations. Nearly all modern +digital modem programs use a programming paradigm called "threads." Threads +are light weight processes that share the same memory space, but each has +its own stack. The use of threads makes the program look and feel +responsive to the user while a lot of code is being executed in the +background. +
+ +Many of the modem source code files are C to C++ rewrites from the +gmfsk application. They say that copying is the best form of +flattery and gmfsk simply had the best explanations and the easiest +source code to read and understand. The author had also spent +several months creating improvements and fixing bugs in the original +gmfsk application. That exercise was the impetus to create Fldigi. +
+ +The Fast Fourier Transform used by Fldigi is a rewrite of John Green's +public domain FFT code (FFT for RISC for MAC). +The rewrite is in C++ and is implemented as a C++ template. +Some of the signal processing algorithms used in Fldigi +are from Dr. Smith's book. His on-line publication is sufficient +to allow you to become fluent in FFT analysis and the creation of +digital filters. I printed the relevant pdf files and then +purchased the hard bound copy. Improvements to the original gmfsk +signal processing algorithms can all be attributed to this excellent +source. +
+ +And last but certainly not least, I must thank the crew who perform +alpha testing and on-line support of the application. These are stalwart amateurs who +risk their operating system and radio equipment in testing, testing and +more testing. Their only reward is in being able to influence the +design of the application and the fun of seeing it work and the bugs +disappear. Thank you to: +
+ +Call Name | Call Name | Call Name | Call Name +:-------------:|:-------------:|:---------------:|:---------------: +4Z5ST Boris | K3GAU David | KU1T Zibi | VA3DB Dianne +AA0HW Chuck | K4XTT Victor | KV9U Rick | VE3IXI Dave +AC7JN Dave | K6KAR Kirk | N0NB Nate | VK2TMG Brett +CT1DRB David | K7BRK Chris | N2AMG Rick | VK4BDJ David +CX7BF Walter | K4RE Brian | N4UM Tim | W3NR Ed +DF4OR Ekki | K9AO Rick | N4ZNV Mike | W4ROS Ross +DK1JBE Tom | KB3FN Lynn | N6WFL Jason | W6JVE Jim +DL6XAZ Fred | KD0AR Mike | N8FQ Joe | WA3VPZ Marshal +DL8FCL Walter | KD4O Phil | NN8B Don | WA4SXZ Rich +G0UZP Paul | KD8DKT Mike | NT1G Skip | WB8ROL Gary +G3TDJ Andy | KE3Y Travis | OZ4KK Erik | WD4FDW Steve +G6CKR Roger | KH6TY Skip | PA0R Rein | WD4FNY Bill +G8SQH David | KL7NA Rob | PA3GWH Richard | WU9Q Bob + +
+and many others whose names are not listed, please accept my apology. +
+ +The test team is representative of users on Windows, Linux, Free +BSD and OS X operating systems. They have varying interests from +very slow speed CW to high speed keyboard full break-in CW, from RTTY +contesters to PSK rag chewers. They have insisted that +fldigi perform well under all of those operations. I have been +amazed by the global distribution of the testing team. It is easy +to think that the internet will be the death of amateur radio. On +the contrary it opens up so many additional ways for us to be +cooperative. +
+ + + +
+\ref recognitions_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/SignalViewers.txt b/fldigi_doxygen/user_src_docs/SignalViewers.txt new file mode 100644 index 00000000..10840dad --- /dev/null +++ b/fldigi_doxygen/user_src_docs/SignalViewers.txt @@ -0,0 +1,27 @@ + + + + +Signal Viewers + + + + + + + + + + + + + +
+ +
+
+ +
+
+ + diff --git a/fldigi_doxygen/user_src_docs/SoundCardSetup.txt b/fldigi_doxygen/user_src_docs/SoundCardSetup.txt new file mode 100644 index 00000000..93a7fc64 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/SoundCardSetup.txt @@ -0,0 +1,307 @@ +/** +\page sound_card_configuration_page Sound Card Configuration + +\tableofcontents + +A few words about sound I/O on the PC. "You are in a maze of +twisty little passages, all alike". +
+ +PortAudio, PulseAudio and OSS are different ways in which fldigi can +access your sound card through the various sound systems. +
+ +OSS was the first audio backend in fldigi. It works with the Linux sound +system of the same name, which has now been replaced by ALSA but is +still supported via an emulation layer. Its only advantage, as an +audio backend, is that it's simple and doesn't require any +external libraries. + +
+The PortAudio backend was written subsequently to support +OSS on Linux and FreeBSD, +ALSA and +JACK on Linux, CoreAudio on OS X, +and also the various sound APIs on Windows -- all through the same +PortAudio library. +
+ +PulseAudio is more than an +audio hardware access layer; refer to its website for a +summary of what it does. Fldigi supports it mainly because many Linux +distributions are now integrating it with their desktops, but also +because it has a few interesting features: + +
    +
  • it can take care of the resampling and volume control for us,
    • +
  • it can stream audio over the network, and
    • +
  • it makes it easier to run multiple fldigi instances (all + accessing the same sound card).
    • +
  • it provides mixer controls for input and output audio streams
    • +
  • it remembers which hardware is used for each application it + serves, and it remembers the mixer levels associated with that + application
    • +
+ +In the future it might be possible to replace all of these with a single +backend, without any loss of functionality, performance, sound system +or platform support. That'll be the day! Until then: +
+ +\image html config-audio-devices.png "Audio Devices" +\image latex config-audio-devices.png "Audio Devices" width=5.0in +
+ +On Linux: + +
    +
  • Use PulseAudio if your Linux distro ships it, and you already have the + pulseaudio daemon running (this is the case with Fedora 8/9 and Ubuntu + 8.04, probably also with openSUSE 11.0). Or if you want networked + audio, etc. etc.
    • +
  • Otherwise, use PortAudio and select a device + from the list(s). PortAudio is also the best way to access JACK, + through which you can use other programs as audio sources/sinks -- + particularly useful with SDR software. As with PulseAudio, you can + select different capture and playback audio devices.
    • +
  • The OSS backend should be used only as a last resort. Note that it + has not been updated to support user-configurable sample rates.
    • +
+ +On Windows: + +Use the PortAudio and select the device from the list(s). + +Select the SndCrd tab on the configuration dialog. +
+ +On Linux Fldigi can interface to the sound card using either the OSS, +the Portaudio, or the PulseAudio. Each of the appropriate +libraries must be present on the computer to use that particular sound +i/o. +
+ +On Windows Fldigi uses the Portaudio sound driver only. +
+ +It is also possible to configure Fldigi with File I/O only, which is +useful for testing the application without an interface to the sound +card. In the File I/O only configuration you can record and +playback audio files in a number of different formats including the +"wav" format associated with the Windows operating system. +
+ +The program will find all active sound cards and the associated drivers +for both. Select the sound card and driver type that will be used with the +program. I recommend using the Pulseudio device driver if that +is available on your Linux distribution. +
+ +\image html config-audio-settings.png "Config Audio Settings" +\image latex config-audio-settings.png "Config Audio Settings" width=5.0in +
+ +If Pulse or Port audio is selected then you can either allow the program to +use the auto detect to determine the best sound card sampling rate, or +you can pick from the drop down list. If you know your RX and TX sound card +oscillator correction factors you can enter them now. If not you can +determine the RX rate correction using a special WWV modem built +into Fldigi. The decoder and encoder logic for each of the various +modems require a specific sound card sample rate which may not be the the +actual sound card sample rate. The conversion between the modem sample rate +and the sound card sample rate is accomplished by one of a set of +sample rate converters. +
+ +Sound card oscillators may have a slight error in frequency that causes their +sampling rate to not be the value specified. This error is usually small +enough to be measured in a parts per million. Fldigi uses a technique called +rate conversion to correct the sampled waveform for this error. The error +can be measured and the correction factor determined by using +the \ref digiscope_display_wwv_mode "WWV calibration" +modem. The supporting library used for the converter provides +several different levels of conversion, Best, Medium, Fastest and Linear +Interpolator. The default, Medium interpolator, will be +satisfactory for most sound cards. If you +are running fldigi on a computer with limited cpu power you might find +it necessary to select one of the more cpu efficient converters, either +Fastest or Linear. Each gives progressively poorer performance +but use fewer cpu cycles to perform the frequency conversion. You +should also be sure that the cpu type is set to +\ref miscellaneous_configuration_page "Slow cpu" on the miscellaneous +configuration tab. +
+ +\image html config-audio-mixer.png "Audio Mixer" +\image latex config-audio-mixer.png "Audio Mixer" width=5.0in +
+ +Mixer controls are only active on Linux using OSS, ALSA backends and if the +distribution provides application layer mixer support. Select whether you +will be using Line-In or Mic-In for the audio connection from the receiver +output. Fldigi ALWAYS expects to use the Line-Out for driving the +transmitter audio. Set the PCM level for your sound card. If you check +"Manage mixer" then the Tx and Rx "volume" controls on the main fldigi +dialog will be active. +
+ +\section right_chanel_audio Right Channel Audio Output + +\image html config-audio-right.png "Right Audio Channel" +\image latex config-audio-right.png "Right Audio Channel" width=5.0in +
+ +You may elect to make the right and left channels both contain the +modem signal. Or, you may reverse the right and left channel +audio signals. These two controls only change the function of the +audio output. +
+ + +\image html stereo-plug.png "Stereo Plug" +\image latex stereo-plug.png "Stereo Plug" width=3.0in +
+ +
    +
  1. Sleeve: usually ground
    2. +
  2. Ring: Right-hand channel for stereo signals, negative polarity for + balanced mono signals. Fldigi uses this channel for special + controls signals.
    3. +
  3. Tip: Left-hand channel for stereo signals, positive polarity for + balanced mono signals. Fldigi uses this channel for Rx and Tx + audio.
    4. +
+ +
+ +The PTT, CW QSK and Pseudo-FSK items are found on their respective +configuration tabs. They are replicated here for your convenience +and these controls may be changed on this or the other tabs. +
+ +\section wav_file_sample_rate WAV File Sample Rate + +\image html SavedWAVFileSampleRate.png "Sample Rate of Saved WAV Files" +\image latex SavedWAVFileSampleRate.png "Sample Rate of Saved WAV Files" width=2.0in +
+ +User selectable WAV file sample rate. +
+ +\section multiple_sound_cards Multiple sound cards + +In systems with multiple sound cards they will not always be in the +correct sort order on boot. This may cause problems not only with +fldigi, but other apps that depend on a certain sound card. The +work around is not that difficult and will reliably place the preferred +sound card in the correct slot. Sound cards are numbered from 0 on to +however many cards you have in your computer. Usually its only 2. +
+ +The 1st step is to determine the correct id of the cards in your +system. Open a terminal and issue the following :: aplay -l +
+ +Here is an example of what you may see.
+
+ +\verbatim + +**** List of PLAYBACK Hardware Devices **** +card 0: ICH6 [Intel ICH6], device 0: Intel ICH [Intel ICH6] + Subdevices: 1/1 + Subdevice #0: subdevice #0 +card 0: ICH6 [Intel ICH6], device 4: Intel ICH - IEC958 [Intel ICH6 - +IEC958] + Subdevices: 1/1 + Subdevice #0: subdevice #0 +card 1: AudioPCI [Ensoniq AudioPCI], device 0: ES1371/1 [ES1371 +DAC2/ADC] + Subdevices: 1/1 + Subdevice #0: subdevice #0 +card 1: AudioPCI [Ensoniq AudioPCI], device 1: ES1371/2 [ES1371 DAC1] + Subdevices: 1/1 + Subdevice #0: subdevice #0 + +\endverbatim + +If it does not already exist you will need to create the following file:
+
+ +/etc/modprobe.d/alsa-options +
+ +You will have to root privileges to create the file, so a system such +as Ubuntu that depends on sudo you would enter +
+ +$ sudo touch /etc/modprobe.d/alsa-options +
+ +Using the above example, you edit that file so that it's contents +contain +
+ +\# Set preferred order of the sound cards
+ + +options snd-ICH6 index=0
+options snd-AudioPCI index=1 +
+
+ +The simplest terminal editor that is on just about every distribution is
+"nano" so to edit the file you just created you can again use sudo
+
+ +$ sudo nano /etc/modprobe.d/alsa-options +
+ +If you want to test this new file, reboot and open a terminal and again +issue the command :: aplay -l +
+ +You will normally find that your internet browser and/or Flash want to +use card 0, so you then may want to consider using card 1 for fldigi +
+ +Here is another example with 3 sound systems; mother board ALC1200, a +thumb-drive audio codec, and a SignaLink USB: +
+ +\verbatim + +**** List of PLAYBACK Hardware Devices **** +card 0: NVidia [HDA NVidia], device 0: ALC1200 Analog [ALC1200 Analog] + Subdevices: 1/1 + Subdevice #0: subdevice #0 +card 1: Set [USB Headphone Set], device 0: USB Audio [USB Audio] + Subdevices: 1/1 + Subdevice #0: subdevice #0 +card 2: default [USB Audio CODEC ], device 0: USB Audio [USB Audio] + Subdevices: 1/1 + Subdevice #0: subdevice #0 +\endverbatim + +The /etc/modprobe.d/alsa-options contains these lines +
+ +\verbatim + +options snd-NVidia index=0 +options snd-Set index=1 +options snd-CODEC index=2 + +\endverbatim + +Notice that each line is uniquely related to the aplay -l report +
+ + +
+\ref sound_card_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/Spotter.txt b/fldigi_doxygen/user_src_docs/Spotter.txt new file mode 100644 index 00000000..024d9354 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Spotter.txt @@ -0,0 +1,149 @@ +/** +\page psk_reporter_page PSK Reporter + +\tableofcontents + +The PSK reporter can generate reception reports from three different sources: +
+ +
    +
  • The decoded text, obtained from the Rx Panel text or the multi-channel + browser. Note: the psk browser must be visible or + decoding and subsequent psk reporting will not occur. If you do + not want the psk browser panel visible in the main dialog then use the + separate browser dialog. It can be minimized and signal decoding + will continue.
    • +
  • The log data
    • +
  • Data entered manually
    • +
+ +The configuration for the PSK reporter in in Misc/Spotting. PSKR needs the +following fields from the Oper tab to be non-empty: +
+ +
    +
  1. Callsign (freeform because it's impossible to verify, and + because we need to support SWLs without callsigns)
    2. +
  2. Locator (standard 6 character format)
    3. +
  3. Antenna info (freeform, should be kept reasonably short)
    4. +
+ +Sources +(1) and (2) are configurable from Misc/Spotting configuration tab, +while (3) is always enabled. To keep the code sane, changing the PSKR +options (or the above station info) does not take immediate effect. +Instead, the Initialize button changes color to indicate that the +changes have not been applied. Clicking on the button will do so (or +display an error) for the current and future sessions. This is similar +to the Initialize buttons in the rig control configuration. +
+ +Here are the options in some more detail: +
+ +\section auto_spot_calls Automatically spot callsigns in decoded text + +The text that is sent to the main window or the PSK browser is continuously +searched for callsigns. If this option is enabled, the main window gets +a "Spot" light button that can toggle the auto-spotter on and off. It +is automatically turned off when playback is selected in the Files +menu. The main window text is not searched if the viewer is +active, i.e., if it is displayed and the current modem is PSK. +
+ +\section send_report_on_qso Send reception report when logging a QSO + +A reception report is queued for every QSO as soon as it's logged +
+ +\section report_qrg Report QRG (etc.) + +This makes the reception reports include the current rig frequency, adjusted +for modem audio frequency and rig sideband. It does not need a click on +"Initialize" to take effect. This needs to be an option because it is +impossible to tell whether the user has real or "fake" rig control with +100% certainty. Besides that, users may want to run a dedicated spotter +for a narrow modes sub-band, and in that case they won't have to +synchronise fldigi's frequency display with the rig all that often. +
+ +\section host_and_port Host and port + +With the port set to 14739 the reports will not be entered in the main +database, but instead will be analysed and displayed here: +
+ +http://pskreporter.info/cgi-bin/psk-analysis.pl +
+ +Probably of no interest to anyone who is not hacking on a PSKR client but +may be useful for debugging. The PSKR protocol uses UDP with no +acknowledgements or retransmissions, so don't be surprised if the +occasional report never makes it to the server. There should be +enough coverage overlap to make packet loss irrelevant (and save a lot +of bandwidth and CPU cycles). +
+ +The spotter needs to see a repeated callsign within a short search window, +but stations do not always repeat their callsigns. In addition, some +operators like to be creative with their macros, and as a result some +signals will decode 100% but the callsign will never be auto-captured. Such +callsigns can be reported manually. +
+ +The manual spotting is done by right-clicking the QRZ "globe" icon. This +will generate a report for whatever is in the Call & Loc fields, so make +sure that those are correct! You should also verify the frequency (e.g. by +placing the waterfall marker on the signal being spotted). +
+ +There is a confirmation popup that will open when you right click the "globe" +button. The aim of course is to avoid accidentally sending +rubbish reports to the PSK reporter database. +
+ +Reception reports are filtered for duplicates among all data sources: a +report is queued only once every hour for each callsign and frequency band. +The queue is flushed every five minutes. You can see what the spotter is +doing in the Event Log window or on the terminal if you set the log level to +"Info". "Debug" will show all the gory details. +
+ +\image html activity-reports.png "Activity Reports" +\image latex activity-reports.png "Activity Reports" width=1.74in +
+ +A button and popup text field on the rig control frame give access to +the most recent receptions reports in your geographic area.The area is +determined by the contents of the field to the right of the button, or +by the locator text on the operator tab if the mini field is empty. + The first two characters of the locator are used. If the +locator is not set, the pskreporter.info uses the current IP +geolocation to approximate it. +
+ +A popup is displayed when the user clicks the button or presses the Enter +key from within the field. The popup shows the frequencies by +measure of activity that gives more weight to transmissions. If +rig control is active, the user can click on one of the lines to go to +that band. Clicking on the 18100000 (1 report) line would +immediately QSY the transceiver to 18.1 MHz. +
+ +The data is retrieved from http://pskreporter.info/cgi-bin/psk-freq.pl +
+ +or with a filled text field, http://pskreporter.info/cgi-bin/psk-freq.pl?grid=TEXT +
+ +There is a link to the pskreporter.info map page in the Help menu. +
+ + +
+\ref psk_reporter_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/Synop.txt b/fldigi_doxygen/user_src_docs/Synop.txt new file mode 100644 index 00000000..f001242b --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Synop.txt @@ -0,0 +1,428 @@ +/** +\page synop_page SYNOP decoding + +\tableofcontents + + +\section what_is_snyop What is Synop + +\subsection wether_data Weather data + + +SYNOP, which stands for +surface synoptic observations is a numerical code used for +reporting weather +observations made by manned and automated fixed land weather stations. It +is also called FM-12 by the +
+ +World Meteorological Organization. It is closely associated to +FM 13-XIV SHIP, for report of surface observation from a sea station +(Created in 1982) and FM 14-XIV SYNOP MOBIL, for reports of surface +observation from a mobile land station. +
+ + +Here is an example of undecoded SYNOP weather report:
+ + +13586 31530 80000 10036 20029 39821 40218 53002 71022 886//
+333 20029 88715=
+ + +Many SYNOP reports are available on web sites such as +Ogimet . +
+ +\subsection synop_reports Synop reports broadcasts + +The most important broadcaster on SYNOP data is DWD, in RTTY mode. +
+ +\subsubsection deutsche_schedule Deutsche Wetterdienst schedule + +SYNOP reports are typically sent every six hours +by Deutscher Wetterdienst on shortwave and low frequency using RTTY. + +The baud rate must be 50 bauds. +
+ +Freq | Station | Time |
+:-------------|:------|:--------------|:------------ +147,300 kHz | DDH47 | 05.00 - 22.00 | + / - 42,5 +4583,000 kHz | DDK2 | 00.00 - 24.00 | + / - 225,0 +7646,000 kHz | DDH7 | 00.00 - 24.00 | + / - 225,0 +10100,800 kHz | DDK9 | 00.00 - 24.00 | + / - 225,0 +11039,000 kHz | DDH9 | 05.00 - 22.00 | + / - 225,0 +14467,300 kHz | DDH8 | 05.00 - 22.00 | + / - 225,0 + + +\subsubsection other_broadcasters Other broadcasters + +Until recently, many shore stations used to transmit Synop reports by +Morse Code (\"Ocean Yacht Navigator\", Kenneth Wilkes, 1976 ). Still, +according to + +WMO information for shipping, +a couple of maritime stations might broadcast these informations in +different mode that RTTY, but this has not been tested yet. There are +just anecdotically cited here. + +Maritime Radio Station of Mumbai + +Met codes: FM 12 - SYNOP, FM 13 - SHIP for Sea areas I. +
+ +Band | Freq +:--------|:-------- +WT (MF) | 500 kHz +WT (MF) | 521 kHz +WT (HF) | 8630 kHz +WT (HF) | 12710 kHz + +
+ +SYNOP decoding is not accessible fromMorse CW modem yet. +
+ +Navtex station of Mumbai. COMCEN + +FM 12 SYNOPSIS, FM 13 SHIP for sea area I (Time schedule 0900, 2100) +
+ +
| Freq +:----|:--------------- +Navtex (Also called MSI as Maritime Safety Information) | 518 kHz + +
+ + +SYNOP decoding is not accessible from Navtex modem yet. +
+ +Marine Rescue Co-ordination Centre: Guayaquil, Radio IOA (Instituto Oceanografico Armada) o Radio Naval + +Meteorological information in process: Text, SHIP, SYNOP. +
+ +Mode | Freq +:----|:--------------- +AM | 1515 kHz + + +
+ +\section synop_parameters Parameters + +\image html config-rtty-synop.png "Synop configuration in RTTY tab" +\image latex config-rtty-synop.png "Synop configuration in RTTY tab" width=5.0in +
+ +By default, there is not SYNOP decoding of RTTY reception, so its behavior +does not change. However, it receives three new parameters related to +Synop decoding. + +SYNOP reports can be saved to the current ADIF log file: They are visible in +the journal of QSOs with the content of the report, the timestamp, and the +Maidenhead locator equivalent to the geographical coordinates of the +emitter of the report. + +SYNOP weather reports can also be plotted on KML files: They can then be +visualized in KML viewers such as Google Earth. + +If SYNOP reports are saved either to ADIF or KML files, fldigi attempts to +detect and decode RTTY messages. When these messages are detected, they are +displayed in the reception window. An extra parameter allows to replace +the coded Synop message, giving clarity at the risk of loosing +information, or mix the decoded reports with the original group of +digits (Interleaving of SYNOP and text). + +\section reception_window Reception window + +When SYNOP messages are detected, they are displayed in the reception +window in \"red\" characters (depicted here in \"italic\"). Here are +some examples (Interleaved text and SYNOP reports): +
+ + +13661 16123 99276 70216 46///
+ +WMO Station=13661
+WMO station=WMO_13661
+ UTC observation time=2013-02-16 12:00
+QLLLL token=Present
+Longitude=-21.6
+Latitude=27.6
+ + +///// 40206 52011
+222// 00203;
+ +Sea surface temperature=20.3 --C
+Temperature type=Intake measurement
+ +
+64522 16123 99591 70347 46///
+ WMO Station=64522
+ WMO station=WMO_64522
+ UTC observation time=2013-02-16 12:00
+ QLLLL token=Present
+ Longitude=-34.7
+ Latitude=59.1
+
+///./ 49920 57004.
+::(1056;
+, +26555 16123 998#6
+ WMO Station=26555
+ WMO station=WMO_26555
+ UTC observation time=2013-02-16 12:00
+
+70269 46/// ///// 40168 52008;
+ WMO Station=70269
+ WMO station=WMO_70269
+ Precipitations=Omitted, no observation
+ Station type=Automated station. No observation (No 7WW)
+ Visibility=Missing
+ Wind direction=No motion or no waves
+ Wind speed=0 knots (Estimated)
+ Sea level pressure=1016 hPa
+ Pressure tendency=Increasing steadily. Raises
+ Pressure change=0.8 hPa
+
+ +25617 16123 99867 1173!((6;
+ WMO Station=25617
+ WMO station=WMO_25617
+ UTC observation time=2013-02-16 12:00
+ QLLLL token=Present
+
+149 52001;
+
+13660 16123 992!;
+ WMO Station=13660
+ WMO station=WMO_13660
+ UTC observation time=2013-02-16 12:00
+
+).'/ ///// 40222 52&17
+
+52"// 08)02;
+
+44551 16123 99376 70378 46//.
+ WMO Station=44551
+ WMO station=WMO_44551
+ UTC observation time=2013-02-16 12:00
+ QLLLL token=Present
+ Longitude=-37.8
+ Latitude=37.6
+
+///// 40185 52022;
+ Sea level pressure=1018 hPa
+ Pressure tendency=Increasing steadily. Raises
+ Pressure change=2.2 hPa
+
+ +62680 16123
+9958"
+ WMO Station=62680
+ WMO station=Atbara
+ UTC observation time=2013-02-16 12:00
+
+70265 66//? BMPROIIO TUPEQ
+
+222!/ 00078;
+
+64527 16123 99593 70483 46///
+ WMO Station=64527
+ WMO station=WMO_64527
+ UTC observation time=2013-02-16 12:00
+ QLLLL token=Present
+ Longitude=-48.3
+ Latitude=59.3
+///// 40095 52004
+
+ + + +\section data_files Data files + +Several data files containing public information are used to decrypt SYNOP +data. They come from various places on the Internet, with redundancy. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NOAAWMO identifier, name and coordinates of thousands of weather stations in the world.
+http://weather.noaa.gov/data/nsd_bbsss.txt +
NOAAWeather, drifting, moored and wave riders buoys. Oil platforms. Fixed and mobile offshore drilling unit.
+ftp://tgftp.nws.noaa.gov/data/observations/marine/stations/station_table.txt +
UK's National Weather ServiceName, country and description of weather ships
+http://www.metoffice.gov.uk/media/csv/e/7/ToR-Stats-SHIP.csv +
+Joint WMO IOC Technical Commission for Oceanography and Marine Meteorology + +Argos and Iridium buoys, with WMO identifiers.
+ftp://ftp.jcommops.org/JCOMMOPS/GTS/wmo/wmo_list.txt +
+ +
+ +There is a specific window for downloading the latest version of these data +files. It can be reached with the command "File/Folders": +
+ +\image html Opening-DataFiles-Menu.png "How to reach the data files sources menu" +\image latex Opening-DataFiles-Menu.png "How to reach the data files sources menu" width=3.48in +
+ +These data files can also be found: +
+ +
    +
  • At installation time your fldigi binary comes with a package. All + data files are silently installed on your machine.
    • +
  • When building your own binary from the sources, with the + command make install. Similarly, all files are installed.
    • +
  • At first use and automatic installation, this opens the Data files + sources menus, where you can download all or some data files used by + fldigi.
    • +
+ + +\image html DataFilesSources.png "Downloading and updating data files used for various decodings" +\image latex DataFilesSources.png "Downloading and updating data files used for various decodings" width=5.0in +
+ + +\subsection synop_outputs Outputs + + +Each message is a set of key-value pairs, associated to: +
+ +Description | Measurement +:--------------------|:---------------- +Wind direction | 315 degrees +Wind speed | 8 m/s (Anemometer) +Temperature | 0.0 deg C +Dew point temperature | -3.8 deg C +Station pressure | 1006 hPa +Sea level pressure | 1030 hPa + + +\subsection output_formats Output formats + +\subsubsection ADIF + + +When the option is ticked, SYNOP weather reports are saved in a new ADIF +record, in the default logfile. +
+ +The report itself is saved with field \. +The length can be of several hundredth of chars, and accordingly to the +ADIF standard, new-lines can appear in each report. +
+ +Example of \ field in an ADIF record: + +\verbatim + +Header +ICAO indicator=LOWM +Identification and location +Land station observation +Land observations +Precipitations=Precipitation omitted, no precipitation +Station type=Manned station. 7WW omitted, not significant +Cloud base=600 to 1000 m +Visibility=15 km +Cloud cover=7/8 + +\endverbatim + +
+ +\subsubsection KML + +SYNOP reports can generate \ref kml_page "KML" +files for fixed stations, mobile weather ships, buoys etc... that is, +every observation which can be associated to a set of coordinates. +Several reports of the same station can be aggregated in a single +place mark. Mobile stations have their path drawn, linking all +coordinates spotted for a given station with an unique name. +
+ + +KML data are are also saved in a display-independent format in +\ tags, and thus can easily be reused by other +software. +
+ +\section command_line_synop Command-line SYNOP decoder program : synop_tool + + +The decoder comes with synop_tool, +a command-line tool able to decode input text files and generate the +same output files as fldigi. It is intended as a development for +checking internal consistency, and accuracy of SYNOP decoding without +the complexity of the graphical interface. + +It is accessible in the directory fldigi/src/synop-src and must +be built with the command make. +
+ +Its command-line options are displayed with the option --help: +
+ +\verbatim + +[fldigi/src/synop-src]$ ./synop_tool --help + +Valid options are: + data_dir # Where the data files are stored. For example /usr/local/share/fldigi/ + kml_dir # Out put directory of created KML files. + load_dir # Input directory of KML files loaded at startup. + dbg # Verbose mode. + usage # Print this message. + test # Decoding preceded by an internal test. + matrix # KML output in aggregated matrices (See KML documentation). + regex # text output of regular expressions, not decoded reports. + version # Prints version number. + help # Prints this messages + +\endverbatim + +
+\ref synop_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/Thor.txt b/fldigi_doxygen/user_src_docs/Thor.txt new file mode 100644 index 00000000..9fec94a2 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Thor.txt @@ -0,0 +1,75 @@ +/** +\page thor_page Thor + +\tableofcontents + +Thor is a new forward error correcting incremental frequency shift keyed +communications mode. It was developed specifically to meet the needs of ARQ +transfers in the HF spectrum. It is particularly well suited under +conditions of atmospheric static noise. Thor borrows from two current modem +technologies, \ref mfsk_page "MFSK" and \ref domino_ex_page "DominoEX". +
+ +Thor emits a distinctive double rising tone sequence at the +beginning of each transmission. It is used to flush the receive +decoder and also provides a visual and audible clue to its being used. +
+ +The modem code for Thor uses a wide band multiple frequency +detector that can lock on and detect the incoming signal even when +badly mistuned. Frequency domain oversampling is used to allow +proper tone detection without the need for AFC. The AFC control does +not alter the decoder in any way. +
+ +The waterfall and digiscope will appear as: +
+ +\image html Thor-1.png "Thor" +\image latex Thor-1.png "Thor" width=6.0in +
+ +The text displayed in the status area is the secondary text being sent by the +transmitting station. When the keyboard buffer is empty the Thor modem +transmits text from the secondary text buffer. Your secondary text buffer +can be edited on the Thor configuration tab. +
+ +The digiscope display is similar to the DominoEX display and represents the +tone pairs moving through the tone filters. You can also use an alternate +digiscope display (left click on the digiscope display area). +
+ + +\image html dominoex-1a.png "DominoEx" +\image latex dominoex-1a.png "DominoEx" width=1.0in +
+ +In this display mode the red line represents the center of the multiple +tone bins that are in the detector. The dots will be blurry if the AFC is +not locked on and become very distinct when AFC lock has been achieved. The +tone dots will move from bottom to top (opposite the direction of the +waterfall). +
+ +This is the same signal mistuned: +
+ +\image html dominoex-2.png "DominoEx Mistuned" +\image latex dominoex-2.png "DominoEx Mistuned" width=6.0in +
+ +and with the signal badly mistuned: +
+ +\image html dominoex-3.png "DominoEx Mistuned 2" +\image latex dominoex-3.png "DominoEx Mistuned 2" width=6.0in +
+ + +
+\ref thor_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/TransceiverControl.txt b/fldigi_doxygen/user_src_docs/TransceiverControl.txt new file mode 100644 index 00000000..0342069a --- /dev/null +++ b/fldigi_doxygen/user_src_docs/TransceiverControl.txt @@ -0,0 +1,289 @@ +/** +\page rig_control_page Rig Control + +\tableofcontents + + +\image html init-rig-setup.png "Initial Rig Setup" +\image latex init-rig-setup.png "Initial Rig Setup" width=2.0in +
+ +CAT not enabled +
+ + +\image html docked-rig-control.png "Docked Rig Control" +\image latex docked-rig-control.png "Docked Rig Control" width=5.0in +
+ +CAT not enabled, Manual Entry of transceiver frequency +
+ +Note: The same control is also used for both manual entry of the +transceiver frequency or with full CAT control. When no CAT is available +the control is simply a convenient way of keeping track of the transceiver +USB/LSB suppressed carrier frequency, the mode and the audio tracking +point. If fldigi is being used with an FM transceiver you probably should +enter the simplex frequency or the input frequency of a repeater being +used. This frequency value is used with the waterfall audio frequency to +compute the logged frequency. The logged frequency value will only be +correct for LSB and USB operation. +
+ +The frequency/mode pick list is displayed when the book button is +pressed. Pressing the book button a second time will restore the +original logging panel. +
+ +The pick list buttons control selecting, adding and deleting entries in +the frequency/mode list. +
+ +
    +
  • add the current frequency / mode / audio track point to the list
    • +
  • select the current list entry
    • +
  • delete the highlighted entry from the list
    • +
  • delete all entries from the list (a warning prompt will appear)
    • +
  • show active frequencies based on either the entry field to the + right or the stations locator, + see \ref psk_reporter_page "pskreporter/spotter".
    • +
  • entry field for active frequencies search, for example "EM."
    • +
+ + +The browser list contains frequency, sideband, modem type and audio +frequency. The list is saved when fldigi is shut down. +
+ +The combo box on the left will allow the selection and control of the +operating mode of the transceiver. +
+ +The combo box on the right will allow the selection and control of the +transceiver bandwidth. +
+ +The frequency display is in fact a set of special buttons. Each +digit may be increment by clicking/pressing on the upper half of the digit and +decrement by clicking/pressing the lower half of the digit. The leading +digits will follow suit if a decade rollover occurs. You can also place the +mouse cursor on a digit and then use the mouse wheel to roll the frequency +up and down. +
+ +Manual entry of frequency can be accomplished by hovering the mouse pointer +over the frequency display and entering the desired frequency (in Khz) via +the keyboard. Pressing \ or \ on completion sets the +frequency to an active state, effecting rig control and future log entires. +Don't forget the decimal point if you are entering a fractional KHz value. +
+ +The Smeter / Power-meter display is only active if fldigi is configured for xmlrpc +control with flrig. The transceiver must support the smeter and power out CAT query. +fldigi does not try to estimate the smeter reading based on the audio stream. +You can toggle viewing the Smeter / Power-meter display using the button just to +the right of the shared space used by the "Smeter/Power-meter" and the "Mode/Bandwidth" +controls. Be sure to save the configuration for this to persist the next +time fldigi is executed. +
+ +The mode combobox, the bandwidth combobox and the frequency display +also annunciate the current transceiver status. If you change +operating mode on the transceiver, that will be annunciated in the +respective combobox and FLDigi will adjust any internal parameters +accordingly. FLDigi queries the transceiver 10 times per second +to maintain a lock step with the transceiver. +
+ +\section rig_config Rig Configuration + +Hardware PTT control + +\image html config-rig-hardware.png "Hardware PTT control" +\image latex config-rig-hardware.png "Hardware PTT control" width=5.0in +
+ +Right Channel VOX Signal + +Fldigi can generate a 1000 Hz tone for the duration of the PTT keydown period. + A simple tone detector/filter and transistor switch can be used to generate +a PTT signal from this sound card output. Jim, W5ZIT, has provided +details on building an \ref w5zit_rt_channel_page "interface" for this +type of PTT control. +
+ +Serial Port using DTR or RTS +
+ +The simplest rig control is just being able to control the push to talk via +an external transistor switch. You set this type of control on the first +configuration tab for rig control. +
+ +You select this operation by checking the "Use serial port PTT". + Select the serial port from the list (fldigi will have searched +for available ports). Then specify whether the h/w uses RTS or +DTR and whether a + or - voltage is required to toggle PTT on. + +You can use a serial port for control with the RTS and DTR pins +configured for you particular interface. +The program allows you to use RTS, DTR or BOTH for the PTT +signal. Press the Initialize button to start the serial port. +
+ +Parallel Port (Linux and Free BSD only) +
+ +Fldigi sets and clears the parallel port pin, PARPORT_CONTROL_INIT, pin 16 on +the 25 pin parallel port connector. Keydown sets Pin 16 to +5 +volts and keyup sets the voltage to zero. +
+ +μH Router (MacOS X) +
+ +Simular functionality can be achieved on the Macintosh operating system using +'μH Router' by Kok Chen, W7AY. See +μH Router Website +for specific details and requirements. A selectable (check box) option will be +available on the Rig->Hardware PTT Configuration panel. +
+ +PTT delays +
+ +You can accommodate delays in transceiver switching between +receive and transmit by adjusting the PTT delays. The control +values are in milliseconds. These controls have no effect on +external PTT circuits such as those implemented in the SignaLink +interfaces. They rely on detecting the audio data stream. +You can use a combination of macro tags in a macro key definition to +achieve a resolution. For example try a macro definition similar +to this to insure that the RSID is sent via a slow FM xcvr (or via a +VHF repeater) +
+ +\verbatim + + + + + +\endverbatim + +
+ +Change the idle time value (in fractional seconds) to suit your needs. +
+ +\section rig_cat_control RigCAT control + +\image html config-rig-rigcat.png "RigCAT control" +\image latex config-rig-rigcat.png "RigCAT control" width=5.0in +
+ + +RigCAT is a rig control system similar to hamlib that was developed +specifically for fldigi. It uses command / response definitions that +are found in various \ref rig_xml_page "rig.xml" +files. You can use a rig.xml file specific for your transceiver or +write and test one yourself. The easiest way is to adapt an existing +rig xml file for a rig that is similar to your own. ICOM almost +identical command/response strings for all of its transceiver line. + Yaesu rigs have nearly all used unique command/response structures +until just recently. The TS-450, TS-950 and others share a similar set +of commands and responses. +
+ +RigCAT commands and responses are defined in a rig specific xml file which +contains all of the required queries and responses in extended markup +language format. Please read the specification +document \ref rig_xml_page "rigxml" to learn more about this new way of +building generic rig interface definitions and how they are used with +fldigi. fldigi will look for a file in the $HOME/.fldigi/rigs directory for +all files with extension ".xml". These contain definitions for the +transceiver indicated by the file name, ie: FT-450.xml, IC-756PRO.xml, +etc. You can download the appropriate xml files from the resource directory +tree http://www.w1hkj.com/xmls +or from the +archives web page. Place +the file in your rigs directory and fldigi will find it. +
+ +You will need to specify how your PTT will be triggered. This can be +using a CAT command, the RTS or DTR pins or none. None would be +appropriate if you are using the rig's VOX or an outboard sound card +interface such as the SignalLink SL-1+ which produces its own VOX type of +PTT. In that case simply leave all of the PTT options unselected. +
+ +If you are using a transceiver or a rig interface such as CI-V that echos +all serial data you check off the "Commands are echoed" box. That +will suppress fldigi trying to respond to a command it just sent to the +transceiver. +
+ +You may need to try various values of retries, retry interval, and command +interval to achieve consistent rigcat control. +
+ +Press the Initialize button after setting all of the parameters. If the +settings are all correct fldigi should start receiving frequency +information from the rig and annunciating them on the rig control +frequency display. + +\section hamlib_cat_control Hamlib CAT control + +Hamlib is a set of standard libraries for interfacing to a large number of +transceivers. The hamlib library system consists of a front end +which acts on behalf of all rigs and backends which are specific to +each rig. +
+ +\image html config-rig-hamlib.png "Hamlib CAT Control" +\image latex config-rig-hamlib.png "Hamlib CAT Control" width=5.0in +
+ +Select your transceiver from the list of supported units. Then select +the serial port and baud rate. If you are familiar with the +hamlib library you can send various startup sequences to the rig using +the advanced configuration. PTT control can be achieved using CAT +commands or via DTR / RTS on the same port as the control comms. + You might also need to specifiy whether RTS/CTS flow control is +uses (Kenwood rigs use this quite often) or if Xon/Xoff flow control is +used. +
+ +You may need to try various values of retries, retry interval, and command +interval to achieve consistent hamlib control. +
+ +Press the Initialize button after setting all of the parameters. If the +settings are all correct fldigi should start receiving frequency +information from the rig and annunciating them on the rig control +frequency display. +
+ +\section xml_rpc_cat Xml-Rpc CAT +
+ +\image html config-rig-xmlrpc.png "Xml-Rpc CAT Control" +\image latex config-rig-xmlrpc.png "Xml-Rpc CAT Control" width=5.0in +
+ + +Xml-Rpc allows third party software to control various aspects of fldigi +operation including but not limited to rig control. This is the data +interface that is also used by the program flrig, a fldigi +companion transceiver control program. +
+ +If you are using a third party interface such as DxKeeper Bridge you might +be instructed to select this method of CAT. +
+ +\ref rig_control_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/UTF8.txt b/fldigi_doxygen/user_src_docs/UTF8.txt new file mode 100644 index 00000000..feef83bb --- /dev/null +++ b/fldigi_doxygen/user_src_docs/UTF8.txt @@ -0,0 +1,44 @@ +/** +\page utf8_support_page UTF-8 support + +\tableofcontents + + +Fldigi supports the UTF-8 character set in all of it's labels and +widgets (controls). The Rx and Tx text panels accept both keyboard +and text stream that is in UTF-8 format. Transmission of UTF-8 +characters is supported by these modes: +
+ +
    +
  • PSK, PSKR, and Multi-Channel PSK/PSKR
    • +
  • Olivia - must enable 8 bit extended characters
    • +
  • MT63 - must enable 8 bit extended characters
    • +
  • MFSK - all baudrates supported
    • +
+
+ + +For example, the following Russian and annotated texts can be sent and +received: +
+ +\image html UTF8-Example.png "UTF-8 Encoded Characters" +\image latex UTF8-Example.png "UTF-8 Encoded Characters" width=3.5in +
+ + +UTF-8 characters are represented by 2 bytes which means that a single +character will take longer to transmit. Transmission speed will +be further reduced on modes like PSK where the character to bit stream +conversion has been optimized for the English language. +
+ + +
+\ref utf8_support_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/WEFAX.txt b/fldigi_doxygen/user_src_docs/WEFAX.txt new file mode 100644 index 00000000..8235024c --- /dev/null +++ b/fldigi_doxygen/user_src_docs/WEFAX.txt @@ -0,0 +1,359 @@ +/** +\page wefax_page WEFAX + +\tableofcontents + + +This modem is able to receive and transmit HF-Fax images, traditionally used +for weather reports. +
+ +More technical information is available on the wikipedia +article Radiofax. +
+ +Two modes are implemented IOC=576 or 288. The focus is made on +black-and-white images, color mode is still experimental. +
+ +Many frequencies are available +at http://www.hffax.com/ for example. +
+ +When entering any Wefax mode, the reception window opens, and optionally the +transmit window. it is always possible to bypass this with the menu +bar: +
+ +\image html FindReception.png "WEFAX" +\image latex FindReception.png "WEFAX" width=6.0in +
+ +\section wefax_config Configuration. +As for any modem, weather fax has its own tab in the configuration window. +
+ +\image html Wefax-Configuration.png "WEFAX Configuration" +\image latex Wefax-Configuration.png "WEFAX Configuration" width=6.0in +
+ +\subsection embeded_wefax Embedded vs floating display mode + +There are two display modes for this modem: +
+ +
    +
  • Embedded mode: This is the default mode, the normal receipt and + transmit windows gets graphic (Like Hellschreiber mode).
    • +
  • Floating mode: There are two separate windows for transmission and + reception. This was the only available mode until fldigi 3.21.49.
    • +
+ +\image html Wefax-Detached-Windows.png "Detached WEFAX Window" +\image latex Wefax-Detached-Windows.png "Detached WEFAX Window" width=6.0in +
+ +\subsection hide_tx_window Hide transmission window. + +This option, allows to closed by default, the transmission window, when +entering Wefax mode. In embedded mode, this means that the entire +window is used for reception (Most common mode). In floating mode, this +implies that the transmission window is not opened by default.However, +it is always possible to manually open or close the transmission window +at any time. +
+ +\subsection logging_adif Logging messages to ADIF file + +Each time an image is saved, it is possible to log this event, with the +frequency and reception time, to the Adif file. This option is disabled by +default. + +\subsection fsk_adjust Frequency shift adjustment + +The default frequency is 800 Hz. However, it is possible to adjust for +example to 850 Hz for Deutsche Wetter Dienst. +
+ +\subsection max_rows Maximum rows number + +It non-continuous (Non non-stop) reception mode, an image is +automatically saved when it has more than this number of lines +(Default 2500 lines). Once this number of rows is reached, the image +is saved and a new image is read with the same parameters. This feature +has two applications: +
+ +
    +
  • In automatic mode (APT control), if an image end is not detected, we + can guarantee that the result will take no more than, for example, the + size of two faxes. Typical faxes have about 1300 lines, so the max lines + parameters can be tuned to, for example, 200 lines.
    • +
  • In manual mode, where images are read continuously, this cuts the + received images into chunks of equal size.
    • +
+ +\subsection dest_dir Destination directory for saved images + +Received images are saved in the default folder + +$HOME/.fldigi/images (Linux) or \/fldigi.files/images + +(Windows). +
+ +Additionally, they can be saved manually, at any time, using the +button 'Save'. The PNG images received some extra text comments which can be +displayed, for example, with GIMP. +
+ +\subsection mono_images Monochrome images + +Fax images are monochromes and are saved as such by default. However, it is +possible to bypass this parameter and save them as color RGB images. +
+ +\section tx_image Transmitting an Image + +To open the transmit window, you must of course select one of the two +Wefax modems, and then right-click on the transmit (blue) window: +
+ +Then, the transmit window just opens. This is the same logic as sending MFSK +images. +
+ +Then, you must open an image file using the button "Load". The image is then +displayed, for example like that: +
+ +\image html Transmit_A.png "Transmitting" +\image latex Transmit_A.png "Transmitting" width=6.0in +
+ +Now, to start the transmission, you just need to click "Tx B/W" for +black-and-white images, etc... During transmission, image reception is +paused. The window will display each image line as it is sent. Please +be patient, this may take a while. You might note that FlDigi status +line displays the estimation transmit time, and the current stage +(Start, phasing etc...); Color transmission ('Tx Color') is +intentionally disabled at the moment. +
+ +\image html Wefax-Sending.png "Sending" +\image latex Wefax-Sending.png "Sending" width=6.0in + + +\section rx_image Receiving an image +
+ +\image html wefax-Receive-Embeded.png "Reception" +\image latex wefax-Receive-Embeded.png "Reception" width=6.0in +
+ + +To enter reception mode, one can click the "View" menu tab, and select +"Weather Fax Image". +
+ +At this time, the reception window opens. A big blank picture is visible, +this is where the received image will be displayed. Several controls +are available: +
+ +
    +
  • Save: This allows to save the current image as a PNG file at any + moment.
    • +
  • Non-stop: At startup, the modem goes into automatic mode, and the + text "Abort" is displayed. When clicking "Abort", this blanks the image + and resets the APT detection. When "Manual mode'" is clicked, no APT + detection is done. The Automatic/Manual mode is displayed in the + reception window label.
    • +
  • Pause/Resume: At any moment, the image reception can be paused + and resumed (State is displayed in the reception window label).
    • +
  • Zoom: This allows to zoom in/out the image.
    • +
  • FIR: + This allows to select an input FIR (Finite Impulse Response) filter. + Practically, the narrow filter (Default value) gives the best results. + The selected value is saved in the configuration file.
    • +
  • Skip + APT/Skip phasing: When in automatic mode, this allows to skip detection + steps. This is often necessary when the signal is not very good.
    • +
+ +When receiving an image, either in manual or automatic mode (APT control), +other controls are displayed: +
+ +
    +
  • Line: The number of the line currently received.
    • +
  • Width: The image width in pixels. This is usually 1809, if LPM + is 120.
    • +
  • LPM: + Lines per minute: Typically 120, can be 60, 90, 120 or 240. This is + detected in automatic mode, but can be manually adjusted.
    • +
  • Slant: + This is used to adjust the slant of the image due to a clock + inaccuracy. This value is saved in the configuration file, so it is + not needed to reenter it each time.
    • +
  • Center: This is used to manually adjust the horizontal center of + the image, if it could not be detected in the phasing step.
    • +
  • Auto: + When this button is set, the image will be automatically centered. This + process starts after some hundredth of lines are received, by shifting + left and right the image. It takes some time to converge.
    • +
+ +
+\image html wefax-rx-window-detached.png "Received WEFAX File" +\image latex wefax-rx-window-detached.png "Received WEFAX File" width=6.0in +
+ +\subsection apt_control_mode APT control reception mode + +This mode uses the APT start and STOP frequencies to detect the beginning +and end of an image. Additionally, it tries to detect the phasing +signal - a wide black band - to detect the center of the image. This +method is helped by the estimation of the signal power of these +frequencies. +
+ +\subsection manual_reception Manual reception mode (Non-Stop) + +In this mode, the image is continuously read and displayed. When the +maximum number of lines is reached, the image is saved and blanked, and +the line counter returns to one. +
+ +\subsection input_fir Input FIR filters + +There are three input Finite Impulse Response filters available. Here +are their frequency characteristics: +
+ +Narrow filter, the default one, give the better results. +
+ +\image html narrow.png "Narrow filter response" +\image latex narrow.png "Narrow filter response" width=3.0in +
+ +\image html middle.png "Middle filter response" +\image latex middle.png "Middle filter response" width=3.0in +
+ +\image html wide.png "Wide filter response" +\image latex wide.png "Wide filter response" width=3.0in +
+ +\subsection center_image Centering an image + +If the phasing was not automatically detected, the modem could not deduce +the beginning of an image. The result is an image which is horizontally +shifted. To correct this, one can use the "Center" slider. +
+ +\subsection picture_slant Picture with a slant + +If either the send, receive or both ends of the transmission are using an +uncalibrated sound card whose sampling rate is not an exact multiple of the +sample rate the resulting picture at the receive end will appear +slanted. The degree of slant is directly related to the accumulation of +the frequency error at both ends of the transfer. Stations wishing to +receive Weather fax pictures should calibrate their sound card. + +The \ref digiscope_display_wwv_mode "WWV calibration mode" is used +to measure and set the parts per million (ppm) correction factor for the +sound card. +
+ +Your sound system may be fully corrected, but the sending station may have +an uncorrected sound card. You can usually correct for small +errors during reception by using the slant slider. Its value (Typically +between - 0.005 and 0.005) will be stored in fldigi configuration +parameters. +
+ +\subsection auto_center Automatic centering. + +If the phasing signal could not be used for centering the image, the +program waits for a string image signal anyway to go into reception +mode, but it sets an internal flag allowing to automatically center the +image. This feature can be freely enabled and disabled at any moment. +it works by detecting a wide vertical band of about hundred pixels, +where the sum of the contrast as the lowest among the complete image +width. +
+ +That is: It computes for each row and each pixel, the +absolute value of the horizontal derivate. It then sums these +derivatives pixel-wise, row by row. Then, it computes an average of +about hundred pixels along this single row. The column which has the +lowest averaged contrast is considered to be the image margin, which is +then shifted on the left of the window. +
+ +This method takes some time to stabilize, because at the beginning, there +are many areas of the image, without details. It gets stable at the end, +when only the margin stays with few contrasted details. +
+ +\subsection image_detection Image detection based on signal power + +The APT control - inherited from the Hamfax signal, does not work very +well when the image is noised. On the other hand, fldigi provides ways +to evaluate the signal power on a given bandwith. This is used because +APT control relies on the emission on specific frequencies. +
+ +Therefore, in the APT start and phasing loops, when check for the presence of +strong signals associated to APT control. This information is used to +take a decision when the traditionally method does not detect anything. +
+ +These two methods are interchangeable but used together for better detection. +
+ +\subsection afc_control AFC: Automatic Frequency Control + +This option controls the frequency on the complete spectrum width. After +several hunderads of lines have been correctly loaded (That is, with a +high line-to-line correlation), the AFC locks until the frequency or +mode is manually changed. +
+ +\subsection noise_elimination Noise elimination + +This option eliminates short-lived noise, individual pixels with a different +value from their horizontal neighbors. They are modified using median +values. This is based on the fact that no line should be narrower than +two pixels, otherwise such an image would not be broadcast, because not +correctly readable. It is therefore impossible to have one single +pixel, simultaneously very different from its left and right neighbors. +
+ +\subsection binary_images Binary images + +Faxes can be stored as binary or grey level images. The cutoff level between +black and white (Default 128) can be adjusted. No information is lost +until the image is saved, therefore this level can be freely modified +until image end. The purpose of this option is to save disk space. +
+ +\subsection display_files Displaying received files + +Each time the end of an image is detected, an image file is created and its +name appears on the file list of the reception window. By clicking on a +file name, it is displayed in the transmit window. +
+ +\image html wefax-tx-rx-embeded.png "Received Image" +\image latex wefax-tx-rx-embeded.png "Received Image" width=6.0in +
+ +
+\ref wefax_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/WWV-xmt.txt b/fldigi_doxygen/user_src_docs/WWV-xmt.txt new file mode 100644 index 00000000..c34826e3 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/WWV-xmt.txt @@ -0,0 +1,59 @@ +/** +\page wwv_tx_mode WWV transmit mode + +\tableofcontents + +The WWV mode is normally used to measure the offset of the sound card +oscillator. (see \ref digiscope_display_wwv_mode "WWV ppm measurement"). +
+ +It can also be used to transmit time tick signals similar to the format +that is used by WWV. The WWV modem sends a time tick which is a +200 msec wide pulse at a once per second rate when the T/R button is +enabled. This pulse is shaped with a 4 msec raised cosine shape +on the leading and trailing edges to reduce key clicks. The +accuracy of the transmitted time tick is solely dependent on the +accuracy with which the WWV ppm measurement was performed. +
+ +The purpose of the WWV time tick transmission is to allow other +stations to calibrate their sound cards against your calibrated +system. This can be used to align all systems in a VHF/UHF net +for example. It is only necessary for one of the net members to +be able to calibrate his or her sound card against WWV. The +other's would then be calibrated by proxy use of the WWV time tick +transmit mode. This can even be used in the case where no member has +access to a HF transceiver. The "master" station would set the Rx +and Tx ppm settings to zero. It would then transmit the time tick +signal for the other stations to calibrate their sound cards against +the master sound card. Having all of the stations calibrated in +this way will insure that the modem decoders will give maximum +performance. Here is an example of an \ref inline_macro_page "advanced macro" + that will send a CW announcement, 2 minutes of time ticks and end with +another CW announcement. +
+ +\verbatim + + + + +QRZ QRZ de +2 minute time tick cal run follows + + + +end of time tick run +de k + + +\endverbatim + + +
+
+\ref wwv_tx_mode "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/WindowsOS.txt b/fldigi_doxygen/user_src_docs/WindowsOS.txt new file mode 100644 index 00000000..4dbe85af --- /dev/null +++ b/fldigi_doxygen/user_src_docs/WindowsOS.txt @@ -0,0 +1,107 @@ +/** +\page installing_on_windows_page Installing Fldigi on Windows + +\tableofcontents + + +The port of fldigi to the Windows operating system is built using +cross-compilers on Linux. The cross-compilation environment is +created using mingw32. +
+ +Installing fldigi on windows is very simple. Simply execute the +installer program and both fldigi and flarq will be installed in the +default programs directory structure for the specific Microsoft version +that is being targeted. Desktop icons and desktop menu items will +be created. An uninstaller link will be created on the desktop +menu. +
+ + +Click on the desktop icon to start the application. If this is a +new installation you will be guided through the inital configuration +with a \ref wizard_page "new install wizard". +
+ + +Resize the main dialog to suit your screen. Adjust the Rx/Tx divider to your +liking. Then set up the operator and sound card configuration +items; \ref configuration_page "configuring fldigi". When +you have fldigi receiving and decoding signals you can exit the +application which will allow you to save your configuration settings. +
+ +Now open up the following folder using your windows file explorer if you do +not have a login name and password: +
+ + + + + + + + +
On XP C:\\\"Documents and Settings\\\\fldigi.files\"
On W2KC:\\\"Documents and Settings\\\\fldigi.files\"
On Vista/Win7C:\\User\\\\fldigi.files
+ +where \ is the name with which you log onto the computer. +
+ +All of these files were generated by fldigi when it first started. The files +with the extension pal are palette definition files. The file "macros.mdf" +contains the macro definitions which you can change using the macro editor. + fldigi.prefs and fldigi_def.xml are used for storing the application state +and configuration items respectively. With the exception of the location of +this folder the operation of fldigi on windows is identical to linux. In +all instances where the help files make reference to $HOME/.fldigi you +should be substitute the appropriate directory for XP or Vista/Win7. +
+ +Please take the time to read and reread the on-line help file. Better +yet download the Adobe Reader file so that you can view the help +locally without needing access to the internet. Fldigi is a large +complex program with many ways for the user to customize its operation +to his or her hardware environment. +
+ + +\section special_note Special Note for Vista/Win7 from user! + +I am trying to install the latest and greatest version of FLDIGI and +FLARQ on a new Toshiba laptop computer that runs Vista/Win7 / Win7. The main +screen of FLDIGI comes up ok and it says that no call sign has been set +and down in the bottom center right there is an error message about +there not being the sound card that it thinks it should see. +I understand the messages as the program needs to be configured. +The problem is that when I click on 'Configuration' the main screen +grays out and it seems to go off into never never land and not comeback +or put up the configuration window. At that point the only thing +that works on the main screen is the close button. What am I +missing? +
+ +I solved the mystery! Cockpit error, kind of! I tried +installing MULTIPSK and got the "no sound card error" also. Went +into the Control Panel to see what was going on. When I looked at +sound input it said there was NO microphone plugged in. Then the +light came on and I remembered that you MUST have a microphone plugged +in when using the Vista OS or it doesn't think there is a sound card in +the computer!!! Well this is my first encounter with Vista and +how am I suppose to know or remember that little quark on an OS I've +never used before?? +
+ +Once I plugged a mic into the sound card input both programs worked +just fine. +
+ +Vista/Win7 requires either a microphone or a line-in +device actually plugged into the 8 mm audio jack before the sound +driver reports that there is an audio capture device. +
+ +\ref installing_on_windows_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/Wizard.txt b/fldigi_doxygen/user_src_docs/Wizard.txt new file mode 100644 index 00000000..8b736a68 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/Wizard.txt @@ -0,0 +1,53 @@ +/** +\page wizard_page New Install Wizard + +\tableofcontents + +New Install Wizard + +The new installation wizard borrows from the normal configuration +dialogs. You will find information on setting each of the wizard dialog +pages on the associated configuration link. +
+ +
+ +\image html wizard-page_1.png "Wizard Configuration" +\image latex wizard-page_1.png "Wizard Configuration" width=5.0in +
+ +\image html wizard-page_2-Operator-Information.png "Operator Configuration" +\image latex wizard-page_2-Operator-Information.png "Operator Configuration" width=5.0in +
+ +See \ref operator_configuration_page "Operator Configuration" +
+ +\image html wizard-page_3-AudioDevices-Device.png "Sound Card Configuration" +\image latex wizard-page_3-AudioDevices-Device.png "Sound Card Configuration" width=5.0in +
+ +See \ref sound_card_configuration_page "Sound Card Configuration" +
+ +\image html wizard-page_4-txControl-RigCat.png "Transceiver Configuration" +\image latex wizard-page_4-txControl-RigCat.png "Transceiver Configuration" width=5.0in +
+ +See \ref rig_control_page "Transceiver Configuration" +
+ +\image html wizard-page_5-Tabular-Data.png "Tabular Configuration" +\image latex wizard-page_5-Tabular-Data.png "Tabular Configuration" width=5.0in +
+ +See \ref supporting_data_files_page "Tabular Data" + +
+ +
+\ref wizard_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/advanced_qsy.txt b/fldigi_doxygen/user_src_docs/advanced_qsy.txt new file mode 100644 index 00000000..2746ee82 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/advanced_qsy.txt @@ -0,0 +1,137 @@ +/** +\page advanced_qsy_page Advanced QSY operations + +\tableofcontents + +
+The<QSY:FFF.F[:NNNN]> +macro tag and its delayed flavour<!QSY:FFF.F[:NNNN]> allows +the user to set the transceiver frequency to FFF.F (In kHz) and optionaly set +the audio frequency to NNNN (In Hz).

It is possible to give +several frequencies, which specify a frequency set. When the macro is +executed, it choses the first frequency of this set greater than the +current one. If the current frequency is greater than any frequency of +the set, then the macro choses the smallest, first frequency of this +set.

The utility of this feature is to allow a scan of a range of +frequencies by re-executing the same macro over and over. Each time the +macro is executed, the +next frequency of the set is selected. It can typically be used to +iteratively try several frequency for a given test. +
+
+The frequency set can be specified in two distinct ways, which can be freely +combined together. +
+
+ +\section dist_freq Distinct frequencies + +Several distinct separated with a +semi-column, in increasing order. +For example: +
+
+ +<QSY:2616.6;3287.6;3853.1;4608.1;4780.1;7878.1;8038.1:1900> +
+
+It means that the transceiver frequency will be set to 2616.6 kHz, then at +next execution to 3853.1 kHz etc... and will loop back to 2616.6 kHz. +Each time the same (optional) audio frequency will be set to 1900 Hz. +In this specific case, it allows to test several Weather Fax broadcast stations, +until the operator finds an active one. +
+
+ +\section s_freq_inc Frequencies with increments + +A frequency can come with an increment: This means an implicit range of +frequencies from this one to the next frequency. If the last frequency +has an increment, it is never taken into account: The last frequency is +always an upper limit. Let's consider this +example: +
+
+<QSY:89000+100;102000>

It is equivalent to: +
+
+<QSY:89000;89100;89200;89300;...;101900;102000> +
+
+In this case, it allows fldigi to scan all FM frequencies by clicking +the macro button. +
+ +\section combo_with Combination with \ macro tag. + +If the macro is automatically reexecuted using the <TIMER>, the +same logic applies. At each run of the macro, the next frequency is +chosen. The following macro transmits the same message on the +frequencies 144800 MHz, 144900 ... until 146000 then loops back, +waiting five seconds between each transmission. +
+
+<TX><QSY:144800.00+100;146000><MODEM:NULL><!MODEM:PACKET> +
+<FREQ> CQ CQ de <MYCALL><RX><TIMER:5> + +
+\section exec_error Execution errors. + +Several error messages can be displayed in the macro editor in case of a +parameter. If this happens, the execution of the macro is stopped. Here +is the list of possible messages: +
+ +\section invalid_freq Invalid frequency range +There must be valid frequencies. This macro will display the +message:
<QSY:abcdef> + +
+ +\section inc_pos Increment must be positive + +The frequency increment must be positive. +This macro will fail: +
+<QSY:89000-1000;88000> +
+ +\section freeq_not_pos Frequency not positive +All frequencies must be strictly positive. +
+\section freq_inc Frequencies must be increasing + +The sequence of frequencies must be strictly increasing. Thus, this error +message can appear with a macro such as: +
+
+<QSY:89000;88000> + +
+\section inline_macro Inline Macro Tags + +Unless otherwise noted all of the macro tags discussed thus far are +meant to be executed at the time that the macro is invoked by the +button closure. It is possible by execution of the tag to be +delayed until it appears in the transmit data stream. This +delayed execution capability is limited to a select number of +tags. See \ref inline_macro_page "Inline Macro Tags" +for a list of these tags and examples. + +
+\section at_macro Delayed Execution Macro Tags + +It is possible for the execution of the tag to be +delayed until after the macro execution returns to the recieve state. This +delayed execution capability is limited to a select number of +tags. See \ref at_macro_page "Delayed Execution Macro Tags" +for a list of these tags and example. + +
+\ref advanced_qsy_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/atMacroTags.txt b/fldigi_doxygen/user_src_docs/atMacroTags.txt new file mode 100644 index 00000000..b4337426 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/atMacroTags.txt @@ -0,0 +1,57 @@ +/** +\page at_macro_page Delayed Execution Macro Tags + +\tableofcontents + + +The following macro tags will be parsed and qued for action after fldigi returns +to the receive mode, i.e. after the \ tag (^r) is executed. +
+ + Tag | Description +:--------------------------: | :----------------- +\<\@MODEM: , ... \> | Change to specified modem with parameters +\<\@RIGCAT:hex hex:retnbr\> | RigCAT user commands +\<\@RIGCAT:"string":retnbr\> | hex hex ... are sequential hexadecimal values
string is Ascii char sequence retnbr
is number of bytes in xcvr response ':retnbr'
is optional; retnbr set to 0 if missing +\<\@GOHOME\> | return waterfall cursor to sweet spot +\<\@GOFREQ:NNNN\> | move waterfall cursor to freq NNNN Hz +\<\@RIGMODE:mode\> | send CAT command to transceiver to change to a valid mode +\<\@FILWID:width\> | send CAT command to transceiver to change to a valid filter
width example to QSY to sweetspot (center of bandpass filter) and select
narrow filter +\<\@TXRSID:on\|off\|t\> | transmit RSID on, off, toggle +
+ +Note that each of these tags is identical to their immediate mode +counterparts. The exception is the addition of the \@ symbol following the +leading '\<'. The use of these tags is best explained by example. +
+ +\section video_checkin Check in to a net with video ID + +\verbatim + + + + + +<@GOFREQ:1200> +<@MODEM:MFSK32> +<@TXRSID:on> +\n +\endverbatim +
    +
  • TxRSID is disabled before any other action
    • +
  • modem is changed to NULL to prevent anything but VIDEO transmission
    • +
  • Audio carrier is changed to 2200 Hertz
    • +
  • The callsign K7KY is transmitted as video text at 2200 Hertz
    • +
  • Return to receive
    • +
  • Waterfall carrier is set to 1200 Hertz
    • +
  • Modem is changed to MFSK-32
    • +
  • TxRSID is enabled
    • +
+
+\ref at_macro_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/bpq32.txt b/fldigi_doxygen/user_src_docs/bpq32.txt new file mode 100644 index 00000000..4eb8d807 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/bpq32.txt @@ -0,0 +1,41 @@ +/** +\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:
+BPQ32 Documents +
+and for a specific reference to FLDIGI (search for keyword FLDigi) +
+BPQ32 Documents (FLDIGI) +
+Installation files:
+Program and Support Data +
+\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 © work of John Wiseman, G8BPQ. Any inquires about +the software can be directed to: + +john(dot)wiseman(at)cantab(dot)net + + +
+\ref bpq32_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/buildinfo.txt b/fldigi_doxygen/user_src_docs/buildinfo.txt new file mode 100644 index 00000000..bb568e67 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/buildinfo.txt @@ -0,0 +1,68 @@ +/** +\page build_info_page Build Information + +\tableofcontents + +\section sub_build_info Build Info + +The following is obtained by executing "fldigi --version" + +\verbatim +Build information: +built : + +Fri Dec 25 15:57:13 CST 2009 by dave@linux-dev on i686-pc-linux-gnu for +i686-pc-linux-gnu + + configure flags: '--without-asciidoc' '--enable-optimizations=native' + + compiler : gcc version 4.3.3 (Ubuntu 4.3.3-5ubuntu4) + + compiler flags : -I$(srcdir) -I$(srcdir)/include +-I$(srcdir)/irrxml -I$(srcdir)/fileselector -pthread +-I/usr/local/include -I/usr/local/include -I/usr/include/freetype2 +-D_THREAD_SAFE -D_REENTRANT -D_REENTRANT -I/usr/local/include +-I/usr/include/libpng12 -I/usr/local/include -pipe -Wall -fexceptions +-O2 -ffast-math -finline-functions -fomit-frame-pointer -march=native +-mfpmath=sse -DNDEBUG + + linker flags : -L/usr/local/lib -lportaudio -lm +-lpthread -L/usr/local/lib -lfltk_images -lpng -lz -ljpeg -lfltk -lXft +-lpthread -ldl -lm -lXext -lX11 -lX11 -lsndfile -lsamplerate +-lpulse-simple -lpulse -L/usr/local/lib -lhamlib -lm -lpng12 +-L/usr/local/lib -lxmlrpc_server_abyss++ -lxmlrpc_server++ +-lxmlrpc_server_abyss -lxmlrpc_server -lxmlrpc_abyss -lpthread +-lxmlrpc++ -lxmlrpc -lxmlrpc_util -lxmlrpc_xmlparse -lxmlrpc_xmltok +-ldl -lrt -lpthread + + libraries : FLTK 1.3.2 + libsamplerate 0.1.4 + libsndfile 1.0.17 + PortAudio 19 + PulseAudio 0.9.14 + Hamlib 1.2.10 + XMLRPC-C 1.06.31 + +Runtime information: +system : Linux +linux-dev 2.6.28-17-generic #58-Ubuntu SMP Tue Dec 1 18:57:07 UTC 2009 +i686 + + libraries : libsamplerate-0.1.4 (c) 2002-2008 Erik de Castro Lopo + libsndfile-1.0.17 + +PortAudio V19-devel (built May 25 2009 06:36:24) 1899 +Pulseaudio 0.9.14 + +Hamlib version 1.2.10 + +\endverbatim + + +
+\ref build_info_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/cabrilloreporter.txt b/fldigi_doxygen/user_src_docs/cabrilloreporter.txt new file mode 100644 index 00000000..744d561a --- /dev/null +++ b/fldigi_doxygen/user_src_docs/cabrilloreporter.txt @@ -0,0 +1,145 @@ +/** +\page cabrillo_report_page Cabrillo Report + +\tableofcontents + +\image html CabrilloSetup.png "Cabrillo Report" +\image latex CabrilloSetup.png "Cabrillo Report" width=5.5in +
+ +Fldigi can generate a basic Cabrillo report that meets most contest needs. +
+ +Selecting the "File/Log/Cabrillo report" menu item opens the following +dialog: +
+ +If you want to export every record press the "Check All" in the left +panel. +
+ +Select the Contest type from the pull down menu in the right panel. +Fldigi knows how to format the various fields for each contest. +When satisfied with the setup press OK. You will then have +the opportunity to specify the location and name of the cabrillo output +file. +
+ +If you use the \ref contest_how_to_page \...\ to +capture your outgoing exchange, OR if you choose to capture all received +exchange information in the "Exch" field on the \ref qso_log_book_page "" panel then +you should be careful not to duplicate the data in the Caprillo report. For +example: +
+ +You captured outgoing exchange data as \\ \\. Do +not enable the "RST sent" and "Serial # out" check boxes as this info is +already contained in the "Exchange in" field. +
+ +You captured incoming exchange data into the Exch field as RST SER# +TIME. Do not enable the "RST rcvd" or the "Serial # in" check +boxes. +
+ +You must then open the file with a plain text editor and +modify the appropriate entries. Check with each contest sponsor +to see what their requirements are. +
+ +Here is an example of a generated cabrillo report format before being edited: + +\verbatim +START-OF-LOG: 3.0 +CREATED-BY: fldigi 3.11 + +# The callsign used during the contest. +CALLSIGN: W1HKJ + +# ASSISTED or NON-ASSISTED +CATEGORY-ASSISTED: + +# Band: ALL, 160M, 80M, 40M, 20M, 15M, 10M, 6M, 2M, 222, 432, 902, 1.2G +CATEGORY-BAND: + +# Mode: SSB, CW, RTTY, MIXED +CATEGORY-MODE: + +# Operator: SINGLE-OP, MULTI-OP, CHECKLOG +CATEGORY-OPERATOR: + +# Power: HIGH, LOW, QRP +CATEGORY-POWER: + +# Station: FIXED, MOBILE, PORTABLE, ROVER, EXPEDITION, HQ, SCHOOL +CATEGORY-STATION: + +# Time: 6-HOURS, 12-HOURS, 24-HOURS +CATEGORY-TIME: + +# Transmitter: ONE, TWO, LIMITED, UNLIMITED, SWL +CATEGORY-TRANSMITTER: + +# Overlay: ROOKIE, TB-WIRES, NOVICE-TECH, OVER-50 +CATEGORY-OVERLAY: + +# Integer number +CLAIMED-SCORE: + +# Name of the radio club with which the score should be aggregated. +CLUB: + +# Contest: AP-SPRINT, ARRL-10, ARRL-160, ARRL-DX-CW, ARRL-DX-SSB, ARRL-SS-CW, +# ARRL-SS-SSB, ARRL-UHF-AUG, ARRL-VHF-JAN, ARRL-VHF-JUN, ARRL-VHF-SEP, +# ARRL-RTTY, BARTG-RTTY, CQ-160-CW, CQ-160-SSB, CQ-WPX-CW, CQ-WPX-RTTY, +# CQ-WPX-SSB, CQ-VHF, CQ-WW-CW, CQ-WW-RTTY, CQ-WW-SSB, DARC-WAEDC-CW, +# DARC-WAEDC-RTTY, DARC-WAEDC-SSB, FCG-FQP, IARU-HF, JIDX-CW, JIDX-SSB, +# NAQP-CW, NAQP-RTTY, NAQP-SSB, NA-SPRINT-CW, NA-SPRINT-SSB, NCCC-CQP, +# NEQP, OCEANIA-DX-CW, OCEANIA-DX-SSB, RDXC, RSGB-IOTA, SAC-CW, SAC-SSB, +# STEW-PERRY, TARA-RTTY +CONTEST: ARRL-RTTY + +# Optional email address +EMAIL: + +LOCATION: + +# Operator name +NAME: + +# Maximum 4 address lines. +ADDRESS: +ADDRESS: +ADDRESS: +ADDRESS: + +# A space-delimited list of operator callsign(s). +OPERATORS: + +# Offtime yyyy-mm-dd nnnn yyyy-mm-dd nnnn +# OFFTIME: + +# Soapbox comments. +SOAPBOX: +SOAPBOX: +SOAPBOX: + +QSO: 14095 RY 2009-01-04 1952 W1HKJ 599 GA 12345 ND2T 599 CA 67890 +QSO: 14098 RY 2009-01-04 1949 W1HKJ 599 GA W0SD 599 SD +QSO: 14099 RY 2009-01-04 1948 W1HKJ 599 1234567890 KB7Q 599 1234567890 +QSO: 14100 RY 2009-01-04 1948 W1HKJ 599 GA N6WS 599 CA +QSO: 14103 RY 2009-01-04 1946 W1HKJ 599 GA VE6AO 599 AB +END-OF-LOG: + +\endverbatim + +
+ +\ref cabrillo_report_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + + diff --git a/fldigi_doxygen/user_src_docs/colorsandfonts.txt b/fldigi_doxygen/user_src_docs/colorsandfonts.txt new file mode 100644 index 00000000..a70fdfad --- /dev/null +++ b/fldigi_doxygen/user_src_docs/colorsandfonts.txt @@ -0,0 +1,188 @@ +/** +\page colors_and_fonts_page Colors and Fonts +\tableofcontents + +
+"System colors" are set by command line switches. The default is black +on a white background. +
+ +From the Menu Configure/Defaults select the menu item +Colors and Fonts and then select one of the following tabs. +
+ +\section text_controls Text Ctrls + +\image html ColorsFonts-rxtx.png "Colors Fonts RX / TX" +\image latex ColorsFonts-rxtx.png "Colors Fonts RX / TX" width=5.0in + +The initial color, font and font-size for the Rx and Tx panel are the +default values. You can always return to these by pressing the Defaults +button. The background color, font and font-size are independently +selectable. The Rx panel displays text in one of 5 colors: +
+ +
    +
  • normal received text - "Rx font" button
    • +
  • transmitted text - XMIT button
    • +
  • control characters - CTRL button
    • +
  • skipped characters (Tx ON/OFF in Tx pane) - SKIP button
    • +
  • quick view characters - ALTR button
    • +
  • select text highlight - SEL button
    • +
+ +The text widget used +for Rx, Tx and Event log displays has been improved to give better +performance with proportional fonts. Fixed width fonts still give +better performance and are not as demanding on the cpu. There are +several very good fixed width fonts that include a slashed zero which +are available for both Windows and Linux. If you are using a +proportional font and find that the Rx text display gets unresponsive +with large amounts of text then you should change to a fixed width +font. Do a search on the internet for "Andale Mono" or "Consolas". +Both are excellent fonts for this use. + + +\section character_set Character Set Selection + +\image html config-ui-rxtext-2.png "Character set" +\image latex config-ui-rxtext-2.png "Character set" width=2.0in + +This setting affects how fldigi encodes the text that it transmits and how +it interprets what it receives. This mainly matters if you intend to +transmit and/or receive text containing characters that are not in the +English alphabet (for example letters with diacritics, Cyrillic letters, +Japanese script and similar). Successful transmission and reception of such +symbols is only possible if both your and the correspondent's program are +set to use the same encoding. Seeing "strange" characters instead of what +you would expect for example "&ccaron;" always turning up as +\latexonly "\`{e}" \endlatexonly \htmlonly "è" \endhtmlonly indicates +that there is probably a mismatch between your encoding and the correspondent's. +
+ +Leaving this control set to UTF-8 (the default) is strongly recommended +as this is a cover-all encoding that enables communication in almost +any language and script imaginable. However, there are three cases in +which you might want to switch encodings (at least temporarily):
+ + +
    +
  • You never expect to transmit or view any character except +for the lower 128 characters (ASCII) of the ANSI data set. This +might be true for English to English communications in which you do not +want to have decoded noise appear as UTF-8 character renditions.
    • +
  • You want to communicate using non-English characters, but +the correspondent's program does not support UTF-8. In such a case, you +should find out what encoding the correspondent is using and change +your setting accordingly.
    • +
  • You expect to exchange a lot of traffic that mostly +consists of non-English characters (communication in Cyrillic script +being a notable example). UTF-8 encodes each non-English character into +a symbol two to four bytes long. Such characters require more time to +transmit and thus reduce the effective transmission speed. Choosing +another encoding that requires less bytes to be sent might be +beneficial if the transmission speed is crucial. For example, a pair of +operators wanting to communicate in Cyrillic script might want to +choose CP1251 to retain the maximum transmission speed.
    • +
+ +Warning: transmission of non-English characters, regardless of the +encoding used, requires that the digital mode used be capable of +handling 8-bit traffic. The following modes suit this requirement: +
+ +
    +
  • DominoEX
    • +
  • MFSK
    • +
  • MT63 (8 bit extended characters must be enabled)
    • +
  • Olivia (8 bit extended characters must be enabled)
    • +
  • PSK (all variants)
    • +
  • THOR
    • +
+ +
+ +\section freq_display Frequency Display + +\image html ColorsFonts-dsp.png "Frequency Display" +\image latex ColorsFonts-dsp.png "Frequency Display" width=5.0in + +The rig control panel uses a special button for each digit the represents +the transceiver frequency. The buttons are responsive to mouse +clicks on the upper and lower half with corresponding changes it that +unit's value. Unit value is also controlled by the mouse wheel +when the cursor is over a particular digit. Select the background +and foreground colors to please your overall color scheme and for best +visual acuity. The System colors are the same ones that are used +by all input and output text controls. +
+ +\section logging_controls Logging controls + +\image html ColorsFonts-log.png "Logging controls" +\image latex ColorsFonts-log.png "Logging controls" width=5.0in + +You can select the background color, the font, the font color and the +font size for both the logging controls on the main dialog and the +separate logbook dialog. + +\section func_keys Func keys + +\image html ColorsFonts-fkeys.png "Colors Fonts FKeys" +\image latex ColorsFonts-fkeys.png "Colors Fonts FKeys" width=5.0in + +You can color code the macro (function key) buttons in groups of 4, +F1-F4, F5-F8, and F9-F12. The background color for each group is +adjusted by clicking the respective Bkgnd button. The text color +for the button labels is adjusted by clicking on the Label Txt button. +The colors will change on these buttons and also on the main +dialog as you make these adjustments. The Defaults button +restores the colors as shown in this view. + +\section tab_colors Tab Colors + +\image html ColorsFonts-tabs.png "Colors Fonts Tabs" +\image latex ColorsFonts-tabs.png "Colors Fonts Tabs" width=5.0in + +Adjust the color of all tabs to suit your personal taste. + +\section light_botton_colors Light Buttons Colors + +\image html ColorsFonts-buttons.png "Colors Fonts Buttons" +\image latex ColorsFonts-buttons.png "Colors Fonts Buttons" width=5.0in + +
    +
  • Adjust the "on" color of Spot, RxID, TxID, Tune, Lk, Rev, T/R and AFC +button
    • +
  • Adjust the "enabled" and "on" colors of the Sql button
    • +
+ + +\section signal_level Signal Level + +\image html ColorsFonts-siglvl.png "Colors Fonts Signal Level" +\image latex ColorsFonts-siglvl.png "Colors Fonts Signal Level" width=5.0in + +
+You can select the low/normal/high/over-drive colors for the diamond signal +level in the lower right hand corner of the main dialog.
. +
+\image html Level-Indicator.png "Level Indicator" +\image latex Level-Indicator.png "Level Indicator" width=2.0in + +
+ +Your audio Rx level should be set to allow the loudest signals to drive +the indicator into the yellow and never into the red zone.
+
+ + + +
+\ref colors_and_fonts_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + diff --git a/fldigi_doxygen/user_src_docs/commandline.txt b/fldigi_doxygen/user_src_docs/commandline.txt new file mode 100644 index 00000000..6389be12 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/commandline.txt @@ -0,0 +1,202 @@ +/** +\page command_line_switches_page Command Line Switches + +\tableofcontents + +\section sTerminal Linux Terminal + +\verbatim + +Usage: + fldigi [option...] + +fldigi options: + + --home-dir DIRECTORY + Set the home directory to full pathname of DIRECTORY + fldigi will put the file stores + .fldigi.files, and .nbems.files + in this directory + The default is: /Users/robert/ + + --config-dir DIRECTORY + Look for configuration files in DIRECTORY + The default is: /Users/robert/.fldigi/ + + --enable-io-port <1|2> ARQ=1 KISS=2 + Select the active IO Port + The default is: 1 + + --kiss-server-address HOSTNAME + Set the KISS UDP server address + The default is: 127.0.0.1 + + --kiss-server-port-io I/O PORT + Set the KISS UDP server I/O port + The default is: 7342 + + --kiss-server-port-o Output PORT + Set the KISS UDP server output port + The default is: 7343 + + --kiss-server-dual-port Dual Port Use (0=disable / 1=enable) + Set the KISS UDP server dual port flag + The default is: 0 + + --arq-server-address HOSTNAME + Set the ARQ TCP server address + The default is: 127.0.0.1 + + --arq-server-port PORT + Set the ARQ TCP server port + The default is: 7322 + + --flmsg-dir DIRECTORY + Look for flmsg files in DIRECTORY + The default is + + --auto-dir DIRECTORY + Look for wrap_auto_file files in DIRECTORY + The default is WRAP/auto/ + + --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 + + --cpu-speed-test + Perform the CPU speed test, show results in the event log + and possibly change options. + + --noise + Unhide controls for noise tests + + --wfall-only + Hide all controls but the waterfall + + --debug-level LEVEL + Set the event log verbosity + + --debug-pskmail + Enable logging for pskmail / arq events + + --debug-audio + Enable logging for sound-card events + + --version + Print version information + + --build-info + Print build information + + --help + Print this option help + +Standard FLTK options: + + -bg COLOR, -background COLOR + Set the background color + -bg2 COLOR, -background2 COLOR + Set the secondary (text) background color + + -di DISPLAY, -display DISPLAY + Set the X display to use DISPLAY, + format is ``host:n.n'' + + -dn, -dnd or -nodn, -nodnd + Enable or disable drag and drop copy and paste in text fields + + -fg COLOR, -foreground COLOR + Set the foreground color + + -g GEOMETRY, -geometry GEOMETRY + Set the initial window size and position + GEOMETRY format is ``WxH+X+Y'' + ** fldigi may override this setting ** + + -i, -iconic + Start fldigi in iconified state + + -k, -kbd or -nok, -nokbd + Enable or disable visible keyboard focus in non-text widgets + + -na CLASSNAME, -name CLASSNAME + Set the window class to CLASSNAME + + -ti WINDOWTITLE, -title WINDOWTITLE + Set the window title + +Additional UI options: + + --font FONT[:SIZE] + Set the widget font and (optionally) size + The default is: ArialMT:12 + +\endverbatim + +\section sWindows Windows Icon Properties + +Setting command line parameters on all versions of Windows is accomplished by +modifying the parameters of fldigi's desktop icon. Open the icon by right clicking +on the icon. This is an example of modifying the font size: + +
+\image html properties-win8.png "Windows 8.1 Properties" +\image latex properties-win8.png "Windows 8.1 Properties" width=3in +
+ +The before and after for changing the font size: +
+\image html properties-win8-1.png "Windows 8.1 Original Font" +\image latex properties-win8-1.png "Windows 8.1 Original Font" width=3in +
+\image html properties-win8-2.png "Windows 8.1 Larger Font" +\image latex properties-win8-2.png "Windows 8.1 Larger Font" width=3in +
+ +Note the space between the location of the executable and the command line parameter. +Multiple parameters can be entered. Each parameter must be exactly as shown in the +list and separated from it's neighbors by at least 1 space. If the parameter has spaces +in the value then it must be enclosed in quotations. For example: +
+ +--home-dir "C:\Documents and Settings\dave\fldigi-vhf.files" +
+ +For --home-dir I would also recommend changing the name of the launcher icon. + +\section sMint Mint Launcher Properties + +Linux users may also change the command line parameters. Here is an example of +modifying the fldigi icon that was added to a Mint-17 launch bar: +
+\image html properties-mint.png "Mint Launch Bar Icon Properties" +\image latex properties-mint.png "Mint Launch Bar Icon Properties" width=3in +
+\image html properties-mint-1.png "Mint Larger Font" +\image latex properties-mint-1.png "Mint Larger Font" width=3in +
+ +Changing the font or font size can result in some loss of text on a control label. +The size of a control and it's label space do not change when the font is modified +on the command line. + +
+\ref command_line_switches_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configCW.txt b/fldigi_doxygen/user_src_docs/configCW.txt new file mode 100644 index 00000000..4c49b172 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configCW.txt @@ -0,0 +1,298 @@ +/** +\page cw_configuration_page CW Configuration + +\tableofcontents +
+\image html config-cw-general.png "General CW Configuration" +\image latex config-cw-general.png "General CW Configuration" width=5.0in +
+ +Fldigi can send and receive morse code from 5 wpm to 200 wpm. The +operating controls for CW are found on the Config/CW tab. You can +open that tab by selecting the "Configure/Modems" menu item and the +clicking on the Modems/CW tab. You can also open up the CW tab by +first selecting CW as the operating mode and then clicking on the +left-most item "CW" on the status bar at the bottom of the fldigi main +window. During operation the Rx and Tx WPM settings are +annunciated on the status bar in the two boxes next to the mode +indicator.
+ +
The CW signals are converted to a baseband signal. It is the +digital equivalent of tuning an analog USB transceiver so that the +carrier is exactly at the CW carrier frequency. The CW decoder +can use one of two different DSP filters. The Fast Fourier +Transform (FFT) filter is implemented with a sin(x)/x +impulse response. This is a very steep sided low pass +filter. Unchecking the FFT filter causes the decoder to use a +Finite Impulse Response (FIR) filter with a cutoff slope that is not as +steep. The FFT filter is optimum when receiving CW in a white +noise environment. The FIR filter may give better response with +impulse noise. Selected a "Matched" filter for either the FFT or +FIR implementation optimizes the filter bandwidth for white noise +suppression. A lot of impuse noise (static) can cause either +filter to ring and increasing the filter bandwidth might improve +detection in that electrical environment. +
+
+ +Fldigi can track the incoming signal. Enable Rx WPM tracking by enabling +the check box "Enable Tx Trkg". The tracking range (+/- Hz around the +TxWPM setting) can be set using the "Rx Trkg Rng" control. When +tracking is enabled the tracking filter is reset every time the +transmit WPM is adjusted. +
+
+ +CW detection is basically an amplitude demodulator. You can set +the threshold for detecting when the signal transitions from off-to-on +and on-to-off. These signal levels are relative to the average +signal level. The on-to-off is the "Lower" value and the +off-to-on the "Upper." This implementation provides a hysteresis +detector. Early fldigi CW decoders used this scheme but the +detection levels were not adjustable. +
+
+ +The RxWPM control is an indicator and is not used for setting the operation +of the CW decoder. +
+
+ +"SOM decoding" provides a fuzzy logic implementation to match the RX +stream detected on-off sequence to a "best fit" character. It can +increase the probability of correctly identifying the text character +under very noisy conditions. +
+ +The TxWPM sliding controller is used to set the transmit WPM. To +make the setting easier two additional controls are provided. +"Lower" sets the lower limit of the slider and "Upper" sets the +upper limit of the slider. The resolution of the TxWPM slider is +1 WPM. The Lower/Upper controls are in in 5 WPM increments. +
+
+ +The transmit encoder settings for WPM can also be adjusted with three hot +keys: +
+ +
    +
  • Numeric keypad "+" increases the TxWPM by 1
    • +
  • Numeric keypad "-" decreases the TxWPM by 1
    • +
  • Numeric keypad "*" toggles between the selected TxWPM and a default WPM
    • +
+ +The "Default" control on the CW tab sets that default value. As +shown above the TxWPM is 30 and the default is 18. If during a +QSO you needed to slow down to give the other op a better chance to +copy what you are sending, just hit the "*" on the numeric keypad and +the CW code will immediately switch to sending CW at the set default +value (18 wpm in this example). Press the "*" again to return to +back to the CW speed that you were previously using.
+ +\section subsec_timing Timing +
+ +\image html config-cw-qsk.png "Timing" +\image latex config-cw-qsk.png "Timing" width=5.0in +
+
+ +Fldigi generates CW by inserting a keyed tone at the current +waterfall audio frequency. The transceiver should be operated in +either USB (preferred) or LSB mode. +The CW signal is completely generated in the software so it is possible +to control many aspects of the CW signal. The actual transmitted +signal will be at the USB carrier + the audio frequency, or the LSB carrier - +the audio frequency. If fldigi is tracking and receiving a CW +signal on the waterfall your transmitted signal will be exactly on the +frequency of the other operator. The CW generated this way +has a nearly ideal attack and decay time, controlled by the software modem. +But ... a caveat ... your transmitter must never be +overdriven and it should have excellent opposite sideband suppression. +Overdriving the transmitter can cause multiple audio signals +within the SSB passband, and cause unwanted interference to other ops. +The same is true for a poorly designed or adjusted transmitter +with bad sideband suppression. I recommend having a trusted +and knowledgable operator assist you when first trying A2 CW. +Have them carefully look for evidence of your signal above and below your +primary signal (by at least +/- 3 Khz). If there is no +evidence of extra signals then your are set to go. If there is you +might want to have the transceiver adusted for sideband suppression, or check +to be sure you are not over driving the audio. + +
    +
  • Wt % control sets the weight of the CW. Normal CW is at 50% +weight, ie: a dot is equal to the interval between dots or between code +elements. It has a range of 20 to 80 percent.
    • + +
  • Dash/Dot controls the relative weight between a dash and a dot. +The standard for CW is 3 to 1. The dash is 3 times the +length of a dot. Some operators prefer the sound of either a +heavier or lighter sounding CW. This control can be adjusted from +2.5 to 4.0 in 0.1 increments.
    • + +
  • Edge shape provides two leading/trailing edge shapes (1) Hanning, or raised +cosine, and (2) Blackman a modified raised cosine with a steeper attack +and decay. Both of these edge shapes give a more narrow bandwidth +CW signal than the traditional exponential waveform. They are +very easy to listen to even at speeds exceeding 100 wpm.
    • + +
  • The Edge control sets the rise and fall times of the CW waveform. +It can be set anywhere from 0.0 to 15.0 milliseconds in +0.1 millisecond increments. DO NOT operate A2 CW with the control +set below 4 msec. This is the control that sets the effective +bandwidth and sound of your CW. If the edge is too steep you will +have a clicky signal and be the bane of the CW bands. The +purpose of being able to set the edge to 0.0 or a very quick rise/fall +time is explained below. A good setting for nice sounding CW at +40 WPM and below is 4 to 6 milliseconds.
    • + +
  • Edge decreases pulse width, when checked will give a slightly narrower dot +length as the edge timing is increased. This is useful when +operating QSK and listening between the character elements.
    • + +
  • The transmitted signal can be further wave shaped using a "Windowed-sinc" +bandpass filter. It is enabled by checking the "BPF transmit audio" check box. +The bandwidth of the filter can be adjusted from 10 to 1000 Hertz with the BPF bw +control. The filter will always be centered on the AFCW injection frequency +(waterfall TX cursor position). You should both visually observe and listen to +the resulting CW signal. The easiest way to do this is to enable the "Send continuously", +select a test character and then press the TX button on the main dialog. The +weight, dash/dot, edge shape selection, edge timing, BPF and bandwidth can be +changed with immediate effect.
    • +
+ +This is what the A2 signal should look like with various settings of +weight, Dash/Dot and Edge. The audio frequency is 400 Hz and +the TxWPM is 100 WPM. +
+
+ +\image html cw-00-30.png "Dash/Dot = 3.0, Edge = 0.0" +\image latex cw-00-30.png "Dash/Dot = 3.0, Edge = 0.0" width=2.8in +
+\image html cw-00-40.png "Dash/Dot = 4.0, Edge = 0.0" +\image latex cw-00-40.png "Dash/Dot = 4.0, Edge = 0.0" width=2.8in +
+\image html cw-30-30.png "Dash/Dot = 3.0, Edge = 3 msec" +\image latex cw-30-30.png "Dash/Dot = 3.0, Edge = 3 msec" width=2.8in +
+\image html cw-60-30.png "Dash/Dot = 3.0, Edge = 6 msec" +\image latex cw-60-30.png "Dash/Dot = 3.0, Edge = 6 msec" width=2.8in +
+\image html cw-120-30.png "Dash/Dot = 3.0, Edge = 12 msec" +\image latex cw-120-30.png "Dash/Dot = 3.0, Edge = 12 msec" width=2.8in +
+ +Changing the weight, dash/dot or edge of the waveform does not change +the WPM at which the code is generated. When a conflict +occurs between the various settings WPM takes first priority, and Edge second. +In the above examples, the Edge setting could not exceed 12 +msec even if the control were set higher than 12.0. The figures +were generated by capturing the output data being sent to the sound card and +then formatting it using Gnumeric. An oscilloscope photo of +the signal is virtually identical.
+
+ +The setting for inter-character and inter-word spacings are fixed at 3 +and 7 respectively. The 3 is achieved by sending a silent +period of 1 dot (element) length at the beginning of each character and 2 at +the end of each character (shown in the figures). This silent +period is sufficient for most transceivers to respond to the PTT signal +which occurs at the beginning of the transmission so that the first dit +or dash is not lost in transmission.QRQ (high speed CW operation)
+
+ +You may wonder why fldigi can go as high as 200 WPM. It's hard to +believe but there are CW operators who can decode 100+ WPM in their +head. These operators also usually operate QSK (full +breakin). A2 CW and PTT operation and QRQ/QSK are not a natural mix. +But fldigi can be used for this type of operation if an +external keyer is used. For that purpose the A2 Tx output from fldigi +is full wave rectified and detected to create a keyline control. +The outboard conversion from A2 to keyline requires a nearly square wave +pulse output of audio at the CW keying rate. Setting the Edge +control to 0.0 and then the audio frequency to about 1000 Hz provides +the needed signal to effect this type of keyline control.
+
+ +If you are operating QSK with a separate receiver / transmitter you can +very quickly stop your transmit signal with the TAB key. In +the CW mode only the TAB key causes the program to skip over the remaining +text in the transmit text buffer. The text that is skipped +will be color coded blue. The program remains in the transmit mode +(PTT enabled), but since the buffer is now empty no A2 CW signal is +generated. Code transmission will then restart with the very +next keyboard closure of a valid CW character. The Escape and +Pause/Break keys still can be used to respectively abort and pause +transmission. +
+ +\section subsec_qsk QSK +
+ +You might ask why fldigi doesn't simply provide a keyline output on +one of the parallel port pins or on RTS or DTR via a comm port. +The answer is quite simple. Linux is a multi-tasking +operating system and the interaction between the OS and the application +causes the timing to be adversely effected. The driver +implementation of the audio sub system must be responsive and so the OS +gives that sub system a very high priority in its multi-tasking +structure. +
+
+ +Many QSK operators use high speed diode antenna switching between +receiver and antenna. fldigi generates a signal that can be used +for that purpose. The left audio channel is always theAFCW +signal. When selected the right audio channel can be configured to +generate a square wave signal that begins earlier and ends later than each +of the CW elements. The square wave signal can be rectified and filtered +to provide the diode switching signal for the Rx/Tx antenna switching.
+
+ +The right audio channel QSK signal is selected by checking the box and +then adjusting the pre and post timing in millisecond increments. +Additional information and a schematic diagram of a QSK keying circuit +is described in \ref cw_keying_page "CW Keying". Setting +up a QSK device can be quite difficult. Fldigi helps to ease the +adjustment by generating a continuous series of characters. This +allows a dual trace scope to be properly synched while making the +adjustments to both the software and the associated QSK hardware. +You enable continuous characters by selecting the checkbox, and +then enabling the T/R button for transmit. The repeated character +can be change on the fly with the pick control. It can be one of +either E, I, S, T, M, O or V. +
+
+ +\section subsec_prosigns PROSIGNS + +\image html config-cw-prosigns.png "CW Prosigns" +\image latex config-cw-prosigns.png "CW Prosigns" width=5.7in +
+\image html config-cw-prosign-popup.png "Prosign Popup" +\image latex config-cw-prosign-popup.png "Prosign Popup" width=1.0in + +You can assign keyboard characters to be used for Morse prosigns. The +available characters are: ~ % & + = { } < > [ ] +
+
+ +The default assignments are shown above. You can also elect to send and +receive the KN prosign as an open parenthesis '('. This is commonly +used on MARS CW operations. +
+
+ +See \ref cw_page "Operating CW" for additional information. +
+
+ +\ref cw_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configContestia.txt b/fldigi_doxygen/user_src_docs/configContestia.txt new file mode 100644 index 00000000..91cca656 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configContestia.txt @@ -0,0 +1,23 @@ +/** +\page contestia_configuration_page Contestia Configuration + +\tableofcontents + +\image html config-contestia.png "Contestia Configuration" +\image latex config-contestia.png "Contestia Configuration" width=5.0in +
+ +Configuration of Contestia is similar to Olivia as Contestia is a +derivative of Oliva. +
+ +See \ref contestia_page for additional information. +
+ +
+\ref contestia_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configDomEX.txt b/fldigi_doxygen/user_src_docs/configDomEX.txt new file mode 100644 index 00000000..110110d3 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configDomEX.txt @@ -0,0 +1,49 @@ +/** +\page domino_ex_configuration_page DominoEX Configuration + +\tableofcontents + +
+\image html config-domino.png "DominoEX Configuration" +\image latex config-domino.png "DominoEX Configuration" width=5.0in + +Enter the secondary text. This text will be sent during periods when +your keyboard is inactive (between letters for slow typists). The +default for this text will be your callsign when you have entered that +in theOperator configuration tab. +
+
+ +Set the BW factor for the decoding prefilter. 2.0 should be adequate +unless you are experiencing nearby continuous wave interference (CWI). +You can enable and disable the prefilter with the checkbox. Please note +that the filter requires additional cpu cycles. Older and slower cpu +models might give better decoding with the filter disabled. +
+
+ +Fldigi can send and receive FEC in accordance with the DomEX-FEC specification +for MultiPsk. This type of FEC is achieved by some loss of non +printing characters in the primary character set. It is therefore +not usable as an FEC mode for ARQ (automatic repeat request) +transmissions. +
+
+ +The DominoEX decoder can detect the presence of CWI within the passband set +by the BW factor. Increasing the CWI threshold increases the +sensitivity to such interference. When the interference is +detected the associated data is culled using a technique called +puncturing. +
+
+ +DominoEX operations are described in \ref domino_ex_page . + +
+\ref domino_ex_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configFH.txt b/fldigi_doxygen/user_src_docs/configFH.txt new file mode 100644 index 00000000..cd5e3223 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configFH.txt @@ -0,0 +1,53 @@ +/** +\page feld_hell_configuration_page Feld Hell Configuration +\tableofcontents + +
+\image html config-feldhell.png "Feld Hell Config Panel" +\image latex config-feldhell.png "Feld Hell Config Panel" width=5.0in + +The Hellschreiber modes all use a video display that is basically a +character-by-character facsimile. The shape of the characters is +determined at the transmitting station. You can select from 15 +different fonts, all of which have been designed for Feld Hell use. +In normal use each dot of the character font is transmitted +twice. You can increase the effective video s/n by transmitting +the dots 2 or 3 times the normal. That is controlled by the +Transmit width.
+
+ +FeldHell is a pulse amplitude modulated +signal. The shape of the pulse is a raised cosine. This +helps to control the bandwidth of the transmitted signal. It is +customary to use a 4 millisecond risetime for the raised cosine, +especially on HF. You can change that to 2 milliseconds. +The video edges will be sharper, but the bandwidth twice as +large. You might find 2 msec a better choice for VHF and above.
+
+ +Fldigi provides three controls for the receive function. The video is +normally black on white. You can change that to white on black. +You can also compress the horizontal scan rate of the video. +You might find this effective in displaying received fonts that +are broad (or if the other end is using a multiple dot transmit width).
+
+ +As +you change Hellschreiber modes the optimum filter bandwidth will be +set. You can change that and might find a narrower filter +effective if you are experiencing CWI interference. FeldHell is +susceptible to CWI. If you narrow the filter the received video +will become blurred.
+ +
+\ref feld_hell_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + +
+
+ + diff --git a/fldigi_doxygen/user_src_docs/configFSQ.txt b/fldigi_doxygen/user_src_docs/configFSQ.txt new file mode 100644 index 00000000..60c787a9 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configFSQ.txt @@ -0,0 +1,103 @@ +/** +\page fsq_configuration_page FSQ Configuration + +\tableofcontents + +\image html config-fsq.png "" +\image latex config-fsq.png "" width=5.0in +
+\section fsq_rx_parameters Rx Parameters + +The FSQ decoder is essential a set of single frequency filters spaced by the interval +samplerate / symbol_length, 2.93 Hz. The filters are achieved using a Fast Fourier Transform. +Each spectral line (or bin) of the FFT is then filtered using a time domain filter called a +moving average (boxcar) filter. The moving average filter is the optimum filter +for locating a signal transition in the time domain. The moving average filter can +be adjusted to average 1 to 4 samples. A setting of 1 disables the filter. The +default value for the moving average filter is 3. + +The filtered spectral lines are then tested for maximum value. The Min Hits adjustment sets +the number of consecutive times a spectral line is the maximum before being designated as +a detected signal. Min Hits can be set over the range 3 to 6. The default value is 3. + +Images are detected by first converting the signal to a base band. This is accomplished +by mixing a 1500 Hz sine wave with the rx stream. This is equivalent to an analog receiver +that using direct conversion. The down converted signal can be filtered to reduce the +effect of noise. Your choice is NONE, 300, 400 or 500 Hz for the low pass filter 6 dB +cutoff frequency. Use the narrower filters for noisy conditions, but remember that filtering +will both reduce the image noise and also blur the image. + +Callsigns that satisfy the parsing requirements will be added to the FSQ heard list. +You can elect to have the heard list periodically managed so that older entries are removed or aged. +The user can elect no aging, Never; or 1, 5 10, 20 minutes intervals for aging. + +\section fsq_tx_parameters Tx Parameters + +FSQ transmissions can occur ar 2, 3, 4.5, or 6 baud. The default rate is 4.5. The baud +rate can be selected on the fsq configuration tab, or by left clicking on the left +most entry on the fldigi main dialog status bar. + +FSQ "Sounding" is a periodic transmission of your call sign followed by a colon. The +Sounding signal is a way of announcing your presence on the channel with the smallest +possible data stream. Other FSQ stations will add you to their Heard list if they detect +your Sounding signal. You set the Sounding interval to OFF, 1, 10 or 30 minutes. + +Your QTC text can be sent using the "QTC" button on the main dialog. It can also be +requested for auto reply by another FSQ station. + +All FSQ transmissions are designed to be inhibited so long as the software detects +a received signal (open squelch). + +\section fsq_logging Logging + +Any of the text in the Rx Panel or the Monitor Panel can be captured for copy, and +saving to a file. Simply right click on the panel for a pop menu. + +Fldigi's FSQ also saves a continuous log of all Heard stations, and an Audit log that +includes all received data. These logs are named fsq_heard_log.txt and fsq_audit_log.txt +respectively. The logs are never cleared unless the operator does so using the operating +system file handling facilities. Data is appended to each log as it occurs. These logs +are located in the fldigi temp folder: +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
XPC:\\Documents and Settings\\\\fldigi.files\\temp
VistaC:\\Users\\\\fldigi.files\\temp
Win7C:\\Users\\\\fldigi.files\\temp
Win8C:\\Users\\\\fldigi.files\\temp
Linux/home/\/.fldigi/temp
OS X/home/\/.fldigi/temp
Unix/home/\/.fldigi/temp
+
+ +You can elect to disable the logging functions. You may also rename the log to suit +your particular operations. + +
+\ref fsq_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/configIO.txt b/fldigi_doxygen/user_src_docs/configIO.txt new file mode 100644 index 00000000..f964230e --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configIO.txt @@ -0,0 +1,139 @@ +/** +\page config_io_page Configure ARQ/KISS I/O + +\tableofcontents + +
+\image html config-io.png "ARQ/KISS IO Configuration Panel" +\image latex config-io.png "ARQ/KISS IO Configuration Panel" width=5.5in +
+ +
+\image html config-io-locked.png "Locked IO Configuration Panel" +\image latex config-io-locked.png "Locked IO Configuration Panel" width=5.5in +
+ +\section sConfigIO I/O Configuration + +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" + +\par Note: +Any changes to the IP Address and/or port numbers requires FLDIGI restart. + +
+ +\subsection ssArqIO ARQ I/O + +
+\image html config-io-arq.png "ARQ IO Panel Options" +\image latex config-io-arq.png "ARQ IO Panel Options" width=5.5in +
+ +To select ARQ I/O, mouse click on the [ ] Enable ARQ check box. If the +checkbox is grayed out, this indicated the panel is locked. Deselect the +[ ] Lock checkbox to gain access. + +The ARQ section of the configuration panel allow the user to set the +IP address and port number. Pressing the [Default] button set the fields +to their startup values. In order for communications to occur both FLDIGI +and the FLDIGI suite of program must be assign the same IP address and port +number if the programs are used on the same computer. If the program are +running on different machines then the IP Address must be set accordingly +while maintaining the same port number. The IP Address entered is the +destination Address for the recipiente program/host computer. + +\subsection ssKissIO KISS I/O + +\image html config-io-kiss.png "KISS IO Panel Options" +\image latex config-io-kiss.png "KISS IO Panel Options" width=5.5in +
+ +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 + +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. + +\subsubsection 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 +clear a small variable delay is initiated preventing the transmitter from +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 + +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. + +\par NOTE: + When actived, only valid ax25 data will be displayed to the receive + panel. No un-squelched random characters will be seen. + +\subsubsection ssBusyChannel Busy Channel + +Busy Channel when enabled and with the properly set threshold of the KPSQL +squelch. Frequencies that are intermittently present within the bandwidth of +the modem will inhibit the transmitter for the specified duration. This is a +useful feature to prevent your station from capitalizing the frequency, +allowing casual users to continue without interruptions from "BBS/Email" +type operation. + +To prevent your station from transmitting between the grap of the RSID and +the data stream. Enable Busy Channel with a 1~2 second inhibit period. + +\subsubsection ssKpsqlAttenuation KPSQL Attenuation. + +Reduces the sensitivity of the KPSQL squelch. Useful when a direct audio +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 + +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 +and generally comprise of the BPSK, 8PSK, MFSK, THOR, Contestia, Olivia and +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. + +
+\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 +
+ +\subsection ssXmlRpcIO XMLRPC I/O + +
+\image html config-io-xmlrpc.png "XMLRPC IO Panel Options" +\image latex config-io-xmlrpc.png "XMLRPC IO Panel Options" width=5.5in +
+ +Setting and configuring IP address and ports numbers are described in the ARQ +section. + + + +
+\ref config_io_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/configMT63.txt b/fldigi_doxygen/user_src_docs/configMT63.txt new file mode 100644 index 00000000..d823ac70 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configMT63.txt @@ -0,0 +1,53 @@ +/** +\page mt63_configuration_page MT63 Configuration +\tableofcontents + +\image html config-mt63.png "Modems MT63 Config Panel" +\image latex config-mt63.png "Modems MT63 Config Panel" width=5.0in +
+ +MT63 is an orthogonal frequency division multiplexed mode consisting of 64 +parallel carriers each carrying a part of the transmitted signal. +There are 3 bandwidths and baudrates that fldigi implements in MT-63: +
    +
  • 500 Hz - 5 baud
    • +
  • 1000 Hz - 10 baud
    • +
  • 2000 Hz - 20 baud
    • +
+ +The lowest frequency transmitted is always 500 Hz. If you have a +scheduled MT63 qso or are trying to copy what you think is MT63 you +should tune the signal so that the lowest observable signal is at 500 +Hz. Fldigi is capable of decoding signals that are mistuned by as much +as +/- 100 Hz. +
+ +Selection of interleave (short/long) is made from the modem menu; +MT63-500S, MT63-500L, MT63-1000S, MT63-1000L, MT63-2000S, MT63-2000L. +
+ +Interleave and 8-bit extended characters are usually +agreed upon before a QSO exchange begins. The default is to use +the long interleave. 8-bit extended characters allow the +transmission of Latin-1 accented characters. +
+ +To assist the Rx operator you can transmit a short tone at the lowest +(and highest) tone frequencies. You can set the tone duration. +
+ +You may also elect to use manual tuning (position on the waterfall) of +the Tx / Rx signal. Be careful when doing this so that the signal +does not extend beyond the limits of your transceiver SSB filters. +
+ +MT63 is used extensively in the Military Affiliate Radio System (MARS). +
+ +\ref mt63_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ + diff --git a/fldigi_doxygen/user_src_docs/configModemScan.txt b/fldigi_doxygen/user_src_docs/configModemScan.txt new file mode 100644 index 00000000..ad0d3e51 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configModemScan.txt @@ -0,0 +1,43 @@ +/** +\page fft_scan_page Configure FFT Scan + +\tableofcontents + +
+\image html config-modem-scan.png "Scan Configuration Panel" +\image latex config-modem-scan.png "Scan Configuration Panel" width=5.5in +
+ +\# scans: The number of scans to perform (averaging). + +db Range: The dynamic range in dB (vertical scale). + +\section sFftScan FFT Scan + +Analysis tool used to evaluate Rx/Codec signal path. Can be used to measure +noise floor of the codec; view the transceiver passband characteristics, +Rx signal spectrum, etc. + +
+\image html fcfhfacc.png "Scan results" +\image latex fcfhfacc.png "Scan results" width=5.5in +
+ +The scope shows the results, both final and during the scan averaging. +The # of scans specifies how many scans are averaged for the display. The +dB range specifies the vertical scale as seen above. "Use relative dB" +removes the vertical offset so that a wider range can be displayed with +more detail. + +Left clicking any where on the waterfall restarts the scan. You can +observe the effect on the scope display. A comma separated file is +also generated; ~/.fldigi/fftscan.csv which can be opened with any +spread sheet program. + +
+\ref fft_scan_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/configOlivia.txt b/fldigi_doxygen/user_src_docs/configOlivia.txt new file mode 100644 index 00000000..dae6bb6b --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configOlivia.txt @@ -0,0 +1,35 @@ +/** +\page olivia_configuration_page Olivia Configuration +\tableofcontents +
+ +\image html config-olivia.png "Description" +\image latex config-olivia.png "Description" width=5.0in +
+ +Olivia is a family of MFSK modes with a high redundancy Forward Error +Correction system similar to MT63. The family is very large, with 40 or +more different options, which can make it very difficult to work out which is +which. The mode works well on poor HF paths and has good sensitivity. +There are three popular modes, which have 8-FSK, 16-FSK and +32-FSK, thus having three, four or five bits per symbol. These +three modes can be selected without additional configuration. The +tone frequency spacing and integration period should always be left at +8 and 4 respectively unless you are experimenting with another station +running an Olivia modem that can be changed. These must always be +the same at both ends of the Olivia QSO. The modes have two +serious shortcomings - excessive bandwidth combined with slow typing +rate, and excessive latency which is the apparent typing delay caused +by the integration period. +
+ +See \ref olivia_page "Operating Olivia" for additional information. +
+ +
+\ref olivia_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configPSK.txt b/fldigi_doxygen/user_src_docs/configPSK.txt new file mode 100644 index 00000000..74082182 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configPSK.txt @@ -0,0 +1,57 @@ +/** +\page psk_configuration_page PSK Configuration + +\tableofcontents + +\image html config-psk-general.png "Modems PSK General" +\image latex config-psk-general.png "Modems PSK General" width=5.0in +
+ +You should set the acquisition search range for waterfall left click +action. As you adjust this control you will see the red mode +width change on the waterfall scale. You can also adjust this +value by pointing the mouse to the waterfall. Hold down the +Control key and rotate the mouse wheel. The search routine which +finds the PSK signal operates on a s/n threshold detector as well as +recognizing the PSK phase modulation. You can adjust the +acquisition signal to ratio threshold for the search routine. +
+ +The PSK decoder estimates the signal to noise ratio, S/N, and the +intermodulation distortion, IMD, of the received signal. This +measurement is valid during periods when the other station is +transmitting the idle signal. The estimates are displayed on the +status bar. You can control how these values are displayed; clear +or dim after NN seconds. Setting the seconds to 0 disables the +clear/dim action. +
+ +Fldigi has a multi channel browser than can display simultaneous reception of +up to 30 PSK signals. The browser is described here: +
+ +8psk (8 phase states) does not use AFC for signal acquistion or tracking. RsID +or operator adjustment of tracking point is necessary to align the decoder with +the received signal. This mode includes the optional use of a pilot tone. The +level of the pilot tone can be set relative to the total signal power. +
+ +This table shows the amount of transmit power used by the pilot tone +
+ +
+dB | -20 | -26 | -29 | -32 | -36 | -40 +:------:|:----:|:----:|:----:|:----:|:----:|:---- +Pwr Lvl | 10% | 5% | 3.5% | 2.5% | 1.6% | 1.0% +
+ +\ref signal_browser_page "Signal Browser" +
+ +
+\ref psk_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configRTTY.txt b/fldigi_doxygen/user_src_docs/configRTTY.txt new file mode 100644 index 00000000..32c7803c --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configRTTY.txt @@ -0,0 +1,95 @@ +/** +\page rtty_fsk_configuration_page RTTY / FSK Configuration + +\tableofcontents + +\image html config-rtty-rx.png "RTTY RX" +\image latex config-rtty-rx.png "RTTY RX" width=5.0in +
+ +\image html config-rtty-tx.png "RTTY TX" +\image latex config-rtty-tx.png "RTTY TX" width=5.0in +
+ +\image html config-rtty-synop.png "RTTY SYNOP" +\image latex config-rtty-synop.png "RTTY SYNOP" width=5.0in +
+ +Fldigi operates RTTY using AFSK and the transceiver set to USB. The +RTTY signal can be transmitted anywhere within the USB passband of the +transceiver. +
+ +You can select from various Shifts, Bauds, Bits, Parity and Stop Bits +for both AFSK and FSK keying of the transmitter. You can elect to +have fldigi automatically insert a CFLF when it reaches character 72 on +a line. You can also have it insert a CR-CR-LF sequence instead +of the standard CR-LF sequence. This is very useful if you are +communicating with someone using a hardware TTY printer. The +extra carriage return will give the physical device time to move to the +left margin before new characters arrive. +
+ +The RTTY decoder maintains an internal AFC system for tracking the +desired signal. Depending on operating conditions you may need to +adjust the action of the AFC loop. Select from the Slow, Normal +or Fast AFC loop. You can also disable AFC with the AFC button on +the main panel. +
+ +The received signal processing consists of a tuned Raised Cosine Filter +followed by an optimized Automatic Threshold Correcting (ATC) +detector. The resulting bit stream is then processed to extract +the byte data. +
+ +\image html config-rtty-classic-scope.png "Classic RTTY XY Scope" +\image latex config-rtty-classic-scope.png "Classic RTTY XY Scope" width=1.5in +
+ +\image html config-rtty-pseudo-scope.png "Pseudo Signal XY Scope" +\image latex config-rtty-pseudo-scope.png "Pseudo Signal XY Scope" width=1.5in +
+ +The Digiscope display can be defaulted to the X-scope or the Signal +scope. +
+ +The classic XY-scope is similar to older hardware scopes that show +the output of the separate Mark-Space filters, one applied to the horizontal +and one to the vertical axis. +
+ +The Pseudo XY-scope is similar with the exception that the horizontal +and vertical are phase related to the Mark-Space signals, but not the +actual signal. +
+ +The Classis XY-scope will appear noisier than the Pseudo XY-scope. +
+ +PseudoFSK selection generates an additional audio signal on the right +channel. This signal is a burst tone at the FSK keying rate. +You can full wave rectify and filter the signal so that it can be +used as the FSK keyline signal to a rig that supports FSK transmissions. +See \ref pseudo_fsk_page "Pseudo FSK" for additional information and a +suitable keying circuit. +
+ +Your log can record either the center frequency between the Mark and +Space or the Mark frequency. You can also select the color that +should distinguish the Mark frequency. + +\image html config-rtty-synop.png "RTTY SYNOP" +\image latex config-rtty-synop.png "RTTY SYNOP" width=5.0in +
+ +See \ref synop_page "Synop" and \ref rtty_page "RTTY" for additional information. + +
+\ref rtty_fsk_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configThor.txt b/fldigi_doxygen/user_src_docs/configThor.txt new file mode 100644 index 00000000..fbed01b9 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configThor.txt @@ -0,0 +1,43 @@ +/** +\page thor_configuration_page Thor Configuration + +\tableofcontents + +\image html config-thor.png "Modems Thor" +\image latex config-thor.png "Modems Thor" width=5.0in +
+ +The decoder can detect and defeat a modest amount of CWI that is within the +BW set by the BW factor. Increasing the CWI threshold increasing +the sensitivity for this correction. The offending tones are +punctured thereby rendering them null to the Viterbi decoder. +

Enter the secondary text. This text will be sent during periods +when your keyboard is inactive (between letters for slow typists). The +default for this text will be your callsign when you have entered that +in the Operator configuration tab. +
+ +Set the BW factor for the decoding prefilter. 2.0 should be adequate +unless you are experiencing nearby continuous wave interference (CWI). +You can enable and disable the prefilter with the checkbox. Please note +that the filter requires additional cpu cycles. Older and slower cpu +models might give better decoding with the filter disabled. +
+ +The DominoEX decoder can detect the presence of CWI within the passband set +by the BW factor. Increasing the CWI threshold increases the +sensitivity to such interference. When the interference is +detected the associated data is culled using a technique called puncturing. +
+ +Thor has been specifically designed to be used with ARQ text transmissions. +It is also an easy to use keyboard chat mode. Thor operations +are described in \ref thor_page "Operating Thor". + +
+\ref thor_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configUITouch.txt b/fldigi_doxygen/user_src_docs/configUITouch.txt new file mode 100644 index 00000000..0f37328d --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configUITouch.txt @@ -0,0 +1,45 @@ +/** +\page touch_page Configure Touch Screen + +\tableofcontents + +
+\image html config-ui-touch.png "Touch Screen Configuration Panel" +\image latex config-ui-touch.png "Touch Screen Configuration Panel" width=5.5in +
+ +\section sTouchScreen Touch Screen + +Provides a few UI configurable items that improve using fldigi on a touch +screen device, such as a Windows table, or an Android running a remote +desktop with fldigi as the application. These items are enhanced by the +addition of a macro tag that allows the operator to change focus to the +frequency input widget by pressing that macro key: + +
+\image html fafhjagc.png "Macro Command" +\image latex fafhjagc.png "Macro Command" width=4.4in +
+ +\ + +Which then enables keyboard entry into the frequency widget, but more +important also allows the cursor keys, and Shift-cursor keys to modify the +frequency entry. + +Tablets usually put the on-screen keyboard at the bottom of the display +which covers up the fldigi Tx panel. Typing in the blind is not very +satisfactory, so the "Tx above Rx" allows the the Rx and Tx panels to be +swapped. The functions keys are too small for most adult male fingers +on a touch screen. The "one Macro Row above Rx/Tx" and the size adjustment +provides relief for bumbling fingers and also moves the function key bar +from beneath that immovable tablet on screen keyboard. + + +
+\ref touch_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/configcallsigndb.txt b/fldigi_doxygen/user_src_docs/configcallsigndb.txt new file mode 100644 index 00000000..5547904f --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configcallsigndb.txt @@ -0,0 +1,77 @@ +/** +\page callsign_db_configuration_page Callsign DB Configuration +\tableofcontents +
+ +\section qrz QRZ +
+\image html config-qrz.png "QRZ" +\image latex config-qrz.png "QRZ" width=5.0in +
+
+Fldigi will open a web browser to either QRZ.com or Hamcall.net with the +contents of the QSO Call field used as a query string to the on line +service. You may find that your default browser needs to be +triggered twice on the first such query. That behavior seems to +be associated with IE7 but not IE6 for example. +
+ +If you have a CD +with the QRZ database installed you can use that CD or its' stored +contents on a hard drive. Simply specify where the CALLBK +directory can be found and enable the QRZ radio button. +
+ +If you are a paid subscriber to either QRZ or Hamcall xml database service +then you can specify that fldigi use that service for all Callsign data +base queries.
+
+ +OK2CQR provides a very nice callsign lookup service on his hamqth.com +web site. There is no subscriber fee to use this service. +Simply register and then use your registered user name and password for +access. You might want to provide monetary support to Petr if +this service meets your needs.
+
+ +\section eqsl EQSL +
+ +\image html config-eqsl.png "EQSL" +\image latex config-eqsl.png "EQSL" width=5.0in +
+ +Configure the eQSL log entry upload with your user ID, password, and QTH +nickname. See Macros for additional +information.
+
+ +\section fldigi_logging FLdigi Logging +
+ +\image html log-it.png "Log It" +\image latex log-it.png "Log It" width=0.5in +
+ +If you check the "send when logged" button then the logged record will be +sent to eQSL when either the +log it button is pressed, or when the macro tag <LOG> or <LNW> +is executed.
+
+You may elect to use the default of date-time ON or date-time OFF for the +eQSL submission.
+
+You may send a message with the log record. If you fill in the +default message text then it will be used for that purpose. You +might want to use something like:
+
+Tks for {MODE} qso {NAME}. 73, pse eQSL
+
+ +
+\ref callsign_db_configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/configure_scripting.txt b/fldigi_doxygen/user_src_docs/configure_scripting.txt new file mode 100644 index 00000000..06865ecd --- /dev/null +++ b/fldigi_doxygen/user_src_docs/configure_scripting.txt @@ -0,0 +1,1634 @@ +/** +\page configure_script_page Configure Scripting + +\tableofcontents +
+ +\section sConfigScript Configure Scripting + +\image html menu-files-config-scripts.png "Scripts" +\image latex menu-files-config-scripts.png "Scripts" width=1.25in + +\par 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. + +\par 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: +
    +
  • Configuring FLDigi to support a specific net operation.
    • +
  • Restore user data when issues with FLdigi requires the deletion or +reset of fldigi.prefs and fldigi_def.xml files.
    • +
+ +\par Net Operations +A script can be created for setting the rig frequency, waterfall offset, modem, +rig mode, and custom macros. See \ref sConfigScriptCmds for other available +options. + +\par 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 \ref sConfigScriptCmds for limits. + + +\subsection ss_exec_script 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. + +
+\image html script_warning_dialogbox.png "Warning Report Dialog Box" +\image latex script_warning_dialogbox.png "Warning Report Dialog Box" width=2.3in + +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. + +
+\image html script_error_log_entry.png "Error Report Log Entry" +\image latex script_error_log_entry.png "Error Report Log Entry" width=2.92in + +Some configuration options will required FLDigi restart. Ensure configuration +is saved prior to restarting. + +
+\image html script_restart_notice.png "Restart FLDIGI notice" +\image latex script_restart_notice.png "Restart FLDIGI notice" width=2.92in + +\par 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. + +\subsection ss_gen_script 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 \ref sScriptSyntax) 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 \ref sScriptSyntax and \ref sExampleScript + +\par 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. + +
+

+\section sConfigScriptCmds Configure Script Commands + +\ref ss_fldigi "FLDIGI"
+\par +\ref sss_freq "FREQ"   \|   +\ref sss_mode "MODE"   \|   +\ref sss_wfhz "WFHZ"   \|   +\ref sss_rxid "RXID"   \|   +\ref sss_txid "TXID"   \|   +\ref sss_spot "SPOT"   \|   +\ref sss_rev "REV"   \|   +\ref sss_afc "AFC"   \|   +\ref sss_lock "LOCK"   \|   +\ref sss_sql "SQL"   \|   +\ref sss_kpsql "KPSQL"   \|   +\ref sss_modem "MODEM" + +\ref ss_operator "OPERATOR"
+\par +\ref sss_callsign "CALLSIGN"   \|   +\ref sss_name "NAME"   \|   +\ref sss_qth "QTH"   \|   +\ref sss_loc "LOC"   \|   +\ref sss_ant "ANT" + +\ref ss_audio_device "AUDIO DEVICE"
+\par +\ref sss_oss "OSS"   \|   +\ref sss_dev_path "OSS DEV"   \|   +\ref sss_portaudio "PA"   \|   +\ref sss_portaudio_playback "PA PLAYBACK"   \|   +\ref sss_portaudio_capture "PA CAPTURE"   \|   +\ref sss_pua "PUA"   \|   +\ref sss_pua_srvr "PUA SERVER" + +\ref ss_audio_settings "AUDIO SETTINGS"
+\par +\ref sss_audio_capture_sample_rate "CAPTURE"   \|   +\ref sss_audio_playback_sample_rate "PLAYBACK"   \|   +\ref sss_audio_converter "CONVERTER"   \|   +\ref sss_rx_ppm "RX PPM"   \|   +\ref sss_tx_ppm "TX PPM"   \|   +\ref sss_tx_offset "TX OFFSET" + +\ref ss_audio_rt_channel "AUDIO RT CHANNEL"
+\par +\ref sss_rt_mono "MONO AUDIO"   \|   +\ref sss_rt_mono_lr "MODEM LR"   \|   +\ref sss_rt_mono_rev "REV LR"   \|   +\ref sss_rt_mono_ptt "PTT RT CHAN"   \|   +\ref sss_rt_mono_qsk "QSK RT CHAN"   \|   +\ref sss_rt_mono_fsk "FSK RT CHAN" + +\ref ss_audio_wave_sr "AUDIO WAVE.SRATE" + +\ref ss_rig_hrdwr_ptt "RIG HRDWR PTT" +\par +\ref ss_hrdwr_ptt "PTT RT CHAN"   \|   +\ref ss_hrdwr_serial "SERIAL PORT"   \|   +\ref ss_hrdwr_device "DEVICE"   \|   +\ref ss_hrdwr_rts "RTS"   \|   +\ref ss_hrdwr_dtr "DTR"   \|   +\ref ss_hrdwr_rtsv "RTSV"   \|   +\ref ss_hrdwr_dtrv "DTRV"   \|   +\ref ss_hrdwr_spttd "START PTT DELAY"   \|   +\ref ss_hrdwr_epttd "END PTT DELAY"   \|   +\ref ss_hrdwr_uhr "UHROUTER"   \|   +\ref ss_hrdwr_pp "PARALLEL"   \|   +\ref ss_hrdwr_init "INIT" + +\ref ss_rigcat "RIGCAT" +\par +\ref ss_rigcat_state "STATE"   \|   +\ref ss_rigcat_df "DESC FILE"   \|   +\ref ss_rigcat_dp "DEV PATH"   \|   +\ref ss_rigcat_retry "RETRIES"   \|   +\ref ss_rigcat_rint "RETRY INT"   \|   +\ref ss_rigcat_wd "WDELAY"   \|   +\ref ss_rigcat_id "IDELAY"   \|   +\ref ss_rigcat_br "BRATE"   \|   +\ref ss_rigcat_sb "SBITS"   \|   +\ref ss_rigcat_echo "ECHO"   \|   +\ref ss_rigcat_trts "TOGGLE RTS PTT"   \|   +\ref ss_rigcat_tdtr "TOGGLE DTR PTT"   \|   +\ref ss_rigcat_restore "RESTORE"   \|   +\ref ss_rigcat_pttc "PTT COMMAND"   \|   +\ref ss_rigcat_rtsv "RTS 12V"   \|   +\ref ss_rigcat_dtrv "DTR 12V"   \|   +\ref ss_rigcat_hfc "HRDWR FC"   \|   +\ref ss_rigcat_vsp "VSP"   \|   +\ref ss_rigcat_init "INIT" + +\ref ss_hamlib "HAMLIB" +\par +\ref ss_hamlib_s "STATE"   \|   +\ref ss_hamlib_r "RIG"   \|   +\ref ss_hamlib_dp "DEV PATH"   \|   +\ref ss_hamlib_r "RETRIES"   \|   +\ref ss_hamlib_ri "RETRY INT"   \|   +\ref ss_hamlib_wd "WDELAY"   \|   +\ref ss_hamlib_pwd "PWDELAY"   \|   +\ref ss_hamlib_br "BRATE"   \|   +\ref ss_hamlib_sbits "SBITS"   \|   +\ref ss_hamlib_sband "SBAND"   \|   +\ref ss_hamlib_pttc "PTT COMMAND"   \|   +\ref ss_hamlib_dtrv "DTR 12V"   \|   +\ref ss_hamlib_rtsv "RTS 12V"   \|   +\ref ss_hamlib_hfc "HRDWR FC"   \|   +\ref ss_hamlib_sfc "SFTWR FC"   \|   +\ref ss_hamlib_ac "ADV CONF"   \|   +\ref ss_hamlib_init "INIT" + +\ref ss_xmlrpc_rc "XMLRPC RC" +\par +\ref ss_xmlrpc_s "STATE"   \|   +\ref ss_xmlrpc_bwd "BWDELAY"   \|   +\ref ss_xmlrpc_init "INIT" + +\ref ss_io "IO" +\par +\ref ss_io_lock "LOCK"   \|   +\ref ss_io_port "PORT"   \|   +\ref ss_io_csma "CSMA"   \|   +\ref ss_io_kiss "KISS"   \|   +\ref sss_io_kiss_ipa "KISS.IPA"   \|   +\ref sss_io_kiss_iopa "KISS.IOPN"   \|   +\ref sss_io_kiss_opn "KISS.OPN"   \|   +\ref sss_io_kiss_dp "KISS.DP"   \|   +\ref sss_io_kiss_busy "KISS.BUSY"   \|   +\ref sss_io_kiss_cont "KISS.CONT"   \|   +\ref sss_io_kiss_atten "KISS.ATTEN"   \|   +\ref ss_io_arq "ARQ"   \|   +\ref sss_io_arq_ipa "ARQ.IPA"   \|   +\ref sss_io_arq_iopn "ARQ.IOPN"   \|   +\ref ss_io_xmlrpc "XMLRPC"   \|   +\ref sss_io_xmlrpc_ipa "XMLRPC.IPA"   \|   +\ref sss_io_xmlrpc_iopn "XMLRPC.IOPN" + +\ref s_nbems "MISC NBEMS" +\par +\ref ss_nbems_timeout "TIMEOUT"   \|   +\ref ss_nbems_open_brwsr "OPEN BRWSR"   \|   +\ref ss_nbems_state "STATE"   \|   +\ref ss_nbems_open_msg "OPEN MSG"   \|   +\ref ss_nbems_open_flmsg "OPEN FLMSG"   \|   +\ref ss_nbems_flmsg_path "PATH" + +\ref s_id "ID" +\par +\ref sss_notify "RSID.NOTIFY"   \|   +\ref sss_search_bandpass "RSID.SRCH BP"   \|   +\ref sss_mark_prev_mode "RSID.MARK PREV"   \|   +\ref sss_detector "RSID.DETECTOR"   \|   +\ref sss_dialog_box "RSID.ALRT DIALOG"   \|   +\ref sss_tx_freq_lock "RSID.TX FREQ LOCK"   \|   +\ref sss_disable_freq_change "RSID.FREQ CHANGE"   \|   +\ref sss_rsid_error_level "RSID.ALLOW ERRORS"   \|   +\ref sss_open_squelch "RSID.SQL OPEN"   \|   +\ref sss_pretone "RSID.PRETONE"   \|   +\ref sss_end_of_xmit_id "RSID.END XMT ID"   \|   +\ref sss_id_mode "VIDEO.ID MODE"   \|   +\ref sss_ed_video_text "VIDEO.VIDEO TXT"   \|   +\ref sss_input_video_text "VIDEO.TEXT INPUT"   \|   +\ref sss_small_font "VIDEO.SMALL FONT"   \|   +\ref sss_500hz_limit "VIDEO.500HZ"   \|   +\ref sss_mode_limit "VIDEO.WIDTH LIMIT"   \|   +\ref sss_char_row "VIDEO.CHAR ROW"   \|   +\ref sss_cw_id "CW.TX CALL"   \|   +\ref sss_id_mode "CW.DETECTOR"   \|   +\ref sss_cw_id_speed "CW.SPEED"   \|   + + +\ref ss_load_macro "MACRO" + +
+

+\section sScriptSyntax 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. + +\subsection ssStucturedCommands 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. + + +\:
+   \:\
+   \:\
+END:
+ + +\subsection ssHierarchyCommands 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. + + +\.\,...:\
+\.\,...:\
+ + +\subsection ssParameters Parameters + +Parameter content varies on the command used. The various parameters types are: +
+
    +
  • Integers (whole numbers, ie 0, 10, 100, 234).
    • +
  • Real Numbers (floating point numbers, ie 1.2, 10.3).
    • +
  • Characters Strings (one or more words, "Madison, AL", "Toney, AL").
    • +
+ +\subsection ssScriptFiles 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. + +
    +
  • The first line in the script file must contain \"FLDIGI_CONFIG\" tag. +This is used to verify the "text" file is a configuration script for +FLDIGI. If it's not present the file will not be processed.
    • + +
  • One command : parameter pair per line.
    • + +
  • Command indentations with spaces or tabs are not required (cosmetic).
    • + +
  • Parameters are separated by a comma ','.
    • + +
  • Parameters regardless of type can be encapsulated in quotes \(\" \"\). However, + if a parameter contains spaces or commas it must be encapsulated.
    • + +
  • One or more commands per file.
    • + +
  • One or more empty lines per file.
    • . + +
  • Any text entry after the '#' pound sign is considered a 'comment' and will be + ignored.
    • +
+ +\par 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
+ +
+\section ss_fldigi FLDigi Commands + +See \ref operating_controls_page + +\subsection sss_freq Frequency Control + +Sets the RF Carrier frequency (effects rig control). + +FREQ:\ + +\ values are entered directly or as exponential notation. The +following frequencies represent the same frequency value. + +Frequency Value = Parameter Syntax + +
    +
  • 14.070 MHz = 14.070e+06
    • +
  • 14070.00 KHz = 14070.0e+03 - Using this exponent magnitude represents the + scale of the frequency display
    • +
  • 14070000 Hz = 14070000 - Directly in Hz
    • +
+ +\subsection sss_mode Mode + +Sets the rig modulation mode (ie. USB, LSB, FM, etc). The actual values are +dependent on the rig and the interface used. + +MODE:\ + +\subsection sss_wfhz Waterfall Offset (Hz) + +Sets the audio tone offset in the waterfall. + +WFHZ:\ + +Valid values range from 0 - 4000 +/- 50% of the bandwidth needed for the +selected modem. + +\subsection sss_rxid RxID + +Enable or disable the use of RSID reception. + +RXID:\ + +\subsection sss_txid TxID + +Enable or disable the use of RSID transmission. + +TXID:\ + +\subsection sss_spot Spot + +Enable or disable the use of the PSKreporter mechanism. + +SPOT:\ + +\subsection sss_rev 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:\ + +\subsection sss_afc AFC + +Enable or disable the use of Automatic Frequency Control. + +AFC:\ + +\subsection sss_lock Lk + +Enable or disable the use of frequency lock. The behavior of this feature +can be altered depending on the settings of the \ref id_configuration_page +panel. + +LOCK:\ + +\subsection sss_sql SQL + +Enable or disable the use of the squelch. + +SQL:\ + +\subsection sss_kpsql KPSQL + +Enable or disable the use of the KISS power squelch. This option is only +available when KISS IO interface option is selected. + +See \ref config_io_page + +KPSQL:\ + +\subsection sss_modem 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 \ref mode_table_page +under 'mode' column for proper modem parameter syntax. + +MODEM:\ + +\subsection sss_fldigi_examples 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 | + +
+\section ss_operator Operator Commands + +See \ref operator_configuration_page + +\subsection sss_callsign Callsign: + +OPERATOR.CALLSIGN:\ + +\subsection sss_name Name: + +OPERATOR.NAME:\ + +\subsection sss_qth QTH: + +OPERATOR.QTH:\ + +\subsection sss_loc Locator: + +Maidenhead Grid Locator. A series of alpha +numerical characters representing a position on earth. + +OPERATOR.LOC:\ + +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 + +\subsection sss_ant Operators Antenna Description + +OPERATOR.ANT:\ + +\subsection sss_op_examples 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" | + +
+\section ss_audio_device Audio Device Commands + +See \ref sound_card_configuration_page + +\subsection sss_oss OSS + +Enable or disable OSS. This option is not available on all operating systems. + +OSS:\ + +\subsection sss_dev_path Device: + +OSS DEV:\ + +Parameter:/dev/path + +\subsection sss_portaudio PortAudio + +Enable or disable Port Audio. This option may or may not be available to all +operating systems. + +PA:\ + +\subsection sss_portaudio_playback Playback: + +The device name is specific to the hardware installed. + +PA PLAYBACK:\,\ + +Parameter:Menu Index, Device Name + +\par 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. + +\subsection sss_portaudio_capture Capture: + +The device name is specific to the hardware installed. + +PA CAPTURE:\,\ + +\par 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 + +\subsection sss_pua PulseAudio + +Enable or disable Pulse Audio. This option is not available on all operating systems. + +PUA:\ + +\subsection sss_pua_srvr Server string: + +PUA SERVER:\ + +Parameter: See Note: † below. + +\subsection sss_ad_examples 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:† | + +\par Note: † Pulse Audio Server Strings +Pulse audio server string information can be found here: +
+http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/ServerStrings/ + +
+\section ss_audio_settings Audio Settings + +See \ref sound_card_configuration_page + +\subsection sss_audio_capture_sample_rate Capture Audio Sample Rate + +Set the input signal sample rate. The sample rate availability is dependent +on the ADC hardware. + +Auto, Native, 8000,... + +CAPTURE:\ + +\subsection sss_audio_playback_sample_rate Playback Audio Sample Rate + +Set the output signal sample rate. The sample rate availability is dependent +on the DAC hardware. + +Auto, Native, 8000,... + +PLAYBACK:\ + +\subsection sss_audio_converter Converter + +CONVERTER:\ Best, Medium, Fastest, Linear + +\subsection sss_rx_ppm Receive Audio PPM Correction + +RX PPM:\ negative, 0, positive values + +\subsection sss_tx_ppm Transmit Audio PPM Correction + +TX PPM:\ negative, 0, positive values + +\subsection sss_tx_offset Transmit Audio Hertz Offset Correction + +TX OFFSET:\ negative, 0, positive values (Hertz) + +\subsection sss_as_examples 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 | + +
+\section ss_audio_rt_channel Audio Right Channel Commands + +See \ref right_chanel_audio + +\subsection sss_rt_mono Mono audio output + +Enable or disable monophonic signal output. + +MONO AUDIO:\ + +\subsection sss_rt_mono_lr Modem signal on left and right channels + +Enable or disable audio signal to both left and right channels + +MODEM LR:\ + +\subsection sss_rt_mono_rev Reverse Left/Right channels + +Enable or disable audio signal reversal on Left/Right channels. + +REV LR:\ + +\subsection sss_rt_mono_ptt PTT tone on right audio channel + +Enable or disable PTT use by suppling a signal on the right channel. + +PTT RT CHAN:\ + +\subsection sss_rt_mono_qsk CW QSK signal on right channel + +QSK RT CHAN:\ + +\subsection sss_rt_mono_fsk Pseudo-FSK on right audio channel + +FSK RT CHAN:\ + +\subsection sss_rtch_examples 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 | + +
+\section ss_audio_wave_sr Wav write sample rate + +See \ref wav_file_sample_rate + +Sets the record wave file sample rate. + +AUDIO WAVE.SRATE:\ + +Available Parameters: 8000, 11025, 16000, 22050, 24000, 44100, 48000 + +| Structured | Dot Notation | +|:-----------|:-------------| +| AUDIO WAVE:
SRATE:16000
END: | AUDIO WAVE.SRATE:16000 | + +
+\section ss_rig_hrdwr_ptt Hardware PTT Option Commands + +See \ref rig_config + +\subsection ss_hrdwr_ptt PTT tone on right audio channel + +PTT RT CHAN:\ + +\subsection ss_hrdwr_serial Use separate serial port PTT + +SERIAL PORT:\ + +\subsection ss_hrdwr_device Device: + +DEVICE:\ + +Parameter: A device path (/dev/ptt) + +\subsection ss_hrdwr_rts Use RTS + +RTS:\ + +\subsection ss_hrdwr_dtr Use DTR + +DTR:\ + +\subsection ss_hrdwr_rtsv RTS = +V + +RTSV:\ + +\subsection ss_hrdwr_dtrv DTR = +V + +DTRV:\ + +\subsection ss_hrdwr_spttd PTT delays valid for all CAT/PTT types + +START PTT DELAY:\ + +\subsection ss_hrdwr_epttd PTT delays valid for all CAT/PTT types + +END PTT DELAY:\ + +\subsection ss_hrdwr_uhr Use uHRouter PTT + +UHROUTER:\ + +\subsection ss_hrdwr_pp Use parallel port PTT + +PARALLEL:\ + +\subsection ss_hrdwr_init Initialize Changes + +INIT: + +\subsection ss_hrdwr_examples 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: | + +
+\section ss_rigcat RIGCAT Commands + +See \ref rig_cat_control + +\subsection ss_rigcat_state Use RigCAT + +STATE:\ + +\subsection ss_rigcat_df Rig description file: + +DESC FILE:\ + +Parameter:/directory/path/file.xml + +\subsection ss_rigcat_dp Device: + +DEV PATH:\ + +Parameter:/dev/path + +\subsection ss_rigcat_retry Retries + +RETRIES:\ + +\subsection ss_rigcat_rint Retry interval (ms) + +RETRY INT:\ + +\subsection ss_rigcat_wd Write delay (ms) + +WDELAY:\ + +\subsection ss_rigcat_id Init delay (ms) + +IDELAY:\ + +\subsection ss_rigcat_br Baud rate: + +BRATE:\ + +\subsection ss_rigcat_sb Stopbits + +SBITS:\ + +\subsection ss_rigcat_echo Commands are echoed + +ECHO:\ + +\subsection ss_rigcat_trts Toggle RTS for PTT + +TOGGLE RTS PTT:\ + +\subsection ss_rigcat_tdtr Toggle DTR for PTT + +TOGGLE DTR PTT:\ + +\subsection ss_rigcat_restore Restore Settings on Close + +RESTORE:\ + +\subsection ss_rigcat_pttc CAT command for PTT + +PTT COMMAND:\ + +\subsection ss_rigcat_rtsv RTS +12 v + +RTS 12V:\ + +\subsection ss_rigcat_dtrv DTR +12 v + +DTR 12V:\ + +\subsection ss_rigcat_hfc RTS/CTS flow control + +HRDWR FC:\ + +\subsection ss_rigcat_vsp VSP Enable + +VSP:\ + +\subsection ss_rigcat_init Initialize Changes + +INIT: + +\subsection ss_rigcat_examples 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: | + +
+\section ss_hamlib HAMLIB Commands + +See \ref hamlib_cat_control + +\subsection ss_hamlib_s Use Hamlib + +Enable to disable Hamlib Rig Control interface. + +STATE:\ + +\subsection ss_hamlib_r Rig: + +Set the rig to control. The list of Rigs are derived from internal list +provided by HAMLIB. + +RIG:\ + +Parameter: HAMLIB Device Names + +\subsection ss_hamlib_dp Device: + +The device path for controlling the Rig. + +DEV PATH:\ + +Parameter:Device path + +\subsection ss_hamlib_retries Retries + +The number of tries at sending commands to the Rig + +RETRIES:\ + +\subsection ss_hamlib_ri Retry Interval (ms) + +RETRY INT:\ + +\subsection ss_hamlib_wd Write delay (ms) + +WDELAY:\ + +\subsection ss_hamlib_pwd Post write delay (ms) + +PWDELAY:\ + +\subsection ss_hamlib_br Baud rate: + +BRATE:\ + +\subsection ss_hamlib_sbits Stopbits + +SBITS:\ + +\subsection ss_hamlib_sband Sideband: + +SBAND:\ + +\subsection ss_hamlib_pttc PTT via Hamlib command + +PTT COMMAND:\ + +\subsection ss_hamlib_dtrv DTR +12 + +DTR 12V:\ + +\subsection ss_hamlib_rtsv RTS +12 + +RTS 12V:\ + +\subsection ss_hamlib_hfc RTS/CTS flow control + +HRDWR FC:\ + +\subsection ss_hamlib_sfc XON/XOFF flow control + +SFTWR FC:\ + +\subsection ss_hamlib_ac Advanced configuration: + +ADV CONF:\ + +\subsection ss_hamlib_init Initialize Changes + +INIT: + +Parameters: None + +\subsection ss_hamlib_examples 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: | + + +
+\section ss_xmlrpc_rc XMLRPC Rig Control Commands + +See \ref xml_rpc_cat + +\subsection ss_xmlrpc_s Use XML-RPC program + +STATE:\ + +\subsection ss_xmlrpc_bwd Mode/BW delay + +BWDELAY:\ + +\subsection ss_xmlrpc_init Initialize Changes + +INIT: + +Parameters: None + +\subsection ss_xmlrpc_example 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: | + + +
+\section ss_io IO + +See \ref config_io_page + +\subsection ss_io_lock Lock + +Used to lock the panel from user GUI access. Has no effect on script commands. + +LOCK:\ + +\subsection ss_io_port Enable ARQ or KISS IO Access + +Select the active IO port for data operation between programs. + +PORT:\ + +Parameters: + +ARQ: Used to control the FL Suite of auxiliary programs. + +KISS: KISS protocol over UDP/IP interface + +\subsection ss_io_ax25d AX25 Decode + +Enable or disable Ax25 decoding. Only available when the KISS IO port is +active. + +AX25D:\ + +\subsection ss_io_csma Enable CSMA + +Enable or disable Carrier Sense Multiple Access. Only available when the +KISS IO port is active. + +CSMA:\ + +\subsection ss_io_kiss KISS Sub Command + +KISS related sub commands. + +\subsubsection sss_io_kiss_ipa IP Address + +IP address for program to program communication + +IPA:\ + +\subsubsection sss_io_kiss_iopa I/O + +IP address I/O port number for program to program communication + +IOPN:\ + +\subsubsection sss_io_kiss_opn O + +IP address Output port number for program to program communication. Required +when FLDigi and auxiliary programs reside on the same host. + +OPN:\ + +\subsubsection sss_io_kiss_dp Dual Port + +Enable or disable the use of dual port io. + +DP:\ + +\subsubsection sss_io_kiss_busy Enable Busy Channel + +Enable or disable busy channel. Allows for the cooperative use of the +frequency. + +BUSY:\ + +\subsubsection sss_io_kiss_cont Continue After (sec) + +The number of seconds the frequency must be clean clear before transmissions +resume. Enabled by busy channel activation. + +CONT:\ + +\subsubsection sss_io_kiss_atten 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:\ + +\subsection ss_io_arq ARQ Sub Command + +ARQ sub commands + +\subsubsection sss_io_arq_ipa IP Address + +IP address for program to program communication + +IPA:\ + +\subsubsection sss_io_arq_iopn Port + +IP address I/O port number for program to program communication + +IOPN:\ + +\subsection ss_io_xmlrpc XMLRPC Sub Command + +\subsubsection sss_io_xmlrpc_ipa IP Address + +IP address for program to program communication + +IPA:\ + +\subsubsection sss_io_xmlrpc_iopn Port + +IP address I/O port number for program to program communication + +IOPN:\ + +\subsection sss_io_example 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 | + +
+\section s_nbems Misc NBEMS Commands + +See \ref subsec_nbems_flxxx_interface + +\subsection ss_nbems_state Enable + +NBEMS data file interface + +STATE:\ + +\subsection ss_nbems_open_msg Open message folder + +OPEN MSG:\ + +\subsection ss_nbems_open_flmsg Open with flmsg + +OPEN FLMSG:\ + +\subsection ss_nbems_flmsg_path FLMsg executable path + +PATH:\ + +Parameter: Directory and file name to the executable file location. + +\subsection ss_nbems_open_brwsr Open in browser + +OPEN BRWSR:\ + +\subsection ss_nbems_timeout Timeout (secs) + +TIMEOUT:\ + +\subsection ss_nbems_examples 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 | + +\section s_id ID + +See \ref id_configuration_page + +\subsection ss_id_rsid RsID + +\subsubsection sss_notify Notify only + +Notify operator of RSID reception, disabling waterfall, frequency, and +modem changes. + +NOTIFY:\ + +\subsubsection sss_search_bandpass Searches passband + +Search the entire band pass for RSID signatures (Enabled). Otherwise search +center frequency +/- 200Hz + +SRCH BP:\ + +\subsubsection sss_mark_prev_mode Mark prev freq/mode + +Annotate on receive panel previous frequency and modem on RSID reception. + +MARK PREV:\ + +\subsubsection sss_detector Disables detector + +Ignore RSID tone sequence. + +DETECTOR:\ + +\subsubsection sss_dialog_box Disable alert dialog + +Display Dialog box indicating reception of RSID tone sequence (Enabled). + +ALRT DIALOG:\ + +\subsubsection sss_tx_freq_lock Retain tx freq lock + +Retain frequency/waterfall transmit position on modem switches (enabled). + +TX FREQ LOCK:\ + +\subsubsection sss_disable_freq_change Disable freq change + +Do not change frequency when RSID tones received. + +FREQ CHANGE:\ + +\subsubsection sss_rsid_error_level Allow errors + +Adjust RSID reception accuracy at the expense of sensitivity. + +ALLOW ERRORS:\ + +Parameters: Low, Medium, High + +\subsubsection sss_open_squelch Squelch open (sec) + +On RSID reception disable squelch for n seconds. + +SQL OPEN:\ + +Parameters: 0 - 20 + +\subsubsection sss_pretone Pre-Signal Tone Seconds + +On RSID reception disable squelch for n seconds. + +PRETONE:\ + +Parameters: 0.0 - 10.0 in 0.1/1.0 increments + +\subsubsection sss_end_of_xmit_id End of xmt ID + +Transmit an RSID tone sequence at the end of the data transmission. + +END XMT ID:\ + +\subsection ss_id_video Video + +\subsubsection sss_id_mode Transmit mode ID + +Enable/Disable the transmission of video text modem name. + +ID MODE:\ + +\subsubsection sss_ed_video_text Transmit video text + +Enable/Disable the transmission of custom video text. + +VIDEO TXT:\ + +\subsubsection sss_input_video_text Custom Video Text Input + +Enable/Disable the transmission of custom video text. + +TEXT INPUT:\ + +\subsubsection sss_small_font Use small font + +Enable/Disable the of small font for video text. + +SMALL FONT:\ + +\subsubsection sss_500hz_limit 500 Hz limit + +Enable/Disable 500 Hz video width limit + +500HZ:\ + +\subsubsection sss_mode_limit Mode width limit + +Enable/Disable video width limit based on modem bandwidth use. + +WIDTH LIMIT:\ + +\subsubsection sss_char_row Chars/Row: + +Maximum number of video text character per "line" + +CHAR ROW:\ + +Parmeters: 1 - 8 Characters + +\subsection ss_id_cw CW + +\subsubsection sss_cw_id Transmit callsign + +Enable/Disable post callsign CW ID + +TX CALL:\ + +\subsubsection sss_cw_id_speed Speed (WPM): + +Enable/Disable post callsign CW ID transmit speed + +SPEED:\ + +Parameters: 15 - 40 WPM + +\par NOTE: +Check the specifications imposed by your country on the maximum +speed allowing for CW identifing. + +\subsection ss_id_rsid_examples 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 | + +
+\section ss_load_macro Load Macro Command + +See \ref macro_page + +The Macro command is a structured command only, dot notation is not supported. + + +MACRO,row,column,label
+\
+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 \ref macro_display_symbols for special +label glyphs. + +No syntax checking is performed for the macro content. User responsibility. + +\image html macrobuttons.png "Macro Bar" +\image latex macrobuttons.png "Macro Bar" width=4.0in + +The following example sets the first button in the first macro bar as seen above. + +\verbatim +MACRO:1,1,"CQ @>|" + +cq cq cq de pse k + +END: +\endverbatim + +
+\section sExampleScript Example Script + +\par NOTE: +This example script may report errors if used as is. Modification is required +to meet your particular setup. + +\verbatim +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" + +cq cq cq de /qrp pse k + +END: + +MACRO:1,2,"ANSWER" + de kn + +END: +\endverbatim + +
+\ref configure_script_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/copy-images.sh b/fldigi_doxygen/user_src_docs/copy-images.sh new file mode 100755 index 00000000..da460633 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/copy-images.sh @@ -0,0 +1,31 @@ +#!/bin/bash + + +cp images/event-log-debug.png ../user_docs/latex/event-log-debug.png +cp images/event-log-error.png ../user_docs/latex/event-log-error.png +cp images/event-log-info.png ../user_docs/latex/event-log-info.png +cp images/event-log-quiet.png ../user_docs/latex/event-log-quiet.png +cp images/event-log-verbose.png ../user_docs/latex/event-log-verbose.png +cp images/event-log-warning.png ../user_docs/latex/event-log-warning.png +cp images/digiscope-psk-nosig.png ../user_docs/latex/digiscope-psk-nosig.png +cp images/digiscope-psk.png ../user_docs/latex/digiscope-psk.png +cp images/digiscope-psk-low.png ../user_docs/latex/digiscope-psk-low.png +cp images/digiscope-psk-high.png ../user_docs/latex/digiscope-psk-high.png +cp images/digiscope-psk-history.png ../user_docs/latex/digiscope-psk-history.png +cp images/digiscope-psk-history-amplitude.png ../user_docs/latex/digiscope-psk-history-amplitude.png +cp images/wwv3.png ../user_docs/latex/wwv3.png +cp images/wwv1-lgneg.png ../user_docs/latex/wwv1-lgneg.png +cp images/wwv2-000ppm.png ../user_docs/latex/wwv2-000ppm.png +cp images/wwv2-lgpos.png ../user_docs/latex/wwv2-lgpos.png +cp images/wwv2-125ppm.png ../user_docs/latex/wwv2-125ppm.png +cp images/dcf77-0.png ../user_docs/latex/dcf77-0.png +cp images/dcf77-0zoom.png ../user_docs/latex/dcf77-0zoom.png +cp images/dcf77-1000.png ../user_docs/latex/dcf77-1000.png +cp images/dcf77-65zoom.png ../user_docs/latex/dcf77-65zoom.png +cp images/RWMpre-cal.png ../user_docs/latex/RWMpre-cal.png +cp images/RWM+25361ppm.png ../user_docs/latex/RWM+25361ppm.png +cp images/RWMpost-cal-x5.png ../user_docs/latex/RWMpost-cal-x5.png + + + + diff --git a/fldigi_doxygen/user_src_docs/execmacro.txt b/fldigi_doxygen/user_src_docs/execmacro.txt new file mode 100644 index 00000000..f4423b10 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/execmacro.txt @@ -0,0 +1,234 @@ +/** +\page exec_macro_page Exec Macro + +\tableofcontents + +The \ ... \ macro is designed to be used on the +Linux OS as it supports fully functional pipes. Windows' version +of file pipes is not fully POSIX compliant, but the function might work +in the environment. Consider all that the following allows you to +do from within fldigi and you might want to consider changing over to +Linux.The \ macro defines an external child process (or +processes) that will be called by fldigi when the macro key is invoked. +
+ +\section export_variables Exported variables + +Fldigi exports a set of variables to the child process and +adds ~/.fldigi/scripts to the PATH variable before running the shell +code. This is the directory location for all executable scripts +and programs which you might want to call from within the macro. Some +examples will be given later. Open the macro editor for an undefined macro +key and enter the following: +
+ +\verbatim +env | grep FLDIGI +\endverbatim +
+ +Save the macro; call it ENV. Then press the newly defined macro key. All +of the exported variables will be shown in the transmit window. +
+ +Here is an example of the results: +
+ +FLDIGI_RX_IPC_KEY=9876 +
+FLDIGI_LOG_LOCATOR=FM02BT +
+FLDIGI_TX_IPC_KEY=6789 +
+FLDIGI_LOG_RST_IN= +
+FLDIGI_LOG_FREQUENCY=3581.000 +
+FLDIGI_AZ=108 +
+FLDIGI_MY_CALL=W1HKJ +
+FLDIGI_LOG_TIME=2113 +
+FLDIGI_MY_NAME=Dave +
+FLDIGI_VERSION=3.0preG +
+FLDIGI_LOG_NOTES= +
+FLDIGI_LOG_QTH=Mt Pleasant, SC +
+FLDIGI_MY_LOCATOR=EM64qv +
+FLDIGI_DIAL_FREQUENCY=3580000 +
+FLDIGI_CONFIG_DIR=/home/dave/.fldigi/ +
+FLDIGI_LOG_RST_OUT= +
+FLDIGI_MODEM=BPSK31 +
+FLDIGI_LOG_CALL=KH6TY +
+FLDIGI_MODEM_LONG_NAME=BPSK-31 +
+FLDIGI_AUDIO_FREQUENCY=1000 +
+FLDIGI_LOG_NAME=Skip +
+FLDIGI_PID=14600 +
+FLDIGI_FREQUENCY=3581000 +
+ +All of the above envelope variables can be referenced in a shell script that +is called from within fldigi. +
+ +\section detecton_of_scripts Detection of existing scripts + +In anticipation of a collection of useful "fldigi scripts", the +macro browser contains a \ \ macro line for each +executable file found in the scripts directory. The EXEC macro allows the +text that is read from the child process to be +parsed for more fldigi macros. For example, try this macro: +
+ +\verbatim +cat foo +\endverbatim + +where foo is a file that contains: +
+ +\verbatim + +\endverbatim + +This may have some interesting uses but, if it is undesirable, it can be +suppressed with an extra layer of redirection. Instead of +\command\, you would +use \noexp command\ where noexp is +the following very simple script: + +\verbatim +snip--------------------------------------- +#!/bin/bash +echo -n "" +"$@" # run the command +r=$? # save its exit code +echo -n "" +exit $? +snip--------------------------------------- +\endverbatim + +There are three additional MACRO definitions that expand the capability of +the \ command: \, \ and \. +The \ and \ macros stop and resume the expansion of all +\ strings. For +example, \\\\ +would only expand the second \. + +By wrapping the command output in this way we can be sure that +no text will be expanded. You might even use +
+ +\verbatim +"$@" | sed "s///g" +\endverbatim +
+ +if you feel paranoid. You can "fork and forget" with an exec macro defined +as: \exec command -args \>/dev/null\ + +Any of the text that appears between the \ and \ can +reference an executable program or shell command found in the +~/.fldigi/scripts directory. + +Any text output that is returned by the program or script program (or the +result of the in-line command) is always returned to the transmit +buffer and appears as appended to the transmit window. + + +\section querying_database Querying an external database + +The \ command captures returned text from the external process and +parses it for the following content: + +$NAMEtext_name$QTHtext_qth + +If either $NAME or $QTH is present the trailing text is transferred to the +LOG_NAME or LOG_QTH widgets respectively. This means that you can create a +script that accesses a local or net based database of callsign data and +parse that data to form the above console output. Fldigi will accept that +output, parse it and populate the associated log entries. Cool! Now +for some examples. Here is a perl script that performs the above for +the University of Arkansas on-line callsign database, +\ref ualr_telnet_page "ualr-telnet". The matching macro +key definition for the above is: + +\verbatim +ualr-telnet.pl $FLDIGI_LOG_CALL +\endverbatim + +which I named "ualr ?" + +\section google_earth_map Google Earth Map + +Here is a really cool perl script, \ref google_maps "Google Earth Mapping", +that accepts the current "Loc" field in the logging area and generates +a Google Earth map which is displayed in your default browser. + +The macro call is: + +\verbatim +map.pl +\endverbatim + +\section custom_dates_times Custom dates/times + +You can use \ to create custom date/time entries. For +example, BARTG contesters use %H%M, but in other circumstances a user +might prefer %H:%M or %H.%M etc. +Create the following script file in the ~/.fldigi/scripts directory, call it mytime: + +\verbatim +snip--------------------------------------- +#!/bin/sh +date --utc "+%H:%M" +snip--------------------------------------- +\endverbatim + +date calls strftime, the same C function used by fldigi for the ZDT/LDT +expansion, so it has an equally vast number of format strings to choose +from. Look for them in its manual page. + +Give "mytime" execute permissions with a file manager or with chmod: + chmod u+x ~/.fldigi/scripts/mytime. + +Test it on the command line and make sure it works correctly: + ~/.fldigi/scripts/mytime + +Restart fldigi. The mytime script will now appear at the end of the list in the +macro browser, and can be entered with the \<\< button as usual. +Test that macro and you will see that \mytime\ +inserts the datetime in the specified format. +Of course you could have entered: +
+ +\verbatim +date --utc "+%H:%M" +\endverbatim + +in the macro body text directly Many other uses for the \...\ macro pair +can be imagined when used the with ENV parameters. For example you could send +Azimuth data to an automated antenna rotor. The exported variables should be +sufficient for a script writer to create custom loggers and clients. + +
+\ref exec_macro_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/fldigi_configuration.txt b/fldigi_doxygen/user_src_docs/fldigi_configuration.txt new file mode 100644 index 00000000..844c2d6f --- /dev/null +++ b/fldigi_doxygen/user_src_docs/fldigi_configuration.txt @@ -0,0 +1,104 @@ +/** +\page configuration_page Configuration + +\tableofcontents + +The first time you execute fldigi you should resize the main window to +suit your screen dimensions. Then adjust the divider line +between the Rx and Tx text widgets.. +
+ +Fldigi contains many configurable items, to specify operator data, user +interface, and modem characteristics. The application also saves +many state variables between executions. It will start up in the +state that it was last used.
+
+ +\section ui_configuation User Interface configuration + +You should initially configure the following: +
+ +
    +
  • \subpage operator_configuration_page
    • +
  • \subpage sound_card_configuration_page
    • +
  • \subpage rig_control_page
    • +
  • \subpage new_installation_page
    • +
  • \subpage config_io_page
    • +
+ +\section windows_install_config Windows Specific Install / Config + +
    +
  • \subpage installing_on_windows_page
    • +
  • \subpage wizard_page
    • +
+ +\section other_configuation_options Other Configuration options + +When the program receives and transmits digital signals and your rig control +is satisfactory then you can continue configuring other aspects of the +program: +
+ +
    +
  • \subpage callsign_db_configuration_page
    • +
  • \subpage colors_and_fonts_page
    • +
  • \subpage fft_scan_page
    • +
  • \subpage id_configuration_page
    • +
  • \subpage psk_mail_configuation_page
    • +
  • \subpage touch_page
    • +
  • \subpage ui_configuration_broswer_page
    • +
  • \subpage ui_configuration_contest_page
    • +
  • \subpage ui_configuration_general_page
    • +
  • \subpage ui_configuration_logging_page
    • +
  • \subpage ui_configuration_macros_page
    • +
  • \subpage ui_configuration_waterfall_controls_page
    • +
  • \subpage ui_configuration_waterfall_page
    • +
  • \subpage wefax_page
    • +
  • \subpage working_logs_page
    • +
+ +\section command_line_switches Command Line Switches + +Additional configurational items are available from the command line. + +See \ref command_line_switches_page "Command Line Switches" for details. + +\section modem_configuration_options Modem Configuration Options + +You can configure each modem type to suit your particular operating needs, +but the defaults should be satisfactory for most users. +
+ +
    +
  • \subpage contestia_configuration_page
    • +
  • \subpage cw_configuration_page
    • +
  • \subpage domino_ex_configuration_page
    • +
  • \subpage feld_hell_configuration_page
    • +
  • \subpage fsq_configuration_page
    • +
  • \subpage id_configuration_page
    • +
  • \subpage miscellaneous_configuration_page
    • +
  • \subpage mt63_configuration_page
    • +
  • \subpage olivia_configuration_page
    • +
  • \subpage psk_configuration_page
    • +
  • \subpage rtty_fsk_configuration_page
    • +
  • \subpage thor_configuration_page
    • +
+
+ + +When you have completed the configuration go to the Configure menu +and select Save config or press the "Save Config" button on the +configure dialog box. The program will write the +file ~/.fldigi/fldigi_def.xml. +
+ + +
+\ref configuration_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/fldigi_developer.txt b/fldigi_doxygen/user_src_docs/fldigi_developer.txt new file mode 100644 index 00000000..17ee0c4b --- /dev/null +++ b/fldigi_doxygen/user_src_docs/fldigi_developer.txt @@ -0,0 +1,16 @@ +/** +\page developers_page Developers + +
    +
  • \subpage build_info_page
    • +
  • \subpage google_maps
    • +
  • \subpage install_from_source_page
    • +
  • \subpage kiss_command_page
    • +
  • \subpage parse_ualr_page
    • +
  • \subpage pseudo_fsk_page
    • +
  • \subpage rig_xml_page
    • +
  • \subpage ualr_telnet_page
    • +
  • \subpage xmlrpc_control_page
    • +
+ +*/ diff --git a/fldigi_doxygen/user_src_docs/fldigi_interprocess_comms.txt b/fldigi_doxygen/user_src_docs/fldigi_interprocess_comms.txt new file mode 100644 index 00000000..9e81816d --- /dev/null +++ b/fldigi_doxygen/user_src_docs/fldigi_interprocess_comms.txt @@ -0,0 +1,14 @@ +/** +\page interprocess_communications_page Interprocess Communications + +
    +
  • \subpage contest_how_to_page
    • +
  • \subpage cw_keying_page
    • +
  • \subpage digiscope_display_page
    • +
  • \subpage digiscope_display_wwv_mode
    • +
  • \subpage dxcc_list_page
    • +
  • \subpage frequency_analyzer_page
    • +
  • \subpage keyboard_operation_page
    • +
+ +*/ diff --git a/fldigi_doxygen/user_src_docs/fldigi_logging.txt b/fldigi_doxygen/user_src_docs/fldigi_logging.txt new file mode 100644 index 00000000..86e8650f --- /dev/null +++ b/fldigi_doxygen/user_src_docs/fldigi_logging.txt @@ -0,0 +1,11 @@ +/** +\page logging_page Logging + +
    +
  • \subpage cabrillo_report_page
    • +
  • \subpage exporting_logbook_data
    • +
  • \subpage qso_log_book_page
    • +
  • \subpage ui_configuration_logging_page
    • +
+ +*/ diff --git a/fldigi_doxygen/user_src_docs/fldigi_macros.txt b/fldigi_doxygen/user_src_docs/fldigi_macros.txt new file mode 100644 index 00000000..f7716439 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/fldigi_macros.txt @@ -0,0 +1,12 @@ +/** +\page macro_page Macros + +
    +
  • \subpage macros_sub_page
    • +
  • \subpage inline_macro_page
    • +
  • \subpage at_macro_page
    • +
  • \subpage advanced_qsy_page
    • +
  • \subpage exec_macro_page
    • +
+ +*/ diff --git a/fldigi_doxygen/user_src_docs/fldigi_modems.txt b/fldigi_doxygen/user_src_docs/fldigi_modems.txt new file mode 100644 index 00000000..8c1be970 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/fldigi_modems.txt @@ -0,0 +1,25 @@ +/** +\page modems_page Modems + + +
    +
  • \subpage contestia_page
    • +
  • \subpage cw_page
    • +
  • \subpage domino_ex_page
    • +
  • \subpage feld_hell_page
    • +
  • \subpage fsq_page
    • +
  • \subpage mfsk_page
    • +
  • \subpage mt63_page
    • +
  • \subpage navtex_and_sitorb_page
    • +
  • \subpage olivia_page
    • +
  • \subpage psk_page
    • +
  • \subpage rtty_page
    • +
  • \subpage thor_page
    • +
  • \subpage throb_page
    • +
  • \subpage tune_page
    • +
  • \subpage wefax_page
    • +
  • \subpage wwv_tx_mode
    • +
  • \subpage mode_table_page
    • +
+ +*/ diff --git a/fldigi_doxygen/user_src_docs/fldigi_operating.txt b/fldigi_doxygen/user_src_docs/fldigi_operating.txt new file mode 100644 index 00000000..2e53909e --- /dev/null +++ b/fldigi_doxygen/user_src_docs/fldigi_operating.txt @@ -0,0 +1,31 @@ +/** +\page operating_page Operating + +
    +
  • \subpage contest_how_to_page
    • +
  • \subpage cw_keying_page
    • +
  • \subpage digiscope_display_page
    • +
  • \subpage digiscope_display_wwv_mode
    • +
  • \subpage dxcc_list_page
    • +
  • \subpage fft_scan_page
    • +
  • \subpage frequency_analyzer_page
    • +
  • \subpage keyboard_operation_page
    • +
  • \subpage kml_page
    • +
  • \subpage menus_page
    • +
  • \subpage mouse_and_keyboard_shortcuts_page
    • +
  • \subpage notifier_page
    • +
  • \subpage operating_controls_page
    • +
  • \subpage operating_multiple_copies_page
    • +
  • \subpage psk_reporter_page
    • +
  • \subpage rig_control_page
    • +
  • \subpage rst_rsq_page
    • +
  • \subpage signal_browser_page
    • +
  • \subpage supporting_data_files_page
    • +
  • \subpage synop_page
    • +
  • \subpage utf8_support_page
    • +
  • \subpage w5zit_rt_channel_page
    • +
  • \subpage working_logs_page
    • +
  • \subpage wwv_tx_mode
    • +
+ +*/ diff --git a/fldigi_doxygen/user_src_docs/global_file_ext_rename.txt b/fldigi_doxygen/user_src_docs/global_file_ext_rename.txt new file mode 100644 index 00000000..120af4d7 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/global_file_ext_rename.txt @@ -0,0 +1 @@ +find . -depth -type f -name "*.png.png" -exec sh -c 'mv "$1" "$(dirname "$1")/$(basename "$1" .png.png).png"' _ {} \; diff --git a/fldigi_doxygen/user_src_docs/global_tiff_file_convert_to.sh b/fldigi_doxygen/user_src_docs/global_tiff_file_convert_to.sh new file mode 100644 index 00000000..ce92459a --- /dev/null +++ b/fldigi_doxygen/user_src_docs/global_tiff_file_convert_to.sh @@ -0,0 +1,2 @@ +find . -depth -type f -name "*.tiff" -exec sh -c 'convert "$1" "$(dirname "$1")/$(basename "$1" .tiff).png"' _ {} \; +find . -depth -type f -name "*.tiff" -exec sh -c 'convert "$1" "$(dirname "$1")/$(basename "$1" .tiff).png"' _ {} \; diff --git a/fldigi_doxygen/user_src_docs/global_tiff_file_convert_to.txt b/fldigi_doxygen/user_src_docs/global_tiff_file_convert_to.txt new file mode 100644 index 00000000..ce92459a --- /dev/null +++ b/fldigi_doxygen/user_src_docs/global_tiff_file_convert_to.txt @@ -0,0 +1,2 @@ +find . -depth -type f -name "*.tiff" -exec sh -c 'convert "$1" "$(dirname "$1")/$(basename "$1" .tiff).png"' _ {} \; +find . -depth -type f -name "*.tiff" -exec sh -c 'convert "$1" "$(dirname "$1")/$(basename "$1" .tiff).png"' _ {} \; diff --git a/fldigi_doxygen/user_src_docs/hell.txt b/fldigi_doxygen/user_src_docs/hell.txt new file mode 100644 index 00000000..39ca8652 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/hell.txt @@ -0,0 +1,62 @@ +/** +\page feld_hell_page Hellschreiber + +\tableofcontents + +\section hell_modem Hellschreiber modem + +All Hellschreiber modes are based on character scanning, reproducing +characters in a similar way to a dot-matrix printer. This technique uses a +digital transmission, yet allows the received result to be interpreted by +eye, a similar concept to the reception of Morse by ear. The character is +scanned upwards, then left to right. There are typically 14 pixels +(transmitted dot elements) per column (although single pixels are never +transmitted) and up to seven columns per character including +inter-character space. +
+ +These remarkably simple modes are easy to use, easy to tune, and +although not especially sensitive, are entirely +suited to HF/VHF since they use no sync and the eye can discern the +text even in high levels of noise. fldigi can operate in the +following : + +\section hell_modes Hellschreiber modes + +
+ +Mode | Symbol Rate | Typing Speed | Duty Cycle | Bandwidth +:------------|:------------|:---------------------|:------|:-------- +Feld-Hell | 122.5 baud | ~ 2.5 cps (25 wpm) | ~ 22% | 350 Hz +Slow Hell | 14 baud | ~ 0.28 cps (2.8 wpm) | ~ 22% | 40 Hz +Feld-Hell X5 | 612.5 baud | ~ 12.5 cps (125 wpm) | ~ 22% | 1750 Hz +Feld-Hell X9 | 1102.5 baud | ~ 22.5 cps (225 wpm) | ~ 22% | 3150 Hz +FSK-Hell | 245 baud | ~ 2.5 cps (25 wpm) | ~ 80% | 490 Hz +FSK-Hell 105 | 105 baud | ~ 2.5 cps (25 wpm) | ~ 80% | 210 Hz +Hell 80 | 245 baud | ~ 5.0 cps (50 wpm) | 100% | 800 Hz + +
+ +\section hell_waterfall Hellschreiber Waterfall + +Feld-Hell look like this when being received by fldigi: +
+ +\image html feld-hell.png "Feld-Hell, Slow Hell, Feld-Hell X5, and Feld-Hell X9 are all pulse" +\image latex feld-hell.png "Feld-Hell, Slow Hell, Feld-Hell X5, and Feld-Hell X9 are all pulse" width=2.69in + +

Feld-Hell seems to be the most commonly used and use can usually be found +on 80 and 40 meters at the high end of the digital sub bands. Extreme +linearity is required in the transmit path in order to control the bandwidth +of the transmitted signal. Feld-Hell X5, Feld-Hell X9 and Hell 80 should +probably not be used on HF in the US. They can be used on VHF +and UHF.

+ +
+\ref feld_hell_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + + +*/ diff --git a/fldigi_doxygen/user_src_docs/imagetocopy.txt b/fldigi_doxygen/user_src_docs/imagetocopy.txt new file mode 100644 index 00000000..b4ccd7ff --- /dev/null +++ b/fldigi_doxygen/user_src_docs/imagetocopy.txt @@ -0,0 +1,31 @@ +Images to copy from script + + +event-log-debug.png +event-log-error.png +event-log-info.png +event-log-quiet.png +event-log-verbose.png +event-log-warning.png +digiscope-psk-nosig.png +digiscope-psk.png +digiscope-psk-low.png +digiscope-psk-high.png +digiscope-psk-history.png +digiscope-psk-history-amplitude.png +wwv3.png +wwv1-lgneg.png +wwv2-000ppm.png +wwv2-lgpos.png +wwv2-125ppm.png +dcf77-0.png +dcf77-0zoom.png +dcf77-1000.png +dcf77-65zoom.png +RWMpre-cal.png +RWM+25361ppm.png +RWMpost-cal-x5.png + + + + diff --git a/fldigi_doxygen/user_src_docs/index.txt b/fldigi_doxygen/user_src_docs/index.txt new file mode 100644 index 00000000..514b6151 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/index.txt @@ -0,0 +1,48 @@ +/****************************************************************************** + * Copyright (C) 2013 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 FLDIGI Users Manual - Version 3.22 +\anchor main_page + +
+\image latex FLDigiWindow.png "" width=4.0in +\image html FLDigiWindowHtml.png "" +
+ +\section fldigi_op_ins Fldigi Configuration and Operational Instructions + +
    +
  • \ref configuration_page
    • +
  • \ref modems_page
    • +
  • \ref operating_page
    • +
  • \ref logging_page
    • +
  • \ref macro_page
    • +
  • \ref configure_script_page
    • +
  • \ref developers_page
    • +
  • \ref license_page
    • +
  • \ref recognitions_page
    • +
+ +
+ +\ref main_page "Return to Top of Page" + +*/ + diff --git a/fldigi_doxygen/user_src_docs/index_order.txt b/fldigi_doxygen/user_src_docs/index_order.txt new file mode 100644 index 00000000..ba5ca7a3 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/index_order.txt @@ -0,0 +1,24 @@ +fldigi_configuration.txt fldigi_developer.txt fldigi_logging.txt \ +fldigi_macros.txt fldigi_modems.txt fldigi_operating.txt \ +New-Install.txt thumb_drive.txt colorsandfonts.txt \ +configcallsigndb.txt configContestia.txt configCW.txt \ +configDomEX.txt configFSQ.txt configFH.txt ConfigID.txt ConfigMisc.txt \ +configMT63.txt configOlivia.txt ConfigOperator.txt configPSK.txt \ +configRTTY.txt configThor.txt ConfigUI-browser.txt \ +ConfigUI-contest.txt ConfigUI-general.txt ConfigUI-logging.txt \ +ConfigUI-macros.txt ConfigUI-WF-controls.txt ConfigWaterfall.txt \ +SoundCardSetup.txt Contest-How-To.txt cabrilloreporter.txt \ +Logbook.txt LogExports.txt working_logs.txt Macros.txt \ +InlineMacroTags.txt atMacroTags.txt advanced_qsy.txt execmacro.txt CW.txt \ +DominoEX.txt hell.txt Contestia.txt MFSK.txt MT63.txt FSQ.txt \ +Navtex.txt psk.txt Olivia.txt RTTYFSK.txt Thor.txt \ +throb.txt tune.txt WEFAX.txt WWV-xmt.txt FrequencyAnalysis.txt \ +DigiscopeDisplay.txt DigiWWV.txt map.txt MousingKeyboardShortcuts.txt \ +Multiples.txt Notifier.txt OperatingControls.txt RST-RSQ.txt \ +Spotter.txt Synop.txt TransceiverControl.txt UTF8.txt \ +pskmail_config.txt PskViewer.txt DXCC_list.txt \ +KeyboardAndKeys.txt KML.txt Installing.txt WindowsOS.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 \ +License.txt Recognitions.txt diff --git a/fldigi_doxygen/user_src_docs/kiss_io_command.txt b/fldigi_doxygen/user_src_docs/kiss_io_command.txt new file mode 100644 index 00000000..ea562bbe --- /dev/null +++ b/fldigi_doxygen/user_src_docs/kiss_io_command.txt @@ -0,0 +1,192 @@ +/** +\page kiss_command_page FLDIGI KISS Hardware Commands + +\tableofcontents + +
+ +

Custom Frame Extensions

+ +
+ +These commands are NON-STANDARD extension(s) to the KISS interface +specifications and designed to control/configure aspects of FLDIGI not +normally found in Hardware TNC's. Undefined kiss frame types 6 and 7 are used +to identify these custom frames. + +
+Definition | Kiss frame ID +:---------: | :-----------------: +HARDWARE | 6 +RAW | 7 +
+ +External program which conform to the official KISS I/O specifications are +expected to operate normally. + +UDP/IP Connectionless communications are used to transfer information between +FLDIGI and the host program. See \ref config_io_page and +\ref command_line_switches_page for specific address and port number +assignments. + +\section sSetCommands Set Commands + +Command \ | Use +:------------------------------- | :---------------------------- +BCHN:\ | Busy Channel On/Off +BCHNS:\<0-999\> | Busy Channel Wait Duration (seconds) +CSMA:\ | Enable/Disable CSMA. Used on a shared frequency +IBCHN:\ | Set Inhibit busy channel duration to N seconds +IBCHN:0 | Resets temporary duration to default setting. +IBCHN:S | Inhibit busy channel temporarily. 'S' (character) (default 5 seconds) +KISSRAW:\ | Pass non HDLC encoded data to the transmitter. +\verbatim +ON = HDLC and Unaltered data. +OFF = HDLC data only. +ONLY = Unaltered data only. +\endverbatim + +Command | Use +:------------------------------- |:------------------------------------------------- +KISSCRCM:\ | Enable KISS frame checksum type +KPSATT:\ | Set the fractional ratio gain value (1/value) +KPSQL:\ | OFF=Histogram Mode, ON=User set level +KPSQLS:\<0-100\> | Set squelch level (percent) +MODEM:\ | Set modem type. Example MODEM:PSK63RC32 +RSIDBCAST:\ | Enable/disable RSID broadcast state change (default: OFF) +RSIDRX:\ | Enable/disable RX RSID +RSIDTX:\ | Enable/disable TX RSID +SQL:\ | SQL On/Off +SQLS:\<0-100\> | Set SQL Level (percent) +TRXSBCAST:\ | Enable/disable TX/RX state change broadcast (default: OFF) +TXBEBCAST:\ | Enable/disable TX buffer empty broadcast (default: OFF) +WFF:\ | Move TXRX cursor to frequency on waterfall. + +\verbatim +NONE = No CRC used +SMACK = Enable CRC use for Host <-> TNC ASYNC links +CCITT = Enable CCITT CRC +FCS = Enable FCS CRC +XOR = Enable BPQ's XOR CRC +\endverbatim + +Command \ | Use +:---------------------|:------------------------------------------------- +RSIDM:\,\ | Set the RSID mode to,... +\verbatim +BANDPASS = Search entire bandpass for RSID signals +MODEM = Search Modem bandpass (+/- 200HZ) for RSID signals +ACTIVE = When RSID received, move frequency transmit/receive cursor to location. +NOTIFY = Report RSID when detected (Notify only). +\endverbatim + +\section sQueryCommands Query Commands + +Command / Return Status | Use +:-------------------------------------------------------- | :------------------------------------------------- +BCHN: FLDIGI returns BCHN:\ | Busy Channel State On/Off Query +BCHNS: FLDIGI returns BCHNS:\<0-999\> | Busy Channel Wait Duration Query (seconds) +BUSY: FLDIGI returns BUSY:\ | Return the state of the squelch, if there is a signal present +CSMA: FLDIGI returns CSMA:\ | CSMA State ON/OFF +FLSTAT: FLDIGI returns FLSTAT:\,\ | Start up State and runtime. Returns OK and after initial Query +IBCHN: FLDIGI returns IBCHN:\ | Inhibit busy channel durations in seconds. +KISSCRCM: FLDIGI returns CRCMODE:\,\ | Host <-> TNC KISS CRC Types +KPSATT: FLDIGI returns KPSATT:\ | Fractional value of KPSQL ratio gain figure (1/value) +KPSQL: FLDIGI returns KPSQL:\ | OFF=Histogram Mode, ON=User set level +KPSQLP: FLDIGI returns KPSQLP \<0-100\> | Current Power Level +KPSQLS: FLDIGI returns KPSQLS:\<0-100\> | Squelch set level Query (percent) +MODEM: FLDIGI returns MODEM:\ | Current Modem +MODEMBW: FLDIGI returns MODEMBW:\ | Current Modem Bandwidth +MODEML: FLDIGI returns MODEML:Modem1,Modem2,... | A List of comma delimited modem ID strings. +RSIDM: FLDIGI returns RSIDM:\,\ | Return current RSID Mode +RSIDRX: FLDIGI returns RSIDRX:\ | RX RSID ON? +RSIDTX: FLDIGI returns RSIDTX:\ | TX RSID ON? +SQL: FLDIGI returns SQL:\ | SQL On/Off +SQLP: FLDIGI returns SQLP:\<0-100\> | Current Symbol Quality Level (Currently Not returning valid data) +SQLS: FLDIGI returns SQLS:\<0-100\> | Set SQL Level Query (percent) +TNC: FLDIGI returns TNC:FLDIGI \ | Returns the version number of FLDIGI +TRXS: FLDIGI returns TRXS:\ | Returns the current RX/TX state of FLDIGI +TXBUF: FLDIGI returns TXBUF:\ | Return the number of byte in the transmit queue +WFBW: FLDIGI returns WFBW:\,\ | Return the active waterfall bandwidth +WFF: FLDIGI returns WFF:\ | Current modem position on waterfall (center) + +\subsection ssQueryCommand Query Commands (FLDIGI to HOST) + +Command | Use +:------------ |:------------------------------------------------- +HOST: | Host returns HOST:\ \ + +\par Note: + Not required + +\section sBroadcastCommands Broadcast Status Messages (FLDIGI to HOST) + +Status \ | Use +:-------------------------- |:------------------------------------------------- +RSIDN:NEW_WF_OFFSET,NEW_MODEM,OLD_WF_OFFSET,OLD_MODEM,\ | RSID NOTICE +TRXS:\ | Transmitted during a state change between RX/TX or TX/RX. +TXBE: | Broadcast on emptied transmit buffer. + +\verbatim +NEW_WF_OFFSET = 0-4000 +NEW_MODEM = Modem ID string of newly switched modem. +OLD_WF_OFFSET = 0-4000 +OLD_MODEM = Modem ID string of modem prior to switching. +ACTIVE = Indicating TXRX cursor changed. +NOTIFY = Notice only. +USER = Report User or commanded via KISS interface modem change. +\endverbatim + +\section sCommandFormat Format of Hardware Commands + +FLDIGI will only except KISS frames with a PORT ID of '0' (zero). The hardware +frame is a kiss frame type 6. + +\verbatim +MODEM:PSK125RC16 +FEND,PORT(0)|HRDW(6),'M','O',D','E','M',':','P','S','K','1',2','5','R','C','1','6',FEND +KISS HARDWARE FRAME="MODEM:PSK63RC32" +KISS HARDWARE FRAME="RSIDTX:ON" +KISS HARDWARE FRAME="RSIDRX:OFF" +\endverbatim + +\section sRawDataFormat Format of RAW Data + +To enable RAW use, issue hardware command KISSRAW:. The +encode of the raw data is the same as the encoding of normal kiss data. The +host program is responsible for the proper protocol data syntax. + +Format:
+ +Dn=8 bit data (byte) + +\verbatim +KISS RAW FRAME=D1,D2,D3,... + +FEND,PORT(0)|RAW(7),D1,D2,D3,...,FEND +\endverbatim +
+ +--- + +Notes: + +
    +
  1. The transmit buffer has a ten minute timer association. In the + event data has been retained in the transmit buffer for more then 10 + minutes without being transmitted in part or whole the buffer is + cleared. This will prevent a build up of data and a subsequent + transmit for an extended period once the frequency is clear. + Consider all packets in the transmit queue lost. If enabled, + TXBE will be issued when this occurs.
    2. +
  2. Both ARQ and KISS IO ports are active for the reception of data. + However, only the selected port will pass data to the higher functions + and the other port will not buffer the data for later use. Reason: see + note 1.
    3. +
  3. By keeping a complete ARQ (RAW) packet in one KISS frame both + HDLC and ARQ (RAW) data can coexist. This allows for sequential data + transmission without interleaving data at the byte level.
    4. +
+ + +*/ diff --git a/fldigi_doxygen/user_src_docs/map.txt b/fldigi_doxygen/user_src_docs/map.txt new file mode 100644 index 00000000..38a63e56 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/map.txt @@ -0,0 +1,127 @@ +/** +\page google_maps Google Maps + +\verbatim + +snip ------------ copy the following to ~/.fldigi/scripts/map.pl + +#!/usr/bin/perl + +# Author: Stelios Bounanos, M0GLD +# Date: 20080625 + +use warnings; +use strict; +use Getopt::Std; + +our $VERSION = "0.3141"; +our %opts = ( "e" => 0, "m" => 1, "z" => 4); + +cmdline(); +open(STDOUT, '>', "/dev/null"); + +my $loc = exists($opts{'l'}) ? $opts{'l'} : $ENV{'FLDIGI_LOG_LOCATOR'}; +die "Invalid locator\n" unless ((defined($loc) && length($loc) =~ /[2-6]/)); + +my $label = exists($opts{'t'}) ? $opts{'t'} : $ENV{'FLDIGI_LOG_CALL'}; +$label = $loc if (!defined($label) || $label eq ""); + +my ($lon, $lat) = map { sprintf("%+.6f", $_) } mtoll($loc); +if ($opts{'m'}) { + my $url = "http://maps.google.com/maps?q=${lat},${lon}(${label})&t=p&z=$opts{'z'}"; +# $url =~ s/([(),])/sprintf("%%%02X", ord($1))/ge; # encode some chars + exec("xdg-open", $url); + die "Could not exec xdg-open: $!\n"; +} + +exit(0) unless ($opts{'e'}); +my $kml = (exists($ENV{'TMPDIR'}) ? $ENV{'TMPDIR'} : "/tmp") . + "/" . $loc . ".kml"; +open(KML, '>', $kml) or die "Could not write $kml: $!\n"; +print KML < + + + $label + + $label + $loc + + + $lon,$lat,0 + + + +EOF + ; +close(KML); + +######################################################################## + +sub cmdline +{ + $Getopt::Std::STANDARD_HELP_VERSION = 1; + my $old_warn_handler = $SIG{__WARN__}; + $SIG{__WARN__} = sub { die $_[0]; }; + getopts('t:l:mz:e', \%opts); + $SIG{__WARN__} = $old_warn_handler; +} + + +# Convert a 2, 4, or 6-character Maidenhead locator string +# to decimal degrees. Return a (longitude, latitude) pair. +sub mtoll +{ + my $len = length($_[0]); + $_[0] .= join("", ("A", "A", "0", "0", "A", "A")[$len .. 5]) if ($len < 6); + $_[0] = uc($_[0]); + die "Invalid locator\n" unless ($_[0] =~ /[A-R]{2}\d{2}[A-X]{2}/); + + my @digits = split(//, $_[0]); + my ($lon, $lat) = (-180, -90); + + $lon += (ord($digits[0]) - ord('A')) * 20 + + (ord($digits[2]) - ord('0')) * 2 + + (ord($digits[4]) - ord('A') + 0.5) / 12; + $lat += (ord($digits[1]) - ord('A')) * 10 + + (ord($digits[3]) - ord('0')) + + (ord($digits[5]) - ord('A') + 0.5) / 24; + + return ($lon, $lat); +} + +sub HELP_MESSAGE +{ +print < +\ref google_maps "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/parseUALR.txt b/fldigi_doxygen/user_src_docs/parseUALR.txt new file mode 100644 index 00000000..2293ac59 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/parseUALR.txt @@ -0,0 +1,100 @@ +/** +\page parse_ualr_page Parse UALR + +\tableofcontents + +A simple parser to create a formated console output for fldigi's \ macro: + +\verbatim + +snip------------------------------------------ +#include +#include +#include +#include +#include +#include +#include + +using namespace std; +using std::cout; +using std::cin; + +int main(int argc, char *argv[]) +{ + size_t pos = 0, pos2 = 0, pos3 = 0, pos4 = 0, pos5 = 0; + string commandline = ""; + string name = ""; + string qth = ""; + string answer = ""; + char c = cin.get(); + + while (!cin.eof()) { + commandline += c; + c = cin.get(); + } + + if (commandline.find("No match found") != string::npos) + goto noresponse; + + pos = commandline.find(", "); + + if (pos == string::npos) + goto noresponse; + + pos += 2; + pos2 = commandline.find("\n", pos); + + if (pos2 == string::npos) + goto noresponse; + + name = commandline.substr(pos, pos2 - pos); + pos3 = name.find(32); + + if (pos3 != string::npos) + name = name.substr(0, pos3); + + for (size_t i = 1; i \< name.length(); i++) + name[i] = tolower(name[i]); + + answer = "$NAME"; + answer.append(name); + + pos4 = commandline.find(", ", pos2); + pos4 = commandline.rfind( "\n", pos4); + pos4 += 1; + pos5 = commandline.find("\n", pos4); + + qth = commandline.substr(pos4, pos5 - pos4); + + answer.append("$QTH"); + answer.append(qth); + + cout \<\< answer.c_str(); + + return 0; + +noresponse:; + + cout \<\< "$NAME?$QTH?"; + + return 0; +} +snip----------------------------------------------- +\endverbatim + +Save the above as "parseUALR.cxx" and then compile and link as follows: + +g++ parseUALR.cxx -o parseUALR + +Copy the "parseUALR" executable to a directory on your shell exec PATH. + + + + +
+\ref parse_ualr_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/psk.txt b/fldigi_doxygen/user_src_docs/psk.txt new file mode 100644 index 00000000..23751225 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/psk.txt @@ -0,0 +1,210 @@ +/** +\page psk_page PSK Single and Multi-Channel Modems + +\tableofcontents + +\section bpsk_modem BPSK, QPSK, 8PSK modems + +PSK are narrow band low to moderate symbol rate modes using either single or +multiple carrier differential Phase Shift Keying. + +Current supported variants: + +BPSK: Binary, 2 constellations (1)
+QPSK: Quadrature, 4 constellations
+8PSK: Octal, 8 constellations
+\par (1) + A convenient way to represent PSK schemes is on a constellation diagram. +This shows the points in the complex plane where, in this context, the real and +imaginary axes are termed the in-phase and quadrature axes respectively due to +their 90° separation.
+ +\par NOTE: + Multi-Channel PSK modems use BPSK modulation. + +PSK63FEC and the PSKxxxR modes are forward error correcting modes. PSK63FEC +is compatible with the MultiPsk mode of the same name. The PSKxxxR, or +robust, modes use both forward error correction and interleaving to achieve +about 4 dB s/n improvement over standard PSK. These modes are used primarily +by the PskMail user community. They are the invention of John Douyere, +VK2ETA, a member of the fldigi development team. +
+ +In addition to the binary phase shift keying the signal is 100% +raised-cosine amplitude modulated at the symbol rate. This reduces the power +to zero at the phase change. Because of this amplitude modulation, the +signal bandwidth is relatively narrow. Synchronization at the receiver +is straight forward because it can be recovered from the amplitude +information. Differential PSK is used to provide continuous phase changes +when idle (to maintain sync), and by allowing the receiver to measure phase +difference from symbol to symbol, to reduce the effects of ionospheric +Doppler phase changes which modulate the signal. The slower modes are +more affected by Doppler, and the QPSK and 8PSK modes are particularly affected. +
+ +With no interleaver and limited coding length, the QPSK mode Forward Error +Correction coding gain is limited, and under burst noise conditions on +HF the performance is usually worse than the BPSK option at the same +baud rate. In general the narrow-band BPSK modes work well on a quiet +single-hop path, but give poor performance in most other conditions. +
+ +Many of the multi-carrier and 8PSK modes exceed the baud and bandwidth limitations +imposed by the FCC (US operators only). These modes are intended for use on VHF/UHF +and have proven to be very robust on FM even when used with repeaters. +
+ +\image html psk-signal-oscope.png "PSK63 signal transmitting text data - oscilloscope view" +\image latex psk-signal-oscope.png "PSK63 signal transmitting text data - oscilloscope view" width=5.0in +
+ +\image html psk-signal-waterfall.png "PSK63 signal transmitting text data - waterfall view" +\image latex psk-signal-waterfall.png "PSK63 signal transmitting text data - waterfall view" width=1.0in +
+ +\image html qpsk-signal-oscope.png "QPSK63 signal transmitting text data - oscilloscope - waterfall view" +\image latex qpsk-signal-oscope.png "QPSK63 signal transmitting text data - oscilloscope - waterfall view" width=5.0in +
+ +\image html qpsk-signal-waterfall.png "QPSK63 signal transmitting text data - waterfall view" +\image latex qpsk-signal-waterfall.png "QPSK63 signal transmitting text data - waterfall view" width=1.0in +
+ +\section multi_bpsk_modem Multi-Channel BPSK modems + +\image html MultiChannelBPSKWaterfall.png "PSK63R20C signal transmitting text data - waterfall view" +\image latex MultiChannelBPSKWaterfall.png "PSK63R20C signal transmitting text data - waterfall view" width=4.0in +
+ +\image html MultiChannelBPSKOScope.png "PSK63R20C signal transmitting text data - oscilloscope view" +\image latex MultiChannelBPSKOScope.png "PSK63R20C signal transmitting text data - oscilloscope view" width=4.0in +
+ +\section eight_psk_modems 8PSK modems + +The 8 PSK modes are intended for use on VHF/UHF FM systems. They provide a very +high data rate suitable for use with both flmsg and flamp and the transfer of +digital data. +
+ +
+Mode | Baud | WPM | Mode-FEC | Baud | WPM +:--------:|:-----:|:----:|:---------:|:-----:|:---- +8PSK125 | 125 | 635 | 8PSK125F | 125 | 317 +8PSK250 | 250 | 1270 | 8PSK250F | 250 | 635 +8PSK500 | 500 | 2540 | 8PSK500F | 500 | 1690 +8PSK1000 | 1000 | 5080 | 8PSK1000F | 1000 | 3386 +----------|-------|------| 8PSK1200F | 1200 | 4170 +
+
+ +The FEC modes do not all use the same Viterbi polynomials to achieve the forward +error correction. That is why the WPM rates for the FEC modes are not multiples +of the base 125 baud. The WPM rates are only an indication of relative rates. +The actual transfer rate is highly dependent on the data content. This is always +true for modes which use a VARICODE. +
+ +The 8psk signal is similar to both bpsk and qpsk, but with 8 possible phase states +instead of the 2 and 4 associated with bpsk, qpsk. The format of the signal does +not lend itself easily to a conventional AFC. Instead, the modes should be used +with RsID enabled. The RsID signal will both determine the mode and the mode +center frequency (to the nearest 2.6 Hz). A finer resolution of the mode center +frequency can be made using the optional pilot carrier. This pilot carrier is +placed at the frequency +
+ +f0 – samplerate / symbollen, f0 is modem center frequency +
+ +samplerate / symbollen is the same as the mode bandwidth. The waterfall and +spectrum signature for the 8psk500 mode is shown here with and without the +pilot carrier: +
+ +\image html eight-psk-signal-oscope.png "8PSK125 signal transmitting text data - oscilloscope - waterfall view" +\image latex eight-psk-signal-oscope.png "8PSK125 signal transmitting text data - oscilloscope - waterfall view" width=5.0in +
+ +\image html eight-psk-signal-waterfall.png "8PSK125 signal transmitting text data - waterfall view" +\image latex eight-psk-signal-waterfall.png "8PSK125 signal transmitting text data - waterfall view" width=1.5in +
+ +The two oscilloscope views above clearly show the combined phase and +amplitude modulation of these modes. +
+ +\image html 8psk500f.png "8PSK500F idle signal without pilot" +\image latex 8psk500f.png "8PSK500F idle signal without pilot" width=3.0in +
+ +\image html 8psk500f-pilot.png "8PSK500F idle signal with pilot" +\image latex 8psk500f-pilot.png "8PSK500F idle signal with pilot" width=3.0in +
+ +\image html 8psk500f-spectrum.png "8PSK500F idle signal without pilot" +\image latex 8psk500f-spectrum.png "8PSK500F idle signal without pilot" width=1.5in +
+ +\image html 8psk500f-spectrum-pilot.png "8PSK500F idle signal with pilot" +\image latex 8psk500f-spectrum-pilot.png "8PSK500F idle signal with pilot" width=1.5in +
+ +Decoding errors are reduced as the tracking point nears the actual transmit center +frequency. The loss of signal power is more than offset by the decoder improvement. +Field testing has shown that the pilot tone needs to be at -40 dB or greater +(less negative). +
+ +Pilot tone detection does require a bit more cpu power. The pilot tone is detected +using a sliding fast Fourier transform, sfft, which computes the frequency of +the pilot to approximately 1 Hz resolution. The sfft only evaluates the signal +at 11 discrete frequencies, so it is necessary that either the RsID, or manual +tuning is used for the initial signal acquisition. The detector is set to provide +lock when the pilot s/n is 2:1 or better. The signal tracking point is then +adjusted to place the pilot tone at the correct frequency location. For example, +if the RsID put the tracking point at 1502 Hz, the pilot would then adjust for +1500 (if that is the correct tracking frequency). The adjustment is made once +per second. Unlike AFC, which is continuous, the pilot adjustment is discrete +and occurs in 1 Hz steps. If the pilot s/n is less than 2:1 then no adjustment +is made to the tracking point. The pilot tone is transmitted during the 8psk +preamble as well as during the data transmission. You should see the tracking +point adjust once at the beginning of the transmission and then stay fixed. +
+ +With these modes, a very linear transmitter is required. Over-driven +operation results in excessive bandwidth, poorer reception and +difficult tuning. Overdrive usually occurs by having the audio +signal much too large. These are very sensitive modes and usually very little +power is required. QRP operation of 80, 40, 30 and 20 meters can provide +nearly 100% copy over multi-hop paths. In many instances PSK can provide +better decoding than CW. +
+ +Setting up for a good clean on air signal that will receive the accolades +of your QSO partners is easy. Follow the instructions on using the +\ref tune_page "Tune" button and you will have a clean on signal. +
+ +Good reception of PSK signals requires that the demodulator be phase locked +to the incoming signal. Fldigi has both a fast acquire / slow tracking AFC +system. Place the red bandwidth bar (see above) so that it overlies +the desired signal and then press the left mouse button. The signal +should quickly lock on a decoding should commence immediately. It is +almost impossible to visually tell whether a BPSK or QPSK signal is +being received. Under very high s/n you might be able to hear the +difference, but that is even difficult for most operators. If you are not +able to decode a signal that looks like a BPSK and the bandwidth of the +signal matches the baud rate then it might be a QPSK signal. Just change +mode a try reacquiring the signal. +
+ +For further information about Phase Shift Keying +
+ +\ref psk_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + + +*/ diff --git a/fldigi_doxygen/user_src_docs/pskmail_config.txt b/fldigi_doxygen/user_src_docs/pskmail_config.txt new file mode 100644 index 00000000..e3d1e4de --- /dev/null +++ b/fldigi_doxygen/user_src_docs/pskmail_config.txt @@ -0,0 +1,26 @@ +/** +\page psk_mail_configuation_page PSKmail Configuration + +\tableofcontents + + +Fldigi can act as both a server and a client for PskMail, a separate +application from fldigi. The PSKmail specific configuration +parameters are all located on the Misc/Pskmail tab of the configuration +dialog. +
+ +Instructions on setting these parameters are a part of the pskmail installation. +
+ +\image html config-psk-mail.png "PSK Mail Configuration" +\image latex config-psk-mail.png "PSK Mail Configuration" width=5.0in +
+ + +
+\ref psk_mail_configuation_page "Return to Top of Page" +
+\ref main_page "Return to Main Page" + +*/ diff --git a/fldigi_doxygen/user_src_docs/rigxml.txt b/fldigi_doxygen/user_src_docs/rigxml.txt new file mode 100644 index 00000000..9c9bd075 --- /dev/null +++ b/fldigi_doxygen/user_src_docs/rigxml.txt @@ -0,0 +1,384 @@ +/** +\page rig_xml_page Rig Xml How to + +\tableofcontents + +This document describes the contents of the rig definition file \"rig.xml\". +
+ +A number of transceivers have rig definition files written and tested +which you may use. These are found in the xmls directory on this +site: xml archives. +You will find subdirectories by manufacturer which contain files named +by rig type, ie: TS-850.xml. If you create, test and verify the proper +operation for a transceiver not yet posted please share that with +others by sending it as an attachment to w1hkj@w1hkj.com and I will +post it on the web site. You are encouraged to study the various rig +definition files to learn more about how they are organized. + +Comments are contained within the tag pair: + +\ --\> +
+ +and may appear anywhere in the rig definition file The entire rig definition +must be contained within the tag pair + +\
\ + +The text within the tag pair \\ specifies the transceiver to +which this file applies, as in: + +\Icom 746 PRO\ +
+ +The text within the tag pair \\ is not used by the +parser, but should as a minimum say who created and who tested the definition file, as in: +
+ +\ +
+ +Dave Freese W1HKJ Tested by: W1HKJ, Dave
\ + +The text within the tag pair + +\
\ + +is not used by the parser, but should as a minimum state whether the +definition file has been \"Verified\", is \"Alpha&\", what the Version and +Date of creation or update, as in: + +\ Verified Version: 1.0 Date: 2007 Jan 5 \ + +The \
\ + +tag pair contains the text which will be displayed on the window decoration bar, as in: + +\Rig Control - IC-746 PRO\
+ +The serial port parameters may be preset in the xml file and also set or +changed on the rigcat configuration tab. +
+\