Another round of documentation updates.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3669 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Joe Taylor 2014-01-29 20:50:18 +00:00
parent 4daf2fbc60
commit d274a49b4f
30 changed files with 1637 additions and 187 deletions

0
CALL3.TXT Normal file
View File

1325
cty.dat Normal file

File diff suppressed because it is too large Load Diff

146
doc/go
View File

@ -1,47 +1,129 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# # Title : build-doc.sh
# Part of the wsjtx-doc project # Description : WSJT-X Documentation build script
# Builds all *.txt files found in $(PWD)/source # Author : KI7MT
# Email : ki7mt@yahoo.com
# Date : JAN-24-2014
# Version : 0.3
# Usage : ./build-doc.sh [ option ]
# Notes : requires asciidoc, source-highlight
#==============================================================================
# exit on any error # exit on error
set -e set -e
# set script path's #add some color
red='\033[01;31m'
green='\033[01;32m'
yellow='\033[01;33m'
cyan='\033[01;36m'
no_col='\033[01;37m'
# misc var's
base_dir=$(pwd) base_dir=$(pwd)
src_dir="$base_dir/source" src_dir="$base_dir/source"
style_dir="$base_dir/style" c_asciidoc="python /c/users/joe/asciidoc-8.6.9/asciidoc.py -b xhtml11 -a max-width=1024px"
log_dir="$base_dir/logs"
# style sheet selection script_name=$(basename $0)
main_style=asciidoc.css doc_version="1.2.2"
toc2_style=toc2.css
# This is temporary. Final version will loop through a directory of files # build functions
c_asciidoc="asciidoc -b xhtml11 -a max-width=1024px" function build_no_toc() { # no toc
echo -e ${yellow}'Building Main With No TOC'${no_col}
$c_asciidoc -o wsjtx-main.html $src_dir/wsjtx-main.adoc
echo -e ${green}'.. wsjtx-main.html'${no_col}
}
function build_toc1() { # top toc
echo -e ${yellow}'Building Main with Top TOC'${no_col}
$c_asciidoc -a toc -o wsjtx-main-toc1.html $src_dir/wsjtx-main.adoc
echo -e ${green}'.. wsjtx-main-toc1.html'${no_col}
}
function build_toc2() { # left toc
echo -e ${yellow}'Building Main with Left TOC'${no_col}
$c_asciidoc -a toc2 -o wsjtx-main-toc2.html $src_dir/wsjtx-main.adoc
echo -e ${green}'.. wsjtx-main-toc2.html'${no_col}
}
function build_support_pages() { # build all remaining pages
echo
echo -e ${yellow}'Building Support Pages'${no_col}
$c_asciidoc -o rig-config-main.html $src_dir/rig-config-main.adoc
echo -e ${green}'.. rig-config-main.html'${no_col}
# setup rig file array
declare -a subpage=('adat' 'alinco' 'aor' 'drake' 'electro' 'flexrad' 'icom' \
'kenwood' 'softrock' 'tentec' 'yaesu')
# loop through rig-config pages
for rig in "${subpage[@]}"
do
$c_asciidoc -a toc2 -o rig-config-$rig.html $src_dir/rig-config-$rig.adoc
echo -e ${green}".. rig-config-$rig.html"${no_col}
done
$c_asciidoc -o rig-config-template.html $src_dir/rig-config-template.adoc
echo -e ${green}'.. rig-config-template.html'${no_col}
$c_asciidoc -a toc2 -o quick-reference.html $src_dir/quick-reference.adoc
echo -e ${green}'.. quick-reference.html'${no_col}
}
# start the main script
clear clear
#echo Building Main Page HTML echo -e ${yellow}"*** Building WSJT-X User Guide for:" ${cyan}$doc_version\
#echo .. Main Page Without TOC ${no_col}${yellow}" ***\n" ${no_col}
#$c_asciidoc -o wsjtx-main.html ${src_dir}/wsjtx-main.txt
#echo .. Done
echo .. Main Page With TOC # without TOC
$c_asciidoc -a toc -o wsjtx-main-toc.html ${src_dir}/wsjtx-main.txt if [[ $1 = "" ]]
echo .. Done then
build_no_toc
build_support_pages
#echo .. Main Page With TOC2 # top TOC
#$c_asciidoc -a toc2 -o wsjtx-main-toc2.html ${src_dir}/wsjtx-main.txt elif [[ $1 = "toc1" ]]
#echo .. Done then
build_toc1
build_support_pages
echo Building Rig Configuration Sheets # left TOC
echo Building Yaesu elif [[ $1 = "toc2" ]]
$c_asciidoc -o yaesu.html ${src_dir}/yaesu.txt then
echo .. Done build_toc2
echo Building regtemplate build_support_pages
$c_asciidoc -o rigtemplate.html ${src_dir}/rigtemplate.txt
echo Done # all toc versions
echo elif [[ $1 = "all" ]]
echo All HTML docs have been saved to "$base_dir" then
build_no_toc
build_toc1
build_toc2
build_support_pages
# Usage: if something other than "", toc1, toc2 or all is entered as $1 display usage
# message and exit.
#
# To-Do: this should be re-written to redirect the user to select
# 1 of 4 proper options v.s. exiting. Future version should provide
# a terminal GUI, Whiptail, Dialog, Zenity etc.
else
clear
echo -e ${red}" * INPUT ERROR *\n"${no_col}
echo 'Script Usage: build-doc.sh [ option ]'
echo
echo 'For with No TOC: ' ./$script_name
echo 'For with Top TOC: './$script_name 'toc1'
echo 'For with Left TOC: './$script_name 'toc2'
echo 'For All Versions: ' ./$script_name 'all'
echo
echo Please re-enter using the examples above.
echo
exit 1
fi
echo
echo -e ${yellow}'All HTML files have been saved to:'${no_col}${cyan} "$base_dir" ${no_col}
echo
exit 0 exit 0

