From 06fef2539139b2553e5d4735e3a3927900d2d47a Mon Sep 17 00:00:00 2001 From: Bill Somerville Date: Fri, 7 Dec 2018 01:44:19 +0000 Subject: [PATCH] User guide updates --- doc/common/links.adoc | 24 ++-- .../en/controls-functions-center.adoc | 2 + .../en/controls-functions-left.adoc | 2 + .../en/controls-functions-main-window.adoc | 2 + .../en/controls-functions-messages.adoc | 2 + .../en/controls-functions-status-bar.adoc | 2 + doc/user_guide/en/cooperating-programs.adoc | 10 +- doc/user_guide/en/faq.adoc | 18 ++- doc/user_guide/en/install-from-source.adoc | 10 +- doc/user_guide/en/install-linux.adoc | 14 +- doc/user_guide/en/install-mac.adoc | 2 +- doc/user_guide/en/install-windows.adoc | 18 ++- doc/user_guide/en/introduction.adoc | 47 +++---- doc/user_guide/en/make-qso.adoc | 4 +- doc/user_guide/en/measurement_tools.adoc | 2 + doc/user_guide/en/new_features.adoc | 11 +- doc/user_guide/en/settings-advanced.adoc | 2 + doc/user_guide/en/settings-audio.adoc | 15 ++- doc/user_guide/en/settings-colors.adoc | 53 ++++++-- doc/user_guide/en/settings-radio.adoc | 123 +++++++++++------- doc/user_guide/en/transceiver-setup.adoc | 68 +++++----- doc/user_guide/en/tutorial-example1.adoc | 2 + doc/user_guide/en/tutorial-example2.adoc | 2 + doc/user_guide/en/tutorial-example3.adoc | 6 +- doc/user_guide/en/tutorial-main-window.adoc | 2 + doc/user_guide/en/vhf-features.adoc | 8 +- doc/user_guide/en/wsjtx-main.adoc | 2 +- doc/user_guide/en/wspr.adoc | 2 + 28 files changed, 302 insertions(+), 153 deletions(-) diff --git a/doc/common/links.adoc b/doc/common/links.adoc index 158400854..94537cbe5 100644 --- a/doc/common/links.adoc +++ b/doc/common/links.adoc @@ -12,14 +12,14 @@ Example: [displayed text] PSK Reporter Perform searches from the doc root directory: doc -Search: grep -rl --exclude-dir="*\.svn" {pskreporter} . - grep -rl --exclude-dir="*\.svn" PSK Reporter . - grep -rl --exclude-dir="*\.svn" {devsvn} . - grep -rl --exclude-dir="*\.svn" {kvasd} . - grep -rl --exclude-dir="*\.svn" {ntpsetup} . +Search: grep -rl --exclude-dir="*\.git" {pskreporter} . + grep -rl --exclude-dir="*\.git" PSK Reporter . + grep -rl --exclude-dir="*\.git" {devrepo} . + grep -rl --exclude-dir="*\.git" {kvasd} . + grep -rl --exclude-dir="*\.git" {ntpsetup} . -Include links.adoc: grep -rl --exclude-dir="*\.svn" pskreporter . -Exclude links.adoc: grep -rl --exclude-dir="*\.svn" {pskreporter} . +Include links.adoc: grep -rl --exclude-dir="*\.git" pskreporter . +Exclude links.adoc: grep -rl --exclude-dir="*\.git" {pskreporter} . Note(s): a). Don't forget a space then "." at the end. @@ -54,8 +54,8 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes. :raspbian: http://physics.princeton.edu/pulsar/K1JT/wsjtx_{VERSION}_armhf.deb[wsjtx_{VERSION}_armhf.deb] :debian: http://www.debian.org/[Debian] :dev_guide: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjt-dev-guide.html[Dev-Guide] -:devsvn1: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[Devel-SVN] -:devsvn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[SourceForge] +:devsvn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[Devel-SVN] +:devrepo: https://sourceforge.net/p/wsjt/wsjtx/ci/master/tree/[SourceForge] :dimension4: http://www.thinkman.com/dimension4/[Thinking Man Software] :download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[Download Page] :dxatlas: http://www.dxatlas.com/[Afreet Software, Inc.] @@ -80,6 +80,7 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes. :lunarEchoes: http://physics.princeton.edu/pulsar/K1JT/LunarEchoes_QEX.pdf[QEX] :msk144: http://physics.princeton.edu/pulsar/k1jt/MSK144_Protocol_QEX.pdf[QEX] :msys_url: http://sourceforge.net/projects/mingwbuilds/files/external-binary-packages/[MSYS Download] +:n1mm_logger: https://n1mm.hamdocs.com/tiki-index.php[N1MM Logger+] :ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] :osx_instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[Mac OS X Install Instructions] :ppa: http://en.wikipedia.org/wiki/Personal_Package_Archive[PPA] @@ -88,6 +89,7 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes. :sourceforge: https://sourceforge.net/user/registration[SourceForge] :sourceforge-jtsdk: https://sourceforge.net/projects/jtsdk[SourceForge JTSDK] :ubuntu_sdk: https://launchpad.net/~ubuntu-sdk-team/+archive/ppa[Ubuntu SDK Notice] +:writelog: https://writelog.com/[Writelog] :wsjt_yahoo_group: https://groups.yahoo.com/neo/groups/wsjtgroup/info[WSJT Group] :wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[WSJT-X] :wspr0_guide: http://www.physics.princeton.edu/pulsar/K1JT/WSPR0_Instructions.TXT[WSPR0 Guide] @@ -111,9 +113,9 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes. :svn: http://subversion.apache.org/packages.html#windows[Subversion] :win32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-win32.exe[wsjtx-{VERSION}-win32.exe] :wsjt-devel: https://lists.sourceforge.net/lists/listinfo/wsjt-devel[here] -:wsjt_svn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[WSJT Source Repository] +:wsjt_repo: https://sourceforge.net/p/wsjt/wsjt_orig/ci/master/tree/[WSJT Source Repository] :wspr_code: http://physics.princeton.edu/pulsar/K1JT/WSPRcode.exe[WSPRcode.exe] -:wspr_svn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/branches/wspr/[WSPR Source Repository] +:wspr_svn: https://sourceforge.net/p/wsjt/wspr/ci/master/tree/[WSPR Source Repository] // MAIL-TO links :alex_efros: mailto:powerman@powerman.name[Alex Efros] diff --git a/doc/user_guide/en/controls-functions-center.adoc b/doc/user_guide/en/controls-functions-center.adoc index a7701b705..a640809d6 100644 --- a/doc/user_guide/en/controls-functions-center.adoc +++ b/doc/user_guide/en/controls-functions-center.adoc @@ -36,6 +36,8 @@ inserted automatically. Typical reports for the various modes fall in the range –30 to +20 dB. Remember that JT65 reports saturate at an upper limit of -1 dB. ++ + TIP: Consider reducing power if your QSO partner reports your signal above -5 dB in one of the _WSJT-X_ slow modes. These are supposed to be weak signal modes! diff --git a/doc/user_guide/en/controls-functions-left.adoc b/doc/user_guide/en/controls-functions-left.adoc index 338346dae..4dcb20bc3 100644 --- a/doc/user_guide/en/controls-functions-left.adoc +++ b/doc/user_guide/en/controls-functions-left.adoc @@ -28,6 +28,8 @@ if the rig is detected to be in *Split* mode. The circle becomes red if you have requested CAT control but communication with the radio has been lost. ++ + TIP: Many Icom rigs cannot be queried for split status, current VFO or split transmit frequency. When using _WSJT-X_ with such radios you should not change the current VFO, split status or dial frequency diff --git a/doc/user_guide/en/controls-functions-main-window.adoc b/doc/user_guide/en/controls-functions-main-window.adoc index c15f68123..472adb9a7 100644 --- a/doc/user_guide/en/controls-functions-main-window.adoc +++ b/doc/user_guide/en/controls-functions-main-window.adoc @@ -36,6 +36,8 @@ the original frequency. * *Erase* clears the right-hand decoded text window. Double-clicking *Erase* clears both text windows. ++ + TIP: Right-clicking on either text window brings up a context menu with several options (including *Erase*) which operate on that window alone. diff --git a/doc/user_guide/en/controls-functions-messages.adoc b/doc/user_guide/en/controls-functions-messages.adoc index c712feada..6a130d70c 100644 --- a/doc/user_guide/en/controls-functions-messages.adoc +++ b/doc/user_guide/en/controls-functions-messages.adoc @@ -56,6 +56,8 @@ spaces) in the *Free Msg* box. pre-stored macro. Pressing *Enter* on a modified message here automatically adds that message to the table of stored macros. ++ + TIP: During a transmission the actual message being sent always appears in the first box of the status bar (bottom left of the main screen). diff --git a/doc/user_guide/en/controls-functions-status-bar.adoc b/doc/user_guide/en/controls-functions-status-bar.adoc index 064a6b927..a38ff54fd 100644 --- a/doc/user_guide/en/controls-functions-status-bar.adoc +++ b/doc/user_guide/en/controls-functions-status-bar.adoc @@ -21,3 +21,5 @@ the elapsed fraction of a Tx or Rx sequence. Finally, if the Watchdog lower right-hand corner displays the number of minutes remaining before timeout. +TIP: Temporary status messages may occasionally be displayed here for +a few seconds when background processing completes. \ No newline at end of file diff --git a/doc/user_guide/en/cooperating-programs.adoc b/doc/user_guide/en/cooperating-programs.adoc index e0c2acf91..99e49e1e3 100644 --- a/doc/user_guide/en/cooperating-programs.adoc +++ b/doc/user_guide/en/cooperating-programs.adoc @@ -36,4 +36,12 @@ current band, as well as other options. * {jtbridge}, by SM0THU, is available for OS X. It works together with logging applications Aether, MacLoggerDX, RUMlog or RUMlogNG. It checks QSO and QSL status of the call and DXCC entity, as well as many -other features. \ No newline at end of file +other features. + +* {n1mm_logger} is a free full feature contest logging application. It + is only available for Windows. _WSJT-X_ can send logged QSO + information to it via a network connection. + +* {writelog} is a non-free full feature contest logging + application. It is only available for Windows. _WSJT-X_ can send + logged QSO information to it via a network connection. \ No newline at end of file diff --git a/doc/user_guide/en/faq.adoc b/doc/user_guide/en/faq.adoc index fa3852a92..fe5df38ee 100644 --- a/doc/user_guide/en/faq.adoc +++ b/doc/user_guide/en/faq.adoc @@ -47,7 +47,23 @@ location for each instance of _WSJT-X_. wsjtx --rig-name=TS2000 wsjtx --rig-name=FT847 -Rig control through _OmniRig_ seems to fail when I click *Test CAT*. What can I do about it?:: +I occasionally get Rig Control Errors if I adjust my Icom rig's VFO. What's wrong?:: + +By default most Icom transceivers have *CI-V Tranceive Mode" enabled, +this will cause unsolicited CAT traffic from the rig that disrupts CAT +control by a PC. Disable this option in the rig's menu. + +I want to control my transceiver with another application as well as _WSJT-X_, is that possible?:: + +This only possible to do reliably via some kind of rig control server, +that server must be able to accept both _WSJT-X_ and the other +application(s) as clients. Using a dumb serial port splitter like the +VSPE tool is not supported, it may work but it is not reliable due to +unmanaged CAT control collisions. Applications like the _Hamlib Rig +Control Server (rigctld)_, _{omnirig}_, and _{dxlsuite} Commander_ are +potentially suitable and _WSJT-X_ can act as a client to them all. + +Rig control through _OmniRig_ seems to fail when I click *Test CAT*. What can I do about it?:: _Omni-Rig_ apparently has a bug that appears when you click *Test CAT*. Forget using *Test CAT* and just click *OK*. _Omni-Rig_ then diff --git a/doc/user_guide/en/install-from-source.adoc b/doc/user_guide/en/install-from-source.adoc index 466528f20..f106aa59b 100644 --- a/doc/user_guide/en/install-from-source.adoc +++ b/doc/user_guide/en/install-from-source.adoc @@ -1,10 +1,10 @@ // Status=review Source code for _WSJT-X_ is available from a public repository at -{devsvn}. To compile the program you will need to install at least the +{devrepo}. To compile the program you will need to install at least the following packages: -- Subversion 1.8 or later +- Git - Qt 5.2 or later - g++ 4.8 or later - gfortran 4.8 or later @@ -14,13 +14,15 @@ following packages: Source code for _WSJT-X_ v{VERSION} can be downloaded with the command: ===== -svn co svn://svn.code.sf.net/p/wsjt/wsjt/tags/wsjtx-{VERSION} +git clone git://git.code.sf.net/p/wsjt/wsjtx +cd wsjtx +git checkout wsjtx-{VERSION} ===== and for the current development branch, ===== -svn co svn://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx +git clone git://git.code.sf.net/p/wsjt/wsjtx ===== If you are interested in contributing to the development and diff --git a/doc/user_guide/en/install-linux.adoc b/doc/user_guide/en/install-linux.adoc index bf7dd442f..999d52fe8 100644 --- a/doc/user_guide/en/install-linux.adoc +++ b/doc/user_guide/en/install-linux.adoc @@ -2,6 +2,16 @@ Debian, Ubuntu, and other Debian-based systems including Raspbian: +NOTE: The project team release binary installer packages for Linux +when a new _WSJT-X_ release is announced, note that these are built to +target one contemporary version of a Linux distribution. Although +these may work on newer Linux versions or even different +distributions, it is unlikely that they will work on older +versions. Check the notes provided with the release for details of the +targeted Linux distributions and versions. If the binary package is +not compatible with your Linux distribution or version you must build +the application from sources. + * 32-bit: {debian32} - To install: + @@ -33,9 +43,9 @@ sudo dpkg -P wsjtx You may also need to execute the following command in a terminal: [example] -sudo apt install libqt5multimedia5-plugins libqt5serialport5 libfftw3-single3 +sudo apt install libqt5multimedia5-plugins libqt5serialport5 libqt5sql5-sqlite libfftw3-single3 -Fedora, Red Hat, and other rpm-based systems: +Fedora, CentOS, Red Hat, and other rpm-based systems: * 32-bit: {fedora32} - To install: diff --git a/doc/user_guide/en/install-mac.adoc b/doc/user_guide/en/install-mac.adoc index 566f5fd89..636777b55 100644 --- a/doc/user_guide/en/install-mac.adoc +++ b/doc/user_guide/en/install-mac.adoc @@ -6,7 +6,7 @@ installation notes. If you have already installed a previous version, you can retain it by changing its name in the *Applications* folder (say, from _WSJT-X_ to -_WSJT-X_1.8_). You can then proceed to the installation phase. +_WSJT-X_1.9_). You can then proceed to the installation phase. Take note also of the following: diff --git a/doc/user_guide/en/install-windows.adoc b/doc/user_guide/en/install-windows.adoc index ba50f10ff..844e2fc55 100644 --- a/doc/user_guide/en/install-windows.adoc +++ b/doc/user_guide/en/install-windows.adoc @@ -16,19 +16,23 @@ directory + TIP: Your computer may be configured so that this directory is "`invisible`". It's there, however, and accessible. An alternative -(shortcut) directory name is `%LOCALAPPDATA%\WSJT-X\`. +(shortcut) directory name is `"%LOCALAPPDATA%\WSJT-X\"`. - The built-in Windows facility for time synchronization is usually not adequate. We recommend the program _Meinberg NTP_ (see {ntpsetup} for downloading and installation instructions) or _Dimension 4_ from -{dimension4}. +{dimension4}. Recent versions of Windows 10 are now shipped with a +more capable Internet time synchronization service that is suitable if +configured appropriately. - _WSJT-X_ expects your sound card to do its raw sampling at 48000 Hz. To ensure that this will be so when running under recent versions of -Windows, open the system's *Sound* control panel and select in turn the -*Recording* and *Playback* tabs. Click on *Properties*, then -*Advanced*, and select *16 bit, 48000 Hz (DVD Quality)*. +Windows, open the system's *Sound* control panel and select in turn +the *Recording* and *Playback* tabs. Click on *Properties*, then +*Advanced*, and select *16 bit, 48000 Hz (DVD Quality)*. Switch of all +audio enhancement features for these devices. - You can uninstall _WSJT-X_ by clicking its *Uninstall* link in the -Windows *Start* menu, or by using *Uninstall a Program* on the -Windows Control Panel. +Windows *Start* menu, or by using *Uninstall a Program* on the Windows +Control Panel Programs and Features option or in Settings Apps on +Windows 10. diff --git a/doc/user_guide/en/introduction.adoc b/doc/user_guide/en/introduction.adoc index fda2f7fa4..b48738190 100644 --- a/doc/user_guide/en/introduction.adoc +++ b/doc/user_guide/en/introduction.adoc @@ -7,29 +7,30 @@ K1**JT**,`" while the suffix "`-X`" indicates that _WSJT-X_ started as an extended and experimental branch of the program _WSJT_. -_WSJT-X_ Version 2.0 offers nine different protocols or modes: *FT8*, -*JT4*, *JT9*, *JT65*, *QRA64*, *ISCAT*, *MSK144*, *WSPR*, and *Echo*. -The first five are designed for making reliable QSOs under extreme -weak-signal conditions. They use nearly identical message structure -and source encoding. JT65 and QRA64 were designed for EME -("`moonbounce`") on the VHF/UHF bands and have also proven very -effective for worldwide QRP communication on the HF bands. QRA64 has -a number of advantages over JT65, including better performance on the -very weakest signals. We imagine that over time it may replace JT65 -for EME use. JT9 was originally designed for the LF, MF, and lower HF -bands. Its submode JT9A is 2 dB more sensitive than JT65 while using -less than 10% of the bandwidth. JT4 offers a wide variety of tone -spacings and has proven highly effective for EME on microwave bands up -to 24 GHz. These four "`slow`" modes use one-minute timed sequences -of alternating transmission and reception, so a minimal QSO takes four -to six minutes — two or three transmissions by each station, one -sending in odd UTC minutes and the other even. FT8 is operationally -similar but four times faster (15-second T/R sequences) and less -sensitive by a few dB. On the HF bands, world-wide QSOs are possible -with any of these modes using power levels of a few watts (or even -milliwatts) and compromise antennas. On VHF bands and higher, QSOs -are possible (by EME and other propagation types) at signal levels 10 -to 15 dB below those required for CW. +_WSJT-X_ Version {VERSION_MAJOR}.{VERSION_MINOR} offers nine different +protocols or modes: *FT8*, *JT4*, *JT9*, *JT65*, *QRA64*, *ISCAT*, +*MSK144*, *WSPR*, and *Echo*. The first five are designed for making +reliable QSOs under extreme weak-signal conditions. They use nearly +identical message structure and source encoding. JT65 and QRA64 were +designed for EME ("`moonbounce`") on the VHF/UHF bands and have also +proven very effective for worldwide QRP communication on the HF bands. +QRA64 has a number of advantages over JT65, including better +performance on the very weakest signals. We imagine that over time it +may replace JT65 for EME use. JT9 was originally designed for the LF, +MF, and lower HF bands. Its submode JT9A is 2 dB more sensitive than +JT65 while using less than 10% of the bandwidth. JT4 offers a wide +variety of tone spacings and has proven highly effective for EME on +microwave bands up to 24 GHz. These four "`slow`" modes use +one-minute timed sequences of alternating transmission and reception, +so a minimal QSO takes four to six minutes — two or three +transmissions by each station, one sending in odd UTC minutes and the +other even. FT8 is operationally similar but four times faster +(15-second T/R sequences) and less sensitive by a few dB. On the HF +bands, world-wide QSOs are possible with any of these modes using +power levels of a few watts (or even milliwatts) and compromise +antennas. On VHF bands and higher, QSOs are possible (by EME and +other propagation types) at signal levels 10 to 15 dB below those +required for CW. *ISCAT*, *MSK144*, and optionally submodes *JT9E-H* are "`fast`" protocols designed to take advantage of brief signal enhancements from diff --git a/doc/user_guide/en/make-qso.adoc b/doc/user_guide/en/make-qso.adoc index 1a564c7c2..986583e7f 100644 --- a/doc/user_guide/en/make-qso.adoc +++ b/doc/user_guide/en/make-qso.adoc @@ -156,8 +156,8 @@ has been received in full in the recent past. Otherwise it will be displayed as < . . . >. These restrictions are honored automatically by the algorithm that generates default messages for minimal QSOs. Except for the special cases involving /P or /R used in VHF -contesting, _WSJT-X 2.0_ offers no support for two nonstandard -callsigns to work each other. +contesting, _WSJT-X {VERSION_MAJOR}.{VERSION_MINOR}_ offers no support +for two nonstandard callsigns to work each other. *JT4, JT9, JT65, and QRA64* diff --git a/doc/user_guide/en/measurement_tools.adoc b/doc/user_guide/en/measurement_tools.adoc index 57c113709..00c5e2d34 100644 --- a/doc/user_guide/en/measurement_tools.adoc +++ b/doc/user_guide/en/measurement_tools.adoc @@ -20,6 +20,8 @@ tab, delete any default frequencies for *FreqCal* mode that are not relevant for your location. You may want to replace some of them with reliably known frequencies receivable at your location. ++ + TIP: We find major-city AM broadcast stations generally serve well as frequency calibrators at the low frequency end of the spectrum. In North America we also use the standard time-and-frequency broadcasts diff --git a/doc/user_guide/en/new_features.adoc b/doc/user_guide/en/new_features.adoc index 2ed33ffd2..a90b52182 100644 --- a/doc/user_guide/en/new_features.adoc +++ b/doc/user_guide/en/new_features.adoc @@ -1,4 +1,4 @@ -=== New in Version 2.0 +=== New in Version {VERSION} For quick reference, here's a short list of features and capabilities added to _WSJT-X_ since Version 1.9.1: @@ -11,7 +11,7 @@ added to _WSJT-X_ since Version 1.9.1: * New logging features for contesting -* Integration with N1MM+ and WriteLog for contesting +* Integration with {n1mm_logger} and {writelog} for contesting * Improved support for compound and nonstandard callsigns @@ -31,6 +31,9 @@ IMPORTANT: Note that for FT8 and MSK144 there is no backward compatibility with WSJT-X 1.9.1 and earlier. Everyone using these modes should upgrade to WSJT-X 2.0 by January 1, 2019. +IMPORTANT: _WSJT-X_ Version 2.0 drops support for Apple Mac OS X 10.9 +(Mavericks). It is possible to build from source for this operating +system version but the DMG installer package requires 10.10 or later. === Documentation Conventions @@ -50,10 +53,10 @@ consequences. === How You Can Contribute _WSJT-X_ is part of an open-source project released under the -{gnu_gpl} (GPL). If you have programming or documentation skills or +{gnu_gpl} (GPLv3). If you have programming or documentation skills or would like to contribute to the project in other ways, please make your interests known to the development team. The project's -source-code repository can be found at {devsvn}, and communication +source-code repository can be found at {devrepo}, and communication among the developers takes place on the email reflector {devmail}. Bug reports and suggestions for new features, improvements to the _WSJT-X_ User Guide, etc., may also be sent to the {wsjt_yahoo_group} diff --git a/doc/user_guide/en/settings-advanced.adoc b/doc/user_guide/en/settings-advanced.adoc index 810075154..94b1c5f71 100644 --- a/doc/user_guide/en/settings-advanced.adoc +++ b/doc/user_guide/en/settings-advanced.adoc @@ -27,6 +27,8 @@ receiver's effective noise bandwidth. a larger delay between execution of a command to enable PTT and onset of Tx audio. ++ + IMPORTANT: For the health of your T/R relays and external preamplifier, we strongly recommend using a hardware sequencer and testing to make sure that sequencing is correct. diff --git a/doc/user_guide/en/settings-audio.adoc b/doc/user_guide/en/settings-audio.adoc index 478416836..921602ef9 100644 --- a/doc/user_guide/en/settings-audio.adoc +++ b/doc/user_guide/en/settings-audio.adoc @@ -4,18 +4,21 @@ image::settings-audio.png[align="center",alt="_WSJT-X_ Audio Configuration Scree Select the *Audio* tab to configure your sound system. -- _Soundcard_: Select the audio devices to be used for *Input* and +* _Soundcard_: Select the audio devices to be used for *Input* and *Output*. Usually the *Mono* settings will suffice, but in special cases you can choose *Left*, *Right*, or *Both* stereo channels. -- Be sure that your audio device is configured to sample at 48000 Hz, +** Be sure that your audio device is configured to sample at 48000 Hz, 16 bits. ++ IMPORTANT: If you select the audio output device that is also your computer's default audio device, be sure to turn off all system sounds to prevent inadvertently transmitting them over the air. ++ + NOTE: Windows Vista and later may configure audio devices using the Texas Instruments PCM2900 series CODEC for microphone input rather line input. (This chip is used in many radios with built-in USB @@ -23,18 +26,20 @@ CODECs, as well as various other audio interfaces.) If you are using such a device, be sure to set the mic level in the Recording Device Properties to 0 dB. -- _Save Directory_: _WSJT-X_ can save its received audio sequences as ++ + +* _Save Directory_: _WSJT-X_ can save its received audio sequences as `.wav` files. A default directory for these files is provided; you can select another location if desired. -- _AzEl Directory_: A file named `azel.dat` will appear in the +* _AzEl Directory_: A file named `azel.dat` will appear in the specified directory. The file contains information usable by another program for automatic tracking of the Sun or Moon, as well as calculated Doppler shift for the specified EME path. The file is updated once per second whenever the <> window is displayed. -- _Remember power settings by band_: Checking either of these will +* _Remember power settings by band_: Checking either of these will cause _WSJT-X_ to remember the *Pwr* slider setting for that operation on a band-by-band basis. For example, when *Tune* is checked here and you click the *Tune* button on the main window, the power slider will diff --git a/doc/user_guide/en/settings-colors.adoc b/doc/user_guide/en/settings-colors.adoc index fc2f748bc..bd77b6285 100644 --- a/doc/user_guide/en/settings-colors.adoc +++ b/doc/user_guide/en/settings-colors.adoc @@ -1,10 +1,47 @@ image::colors.png[align="center",alt="Colors Screen"] -_WSJT-X_ uses colors to highlight decoded CQ messages of particular -interest. Check the box *Show DXCC, grid, and worked-before status* -on the *Settings | General* tab, and any boxes of interest to you on -the *Colors* tab. You can drag any line up or down to raise or lower -its logical priority. Right-click any line to set a new foreground or -background color. Foreground and background colors are applied -separately, and careful choices of foreground, background, and -priority can provide two indications of worked-before status. +.Decode Highlighting + +* _WSJT-X_ uses colors to highlight decoded CQ messages of particular + interest. Check the box *Show DXCC, grid, and worked-before status* + on the *Settings | General* tab, and any boxes of interest to you on + the *Colors* tab. You can drag any line up or down to raise or + lower its logical priority. Right-click any line to set a new + foreground or background color. Foreground and background colors + are applied separately, and careful choices of foreground, + background, and priority can provide two indications of + worked-before status. + +* Press the *Reset Highlighting* button to reset all of the color + settings to default values. + +* Check *Highlight by Mode* if you wish worked before status to be per + <>. + +* Worked before status is calculated from your _WSJT-X_ ADIF + <> file, you may replace ADIF log file with one + exported from your station logging application, *Rescan ADIF Log* + rebuilds the _WSJT-X_ worked before indexes using the current ADIF + log file. + ++ + +TIP: The _WSJT-X_ ADIF file records must contain the "CALL" field. + The "BAND", and "MODE", and "GRIDSQUARE" fields are optional + depending on your DXing objectives. DXCC entity, continent, CQ, + and ITU Zone data for call prefixes and certain well known + overrides are derived from the cty.dat database which is bundled + with _WSJT-X_ (See <> for details). + +.Logbook of The World User Validation + +Stations who are known to have uploaded their logs to the ARRL LoTW +QSL matching service can be highlighted. The data used to determine +this is available on line. + +* *Fetch Now* will download a fresh dataset from the *Users CSV file + URL*. The LoTW team normally update this data weekly. + +* Adjust *Age of of last upload less than* to set the period within + which a station must have uploaded their log to LoTW to trigger + highlighting. \ No newline at end of file diff --git a/doc/user_guide/en/settings-radio.adoc b/doc/user_guide/en/settings-radio.adoc index 13f64267a..0f0ff27fe 100644 --- a/doc/user_guide/en/settings-radio.adoc +++ b/doc/user_guide/en/settings-radio.adoc @@ -6,66 +6,91 @@ _WSJT-X_ offers CAT (Computer Aided Transceiver) control of relevant features of most modern transceivers. To configure the program for your radio, select the *Radio* tab. -- Select your radio type from the drop-down list labeled *Rig*, or -*None* if you do not wish to use CAT control. +* Select your radio type from the drop-down list labeled *Rig*, or + *None* if you do not wish to use CAT control. -- Alternatively, if you have configured your station for control by -*DX Lab Suite Commander*, *Ham Radio Deluxe*, *Hamlib NET rigctl*, or -*Omni-Rig*, you may select one of those program names from the *Rig* -list. In these cases the entry field immediately under _CAT Control_ -will be relabeled as *Network Server*. Leave this field blank to -access the default instance of your control program, running on the -same computer. If the control program runs on a different computer -and/or port, specify it here. Hover the mouse pointer over the entry -field to see the required formatting details. +** Alternatively, if you have configured your station for control by + *DX Lab Suite Commander*, *Flrig*, *Ham Radio Deluxe*, *Hamlib NET + rigctl*, or *Omni-Rig*, you may select one of those program names + from the *Rig* list. In these cases the entry field immediately + under _CAT Control_ will be relabeled as *Network Server*. Leave + this field blank to access the default instance of your control + program, running on the same computer. If the control program runs + on a different computer and/or port, specify it here. Hover the + mouse pointer over the entry field to see the required formatting + details. -- Select *Omni-Rig Rig 1* or *Omni-Rig Rig 2* to connect to an -_Omni-Rig_ server running on the same computer. Note that _Omni-Rig_ -is available only under Windows. +** Select *Omni-Rig Rig 1* or *Omni-Rig Rig 2* to connect to an + _Omni-Rig_ server installed on the same computer. _Omni-Rig_ will + be started automatically by _WSJT-X_. -- Set *Poll Interval* to the desired interval for _WSJT-X_ to query -your radio. For most radios a small number (say, 1 – 3 s) is -suitable. ++ -- _CAT Control_: To have _WSJT-X_ control the radio directly rather -than though another program, make the following settings: +NOTE: _Omni-Rig_ is available only under Windows. -* Select the *Serial Port* used to communicate with your radio. +* Set *Poll Interval* to the desired interval for _WSJT-X_ to query + your radio. For most radios a small number (say, 1 – 3 s) is + suitable. -* _Serial Port Parameters_: Set values for *Baud Rate*, *Data Bits*, -*Stop Bits*, and *Handshake* method. Consult your radio's user guide -for the proper parameter values. +* _CAT Control_: To have _WSJT-X_ control the radio directly rather + than though another program, make the following settings: -* _Force Control Lines_: A few station setups require the CAT serial -port’s *RTS* and/or *DTR* control lines to be forced high or -low. Check these boxes only if you are sure they are needed (for -example, to power the radio serial interface). +** Select the *Serial Port* or *Network Server* including the service + port number used to communicate with your radio. -- _PTT Method_: select *VOX*, *CAT*, *DTR*, or *RTS* as the desired -method for T/R switching. If your choice is *DTR* or *RTS*, select -the desired serial port (which may be the same one as used for -CAT control). ++ -- _Transmit Audio Source_: some radios permit you to choose the -connector that will accept Tx audio. If this choice is enabled, -select *Rear/Data* or *Front/Mic*. +NOTE: A special value of *USB* is available for custom USB devices + like those used by some SDR kits. This is not the same a virtual + serial port provided by USB connected transcivers and CAT + interfaces, for those use the COM or serial port name that + refers to them. -- _Mode_: _WSJT-X_ uses upper sideband mode for both transmitting and -receiving. Select *USB*, or choose *Data/Pkt* if your radio offers -such an option and uses it to enable the rear-panel audio line input. -Some radios also offer wider and/or flatter passbands when set to -*Data/Pkt* mode. Select *None* if you do not want _WSJT-X_ to change -the radio's Mode setting. +** _Serial Port Parameters_: Set values for *Baud Rate*, *Data Bits*, + *Stop Bits*, and *Handshake* method. Consult your radio's user + *guide for the proper parameter values. -- _Split Operation_: Significant advantages result from using *Split* -mode (separate VFOs for Rx and Tx) if your radio supports it. If it -does not, _WSJT-X_ can emulate such behavior. Either method will -result in a cleaner transmitted signal, by keeping the Tx audio always -in the range 1500 to 2000 Hz so that audio harmonics cannot pass -through the Tx sideband filter. Select *Rig* to use the radio's Split -mode, or *Fake It* to have _WSJT-X_ adjust the VFO frequency as -needed, when T/R switching occurs. Choose *None* if you do not -wish to use split operation. ++ + +NOTE: CAT interfaces that require handshaking will be non-responsive + until the correct *Handshake* setting is applied. + +** _Force Control Lines_: A few station setups require the CAT serial + port’s *RTS* and/or *DTR* control lines to be forced high or + low. Check these boxes *only* if you are sure they are needed (for + example, to power the radio serial interface). + +* _PTT Method_: select *VOX*, *CAT*, *DTR*, or *RTS* as the desired + method for T/R switching. If your choice is *DTR* or *RTS*, select + the desired serial port (which may be the same one as used for CAT + control). + ++ + +NOTE: When using a proxy application for rig control, *CAT* is usually + the correct option for _PTT Method_ assuming the proxy + application is capable of keying your transceiver idependently. + +* _Transmit Audio Source_: some radios permit you to choose the + connector that will accept Tx audio. If this choice is enabled, + select *Rear/Data* or *Front/Mic*. + +* _Mode_: _WSJT-X_ uses upper sideband mode for both transmitting and + receiving. Select *USB*, or choose *Data/Pkt* if your radio offers + such an option and uses it to enable the rear-panel audio line + input. Some radios also offer wider and/or flatter passbands when + set to *Data/Pkt* mode. Select *None* if you do not want _WSJT-X_ + to change the radio's Mode setting. + +* _Split Operation_: Significant advantages result from using *Split* + mode (separate VFOs for Rx and Tx) if your radio supports it. If it + does not, _WSJT-X_ can emulate such behavior. Either method will + result in a cleaner transmitted signal, by keeping the Tx audio + always in the range 1500 to 2000 Hz so that audio harmonics cannot + pass through the Tx sideband filter. Select *Rig* to use the + radio's Split mode, or *Fake It* to have _WSJT-X_ adjust the VFO + frequency as needed, when T/R switching occurs. Choose *None* if + you do not wish to use split operation. When all required settings have been made, click *Test CAT* to test communication between _WSJT-X_ and your radio. The button should turn diff --git a/doc/user_guide/en/transceiver-setup.adoc b/doc/user_guide/en/transceiver-setup.adoc index 060414c41..b281c4b9b 100644 --- a/doc/user_guide/en/transceiver-setup.adoc +++ b/doc/user_guide/en/transceiver-setup.adoc @@ -2,53 +2,63 @@ .Receiver Noise Level - If it is not already highlighted in green, click the *Monitor* -button to start normal receive operation. + button to start normal receive operation. - Be sure your transceiver is set to *USB* (or *USB Data*) mode. - Use the receiver gain controls and/or the computer's audio mixer -controls to set the background noise level (scale at lower left of -main window) to around 30 dB when no signals are present. It is -usually best to turn AGC off or reduce the RF gain control to minimize -AGC action. + controls to set the background noise level (scale at lower left of + main window) to around 30 dB when no signals are present. It is + usually best to turn AGC off or reduce the RF gain control to + minimize AGC action. + ++ + +TIP: The PC audio mixer normally has two sliders, one for each + application attached which should be set to maximum (0dB FS) as + it cannot help with distortion from overly high or low input + levels from your receiver and another *Master* level which is + analogue attenuator on the sound card before the Analogue to + Digital Converter (ADC). The *Master* level can be used to adjust + the signal level received by _WSJT-X_. .Bandwidth and Frequency Setting - If your transceiver offers more than one bandwidth setting in USB -mode, it may be advantageous to choose the widest one possible, up to -about 5 kHz. This choice has the desirable effect of allowing the -*Wide Graph* (waterfall and 2D spectrum) to display the conventional -JT65 and JT9 sub-bands simultaneously on most HF bands. Further -details are provided in the <>. A -wider displayed bandwidth may also be helpful at VHF and above, where -FT8, JT4, JT65, and QRA64 signals may be found over much wider ranges -of frequencies. + mode, it may be advantageous to choose the widest one possible, up + to about 5 kHz. This choice has the desirable effect of allowing + the *Wide Graph* (waterfall and 2D spectrum) to display the + conventional JT65 and JT9 sub-bands simultaneously on most HF bands. + Further details are provided in the <>. A wider displayed bandwidth may also be helpful at VHF + and above, where FT8, JT4, JT65, and QRA64 signals may be found over + much wider ranges of frequencies. - If you have only a standard SSB filter you won’t be able to display -more than about 2.7 kHz bandwidth. Depending on the exact dial -frequency setting, on HF bands you can display the full sub-band -generally used for one mode. + more than about 2.7 kHz bandwidth. Depending on the exact dial + frequency setting, on HF bands you can display the full sub-band + generally used for one mode. - Of course, you might prefer to concentrate on one mode at a time, -setting your dial frequency to (say) 14.074 for FT8, 14.076 for JT65, -or 14.078 for JT9. Present conventions have the nominal JT9 dial -frequency 2 kHz higher than the JT65 dial frequency on most bands, and -the FT8 frequency 2 kHz lower. + setting your dial frequency to (say) 14.074 for FT8, 14.076 for + JT65, or 14.078 for JT9. Present conventions have the nominal JT9 + dial frequency 2 kHz higher than the JT65 dial frequency on most + bands, and the FT8 frequency 2 kHz lower. .Transmitter Audio Level -* Click the *Tune* button on the main screen to switch the -radio into transmit mode and generate a steady audio tone. +* Click the *Tune* button on the main screen to switch the radio into + transmit mode and generate a steady audio tone. * Listen to the generated audio tone using your radio’s *Monitor* -facility. The transmitted tone should be perfectly smooth, with no -clicks or glitches. Make sure that this is true even when you -simultaneously use the computer to do other tasks such as email, web -browsing, etc. + facility. The transmitted tone should be perfectly smooth, with no + clicks or glitches. Make sure that this is true even when you + simultaneously use the computer to do other tasks such as email, web + browsing, etc.. * Adjust the *Pwr* slider (at right edge of main window) downward from -its maximum until the RF output from your transmitter falls slightly. -This is generally a good level for audio drive. + its maximum until the RF output from your transmitter falls + slightly. This is generally a good level for audio drive. * Toggle the *Tune* button once more or click *Halt Tx* to stop your -test transmission. + test transmission. diff --git a/doc/user_guide/en/tutorial-example1.adoc b/doc/user_guide/en/tutorial-example1.adoc index 8ad5d73bb..ff7ad4d55 100644 --- a/doc/user_guide/en/tutorial-example1.adoc +++ b/doc/user_guide/en/tutorial-example1.adoc @@ -64,6 +64,8 @@ so that a transmission will start automatically at the proper time. *Shift* key to move only the Tx frequency or the *Ctrl* key to move both Rx and Tx frequencies. ++ + NOTE: You can prevent your Tx frequency from being changed by checking the box *Hold Tx Freq*. diff --git a/doc/user_guide/en/tutorial-example2.adoc b/doc/user_guide/en/tutorial-example2.adoc index e7aa3aeee..b51227c74 100644 --- a/doc/user_guide/en/tutorial-example2.adoc +++ b/doc/user_guide/en/tutorial-example2.adoc @@ -50,6 +50,8 @@ image::decodes.png[align="center"] earlier, in <>. _WSJT-X_ automatically determines the mode of each JT9 or JT65 message. ++ + TIP: When you double-click on a signal in the waterfall it will be properly decoded even if on the "`wrong`" side of the *JT65 nnnn JT9* marker. The Tx mode automatically switches to that of the decoded diff --git a/doc/user_guide/en/tutorial-example3.adoc b/doc/user_guide/en/tutorial-example3.adoc index 931067760..6e4e98c56 100644 --- a/doc/user_guide/en/tutorial-example3.adoc +++ b/doc/user_guide/en/tutorial-example3.adoc @@ -43,16 +43,16 @@ frequency to that of the selected message and leaving Tx frequency unchanged. To change both Rx and Tx frequencies, hold *Ctrl* down when double-clicking. -NOTE: To avoid QRM from competing callers, it is frequently desirable +TIP: To avoid QRM from competing callers, it is frequently desirable to answer a CQ on a different frequency from that of the CQing station. The same is true when you tail-end another QSO. Choose a Tx frequency that appears to be not in use. You might want to check the box *Hold Tx Freq*. -NOTE: Keyboard shortcuts *Shift+F11* and *Shift+F12* provide an easy +TIP: Keyboard shortcuts *Shift+F11* and *Shift+F12* provide an easy way to move your Tx frequency down or up in 60 Hz steps. -NOTE: An online {ft8_tips} by ZL2IFB offers many helpful tips on +TIP: An online {ft8_tips} by ZL2IFB offers many helpful tips on operating procedures. .FT8 DXpedition Mode: diff --git a/doc/user_guide/en/tutorial-main-window.adoc b/doc/user_guide/en/tutorial-main-window.adoc index 09a17b196..c585b1f6a 100644 --- a/doc/user_guide/en/tutorial-main-window.adoc +++ b/doc/user_guide/en/tutorial-main-window.adoc @@ -6,6 +6,8 @@ - Set the audio frequencies to *Tx 1224 Hz* and *Rx 1224 Hz*. ++ + TIP: Sliders and spinner controls respond to *Arrow* key presses and *Page Up/Down* key presses, with the *Page* keys moving the controls in larger steps. You can also type numbers directly into diff --git a/doc/user_guide/en/vhf-features.adoc b/doc/user_guide/en/vhf-features.adoc index d0a4cd731..1838529ce 100644 --- a/doc/user_guide/en/vhf-features.adoc +++ b/doc/user_guide/en/vhf-features.adoc @@ -1,5 +1,6 @@ -_WSJT-X_ v1.9 suppports a number of features designed for use -on the VHF and higher bands. These features include: +_WSJT-X_ v{VERSION_MAJOR}.{VERSION_MINOR} suppports a number of +features designed for use on the VHF and higher bands. These features +include: - *FT8*, a mode designed for making fast QSOs with weak, fading signals @@ -276,6 +277,8 @@ this number is well below 100% you may increase the decoding depth from *Fast* to *Normal* or *Deep*, and increase *F Tol* from 100 to 200 Hz. ++ + NOTE: Most modern multi-core computers can easily handle the optimum parameters *Deep* and *F Tol 200*. Older and slower machines may not be able to keep up at these settings; at the *Fast* and *Normal* @@ -303,6 +306,7 @@ enclosed in <> angle brackets, as in the following model QSO RRR 73 ++ NOTE: There is little or no advantage to using MSK144 *Sh* messages at 50 or 70 MHz. At these frequencies, most pings are long diff --git a/doc/user_guide/en/wsjtx-main.adoc b/doc/user_guide/en/wsjtx-main.adoc index 704ad74c4..6b190e0a2 100644 --- a/doc/user_guide/en/wsjtx-main.adoc +++ b/doc/user_guide/en/wsjtx-main.adoc @@ -1,5 +1,5 @@ // This is a comment line, anything with // is ignored at process time. -= _WSJT-X 2.0_ User Guide += _WSJT-X {VERSION_MAJOR}.{VERSION_MINOR}_ User Guide Joseph H Taylor, Jr, K1JT :revnumber: {VERSION} // For web-pages, adding :badges: is ok, but is a security issue for diff --git a/doc/user_guide/en/wspr.adoc b/doc/user_guide/en/wspr.adoc index 960235988..d54a97544 100644 --- a/doc/user_guide/en/wspr.adoc +++ b/doc/user_guide/en/wspr.adoc @@ -11,6 +11,8 @@ desired size. - Select an active WSPR frequency (for example, 10.1387 or 14.0956 MHz). ++ + IMPORTANT: If you will transmit in the 60 m band, be sure to choose a frequency that conforms with your local regulations.