w4kek/WSJT-X
1
0
Fork 0
mirror of https://github.com/saitohirga/WSJT-X.git synced 2025-04-05 19:08:38 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add PDF generation to docs target

Browse Source 
Cleaned  up   some  syntax   anomolies  because   of  the   switch  to
asciidoctor. Minor text tweaks to improve PDF pagination. Reduced HTML
master font size to 80% for better web rendering.

Removed references to KVASD from User Guide.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6142 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Bill Somerville 2015-11-21 02:34:20 +00:00
parent b0f70512f7
commit 6c6a758b8b
39 changed files with 841 additions and 808 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
doc/CMakeLists.txt
View File

@ -5,6 +5,8 @@ set (common_SRCS
)
set (UG_SRCS
user_guide/docinfo.html
user_guide/docinfo.xml
user_guide/acknowledgements.adoc
user_guide/compiling.adoc
user_guide/config-details.adoc
@ -96,45 +98,89 @@ Building the documenation may optionally be turned off by setting the CMake
option WSJT_GENERATE_DOCS to OFF.")
endif (NOT ASCIIDOCTOR_EXECUTABLE)
find_program (FOPUB_EXECUTABLE NAMES fopub)
include (CMakeParseArguments)
# generate an HTML document from asciidoc text files(s)
# generate a document from asciidoc text files(s)
#
# HTML - variable for output file ${CMAKE_CURRENT_BINARY_DIR}/`$basename ${SOURCE}`.html
# HTML - generate an HTML document
# PDF - generate a PDF document
# SOURCE - top level asciidoc file
# ASCIIDOCTOR_OPTIONS - asciidoctor command options
# DEPENDS - dependent files
function (html_document)
cmake_parse_arguments (args "" "SOURCE;HTML" "ASCIIDOCTOR_OPTIONS;DEPENDS" ${ARGN})
get_filename_component (_output_name_we ${args_SOURCE} NAME_WE)
get_filename_component (_path ${args_SOURCE} PATH)
set (_doc_file ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.html)
add_custom_command (
OUTPUT ${_doc_file}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${path}
COMMAND ${ASCIIDOCTOR_EXECUTABLE} ${args_ASCIIDOCTOR_OPTIONS}
-b html5
-a VERSION_MAJOR=${WSJTX_VERSION_MAJOR}
-a VERSION_MINOR=${WSJTX_VERSION_MINOR}
-a VERSION_PATCH=${WSJTX_VERSION_PATCH}
-a VERSION=${wsjtx_VERSION}
--out-file=${_doc_file} ${args_SOURCE}
DEPENDS ${args_DEPENDS}
COMMENT "Generating ${_doc_file}"
)
set (${args_HTML} ${_doc_file} PARENT_SCOPE)
endfunction (html_document)
function (document)
cmake_parse_arguments (_args "HTML" "SOURCE;OUTPUT" "ASCIIDOCTOR_OPTIONS;PDF;DEPENDS" ${ARGN})
get_filename_component (_source_path ${_args_SOURCE} PATH)
get_filename_component (_source_name ${_args_SOURCE} NAME)
get_filename_component (_output_name_we ${_args_SOURCE} NAME_WE)
html_document(
HTML user_guide
# HTML
if (${_args_HTML})
set (_html_file ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.html)
add_custom_command (
OUTPUT ${_html_file}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${_source_path}
COMMAND ${ASCIIDOCTOR_EXECUTABLE} ${_args_ASCIIDOCTOR_OPTIONS}
-b html5
-a VERSION_MAJOR=${WSJTX_VERSION_MAJOR}
-a VERSION_MINOR=${WSJTX_VERSION_MINOR}
-a VERSION_PATCH=${WSJTX_VERSION_PATCH}
-a VERSION=${wsjtx_VERSION}
--out-file=${_html_file} ${_source_name}
DEPENDS ${_args_DEPENDS}
COMMENT "Generating ${_html_file}"
)
list (APPEND _output_files ${_html_file})
endif (${_args_HTML})
# PDF
if (_args_PDF AND EXISTS ${FOPUB_EXECUTABLE})
set (_docbook_file ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.xml)
set (_pdf_file_we ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we})
add_custom_command (
OUTPUT ${_docbook_file} "${_pdf_file_we} (USLetter).pdf" "${_pdf_file_we} (A4).pdf"
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${_source_path}
COMMAND ${ASCIIDOCTOR_EXECUTABLE} ARGS ${_args_ASCIIDOCTOR_OPTIONS}
-b docbook
-a data-uri!
-a VERSION_MAJOR=${WSJTX_VERSION_MAJOR}
-a VERSION_MINOR=${WSJTX_VERSION_MINOR}
-a VERSION_PATCH=${WSJTX_VERSION_PATCH}
-a VERSION=${wsjtx_VERSION}
-D ${CMAKE_CURRENT_BINARY_DIR}
-o ${_docbook_file} ${_source_name}
COMMAND ${FOPUB_EXECUTABLE} ARGS ${_docbook_file} ${_args_PDF} -param paper.type USLetter
COMMAND ${CMAKE_COMMAND} ARGS -E rename ${_pdf_file_we}.pdf '${_pdf_file_we} \(USLetter\).pdf'
COMMAND ${FOPUB_EXECUTABLE} ARGS ${_docbook_file} ${_args_PDF} -param paper.type A4
COMMAND ${CMAKE_COMMAND} ARGS -E rename ${_pdf_file_we}.pdf '${_pdf_file_we} \(A4\).pdf'
DEPENDS ${_args_DEPENDS}
COMMENT "Generating ${_pdf_file_we}.pdf"
)
list (APPEND _output_files "${_pdf_file_we} (USLetter).pdf" "${_pdf_file_we} (A4).pdf")
endif (_args_PDF AND EXISTS ${FOPUB_EXECUTABLE})
set (${_args_OUTPUT} ${_output_files} PARENT_SCOPE)
endfunction (document)
document(
HTML
SOURCE user_guide/wsjtx-main.adoc
ASCIIDOCTOR_OPTIONS -d book -a data-uri -a toc=left -a max-width=1100px
OUTPUT html
ASCIIDOCTOR_OPTIONS -d book -a data-uri -a toc=left -a max-width=1024px
DEPENDS ${common_SRCS} ${UG_SRCS} ${UG_IMGS}
)
add_custom_target (docs ALL DEPENDS ${user_guide})
document(
PDF -param body.font.master 11 -param body.font.family "'Noto Sans, Helvetica, sans-serif'" -param title.font.family "'Noto Serif, Times New Roman, serif'" -param page.margin.inner 1cm -param page.margin.outer 1cm -param page.margin.top 0.75cm -param page.margin.bottom 0.5cm -param generate.toc 0
SOURCE user_guide/wsjtx-main.adoc
OUTPUT pdf
ASCIIDOCTOR_OPTIONS -d book
DEPENDS ${common_SRCS} ${UG_SRCS} ${UG_IMGS}
)
add_custom_target (docs ALL DEPENDS ${html} ${pdf})
install (FILES
${user_guide}
${html}
DESTINATION ${WSJT_SHARE_DESTINATION}/${WSJT_DOC_DESTINATION}
RENAME ${PROJECT_MANUAL}
#COMPONENT runtime

2
doc/user_guide/acknowledgements.adoc
View File

@ -1,7 +1,7 @@
// Status=review
Since 2005 the _WSJT_ project (including programs _WSJT_, _MAP65_,
_WSPR_, _WSJT-X_, and _WSPR-X_) has been ``open source'', with all
_WSPR_, _WSJT-X_, and _WSPR-X_) has been "`open source`", with all
code licensed under the GNU Public License (GPL). Many users of these
programs, too numerous to mention here individually, have contributed
suggestions and advice that have greatly aided the development of

8
doc/user_guide/config-details.adoc
View File

@ -1,4 +1,4 @@
// Status=review
[[CONFIG_DETAILS]]
Are we here?
// Status=review
[[CONFIG_DETAILS]]
Are we here?

2
doc/user_guide/controls-functions-center.adoc
View File

@ -4,7 +4,7 @@ At the center of the main window are a number of controls used when
making QSOs:
//.Misc Controls Center
image::images/misc-controls-center.png[align="center",alt="Misc Controls Center"]
image::misc-controls-center.png[align="center",alt="Misc Controls Center"]
* Check *Tx even* to transmit in even-numbered UTC minutes. Uncheck
this box to transmit in the odd minutes. This selection is made

2
doc/user_guide/controls-functions-left.adoc
View File

@ -5,7 +5,7 @@ station being called, and date and time are found at lower left of the
main window:
//.Misc Controls Left
image::images/misc-main-ui.png[align="center",alt="Mist Menu Items"]
image::misc-main-ui.png[align="center",alt="Misc Menu Items"]
* A drop-down list of frequencies and bands at upper left lets you
select the operating band and sets dial frequency to a value taken

4
doc/user_guide/controls-functions-main-window.adoc
View File

@ -3,7 +3,7 @@ The following buttons appear just under the decoded text windows on
the main screen:
//.Main UI Controls
image::images/main-ui-controls.png[align="left",width=650,alt="Main UI Controls"]
image::main-ui-controls.png[align="left",width=650,alt="Main UI Controls"]
* *Log QSO* raises a dialog window pre-filled with known information
about a QSO you have nearly completed. You can edit or add to this
@ -13,7 +13,7 @@ confirmation screen automatically when you send a message containing
73.
//.Log QSO Window
image::images/log-qso.png[align="center",alt="Log QSO"]
image::log-qso.png[align="center",alt="Log QSO"]
* *Stop* will terminate normal data acquisition in case you want to
freeze the waterfall or open and explore a previously recorded audio

18
doc/user_guide/controls-functions-menus.adoc
View File

@ -6,7 +6,7 @@ provided below. Keyboard shortcuts for some frequently used menu
items are listed at the right.
==== WSJT-X menu
image::images/MacAppMenu.png[align="left",alt="Mac App Menu"]
image::MacAppMenu.png[align="left",alt="Mac App Menu"]
This menu appears on the Macintosh only. *Settings* appears here,
labeled as *Preferences*, rather than on the *File* menu. *About
@ -14,24 +14,24 @@ WSJT-X* appears here rather than on the *Help* menu.
[[FILE_MENU]]
==== File menu
image::images/file-menu.png[align="left",alt="File Menu"]
image::file-menu.png[align="left",alt="File Menu"]
[[VIEW_MENU]]
==== View Menu
image::images/view-menu.png[align="left",alt="View Menu"]
image::view-menu.png[align="left",alt="View Menu"]
[[MODE_MENU]]
==== Mode Menu
image::images/mode-menu.png[align="left",alt="Mode Menu"]
image::mode-menu.png[align="left",alt="Mode Menu"]
[[DECODE_MENU]]
==== Decode Menu
image::images/decode-menu.png[align="left",alt="Decode Menu"]
image::decode-menu.png[align="left",alt="Decode Menu"]
[[SAVE_MENU]]
[[SAVE-WAV]]
==== Save Menu
image::images/save-menu.png[align="left",alt="Save Menu"]
image::save-menu.png[align="left",alt="Save Menu"]
Choose *Save all* to save received data as audio +.wav+ files.
*Save decoded* will save only those files containing at least one
@ -39,10 +39,10 @@ decoded message.
[[HELP_MENU]]
==== Help Menu
image::images/help-menu.png[align="left",alt="Help Menu"]
image::help-menu.png[align="left",alt="Help Menu"]
===== Keyboard Shortcuts (F3)
image::images/keyboard-shortcuts.png[align="left",alt="Help Menu"]
image::keyboard-shortcuts.png[align="left",alt="Keyboard Shortcuts"]
===== Special Mouse Commands (F5)
image::images/special-mouse-commands.png[align="left",alt="Help Menu"]
image::special-mouse-commands.png[align="left",alt="Special Mouse Commands"]

4
doc/user_guide/controls-functions-messages.adoc
View File

@ -8,7 +8,7 @@ you click *Generate Std Msgs* or double-click on an appropriate line
in one of the decoded text windows.
//.Traditional Message Menu
image::images/traditional-msg-box.png[align="center",alt="Traditional Message Menu"]
image::traditional-msg-box.png[align="center",alt="Traditional Message Menu"]
* Select the next message to be transmitted (at the start of your next
Tx sequence) by clicking on the circle under *Next*.
@ -33,7 +33,7 @@ The second arrangement of controls for generating and selecting
Tx messages appears on *Tab 2* of the Message Control Panel:
//.New Message Menu
image::images/new-msg-box.png[align="center",alt="New Message Menu"]
image::new-msg-box.png[align="center",alt="New Message Menu"]
With this setup you normally follow a top-to-bottom sequence of
transmissions from the left column if you are calling CQ, or the right

2
doc/user_guide/controls-functions-status-bar.adoc
View File

@ -4,7 +4,7 @@ A *Status Bar* at the bottom edge of the main window provides
information about operating conditions.
//.Status Bar
image::images/status-bar-a.png[align="left",alt="New Message Menu"]
image::status-bar-a.png[align="left",alt="Status Bar"]
Labels on the *Status Bar* display such information as the program's
current operating state, operating mode, the content of your most

2
doc/user_guide/controls-functions-wide-graph.adoc
View File

@ -4,7 +4,7 @@ The following controls appear at the bottom of the Wide Graph window.
With the exception of *JT65 nnnn JT9*, they affect only the graphical
displays — they have no effect on the decoding process.
image::images/wide-graph-controls.png[align="center",alt="Wide Graph Controls"]
image::wide-graph-controls.png[align="center",alt="Wide Graph Controls"]
- *Bins/Pixel* controls the displayed frequency resolution. Set this
value to 1 for the highest possible resolution, or to higher numbers

4
doc/user_guide/cooperating-programs.adoc
View File

@ -12,7 +12,7 @@ showing world-wide JT65 activity on all amateur bands over over the
past hour. Such a map might look like this, where different colors
represent different bands:
image::images/psk-reporter.png[align="left",alt="PSK Reporter"]
image::psk-reporter.png[align="left",alt="PSK Reporter"]
* {jtalert}, by VK3AMA, is available only for Windows. It provides
many operating aids including automatic logging to several third-party
@ -20,7 +20,7 @@ logging programs, audio and visual alerts following a number of
optional alert conditions (decoding of a new DXCC, new state, etc.),
and convenient direct access to web services such as callsign lookup.
image::images/jtalert.png[align="left",alt="JTAlert-X image"]
image::jtalert.png[align="left",alt="JTAlert-X image"]
* {alarmejt}, by F5JMH, is available only for Linux. The program keeps
its own logbook. It fetches contact information from _WSJT-X_ and

4
doc/user_guide/docinfo.html
View File

@ -1,4 +1,8 @@
<style>
html, body {
font-size: 90%;
}
body {
font-family: Arial, Hevetica, sans-serif;
}

0
doc/user_guide/docinfo.xml Normal file
View File

138
doc/user_guide/faq.adoc
View File

@ -1,69 +1,69 @@
////
Questions:
Should be short one liners ending with ?::
If your question is too long for one line, consider multiple questions or rephrase
Answers:
Can be bullet or paragraphs. Bullets make for easier reading.
Bullet Usage:
* = a circle bullet single intent
** = circle bullet double indent
. = should be avoided as the questions are numbered
.. = bullet a, b, c, and so on, double indent
Alternatives: Use a * Bullet, followed by .. for example, then have
a multi-section answer using the * as the section header
* Section Header 1
.. Possible Answer a
.. Possible Answer b
* Section Header 2
.. Possible Answer a
.. Possible Answer b
Link Usage:
Use the common/links.adoc for href links to maintain consistency. Try to avoid
apostrophes ` or ' as it breaks AsciiDoc syntax without special escaping
and they do not translate into other languages well.
////
[qanda]
My displayed spectrum is flatter when I do not check the *Flatten* box. What's wrong?::
_WSJT-X_ does not expect a steep filter edge within the displayed
passband. Use a wider IF filter or reduce the displayed passband by
decreasing *Bins/Pixel*, increasing *Start*, or reducing the width of
the *Wide Graph*. You might also choose to re-center the filter
passband, if such control is available.
How should I configure _WSJT-X_ to run multiple instances?::
Start _WSJT-X_ from a command-prompt window, passing each instance a
unique identifier as in the following two-instance example. This
procedure will isolate the *Settings* file and the writable file
location for each instance of _WSJT-X_.
wsjtx --rig-name=TS2000
wsjtx --rig-name=FT847
When setting up rig control through _OmniRig_, something goes wrong when I click *Test CAT*. What can I do about it?::
_OmniRig_ apparently has a bug that appears when you click *Test CAT*.
Forget using *Test CAT* and just click *OK*. _OmniRig_ then behaves
normally.
I am using _WSJT-X_ with _Ham Radio Deluxe_. All seems well until I start HRD Logbook or DM780 running in parallel; then CAT control becomes unreliable.::
You may see delays up to 20 seconds or so in frequency changes or
other radio commands, due to a bug in HRD. HRD folks are aware of the
problem, and are working to resolve it.
I am running _WSJT-X_ under Ubuntu 14.04. The program starts, but menu bar is missing from the top of the main window and the hot-keys don't work.::
Ubuntu's new ``Unity'' desktop puts the menu for the currently active
window at the top of the primary display screen. You can restore menu
bars to their traditional locations by typing the following in a
command-prompt window:
sudo apt-get remove appmenu-qt5
////
Questions:
Should be short one liners ending with ?::
If your question is too long for one line, consider multiple questions or rephrase
Answers:
Can be bullet or paragraphs. Bullets make for easier reading.
Bullet Usage:
* = a circle bullet single intent
** = circle bullet double indent
. = should be avoided as the questions are numbered
.. = bullet a, b, c, and so on, double indent
Alternatives: Use a * Bullet, followed by .. for example, then have
a multi-section answer using the * as the section header
* Section Header 1
.. Possible Answer a
.. Possible Answer b
* Section Header 2
.. Possible Answer a
.. Possible Answer b
Link Usage:
Use the common/links.adoc for href links to maintain consistency. Try to avoid
apostrophes ` or ' as it breaks AsciiDoc syntax without special escaping
and they do not translate into other languages well.
////
[qanda]
My displayed spectrum is flatter when I do not check the *Flatten* box. What's wrong?::
_WSJT-X_ does not expect a steep filter edge within the displayed
passband. Use a wider IF filter or reduce the displayed passband by
decreasing *Bins/Pixel*, increasing *Start*, or reducing the width of
the *Wide Graph*. You might also choose to re-center the filter
passband, if such control is available.
How should I configure _WSJT-X_ to run multiple instances?::
Start _WSJT-X_ from a command-prompt window, passing each instance a
unique identifier as in the following two-instance example. This
procedure will isolate the *Settings* file and the writable file
location for each instance of _WSJT-X_.
wsjtx --rig-name=TS2000
wsjtx --rig-name=FT847
When setting up rig control through _OmniRig_, something goes wrong when I click *Test CAT*. What can I do about it?::
_OmniRig_ apparently has a bug that appears when you click *Test CAT*.
Forget using *Test CAT* and just click *OK*. _OmniRig_ then behaves
normally.
I am using _WSJT-X_ with _Ham Radio Deluxe_. All seems well until I start HRD Logbook or DM780 running in parallel; then CAT control becomes unreliable.::
You may see delays up to 20 seconds or so in frequency changes or
other radio commands, due to a bug in HRD. HRD folks are aware of the
problem, and are working to resolve it.
I am running _WSJT-X_ under Ubuntu 14.04. The program starts, but menu bar is missing from the top of the main window and the hot-keys don't work.::
Ubuntu's new "`Unity`" desktop puts the menu for the currently active
window at the top of the primary display screen. You can restore menu
bars to their traditional locations by typing the following in a
command-prompt window:
sudo apt-get remove appmenu-qt5

4
doc/user_guide/font-sizes.adoc
View File

@ -9,7 +9,7 @@ scale) of most labels on the user interface. The last two numbers
control size and weight of text in the *Band Activity* and *Rx
Frequency* windows.
- By default the four numbers are ``8 50 10 50''. If you need larger
- By default the four numbers are "`8 50 10 50`". If you need larger
fonts in the user interface and bold text in the decode windows, try
something like ``10 50 12 100'' (without the quotes).
something like "`10 50 12 100`" (without the quotes).