Binary file not shown.

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

BIN
doc/images/decodes.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 207 KiB

BIN
doc/images/tx-macros.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

View File

@ -5,4 +5,5 @@ enter a brief description of your antenna for each amateur band. The
antenna information will be included with reception reports to antenna information will be included with reception reports to
{pskreporter}, if enabled. {pskreporter}, if enabled.
(Figure to be added here.) [[FigBandSettings]]
image::images/band-settings.png[align="left"]

View File

@ -33,7 +33,7 @@ can configure _WSJT-X_ to communicate with the radio through that
program. Entries for these programs appear at the end of the program. Entries for these programs appear at the end of the
drop-down list of supported rigs. drop-down list of supported rigs.
[[X11]] [[FIG_CONFIG_STATION]]
image::images/r3666-config-screen-80.png[align="center",alt="Configuration Screen"] image::images/r3666-config-screen-80.png[align="center",alt="Configuration Screen"]
Leave *Split Tx* unchecked for now. If you are using CAT control, most Leave *Split Tx* unchecked for now. If you are using CAT control, most

View File

@ -3,6 +3,7 @@
*Tx Macros* are an aid for sending commonly used free-text messages. *Tx Macros* are an aid for sending commonly used free-text messages.
To enable a pull-down selection, add your custom messages to the entry To enable a pull-down selection, add your custom messages to the entry
fields provided. In JT65 and JT9 the maximum free-text message length fields provided. In JT65 and JT9 the maximum free-text message length
is 13 characters, including embedded spaces. is 13 characters, including spaces.
(Figure to be added here.) [[FigTxMacros]]
image::images/tx-macros.png[align="left"]

View File

