Initial Commit
This commit is contained in:
Jordan Sherer
@@ -0,0 +1,114 @@
|
||||
:doctype: manpage
|
||||
:man source: AsciiDoc
|
||||
:man version: {VERSION}
|
||||
:man manual: WSJT-X Manual
|
||||
= jt65code(1)
|
||||
|
||||
== NAME
|
||||
|
||||
jt65code, jt9code, jt4code - Weak signal communications encoding support utility.
|
||||
|
||||
== SYNOPSIS
|
||||
|
||||
*jt65code* "'MESSAGE'"
|
||||
|
||||
*jt65code* ['OPTIONS']
|
||||
|
||||
*jt9code* "'MESSAGE'"
|
||||
|
||||
*jt9code* ['OPTIONS']
|
||||
|
||||
*jt4code* "'MESSAGE'"
|
||||
|
||||
*jt4code* ['OPTIONS']
|
||||
|
||||
== OPTIONS
|
||||
*-t*::
|
||||
Prints a selection of messages alongside their corresponding
|
||||
decoded form and types.
|
||||
|
||||
== DESCRIPTION
|
||||
|
||||
*jt65code*, *jt9code* and *jt4code* are utility programs that let you
|
||||
explore the conversion of user-level messages into channel symbols or
|
||||
“tone numbers.” These programs can be useful to someone designing a
|
||||
beacon generator for JT9 or JT65, or for studying behavior of the
|
||||
error-control codes for each of the protocols.
|
||||
|
||||
Channel-symbol values for JT9 run from 0 to 8, with 0 representing the
|
||||
sync tone. The total number of symbols in a transmitted message is
|
||||
85. To run jt9code, enter the program name followed by a JT9 message
|
||||
enclosed in quotes. In Windows the command and program output might
|
||||
look like this:
|
||||
|
||||
.....
|
||||
$ jt9code "G0XYZ K1ABC FN42"
|
||||
Message: G0XYZ K1ABC FN42
|
||||
Channel symbols:
|
||||
0 0 7 3 0 3 2 5 4 0 1 7 7 7 8 0 4 8 8 2 2 1 0 1 1 3 5 4 5 6
|
||||
8 7 0 6 0 1 8 3 3 7 8 1 1 2 4 5 8 1 5 2 0 0 8 6 0 5 8 5 1 0
|
||||
5 8 7 7 2 0 4 6 6 6 7 6 0 1 8 8 5 7 2 5 1 5 0 4 0
|
||||
Decoded message: G0XYZ K1ABC FN42
|
||||
.....
|
||||
|
||||
For the corresponding program jt65code only the information-carrying
|
||||
channel symbols are shown, and the symbol values range from 0 to
|
||||
63. Sync synbols lie two tone intervals below data tone 0, and the
|
||||
sequential locations of sync symbols are described in the JT65
|
||||
Protocol section of this Guide.
|
||||
|
||||
A typical execution of jt65code is shown below. The program displays
|
||||
the packed message of 72 bits, shown here as 12 six-bit symbol values,
|
||||
followed by the channel symbols:
|
||||
|
||||
.....
|
||||
$ jt65code "G0XYZ K1ABC FN42"
|
||||
Message: G0XYZ K1ABC FN42
|
||||
Packed message, 6-bit symbols: 61 36 45 30 3 55 3 2 14 5 33 40
|
||||
Information-carrying channel symbols:
|
||||
56 40 8 40 51 47 50 34 44 53 22 53 28 31 13 60 46 2 14 58 43
|
||||
41 58 35 8 35 3 24 1 21 41 43 0 25 54 9 41 54 7 25 21 9
|
||||
62 59 7 43 31 21 57 13 59 41 17 49 19 54 21 39 33 42 18 2 60
|
||||
Decoded message: G0XYZ K1ABC FN42
|
||||
.....
|
||||
|
||||
For an illustration of the power of the strong error-control coding in
|
||||
JT9, JT65 and JT4, try looking at the channel symbols after changing a
|
||||
single character in the message. For example, change the grid locater
|
||||
from FN42 to FN43 in the JT65 message:
|
||||
|
||||
.....
|
||||
$ jt65code "G0XYZ K1ABC FN43"
|
||||
Message: G0XYZ K1ABC FN43
|
||||
Packed message, 6-bit symbols: 61 36 45 30 3 55 3 2 14 5 33 41
|
||||
Information-carrying channel symbols:
|
||||
25 35 47 8 13 9 61 40 44 9 51 6 8 40 38 34 8 2 21 23 30
|
||||
51 32 56 39 35 3 50 48 30 8 5 40 18 54 9 24 30 26 61 23 11
|
||||
3 59 7 7 39 1 25 24 4 50 17 49 52 19 34 7 4 34 61 2 61
|
||||
Decoded message: G0XYZ K1ABC FN43
|
||||
.....
|
||||
|
||||
You will discover that every possible JT65 message differs from every
|
||||
other possible JT65 message in at least 52 of the 63
|
||||
information-carrying channel symbols.
|
||||
|
||||
WSJT-X home page:: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx.html
|
||||
|
||||
WSJT-X User's Guide::
|
||||
http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjtx-main-{VERSION}.html
|
||||
|
||||
== AUTHOR
|
||||
|
||||
Joe Taylor, K1JT.
|
||||
|
||||
== COPYING
|
||||
|
||||
*jt65code*, *jt9code* and *jt4code* are Copyright (C) 2001 - 2015 by
|
||||
Joseph H. Taylor, Jr., K1JT, with contributions from additional
|
||||
authors. WSJT-X is Open Source software, licensed under the GNU
|
||||
General Public License (GPLv3).
|
||||
|
||||
These programs are distributed in the hope that they will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
@@ -0,0 +1,54 @@
|
||||
:doctype: manpage
|
||||
:man source: AsciiDoc
|
||||
:man version: {VERSION}
|
||||
:man manual: WSJT-X Manual
|
||||
= wsjtx(1)
|
||||
|
||||
== NAME
|
||||
|
||||
message_aggregator - Reference example UDP server
|
||||
|
||||
== SYNOPSIS
|
||||
|
||||
*message_aggregator*
|
||||
|
||||
== DESCRIPTION
|
||||
|
||||
*message_aggregator* does not serve any useful purpose other than to
|
||||
demonstrate the UDP message features of *WSJT-X*. It is a small GUI
|
||||
application that interacts with any running *WSJT-X* instances.
|
||||
|
||||
Developers writing add on applications may find the source code of
|
||||
message_aggregator contained in the *WSJT-X* code repository
|
||||
useful. The files NetworkMessage.hpp, MessageServer.hpp,
|
||||
MessageClient.hpp and their associated implementations along with the
|
||||
application source MessageAggregator.cpp should cover all the required
|
||||
areas. All these files can be found at:
|
||||
|
||||
https://sourceforge.net/p/wsjt/wsjt/HEAD/tree/branches/wsjtx/
|
||||
|
||||
*message_aggregator* may also be used as a multi-cast UDP server which
|
||||
allows multiple instances of *message_aggregator* to be run
|
||||
concurrently, to do this simply use a suitable multi-cast group
|
||||
address in *message_aggregator* and in *WSJT-X* in the
|
||||
"*Settings->Reporting->UDP Server*" pane e.g. 239.255.0.1 or ff03::1
|
||||
for a local scope group.
|
||||
|
||||
Note that on some systems it may be necessary to add a static
|
||||
multi-cast route to the routing table before multi-cast traffic can be
|
||||
routed to sockets on the same host as the sender.
|
||||
|
||||
== AUTHOR
|
||||
|
||||
Bill Somerville, G4WJS.
|
||||
|
||||
== COPYING
|
||||
|
||||
*message_aggregator* is Copyright (C) 2015 by William Somerville, G4WJS,
|
||||
with contributions from additional authors. *message_aggregator* is Open Source
|
||||
software, licensed under the GNU General Public License (GPLv3).
|
||||
|
||||
This program is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
@@ -0,0 +1,29 @@
|
||||
:doctype: manpage
|
||||
:man source: AsciiDoc
|
||||
:man version: {revnumber}
|
||||
:man manual: WSJT-X Manual
|
||||
= rigctl-wsjtx(1)
|
||||
|
||||
== NAME
|
||||
|
||||
rigctl-wsjtx - Hamlib 3 rigctld server.
|
||||
|
||||
== SYNOPSIS
|
||||
|
||||
*rigctl-wsjtx* [OPTIONS]
|
||||
|
||||
== DESCRIPTION
|
||||
|
||||
*wsjtx* uses a version of the *hamlib* CAT control library. This
|
||||
library is heavily modified over the current release version of
|
||||
*hamlib*. If a *wsjtx* user wishes to use the *hamlib* network rig
|
||||
server *rigctld* to remotely control their transceiver; then this
|
||||
special version of the *rigctl* client should be used since that too
|
||||
has the modified *hamlib* code embedded with it.
|
||||
|
||||
WSJT-X home page:: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx.html
|
||||
|
||||
WSJT-X User's Guide:: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjtx-main-toc2.html
|
||||
|
||||
== OPTIONS
|
||||
Refer to the *hamlib* documentation.
|
||||
@@ -0,0 +1,29 @@
|
||||
:doctype: manpage
|
||||
:man source: AsciiDoc
|
||||
:man version: {revnumber}
|
||||
:man manual: WSJT-X Manual
|
||||
= rigctld-wsjtx(1)
|
||||
|
||||
== NAME
|
||||
|
||||
rigctld-wsjtx - Hamlib 3 rigctld server.
|
||||
|
||||
== SYNOPSIS
|
||||
|
||||
*rigctld-wsjtx* [OPTIONS]
|
||||
|
||||
== DESCRIPTION
|
||||
|
||||
*wsjtx* uses a version of the *hamlib* CAT control library. This
|
||||
library is heavily modified over the current release version of
|
||||
*hamlib*. If a *wsjtx* user wishes to use the *hamlib* network rig
|
||||
server *rigctld* to remotely control their transceiver; then this
|
||||
special version of *rigctld* should be used since that too has the
|
||||
modified *hamlib* code embedded with it.
|
||||
|
||||
WSJT-X home page:: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx.html
|
||||
|
||||
WSJT-X User's Guide:: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjtx-main-toc2.html
|
||||
|
||||
== OPTIONS
|
||||
Refer to the *hamlib* documentation.
|
||||
@@ -0,0 +1,67 @@
|
||||
:doctype: manpage
|
||||
:man source: AsciiDoc
|
||||
:man version: {VERSION}
|
||||
:man manual: WSJT-X Manual
|
||||
= wsjtx(1)
|
||||
|
||||
== NAME
|
||||
|
||||
udp_daemon - Reference example UDP server
|
||||
|
||||
== SYNOPSIS
|
||||
|
||||
*udp_daemon* ['OPTIONS']
|
||||
|
||||
== DESCRIPTION
|
||||
|
||||
*udp_daemon* does not serve any useful purpose other than to
|
||||
demonstrate the UDP message features of *WSJT-X*. It is a small
|
||||
command line application that interacts with any running *WSJT-X*
|
||||
instances.
|
||||
|
||||
Developers writing add on applications may find the source code of
|
||||
*udp_daemon* contained in the *WSJT-X* code repository useful. The
|
||||
files NetworkMessage.hpp, MessageServer.hpp, MessageClient.hpp and
|
||||
their associated implementations along with the application source
|
||||
UDPDaemon.cpp should cover all the required areas. All these files can
|
||||
be found at:
|
||||
|
||||
https://sourceforge.net/p/wsjt/wsjt/HEAD/tree/branches/wsjtx/
|
||||
|
||||
*udp_daemon* may also be used as a multi-cast UDP server which allows
|
||||
multiple instances of *udp_daemon* to be run concurrently, to do this
|
||||
simply pass a suitable multi-cast group address using the command line
|
||||
option and in *WSJT-X* in the "*Settings->Reporting->UDP Server*" pane
|
||||
e.g. 239.255.0.1 or ff03::1 for a local scope group.
|
||||
|
||||
Note that on some systems it may be necessary to add a static
|
||||
multi-cast route to the routing table before multi-cast traffic can be
|
||||
routed to sockets on the same host as the sender.
|
||||
|
||||
== OPTIONS
|
||||
*-p* PORT, *--port*=PORT::
|
||||
|
||||
Optional service port number to listen on (default 2237).
|
||||
|
||||
*-g* MULTICAST-GROUP, *--group*=MULTICAST-GROUP::
|
||||
|
||||
Optional multicast group address to join (Default unicast server).
|
||||
|
||||
*-v, --version*:: Display the application version.
|
||||
|
||||
*-h,--help*:: Display usage information.
|
||||
|
||||
== AUTHOR
|
||||
|
||||
Bill Somerville, G4WJS.
|
||||
|
||||
== COPYING
|
||||
|
||||
*udp_daemon* is Copyright (C) 2015 by William Somerville, G4WJS,
|
||||
with contributions from additional authors. *udp_daemon* is Open Source
|
||||
software, licensed under the GNU General Public License (GPLv3).
|
||||
|
||||
This program is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
@@ -0,0 +1,121 @@
|
||||
:doctype: manpage
|
||||
:man source: AsciiDoc
|
||||
:man version: {VERSION}
|
||||
:man manual: WSJT-X Manual
|
||||
= wsjtx(1)
|
||||
|
||||
== NAME
|
||||
|
||||
wsjtx, jt9 - Weak signal communications program.
|
||||
|
||||
== SYNOPSIS
|
||||
|
||||
*wsjtx* ['OPTIONS']
|
||||
|
||||
== DESCRIPTION
|
||||
|
||||
*wsjtx* is a weak signal communications program supporting several operating
|
||||
modes: JT65, JT9, JT4 and WSPR (*wsjtx* version 1 supported JT9 only).
|
||||
|
||||
WSJT-X home page:: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx.html
|
||||
|
||||
WSJT-X User's Guide::
|
||||
http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjtx-main-{VERSION}.html
|
||||
|
||||
An alternative JT65 decoder executable *kvasd* for i386 Ubuntu is
|
||||
available at http://www.physics.princeton.edu/pulsar/K1JT/kvasd .
|
||||
This decoder is not open-source, is not included in the wsjtx package,
|
||||
and is not required for JT65 decoding.
|
||||
|
||||
== OPTIONS
|
||||
*-r, --rig-name*[=RIGNAME]::
|
||||
|
||||
Enable multiple instances of the wsjtx(1) application to run
|
||||
concurrently. Each RIGNAME must be unique. One instance may use no
|
||||
RIGNAME. If this option is not supplied then only one instance of
|
||||
wsjtx(1) may be run at any time.
|
||||
|
||||
*-v, --version*:: Display the application version.
|
||||
|
||||
*-h,--help*:: Display usage information.
|
||||
|
||||
*--test-mode*::
|
||||
|
||||
When this option is provided all writable files will be placed in a
|
||||
special test location (~/.qttest). This option is only for
|
||||
application testing and is not designed for normal operations. **Use
|
||||
with caution**.
|
||||
|
||||
== FILES
|
||||
|
||||
Most of the following files are in a directory path containing the
|
||||
directory name *WSJT-X[ - RIGNAME]* which indicates the value of the
|
||||
command line option *--rig-name=RIGNAME* to indicate multiple instances of
|
||||
*wsjtx* running concurrently. All writable files listed below are
|
||||
therefore unique to each concurrent instance of *wsjtx*. If the
|
||||
*--rig-name* command line option is not supplied or the *RIGNAME* argument
|
||||
is not supplied then the directory paths below will have the directory
|
||||
*WSJT-X*.
|
||||
|
||||
~/.config/WSJT-X[ - RIGNAME].ini::
|
||||
|
||||
This file stores the application
|
||||
configuration settings.
|
||||
|
||||
~/.local/share/WSJT-X[ - RIGNAME]/ALL.txt::
|
||||
|
||||
*ALL.txt* contains a record of transmitted and received messages and
|
||||
other activity such as frequency or band changes.
|
||||
|
||||
~/.local/share/WSJT-X[ - RIGNAME]/save/::
|
||||
|
||||
Is the default location for saved .WAV files recorded by the
|
||||
application. The .WAV file save location may be changed in the
|
||||
applications settings dialog.
|
||||
|
||||
~/.local/share/WSJT-X[ - RIGNAME]/save/samples/::
|
||||
|
||||
Sample .WAV files suppied with the application are found in this
|
||||
directory, they may be played back in the application and are referred
|
||||
to in the user guide tutorial sections.
|
||||
|
||||
~/.local/share/WSJT-X[ -RIGNAME]/timer.out::
|
||||
|
||||
This is a diagnostic file that records decode performance profiling
|
||||
information.
|
||||
|
||||
~/.local/share/WSJT-X[ - RIGNAME]/cty.dat::
|
||||
|
||||
This file is not required as a version of it is embedded in the
|
||||
application, but if you wish an updated version can be placed here.
|
||||
If present that version will be used in preference to the embedded
|
||||
version.
|
||||
|
||||
~/.local/share/WSJT-X[ - RIGNAME]/wsjtx.log::
|
||||
|
||||
This is a plain text CSV record of logged QSOs.
|
||||
|
||||
~/.local/share/WSJT-X[ - RIGNAME]/wsjtx_log.adi::
|
||||
|
||||
This is a record of QSOs logged in the ADIF format which is suitable
|
||||
for import into many Ham Radio logging programs.
|
||||
|
||||
== AUTHOR
|
||||
|
||||
Joe Taylor, K1JT.
|
||||
|
||||
== COPYING
|
||||
|
||||
*wsjtx* is Copyright (C) 2001 - 2015 by Joseph H. Taylor, Jr., K1JT,
|
||||
with contributions from additional authors. WSJT-X is Open Source
|
||||
software, licensed under the GNU General Public License (GPLv3).
|
||||
|
||||
*wsjtx* includes the ``**Hamlib - Ham Radio Control Libraries**''
|
||||
software which is licensed under the GNU Lesser General Public License
|
||||
(LGPL). Home page https://sourceforge.net/apps/mediawiki/hamlib,
|
||||
sources from https://sourceforge.net/p/hamlib/code/ci/master/tree/.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
@@ -0,0 +1,93 @@
|
||||
:doctype: manpage
|
||||
:man source: AsciiDoc
|
||||
:man version: {VERSION}
|
||||
:man manual: WSPRD Manual
|
||||
= wsprd(1)
|
||||
|
||||
== NAME
|
||||
|
||||
wsprd - is a decoder for K1JT's Weak Signal Propagation Reporter (WSPR) mode.
|
||||
|
||||
== SYNOPSIS
|
||||
|
||||
*wsprd* ['OPTIONS']
|
||||
|
||||
== DESCRIPTION
|
||||
|
||||
*wsprd* - The program is written in C and is a command-line program that reads
|
||||
from a .c2 file or .wav file and writes output to the console. It is used by
|
||||
WSJT-X for wspr-mode decoding.
|
||||
|
||||
|
||||
== OPTIONS
|
||||
*-a <path>*:: Path to writeable data files, default="."
|
||||
|
||||
*-c <file>*:: Write .c2 file at the end of the first pass
|
||||
|
||||
*-e x*:: x is transceiver dial frequency error in Hz
|
||||
|
||||
*-f x*:: x is transceiver dial frequency in MHz
|
||||
|
||||
*-H* :: do not use, or update the hash table
|
||||
|
||||
*-m* :: decode wspr-15 .wav file
|
||||
|
||||
*-q* :: quick mode - does not dig deep for weak signals
|
||||
|
||||
*-s* :: single pass mode, no subtraction (same as original wsprd)
|
||||
|
||||
*-v* :: verbose mode, shows duplicate decodings
|
||||
|
||||
*-w* :: wideband mode - decode signals within {plus}/- 150 Hz of center
|
||||
|
||||
*-z x*:: x is fano metric table bias, default is 0.42
|
||||
|
||||
The Infile can be either .wav or .c2, for example:
|
||||
|
||||
-----
|
||||
./wsprd -wf 14.0956 140709_2258.wav
|
||||
-----
|
||||
|
||||
*NOTE* for .c2 files, the frequency within the file overrides the command
|
||||
line value.
|
||||
|
||||
== FEATURES
|
||||
* By default, *wsprd* reports signals that are within {plus}/- 110 Hz of the
|
||||
subband center frequency. The wideband option (-w) extends this to {plus}/- 150 Hz.
|
||||
|
||||
* *wsprd* maintains a hashtable and will decode all three types of wspr
|
||||
messages. An option (-H) is available to turn off use of the hashtable.
|
||||
|
||||
* The symbols are decoded using Phil Karn's sequential decoder routine, fano.c
|
||||
|
||||
== NOTES
|
||||
. This program attempts to maximize the number of successful decodes per transmit
|
||||
interval by trying to decode virtually every peak in the averaged spectrum.
|
||||
The program also implements two-pass decoding, whereby signals that are successfully
|
||||
decoded are subtracted one-by-one during the first decoding pass. Then, the
|
||||
decoder is run again. In many cases the subtraction process will uncover signals
|
||||
that can then be successfully decoded on the second pass.
|
||||
|
||||
. There will be occasional duplicate decodes when two closely spaced
|
||||
peaks come from the same signal. The program removes dupes based on callsign
|
||||
and frequency. Two decodes that have the same callsign and estimated frequencies
|
||||
that are within 1 Hz will be treated as decodes of the same signal. This
|
||||
dupechecking is turned off with the -v flag.
|
||||
|
||||
|
||||
== AUTHORS
|
||||
|
||||
Joe Taylor, K1JT and Steven Franks, K9AN
|
||||
|
||||
|
||||
== COPYING
|
||||
|
||||
*WSPRD* is Copyright (C) 2015 by Joseph H. Taylor, Jr., K1JT,
|
||||
and Steven Franke, K9AN, with contributions from additional authors.
|
||||
*WSPRD* is Open Source software, licensed under the GNU General Public
|
||||
License (GPLv3).
|
||||
|
||||
This program is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
Reference in New Issue
Block a user