174
doc/user_guide/implementation.adoc
View File

@ -1,87 +1,87 @@
// Status=review
.Transmitting
Immediately before the start of a transmission _WSJT-X_ encodes a
user's message and computes the sequence of tones to be sent. The
audio waveform is computed on-the-fly, with 16-bit integer samples
sent to the audio output device at a 48000 Hz rate. Generated signals
have continuous phase and constant amplitude, and there are no key
clicks. The transmitter's power amplifier need not be highly linear.
.Receiving
_WSJT-X_ acquires 16-bit integer samples from the audio input device
at a 48000 Hz rate and immediately downsamples the stream to 12000 Hz.
Spectra from overlapping segments are computed for the waterfall
display and saved for the decoder at intervals of 3456/12000 = 0.288
s, half the JT9 symbol length.
.Decoding
At the end of a reception sequence, about 50 seconds into the UTC
minute, received data samples are forwarded to the decoder. In JT9
and JT65 modes the decoder goes through its full procedure twice:
first at the selected Rx frequency, and then over the full displayed
frequency range. Each decoding pass can be described as a sequence of
discrete blocks. Details of the functional blocks are different for
each mode. In dual-mode JT9+JT65 operation on computers with more
than one CPU, decoding computations for the two modes are done in
parallel.
The basic decoding algorithm for JT65 mode is described in the 2005
{jt65protocol} paper. The following list summarizes the corresponding
algorithm for JT9 mode. Blocks are labeled here with the names of
functional procedures in the code.
[horizontal]
+sync9+:: Use sync symbols to find candidate JT9 signals
in the specified frequency range
Then, at the frequency of each plausible candidate:
[horizontal]
+downsam9+:: Mix, filter and downsample to 16 complex
samples/symbol
+peakdt9+:: Using sync symbols, time-align to start of JT9 symbol
sequence
+afc9+:: Measure frequency offset and possible drift
+twkfreq+:: Remove frequency offset and drift
+symspec2+:: Compute 8-bin spectra for 69 information-carrying
symbols, using the time- and frequency-aligned data;
transform to yield 206 single-bit soft symbols
+interleave9+:: Remove single-bit interleaving imposed at the
transmitter
+decode9+:: Retrieve a 72-bit user message using the sequential
Fano algorithm
+unpackmsg+:: Unpack a human-readable message from the 72-bit
compressed format
Decoding of clean JT9 signals in a white-noise background starts to
fail below signal-to-noise ratio -25 dB and reaches 50% copy at -26
dB.
With marginal or unrecognizable signals the sequential Fano algorithm
can take exponentially long times. If the +sync9+ step in the above
sequence finds many seemingly worthy candidate signals and many of
them turn out to be undecodable, the decoding loop can take an
inconveniently long time. For this reason the step labeled +decode9+
is programmed to ``time out'' and report failure for a given signal if
it takes too long. The choices *Fast | Normal | Deepest* on the
*Decode* menu provide the user with a three-step adjustment of the
timeout limit.
Decoding in JT4 and WSPR modes is basically similar to that for JT9.
The same K=32, r=1/2 sequential Fano algorithm is used for all three
modes. Other details such as tone numbers, symbol lengths,
synchronizing scheme, and subroutine names are distinct for each mode.
The WSPR decoder now uses a two-pass algorithm. Decoded signals are
reconstructed and subtracted from the received waveform, after which a
second decoding pass takes place.
// Status=review
.Transmitting
Immediately before the start of a transmission _WSJT-X_ encodes a
user's message and computes the sequence of tones to be sent. The
audio waveform is computed on-the-fly, with 16-bit integer samples
sent to the audio output device at a 48000 Hz rate. Generated signals
have continuous phase and constant amplitude, and there are no key
clicks. The transmitter's power amplifier need not be highly linear.
.Receiving
_WSJT-X_ acquires 16-bit integer samples from the audio input device
at a 48000 Hz rate and immediately downsamples the stream to 12000 Hz.
Spectra from overlapping segments are computed for the waterfall
display and saved for the decoder at intervals of 3456/12000 = 0.288
s, half the JT9 symbol length.
.Decoding
At the end of a reception sequence, about 50 seconds into the UTC
minute, received data samples are forwarded to the decoder. In JT9
and JT65 modes the decoder goes through its full procedure twice:
first at the selected Rx frequency, and then over the full displayed
frequency range. Each decoding pass can be described as a sequence of
discrete blocks. Details of the functional blocks are different for
each mode. In dual-mode JT9+JT65 operation on computers with more
than one CPU, decoding computations for the two modes are done in
parallel.
The basic decoding algorithm for JT65 mode is described in the 2005
{jt65protocol} paper. The following list summarizes the corresponding
algorithm for JT9 mode. Blocks are labeled here with the names of
functional procedures in the code.
[horizontal]
+sync9+:: Use sync symbols to find candidate JT9 signals
in the specified frequency range
Then, at the frequency of each plausible candidate:
[horizontal]
+downsam9+:: Mix, filter and downsample to 16 complex
samples/symbol
+peakdt9+:: Using sync symbols, time-align to start of JT9 symbol
sequence
+afc9+:: Measure frequency offset and possible drift
+twkfreq+:: Remove frequency offset and drift
+symspec2+:: Compute 8-bin spectra for 69 information-carrying
symbols, using the time- and frequency-aligned data;
transform to yield 206 single-bit soft symbols
+interleave9+:: Remove single-bit interleaving imposed at the
transmitter
+decode9+:: Retrieve a 72-bit user message using the sequential
Fano algorithm
+unpackmsg+:: Unpack a human-readable message from the 72-bit
compressed format
Decoding of clean JT9 signals in a white-noise background starts to
fail below signal-to-noise ratio -25 dB and reaches 50% copy at -26
dB.
With marginal or unrecognizable signals the sequential Fano algorithm
can take exponentially long times. If the +sync9+ step in the above
sequence finds many seemingly worthy candidate signals and many of
them turn out to be undecodable, the decoding loop can take an
inconveniently long time. For this reason the step labeled +decode9+
is programmed to "`time out`" and report failure for a given signal if
it takes too long. The choices *Fast | Normal | Deepest* on the
*Decode* menu provide the user with a three-step adjustment of the
timeout limit.
Decoding in JT4 and WSPR modes is basically similar to that for JT9.
The same K=32, r=1/2 sequential Fano algorithm is used for all three
modes. Other details such as tone numbers, symbol lengths,
synchronizing scheme, and subroutine names are distinct for each mode.
The WSPR decoder now uses a two-pass algorithm. Decoded signals are
reconstructed and subtracted from the received waveform, after which a
second decoding pass takes place.