@ -1,6 +1,7 @@
// Status=review // Status=review
At the center of the main window are a number of controls you will
use when making QSOs: At the center of the main window are a number of controls used when
making QSOs:
//.Misc Controls Center //.Misc Controls Center
image::images/misc-controls-center.png[align="center",alt="Misc Controls Center"] image::images/misc-controls-center.png[align="center",alt="Misc Controls Center"]
@ -10,9 +11,9 @@ this box to transmit in the odd minutes. This selection is made
automatically when you double-click on a decoded text line as automatically when you double-click on a decoded text line as
described in the <<X5,Basic Operating Tutorial>>. described in the <<X5,Basic Operating Tutorial>>.
* The Tx and Rx audio frequencies can be adjusted with spinner * The Tx and Rx audio frequencies are usually set automatically by
controls. These settings are usually set automatically by double-clicking on decoded text or a signal in the waterfall. They
double-clicking on decoded text or a signal in the waterfall. can also be adjusted with spinner controls.
* You can force Tx frequency to the current Rx frequency by clicking * You can force Tx frequency to the current Rx frequency by clicking
the *Tx=Rx* button, and vice-versa for *Rx=Tx*. (Copy across the = the *Tx=Rx* button, and vice-versa for *Rx=Tx*. (Copy across the =

View File

@ -1,8 +1,8 @@
// Status=review // Status=review
Controls related to band and frequency selection, receiver audio Controls related to frequency selection, received audio level, the
level, the station being called or worked, and date and time are found station being called, and date and time are found at lower left of the
at lower left of the main window: main window:
//.Misc Controls Left //.Misc Controls Left
image::images/misc-main-ui.png[align="center",alt="Mist Menu Items"] image::images/misc-main-ui.png[align="center",alt="Mist Menu Items"]
@ -22,7 +22,7 @@ control but communication with the radio has been lost. If the
locator *Dx Grid* is known, the great-circle azimuth and distance are locator *Dx Grid* is known, the great-circle azimuth and distance are
displayed. displayed.
* The program can maintain a database of call-signs and locators for * The program can maintain a database of callsigns and locators for
future reference. Click *Add* to insert the present call and locator future reference. Click *Add* to insert the present call and locator
in the database; click *Lookup* to retrieve the locator for a in the database; click *Lookup* to retrieve the locator for a
previously stored call. previously stored call.

View File

@ -5,12 +5,12 @@ the main screen:
//.Main UI Controls //.Main UI Controls
image::images/main-ui-controls.png[align="left",alt="Main UI Controls"] image::images/main-ui-controls.png[align="left",alt="Main UI Controls"]
* *Log QSO* pops up a confirmation screen pre-filled with known * *Log QSO* raises a dialog window pre-filled with known information
information about a QSO you have nearly completed. You can edit or about a QSO you have nearly completed. You can edit or add to this
add to this information before clicking *OK* to log the QSO. If you information before clicking *OK* to log the QSO. If you check *Prompt
check *Prompt me to log QSO* on the *Setup* menu, the program will me to log QSO* on the *Setup* menu, the program will raise the
raise the confirmation screen automatically when you send a 73 or confirmation screen automatically when you send a 73 or free-text
free-text message. message.
//.Log QSO Window //.Log QSO Window
image::images/log-qso.png[align="center",alt="Log QSO"] image::images/log-qso.png[align="center",alt="Log QSO"]
@ -22,18 +22,18 @@ file.
* *Monitor* restarts normal receive operation. This button is * *Monitor* restarts normal receive operation. This button is
highlighted in green when the _WSJT-X_ is receiving. highlighted in green when the _WSJT-X_ is receiving.
* *Erase* clears the right-hand decoded text window. Double-clicking * *Erase* clears the right-hand decoded text window.
Erase* clears both text windows. Double-clicking *Erase* clears both text windows.
* *Decode* tells the program to repeat the decoding procedure at the * *Decode* tells the program to repeat the decoding procedure at the
Rx frequency ([green]*GREEN* marker on waterfall), using the most recently Rx frequency ([green]*GREEN* marker on waterfall), using the most recently
completed sequence of Rx data. completed sequence of received data.
* *Enable Tx* puts the program into automatic T/R sequencing mode * *Enable Tx* toggles the program into automatic T/R sequencing mode
and highlights the button in [red]*RED*. A transmission will start at the and highlights the button in [red]*RED*. A transmission will start at
beginning of the selected (odd or even) sequence, or immediately if the beginning of the selected (odd or even) sequence, or immediately
appropriate. A transmission will not be started any later than 24 s if appropriate. A transmission will not be started any later than 24
into a UTC minute. s into a UTC minute.
* *Halt Tx* terminates a transmission in progress and disables * *Halt Tx* terminates a transmission in progress and disables
automatic T/R sequencing. automatic T/R sequencing.

View File

@ -1,25 +1,24 @@
// Status=review // Status=review
Program menus offer many options for configuration and operation. Program menus offer many options for configuration and operation.
Nost of the options will be self-explanatory; a few additional details Most of the items are self-explanatory; a few additional details
are provided below. are provided below.
[[X771]] [[FILE_MENU]]
==== File menu ==== File menu
//.File Menu
image::images/file-menu.png[align="left",alt="File Menu"] image::images/file-menu.png[align="left",alt="File Menu"]
[[X772]]
[[SETUP_MENU]]
==== Setup Menu ==== Setup Menu
//.Setup Menu
image::images/setup-menu.png[align="left",alt="Setup Menu"] image::images/setup-menu.png[align="left",alt="Setup Menu"]
.Show DXCC entity and worked B4 status .Show DXCC entity and worked B4 status
When this option is checked _WSJT-X_ appends some useful information When this option is checked _WSJT-X_ appends some useful information
to all CQ messages displayed in the Band Activity window. The name of to all CQ messages displayed in the *Band Activity* window. The name of
the DXCC entity is shown, abbreviated if necessary. Your ``worked the DXCC entity is shown, abbreviated if necessary. Your ``worked
before'' status (according to the log file +wsjtx_log.adi+) is flagged before'' status (according to log file +wsjtx_log.adi+) is flagged
with a single character and a change of background colour: with a single character and a change of background color, as follows:
[horizontal] [horizontal]
!:: (bright green) -- New DXCC entity !:: (bright green) -- New DXCC entity
@ -32,43 +31,38 @@ differentiate between bands.
This option is mainly intended for use This option is mainly intended for use
on non-Windows platforms; Windows users can (and should) use VK3AMA's on non-Windows platforms; Windows users can (and should) use VK3AMA's
excellent {jtalert} utility. excellent {jtalert} utility instead.
.Requirements: .Requirements:
_WSJT-X_ expects the file +cty.dat+ to be in your installation _WSJT-X_ expects the file +cty.dat+ to be in your installation
directory. It contains the DXCC data, is regularly updated and can be directory. It contains DXCC prefix information, and updated copies
downloaded from {cty_dat}. can be downloaded from {cty_dat} when required.
Your previous history is read from file +wsjtx_log.adi+. This file is The log file +wsjtx_log.adi+ is updated whenever you log a QSO from
updated every time you log a QSO from _WSJT-X_ (but note that it can _WSJT-X_ (but note that it can also be erased from the file menu). You
also be erased from the file menu). You can append or overwrite this can append or overwrite this file by exporting your QSO history as an
file by exporting your QSO history as an ADIF file from another ADIF file from another logging program. Turning *Show DXCC entity and
logging program. Turning *Show DXCC entity and worked B4 status* off worked B4 status* off and on again will cause _WSJT-X_ to re-read the
and on again will cause _WSJT-X_ to re-read the log file. Very large log file. Very large log files may cause _WSJT-X_ to slow down when
log files may cause _WSJT-X_ to slow down while searching for calls. searching for calls.
[[X773]] [[VIEW_MENY]]
==== View Menu ==== View Menu
//.View Menu
image::images/view-menu.png[align="left",alt="View Menu"] image::images/view-menu.png[align="left",alt="View Menu"]
[[X774]] [[MODE_MENU]]
==== Mode Menu ==== Mode Menu
//.Mode Menu
image::images/mode-menu.png[align="left",alt="Mode Menu"] image::images/mode-menu.png[align="left",alt="Mode Menu"]
[[X775]] [[DECODE_MENU]]
==== Decode Menu ==== Decode Menu
//.Decode Menu
image::images/decode-menu.png[align="left",alt="Decode Menu"] image::images/decode-menu.png[align="left",alt="Decode Menu"]
[[X776]] [[SAVE_MENU]]
==== Save Menu ==== Save Menu
//.Save Menu
image::images/save-menu.png[align="left",alt="Save Menu"] image::images/save-menu.png[align="left",alt="Save Menu"]
[[X777]] [[HELP_MENU]]
==== Help Menu ==== Help Menu
//.Help Menu
image::images/help-menu.png[align="left",alt="Help Menu"] image::images/help-menu.png[align="left",alt="Help Menu"]

View File

@ -15,12 +15,12 @@ Tx sequence) by clicking on the circle under *Next*.
* To change to a specified Tx message immediately, click on a * To change to a specified Tx message immediately, click on a
rectangular button under the *Now* label. Changing a Tx message in rectangular button under the *Now* label. Changing a Tx message in
this way will slightly reduce the chance of a correct decode, but mid-stream will slightly reduce the chance of a correct decode, but it
usually succeeds if done in the first 10 s of a transmission. is usually OK if done in the first 10 s of a transmission.
* Right-clicking on the entry field for message #5 pops up a list of * Right-clicking on the entry field for message #5 pops up a list of
free-text messages entered on the *Setup | Configuration | Tx Macros* free-text messages entered on the *Setup | Configuration | Tx Macros*
screen. Select any of these pre-stored messages by using the left screen. Select any of your pre-stored messages by using the left
mouse button. mouse button.
The second arrangement of controls for generating and selecting The second arrangement of controls for generating and selecting

View File

@ -6,7 +6,7 @@ information about operating conditions.
//.Status Bar //.Status Bar
image::images/status-bar-a.png[align="left",alt="New Message Menu"] image::images/status-bar-a.png[align="left",alt="New Message Menu"]
Labels on the Status Bar display the program's provide current Labels on the Status Bar display the program's current operating state,
operating state (Receiving, Transmitting, Tune, or an open file name), operating mode, and content of your most recent transmitted message. The
its operating mode, and the content of your most recent transmitted operating state can be Receiving, Transmitting, Tune, or the name of
message. file opened from the *File* menu.

View File

@ -6,21 +6,22 @@ displays — they have no effect on the decoding process.
image::images/wide-graph-controls.png[align="center",alt="Wide Graph Controls"] image::images/wide-graph-controls.png[align="center",alt="Wide Graph Controls"]
- *Bins/Pixel* controls the displayed frequency resolution. Set - *Bins/Pixel* controls the displayed frequency resolution. Set this
to 1 for the highest possible resolution, or to higher values to value to 1 for the highest possible resolution, or to higher numbers
compress the spectral display. Normal operation with a convenient to compress the spectral display. Normal operation with a convenient
window size works well at 2 to 8 bins per pixel. window size works well at 2 to 8 bins per pixel.
- *JT65 nnnn JT9* sets the dividing point for wide-band decoding of - *JT65 nnnn JT9* sets the dividing point for wide-band decoding of
JT65 and JT9 signals in *JT9+JT65* mode. The decoder looks for JT65 JT65 and JT9 signals in *JT9+JT65* mode. The decoder looks for JT65
signals below nnnn Hz and JT9 signals above that frequency. signals below the specified frequency and JT9 signals above it.
- *Start nnn Hz* sets the low-frequency starting point of the - *Start nnn Hz* sets the low-frequency starting point of the
waterfall frequency scale. waterfall frequency scale.
- *N Avg* is the number of successive FFTs to be averaged before - *N Avg* is the number of successive FFTs to be averaged before
updating the spectral display. Values around 5 are suitable for updating the spectral display. Values around 5 are suitable for
normal JT9 and JT65 operation. normal JT9 and JT65 operation. Adjust *N Avg* to make the waterfall
move faster or slower, as desired.
- *Zero* and *Gain* control the scaling and reference level for - *Zero* and *Gain* control the scaling and reference level for
waterfall colors. Values around 0 for both parameters are usually waterfall colors. Values around 0 for both parameters are usually

View File

@ -36,12 +36,15 @@ sequence:
Encoded user information is transmitted during the 63 intervals not Encoded user information is transmitted during the 63 intervals not
used for the sync tone. Each channel symbol generates a tone at used for the sync tone. Each channel symbol generates a tone at
frequency 1275.8 + 2.6917 Nm Hz, where N is the value of the six-bit frequency 1275.8 + 2.6917 × N × m Hz, where N is the value of the
symbol, 0 ≤ N ≤ 63, and m is 1, 2, or 4 for JT65 sub-modes A, B, or C. six-bit symbol, 0 ≤ N ≤ 63, and m is 1, 2, or 4 for JT65 sub-modes A,
For EME (but conventionally not on the HF bands) the signal report B, or C.
OOO is conveyed by reversing sync and data positions in the
transmitted sequence. Shorthand messages dispense with the sync For EME (but conventionally not on the HF bands) the signal report OOO
vector and use intervals of 1.486 s (16,384 samples) for the is sometimes used instead of numerical signal reports. It is conveyed
alternating tones. The lower frequency is always 1270.5 Hz, the same by reversing sync and data positions in the transmitted sequence.
as that of the sync tone, and the frequency separation is 26.92 nm Hz Shorthand messages for RO, RRR, and 73 dispense with the sync vector
with n = 2, 3, 4 for the messages RO, RRR, and 73. entirely and use time intervals of 1.486 s (16,384 samples) for pairs
of alternating tones. The lower frequency is always 1270.5 Hz, the
same as that of the sync tone, and the frequency separation is 26.92 ×
n × m Hz with n = 2, 3, 4 for the messages RO, RRR, and 73.

View File

@ -22,16 +22,16 @@ recommended basic QSO goes something like this:
one callsign) followed by the transmitting stations grid locator, a one callsign) followed by the transmitting stations grid locator, a
signal report, R plus a signal report, or the final acknowledgements signal report, R plus a signal report, or the final acknowledgements
RRR or 73. These messages are compressed and encoded in a highly RRR or 73. These messages are compressed and encoded in a highly
efficient and reliable way, and may contain up to 18 characters in efficient and reliable way, and in uncompressed form may contain
uncompressed form. as many as 18 characters.
*Signal reports* are specified as signal-to-noise ratio (S/N) in dB, *Signal reports* are specified as signal-to-noise ratio (S/N) in dB,
using a standard reference noise bandwidth of 2500 Hz. Thus, in using a standard reference noise bandwidth of 2500 Hz. Thus, in
example message #0003, K1ABC is telling G0XYZ that his signal is 19 dB example message #0003 above, K1ABC is telling G0XYZ that his signal is
below the noise power in bandwidth 2500 Hz. In message #0004, G0XYZ 19 dB below the noise power in bandwidth 2500 Hz. In message #0004,
acknowledges receipt of that report and responds with a 22 dB signal G0XYZ acknowledges receipt of that report and responds with a 22 dB
report. JT65 reports are constrained to lie in the range 30 to 1 signal report. JT65 reports are constrained to lie in the range 30
dB, while JT9 supports the extended range 50 to +49 dB. to 1 dB, while JT9 supports the extended range 50 to +49 dB.
TIP: Signals become visible on the waterfall around S/N = 26 dB and TIP: Signals become visible on the waterfall around S/N = 26 dB and
audible (to someone with very good hearing) around 15 dB. Thresholds audible (to someone with very good hearing) around 15 dB. Thresholds
@ -46,25 +46,25 @@ protocols are not well suited for extensive conversations or rag-chewing.
=== Compound Callsigns === Compound Callsigns
Compound callsigns such as xx/K1ABC or K1ABC/x are handled in one of Compound callsigns such as xx/K1ABC or K1ABC/x are handled in
two possible ways. one of two possible ways.
.Type 1 Compound-Callsign Messages .Type 1 Compound-Callsign Messages
A list of about 350 of the most common prefixes and suffixes can be A list of about 350 of the most common prefixes and suffixes can be
displayed from the *Help* menu. A single compound callsign involving displayed from the *Help* menu. A single compound callsign involving
one item from this list can be used in a message in place of the one item from this list can be used in place of the standard third
standard third word (normally a locator, signal report, RRR, or 73). message word (normally a locator, signal report, RRR, or 73). Thus,
Thus, the following examples are all acceptable *Type 1* messages the following examples are all acceptable *Type 1* messages with
with compound callsigns: compound callsigns:
CQ ZA/K1ABC CQ ZA/K1ABC
CQ K1ABC/4 CQ K1ABC/4
ZA/K1ABC G0XYZ ZA/K1ABC G0XYZ
G0XYZ K1ABC/4 G0XYZ K1ABC/4
The following messages are _not_ valid because a third word is not The following messages are _not_ valid, because a third word is not
permitted in a *Type 1* message with compound callsigns: permitted in a *Type 1* message:
ZA/K1ABC G0XYZ -22 #These messages will be sent ZA/K1ABC G0XYZ -22 #These messages will be sent
G0XYZ K1ABC/4 73 #without the third "word" G0XYZ K1ABC/4 73 #without the third "word"
@ -79,9 +79,9 @@ might look like this:
G0XYZ K1ABC RRR G0XYZ K1ABC RRR
K1ABC G0XYZ 73 K1ABC G0XYZ 73
Notice that both operators sens and receive the full compound Notice that both operators send and receive the full compound
callsign in the first two transmissions. After that, they omit the callsign in the first two transmissions. After that, they omit the
add-on prefix or suffix. add-on prefix or suffix and use the standard structured messages.
.Type 2 Compound-Callsign Messages .Type 2 Compound-Callsign Messages
@ -98,12 +98,13 @@ callsigns:
QRZ K1ABC/VE6 DO33 QRZ K1ABC/VE6 DO33
In each case, the message is treated as *Type 2* because the add-on In each case, the message is treated as *Type 2* because the add-on
prefix or suffix is _not_ one of those in the displayable list. Note prefix or suffix is _not_ one of those in the fixed list. Note
that a second callsign is never permissible in these messages. that a second callsign is never permissible in these messages.
TIP: Remember that during a transmission your transmitted message is TIP: Remember that during a transmission your transmitted message is
always displayed in the first label on the *Status Bar*, highlighted always displayed in the first label on the *Status Bar*, highlighted
in yellow -- displayed exactly as another station will receive it. in yellow. It is displayed there exactly as another station would
receive it.
A QSO between two stations using *Type 2* compound-callsign messages A QSO between two stations using *Type 2* compound-callsign messages
might look like this: might look like this:
@ -115,8 +116,10 @@ might look like this:
G0XYZ K1ABC RRR G0XYZ K1ABC RRR
DE G0XYZ/P 73 DE G0XYZ/P 73
Each operator sends his own full callsign in the first (and perhaps Each operator sends his own compound callsign in the first (and
also last) transmission, as may be required by licensing authorities. perhaps also last) transmission, as may be required by licensing
authorities. Subsequent transmissions may use the standard structured
messages without callsign prefix or suffix.
=== Pre-QSO Checklist === Pre-QSO Checklist
@ -132,4 +135,4 @@ checklist:
on *Station* tab of the *Setup | Configuration* window. on *Station* tab of the *Setup | Configuration* window.
IMPORTANT: Remember that JT9 and J65 generally do not require high IMPORTANT: Remember that JT9 and J65 generally do not require high
power. Under most propagation conditions, [red]*QRP is the rule!* power. Under most propagation conditions, QRP is the norm.

