w4kek/WSJT-X
1
0
Fork 0
mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-25 05:38:46 -05:00
Code Issues Packages Projects Releases Wiki Activity

Editorial work on WSJT-X User Guide: Thanks to Dave, KC3GPM!

Browse Source
This commit is contained in:
Joe Taylor 2020-06-11 09:23:16 -04:00
parent d2d8a43d9b
commit 29f448219c
7 changed files with 78 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/user_guide/en/astro_data.adoc
View File

@ -1,3 +1,5 @@
//status=edited
A text box entitled Astronomical Data provides information needed for
tracking the sun or moon, compensating for EME Doppler shift, and
estimating EME Doppler spread and path degradation. Toggle the
@ -5,7 +7,7 @@ estimating EME Doppler spread and path degradation. Toggle the
image::AstroData_2.png[align="center",alt="Astronomical Data"]
Available information includes the current UTC *Date* and time; *Az*
Available information includes the current UTC *Date* and *Time*; *Az*
and *El*, azimuth and elevation of the moon at your own location, in
degrees; *SelfDop*, *Width*, and *Delay*, the Doppler shift, full
limb-to-limb Doppler spread in Hz, and delay of your own EME echoes in
@ -23,17 +25,17 @@ relative to the best possible time with the moon at perigee in a cold
part of the sky.
On the higher microwave bands, where Faraday rotation is minimal and
linear polarization is often used, spatial offset will reduce signal
levels. Some stations have implemented mechanical polarisation
adjustment to overcome this loss, and the amount of rotation needed is
linear polarization is often used, spatial offset reduces signal
levels. Some stations have implemented mechanical polarisation
adjustment to overcome this loss. The amount of rotation needed is
predicted in real time by the value of *Dpol*. Positive Dpol means
that the antenna should be rotated in a clockwise direction looking
from behind the antenna towards the moon. For a dish antenna, the
feed should similarly be rotated clockwise looking into the mouth of
the feed. A negative value for Dpol means anticlockwise rotation.
the feed. A negative value for Dpol means a counterclockwise rotation.
The state of the art for establishing three-dimensional locations of
The state-of-the-art for establishing three-dimensional locations of
the sun, moon, and planets at a specified time is embodied in a
numerical model of the solar system maintained at the Jet Propulsion
Laboratory. The model has been numerically integrated to produce

31
doc/user_guide/en/controls-functions-center.adoc
View File

@ -1,4 +1,4 @@
// Status=review
// Status=edited
At the center of the main window are a number of controls used when
making QSOs. Controls not relevant to a particular mode or submode
@ -7,41 +7,34 @@ may be "grayed out" (disabled) or removed from the display.
//.Misc Controls Center
image::misc-controls-center.png[align="center",alt="Misc Controls Center"]
* Check *Tx even* to transmit in even-numbered UTC minutes or
* Check *Tx even/1st* to transmit in even-numbered UTC minutes or
sequences, starting at 0. Uncheck this box to transmit in the odd
sequences. The correct selection is made automatically when you
double-click on a decoded text line, as described in the
<<TUTORIAL,Basic Operating Tutorial>>.
* The Tx and Rx audio frequencies can be set automatically by
double-clicking on decoded text or a signal in the waterfall. They
double-clicking decoded text or a signal in the waterfall. They
can also be adjusted using the spinner controls.
* You can copy values between the *Tx Freq* and *Rx Freq* boxes by
clicking on the up/down arrows between the controls. Your
on-the-air frequency is the sum of dial frequency and audio Tx
frequency. By convention we define the frequency of WSJT-X modes as
the frequency of the lowest tone.
* You can force Tx frequency to the current Rx frequency by clicking
the *Tx<-Rx* button, and vice-versa for *Rx<-Tx*. The on-the-air
frequency of your lowest JT9 or JT65 tone is the sum of dial frequency
and audio Tx frequency.
* Check the box *Hold Tx Freq* to ensure that the specified Tx
frequency is not changed automatically when you double-click on
decoded text or a signal in the waterfall.
* For modes lacking a multi-decode feature, or when *Enable
VHF/UHF/Microwave features* has been checked on the *Settings ->
General* tab, the *F Tol* control sets a frequency tolerance range
over which decoding will be attempted, centered on the Rx frequency.
* For modes lacking a multi-decode feature, or when *Enable VHF/UHF/Microwave features* has been checked on the *File -> Settings -> General* tab, the *F Tol* control sets a frequency tolerance range over which decoding is attempted, centered on the Rx frequency.
* The *Report* control lets you change a signal report that has been
inserted automatically. Typical reports for the various modes fall in
* The *Report* control lets you change an automatically inserted signal report. Typical reports for the various modes fall in
the range –30 to +20 dB. Remember that JT65 reports saturate at an
upper limit of -1 dB.
+
TIP: Consider reducing power if your QSO partner reports your
signal above -5 dB in one of the _WSJT-X_ slow modes. These are
supposed to be weak signal modes!
TIP: Consider reducing power if your QSO partner reports your signal above -5 dB in one of the _WSJT-X_ slow modes. These are supposed to be weak signal modes!
* In some circumstances, especially on VHF and higher bands, you can
select a supported submode of the active mode by using the *Submode*
@ -51,11 +44,11 @@ time and frequency synchronization with a received signal.
* Spinner control *T/R xx s* sets sequence lengths for transmission
and reception in ISCAT, MSK144, and the fast JT9 modes.
* With *Split operation* activated on the *Settings -> Radio* tab, in
* With *Split operation* activated on the *File -> Settings -> Radio* tab, in
MSK144 and the fast JT9 submodes you can activate the spinner control
*Tx CQ nnn* by checking the box to its right. The program will then
generate something like `CQ nnn K1ABC FN42` for your CQ message, where
`nnn` is the kHz portion of your current dial frequency,
`nnn` is the kHz portion of your current operating frequency,
in the range 010 to 999. Your CQ
message *Tx6* will then be transmitted at the calling frequency
selected in the *Tx CQ nnn* spinner control. All other messages will