104
doc/user_guide/install-linux.adoc
View File

@ -3,77 +3,63 @@
Debian, Ubuntu, and other Debian-based systems:
* 32-bit: {debian32}
- To install: +sudo dpkg -i wsjtx_{VERSION}_i386.deb+
- Uninstall: +sudo dpkg -P wsjtx+
- To install:
+
[example]
sudo dpkg -i wsjtx_{VERSION}_i386.deb
- Uninstall:
+
[example]
sudo dpkg -P wsjtx
* 64-bit: {debian64}
- To install: +sudo dpkg -i wsjtx_{VERSION}_amd64.deb+
- Uninstall: +sudo dpkg -P wsjtx+
- To install:
+
[example]
sudo dpkg -i wsjtx_{VERSION}_amd64.deb
- Uninstall:
+
[example]
sudo dpkg -P wsjtx
You may also need to execute the following commands in a terminal:
sudo apt-get install libqt5multimedia5-plugins libqt5serialport5
sudo apt-get install libfftw3-single3
[example]
sudo apt-get install libqt5multimedia5-plugins libqt5serialport5
sudo apt-get install libfftw3-single3
For Ubuntu 15.04 and similar systems, the above and also
sudo apt-get install libqt5opengl5
[example]
sudo apt-get install libqt5opengl5
Fedora, Red Hat, and other rpm-based systems:
* 32-bit: {fedora32}
- To install: +sudo rpm -i wsjtx-{VERSION}-i686.rpm+
- Uninstall: +sudo rpm -e wsjtx+
- To install:
+
[example]
sudo rpm -i wsjtx-{VERSION}-i686.rpm
- Uninstall:
+
[example]
sudo rpm -e wsjtx
* 64-bit: {fedora64}
- To install: +sudo rpm -i wsjtx-{VERSION}-x86_64.rpm+
- Uninstall: +sudo rpm -e wsjtx+
- To install:
+
[example]
sudo rpm -i wsjtx-{VERSION}-x86_64.rpm
- Uninstall:
+
[example]
sudo rpm -e wsjtx
You may also need to execute the following commands in a terminal:
sudo yum install fftw-libs-single qt5-qtmultimedia qt5-qtserialport
.KVASD Installation
All Linux users must install a companion program called +kvasd+, an
implementation of the the Koetter-Vardy algebraic soft-decision
decoder for the Reed Solomon (63,12) code. Users of Ubuntu and other
Debian-based systems can install +kvasd+ by executing the following
commands in a terminal:
sudo add-apt-repository ppa:ki7mt/kvasd-installer
sudo apt-get update
sudo apt-get install kvasd-installer
kvasd-installer
The final screen of the installer should include the line
KVASD version 1.12 -- Decode test *** PASSED ***
which should also be displayed if the command
kvasd -v
is executed after installation is complete.
You can install +kvasd+ on most Linux systems (including ARM-based
systems) by downloading, unpacking, and executing the simple tools
packaged in the +kvasd-installer+ script. Your system will need the
following standard tools already installed:
autoconf awk bash dialog libgfortran svn
Download the {kvasd_installer} tarfile to a convenient directory, then
execute the following commands in a terminal there:
tar xzf kvasd-installer-1.12.14.tar.gz
cd kvasd-installer-1.12.14
./autogen.sh
sudo make install
kvasd-installer
As described above, the final screen of the installer should include
the line
KVASD version 1.12 -- Decode test *** PASSED ***
[example]
sudo yum install fftw-libs-single qt5-qtmultimedia qt5-qtserialport

3
doc/user_guide/install-mac.adoc
View File

@ -10,9 +10,6 @@ _WSJT-X_1.5_). You can then proceed to the installation phase.
Take note also of the following:
* Double-click on *KVASD-Installer* to insert the KVASD decoder into
_WSJT-X_.
* Use the Mac's *Audio MIDI Setup* utility to configure your sound
card for 48000 Hz, two-channel, 16-bit format.

2
doc/user_guide/install-windows.adoc
View File

@ -14,7 +14,7 @@ installation directory and its subdirectories.
directory +C:\Users\<username>\AppData\Local\WSJT-X+.
IMPORTANT: Note that your computer might be configured so that this
directory is ``invisible''. It's there, however, and accessible.
directory is "`invisible`". It's there, however, and accessible.
An alternative (shortcut) directory name is %LOCALAPPDATA%\WSJT-X\.
- The built-in Windows facility for time synchronization is usually

10
doc/user_guide/introduction.adoc
View File

