1. Updated two screen pix in User's Guide.

2. Revise, revise, revise.  Good writing requires plenty of revisions!


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3667 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Joe Taylor 2014-01-28 21:53:09 +00:00
parent 2c7a76ffbc
commit cb88a54c39
18 changed files with 154 additions and 132 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.3 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -4,3 +4,5 @@ The Band Settings tab allows you to define the default frequency and
enter a brief description of your antenna for each amateur band. The
antenna information will be included with reception reports to
{pskreporter}, if enabled.
(Figure to be added here.)

View File

@ -19,24 +19,6 @@ frequency. To enable this capability:
- Check the box *Enable CAT*
- Select your radio type from a drop-down list
- Select a *CAT port* (not the same port selected for PTT control)
- Set the correct port parameters (*Serial rate*, *Handshake*, *Data bits*,
*Stop bits*) for your radio
- If you use {dxlcommander} or {hrd} to control your transceiver, you
can configure _WSJT-X_ to communicate with the radio through that
program. Entries for these programs appear at the end of the
drop-down list of supported rigs.
[[X11]]
image::images/r3563-config-screen-80.png[align="center",alt="Configuration Screen"]
For now you should leave *Split Tx* unchecked. If you are using CAT
control, most radios will allow you to set *PTT method* = CAT. Some
radios support two types of PTT assertion via CAT control: one takes
audio input from the Mic connector, the other from a rear-panel Data
connector. The simplest CAT configuration sets *Polling interval* = 0
(no polling the radio for dial frequency). _WSJT-X_ will then be able
to set the radios frequency, but the program will be unaware of
subsequent changes made using the radios panel controls.
TIP: If you need an additional item in the list of devices for the
CAT port, edit the configuration file +wsjtx.ini+ and add your
@ -44,6 +26,25 @@ requirement as +CATdriver=<yourdriver>+ (for example,
+CATdriver=/dev/tty.usbserial+) in the group of entries marked
+[Common]+.
- Set the port parameters *Serial rate*, *Handshake*, *Data bits*,
*Stop bits* as required for your radio
- If you use {dxlcommander} or {hrd} to control your transceiver, you
can configure _WSJT-X_ to communicate with the radio through that
program. Entries for these programs appear at the end of the
drop-down list of supported rigs.
[[X11]]
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
radios will allow you to set *PTT method* = CAT. Some radios support
two types of PTT assertion via CAT control: one takes audio input from
the Mic connector, the other from a rear-panel Data connector. The
simplest CAT configuration sets *Polling interval* = 0 (no polling the
radio for dial frequency). _WSJT-X_ can then set the radios
frequency, but the program will be unaware of subsequent changes made
using the radios panel controls.
With most radios you can set *Polling interval* to a small number (say
1 3 s) and the program will follow any frequency changes made at the
radio. Note that you may not be able simultaneously to control the
@ -55,6 +56,6 @@ and to exit the program before turning the equipment off.
- Click the *Test CAT Control* and *Test PTT* buttons to see that you
have established the desired control of station functions.
- Select the devices you will use for Audio input and output.
- Select the devices you will use for *Audio In* and *Audio Out*.
- Click *OK* to dismiss the *Configuration* window.

View File

@ -3,4 +3,6 @@
*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
fields provided. In JT65 and JT9 the maximum free-text message length
is 13 characters, including spaces.
is 13 characters, including embedded spaces.
(Figure to be added here.)

View File

@ -11,5 +11,5 @@ Frequency* windows.
- 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
``10 50 12 100'' (without the quotes).
something like ``10 50 12 100'' (without the quotes).

View File

@ -3,10 +3,8 @@
// to a very old src version of WSJT 5.7 or so. WSJTX is not listed at all.
// Also, all the Qt4 stuff is now obsolete, and needs to be updated.
_WSJT-X_ is an open-source program released under the GNU General
Public License (GPL). Source code is available from the public repository
at {devsvn}. To compile the program you will need to install the
following packages:
Source code is available from the public repository at {devsvn}. To
compile the program you will need to install the following packages:
- Subversion
- Qt 5.x
@ -19,6 +17,6 @@ following packages:
With Subversion installed, the full source code for _WSJT-X_ can be
downloaded with the command:
$ svn co svn://svn.berlios.de/wsjt/branches/wsjtx
svn co svn://svn.berlios.de/wsjt/branches/wsjtx
// Need further compiling Instructions