11
doc/user_guide/en/controls-functions-left.adoc
View File

@ -1,16 +1,15 @@
// Status=review
// Status=edited
Controls related to frequency selection, received audio level, the
station being called, and date and time are found at lower left of the
station being called, and date and time are found in the lower, left-hand section of the
main window:
//.Misc Controls Left
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
from the *Frequencies* tab on the *Settings* window. If CAT control
is active the radio's dial frequency will be set accordingly; if not,
* A drop-down list of frequencies and bands in the upper, left-hand corner lets you
select the operating band. It also sets dial frequency to a value taken from the *Frequencies* tab on the *Settings* window. If CAT control
is active, the radio's dial frequency is set accordingly; if not,
you must tune the radio manually.
* Alternatively, you can enter a frequency (in MHz) or band name in

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

@ -1,19 +1,17 @@
The following controls appear just under the decoded
text windows on the main screen. Some controls appear only in certain
operating modes.
// Status=edited
The following controls appear just under the decoded text windows on
the main screen:
//.Main UI
image::main-ui-controls.png[align="center",width=650,alt="Main UI Controls"]
* When *CQ only* is checked, only messages from stations calling CQ will
be displayed in the left text panel.
* When *CQ only* is checked, only messages from stations calling CQ are displayed in the left text panel.
* *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
information before clicking *OK* to log the QSO. If you check *Prompt
me to log QSO* on the *Settings -> Reporting* tab, the program will
raise the confirmation screen automatically when you send a message
containing +73+. *Start Date* and *Start Time* are set when you click
me to log QSO* on the *File -> Settings -> Reporting* tab, the program raises the confirmation screen automatically when you send a message containing +73+. *Start Date* and *Start Time* are set when you click
to send the *Tx 2* or *Tx 3* message, and backed up by one or two
sequence lengths, respectively. (Note that the actual start time may
have been earlier if repeats of early transmissions were required.)
@ -22,15 +20,15 @@ End date and time are set when the *Log QSO* screen is invoked.
//.Log QSO Window
image::log-qso.png[align="center",alt="Log QSO"]
* *Stop* will terminate normal data acquisition in case you want to
* *Stop* terminates normal data acquisition in case you want to
freeze the waterfall or open and explore a previously recorded audio
file.
* *Monitor* toggles normal receive operation on or off. This button
is highlighted in green when the _WSJT-X_ is receiving. If you are
is highlighted in green when _WSJT-X_ is receiving. If you are
using CAT control, toggling *Monitor* OFF relinquishes control of the
rig; if *Monitor returns to last used frequency* is selected on the
*Settings | General* tab, toggling *Monitor* back ON will return to
*File -> Settings -> General* tab, toggling *Monitor* back ON will return to
the original frequency.
* *Erase* clears the right-hand decoded text window.
@ -64,8 +62,9 @@ carrier at the specified Tx frequency (red marker on waterfall scale).
This process is useful for adjusting an antenna tuner or tuning an
amplifier. The button is highlighted in red while *Tune* is active.
Toggle the button a second time or click *Halt Tx* to terminate the
*Tune* process. Note that activating *Tune* interrupts a receive
sequence and will prevent decoding during that sequence.
*Tune* process.
TIP: Activating *Tune* interrupts a receive sequence and will prevent decoding during that sequence.
* Uncheck the box *Menus* to make the top-of-window menus disappear,
leaving more vertical space for decoded messages.