View File

@ -14,16 +14,15 @@ will be best with this slider not too far from its mid-point.
.Bandwidth and Frequency Setting .Bandwidth and Frequency Setting
Many SSB Many SSB transceivers have a fixed-width Tx filter that will not pass
transceivers have a fixed-width Tx filter that will not pass audio audio frequencies higher than about 2700 Hz. _WSJT-X_ takes care of
frequencies higher than about 2700 Hz. _WSJT-X_ takes care of this by this by offering a *Split Tx* mode, receiving with *VFO A* and
using *Split Tx* mode, receiving with *VFO A* and transmitting with transmitting with *VFO B*. Under CAT control _WSJT-X_ offsets the Tx
*VFO B*. Under CAT control _WSJT-X_ offsets the Tx dial frequency dial frequency (*VFO B*) in 500 Hz steps, adjusting the generated
(*VFO B*) in 500 Hz steps, adjusting the generated audio frequency so audio frequency so that it always falls in the range 1500 2000
that it always falls in the range 1500 2000 Hz. With *CAT* and Hz. With *CAT* and *Split Tx* enabled on the configuration screen and
*Split Tx* enabled on the configuration screen and your transceiver your transceiver set to *Split* mode, this frequency control will be
set to *Split* mode, this frequency control will be handled handled automatically.
automatically.
If your transceiver has only a standard SSB filter you wont be able If your transceiver has only a standard SSB filter you wont be able
to use more than about 2.7 kHz bandwidth. You can still have all of to use more than about 2.7 kHz bandwidth. You can still have all of
@ -39,5 +38,5 @@ frequency, and the checkbox labeled *+2 kHz*, just below the *Band*
selector, makes the appropriate settings easy. selector, makes the appropriate settings easy.
IMPORTANT: When you are finished with this Tutorial, dont forget to IMPORTANT: When you are finished with this Tutorial, dont forget to
re-enter your own call-sign as *My Call*. re-enter your own callsign as *My Call*.