@ -2,15 +2,15 @@
_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 “Weak Signal communication by K1JT,” while
the suffix “-X” indicates that _WSJT-X_ started as an extended (and
the program name stand for "`Weak Signal communication by K1JT,`" while
the suffix "`-X`" indicates that _WSJT-X_ started as an extended (and
experimental) branch of the program _WSJT_.
_WSJT-X_ Version 1.6 offers five protocols or “modes”: JT4, JT9, JT65
_WSJT-X_ Version 1.6 offers five protocols or "`modes`": JT4, JT9, JT65
WSPR, and Echo. The first three are designed for making reliable
QSOs under extreme weak-signal conditions. They use nearly identical
message structure and source encoding. JT65 was designed for EME
(“moonbounce”) on the VHF/UHF bands and has also proven very effective
("`moonbounce`") on the VHF/UHF bands and has also proven very effective
for worldwide QRP communication on the HF bands. JT9 is optimized for
the LF, MF, and lower HF bands. It is 2 dB more sensitive than
JT65 while using less than 10% of the bandwidth. JT4 offers a wide
@ -24,7 +24,7 @@ watts 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.
WSPR (pronounced “whisper”) stands for Weak Signal Propagation
WSPR (pronounced "`whisper`") stands for Weak Signal Propagation
Reporter. The WSPR protocol was designed for probing potential
propagation paths using low-power transmissions. WSPR messages
normally carry the transmitting station’s callsign, grid locator, and

6
doc/user_guide/logging.adoc
View File

@ -16,8 +16,8 @@ The program option *Show DXCC entity and worked before status*
use on non-Windows platforms, where {jtalert} is not available. When
this option is checked _WSJT-X_ appends some additional information to
all CQ messages displayed in the _Band Activity_ window. The name of
the DXCC entity is shown, abbreviated if necessary. Your ``worked
before'' status for this callsign (according to log file
the DXCC entity is shown, abbreviated if necessary. Your "`worked
before`" status for this callsign (according to log file
+wsjtx_log.adi+) is flagged with a single character and a change of
background color, as follows:
@ -37,7 +37,7 @@ and readable, it will be used in preference to the built-in one.
The log file +wsjtx_log.adi+ is updated whenever you log a QSO from
_WSJT-X_. (Keep in mind that if you erase this file you will lose all
``worked before'' information.) You can append or overwrite the
"`worked before`" information.) You can append or overwrite the
+wsjtx_log.adi+ file by exporting your QSO history as an ADIF file
from another logging program. Turning *Show DXCC entity and worked
before status* off and then on again will cause _WSJT-X_ to re-read

328
doc/user_guide/make-qso.adoc
View File

@ -1,164 +1,164 @@
// Status=review
=== Standard Exchange
By longstanding tradition, a minimally valid QSO requires the exchange
of callsigns, a signal report or some other information, and
acknowledgments. _WSJT-X_ is designed to facilitate making such
minimal QSOs using short, structured messages. The process works best
if you use these formats and follow standard operating practices. The
recommended basic QSO goes something like this:
CQ K1ABC FN42 #K1ABC calls CQ
K1ABC G0XYZ IO91 #G0XYZ answers
G0XYZ K1ABC –19 #K1ABC sends report
K1ABC G0XYZ R–22 #G0XYZ sends R+report
G0XYZ K1ABC RRR #K1ABC sends RRR
K1ABC G0XYZ 73 #G0XYZ sends 73
*Standard messages* consist of two callsigns (or CQ, QRZ, or DE and
one callsign) followed by the transmitting station’s grid locator, a
signal report, R plus a signal report, or the final acknowledgements
RRR or 73. These messages are compressed and encoded in a highly
efficient and reliable way. In uncompressed form (as displayed
on-screen) they may contain as many as 22 characters.
*Signal reports* are specified as signal-to-noise ratio (S/N) in dB,
using a standard reference noise bandwidth of 2500 Hz. Thus, in
example message at UTC 0003 above, K1ABC is telling G0XYZ that his
signal is 19 dB below the noise power in bandwidth 2500 Hz. In the
message at 0004, G0XYZ acknowledges receipt of that report and
responds with a –22 dB signal report. JT65 reports are constrained to
lie in the range –30 to –1 dB, and values are significantly compressed
above about -10 dB. JT9 supports the extended range –50 to +49 dB and
assigns more reliable numbers to relatively strong signals.
IMPORTANT: Signals become visible on the waterfall around S/N = –26 dB
and audible (to someone with very good hearing) around –15
dB. Thresholds for decodability are around -23 dB for JT4, –24 dB for
JT65, –26 dB for JT9.
=== Free Text Messages
Users often add some friendly chit-chat at the end of a QSO.
Free-format messages such as ``TNX ROBERT 73'' or ``5W VERT 73 GL''
are supported, up to a maximum of 13 characters, including spaces. In
general you should avoid the character / in free-text messages, as the
program may then try to interpret your construction as part of a
compound callsign. It should be obvious that the JT4, JT9, and JT65
protocols are not designed or well suited for extensive conversations
or rag-chewing.
[[COMP-CALL]]
=== Compound Callsigns
Compound callsigns such as xx/K1ABC or K1ABC/x are handled in
one of two possible ways:
.Messages containing Type 1 compound callsigns
A list of about 350 of the most common prefixes and suffixes can be
displayed from the *Help* menu. A single compound callsign involving
one item from this list can be used in place of the standard third
word of a message (normally a locator, signal report, RRR, or 73).
The following examples are all acceptable messages containing *Type 1*
compound callsigns:
CQ ZA/K1ABC
CQ K1ABC/4
ZA/K1ABC G0XYZ
G0XYZ K1ABC/4
The following messages are _not_ valid, because a third word is not
permitted in any message containing a *Type 1* compound callsign:
ZA/K1ABC G0XYZ -22 #These messages are invalid; each would
G0XYZ K1ABC/4 73 # be sent without its third "word"
A QSO between two stations using *Type 1* compound-callsign messages
might look like this:
CQ ZA/K1ABC
ZA/K1ABC G0XYZ
G0XYZ K1ABC –19
K1ABC G0XYZ R–22
G0XYZ K1ABC RRR
K1ABC G0XYZ 73
Notice that the full compound callsign is sent and received in the
first two transmissions. After that, the operators omit the add-on
prefix or suffix and use the standard structured messages.
.Type 2 Compound-Callsign Messages
Prefixes and suffixes _not_ found in the displayable short list are
handled by using *Type 2* compound callsigns. In this case the
compound callsign must be the second word in a two- or three-word
message, and the first word must be CQ, DE, or QRZ. Prefixes can be 1
to 4 characters, suffixes 1 to 3 characters. A third word conveying a
locator, report, RRR, or 73 is permitted. The following are valid
messages containing *Type 2* compound callsigns:
CQ W4/G0XYZ FM07
QRZ K1ABC/VE6 DO33
DE W4/G0XYZ FM18
DE W4/G0XYZ -22
DE W4/G0XYZ R-22
DE W4/G0XYZ RRR
DE W4/G0XYZ 73
In each case, the compound callsign is treated as *Type 2* because the
add-on prefix or suffix is _not_ one of those in the fixed list. Note
that a second callsign is never permissible in these messages.
IMPORTANT: Remember that during a transmission your transmitted message is
always displayed in the first label on the *Status Bar*, highlighted
in yellow. It is displayed there exactly as another station will
receive it. Be sure to check that you are actually transmitting the
message you wish to send!
QSOs involving *Type 2* compound callsigns might look like either
of the following sequences
CQ K1ABC/VE1 FN75
K1ABC G0XYZ IO91
G0XYZ K1ABC –19
K1ABC G0XYZ R–22
G0XYZ K1ABC RRR
K1ABC/VE1 73
CQ K1ABC FN42
DE G0XYZ/W4 FM18
G0XYZ K1ABC –19
K1ABC G0XYZ R–22
G0XYZ K1ABC RRR
DE G0XYZ/W4 73
Operators with a compound callsign use its full form when calling CQ
and possibly also in a 73 transmission, as may be required by
licensing authorities. Other transmissions during a QSO may use the
standard structured messages without callsign prefix or suffix.
IMPORTANT: If you are using a compound callsign, you may want to
experiment with the option *Message generation for type 2 compound
callsign holders* on the *Settings | General* tab, so that messages
will be generated that best suit your needs.
=== Pre-QSO Checklist
Before attempting your first QSO with one of the WSJT modes, be sure
to go through the <<TUTORIAL,Basic Operating Tutorial>> above as well
as the following checklist:
- Your callsign and grid locator set to correct values
- PTT and CAT control (if used) properly configured and tested
- Computer clock properly synchronized to UTC within ±1 s
- Radio set to *USB* (upper sideband) mode
- Radio filters centered and set to widest available passband (up to 5 kHz).
IMPORTANT: Remember that JT4, JT9, J65, and WSPR generally do not
require high power. Under most HF propagation conditions, QRP is the
norm.
// Status=review
=== Standard Exchange
By longstanding tradition, a minimally valid QSO requires the exchange
of callsigns, a signal report or some other information, and
acknowledgments. _WSJT-X_ is designed to facilitate making such
minimal QSOs using short, structured messages. The process works best
if you use these formats and follow standard operating practices. The
recommended basic QSO goes something like this:
CQ K1ABC FN42 #K1ABC calls CQ
K1ABC G0XYZ IO91 #G0XYZ answers
G0XYZ K1ABC –19 #K1ABC sends report
K1ABC G0XYZ R–22 #G0XYZ sends R+report
G0XYZ K1ABC RRR #K1ABC sends RRR
K1ABC G0XYZ 73 #G0XYZ sends 73
*Standard messages* consist of two callsigns (or CQ, QRZ, or DE and
one callsign) followed by the transmitting station’s grid locator, a
signal report, R plus a signal report, or the final acknowledgements
RRR or 73. These messages are compressed and encoded in a highly
efficient and reliable way. In uncompressed form (as displayed
on-screen) they may contain as many as 22 characters.
*Signal reports* are specified as signal-to-noise ratio (S/N) in dB,
using a standard reference noise bandwidth of 2500 Hz. Thus, in
example message at UTC 0003 above, K1ABC is telling G0XYZ that his
signal is 19 dB below the noise power in bandwidth 2500 Hz. In the
message at 0004, G0XYZ acknowledges receipt of that report and
responds with a –22 dB signal report. JT65 reports are constrained to
lie in the range –30 to –1 dB, and values are significantly compressed
above about -10 dB. JT9 supports the extended range –50 to +49 dB and
assigns more reliable numbers to relatively strong signals.
IMPORTANT: Signals become visible on the waterfall around S/N = –26 dB
and audible (to someone with very good hearing) around –15
dB. Thresholds for decodability are around -23 dB for JT4, –24 dB for
JT65, –26 dB for JT9.
=== Free Text Messages
Users often add some friendly chit-chat at the end of a QSO.
Free-format messages such as "`TNX ROBERT 73`" or "`5W VERT 73 GL`"
are supported, up to a maximum of 13 characters, including spaces. In
general you should avoid the character / in free-text messages, as the
program may then try to interpret your construction as part of a
compound callsign. It should be obvious that the JT4, JT9, and JT65
protocols are not designed or well suited for extensive conversations
or rag-chewing.
[[COMP-CALL]]
=== Compound Callsigns
Compound callsigns such as xx/K1ABC or K1ABC/x are handled in
one of two possible ways:
.Messages containing Type 1 compound callsigns
A list of about 350 of the most common prefixes and suffixes can be
displayed from the *Help* menu. A single compound callsign involving
one item from this list can be used in place of the standard third
word of a message (normally a locator, signal report, RRR, or 73).
The following examples are all acceptable messages containing *Type 1*
compound callsigns:
CQ ZA/K1ABC
CQ K1ABC/4
ZA/K1ABC G0XYZ
G0XYZ K1ABC/4
The following messages are _not_ valid, because a third word is not
permitted in any message containing a *Type 1* compound callsign:
ZA/K1ABC G0XYZ -22 #These messages are invalid; each would
G0XYZ K1ABC/4 73 # be sent without its third "word"
A QSO between two stations using *Type 1* compound-callsign messages
might look like this:
CQ ZA/K1ABC
ZA/K1ABC G0XYZ
G0XYZ K1ABC –19
K1ABC G0XYZ R–22
G0XYZ K1ABC RRR
K1ABC G0XYZ 73
Notice that the full compound callsign is sent and received in the
first two transmissions. After that, the operators omit the add-on
prefix or suffix and use the standard structured messages.
.Type 2 Compound-Callsign Messages
Prefixes and suffixes _not_ found in the displayable short list are
handled by using *Type 2* compound callsigns. In this case the
compound callsign must be the second word in a two- or three-word
message, and the first word must be CQ, DE, or QRZ. Prefixes can be 1
to 4 characters, suffixes 1 to 3 characters. A third word conveying a
locator, report, RRR, or 73 is permitted. The following are valid
messages containing *Type 2* compound callsigns:
CQ W4/G0XYZ FM07
QRZ K1ABC/VE6 DO33
DE W4/G0XYZ FM18
DE W4/G0XYZ -22
DE W4/G0XYZ R-22
DE W4/G0XYZ RRR
DE W4/G0XYZ 73
In each case, the compound callsign is treated as *Type 2* because the
add-on prefix or suffix is _not_ one of those in the fixed list. Note
that a second callsign is never permissible in these messages.
IMPORTANT: Remember that during a transmission your transmitted message is
always displayed in the first label on the *Status Bar*, highlighted
in yellow. It is displayed there exactly as another station will
receive it. Be sure to check that you are actually transmitting the
message you wish to send!
QSOs involving *Type 2* compound callsigns might look like either
of the following sequences
CQ K1ABC/VE1 FN75
K1ABC G0XYZ IO91
G0XYZ K1ABC –19
K1ABC G0XYZ R–22
G0XYZ K1ABC RRR
K1ABC/VE1 73
CQ K1ABC FN42
DE G0XYZ/W4 FM18
G0XYZ K1ABC –19
K1ABC G0XYZ R–22
G0XYZ K1ABC RRR
DE G0XYZ/W4 73
Operators with a compound callsign use its full form when calling CQ
and possibly also in a 73 transmission, as may be required by
licensing authorities. Other transmissions during a QSO may use the
standard structured messages without callsign prefix or suffix.
IMPORTANT: If you are using a compound callsign, you may want to
experiment with the option *Message generation for type 2 compound
callsign holders* on the *Settings | General* tab, so that messages
will be generated that best suit your needs.
=== Pre-QSO Checklist
Before attempting your first QSO with one of the WSJT modes, be sure
to go through the <<TUTORIAL,Basic Operating Tutorial>> above as well
as the following checklist:
- Your callsign and grid locator set to correct values
- PTT and CAT control (if used) properly configured and tested
- Computer clock properly synchronized to UTC within ±1 s
- Radio set to *USB* (upper sideband) mode
- Radio filters centered and set to widest available passband (up to 5 kHz).
IMPORTANT: Remember that JT4, JT9, J65, and WSPR generally do not
require high power. Under most HF propagation conditions, QRP is the
norm.

2
doc/user_guide/new_features.adoc
View File

@ -29,7 +29,7 @@ Much work has already been done on Version 1.7 of _WSJT-X_. (Up to
now this branch has been called v1.6.1.) More than 100 people have
been building this version for themselves as development progresses,
and reporting on their experiences. The next release will offer
several ``fast modes'' intended for meteor and ionospheric scatter,
several "`fast modes`" intended for meteor and ionospheric scatter,
including a new FEC-enhanced mode called *JTMSK*. It will also have a
significantly improved JT65 decoder, especially advantageous when used
in crowded HF bands. Starting with Version 1.7, _WSJT-X_ will no

8
doc/user_guide/protocols.adoc
View File

@ -1,7 +1,7 @@
[[JT65PRO]]
=== JT65
JT65 was designed for making minimal QSOs via EME (``moon-bounce'') on
JT65 was designed for making minimal QSOs via EME ("`moon-bounce`") on
the VHF and UHF bands. A detailed description of the protocol and its
implementation in program _WSJT_ was published in {jt65protocol} for
September-October, 2005. Briefly stated, JT65 uses 60 s T/R sequences
@ -19,7 +19,7 @@ sequences of 63 six-bit channel symbols.
JT65 requires tight synchronization of time and frequency between
transmitting and receiving stations. Each transmission is divided into
126 contiguous tone intervals or ``symbols'' of length 4096/11025 =
126 contiguous tone intervals or "`symbols`" of length 4096/11025 =
0.372 s. Within each interval the waveform is a constant-amplitude
sinusoid at one of 65 pre-defined frequencies. Frequency steps between
intervals are accomplished in a phase-continuous manner. Half of the
@ -125,8 +125,8 @@ decoders are clamped at an upper limit –1 dB, and the S/N scale is
nonlinear above –10 dB.
By comparison, JT9 allows for signal reports in the range –50 to +49
dB. It manages this by taking over a small portion of ``message
space'' that would otherwise be used for grid locators within 1 degree
dB. It manages this by taking over a small portion of "`message
space`" that would otherwise be used for grid locators within 1 degree
of the south pole. The S/N scale of the present JT9 decoder is
reasonably linear (although it's not intended to be a precision
measurement tool).

5
doc/user_guide/settings-audio.adoc
View File

@ -1,7 +1,8 @@
// Status=review
Select the *Audio* tab to configure your sound system.
image::images/settings-audio.png[align="center",alt="WSJT-X Audio Configuration Screen"]
image::settings-audio.png[align="center",alt="WSJT-X Audio Configuration Screen"]
Select the *Audio* tab to configure your sound system.
- _Soundcard_: Select the audio devices to be used for *Input* and
*Output*. Usually the *Mono* settings will suffice, but in special

4
doc/user_guide/settings-colors.adoc
View File

@ -1,7 +1,5 @@
[[COLORS]]
image::colors.png[align="center",alt="Colors Screen"]
_WSJT-X_ uses colors to highlight decoded messages containing
information of particular interest. Click on one of the buttons to
select your preferred colors for any message category.
image::images/colors.png[align="center",alt="Reporting Screen"]

6
doc/user_guide/settings-frequencies.adoc
View File

@ -1,7 +1,7 @@
// Status=review
[[FIG_BAND_SETTINGS]]
image::images/settings-frequencies.png[align="center",alt="Frequency Screen"]
image::settings-frequencies.png[align="center",alt="Frequency Screen"]
_Working Frequencies_: By default the *Working Frequencies* table
contains a list of currently recommended dial frequencies for each
@ -28,7 +28,7 @@ _Slope_ B in the equation
Dial error = A + B*f
where ``Dial error'' and A are in Hz, f is frequency in MHz, and B is
where "`Dial error`" and A are in Hz, f is frequency in MHz, and B is
in parts per million (ppm).
Frequency values sent to the radio and received from it will
@ -43,7 +43,7 @@ may be added if (for example) a transverter is in use.
- For a simple setup approach you might want to delete any unwanted
bands -- for example, bands where you have no equipment. Then click
on a *Frequency* entry and type *Ctrl+A* to ``select all,'' and
on a *Frequency* entry and type *Ctrl+A* to "`select all,`" and
drag-and-drop the entries onto the _Station Information_ table. You
can then add any transverter offsets and antenna details.

2
doc/user_guide/settings-general.adoc
View File

@ -1,6 +1,6 @@
// Status=review
[[FIG_CONFIG_STATION]]
image::images/settings-general.png[align="center",alt="Settings Window"]
image::settings-general.png[align="center",alt="Settings Window"]
Select the *General* tab on the *Settings* window. Under _Station
Details_, enter your call sign and 4-digit or 6-digit grid locator.

4
doc/user_guide/settings-radio.adoc
View File

@ -1,11 +1,11 @@
// Status=review
image::RadioTab.png[align="center",alt="Radio Tab"]
_WSJT-X_ offers CAT (Computer Aided Transceiver) control of the
relevant features of most modern transceivers. To configure the
program for your radio, select the *Radio* tab.
image::images/RadioTab.png[align="center",alt="Radio Tab"]
- Select your radio type from the drop-down list labeled *Rig*, or
*None* if you do not wish to use CAT control.

2
doc/user_guide/settings-reporting.adoc
View File

@ -1,6 +1,6 @@
// Status=review
[[FIG_CONFIG_RPT]]
image::images/reporting.png[align="center",alt="Reporting Screen"]
image::reporting.png[align="center",alt="Reporting Screen"]
- _Logging_: Choose any desired options from this group.

2
doc/user_guide/settings-txmacros.adoc
View File

@ -1,7 +1,7 @@
// Status=review
[[FigTxMacros]]
image::images/tx-macros.png[align="center",alt="Tx Macros Screen"]
image::tx-macros.png[align="center",alt="Tx Macros Screen"]
*Tx Macros* are an aid for sending brief, frequently used free-text
messages such as the examples shown above.

60
doc/user_guide/support.adoc
View File

@ -1,30 +1,30 @@
=== Help with Setup
The best source of help in setting up your station or configuring
_WSJT-X_ is the {wsjt_yahoo_group} at email address
wsjtgroup@yahoogroups.com. The chances are good that someone with
similar interests and equipment has already solved your problem and
will be happy to help.
=== Bug Reports
One of your responsibilities as a _WSJT-X_ user is to help the
volunteer programmers to make the program better. Bugs may be
reported to {wsjt_yahoo_group} (email address
wsjtgroup@yahoogroups.com) or the WSJT Developers list
(wsjt-devel@lists.sourceforge.net). To be useful, bug reports should
include at least the following information:
- Program version
- Operating system
- Concise description of the problem
- Exact sequence of steps required to reproduce the problem
=== Feature Requests
Suggestions from users often result in new program features. Good
ideas are always welcome: if there's a feature you would like to see
in _WSJT-X_, spell it out in as much detail as seems useful and send
it to us at one the the email addresses given a few lines above. Be
sure to explain why you think the feature is desirable, and what sort
of other users might find it so.
=== Help with Setup
The best source of help in setting up your station or configuring
_WSJT-X_ is the {wsjt_yahoo_group} at email address
wsjtgroup@yahoogroups.com. The chances are good that someone with
similar interests and equipment has already solved your problem and
will be happy to help.
=== Bug Reports
One of your responsibilities as a _WSJT-X_ user is to help the
volunteer programmers to make the program better. Bugs may be
reported to {wsjt_yahoo_group} (email address
wsjtgroup@yahoogroups.com) or the WSJT Developers list
(wsjt-devel@lists.sourceforge.net). To be useful, bug reports should
include at least the following information:
- Program version
- Operating system
- Concise description of the problem
- Exact sequence of steps required to reproduce the problem
=== Feature Requests
Suggestions from users often result in new program features. Good
ideas are always welcome: if there's a feature you would like to see
in _WSJT-X_, spell it out in as much detail as seems useful and send
it to us at one the the email addresses given a few lines above. Be
sure to explain why you think the feature is desirable, and what sort
of other users might find it so.

2
doc/user_guide/transceiver-setup.adoc
View File

@ -45,7 +45,7 @@ radio into transmit mode and generate a steady audio tone.
facility. The transmitted tone should be perfectly smooth, with no
clicks or glitches.
* Open the computer's audio mixer controls for output (``Playback'')
* Open the computer's audio mixer controls for output ("`Playback`")
devices and adjust the volume slider downward from its maximum until
the RF output from your transmitter falls by around ten percent. This
will be a good level for audio drive.

12
doc/user_guide/tutorial-example1.adoc
View File

@ -12,7 +12,7 @@ those shown in the screen shot below.
something similar to the to the following screen shot:
[[X12]]
image::images/main-ui-1.6.png[align="center",alt="Main UI and Wide Graph"]
image::main-ui-1.6.png[align="center",alt="Main UI and Wide Graph"]
.Decoding Overview
@ -28,7 +28,7 @@ Tx frequency.
Seven JT9 signals are present in the example file, all decodable.
When this file was recorded KF4RWA was finishing a QSO with K1JT.
Since the green marker was placed at his audio frequency, 1224 Hz, his
message ``K1JT KF4RWA 73'' is decoded first and appears in the *Rx
message "`K1JT KF4RWA 73`" is decoded first and appears in the *Rx
Frequency* window. The *Band Activity* window shows this message plus
all decodes at other frequencies. By default lines containing CQ are
highlighted in green, and lines with *My Call* (in this case K1JT) in
@ -56,14 +56,14 @@ will transmit in the proper (odd or even) minutes.
** The Rx and Tx frequency markers are moved to the frequency of the
CQing station.
** The *Gen Msg* (``generated message'') radio button at bottom right
** The *Gen Msg* ("`generated message`") radio button at bottom right
of the main window is selected.
** If you had checked *Double-click on call sets Tx Enable* on the
*Setup* menu, *Enable Tx* would be activated and a transmission would
start automatically at the proper time.
- Double-click on the decoded message ``K1JT N5KDV EM41'',
- Double-click on the decoded message "`K1JT N5KDV EM41`",
highlighted in red. Results will be similar to those in the
previous step, except the Tx frequency (red marker) is not
moved. Such messages are usually in response to your own CQ, or from
@ -75,8 +75,8 @@ line you can cause both Tx and Rx frequencies to be moved. This
behavior can also be forced by checking *Lock Tx=Rx*.
- Double-click on the message from KF4RWA in either window. He is
sending ``73'' to K1JT, signifying that the QSO is over. Most likely
you want to send 73 to him, so the message ``KF4RWA K1JT 73'' is
sending "`73`" to K1JT, signifying that the QSO is over. Most likely
you want to send 73 to him, so the message "`KF4RWA K1JT 73`" is
automatically generated and selected for your next transmission.
(Alternatively, you might choose to send a free text message or to
call CQ again.)

18
doc/user_guide/tutorial-example2.adoc
View File

@ -18,7 +18,7 @@ The waterfall should look like this:
//.130610_2343.wav Decode
[[X14]]
image::images/130610_2343-wav-80.png[align="left",alt="Wide Graph Decode 130610_2343"]
image::130610_2343-wav-80.png[align="left",alt="Wide Graph Decode 130610_2343"]
IMPORTANT: Notice the [blue]*BLUE* marker on the waterfall scale, here
set at 2500 Hz. Its position is set by the spinner control *JT65 nnnn
@ -42,14 +42,14 @@ decoding priority, and its message is displayed also in the *Rx
Frequency* window.
[[FigDecodes]]
image::images/decodes.png[align="center"]
image::decodes.png[align="center"]
- Confirm that mouse-click behavior is similar to that described
earlier, in <<TUT_EX1,Example 1>>. _WSJT-X_ automatically determines
the mode of each JT9 or JT65 message.
IMPORTANT: 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*
properly decoded even if on the "`wrong`" side of the *JT65 nnnn JT9*
marker. The Tx mode automatically switches to that of the decoded
signal and the Rx and Tx frequency markers on the waterfall scale
resize themselves accordingly. When selecting a JT65 signal, click on
@ -61,20 +61,20 @@ window. Between the *UTC* and *Freq* columns on the decoded text line
you will find *dB*, the measured signal-to-noise ratio, and *DT*, the
signal's time offset in seconds relative to your computer clock.
[width="70%",cols="3,^3,^3,^4,^4,30",options="header"]
|=================================
[width="80%",align="center",cols="^10,2*^8,2*^10,54",options="header"]
|===
|UTC|dB|DT|Freq|Mode|Message
|+2343+|+-7+|+0.3+|+815+|+#+|+KK4DSD W7VP -16+
|=================================
|===
- Double-click on the waterfall at 3196 Hz. The program will decode a
JT9 message from IZ0MIT:
[width="70%",cols="3,^3,^3,^4,^4,30",options="header"]
|=====================================
[width="80%",align="center",cols="^10,2*^8,2*^10,54",options="header"]
|===
|UTC|dB|DT|Freq|Mode|Message
|+2343+|+-7+|+0.3+|+3196+|+@+|+WB8QPG IZ0MIT -11+
|=====================================
|===
- Scroll back in the *Band Activity* window and double-click on the
message +CQ DL7ACA JO40+. The program will set *Tx mode* to JT65 and Tx

188
doc/user_guide/utilities.adoc
View File

@ -1,94 +1,94 @@
// Status=review
The _WSJT-X_ packages include program *+rigctl-wsjtx[.exe]+*, which
can be used to send CAT sequences to a rig from the command line, or
from a batch file or shell script; and program *+rigctld-wsjtx[.exe]+*,
which allows other compatible applications to share a CAT connection
to a rig. These program versions include the latest Hamlib rig
drivers -- the same ones used by _WSJT-X_ itself.
Additional utility programs *+jt4code+*, *+jt9code+*, and *+jt65code+*
let you explore the conversion of user-level messages into channel
symbols or ``tone numbers,'' and back again. These programs can be
useful to someone designing a beacon generator, for understanding the
permissible structure of transmitted messages, and for studying
behavior of the error-control codes.
Channel-symbol values for JT4 run from 0 to 3. The total number of
symbols in a transmitted message is 206. To run +jt4code+, enter the
program name followed by a JT4 message enclosed in quotes. In Windows
the command and program output might look like this:
C:\WSJTX> jt4code "G0XYZ K1ABC FN42"
Message Decoded Err? Type
-------------------------------------------------------------------
1. G0XYZ K1ABC FN42 G0XYZ K1ABC FN42 1: Std Msg
Channel symbols
2 0 0 1 3 2 0 2 3 1 0 3 3 2 2 1 2 1 0 0 0 2 0 0 2 1 1 2 0 0
2 0 2 0 2 0 2 0 2 3 0 3 1 0 3 1 0 3 0 1 1 1 1 1 0 1 0 0 2 3
2 2 3 0 2 1 3 3 3 3 2 0 2 1 2 3 0 0 2 3 1 1 1 0 3 1 2 0 3 2
0 2 3 3 0 1 2 1 2 1 0 1 0 1 1 1 1 3 0 3 0 3 2 3 3 0 3 0 1 0
3 3 3 0 0 3 2 1 3 2 3 1 3 3 2 2 0 2 3 3 2 1 1 0 2 2 3 3 1 2
3 1 1 2 1 1 1 0 2 1 2 0 2 3 1 2 3 1 2 2 1 2 0 0 3 3 1 1 1 1
2 0 3 3 0 2 2 2 3 3 0 0 0 1 2 3 3 2 1 1 1 3 2 3 0 3
Channel-symbol values for JT9 run from 0 to 8, with 0 representing the
sync tone. The total number of symbols in a transmitted message is
85. Enter the program name followed by a JT9 message enclosed in
quotes:
C:\WSJTX> jt9code "G0XYZ K1ABC FN42"
Message Decoded Err? Type
-------------------------------------------------------------------
1. G0XYZ K1ABC FN42 G0XYZ K1ABC FN42 1: Std Msg
Channel symbols
0 0 7 3 0 3 2 5 4 0 1 7 7 7 8 0 4 8 8 2 2 1 0 1 1 3 5 4 5 6
8 7 0 6 0 1 8 3 3 7 8 1 1 2 4 5 8 1 5 2 0 0 8 6 0 5 8 5 1 0
5 8 7 7 2 0 4 6 6 6 7 6 0 1 8 8 5 7 2 5 1 5 0 4 0
For the corresponding program *+jt65code+* only the
information-carrying channel symbols are shown, and the symbol values
range from 0 to 63. Sync symbols lie two tone intervals below data
tone 0, and the sequential locations of sync symbols are described in
the <<JT65PRO,JT65 Protocol>> section of this Guide.
A typical execution of +jt65code+ is shown below. The program
displays the packed message of 72 bits, shown here as 12 six-bit
symbol values, followed by the channel symbols:
C:\WSJTX> jt65code "G0XYZ K1ABC FN42"
Message Decoded Err? Type
----------------------------------------------------------------------
1. G0XYZ K1ABC FN42 G0XYZ K1ABC FN42 1: Std Msg
Packed message, 6-bit symbols 61 36 45 30 3 55 3 2 14 5 33 40
Information-carrying channel symbols
56 40 8 40 51 47 50 34 44 53 22 53 28 31 13 60 46 2 14 58 43
41 58 35 8 35 3 24 1 21 41 43 0 25 54 9 41 54 7 25 21 9
62 59 7 43 31 21 57 13 59 41 17 49 19 54 21 39 33 42 18 2 60
For an illustration of the power of the strong error-control coding in
JT9 and JT65, try looking at the channel symbols after changing a
single character in the message. For example, change the grid locator
from +FN42+ to +FN43+ in the JT65 message:
C:\Users\joe\wsjt\wsjtx_install>jt65code "G0XYZ K1ABC FN43"
Message Decoded Err? Type
----------------------------------------------------------------------
1. G0XYZ K1ABC FN43 G0XYZ K1ABC FN43 1: Std Msg
Packed message, 6-bit symbols 61 36 45 30 3 55 3 2 14 5 33 41
Information-carrying channel symbols
25 35 47 8 13 9 61 40 44 9 51 6 8 40 38 34 8 2 21 23 30
51 32 56 39 35 3 50 48 30 8 5 40 18 54 9 24 30 26 61 23 11
3 59 7 7 39 1 25 24 4 50 17 49 52 19 34 7 4 34 61 2 61
You will discover that every possible JT65 message differs from every
other possible JT65 message in at least 52 of the 63
information-carrying channel symbols.
// Status=review
The _WSJT-X_ packages include program *+rigctl-wsjtx[.exe]+*, which
can be used to send CAT sequences to a rig from the command line, or
from a batch file or shell script; and program *+rigctld-wsjtx[.exe]+*,
which allows other compatible applications to share a CAT connection
to a rig. These program versions include the latest Hamlib rig
drivers -- the same ones used by _WSJT-X_ itself.
Additional utility programs *+jt4code+*, *+jt9code+*, and *+jt65code+*
let you explore the conversion of user-level messages into channel
symbols or "`tone numbers,`" and back again. These programs can be
useful to someone designing a beacon generator, for understanding the
permissible structure of transmitted messages, and for studying
behavior of the error-control codes.
Channel-symbol values for JT4 run from 0 to 3. The total number of
symbols in a transmitted message is 206. To run +jt4code+, enter the
program name followed by a JT4 message enclosed in quotes. In Windows
the command and program output might look like this:
C:\WSJTX> jt4code "G0XYZ K1ABC FN42"
Message Decoded Err? Type
-------------------------------------------------------------------
1. G0XYZ K1ABC FN42 G0XYZ K1ABC FN42 1: Std Msg
Channel symbols
2 0 0 1 3 2 0 2 3 1 0 3 3 2 2 1 2 1 0 0 0 2 0 0 2 1 1 2 0 0
2 0 2 0 2 0 2 0 2 3 0 3 1 0 3 1 0 3 0 1 1 1 1 1 0 1 0 0 2 3
2 2 3 0 2 1 3 3 3 3 2 0 2 1 2 3 0 0 2 3 1 1 1 0 3 1 2 0 3 2
0 2 3 3 0 1 2 1 2 1 0 1 0 1 1 1 1 3 0 3 0 3 2 3 3 0 3 0 1 0
3 3 3 0 0 3 2 1 3 2 3 1 3 3 2 2 0 2 3 3 2 1 1 0 2 2 3 3 1 2
3 1 1 2 1 1 1 0 2 1 2 0 2 3 1 2 3 1 2 2 1 2 0 0 3 3 1 1 1 1
2 0 3 3 0 2 2 2 3 3 0 0 0 1 2 3 3 2 1 1 1 3 2 3 0 3
Channel-symbol values for JT9 run from 0 to 8, with 0 representing the
sync tone. The total number of symbols in a transmitted message is
85. Enter the program name followed by a JT9 message enclosed in
quotes:
C:\WSJTX> jt9code "G0XYZ K1ABC FN42"
Message Decoded Err? Type
-------------------------------------------------------------------
1. G0XYZ K1ABC FN42 G0XYZ K1ABC FN42 1: Std Msg
Channel symbols
0 0 7 3 0 3 2 5 4 0 1 7 7 7 8 0 4 8 8 2 2 1 0 1 1 3 5 4 5 6
8 7 0 6 0 1 8 3 3 7 8 1 1 2 4 5 8 1 5 2 0 0 8 6 0 5 8 5 1 0
5 8 7 7 2 0 4 6 6 6 7 6 0 1 8 8 5 7 2 5 1 5 0 4 0
For the corresponding program *+jt65code+* only the
information-carrying channel symbols are shown, and the symbol values
range from 0 to 63. Sync symbols lie two tone intervals below data
tone 0, and the sequential locations of sync symbols are described in
the <<JT65PRO,JT65 Protocol>> section of this Guide.
A typical execution of +jt65code+ is shown below. The program
displays the packed message of 72 bits, shown here as 12 six-bit
symbol values, followed by the channel symbols:
C:\WSJTX> jt65code "G0XYZ K1ABC FN42"
Message Decoded Err? Type
----------------------------------------------------------------------
1. G0XYZ K1ABC FN42 G0XYZ K1ABC FN42 1: Std Msg
Packed message, 6-bit symbols 61 36 45 30 3 55 3 2 14 5 33 40
Information-carrying channel symbols
56 40 8 40 51 47 50 34 44 53 22 53 28 31 13 60 46 2 14 58 43
41 58 35 8 35 3 24 1 21 41 43 0 25 54 9 41 54 7 25 21 9
62 59 7 43 31 21 57 13 59 41 17 49 19 54 21 39 33 42 18 2 60
For an illustration of the power of the strong error-control coding in
JT9 and JT65, try looking at the channel symbols after changing a
single character in the message. For example, change the grid locator
from +FN42+ to +FN43+ in the JT65 message:
C:\Users\joe\wsjt\wsjtx_install>jt65code "G0XYZ K1ABC FN43"
Message Decoded Err? Type
----------------------------------------------------------------------
1. G0XYZ K1ABC FN43 G0XYZ K1ABC FN43 1: Std Msg
Packed message, 6-bit symbols 61 36 45 30 3 55 3 2 14 5 33 41
Information-carrying channel symbols
25 35 47 8 13 9 61 40 44 9 51 6 8 40 38 34 8 2 21 23 30
51 32 56 39 35 3 50 48 30 8 5 40 18 54 9 24 30 26 61 23 11
3 59 7 7 39 1 25 24 4 50 17 49 52 19 34 7 4 34 61 2 61
You will discover that every possible JT65 message differs from every
other possible JT65 message in at least 52 of the 63
information-carrying channel symbols.

268
doc/user_guide/vhf-features.adoc
View File

@ -1,134 +1,134 @@
=== VHF Setup
V1.6.0 is the first _WSJT-X_ version to include features specifically
designed for use on VHF and higher bands. These features include
*JT4*, a mode particularly useful for EME on the microwave bands;
*Echo* mode, for detecting and measuring your own lunar echoes; and
automatic *Doppler tracking* for the EME path. The accuracy of
Doppler calculations is better than 1 Hz at 10 GHz. (Note that
sub-modes JT65B and JT65C are present in v1.6.0, but are not yet fully
implemented for EME purposes.)
- To activate the VHF-and-up features check the box labeled _Enable
VHF/UHF/Microwave features_ on the *Settings | General* tab.
- If you will be doing EME, check the box _Decode at t = 52 s_
to allow for the EME path delay on received signals.
- If you will use automatic Doppler tracking, check the box _Allow Tx
frequency changes while transmitting_. On the *Radio* tab select
_Split Operation_ (use either _Rig_ or _Fake It_: you might need to
experiment with both).
IMPORTANT: Not all transceivers permit computer adjustments of Tx
frequency while transmitting. Among those that do are the IC-735,
IC-756 Pro II, IC-910-H, FT-847, TS-2000 (with Rev 9 firmware
upgrade), Flex 1500 and 5000, HPSDR, Anan-10, Anan-100, and KX3.
- The main window reconfigures itself as necessary to include controls
supporting features of each mode. For example, in JT4 mode the
central part of the main window will look like this:
image::images/VHF_controls.png[align="center",alt="VHF Controls"]
- On the *View* menu, select *Astronomical data* to display a window
with important information for tracking the Moon and performing
automatic Doppler control. Check the box labeled _Doppler tracking_
to ensure that the right-hand portion of the window is visible.
image::images/Astronomical_data.png[align="center",alt="Astronomical data"]
IMPORTANT: Note that two different types of Doppler control are provided.
- Select _Full Doppler to DX Grid_ if you know your QSO partner's locator
and he/she will not be using any Doppler control.
- Select _Constant frequency on Moon_ to correct for your own (one-way)
Doppler shift to or from the Moon. If your QSO partner does the same
thing, both stations will have the required Doppler compensation.
Moreover, anyone else using this option will hear both of you
without the need for manual frequency changes. The hypothetical ``man
in the moon'' will copy all of you on the selected nominal frequency.
- In the example depicted above, the moon-based nominal frequency is
100 kHz above the stated band edge, or 10368.100 MHz for the 10 GHz
band. The home station two-way self Doppler shift is +6193 Hz, so the
one-way shift is +3096.5 Hz. Therefore, the receive frequency is set
to 10,360.103097 Hz. When a transmission is started, the frequency
is reset to 3096.5 Hz below the nominal frequency.
- Spinner controls at top right of the *Astronomical Data* window let you
set a working frequency above the nominal band edge. The frequency above
band edge is the sum of the numbers in these two controls (kHz + Hz).
=== EME with JT4
- Select *JT4* from the *Mode* menu.
- Select the desired submode, which determines the tone spacing.
Higher spacings are used on the higher microwave bands, to allow for
larger Doppler spreads. For example, JT4F is generally used for EME on
the 10 GHz band.
- If using a transverter, set the appropriate offset on the *Settings
| Frequencies* tab. Offset is defined as (desired transceiver dial
reading) minus (desired on-the-air frequency). For example, when
using a 144 MHz radio at 10368 MHz, _Offset (MHz)_ = (144 - 10368) =
-10224.000. If the band is already in the table, you can edit the
offset by double clicking on the offset field itself. Otherwise a new
band can be added by right clicking in the table and selecting _Insert_.
image::images/Add_station_info.png[align="center",alt="Station information"]
- The JT4 decoder in _WSJT-X_ includes optional facilities for
averaging over successive transmissions and also correlation decoding,
sometimes known as ``Deep Search''.
IMPORTANT: The *Decode* menu appears to provide options to set
different decoding behavior. However, in JT4 mode _WSJT-X_ Version
1.6 always behaves as if you have selected _Include correlation_.
image::images/decoding_depth.png[align="center",alt="Decoding Depth"]
- By convention, EME with JT4 can use ``short form'' messages. To
activate automatic generation of these messages, check the box labeled
_Sh_ on the main window.
IMPORTANT: Thanks to G3WDG, many additional hints for using JT4 and
Echo mode on the EME path are available {jt4eme}.
=== Echo Mode
*Echo* mode allows you to make sensitive measurements of your own
lunar echoes, even when they are too weak to be heard. Select *Echo*
from the *Mode* menu, aim your antenna at the moon, pick a clear
frequency, and toggle click *Tx Enable*. _WSJT-X_ will then cycle
through the following loop every 6 seconds:
1. Transmit a 1500 Hz fixed tone for 2.3 s
2. Wait about 0.2 s for start of the return echo
3. Record the received signal for 2.3 s
4. Analyze, average, and display the results
5. Repeat from step 1
To make a sequence of echo tests:
- Select *Echo* from the *Mode* menu.
- On the Astronomical Data window check _Doppler tracking_ and
_Constant frequency on the Moon_
- Choose your desired test frequency using the _Frequency above nominal
band edge_ controls.
- Be sure that your rig control has been set up for _Split Operation_
(either _Rig_ of _Fake It_) on the *Settings | Radio* tab.
- Click *Enable Tx* on the main window to start a sequence of 6-second
cycles.
- _WSJT-X_ calculates and compensates for Doppler shift automatically.
Your return echo should always appear at the center of the plot area
on the Echo Graph window, as in the screen shot below.
image::images/echo_144.png[align="center",alt="Echo 144 MHz"]
=== VHF Setup
V1.6.0 is the first _WSJT-X_ version to include features specifically
designed for use on VHF and higher bands. These features include
*JT4*, a mode particularly useful for EME on the microwave bands;
*Echo* mode, for detecting and measuring your own lunar echoes; and
automatic *Doppler tracking* for the EME path. The accuracy of
Doppler calculations is better than 1 Hz at 10 GHz. (Note that
sub-modes JT65B and JT65C are present in v1.6.0, but are not yet fully
implemented for EME purposes.)
- To activate the VHF-and-up features check the box labeled _Enable
VHF/UHF/Microwave features_ on the *Settings | General* tab.
- If you will be doing EME, check the box _Decode at t = 52 s_
to allow for the EME path delay on received signals.
- If you will use automatic Doppler tracking, check the box _Allow Tx
frequency changes while transmitting_. On the *Radio* tab select
_Split Operation_ (use either _Rig_ or _Fake It_: you might need to
experiment with both).
IMPORTANT: Not all transceivers permit computer adjustments of Tx
frequency while transmitting. Among those that do are the IC-735,
IC-756 Pro II, IC-910-H, FT-847, TS-2000 (with Rev 9 firmware
upgrade), Flex 1500 and 5000, HPSDR, Anan-10, Anan-100, and KX3.
- The main window reconfigures itself as necessary to include controls
supporting features of each mode. For example, in JT4 mode the
central part of the main window will look like this:
image::VHF_controls.png[align="center",alt="VHF Controls"]
- On the *View* menu, select *Astronomical data* to display a window
with important information for tracking the Moon and performing
automatic Doppler control. Check the box labeled _Doppler tracking_
to ensure that the right-hand portion of the window is visible.
image::Astronomical_data.png[align="center",alt="Astronomical data"]
IMPORTANT: Note that two different types of Doppler control are provided.
- Select _Full Doppler to DX Grid_ if you know your QSO partner's locator
and he/she will not be using any Doppler control.
- Select _Constant frequency on Moon_ to correct for your own (one-way)
Doppler shift to or from the Moon. If your QSO partner does the same
thing, both stations will have the required Doppler compensation.
Moreover, anyone else using this option will hear both of you
without the need for manual frequency changes. The hypothetical "`man
in the moon`" will copy all of you on the selected nominal frequency.
- In the example depicted above, the moon-based nominal frequency is
100 kHz above the stated band edge, or 10368.100 MHz for the 10 GHz
band. The home station two-way self Doppler shift is +6193 Hz, so the
one-way shift is +3096.5 Hz. Therefore, the receive frequency is set
to 10,360.103097 Hz. When a transmission is started, the frequency
is reset to 3096.5 Hz below the nominal frequency.
- Spinner controls at top right of the *Astronomical Data* window let you
set a working frequency above the nominal band edge. The frequency above
band edge is the sum of the numbers in these two controls (kHz + Hz).
=== EME with JT4
- Select *JT4* from the *Mode* menu.
- Select the desired submode, which determines the tone spacing.
Higher spacings are used on the higher microwave bands, to allow for
larger Doppler spreads. For example, JT4F is generally used for EME on
the 10 GHz band.
- If using a transverter, set the appropriate offset on the *Settings
| Frequencies* tab. Offset is defined as (desired transceiver dial
reading) minus (desired on-the-air frequency). For example, when
using a 144 MHz radio at 10368 MHz, _Offset (MHz)_ = (144 - 10368) =
-10224.000. If the band is already in the table, you can edit the
offset by double clicking on the offset field itself. Otherwise a new
band can be added by right clicking in the table and selecting _Insert_.
image::Add_station_info.png[align="center",alt="Station information"]
- The JT4 decoder in _WSJT-X_ includes optional facilities for
averaging over successive transmissions and also correlation decoding,
sometimes known as "`Deep Search`".
IMPORTANT: The *Decode* menu appears to provide options to set
different decoding behavior. However, in JT4 mode _WSJT-X_ Version
1.6 always behaves as if you have selected _Include correlation_.
image::decoding_depth.png[align="center",alt="Decoding Depth"]
- By convention, EME with JT4 can use "`short form`" messages. To
activate automatic generation of these messages, check the box labeled
_Sh_ on the main window.
IMPORTANT: Thanks to G3WDG, many additional hints for using JT4 and
Echo mode on the EME path are available {jt4eme}.
=== Echo Mode
*Echo* mode allows you to make sensitive measurements of your own
lunar echoes, even when they are too weak to be heard. Select *Echo*
from the *Mode* menu, aim your antenna at the moon, pick a clear
frequency, and toggle click *Tx Enable*. _WSJT-X_ will then cycle
through the following loop every 6 seconds:
1. Transmit a 1500 Hz fixed tone for 2.3 s
2. Wait about 0.2 s for start of the return echo
3. Record the received signal for 2.3 s
4. Analyze, average, and display the results
5. Repeat from step 1
To make a sequence of echo tests:
- Select *Echo* from the *Mode* menu.
- On the Astronomical Data window check _Doppler tracking_ and
_Constant frequency on the Moon_
- Choose your desired test frequency using the _Frequency above nominal
band edge_ controls.
- Be sure that your rig control has been set up for _Split Operation_
(either _Rig_ of _Fake It_) on the *Settings | Radio* tab.
- Click *Enable Tx* on the main window to start a sequence of 6-second
cycles.
- _WSJT-X_ calculates and compensates for Doppler shift automatically.
Your return echo should always appear at the center of the plot area
on the Echo Graph window, as in the screen shot below.
image::echo_144.png[align="center",alt="Echo 144 MHz"]

1
doc/user_guide/wsjtx-main.adoc
View File

@ -7,6 +7,7 @@ Joseph H Taylor, Jr, K1JT
// are non-free, so can't be included as part of the Debian package.
// :badges:
:docinfo1:
:imagesdir: images
:icons: font
:numbered:
:keywords: amateur radio weak signal communication K1JT WSJT JT65 JT9

144
doc/user_guide/wspr.adoc
View File

@ -1,72 +1,72 @@
- Select *WSPR-2* from the *Mode* menu. The main window will
reconfigure itself to the WSPR interface, removing some controls not
used in WSPR mode.
- Configure the Wide Graph as suggested in the screen shot below.
image::images/WSPR.png[align="center",alt="WSPR mode"]
- Use the mouse to set the width and height of the main window as
desired.
- Select an active WSPR frequency (for example, 10.1387 MHz).
- Click *Monitor* to start a WSPR receiving period.
- If you will be transmitting as well as receiving, select a suitable
value for *Tx Pct* (average percentage of 2-minute sequences devoted to
transmitting) and activate the *Enable Tx* button.
- Select your Tx power (in dBm) from the drop-down list.
=== Band Hopping
WSPR mode allows those with CAT-controlled radios to investigate
propagation on many bands without user intervention. Coordinated
hopping enables a sizable group of stations around the world to move
together from band to band, thereby maximizing the chances of
identifying open propagation paths.
- To enable automatic band-hopping, check the *Band Hopping* box on
the main window.
- Click *Schedule* to open the *WSPR Band Hopping* window, and select
the bands you wish to use at each time of day.
image::images/band_hopping.png[align="center",alt="Band Hopping"]
- Band-switching occurs after each 2-minute interval. Preferred bands
are identified with time slots in a repeating 20-minute cycle,
according to the following table:
[width="73%",cols="11,10*^",align="center",options="header"]
|======================================================================
|*Band:* |160 | 80 | 60 | 40 | 30 | 20 | 17 | 15 | 12 | 10
|*UTC minute:* | 00 | 02 | 04 | 06 | 08 | 10 | 12 | 14 | 16 | 18
| | 20 | 22 | 24 | 26 | 28 | 30 | 32 | 34 | 36 | 38
| | 40 | 42 | 44 | 46 | 48 | 50 | 52 | 54 | 56 | 58
|======================================================================
- If the preferred band is not active according to your band-hopping
schedule, a band will be selected at random from among the active
bands.
- If the box labeled *Tune* is checked for a particular band, _WSJT-X_
transmits an unmodulated carrier for several seconds just after
switching to that band and before the normal Rx or Tx period
starts. This feature can be used to activate an automatic antenna
tuner (ATU) to tune a multi-band antenna to the newly selected band.
- Depending on your station and antenna setup, band changes might
require other switching besides retuning your radio. To make this
possible in an automated way, whenever _WSJT-X_ executes a successful
band-change command to a CAT-controlled radio, it looks for a file
named +user_hardware.bat+, +user_hardware.cmd+, +user_hardware.exe+,
or +user_hardware+ in the working directory. If one of these is found,
_WSJT-X_ tries to execute the command
user_hardware nnn
- In the above command +nnn+ is the band-designation wavelength in
meters. You will need to write your own program, script, or batch file
to do the necessary switching at your station.
- Select *WSPR-2* from the *Mode* menu. The main window will
reconfigure itself to the WSPR interface, removing some controls not
used in WSPR mode.
- Configure the Wide Graph as suggested in the screen shot below.
image::WSPR.png[align="center",alt="WSPR mode"]
- Use the mouse to set the width and height of the main window as
desired.
- Select an active WSPR frequency (for example, 10.1387 MHz).
- Click *Monitor* to start a WSPR receiving period.
- If you will be transmitting as well as receiving, select a suitable
value for *Tx Pct* (average percentage of 2-minute sequences devoted to
transmitting) and activate the *Enable Tx* button.
- Select your Tx power (in dBm) from the drop-down list.
=== Band Hopping
WSPR mode allows those with CAT-controlled radios to investigate
propagation on many bands without user intervention. Coordinated
hopping enables a sizable group of stations around the world to move
together from band to band, thereby maximizing the chances of
identifying open propagation paths.
- To enable automatic band-hopping, check the *Band Hopping* box on
the main window.
- Click *Schedule* to open the *WSPR Band Hopping* window, and select
the bands you wish to use at each time of day.
image::band_hopping.png[align="center",alt="Band Hopping"]
- Band-switching occurs after each 2-minute interval. Preferred bands
are identified with time slots in a repeating 20-minute cycle,
according to the following table:
[width="80%",align="center",cols=">20,10*>8",options="header"]
|===
|Band: |160|80|60|40|30|20|17|15|12|10
.3+|*UTC minute:* | 00|02|04|06|08|10|12|14|16|18
>| 20|22|24|26|28|30|32|34|36|38
>| 40|42|44|46|48|50|52|54|56|58
|===
- If the preferred band is not active according to your band-hopping
schedule, a band will be selected at random from among the active
bands.
- If the box labeled *Tune* is checked for a particular band, _WSJT-X_
transmits an unmodulated carrier for several seconds just after
switching to that band and before the normal Rx or Tx period
starts. This feature can be used to activate an automatic antenna
tuner (ATU) to tune a multi-band antenna to the newly selected band.
- Depending on your station and antenna setup, band changes might
require other switching besides retuning your radio. To make this
possible in an automated way, whenever _WSJT-X_ executes a successful
band-change command to a CAT-controlled radio, it looks for a file
named +user_hardware.bat+, +user_hardware.cmd+, +user_hardware.exe+,
or +user_hardware+ in the working directory. If one of these is found,
_WSJT-X_ tries to execute the command
user_hardware nnn
- In the above command +nnn+ is the band-designation wavelength in
meters. You will need to write your own program, script, or batch file
to do the necessary switching at your station.