From 2c7a76ffbc52d4184c44a4e249a25577249e74f8 Mon Sep 17 00:00:00 2001 From: Joe Taylor Date: Tue, 28 Jan 2014 15:24:26 +0000 Subject: [PATCH] Another round of edits for the WSJT-X User's Guide. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3666 ab8295b8-cf94-4d9e-aec4-7959e3be5d79 --- doc/source/configuration-band-settings.adoc | 4 +- doc/source/configuration-main-window.adoc | 4 +- doc/source/configuration-station.adoc | 28 +++++----- doc/source/configuration-txmacros.adoc | 6 +- doc/source/controls-functions-center.adoc | 20 ++++--- .../controls-functions-kb-shortcuts.adoc | 1 + doc/source/controls-functions-left.adoc | 16 +++--- .../controls-functions-main-window.adoc | 18 +++--- doc/source/controls-functions-menus.adoc | 38 ++++++++++++- doc/source/controls-functions-messages.adoc | 22 ++++---- ...controls-functions-special-mouse-cmds.adoc | 2 +- doc/source/controls-functions-status-bar.adoc | 5 +- doc/source/controls-functions-wide-graph.adoc | 15 +++-- doc/source/font-sizes.adoc | 6 +- doc/source/install-mac.adoc | 2 + doc/source/install-ubuntu.adoc | 12 ++-- doc/source/install-windows.adoc | 2 +- doc/source/introduction.adoc | 10 ++-- doc/source/jt65-protocol.adoc | 19 ++++--- doc/source/jt9-protocol.adoc | 4 +- doc/source/make-qso.adoc | 56 ++++++++++--------- doc/source/system-requirments.adoc | 4 +- doc/source/transceiver-setup.adoc | 11 ++-- doc/source/tutorial-example1.adoc | 51 ++++++++--------- doc/source/tutorial-example2.adoc | 54 ++++++++++-------- doc/source/tutorial-main-window.adoc | 2 +- doc/source/tutorial-wide-graph-settings.adoc | 7 ++- doc/source/wsjtx-main.adoc | 4 ++ mainwindow.cpp | 2 +- 29 files changed, 244 insertions(+), 181 deletions(-) diff --git a/doc/source/configuration-band-settings.adoc b/doc/source/configuration-band-settings.adoc index 8724f5fbc..0f52d99c6 100644 --- a/doc/source/configuration-band-settings.adoc +++ b/doc/source/configuration-band-settings.adoc @@ -1,6 +1,6 @@ // Status=review -The Band Settings tab allows you to set the default frequency and +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 they have been enabled. +{pskreporter}, if enabled. diff --git a/doc/source/configuration-main-window.adoc b/doc/source/configuration-main-window.adoc index 076d3f98a..2e3dcb373 100644 --- a/doc/source/configuration-main-window.adoc +++ b/doc/source/configuration-main-window.adoc @@ -5,8 +5,8 @@ To set the proper level of audio drive from _WSJT-X_ to your radio: radio into transmit mode and generate a steady audio tone. * Listen to the generated audio tone using your radio’s Monitor -facility. The tone should be perfectly smooth, with no clicks or -glitches. +facility. The pure sinusoidal tone should be perfectly smooth, with no +clicks or glitches. * Open the computer’s audio mixer controls for output (“Playback”) devices and adjust the volume slider downward from its maximum until diff --git a/doc/source/configuration-station.adoc b/doc/source/configuration-station.adoc index 862287822..776bc7523 100644 --- a/doc/source/configuration-station.adoc +++ b/doc/source/configuration-station.adoc @@ -14,13 +14,13 @@ Default is 0 (never). _WSJT-X_ does not implement full transceiver control, but it provides a way to ensure that _WSJT-X_ can read and set the radio’s dial -frequency. If you want this capability: +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 port parameters (*Serial rate*, *Handshake*, *Data bits*, *Stop -bits*) for your radio +- 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 @@ -39,22 +39,22 @@ to set the radio’s frequency, but the program will be unaware of subsequent changes made using the radio’s 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 -requirement as CATdriver=yourdriver (for example, -CATdriver=/dev/tty.usbserial ) in the group of entries marked -[Common]. +CAT port, edit the configuration file +wsjtx.ini+ and add your +requirement as +CATdriver=+ (for example, ++CATdriver=/dev/tty.usbserial+) in the group of entries marked ++[Common]+. 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 your -radio from _WSJT-X_ and from another program. Some experimentation may -be required, and you may need to refer to the documentation for your -rig-control software and your radio. It is best to have the radio and -any interface equipment turned on and connected before starting -_WSJT-X_, and to exit the program before turning your equipment off. +radio. Note that you may not be able simultaneously to control the +radio from _WSJT-X_ and from another program. Some experimentation +may be required; refer to the documentation for your rig-control +software and your radio. It is best to have the radio and any +interface equipment turned on and connected before starting _WSJT-X_, +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. -- Click OK to dismiss the *Configuration* window. +- Click *OK* to dismiss the *Configuration* window. diff --git a/doc/source/configuration-txmacros.adoc b/doc/source/configuration-txmacros.adoc index 99293375a..9aaa44cc7 100644 --- a/doc/source/configuration-txmacros.adoc +++ b/doc/source/configuration-txmacros.adoc @@ -1,6 +1,6 @@ // Status=review + *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. The maximum free-text message length in JT65 and JT9 -is 13 characters. - +fields provided. In JT65 and JT9 the maximum free-text message length +is 13 characters, including spaces. diff --git a/doc/source/controls-functions-center.adoc b/doc/source/controls-functions-center.adoc index 5262dc3fb..14736b369 100644 --- a/doc/source/controls-functions-center.adoc +++ b/doc/source/controls-functions-center.adoc @@ -6,23 +6,25 @@ use when making QSOs: image::images/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 intervals. This selection is made +this box to transmit in the odd minutes. This selection is made automatically when you double-click on a decoded text line as described in the <>. * The Tx and Rx audio frequencies can be adjusted with spinner controls. These settings are usually set automatically by -double-clicking on decoded text or on thw waterfall. +double-clicking on decoded text or a signal in the waterfall. -* The on-the-air frequency of your lowest JT9 or JT65 tone is the sum -of dial frequency and audio Tx frequency. You can force Tx frequency -to the current Rx frequency by clicking the *Tx=Rx* button, and -vice-versa for *Rx=Tx*. Check the box *Lock Tx=Rx* to make the -frequencies always track one another. +* 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 = +sign is from right to left.) Check the box *Lock Tx=Rx* to make the +frequencies always track one another. The on-the-air frequency of +your lowest JT9 or JT65 tone is the sum of dial frequency and audio Tx +frequency. * The *Report* control lets you change a signal report that has been -inserted automatically. Most reports will fall in the range –26 to -+10 dB. Remember that JT65 reports must lie in the range -30 to -1 dB. +inserted automatically. Most reports will fall in the range –26 to +10 +dB. Remember that JT65 reports are clamped at an upper limit of -1 +dB. IMPORTANT: When signals are close to or above 0 dB, you and your QSO partner should probably reduce power. JT65 and JT9 are supposed to be diff --git a/doc/source/controls-functions-kb-shortcuts.adoc b/doc/source/controls-functions-kb-shortcuts.adoc index 3ef8d074c..cafd06f99 100644 --- a/doc/source/controls-functions-kb-shortcuts.adoc +++ b/doc/source/controls-functions-kb-shortcuts.adoc @@ -3,6 +3,7 @@ The following keyboard shortcuts give quick access to some frequently used program functions. [horizontal] +*Key*:: *Action performed* F1:: Display online User's Guide in browser Ctrl+F1:: diff --git a/doc/source/controls-functions-left.adoc b/doc/source/controls-functions-left.adoc index fa11ddcfb..3de25d6ff 100644 --- a/doc/source/controls-functions-left.adoc +++ b/doc/source/controls-functions-left.adoc @@ -1,14 +1,14 @@ // Status=review Controls related to band and frequency selection, receiver audio -level, the station being worked, and date and time are found at lower -left of the main window: +level, the station being called or worked, 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"] -* The drop-down list of bands at upper left lets you select the -operating band and sets dial frequency to a default value taken from +* A drop-down list of bands at upper left lets you select the +operating band and sets dial frequency to a value taken from the *Default Frequencies* tab on the *Setup | Configuration* screen. If CAT control is active the radio's dial frequency will be set accordingly; if not, you must tune the radio manually. @@ -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 displayed. -* The program can keep a database of call-signs and locators for -future reference. Click *Add* to insert the present call and locator in -the database; click *Lookup* to retrieve the locator for a previously -stored call. +* The program can maintain a database of call-signs and locators for +future reference. Click *Add* to insert the present call and locator +in the database; click *Lookup* to retrieve the locator for a +previously stored call. diff --git a/doc/source/controls-functions-main-window.adoc b/doc/source/controls-functions-main-window.adoc index 9f3f7d812..213f8a583 100644 --- a/doc/source/controls-functions-main-window.adoc +++ b/doc/source/controls-functions-main-window.adoc @@ -15,22 +15,22 @@ free-text message. //.Log QSO Window image::images/log-qso.png[align="center",alt="Log QSO"] -* *Stop* will stop normal data acquisition in case you want to freeze -the waterfall, or perhaps to open and explore a previously recorded -audio file. +* *Stop* will terminate normal data acquisition in case you want to +freeze the waterfall or open and explore a previously recorded audio +file. * *Monitor* restarts normal receive operation. This button is -highlighted in green when the program is receiving. +highlighted in green when the _WSJT-X_ is receiving. -* *Erase* clears the right (*Rx frequency*) text window. Double-clicking +* *Erase* clears the right-hand decoded text window. Double-clicking Erase* clears both text windows. * *Decode* tells the program to repeat the decoding procedure at the -Rx frequency (green marker on waterfall), using the most recently +Rx frequency ([green]*GREEN* marker on waterfall), using the most recently completed sequence of Rx data. * *Enable Tx* puts the program into automatic T/R sequencing mode -and highlights the button in red. A transmission will start at the +and highlights the button in [red]*RED*. A transmission will start at the beginning of the selected (odd or even) sequence, or immediately if appropriate. A transmission will not be started any later than 24 s into a UTC minute. @@ -39,8 +39,8 @@ into a UTC minute. automatic T/R sequencing. * *Tune* may be used to switch into Tx mode and generate an -unmodulated carrier at the specified Tx frequency (red marker on -waterfall). This process may be useful for adjusting an antenna +unmodulated carrier at the specified Tx frequency ([red]*RED* marker +on waterfall). This process may be useful for adjusting an antenna tuner. The button is highlighted in [red]*RED* while *Tune* is active. Toggle the button a second time to terminate the *Tune* process. diff --git a/doc/source/controls-functions-menus.adoc b/doc/source/controls-functions-menus.adoc index f5f9a4c92..6a464c88e 100644 --- a/doc/source/controls-functions-menus.adoc +++ b/doc/source/controls-functions-menus.adoc @@ -1,7 +1,8 @@ // Status=review Program menus offer many options for configuration and operation. -You should explore them and test the resulting program actions. +Nost of the options will be self-explanatory; a few additional details +are provided below. [[X771]] ==== File menu @@ -12,6 +13,41 @@ image::images/file-menu.png[align="left",alt="File Menu"] //.Setup Menu image::images/setup-menu.png[align="left",alt="Setup Menu"] +.Show DXCC entity and worked B4 status + +When this option is checked _WSJT-X_ appends some useful 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 (according to the log file +wsjtx_log.adi+) is flagged +with a single character and a change of background colour: + +[horizontal] +!:: (bright green) -- New DXCC entity +~:: (mid green) -- You have already worked this DXCC entity but not +this station + :: (dull green) -- You have previously worked the calling station + +The program does not distinguish between modes, but it does +differentiate between bands. + +This option is mainly intended for use +on non-Windows platforms; Windows users can (and should) use VK3AMA's +excellent {jtalert} utility. + +.Requirements: + +_WSJT-X_ expects the file +cty.dat+ to be in your installation +directory. It contains the DXCC data, is regularly updated and can be +downloaded from {cty_dat}. + +Your previous history is read from file +wsjtx_log.adi+. This file is +updated every time you log a QSO from _WSJT-X_ (but note that it can +also be erased from the file menu). You can append or overwrite this +file by exporting your QSO history as an ADIF file from another +logging program. Turning *Show DXCC entity and worked B4 status* off +and on again will cause _WSJT-X_ to re-read the log file. Very large +log files may cause _WSJT-X_ to slow down while searching for calls. + [[X773]] ==== View Menu //.View Menu diff --git a/doc/source/controls-functions-messages.adoc b/doc/source/controls-functions-messages.adoc index 192b6c6c5..132a3d80c 100644 --- a/doc/source/controls-functions-messages.adoc +++ b/doc/source/controls-functions-messages.adoc @@ -2,7 +2,7 @@ Two arrangements of controls are provided for generating and selecting Tx messages. Traditional controls carried over from program _WSJT_ -appear on *Tab 1* and provide six fields for message entry. +appear on *Tab 1*, providing six fields for message entry. Pre-formatted messages for the standard minimal QSO are generated when you click *Generate Std Msgs* or double-click on an appropriate line in one of the decoded text windows. @@ -14,14 +14,14 @@ image::images/traditional-msg-box.png[align="center",alt="Traditional Message Me Tx sequence) by clicking on the circle under *Next*. * To change to a specified Tx message immediately, click on a -rectangular button under the *Now* label. Changing a Tx message -already underway reduces the chance of a correct decode, but will -probably succeed if done in the first 10 s of a Tx period. +rectangular button under the *Now* label. Changing a Tx message in +this way will slightly reduce the chance of a correct decode, but +usually succeeds if done in the first 10 s of a transmission. * Right-clicking on the entry field for message #5 pops up a list of free-text messages entered on the *Setup | Configuration | Tx Macros* -screen. You can select any of these pre-stored messages by using the -left mouse button. +screen. Select any of these pre-stored messages by using the left +mouse button. The second arrangement of controls for generating and selecting Tx messages appears on *Tab 2* of the Message Control Panel: @@ -31,11 +31,11 @@ image::images/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 -column if you are answering a CQ. Clicking a button puts the -appropriate message in the *Gen Msg* box. If you are already -transmitting, it changes the Tx message immediately. You can enter -anything (up to 13 characters) in the *Free Msg* box. Right-clicking on -this entry field pops up your previously defined list of *Tx Macros*. +column if answering a CQ. Clicking a button puts the appropriate +message in the *Gen Msg* box. If you are already transmitting, it +changes the Tx message immediately. You can enter anything (up to 13 +characters) in the *Free Msg* box. Right-clicking on this entry field +pops up your previously defined list of *Tx Macros*. IMPORTANT: During a transmission the actual message being sent always appears highlighted in yellow in the first box of the status bar diff --git a/doc/source/controls-functions-special-mouse-cmds.adoc b/doc/source/controls-functions-special-mouse-cmds.adoc index 5d48bea81..198245755 100644 --- a/doc/source/controls-functions-special-mouse-cmds.adoc +++ b/doc/source/controls-functions-special-mouse-cmds.adoc @@ -4,7 +4,7 @@ The following special mouse commands are available: //.Special Mouse Commands [width="80%",cols="13,50",options="header",align="center"] |===== -|Mouse-Click on|Action Performed +|Click on|Action Performed |Waterfall|*Click*: set Rx frequency + *Double-click*: set Rx frequency and decode there + *Ctrl-click*: set Rx and Tx frequencies + diff --git a/doc/source/controls-functions-status-bar.adoc b/doc/source/controls-functions-status-bar.adoc index a6d957957..84b54410b 100644 --- a/doc/source/controls-functions-status-bar.adoc +++ b/doc/source/controls-functions-status-bar.adoc @@ -6,6 +6,7 @@ information about operating conditions. //.Status Bar image::images/status-bar-a.png[align="left",alt="New Message Menu"] -Labels on the Status Bar provide information about the current +Labels on the Status Bar display the program's provide current operating state (Receiving, Transmitting, Tune, or an open file name), -operating mode, and content of your most recent transmitted message. +its operating mode, and the content of your most recent transmitted +message. diff --git a/doc/source/controls-functions-wide-graph.adoc b/doc/source/controls-functions-wide-graph.adoc index ef97f803e..a4e42a890 100644 --- a/doc/source/controls-functions-wide-graph.adoc +++ b/doc/source/controls-functions-wide-graph.adoc @@ -12,7 +12,7 @@ compress the spectral display. Normal operation with a convenient window size works well at 2 to 8 bins per pixel. - *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. - *Start nnn Hz* sets the low-frequency starting point of the @@ -30,13 +30,12 @@ preferences. - *Palette* lets you select from a wide range of waterfall color palettes. -- Check *Flatten* if you want _WSJT-X_ to compensate for uneven -response across the received passband. +- Check *Flatten* if you want _WSJT-X_ to compensate for a sloping or +uneven response across the received passband. -- Select *Current* or *Cumulative* for the spectrum displayed -in the bottom one-third of the Wide Graph window. *Current* is the -average spectrum over the most recent *N Avg* FFT calculations. -*Cumulative* is the average spectrum since the start of the current -minute. +- Select *Current* or *Cumulative* for the spectrum displayed in the +bottom one-third of the Wide Graph window. *Current* is the average +spectrum over the most recent *N Avg* FFT calculations. *Cumulative* +is the average spectrum since the start of the present UTC minute. diff --git a/doc/source/font-sizes.adoc b/doc/source/font-sizes.adoc index bc1c4f559..06fbac841 100644 --- a/doc/source/font-sizes.adoc +++ b/doc/source/font-sizes.adoc @@ -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. -- The default is ``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). +- 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). diff --git a/doc/source/install-mac.adoc b/doc/source/install-mac.adoc index 7b1be3b71..639048ee8 100644 --- a/doc/source/install-mac.adoc +++ b/doc/source/install-mac.adoc @@ -12,3 +12,5 @@ on how to configure your system for _WSJT-X_. - Some additional information can be found {osx-instructions}. * {osx-108} * {osx-109} + +// Any necessary instructions about time synchronization or sound setup ?? diff --git a/doc/source/install-ubuntu.adoc b/doc/source/install-ubuntu.adoc index e917f4cc8..7fe3ab20c 100644 --- a/doc/source/install-ubuntu.adoc +++ b/doc/source/install-ubuntu.adoc @@ -3,17 +3,19 @@ available at {launchpadurl}. - If you have not before obtained packages from the Personal Package -Archive (PPA) at the above link, execute the following instruction at -the command prompt: +Archive (PPA) at the above link, open a terminal window and execute +the following command: - $ sudo add-apt-repository ppa:jnogatch/wsjtx + sudo add-apt-repository ppa:jnogatch/wsjtx - Accept the PPA Key, then issue these commands: - $ sudo apt-get update - $ sudo apt-get install wsjtx + sudo apt-get update + sudo apt-get install wsjtx - Download the soft-decision Reed Solomon decoder, {kvasd}, and put it in the same directory as the executable binaries +wsjtx+ and +jt9+. Normally (after you have run the script +/usr/bin/wsjtx+ at least once) this directory will be +$HOME/.wsjtx+. + +// Add instructions about ntpd and sound setup. diff --git a/doc/source/install-windows.adoc b/doc/source/install-windows.adoc index e903a6cd4..0e266a55d 100644 --- a/doc/source/install-windows.adoc +++ b/doc/source/install-windows.adoc @@ -6,7 +6,7 @@ instructions. location +C:\Program Files\WSJTX+. The suggested default directory is +C:\WSJTX+. -- All files relating to _WSJT-X_ will be stored in your chosen +- All files relating to _WSJT-X_ will be stored in the chosen installation directory and its subdirectories. You can uninstall _WSJT-X_ by removing the installation directory and its contents. diff --git a/doc/source/introduction.adoc b/doc/source/introduction.adoc index cc62a7206..df6be3aa9 100644 --- a/doc/source/introduction.adoc +++ b/doc/source/introduction.adoc @@ -5,11 +5,11 @@ 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_ offers two protocols or “modes,” JT65 and JT9. Both are -designed for making reliable, confirmed QSOs under extreme weak-signal -conditions. They use nearly identical message structure and source -encoding. JT65 was designed for EME (“moon-bounce”) on the VHF/UHF -bands, and has also proved very effective for worldwide QRP +_WSJT-X_ currently offers two protocols or “modes,” JT65 and JT9. +Both are designed for making reliable, confirmed QSOs under extreme +weak-signal conditions. They use nearly identical message structure +and source encoding. JT65 was designed for EME (“moon-bounce”) on the +VHF/UHF bands, and has also proved very effective for worldwide QRP communication at HF. JT9 is optimized for the LF, MF, and HF bands. 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 diff --git a/doc/source/jt65-protocol.adoc b/doc/source/jt65-protocol.adoc index 8aece6281..dc41c7b08 100644 --- a/doc/source/jt65-protocol.adoc +++ b/doc/source/jt65-protocol.adoc @@ -6,14 +6,14 @@ implementation in program _WSJT_ was published in {jt65protocol} for September-October, 2005. Briefly stated, JT65 uses 60 s T/R sequences and carefully structured messages. Standard messages are compressed so that two callsigns and a grid locator can be transmitted with just -71 bits. A 72^nd^ bit serves as a flag to indicate that the message +71 bits. A 72nd bit serves as a flag to indicate that the message consists of arbitrary text (up to 13 characters) instead of callsigns and a grid locator. Special formats allow other information such as add-on callsign prefixes (e.g., ZA/K1ABC) or numerical signal reports (in dB) to be substituted for the grid locator. The aim of source encoding is to compress the common messages used for minimal QSOs into a minimum fixed number of bits. After compression, a Reed Solomon -(63,12) error-correcting code converts 72-bit user messages into +(63,12) error-control code converts 72-bit user messages into sequences of 63 six-bit channel symbols. JT65 requires tight synchronization of time and frequency between @@ -27,7 +27,7 @@ vector interleaved with the encoded information symbols. The sync vector allows calibration of time and frequency offsets between transmitter and receiver. A transmission nominally begins at t = 1 s after the start of a UTC minute and finishes at t = 47.8 s. The -synchronizing tone is at 11025*472/4096 = 1270.5 Hz, and is normally +synchronizing tone is at 11025 × 472/4096 = 1270.5 Hz, and is normally sent in each interval having a “1” in the following pseudo-random sequence: @@ -38,9 +38,10 @@ Encoded user information is transmitted during the 63 intervals not 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 symbol, 0 ≤ N ≤ 63, and m is 1, 2, or 4 for JT65 sub-modes A, B, or C. -The signal report “OOO” is conveyed by reversing sync and data -positions in the transmitted sequence. Shorthand messages dispense -with the sync vector and use intervals of 1.486 s (16,384 samples) for -the 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 -nm Hz with n = 2, 3, 4 for the messages RO, RRR, and 73. +For EME (but conventionally not on the HF bands) the signal report +OOO is conveyed by reversing sync and data positions in the +transmitted sequence. Shorthand messages dispense with the sync +vector and use intervals of 1.486 s (16,384 samples) for the +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 nm Hz +with n = 2, 3, 4 for the messages RO, RRR, and 73. diff --git a/doc/source/jt9-protocol.adoc b/doc/source/jt9-protocol.adoc index 0dca81432..e508ca312 100644 --- a/doc/source/jt9-protocol.adoc +++ b/doc/source/jt9-protocol.adoc @@ -6,11 +6,11 @@ JT9 is designed for making minimal QSOs at LF, MF, and HF. It uses those in JT65. Error control coding (ECC) uses a strong convolutional code with constraint length K=32, rate r=1/2, and a zero tail, leading to an encoded message length of (72+31) × 2 = 206 information-carrying -bits. Modulation is nine-tone frequency-shift keying, or 9-FSK. +bits. Modulation is nine-tone frequency-shift keying, 9-FSK. Eight tones are used for data, one for synchronization. Eight data tones means that three data bits are conveyed by each transmitted information symbol. Sixteen symbol intervals are devoted to -synchronization, so a transmission therefore requires a total of 206 / 3 +synchronization, so a transmission requires a total of 206 / 3 + 16 = 85 (rounded up) channel symbols. The sync symbols are those numbered 1, 2, 5, 10, 16, 23, 33, 35, 51, 52, 55, 60, 66, 73, 83, and 85 in the transmitted sequence. diff --git a/doc/source/make-qso.adoc b/doc/source/make-qso.adoc index fe10652c6..6394374a5 100644 --- a/doc/source/make-qso.adoc +++ b/doc/source/make-qso.adoc @@ -3,7 +3,7 @@ By longstanding tradition, a minimal 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, formatted messages. The process works best +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: @@ -34,15 +34,15 @@ report. JT65 reports are constrained to lie in the range –30 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 -audible (to those with very good hearing) around –15 dB. Thresholds +audible (to someone with very good hearing) around –15 dB. Thresholds for signal decodability are approximately –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 JOE 73'' or ``5W -VERT 73 GL'' are supported, up to a maximum of 13 characters +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). It should be obvious that the JT9 and JT65 -protocols are not suitable for extensive conversations or rag-chewing. +protocols are not well suited for extensive conversations or rag-chewing. === Compound Callsigns @@ -53,20 +53,21 @@ two possible ways. 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 a message in place of the third -``word'' (normally a locator, signal report, RRR, or 73). Thus, the -following examples are all properly formatted *Type 1* messages: +one item from this list can be used in a message in place of the +standard third word (normally a locator, signal report, RRR, or 73). +Thus, the following examples are all acceptable *Type 1* messages +with compound callsigns: CQ ZA/K1ABC CQ K1ABC/4 ZA/K1ABC G0XYZ G0XYZ K1ABC/4 -However, the following messages are _not_ valid because a third -word is not permitted in a *Type 1* compound callsign message: +The following messages are _not_ valid because a third word is not +permitted in a *Type 1* message with compound callsigns: 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" A QSO between two stations using *Type 1* compound-callsign messages might look like this: @@ -78,32 +79,31 @@ might look like this: G0XYZ K1ABC RRR K1ABC G0XYZ 73 -Notice that both operators have sent and received the full compound -callsign in the first two transmissions; after that, they omit the +Notice that both operators sens and receive the full compound +callsign in the first two transmissions. After that, they omit the add-on prefix or suffix. .Type 2 Compound-Callsign Messages Prefixes and suffixes _not_ found in the short displayable list can be -handled in a *Type 2* message. The compound callsign must be the +handled with a *Type 2* message. 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 up 1-4 characters, suffixes 1-3 +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 -optional. The following are valid *Type 2* messages with compound +permitted. The following are valid *Type 2* messages with compound callsigns: - CQ W4/G0XYZ FM07 #OK because W4 is not in short-list + CQ W4/G0XYZ FM07 DE W4/G0XYZ -22 - QRZ K1ABC/VE6 DO33 #OK because VE6 is not in short-list + QRZ K1ABC/VE6 DO33 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 liet. Note -that a second callsign is never permissible in these messages, but a -locator, report, RRR, or 73 is allowed. +prefix or suffix is _not_ one of those in the displayable list. Note +that a second callsign is never permissible in these messages. -TIP: Remember that your transmitted message is always displayed in the -first panel of the *Status Bar*, highlighted in yellow, exactly as another -station will receive it. +TIP: Remember that during a transmission your transmitted message is +always displayed in the first label on the *Status Bar*, highlighted +in yellow -- displayed exactly as another station will receive it. A QSO between two stations using *Type 2* compound-callsign messages might look like this: @@ -115,15 +115,19 @@ might look like this: G0XYZ K1ABC RRR DE G0XYZ/P 73 +Each operator sends his own full callsign in the first (and perhaps +also last) transmission, as may be required by licensing authorities. + === Pre-QSO Checklist Before attempting your first QSO with JT9 or JT65, be sure to go -through the <> above and the following checklist: +through the <> 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 set to *USB* (upper sideband) mode - Radio's Split mode selected or not, consistent with your choice on *Station* tab of the *Setup | Configuration* window. diff --git a/doc/source/system-requirments.adoc b/doc/source/system-requirments.adoc index 0581bb80a..bc38a9a84 100644 --- a/doc/source/system-requirments.adoc +++ b/doc/source/system-requirments.adoc @@ -5,6 +5,6 @@ - Monitor with at least 1024 x 780 resolution (more is better) - Computer-to-radio interface using a serial port for T/R switching, or CAT control, or VOX -- Audio input and output devices supported by your operating system +- Audio input and output devices supported by the operating system - Audio or equivalent USB connections between transceiver and computer -- A means for synchronizing your computer clock to UTC within ±1 s +- A means for synchronizing the computer clock to UTC within ±1 s diff --git a/doc/source/transceiver-setup.adoc b/doc/source/transceiver-setup.adoc index b674e81c0..67defb11f 100644 --- a/doc/source/transceiver-setup.adoc +++ b/doc/source/transceiver-setup.adoc @@ -4,18 +4,17 @@ - Click the *Monitor* button to return to normal receive operation (button should be highlighted in [green]*GREEN*). -- Set your transceiver to USB (or USB Data) mode. +- Set your transceiver to *USB* (or *USB Data*) mode. - Use the receiver gain controls and/or Windows mixer controls to set the background noise level (scale at lower left of main window) to -around 30 dB with no signals present. If necessary you can also use +around 30 dB when no signals are present. If necessary you can also use the slider next to the scale, but note that the overall dynamic range will be best with this slider not too far from its mid-point. .Bandwidth and Frequency Setting -Taking full advantage of the wide-band, dual-mode capability of -_WSJT-X_ requires a receiver bandwidth of at least 4 kHz. Many SSB +Many SSB transceivers have a fixed-width Tx filter that will not pass audio frequencies higher than about 2700 Hz. _WSJT-X_ takes care of this by using *Split Tx* mode, receiving with *VFO A* and transmitting with @@ -39,6 +38,6 @@ the nominal JT9 dial frequency 2 kHz higher than the JT65 dial frequency, and the checkbox labeled *+2 kHz*, just below the *Band* selector, makes the appropriate settings easy. -IMPORTANT: When finished with this Tutorial, don’t forget to re-enter -your own call-sign as *My Call*. +IMPORTANT: When you are finished with this Tutorial, don’t forget to +re-enter your own call-sign as *My Call*. diff --git a/doc/source/tutorial-example1.adoc b/doc/source/tutorial-example1.adoc index 0941be0fa..8fa6a922b 100644 --- a/doc/source/tutorial-example1.adoc +++ b/doc/source/tutorial-example1.adoc @@ -2,7 +2,7 @@ .Open a Wave File: - Select *File | Open* and navigate to -+...\save\samples\130418_1742.wav+ under your _WSJT-X_ installation ++...\save\samples\130418_1742.wav+ under the _WSJT-X_ installation directory. When the file opens you should see something similar to the to the following screen shot: @@ -14,33 +14,34 @@ 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 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 marker indicates your Tx frequency. +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 least eight JT9 signals are present in the example file; all -but one of them are decodable. When this file was recorded KF4RWA was +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 both -decoded text windows. The *Band Activity* window shows this message -as well as 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” 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*. -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 <>. Your results should then be identical to those shown in the -<> above. +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 <> screen. Your results should then be identical to +those shown in the screen shot above. [[X13]] .Decoding Controls -To gain some feeling for the controls 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: +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 +waterfall spectral display. You should be able to confirm the +following behavior: - Double-click on either of the decoded lines highlighted in green. This action produces the following results: @@ -70,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 +- 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. +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 @@ -89,8 +90,8 @@ call CQ again.) narrow-band decode there. Decoded text appears in the right window only. -- Ctrl-double-click sets both Rx and Tx frequencies and decodes at the -new frequency. +- Ctrl-double-click to set both Rx and Tx frequencies and decodes at +the new frequency. - Click *Erase* to clear the right window. diff --git a/doc/source/tutorial-example2.adoc b/doc/source/tutorial-example2.adoc index ec41c95ee..f0b66bf8e 100644 --- a/doc/source/tutorial-example2.adoc +++ b/doc/source/tutorial-example2.adoc @@ -1,8 +1,8 @@ // Status=review .Wide Graph Settings: -- *Bins/Pixel* = 7 -- *Zero* = -3 -- Adjust the width of the Wide Graph window so that its upper + +- Set *Bins/Pixel* = 7 +- Adjust the width of the Wide Graph window so that the upper frequency limit is approximately 4000 Hz. .Main Window: @@ -24,11 +24,7 @@ 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 @). -... Figure here showing text windows ... - -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 been decoded first. +// ... 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 @@ -36,9 +32,17 @@ JT9*, where nnnn is a frequency in Hz. In *JT9+JT65* mode the program will automatically decode JT65 signals below this frequency and JT9 signals above it. +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 +been decoded first. + - Confirm that mouse-click behavior is similar to that described -<>, in Example 1. The program automatically determines the -mode of each JT9 or JT65 signal. +<>, 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. - Double-click on the waterfall near 815 Hz: a JT65 message originating from W7VP will be decoded and appear in the *Rx Frequency* @@ -77,21 +81,25 @@ program is now configured properly for a JT9 QSO with TA4A. .Reopen the First Sample File: - Select *File | Open* and navigate to +...\save\samples\130418_1742.wav+. -These 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 be using data like this. For best viewing, adjust *Bins/Pixel* -and the width of the Wide Graph so that only the active part of the -spectrum 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. +Taking full advantage of the wide-band, dual-mode capability of +_WSJT-X_ requires a receiver bandwidth of at least 4 kHz, but these +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 +be using data like this. For best viewing, adjust *Bins/Pixel* and the +width of the Wide Graph so that only the active part of the spectrum +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. -The signals in this file are all JT9 signals. To decode them in -JT9+JT65 mode you’ll need to move the JT65 nnnn JT9 delimiter down to -1000 Hz or less. +The signals in this file are all JT9 signals. To decode them +automatically in JT9+JT65 mode you’ll need to move the *JT65 nnnn JT9* +delimiter down to 1000 Hz or less. .Start, Zero, and Gain -Now is a good time to experiment with the *Start*, *Zero*, and -*Gain* parameters. *Start* sets the starting frequency at the left + +Now is a good time to experiment with the *Start*, *Zero*, and *Gain* +parameters. *Start* determines the frequency displayed at the left side of the waterfall scale. *Zero* sets the baseline level for colors, and *Gain* sets the sensitivity for color changes. For the -receiver setup of this file good values are *Zero*=0, *Gain*=0. -Re-open the wave file after each change, to see the new results. +receiver setup of this file good values are close to *Zero*=0, +*Gain*=0. Re-open the wave file after each change, to see the new +results. diff --git a/doc/source/tutorial-main-window.adoc b/doc/source/tutorial-main-window.adoc index 0e6ef0712..51b91b32c 100644 --- a/doc/source/tutorial-main-window.adoc +++ b/doc/source/tutorial-main-window.adoc @@ -1,5 +1,5 @@ // 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 Tx and Rx frequencies to 1224 Hz. +- Set the audio frequencies to *Tx 1224 Hz* and Rx 1224 Hz*. //Maybe show small screen shots here? diff --git a/doc/source/tutorial-wide-graph-settings.adoc b/doc/source/tutorial-wide-graph-settings.adoc index e1e2d51e7..82158c2bf 100644 --- a/doc/source/tutorial-wide-graph-settings.adoc +++ b/doc/source/tutorial-wide-graph-settings.adoc @@ -1,10 +1,13 @@ // Status=review - *Bins/Pixel* = 4 +- *JT65 2500 JT9* +- *Start* = 0 - *N Avg* = 5 -- *Gain* = 0, - *Zero* = –10 +- *Gain* = 0, +- *Palette* = Digipan - *Flatten* = checked - Select *Cumulative* for data display. -- Select *Tab 2* (below the *Erase* button on the main window) to +- Select *Tab 2* (below the *Decode* button on the main window) to choose the alternative set of controls for generating and selecting Tx messages. diff --git a/doc/source/wsjtx-main.adoc b/doc/source/wsjtx-main.adoc index 342af6e49..43e10d2a2 100644 --- a/doc/source/wsjtx-main.adoc +++ b/doc/source/wsjtx-main.adoc @@ -27,6 +27,8 @@ :osx-109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[OS X 10.9] :pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] :jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX] +: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 @@ -35,6 +37,8 @@ // == is level (2), section 1.0, === would mean section 1.1, === would // be section 1.1.1. This method is used throughout the document. + +<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< [[X1]] == Introduction include::introduction.adoc[] diff --git a/mainwindow.cpp b/mainwindow.cpp index 5d81308d0..c871eec4e 100644 --- a/mainwindow.cpp +++ b/mainwindow.cpp @@ -1,4 +1,4 @@ -//----------------------------------------------------------- MainWindow +//---------------------------------------------------------- MainWindow #include "mainwindow.h" #include "ui_mainwindow.h"