23
doc/user_guide/en/controls-functions-menus.adoc
View File

@ -1,4 +1,4 @@
// Status=review
// Status=edited
Menus at top of the main window offer many options for configuration
and operation. Most of the items are self-explanatory; a few
@ -9,8 +9,7 @@ frequently used menu items are listed at the right edge of the 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
WSJT-X* appears here rather than on the *Help* menu.
labeled as *Preferences*, rather than on the *File* menu. *About WSJT-X* appears here rather than on the *Help* menu.
[[FILE_MENU]]
==== File menu
@ -20,20 +19,12 @@ image::file-menu.png[align="left",alt="File Menu"]
==== Configuration Menu
image::config-menu.png[align="left",alt="File Menu"]
Most users of more than one mode prefer to create and use entries on
the *Configurations* menu for switching between modes. You can
*Clone* the configuration currently in use, *Rename* the clone as
desired, and then make all desired settings for the new configuration.
The easiest way is to start with a working setup for some mode, say
*FT8*. *Clone* it, then select *Configurations | FT8 - Copy | Rename
...*, enter a new name, say *FT4*, and click *OK*. Then select the
new name from the *Configurations* menu and choose *Switch To*. When
the new configuration comes up you can change any desired settings:
for example, select *FT4* from the *Mode* menu. Configurations save
all settings that are normally restored after a program restart,
including which of the defined configurations is currently active.
Many users prefer to create and use entries on the *Configurations*
menu for switching between modes. Simply *Clone* the *Default* entry,
*Rename* it as desired, and then make all desired settings for that
configuration. These settings are restored whenever you select that configuration.
As well as switching between configurations while running _WSJT-X_ you
As well as switching between configurations while running _WSJT-X_, you
can also start the application from the command line in any desired
configuration. Use the command-line option
`--config <configuration-name>`, or `-c` for short, as in these

26
doc/user_guide/en/controls-functions-messages.adoc
View File