View File

@ -1,16 +1,17 @@
// Status=review
Two different packages are available: one for OS X 10.6 through 10.8,
and one for OS X 10.9. The two versions are _not_ interchangeable.
and one for OS X 10.9. The two packages are _not_ interchangeable.
- Select the correct package for your OS X and download it to your desktop.
** {osx-108}
** {osx-109}
- Double-click on the file to see a new folder, +WSJT-X+. Drop down
into that folder, where a +Readme+ file provides detailed instructions
on how to configure your system for _WSJT-X_.
- Some additional information can be found {osx-instructions}.
* {osx-108}
* {osx-109}
- Additional information from package developer G4KLA
can be found {osx-instructions}.
// Any necessary instructions about time synchronization or sound setup ??

View File

@ -1,6 +1,7 @@
// Status=review
- Installation packages for Ubuntu 12.04, 12.10, 13.04, 13.10 are
available at {launchpadurl}.
maintained by AC6SL and available at {launchpadurl}.
- If you have not before obtained packages from the Personal Package
Archive (PPA) at the above link, open a terminal window and execute

View File

@ -16,10 +16,10 @@ downloading and installation instructions.
- _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* options. Click on *Properties*, then
Windows, open the system's *Sound* control panel and select in turn the
*Recording* and *Playback* tabs. Click on *Properties*, then
*Advanced*, and select ``16 bit, 48000 Hz (DVD Quality).''
CAUTION: If you are using a sound card that is also the default device
for Windows sounds, be sure to turn off all such sounds so they are
not transmitted over the air.
CAUTION: If you are using a sound card that is also the Windows
default audio device, be sure to turn off all Windows sounds so they
are not transmitted over the air.

View File

@ -1,9 +1,10 @@
// Status=review
_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”, and
the “-X” suffix indicates that _WSJT-X_ started as an extended (and
experimental) branch of program _WSJT_.
in the program name stand for ``Weak Signal communication by K1JT'',
and the “-X” suffix indicates that _WSJT-X_ started as an extended
(and experimental) branch of program _WSJT_.
_WSJT-X_ currently offers two protocols or “modes,” JT65 and JT9.
Both are designed for making reliable, confirmed QSOs under extreme
@ -15,8 +16,9 @@ It is about 2 dB more sensitive than JT65 while using less than 10% of
the bandwidth. Both modes use one-minute timed sequences of
alternating transmission and reception, so a minimal QSO takes four to
six minutes — two or three transmissions by each station, one sending
in odd UTC minutes and the other even. World-wide QSOs are possible
with power levels of a few watts and compromise antennas.
in odd UTC minutes and the other even. On the HF bands, world-wide
QSOs are possible with power levels of a few watts and compromise
antennas.
_WSJT-X_ can display a bandpass as large as 5 kHz and transparently
provides dual-mode reception of both JT65 and JT9 signals. If your
@ -29,10 +31,11 @@ make QSOs in both modes using nothing more than mouse clicks.
Plans for future program development call for _WSJT-X_ and _WSJT_ to
merge together. _WSJT-X_ will gradually acquire the additional modes
JT4, FSK441, and ISCAT that are now supported in _WSJT_. The entire
WSJT-related effort is an open-source project. If you have
programming or documentation skills or would like to contribute to the
project in other ways, please make your interests known to the
development team. The projects source-code repository can be found
at {devsvn}, and communication among the developers takes place on the
email reflector {devmail}.
WSJT-related effort is an open-source project, released under the GNU
General Public License (GPL). If you have programming or
documentation skills or would like to contribute to the project in
other ways, please make your interests known to the development team.
The projects source-code repository can be found at {devsvn}, and
most communication among the developers takes place on the email
reflector {devmail}.

View File

