Merge branch 'develop' of bitbucket.org:k1jt/wsjtx into develop

Release_Notes.txt

@@ -10,7 +10,99 @@
                                                          
                                                          
                                                          
-Copyright 2001 - 2019 by Joe Taylor, K1JT.
+Copyright 2001 - 2020 by Joe Taylor, K1JT.
+
+		   Release: WSJT-X 2.2.0-rc1
+		          May 10, 2019
+		   -------------------------
+
+WSJT-X 2.2.0-rc1 is a beta-quality release candidate for a program
+upgrade that provides a number of new features and capabilities.  These
+include:
+
+  - Improvements to the decoders for five modes:
+ 
+      FT4: Corrected bugs that prevented AP decoding and/or multi-pass
+      decoding in some circumstances.  The algorithm for AP
+      decoding has been improved and extended.
+
+      FT8: Decoding is now spread over three intervals.  The first
+      starts at t = 11.8 s into an Rx sequence and typically yields
+      around 85% of the possible decodes for the sequence.  You
+      therefore see most decodes much earlier than before.  A second
+      processing step starts at 13.5 s, and the final one at 14.7 s.
+      Overall decoding yield on crowded bands is improved by 10% or
+      more.  (Systems with receive latency greater than 0.2 s will see
+      smaller improvements, but will still see many decodes earlier
+      than before.)
+
+      JT4: Formatting and display of Averaged and Deep Search decodes
+      has been cleaned up and made consistent with other modes.
+      Together with JT65 and QRA64, JT4 remains one of the digital
+      modes widely for EME and other extreme weak-signal work on
+      microwave bands.
+
+      JT65: Many improvements for Averaged and Deep Search decodes and
+      their display to the user.  These improvements are particularly
+      important for EME on VHF and UHF bands.
+
+      WSPR: Significant improvements have been made to the WSPR
+      decoder's sensitivity, its ability to cope with many signals in
+      a crowded sub-band, and its rate of undetected false decodes.
+      We now use up to three decoding passes.  Passes 1 and 2 use
+      noncoherent demodulation of single symbols and allow for
+      frequency drifts up to ±4 Hz in a transmission.  Pass 3 assumes
+      no drift and does coherent block detection of up to three
+      symbols.  It also applies bit-by-bit normalization of the
+      single-symbol bit metrics, a technique that has proven helpful
+      for signals corrupted by artifacts of the subtraction of
+      stronger signals and also for LF/MF signals heavily contaminated
+      by lightning transients.  With these improvements the number of
+      decodes in a crowded WSPR sub-band typically increases by 10 to
+      15%.
+
+ - New format for "EU VHF Contest" Tx2 and Tx3 messages
+
+      When "EU VHF Contest" is selected, the Tx2 and Tx3 messages
+      (those conveying signal report, serial number, and 6-character
+      locator) now use hashcodes for both callsigns.  This change is
+      NOT backward compatible with earlier versions of _WSJT-X_, so
+      all users of EU VHF Contest messages should be sure to upgrade
+      to versiion 2.2.0.
+
+ - Accessibility
+
+      Keyboard shortcuts have been added as an aid to accessibility:
+      Alt+R sets Tx4 message to RR73, Ctrl+R sets it to RRR.
+
+      As an aid for partial color-blindness, the "inverted goal posts"
+      marking Rx frequency on the Wide Graph's frequency scale are now
+      rendered in a darker shade of green.
+
+ - Minor enhancements and bug fixes
+
+      "Save None" now writes no .wav files to disk, even temporarily.
+
+      An explicit entry for "WW Digi Contest" has been added to
+      "Special operating activities" on the "Settings | Advanced" tab.
+
+      Contest mode FT4 now always uses RR73 for the Tx4 message.
+
+      The Status bar now displays the number of decodes found in the
+      most recent Rx sequence.
+
+Release candidate WSJT-X 2.2.0-rc1 will be available for beta-testing
+for one month starting on May 10, 2020.  We currently plan a General
+Availability (GA) release of WSJT-X 2.2.0 on June 1, 2020.
+
+For those looking even farther ahead: We are well along in the
+development of two new modes designed for the LF and MF bands.  One
+mode is for WSPR-like activity and one for making 2-way QSOs.  Both
+use Low-density Parity Check (LDPC) codes, 4-GFSK modulation, and
+two-minute T/R sequences.  The QSO mode reaches threshold SNR
+sensitivity around -31 dB on the AWGN channel, and the WSPR-like mode
+better than -32 dB.
+
 
 		   Release: WSJT-X 2.1.1
 		     November 25, 2019