View File

@ -7,7 +7,7 @@ directory. When the file opens you should see something similar to
the to the following screen shot: the to the following screen shot:
[[X12]] [[X12]]
image::images/r3556-main-ui-80.png[align="center",alt="Main UI and Wide Graph"] image::images/r3666-main-ui-80.png[align="center",alt="Main UI and Wide Graph"]
.Decoding Overview .Decoding Overview
@ -26,7 +26,7 @@ one of them are decodable. When this file was recorded KF4RWA was
finishing a QSO with K1JT. Since the green marker was placed at his finishing a QSO with K1JT. Since the green marker was placed at his
audio frequency, 1224 Hz, his message ``K1JT KF4RWA 73'' is decoded audio frequency, 1224 Hz, his message ``K1JT KF4RWA 73'' is decoded
first and appears in the *Rx Frequency* window. The *Band Activity* first and appears in the *Rx Frequency* window. The *Band Activity*
window shows this message plus all decodes at other frequencies. The window shows this message plus all decodes at other frequencies.
Lines containing CQ are highlighted in [green]*GREEN*, and lines Lines containing CQ are highlighted in [green]*GREEN*, and lines
with *My Call* (in this case K1JT) in [red]*RED*. with *My Call* (in this case K1JT) in [red]*RED*.
@ -82,16 +82,17 @@ automatically generated and selected for your next transmission.
(Alternatively, you might choose to send a free text message or to (Alternatively, you might choose to send a free text message or to
call CQ again.) call CQ again.)
- Click on the waterfall to set Rx frequency ([green]*GREEN* marker). - Click somewhere on the waterfall to set Rx frequency ([green]*GREEN*
marker).
- Ctrl-click on waterfall to set both Rx and Tx frequencies. - Ctrl-click on the waterfall to set both Rx and Tx frequencies.
- Double-click on the waterfall to set Rx frequency and start a - Double-click on a signal in the waterfall to set Rx frequency and
narrow-band decode there. Decoded text will appear in the right window start a narrow-band decode there. Decoded text will appear in the
only. right window only.
- Ctrl-double-click to set both Rx and Tx frequencies and decode at - Ctrl-double-click on a signal to set both Rx and Tx frequencies and
the new frequency. decode at the new frequency.
- Click *Erase* to clear the right window. - Click *Erase* to clear the right window.