@ -14,21 +14,21 @@ image::images/r3556-main-ui-80.png[align="center",alt="Main UI and Wide Graph"]
Notice the [green]*GREEN* and [red]*RED* markers on the waterfall
frequency scale. Decoding takes place at the end of a receive
sequence and is organized in two stages. The first decodes take place
at the selected Rx frequency, indicated by the [green]*GREEN* marker.
Results appear in both the left (*Band Activity*) and right (*Rx
Frequency*) text windows on the main screen. The program then finds
and decodes all signals in the selected mode or modes over the
displayed frequency range. The [red]*RED* marker indicates your Tx
frequency.
at the selected Rx frequency, indicated by the [green]*GREEN* marker
on the waterfall scale. Results appear in both the left (*Band
Activity*) and right (*Rx Frequency*) text windows on the main
screen. The program then finds and decodes all signals in the selected
mode(s) over the displayed frequency range. The [red]*RED* marker
indicates your Tx frequency.
At least eight JT9 signals are present in the example file; all but
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
audio frequency, 1224 Hz, his message “K1JT KF4RWA 73” appears in the
*Rx Frequency* window. The *Band Activity* window shows this message
plus all the other decodes at nearby frequencies. The CQ lines are
highlighted in [green]*GREEN*, and lines containing *My Call*, in this
case K1JT, are highlighted in [red]*RED*.
audio frequency, 1224 Hz, his 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. The
Lines containing CQ are highlighted in [green]*GREEN*, and lines
with *My Call* (in this case K1JT) in [red]*RED*.
TIP: For this step and the next, you may want to pretend you are K1JT
by entering that callsign temporarily as *My Call* on the <<X11,*Setup
@ -38,8 +38,8 @@ those shown in the screen shot above.
[[X13]]
.Decoding Controls
To gain some feeling for the controls frequently used when making
QSOs, try clicking with the mouse on the decoded text lines and on the
To gain some feeling for controls frequently used when making QSOs,
try clicking with the mouse on the decoded text lines and on the
waterfall spectral display. You should be able to confirm the
following behavior:
@ -49,7 +49,7 @@ green. This action produces the following results:
** Callsign and locator of a station calling CQ are copied to the *DX
Call* and *DX Grid* entry fields.
** Messages are generated for a minimal QSO.
** Messages are generated for a standard minimal QSO.
** The *Tx even* box is checked or cleared appropriately, so that you
will transmit in the proper (odd or even) minutes.
@ -60,9 +60,9 @@ CQing station.
** The *Gen Msg* (``generated message'') radio button at bottom right
of the main window is selected.
** If you have checked *Double-click on call sets Tx Enable* on the
*Setup* menu, *Enable Tx* is activated and a transmission starts
automatically at the appropriate time.
** 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'',
highlighted in [red]*RED*. Results will be similar to those in the
@ -71,9 +71,9 @@ moved. Such messages are usually in response to your own CQ, or from
a tail-ender, and you probably want your Tx frequency to stay where it
was.
- By holding down the *Ctrl* key when double-clicking on the decoded line
you can cause both Tx and Rx frequencies to be moved. This behavior
can also be forced by checking *Lock Tx=Rx*.
- By holding down the *Ctrl* key when double-clicking on a decoded
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
@ -87,10 +87,10 @@ call CQ again.)
- Ctrl-click on waterfall to set both Rx and Tx frequencies.
- Double-click on the waterfall to set Rx frequency and start a
narrow-band decode there. Decoded text appears in the right window
narrow-band decode there. Decoded text will appear in the right window
only.
- Ctrl-double-click to set both Rx and Tx frequencies and decodes at
- Ctrl-double-click to set both Rx and Tx frequencies and decode at
the new frequency.
- Click *Erase* to clear the right window.

View File