@@ -836,5 +928,5 @@ activated in v1.8.0.
 We haven't yet finalized what the three extra bits in the message
 payload will be used for.  Suggestions are welcome!
 
-	-- Joe, K1JT, for the WSJT Development Team
+++++++	-- Joe, K1JT, for the WSJT Development Team
 	

doc/user_guide/en/controls-functions-center.adoc

@@ -17,10 +17,11 @@ double-click on a decoded text line, as described in the
 double-clicking on decoded text or a signal in the waterfall.  They
 can also be adjusted using the spinner controls.
 
-* You can force Tx frequency to the current Rx frequency by clicking
-the *Tx<-Rx* button, and vice-versa for *Rx<-Tx*.  The on-the-air
-frequency of your lowest JT9 or JT65 tone is the sum of dial frequency
-and audio Tx frequency.
+* You can copy values between the *Tx Freq* and *Rx Freq* boxes by
+clicking on the up/down arrows between the controls.  Your
+on-the-air frequency is the sum of dial frequency and audio Tx
+frequency.  By convention we define the frequency of WSJT-X modes as
+the frequency of the lowest tone.
 
 * Check the box *Hold Tx Freq* to ensure that the specified Tx
 frequency is not changed automatically when you double-click on
@@ -54,7 +55,7 @@ and reception in ISCAT, MSK144, and the fast JT9 modes.
 MSK144 and the fast JT9 submodes you can activate the spinner control
 *Tx CQ nnn* by checking the box to its right.  The program will then
 generate something like `CQ nnn K1ABC FN42` for your CQ message, where
-`nnn` is the kHz portion of your current operating frequency,
+`nnn` is the kHz portion of your current dial frequency,
 in the range 010 to 999.  Your CQ
 message *Tx6* will then be transmitted at the calling frequency
 selected in the *Tx CQ nnn* spinner control.  All other messages will

doc/user_guide/en/controls-functions-main-window.adoc

@@ -1,6 +1,6 @@
-// Status=review
-The following controls appear just under the decoded text windows on
-the main screen:
+// Status=review The following controls appear just under the decoded
+text windows on the main screen.  Some controls appear only in certain
+operating modes.
 
 //.Main UI 
 image::main-ui-controls.png[align="center",width=650,alt="Main UI Controls"]

doc/user_guide/en/controls-functions-wide-graph.adoc

@@ -97,7 +97,6 @@ color and line width for the plots.
 
 Most windows can be resized as desired.  If you are short of screen
 space you can make the Main Window and Wide Graph smaller by hiding
-some controls and labels.  To enable this feature type *Ctrl+M* with
-focus on the appropriate window.  (For the Main Window you can select
-*Hide menus and labels* on the *View* menu.)  Type *Ctrl+M* again
-to make the controls visible once more.
+some controls and labels.  To enable this feature uncheck the box
+labales *Controls* at top left of the *Wide Graph* window, or the box 
+*Menus* to the right of the *Tune* button on the Main Window.

doc/user_guide/en/decoder_notes.adoc

@@ -1,10 +1,10 @@
 === AP Decoding
 