@ -1,4 +1,4 @@
// Status=review
// Status=edited
Two arrangements of controls are provided for generating and selecting
Tx messages. Controls familiar to users of program _WSJT_
@ -11,29 +11,27 @@ in one of the decoded text windows.
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*.
Tx sequence) by clicking the radio button in the *Next* column.
* To change to a specified Tx message immediately during a
transmission, click on a rectangular button under the *Now* label.
Changing a Tx message in mid-stream will slightly reduce the chance of
a correct decode, but it is usually OK if done in the first 10-20% of
a transmission.
transmission, click a rectangular button in the *Now* column.
Changing a Tx message in mid-stream slightly reduces the chance of
a correct decode, but it is usually OK if done in the first 10-20% of a transmission.
* All six Tx message fields are editable. You can modify an
automatically generated message or enter a desired message, keeping in
mind the limits on message content. See <<PROTOCOLS,Protocol
Specifications>> for details.
* Click on the pull-down arrow for message #5 to select one of the
pre-stored messages entered on the *Settings | Tx Macros* tab.
* Click the pull-down arrow for message #5 to select one of the
stored messages entered on the *Files -> Settings -> Tx Macros* tab.
Pressing *Enter* on a modified message #5 automatically adds that
message to the stored macros.
* In some circumstances it may be desirable to make your QSOs as
short as possible. To configure the program to start contacts with
message #2, disable message #1 by double-clicking on its round
radio-button or rectangular *Tx 1* button. Similarly, to send RR73
rather than RRR for message #4, double-click on one of its buttons.
message #2, disable message #1 by double-clicking its radio-button in the *Next* column or *Tx 1* button in the *Now* column. Similarly, to send RR73
rather than RRR for message #4, double-click one of its buttons.
The second arrangement of controls for generating and selecting
Tx messages appears on *Tab 2* of the Message Control Panel:
@ -52,12 +50,12 @@ immediately.
* You can enter and transmit anything (up to 13 characters, including
spaces) in the *Free Msg* box.
* Click on the pull-down arrow in the *Free Msg* box to select a
pre-stored macro. Pressing *Enter* on a modified message here
* Click the pull-down arrow in the *Free Msg* box to select a
stored macro. Pressing *Enter* on a modified message here
automatically adds that message to the table of stored macros.
+
TIP: During a transmission the actual message being sent always
appears in the first box of the status bar (bottom left of the main
appears in the first box of the status bar (bottom-left corner of the main
screen).

50
doc/user_guide/en/install-windows.adoc
View File

@ -1,17 +1,16 @@
// Status=review
// Status=edited
Download and execute the package file {win32} (Win 7, Win 8, Win10,
32-bit) or {win64} (Win 7, Win 8, Win10, 64-bit) following these
instructions:
Download and execute the package file {win32} (WinXP, Vista, Win 7,
Win 8, Win10, 32-bit) or {win64} (Vista, Win 7, Win 8, Win10, 64-bit)
following these instructions:
* Install _WSJT-X_ into its own directory, for example `C:\WSJTX` or `
C:\WSJT\WSJTX`, rather than the conventional location `C:\Program
* Install _WSJT-X_ into its own directory, for example `C:\WSJTX` or `C:\WSJT\WSJTX`, rather than the conventional location `C:\Program
Files ...\WSJTX`.
* All program files relating to _WSJT-X_ will be stored in the chosen
* All program files relating to _WSJT-X_ are stored in the chosen
installation directory and its subdirectories.
* Logs and other writeable files will normally be found in the
* Logs and other writeable files are normally found in the
directory +
`C:\Users\<username>\AppData\Local\WSJT-X`.
@ -30,27 +29,23 @@ TIP: Your computer may be configured so that this directory is
[[OPENSSL]]
* _WSJT-X_ requires the _OpenSSL_ libraries to be installed, and
suitable libraries may already be installed on your system. If they
are not you will see this error shortly after requesting a fetch of
the latest LoTW users database. To fix this you need to install the
_OpenSSL_ libraries.
image:LoTW_TLS_error.png[_WSJT-X_ LoTW download TLS error,
align="center"]
* _WSJT-X_ requires installation of the _OpenSSL_ libraries. Suitable libraries may already be installed on your system. If they are not, you will see this error shortly after requesting a fetch of the latest LoTW users database. To fix this, install the _OpenSSL_ libraries.
image::LoTW_TLS_error.png[align="center"]
* You can download a suitable _OpenSSL_ package from
{win_openssl_packages}. You need the latest *Windows Light*
version. For the 32-bit _WSJT-X_ build use the latest Win32 v1.1.x
** You can download a suitable _OpenSSL_ package for Windows from
{win_openssl_packages}; you need the latest *Windows Light*
version. For the 32-bit _WSJT-X_ build, use the latest Win32 v1.1.1
version of the _OpenSSL_ libraries, for the 64-bit _WSJT-X_ use the
latest Win64 v1.1.x version of the _OpenSSL_ libraries which at the
time of writing were {win32_openssl} and {win64_openssl}. It is OK
to install both versions on a 64-bit system.
latest Win64 v1.1.1 version of the _OpenSSL_ libraries (Note: it is
OK to install both versions on a 64-bit system) which, at the time
of writing, were {win32_openssl} and {win64_openssl} respectively.
** Install the package and accept the default options, including the
option to copy the _OpenSSL_ DLLs to the Windows system
directory. There is no obligation to donate to the _OpenSSL_
project, un-check all the donation options if desired. +
project. Un-check all the donation options if desired. +
NOTE: If you still get the same network error after installing the
_OpenSSL_ libraries then you also need to install the
@ -61,21 +56,20 @@ NOTE: If you still get the same network error after installing the
TIP: If you cannot install the _OpenSSL_ libraries or do not have an
Internet connection on the computer used to run
_WSJT-X_&nbsp;{VERSION_MAJOR}.{VERSION_MINOR}, you can download
_WSJT-X_ {VERSION_MAJOR}.{VERSION_MINOR}, you can download
the _LoTW_ file manually. Go to
https://lotw.arrl.org/lotw-user-activity.csv in a web browser,
download the file, then move it to the _WSJT-X_ log files
directory. This directory can be opened by selecting
*File&nbsp;|&nbsp;Open&nbsp;log&nbsp;directory*.
*File|Open log directory* from the main menu.
* _WSJT-X_ expects your sound card to do its raw sampling at 48000 Hz.
To ensure that this will be so when running under recent versions of
Windows, open the system's *Sound* control panel and select in turn
the *Recording* and *Playback* tabs. Click on *Properties*, then
the *Recording* and *Playback* tabs. Click *Properties*, then
*Advanced*, and select *16 bit, 48000 Hz (DVD Quality)*. Switch off
all audio enhancement features for these devices.
* You can uninstall _WSJT-X_ by clicking its *Uninstall* link in the
Windows *Start* menu, or by using *Uninstall a Program* on the
Windows Control Panel Programs and Features option or in Settings
Apps and Features on Windows 10.
*Windows Control Panel|Programs and Features* option or in *Settings|Apps* on Windows 10.