Skip to content

Commit

Permalink
Merge pull request #444 from drowe67/ms-bandwidth-manual
Browse files Browse the repository at this point in the history 
Add recommended RF bandwidths to user manual.
  • Loading branch information
@tmiw
tmiw authored Jul 12, 2023
2 parents 2deea41 + c6555fd commit 5c16db1
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 17 deletions.
56 changes: 41 additions & 15 deletions USER_MANUAL.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,43 @@ <h2 data-number="2.5" id="audio-processing"><span class="header-section-number">
<h2 data-number="2.6" id="usb-or-lsb"><span class="header-section-number">2.6</span> USB or LSB?</h2>
<p>On bands below 10 MHz, LSB is used for FreeDV. On 10MHz and above, USB is used. After much debate, the FreeDV community has adopted the same conventions as SSB, based on the reasoning that FreeDV is a voice mode.</p>
<p>As an aid to the above, FreeDV will show the current mode on the bottom of the window upon pressing the Start button if Hamlib is enabled and your radio supports retrieving frequency and mode information over CAT. If your radio is using an unexpected mode (e.g. LSB on 20 meters), it will display that mode on the bottom of the window next to the Clear button in red letters. When a session is not active, Hamlib isn’t enabled, or if your radio doesn’t support retrieving frequency and mode over CAT, it will remain grayed out with “unk” displaying instead of the mode (for “unknown”).</p>
<h2 data-number="2.7" id="transceiver-filters"><span class="header-section-number">2.7</span> Transceiver Filters</h2>
<p>For most FreeDV use, your radio’s receive and transmit filters should be set to the widest possible (typically around 3 KHz). This allows easy switching between analog mode as well as the various FreeDV modes. Depending on your individual circumstances, narrower receive filters may help with reception of FreeDV, but there has not been any testing to definitively confirm this or under what circumatances (if any) where this would be the case. Additionally, FreeDV already performs its own transmit filtering, so using additional narrow filtering on the radio will likely have little benefit (again, untested).</p>
<p>For reference, the channel widths of the currently supported modes are below:</p>
<table>
<thead>
<tr class="header">
<th>Mode</th>
<th>Width (KHz)</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>1600</td>
<td>1.125</td>
</tr>
<tr class="even">
<td>700C</td>
<td>1.500</td>
</tr>
<tr class="odd">
<td>700D</td>
<td>1.000</td>
</tr>
<tr class="even">
<td>700E</td>
<td>1.500</td>
</tr>
<tr class="odd">
<td>2020</td>
<td>1.600</td>
</tr>
<tr class="even">
<td>2020B</td>
<td>2.100</td>
</tr>
</tbody>
</table>
<h1 data-number="3" id="voice-keyer"><span class="header-section-number">3</span> Voice Keyer</h1>
<p>The Voice Keyer Button on the front page puts FreeDV and your radio into transmit, reads a wave file of your voice to call CQ, and then switches to receive to see if anyone is replying. If you press the space bar or click the PTT button, the voice keyer stops. If a signal with a valid sync is received for a few seconds the voice keyer also stops.</p>
<p>The Audio tab inside Tools-Options can be used to select the wave file, set the Rx delay, and number of times the tx/rx cycle repeats.</p>
Expand Down Expand Up @@ -196,7 +233,6 @@ <h1 data-number="6" id="freedv-reporting"><span class="header-section-number">6<
<li><a href="https://freedv-reporter.k6aq.net/">FreeDV Reporter</a></li>
</ul>
<p>The frequency that FreeDV reports is set by changing the “Report Frequency” drop down box in the main window. This is in kilohertz (kHz) and will turn red if the entered value is invalid. If Hamlib support is also enabled, this frequency will automatically remain in sync with the current VFO on the radio (i.e. if the frequency is changed in the application, the radio will also change its frequency).</p>
<p><em>Note: in some setups (such as when using ALE), it is not preferred to have the reporting frequency automatically be in sync with the radio. For example, in the case of ALE, the radio’s frequency changes multiple times per second while waiting for a contact, which is faster than FreeDV can pull the latest from the radio (every five seconds). This can be disabled by enabling “Manual Frequency Reporting” in Tools-&gt;Options.</em></p>
<p>FreeDV will also show the callsigns of previously received signals. To view those, click on the arrow next to the last received callsign at the bottom of the window. These are in descending order by time of receipt (i.e. the most recently received callsign will appear at the top of the list).</p>
<h1 data-number="7" id="multiple-mode-support"><span class="header-section-number">7</span> Multiple Mode Support</h1>
<p>FreeDV can simultaneously decode the following modes when selected prior to pushing “Start”:</p>
Expand Down Expand Up @@ -611,38 +647,28 @@ <h2 data-number="17.1" id="v1.8.12-tbd-2023"><span class="header-section-number"
<li>Clear button now clears the callsign list. (PR #436)</li>
<li>Fix bug causing the PTT button to stay red after the voice keyer finishes TX. (PR #440)</li>
<li>Fix FreeDV Reporter crash when sending RX record. (PR #443)</li>
<li>Hamlib: set mode before frequency to avoid accidental offsetting. (PR #442, #452)</li>
<li>Fix audio dialog plot display and lockup issues. (PR #450)</li>
<li>Hamlib: set mode before frequency to avoid accidental offsetting. (PR #442)</li>
<li>Disable PTT and Voice Keyer buttons if only RX devices are configured. (PR #449)</li>
<li>Fix Linux display bugs when switching between dark and light mode. (PR #454)</li>
</ul></li>
<li>Enhancements:
<ul>
<li>Add the ability to request that another FreeDV Reporter user QSY. (PR #434, #453, #456, #458, #459, #467)</li>
<li>Display ‘Digital’ on button when Analog mode is active. (PR #447)</li>
<li>Set minimum size for Mode box to 250px. (PR #446)</li>
<li>Notify FreeDV Reporter if only capable of RX. (PR #449)</li>
<li>Hamlib: allow frequency and mode changes during TX. (PR #455)</li>
<li>Auto-size columns in Audio Options to improve readability. (PR #461)</li>
<li>Add support for modifying the drop down frequency list. (PR #460)</li>
<li>Preserve size and position of Audio Configuration dialog. (PR #466)</li>
<li>Add ability to suppress automatic frequency reporting on radio changes. (PR #469)</li>
</ul></li>
<li>Build system:
<ul>
<li>Bump Codec2 version to v1.1.1. (PR #437)</li>
<li>Generate PDF/HTML docs only on PR merge. (PR #471)</li>
</ul></li>
<li>Cleanup:
<li>Documentation
<ul>
<li>Refactor configuration handling in the codebase. (PR #457)</li>
<li>Add RF bandwidth information to user manual. (PR #444)</li>
</ul></li>
<li>Miscellaneous:
<li>Miscallenous::
<ul>
<li>Set default FreeDV Reporter hostname to qso.freedv.org. (PR #448)</li>
</ul></li>
</ol>
<p><em>Note for Windows users: you may receive a one-time error message on startup after upgrading indicating that certain Registry keys have incorrect types. This is expected as the formats of some configuration parameters have changed.</em></p>
<h2 data-number="17.2" id="v1.8.11-june-2023"><span class="header-section-number">17.2</span> V1.8.11 June 2023</h2>
<ol type="1">
<li>Bugfixes:
Expand Down
24 changes: 22 additions & 2 deletions USER_MANUAL.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,24 @@ On bands below 10 MHz, LSB is used for FreeDV. On 10MHz and above, USB is used.

As an aid to the above, FreeDV will show the current mode on the bottom of the window upon pressing the Start button if Hamlib is enabled and your radio supports retrieving frequency and mode information over CAT. If your radio is using an unexpected mode (e.g. LSB on 20 meters), it will display that mode on the bottom of the window next to the Clear button in red letters. When a session is not active, Hamlib isn't enabled, or if your radio doesn't support retrieving frequency and mode over CAT, it will remain grayed out with "unk" displaying instead of the mode (for "unknown").

## Transceiver Filters

For most FreeDV use, your radio's receive and transmit filters should be set to the widest possible (typically around 3 KHz).
This allows easy switching between analog mode as well as the various FreeDV modes. There has not been any testing done to
definitively confirm whether narrower bandwidths help with reception of FreeDV. Additionally, FreeDV already performs its own
transmit filtering, so using additional narrow filtering on the radio will likely have little benefit (again, untested).

For reference, the channel widths of the currently supported modes are below:

| Mode | Width (KHz) |
| --- | --- |
| 1600 | 1.125 |
| 700C | 1.500 |
| 700D | 1.000 |
| 700E | 1.500 |
| 2020 | 1.600 |
| 2020B | 2.100 |

# Voice Keyer

The Voice Keyer Button on the front page puts FreeDV and your radio into
Expand Down Expand Up @@ -892,9 +910,11 @@ LDPC | Low Density Parity Check Codes - a family of powerful FEC codes
3. Build system:
* Bump Codec2 version to v1.1.1. (PR #437)
* Generate PDF/HTML docs only on PR merge. (PR #471)
4. Cleanup:
4. Documentation
* Add RF bandwidth information to user manual. (PR #444)
5. Cleanup:
* Refactor configuration handling in the codebase. (PR #457)
4. Miscellaneous:
6. Miscellaneous:
* Set default FreeDV Reporter hostname to qso.freedv.org. (PR #448)

*Note for Windows users: you may receive a one-time error message on startup
Expand Down
Binary file modified USER_MANUAL.pdf
View file
Binary file not shown.

0 comments on commit 5c16db1

Please sign in to comment.