Update docs

This commit is contained in:
Jon Beniston 2023-03-03 18:00:20 +00:00
parent d9f27485c3
commit cd59307806
2 changed files with 12 additions and 12 deletions

View File

@ -1,4 +1,4 @@
<h1>Navtex demodulator plugin</h1>
<h1>Navtex Demodulator Plugin</h1>
<h2>Introduction</h2>
@ -29,7 +29,7 @@ Average total power in dB relative to a +/- 1.0 amplitude signal received in the
<h3>4: Navarea</h3>
Specifies the geographical area in which the receiver is in. This enables the plugin to decode transmitter station identifiers, and display which transmitter the current transmission timeslot is assigned to.
Specifies the geographical area in which the receiver is in. This enables the plugin to decode transmitter station identifiers, and display which transmitter the current transmission timeslot is assigned to (5).
Note that with good propagation conditions, it is possible to receive messages from another area, so the station indicated in the message table (17) should be checked against the location given in the recevied message text.
<h3>5: TX</h3>
@ -46,15 +46,15 @@ This specifies the bandwidth of a filter that is applied to the input signal to
<h3>8: UDP</h3>
When checked, received packets are forwarded to the specified UDP address (9) and port (10).
When checked, received messages are forwarded to the specified UDP address (9) and port (10).
<h3>9: UDP address</h3>
IP address of the host to forward received packets to via UDP.
IP address of the host to forward received messages to via UDP.
<h3>10: UDP port</h3>
UDP port number to forward received packets to.
UDP port number to forward received messages to.
<h3>11: Station Filter</h3>
@ -66,7 +66,7 @@ This drop down displays a list of all message types that have been received. Whe
<h3>13: Start/stop Logging Messages to .csv File</h3>
When checked, writes all received messages to a .csv file.
When checked, writes all received messages to a .csv file, specified by (14).
<h3>14: .csv Log Filename</h3>
@ -87,7 +87,7 @@ The received messages table displays the contents of the messages that have been
* Date - Date the message was received.
* Time - Time the message was received.
* SID - Station identifer of the transmitting station.
* Station - SID decoded according to the currently selected navarea.
* Station - SID decoded according to the currently selected navarea (4).
* TID - Message type identifier.
* MID - Message identifier.
* Message - The message text.

View File

@ -1,9 +1,9 @@
<h1>RTTY demodulator plugin</h1>
<h1>RTTY Demodulator Plugin</h1>
<h2>Introduction</h2>
This plugin can be used to demodulate RTTY (Radioteletype) transmissions.
RTTY using BFSK (Binary Frequency Shift Keying), where transmission of data alternates between two frequencies,
RTTY uses BFSK (Binary Frequency Shift Keying), where transmission of data alternates between two frequencies,
the mark frequency and the space frequency. The RTTY Demodulor should be centered in between these frequencies.
The baud rate, frequency shift (difference between mark and space frequencies), bandwidth and baudot character set are configurable.
@ -60,7 +60,7 @@ UDP port number to forward received characters to.
<h3>11: Squelch</h3>
Sets the squelch power. Characters received with average power lower than this setting will be discarded.
Sets the squelch power level in dB. Characters received with average power lower than this setting will be discarded.
<h3>12: Baudot Character Set</h3>
@ -79,11 +79,11 @@ Specifies whether bits are transmitted least-significant-bit first (LSB) or most
<h3>14: Mark/Space Frequency</h3>
When unchecked, the mark frequency is the higher frequency, when checked space frequency is higher.
When unchecked, the mark frequency is the higher frequency, when checked the space frequency is higher.
<h3>15: Suppress CR LF</h3>
When checked the CR CR LF sequence is just displayed as CR.
When checked the CR CR LF sequence is just displayed as CR. This can help make more received text visible in (19).
<h3>16: Unshift on Space</h3>