@ -6,7 +6,7 @@
frequency limit is approximately 4000 Hz.
.Main Window:
- Select *JT9+JT65* on the *Mode* menu
- Select *JT9+JT65* on the *Mode* menu.
- Toggle the *Tx mode* button to read *Tx JT65*, and set the Tx and Rx
frequencies to 1718 Hz.
- Double-click on *Erase* to clear both text windows.
@ -38,11 +38,14 @@ been decoded first.
- Confirm that mouse-click behavior is similar to that described
<<X13,earlier>>, in Example 1. The program automatically determines
the mode of each JT9 or JT65 signal. Note that when you double-click
on a signal in the waterfall, this is true even if the signal is on
the ``wrong'' side of the [blue]*BLUE* *JT65 nnnn JT9* marker. When
clicking on a JT65 signal to decode it, click on the sync tone at the
left edge.
the mode of each JT9 or JT65 signal.
TIP: When you double-click on a signal in the waterfall it will be
properly decoded even if on the ``wrong'' side of the *JT65 nnnn JT9*
marker. The Tx mode automatically switches to that of the decoded
signal and the Rx and Tx frequency markers on the waterfall scale
resize themselves accordingly. When selecting a JT65 signal, click on
the sync tone at its left edge.
- Double-click on the waterfall near 815 Hz: a JT65 message
originating from W7VP will be decoded and appear in the *Rx Frequency*
@ -54,8 +57,8 @@ window.
|2343|-7|0.3|815|#|KK4DSD W7VP -16
|=================================
- Double-click on the waterfall at 3196 Hz and the program will decode a JT9
message from IZ0MIT:
- 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"]
|=====================================
@ -63,11 +66,6 @@ message from IZ0MIT:
|2343|-7|0.3|3196|@|WB8QPG IZ0MIT -11
|=====================================
TIP: Notice that when a signal is decoded in this way, 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.
- 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
and Rx frequencies to that of DL7ACA, 975 Hz. If you had checked

View File

@ -1,5 +1,6 @@
// Status=review
- Click the *Stop* button on the main window to halt any data acquisition.
- Select *JT9* from the *Mode* menu and *Deepest* from the *Decode* menu.
- Set the audio frequencies to *Tx 1224 Hz* and Rx 1224 Hz*.
//Maybe show small screen shots here?
- Set the audio frequencies to *Tx 1224 Hz* and *Rx 1224 Hz*.

View File

@ -1,9 +1,10 @@
// Status=review
- *Bins/Pixel* = 4
- *JT65 2500 JT9*
- *JT65 .... JT9* = 2500
- *Start* = 0
- *N Avg* = 5
- *Zero* = 10
- *Zero* = 0
- *Gain* = 0,
- *Palette* = Digipan
- *Flatten* = checked

View File