View File

@ -20,20 +20,30 @@ The waterfall should look like this:
[[X14]] [[X14]]
image::images/130610_2343-wav-80.png[align="left",alt="Wide Graph Decode 130610_2343"] image::images/130610_2343-wav-80.png[align="left",alt="Wide Graph Decode 130610_2343"]
This sample file contains 17 decodable signals — nine in JT65 mode TIP: Notice the [blue]*BLUE* marker on the waterfall scale, here
(flagged with the character # in the decoded text windows), and eight set at 2400 Hz. Its position is set by the spinner control *JT65 nnnn
in JT9 mode (flagged with @).
// ... Figure here showing the text windows ?
TIP: Notice the [blue]*BLUE* marker on the waterfall scale, by default
set at 2500 Hz. Its position is set by the spinner control *JT65 nnnn
JT9*, where nnnn is a frequency in Hz. In *JT9+JT65* mode the program JT9*, where nnnn is a frequency in Hz. In *JT9+JT65* mode the program
will automatically decode JT65 signals below this frequency and JT9 will automatically decode JT65 signals below this frequency and JT9
signals above it. signals above it.
JT9 signals appear in the *Cumulative* spectrum as nearly
rectangular shapes about 16 Hz wide. Although there is no clearly
visible sync tone like the one at the low-frequency edge of JT65
signals, by convention the nominal frequency of a JT9 signal is taken
to be that of its lowest tone, at the left edge of its spectrum.
This sample file contains 17 decodable signals — nine in JT65 mode
(flagged with the character # in the decoded text windows), and eight
in JT9 mode (flagged with @). The *Band Activity* window should
contain these decodes (you may need to scroll back in the window to
see them all):
// ... Figure here showing the text windows ?
[[FigDecodes]]
image::images/decodes.png[align="center"]
Since the Tx mode was set to *Tx JT65*, signals in that mode were Since the Tx mode was set to *Tx JT65*, signals in that mode were
decoded first. If you had selected *Tx JT9*, JT9 signals would have decoded next. If you had selected *Tx JT9*, JT9 signals would have
been decoded first. been decoded first.
- Confirm that mouse-click behavior is similar to that described - Confirm that mouse-click behavior is similar to that described
@ -80,7 +90,7 @@ program is now configured properly for a JT9 QSO with TA4A.
- Select *File | Open* and navigate to +...\save\samples\130418_1742.wav+. - Select *File | Open* and navigate to +...\save\samples\130418_1742.wav+.
Taking full advantage of the wide-band, dual-mode capability of Taking full advantage of the wide-band, dual-mode capability of
_WSJT-X_ requires a receiver bandwidth of at least 4 kHz, but these _WSJT-X_ requires a receiver bandwidth of at least 4 kHz. These
data were recorded with a much narrower Rx bandwidth, roughly 200 to data were recorded with a much narrower Rx bandwidth, roughly 200 to
2600 Hz. If you have no Rx filter wider than about 2.7 kHz, you will 2600 Hz. If you have no Rx filter wider than about 2.7 kHz, you will
be using data like this. For best viewing, adjust *Bins/Pixel* and the be using data like this. For best viewing, adjust *Bins/Pixel* and the
@ -89,7 +99,7 @@ shows, say 0 to 2600 Hz. Re-open the example file after any change of
*Bins/Pixel* or Wide Graph width, to refresh the waterfall. *Bins/Pixel* or Wide Graph width, to refresh the waterfall.
The signals in this file are all JT9 signals. To decode them The signals in this file are all JT9 signals. To decode them
automatically in JT9+JT65 mode youll need to move the *JT65 nnnn JT9* automatically in *JT9+JT65* mode youll need to move the *JT65 nnnn JT9*
delimiter down to 1000 Hz or less. delimiter down to 1000 Hz or less.
.Start, Zero, and Gain .Start, Zero, and Gain

View File

@ -7,33 +7,27 @@ transmitted audio waveform is then computed on-the-fly, using 16-bit
integer samples at a 48000 Hz rate. Digital samples are converted to integer samples at a 48000 Hz rate. Digital samples are converted to
an analog waveform in the sound card or equivalent D/A interface. an analog waveform in the sound card or equivalent D/A interface.
.Receiving and Decoding .Receiving
_WSJT-X_ acquires 16-bit integer samples from the sound card at a 48000 _WSJT-X_ acquires 16-bit integer samples from the sound card at a 48000
Hz rate and immediately downsamples the stream to 12000 Hz. Spectra Hz rate and immediately downsamples the stream to 12000 Hz. Spectra
from overlapping segments are computed for the waterfall display and from overlapping segments are computed for the waterfall display and
saved at intervals of 0.188 s, half the JT9 symbol length. As shown saved at intervals of 0.188 s, half the JT9 symbol length.
in screen shots earlier in this guide, a JT9 signal appears in the
*Cumulative* spectrum as a nearly rectangular shape about 16 Hz wide.
Although there is no clearly visible ``sync tone'' like the one at the
low-frequency edge of a JT65 signal, by convention the nominal
frequency of a JT9 signal is taken to be that of the lowest tone, at
the left edge of the spectrum.
insert annotated waterfall picture here?
At the end of a reception sequence, about 50 seconds into the UTC At the end of a reception sequence, about 50 seconds into the UTC
minute, received data samples are forwarded to the decoder. For minute, received data samples are forwarded to the decoder. For
operator convenience the decoder goes through its full procedure operator convenience the decoder goes through its full procedure
twice: first at the selected Rx frequency, and then in the full twice: first at the selected Rx frequency, and then over the full
displayed frequency range (or in JT9+JT65 mode, the displayed range displayed frequency range. Each decoding pass can be described as a
above the blue *JT65 nnnn JT9* marker). Decoding of clean JT9 signals sequence of discrete blocks. These functional blocks are different
in a white-noise background starts to fail below signal-to-noise for the JT65 and JT9 modes.
ratio -25 dB and reaches 50% copy at -26 dB.
Each decoding pass can be described as a sequence of discrete blocks. .Decoding
In the following list, blocks are labeled with the names of functional
procedures in the code. The basic decoding algorithm for JT65 mode was described in the
{jt65protocol} paper. The following list summarizes the corresponding
algorithm for JT9 mode, with blocks labeled with the names of
functional procedures in the code.
[horizontal] [horizontal]
+sync9+:: Use sync symbols to find candidate JT9 signals +sync9+:: Use sync symbols to find candidate JT9 signals
@ -66,6 +60,10 @@ Then, at the frequency of each plausible candidate:
+unpackmsg+:: Unpack a human-readable message from the 72-bit +unpackmsg+:: Unpack a human-readable message from the 72-bit
compressed format 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 decoding With marginal or unrecognizable signals the sequential decoding
algorithm can take exponentially long times. If the +sync9+ step in algorithm can take exponentially long times. If the +sync9+ step in
the above sequence finds many seemingly worthy candidate signals, and the above sequence finds many seemingly worthy candidate signals, and

View File

@ -2,7 +2,7 @@
// This is a comment line, anything with // is ignored at process time. // This is a comment line, anything with // is ignored at process time.
= WSJT-X User Guide = WSJT-X User Guide
:Author: Joe Taylor, K1JT :Author: Joe Taylor, K1JT
:Date: January 21, 2014, Copyright © 2012-2014 :Date: January 29, 2014, Copyright © 2012-2014
:Revision: 1.2.2 :Revision: 1.2.2
:badges: :badges:
:icons: :icons:
@ -38,7 +38,6 @@
// == is level (2), section 1.0, === would mean section 1.1, === would // == is level (2), section 1.0, === would mean section 1.1, === would
// be section 1.1.1. This method is used throughout the document. // be section 1.1.1. This method is used throughout the document.
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[[INTRO]] [[INTRO]]
== Introduction == Introduction
include::introduction.adoc[] include::introduction.adoc[]

BIN
kvasd.dat Normal file

Binary file not shown.

View File

@ -1,4 +1,4 @@
//----------------------------------------------------------- MainWindow //---------------------------------------------------------- MainWindow
#include "mainwindow.h" #include "mainwindow.h"
#include "ui_mainwindow.h" #include "ui_mainwindow.h"

27
prefixes.txt Normal file
View File

@ -0,0 +1,27 @@
Short-list of Add-On DXCC Prefixes:
1A 1S 3A 3B6 3B8 3B9 3C 3C0 3D2 3D2C 3D2R 3DA 3V 3W 3X
3Y 3YB 3YP 4J 4L 4S 4U1I 4U1U 4W 4X 5A 5B 5H 5N 5R
5T 5U 5V 5W 5X 5Z 6W 6Y 7O 7P 7Q 7X 8P 8Q 8R
9A 9G 9H 9J 9K 9L 9M2 9M6 9N 9Q 9U 9V 9X 9Y A2
A3 A4 A5 A6 A7 A9 AP BS7 BV BV9 BY C2 C3 C5 C6
C9 CE CE0X CE0Y CE0Z CE9 CM CN CP CT CT3 CU CX CY0 CY9
D2 D4 D6 DL DU E3 E4 EA EA6 EA8 EA9 EI EK EL EP
ER ES ET EU EX EY EZ F FG FH FJ FK FKC FM FO
FOA FOC FOM FP FR FRG FRJ FRT FT5W FT5X FT5Z FW FY M MD
MI MJ MM MU MW H4 H40 HA HB HB0 HC HC8 HH HI HK
HK0A HK0M HL HM HP HR HS HV HZ I IS IS0 J2 J3 J5
J6 J7 J8 JA JDM JDO JT JW JX JY K KG4 KH0 KH1 KH2
KH3 KH4 KH5 KH5K KH6 KH7 KH8 KH9 KL KP1 KP2 KP4 KP5 LA LU
LX LY LZ OA OD OE OH OH0 OJ0 OK OM ON OX OY OZ
P2 P4 PA PJ2 PJ7 PY PY0F PT0S PY0T PZ R1F R1M S0 S2 S5
S7 S9 SM SP ST SU SV SVA SV5 SV9 T2 T30 T31 T32 T33
T5 T7 T8 T9 TA TF TG TI TI9 TJ TK TL TN TR TT
TU TY TZ UA UA2 UA9 UK UN UR V2 V3 V4 V5 V6 V7
V8 VE VK VK0H VK0M VK9C VK9L VK9M VK9N VK9W VK9X VP2E VP2M VP2V VP5
VP6 VP6D VP8 VP8G VP8H VP8O VP8S VP9 VQ9 VR VU VU4 VU7 XE XF4
XT XU XW XX9 XZ YA YB YI YJ YK YL YN YO YS YU
YV YV0 Z2 Z3 ZA ZB ZC4 ZD7 ZD8 ZD9 ZF ZK1N ZK1S ZK2 ZK3
ZL ZL7 ZL8 ZL9 ZP ZS ZS8 KC4 E5
Short-list of Add-on Suffixes: /0 /1 /2 /3 /4 /5 /6 /7 /8 /9 /A /P

View File

@ -6,14 +6,19 @@ DefaultDirName=c:\wsjtx1.2
DefaultGroupName=wsjtx1.2 DefaultGroupName=wsjtx1.2
[Files] [Files]
Source: "c:\Users\joe\wsjt\wsjtx_install\*.exe"; DestDir: "{app}" Source: "c:\Users\joe\wsjt\wsjtx_install\wsjtx.exe"; DestDir: "{app}"
Source: "c:\Users\joe\wsjt\wsjtx_install\jt9.exe"; DestDir: "{app}"
Source: "c:\Users\joe\wsjt\wsjtx_install\jt9code.exe"; DestDir: "{app}"
Source: "c:\Users\joe\wsjt\wsjtx_install\kvasd.exe"; DestDir: "{app}"
Source: "c:\Users\joe\wsjt\wsjtx_install\*.dll"; DestDir: "{app}"; Source: "c:\Users\joe\wsjt\wsjtx_install\*.dll"; DestDir: "{app}";
Source: "c:\Users\joe\wsjt\wsjtx_install\*.dat"; DestDir: "{app}"; Source: "c:\Users\joe\wsjt\wsjtx\cty.dat"; DestDir: "{app}";
Source: "c:\Users\joe\wsjt\wsjtx_install\wsjt.ico"; DestDir: "{app}"; Source: "c:\Users\joe\wsjt\wsjtx\kvasd.dat"; DestDir: "{app}";
Source: "c:\Users\joe\wsjt\wsjtx_install\qt.conf"; DestDir: "{app}"; Source: "c:\Users\joe\wsjt\wsjtx\wsjt.ico"; DestDir: "{app}";
Source: "c:\Users\joe\wsjt\wsjtx_install\CALL3.TXT"; DestDir: "{app}"; Flags: onlyifdoesntexist Source: "c:\Users\joe\wsjt\wsjtx\qt.conf"; DestDir: "{app}";
Source: "c:\Users\joe\wsjt\wsjtx\CALL3.TXT"; DestDir: "{app}"; Flags: onlyifdoesntexist
Source: "c:\Users\joe\wsjt\wsjtx\shortcuts.txt"; DestDir: "{app}" Source: "c:\Users\joe\wsjt\wsjtx\shortcuts.txt"; DestDir: "{app}"
Source: "c:\Users\joe\wsjt\wsjtx\mouse_commands.txt"; DestDir: "{app}" Source: "c:\Users\joe\wsjt\wsjtx\mouse_commands.txt"; DestDir: "{app}"
Source: "c:\Users\joe\wsjt\wsjtx\prefixes.txt"; DestDir: "{app}"
Source: "c:\Users\joe\wsjt\wsjtx\WSJT-X_Users_Guide_v1.2.pdf"; DestDir: "{app}" Source: "c:\Users\joe\wsjt\wsjtx\WSJT-X_Users_Guide_v1.2.pdf"; DestDir: "{app}"
Source: "c:\Users\joe\wsjt\wsjtx_install\save\Samples\130418_1742.wav"; DestDir: "{app}\save\Samples"; Source: "c:\Users\joe\wsjt\wsjtx_install\save\Samples\130418_1742.wav"; DestDir: "{app}\save\Samples";
Source: "c:\Users\joe\wsjt\wsjtx_install\save\Samples\130610_2343.wav"; DestDir: "{app}\save\Samples"; Source: "c:\Users\joe\wsjt\wsjtx_install\save\Samples\130610_2343.wav"; DestDir: "{app}\save\Samples";