From d112bb4f727119bf4dc2a9638947ec7b279ee069 Mon Sep 17 00:00:00 2001 From: drowe67 Date: Mon, 10 Jul 2017 22:15:35 +0000 Subject: [PATCH] changed patch level, added soem minor bugs to README git-svn-id: https://svn.code.sf.net/p/freetel/code@3291 01035d8c-6547-0410-b346-abe4f91aad63 --- freedv-dev/CMakeLists.txt | 4 +- freedv-dev/README.txt | 117 ++++++++++++----------------------- freedv-dev/RELEASE_NOTES.txt | 7 +++ freedv-dev/USER_MANUAL.txt | 84 +++++++++++++++++++++++++ 4 files changed, 132 insertions(+), 80 deletions(-) create mode 100644 freedv-dev/RELEASE_NOTES.txt create mode 100644 freedv-dev/USER_MANUAL.txt diff --git a/freedv-dev/CMakeLists.txt b/freedv-dev/CMakeLists.txt index 24242a81..fdc1c01e 100644 --- a/freedv-dev/CMakeLists.txt +++ b/freedv-dev/CMakeLists.txt @@ -30,8 +30,8 @@ project(FreeDV) # Set FreeDV version and generate src/version.h # set(FREEDV_VERSION_MAJOR 1) -set(FREEDV_VERSION_MINOR 3) -set(FREEDV_VERSION_PATCH FALSE) +set(FREEDV_VERSION_MINOR 2) +set(FREEDV_VERSION_PATCH 2) set(FREEDV_VERSION ${FREEDV_VERSION_MAJOR}.${FREEDV_VERSION_MINOR}) if(FREEDV_VERSION_PATCH) set(FREEDV_VERSION ${FREEDV_VERSION}.${FREEDV_VERSION_PATCH}) diff --git a/freedv-dev/README.txt b/freedv-dev/README.txt index 7f240aa7..26e731d1 100644 --- a/freedv-dev/README.txt +++ b/freedv-dev/README.txt @@ -1,3 +1,14 @@ +================================== + FreeDV GUI README.txt +================================== + +This document describes how to build the FreeDV GUI program for +various operating systems. See also: + + http://freedv.org - introduction, documentation, downloads + RELEASE_NOTES.txt - changes made to each version + USER_MANUAL.txt - FreeDV GUI Manual + ================================== Building and installing on Linux ================================== @@ -191,82 +202,32 @@ configure emacs: (setq c-basic-offset 4) ))) -================= -USER GUIDE NOTES -================= - -TODO: Put this in a more usable form (maybe parse into HTML), video -tutorials etc... - -1/ Error Histogram ------------------- - -Displays BER of each carrier when in "test frame" -mode. As each QPSK carrier has 2 bits there are 2*Nc histogram -points. - -Ideally all carriers will have about the same BER (+/- 20% after 5000 -total bit errors). However problems can occur with filtering in the -tx path. If one carrier has less power, then it will have a higher -BER. The errors in this carrier will tend to dominate overall -BER. For example if one carrier is attenuated due to SSB filter ripple -in the tx path then the BER on that carrier will be higher. This is -bad news for DV. - -Suggested usage: - -i) Transmit FreeDV in test frame mode. Use a 2nd rx (or -get a friend) to monitor your rx signal with FreeDV in test frame -mode. - -ii) Adjust your rx SNR to get a BER of a few % (e.g. reduce tx -power, use a short antenna for the rx, point your beam away, adjust rx -RF gain). - -iii) Monitor the error histogram for a few minutes, until you -have say 5000 total bit errors. You have a problem if the BER of any -carrier is more than 20% different from the rest. - -A typical issue will be one carrier at 1.0, the others at 0.5, -indicating the poorer carrier BER is twice the larger. - -2/ Voice Keyer --------------- - -Puts FreeDV and your radio into transmit, reads a wave -file of your voice to call CQ, then switches to receive to see if -anyone is replying. If you press space bar the voice keyer stops. If -a signal with a valid sync is received for a few seconds the voice -keyer stops. The Tools-PTT dialog can be used to select the wave -file, set the Rx delay, and number of times the tx/rx cycle repeats. - -3/ UDP Control port -------------------- - -FreeDV can be controlled via UDP from other programs on the same host -(127.0.0.1) using text strings. The default port is 3000, and can be -set Via Tools-Options. - -Currents commands: - - "set txtmsg XXX" - sets the text/callsign ID string to XXX - "restore" - Restores the FreeDV windowto full size if minimised - "ptton" - PTT on (transmit) - "pttoff" - PTT off (receive) - -Hint: "netcat" can be used to test this feature. - -4/ Full Duplex Testing with loopback ------------------------------------- - -FreeDV GUI can operate in full duplex mode which is useful for -development as only one PC is required. Tx and Rx signals can be -looped back via an analog connection between the sound cards, or (on -Linux) using the Alsa loopback module: - -$ sudo modprobe snd-aloop -$ ./freedv - -In Tools - Audio Config - Receive Tab - From Radio select -> Loopback: Loopback PCM (hw:1,0) - - Transmit Tab - To Radio select -> Loopback: Loopback PCM (hw:1,1) +FreeDV GUI TODO List +-------------------- + +[ ] Ubuntu packaging +[ ] default sound card in/out setting for rx out of the box +[ ] When application close on windows while "Start" down sometimes crashes + + Also on Linux it reports an unterminated thread when exiting +[ ] Tool-Audio Config Dialog sound device names truncated on Windows +[ ] Serialport::closeport() on Linux takes about 1 second + + delays 'Stop' on main window test on Tools-PTT Test +[ ] Voice keyer file name at bottom on main screen truncated + + need a bigger field +[ ] Start/Stop file rec/playback, work out a better UI, + maybe buttons on front page +[ ] feature for evaluating yr own sound quality + + trap bad mic response/levels + + zero in on different sound quality from different users +[ ] feeding audio over UDP say from from gqrx + + could also be used to netcat stored files +[ ] refactoring + [ ] fdmdv2_main.cpp is way too long + [ ] rename fdmdv2*.cpp -> freedv*.cpp + [ ] dlg_ptt uses ComPortsDlg name internally, rename PttDlg or similar +[ ] Add RSID + + use case, when would it be used? +[ ] clean up dialogs + + were based on auto generation code + + must be an easier/clearer way to write them diff --git a/freedv-dev/RELEASE_NOTES.txt b/freedv-dev/RELEASE_NOTES.txt new file mode 100644 index 00000000..79eaeca0 --- /dev/null +++ b/freedv-dev/RELEASE_NOTES.txt @@ -0,0 +1,7 @@ +V1.2.2 July 2017 +---------------- + +1/ Improvements to Hamlib support, error message reporting, serial rate box. + +2/ Disabled unused UDP comms/egexp processing to clean up Options dialog. + diff --git a/freedv-dev/USER_MANUAL.txt b/freedv-dev/USER_MANUAL.txt new file mode 100644 index 00000000..10cf4725 --- /dev/null +++ b/freedv-dev/USER_MANUAL.txt @@ -0,0 +1,84 @@ +====================== +FREEDV GUI USER MANUAL +====================== + + +Voice Keyer +----------- + +Voice Keyer Button on Front Page +Options-PTT Dialog + +Puts FreeDV and your radio into transmit, reads a wave file of your +voice to call CQ, then switches to receive to see if anyone is +replying. If you press space bar the voice keyer stops. If a signal +with a valid sync is received for a few seconds the voice keyer stops. + +Options-PTT dialog can be used to select the wave file, set the Rx +delay, and number of times the tx/rx cycle repeats. + +The wave file for the voice keyer should be in 8kHz mono 16 bit sample +form. Use a free application such as Audacity to convert a file you +have recorded to this format. + +Test Frame Histogram +-------------------- + +Test Frame Histogram tab on Front Page + +Displays BER of each carrier when in "test frame" mode. As each QPSK +carrier has 2 bits there are 2*Nc histogram points. + +Ideally all carriers will have about the same BER (+/- 20% after 5000 +total bit errors). However problems can occur with filtering in the +tx path. If one carrier has less power, then it will have a higher +BER. The errors in this carrier will tend to dominate overall +BER. For example if one carrier is attenuated due to SSB filter ripple +in the tx path then the BER on that carrier will be higher. This is +bad news for DV. + +Suggested usage: + +i) Transmit FreeDV in test frame mode. Use a 2nd rx (or +get a friend) to monitor your rx signal with FreeDV in test frame +mode. + +ii) Adjust your rx SNR to get a BER of a few % (e.g. reduce tx +power, use a short antenna for the rx, point your beam away, adjust rx +RF gain). + +iii) Monitor the error histogram for a few minutes, until you +have say 5000 total bit errors. You have a problem if the BER of any +carrier is more than 20% different from the rest. + +A typical issue will be one carrier at 1.0, the others at 0.5, +indicating the poorer carrier BER is twice the larger. + +Full Duplex Testing with loopback +--------------------------------- + +Options - Half Duplex check box + +FreeDV GUI can operate in full duplex mode which is useful for +development of listening to your own FreeDV signal as only one PC is +required. Normal operation is half duplex. + +Tx and Rx signals can be looped back via an analog connection between +the sound cards. + +On Linux, using the Alsa loopback module: + + $ sudo modprobe snd-aloop + $ ./freedv + + In Tools - Audio Config - Receive Tab - From Radio select -> Loopback: Loopback PCM (hw:1,0) + - Transmit Tab - To Radio select -> Loopback: Loopback PCM (hw:1,1) + +TODO +---- + +[ ] Put this in a more usable form (maybe render into HTML) + +[ ] complete manual, at this stage just more obscure features + documented here, integrate with other on-line documentation + sources -- 2.25.1