-The _WSJT-X_ decoders for JT65, QRA64, and FT8 include optional
-procedures that use naturally accumulating information during a
-minimal QSO.  This _a priori_ (AP) information increases sensitivity
-of the decoder by up to 4 dB, at the cost of a slightly higher rate of
-false decodes.
+The _WSJT-X_ decoders for FT4, FT8, JT65, and QRA64 include optional
+procedures that take advantage of naturally accumulating information
+during a minimal QSO.  This _a priori_ (AP) information increases
+sensitivity of the decoder by up to 4 dB, at the cost of a slightly
+higher rate of false decodes.
 
 For example: when you decide to answer a CQ, you already know your own
 callsign and that of your potential QSO partner.  The software
@@ -12,7 +12,7 @@ therefore "`knows`" what might be expected for at least 57 message
 bits (28 for each of two callsigns, 1 or more for message type) in the
 next received message.  The decoder's task can thus be reduced to
 determining the remaining 15 bits of the message and ensuring that the
-resulting solution is reliable.
+resulting solution is consistent with the message's parity symbols.
 
 AP decoding starts by setting AP bits to the hypothesized values, as
 if they had been received correctly.  We then determine whether the
@@ -20,11 +20,11 @@ remaining message and parity bits are consistent with the hypothesized
 AP bits, with a specified level of confidence.  Successful AP decodes
 are labeled with an end-of-line indicator of the form `aP`, where `P`
 is one of the single-digit AP decoding types listed in Table 1.  For
-example, `a2` indicates that the successful decode used MyCall as
+example, `a2` indicates that the successful decode used *MyCall* as
 hypothetically known information.
 
 [[FT8_AP_INFO_TABLE]]
-.FT8 AP information types
+.FT4 and FT8 AP information types
 [width="35%",cols="h10,<m20",frame=topbot,options="header"]
 |===============================================
 |aP | Message components
@@ -47,7 +47,7 @@ _WSJT-X_ auto-sequencer, along with the type of AP decoding that would
 be attempted in each state.
 
 [[FT8_AP_DECODING_TYPES_TABLE]]
-.FT8 AP decoding types for each QSO state
+.FT4 and FT8 AP decoding types for each QSO state
 [width="35%",cols="h10,<m20",frame=topbot,options="header"]
 |===========================================
 |State        |AP type

doc/user_guide/en/introduction.adoc