@ -30,8 +30,8 @@
:jtalert: http://ham-apps.com[JT-ALERT-X]
:cty_dat: http://www.country-files.com/cty/[here].
// These [[X?]] numbers are HTML anchors, and can be used to
// navigate though the document easily: <<[X1],See Introduction]>> will
// These [[xxxx]] labels are HTML anchors, and can be used to
// navigate though the document easily: <<[INTRO],See Introduction]>> will
// place a hyper-link in your text to take you too the anchored section.
// All major sections or points of interest should have one.
@ -39,29 +39,29 @@
// be section 1.1.1. This method is used throughout the document.
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[[X1]]
[[INTRO]]
== Introduction
include::introduction.adoc[]
[[X2]]
[[SYSREQ]]
== System Requirements
include::system-requirments.adoc[]
[[X3]]
[[INSTALL]]
== Installation
- Download _WSJT-X_ from the {homepage}. Click on _WSJT-X_ at the left
margin and then on the appropriate link(s) for your operating system.
[[INSTALL_WIN]]
=== Windows
include::install-windows.adoc[]
[[X31]]
[[INSTALL_UBU]]
=== Linux
include::install-ubuntu.adoc[]
// The Mac Section need to be written. The file is a placeholder only.
[[X32]]
[[INSTALL_OSX]]
=== OS X
include::install-mac.adoc[]
@ -70,133 +70,147 @@ include::install-mac.adoc[]
// Also, all the Qt4 stuff is now obsolete, and needs to be updated.
// Instructions for source builds Win, *Nix & Mac all need to be written /
// Rreviewd.
[[X33]]
[[SRC_CODE]]
=== Source Code
include::install-from-source.adoc[]
[[X4]]
[[CONFIG]]
== Setup and Configuration
[[X41]]
[[STATION]]
=== Station Tab
include::configuration-station.adoc[]
[[X42]]
[[TXMACROS]]
=== Tx Macros Tab
include::configuration-txmacros.adoc[]
[[X43]]
[[BAND_SETTINGS]]
=== Band Settings Tab
include::configuration-band-settings.adoc[]
[[X44]]
[[CONFIG_MAIN]]
=== Main Window
include::configuration-main-window.adoc[]
[[X45]]
[[FONTS]]
=== Font Sizes
include::font-sizes.adoc[]
[[X5]]
[[TUTORIAL]]
== Basic Operating Tutorial
[[X51]]
[[TUT_MAIN]]
=== Main Window Settings
include::tutorial-main-window.adoc[]
[[X52]]
[[TUT_WIDE_GRAPH]]
=== Wide Graph Settings
include::tutorial-wide-graph-settings.adoc[]
[[X53]]
[[TUT_EX1]]
=== Sample File 1
include::tutorial-example1.adoc[]
[[X54]]
[[TUT_EX2]]
=== Sample File 2
include::tutorial-example2.adoc[]
[[X55]]
[[TUT_XCVR]]
=== Transceiver Setup
include::transceiver-setup.adoc[]
[[X6]]
[[MAKE_QSOS]]
== Making QSOs
include::make-qso.adoc[]
[[X7]]
[[CONTROLS]]
== Controls & Functions
[[X71]]
[[CONTROLS_WIDE]]
=== Wide Graph Controls
include::controls-functions-wide-graph.adoc[]
[[X72]]
[[CONTROLS_MAIN]]
=== Main Window
include::controls-functions-main-window.adoc[]
[[X73]]
[[CONTROLS_LEFT]]
=== Misc Controls Left
include::controls-functions-left.adoc[]
[[X74]]
[[CONTROLS_CENTER]]
=== Misc Controls Center
include::controls-functions-center.adoc[]
[[X75]]
[[CONTROLS_MSGS]]
=== Tx Messages
include::controls-functions-messages.adoc[]
[[X76]]
[[STATUS_BAR]]
=== Status Bar
include::controls-functions-status-bar.adoc[]
[[X77]]
[[MENUS]]
=== Menus
include::controls-functions-menus.adoc[]
[[X78]]
[[SHORTCUTS]]
=== Keyboard Shortcuts
include::controls-functions-kb-shortcuts.adoc[]
[[X79]]
[[MOUSE_COMMANDS]]
=== Mouse Commands
include::controls-functions-special-mouse-cmds.adoc[]
[[X8]]
== JT65 Protocol
[[COOP_PGMS]]
== Cooperating Programs
To be added ...
[[JT65PRO]]
== The JT65 Protocol
include::jt65-protocol.adoc[]
[[X9]]
== JT9 Protocol
[[JT9PRO]]
== The JT9 Protocol
include::jt9-protocol.adoc[]
[[XA]]
[[JT65_JT9]]
== JT65 & JT9 Differences
include::jt65-jt9-differences.adoc[]
[[XB]]
[[TXRX]]
== Transmitting and Receiving in _WSJT-X_
include::tx-rx.adoc[]
[[XAPPA]]
[[TROUBLE_SHOOTING]]
== Troubleshooting
To be added ...
[[FAQ]]
== Frequently Asked Questions
To be added ...
[[APPA]]
== Appendix A
// Note to Dev-Team, this list of files needs to be updated.
[[XAPPA1]]
[[APPA1]]
=== Installed Files
include::installed-files.adoc[]
[[XAPPA2]]
[[APPA2]]
=== Runtime Files
include::runtime-files.adoc[]
[[XAPPB]]
[[APPB]]
== Appendix B
[[XAPPB1]]
[[APPB1]]
=== Rig Configuration
include::rig-config-main.adoc[]
[[XACK]]
[[ACK]]
== Acknowledgments
include::acknowledgements.adoc[]

View File

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