@@ -4,8 +4,7 @@ _WSJT-X_ is a computer program designed to facilitate basic amateur
 radio communication using very weak signals. The first four letters in
 the program name stand for "`**W**eak **S**ignal communication by
 K1**JT**,`" while the suffix "`-X`" indicates that _WSJT-X_ started as
-an extended and experimental branch of the program
-_WSJT_.
+an extended and experimental branch of the program _WSJT_.
 
 _WSJT-X_ Version {VERSION_MAJOR}.{VERSION_MINOR} offers ten different
 protocols or modes: *FT4*, *FT8*, *JT4*, *JT9*, *JT65*, *QRA64*,

doc/user_guide/en/make-qso.adoc

@@ -106,16 +106,16 @@ place of RRR, and the final 73 is optional.
 *EU VHF Contest*
 
  CQ TEST G4ABC IO91
-                       G4ABC PA9XYZ JO22
+                                 G4ABC PA9XYZ JO22
  <PA9XYZ> <G4ABC> 570123 IO91NP
-                       <G4ABC> <PA9XYZ> R 580071 JO22DB
+                                 <G4ABC> <PA9XYZ> R 580071 JO22DB
  PA9XYZ G4ABC RR73
 
 Either callsign (or both) may have /P appended.
 
 IMPORTANT: Messages conveying signal reports, QSO serial numbers, and
-6-character locators have been changed in _WSJT-X v2.2_ and are *NOT*
-compatible with the formats used in earlier program versions.  Be sure
+6-character locators have been changed in _WSJT-X v2.2_ and are *not
+compatible* with the formats used in earlier program versions.  Be sure
 to upgrade _WSJT-X_ if you will use *EU VHF Contest* messages.
 
 *ARRL Field Day*
@@ -309,6 +309,6 @@ as the following checklist:
 
 - Radio filters centered and set to widest available passband (up to 5 kHz).
 
-TIP: Remember that in many circumstances FT8, JT4, JT9, JT65, and WSPR
-do not require high power. Under most HF propagation conditions, QRP
-is the norm.
+TIP: Remember that in many circumstances FT4, FT8, JT4, JT9, JT65, and
+WSPR do not require high power. Under most HF propagation conditions,
+QRP is the norm.

doc/user_guide/en/new_features.adoc

@@ -45,7 +45,7 @@ in a crowded WSPR sub-band typically increases by 10 to 15%.
 
 *New message format:* When *EU VHF Contest* is selected, the Tx2 and
 Tx3 messages -- those conveying signal report, serial number, and
-6-character locator -- now use hashcodes for both callsigns .  This
+6-character locator -- now use hashcodes for both callsigns.  This
 change is *not* backward compatible with earlier versions of _WSJT-X_, so
 all users of *EU VHF Contest* messages should be sure to upgrade to
 versiion 2.2.0.  See <<CONTEST_MSGS,Contest Messages>> for details.

doc/user_guide/en/settings-advanced.adoc

@@ -38,7 +38,8 @@ with twice or four times the normal tone spacing.  This feature is
 intended for use with specialized LF/MF transmitters that divide
 generated frequencies by 2 or 4 as part of the transmission process.
 
-_Special Operating Activity: Generation of FT8 and MSK144 messages_
+_Special Operating Activity: Generation of FT4, FT8, and MSK144
+messages_
 
 - Check this box and select the type of activity to enable
 auto-generation of special message formats for contesting and

doc/user_guide/en/tutorial-example4.adoc

@@ -1,7 +1,6 @@
 FT4 is designed for contesting, particularly on the HF bands.
 Compared with FT8 it is 3.5 dB less sensitive and requires 1.6 times
 the bandwidth, but it offers the potential for twice the QSO rate.
-FT4 is not recommended for everyday use.
 
 .Main Window:
 - Select *FT4* on the *Mode* menu.

doc/user_guide/en/vhf-features.adoc

@@ -1,25 +1,21 @@
 _WSJT-X_ supports 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
+- *FT4*, designed especially for contesting
 
-- *JT4*, a mode particularly useful for EME on the microwave bands
+- *FT8*, designed for making fast QSOs with weak, fading signals
 
-- *JT9* fast modes, useful for scatter propagation on VHF bands
+- *JT4*, particularly useful for EME on the microwave bands
+
+- *JT9 fast modes*, useful for scatter propagation on VHF bands
 
 - *JT65*, widely used for EME on VHF and higher bands
 
-- *QRA64*, a mode for EME using a "`Q-ary Repeat Accumulate`" code,
-a low-density parity-check (LDPC) code using a 64-character symbol
-alphabet
+- *QRA64*, another mode for EME
 
-- *MSK144*, a mode for meteor scatter using a binary LDPC code and
-Offset Quadrature Phase-Shift Keying (OQPSK).  The resulting waveform
-is sometimes called Minimum Shift Keying (MSK).
+- *MSK144*, for meteor scatter
 
-- *ISCAT*, intended for aircraft scatter and other types of scatter
-propagation
+- *ISCAT*, for aircraft scatter and other types of scatter propagation
 
 - *Echo* mode, for detecting and measuring your own lunar echoes
 
@@ -215,10 +211,10 @@ initially, as the QRA64 tones are often not visible on the waterfall.
 The box labeled *Tx6* switches the Tx6 message from 1000Hz to 1250Hz
 to indicate to the other station that you are ready to receive messages.
 
-TIP: QRA64 is different from JT65 in that the decoder attempts to find
-and decode only a single signal in the receiver passband.  If many
-signals are present, you may be able to decode them by double-clicking
-on the lowest tone of each one in the waterfall.
+TIP: QRA64 attempts to find and decode only a single signal in the
+receiver passband.  If many signals are present, you may be able to
+decode them by double-clicking on the lowest tone of each one in the
+waterfall.
 
 TIP: G3WDG has prepared a more detailed tutorial on using {QRA64_EME}.