CW keyer from keyboard: updated documentation changelogs and version

CHANGELOG

@@ -1,3 +1,9 @@
+sdrangel (4.11.5-1) unstable; urgency=medium
+
+  * CW keyer from keyboard. Audio monitor AM, NFM, SSB modulators. Implements #385
+
+ -- Edouard Griffiths, F4EXB <f4exb06@gmail.com>  Tue, 30 Jul 2019 23:04:06 +0200
+
 sdrangel (4.11.4-1) unstable; urgency=medium
 
   * DATV demod: option to output transport stream to UDP. Implements #313

CMakeLists.txt

@@ -18,7 +18,7 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 # configure version
 set(sdrangel_VERSION_MAJOR "4")
 set(sdrangel_VERSION_MINOR "11")
-set(sdrangel_VERSION_PATCH "4")
+set(sdrangel_VERSION_PATCH "5")
 set(sdrangel_VERSION_SUFFIX "")
 
 # SDRAngel cmake options

debian/changelog

@@ -1,3 +1,9 @@
+sdrangel (4.11.5-1) unstable; urgency=medium
+
+  * CW keyer from keyboard. Audio monitor AM, NFM, SSB modulators. Implements #385
+
+ -- Edouard Griffiths, F4EXB <f4exb06@gmail.com>  Tue, 30 Jul 2019 23:04:06 +0200
+
 sdrangel (4.11.4-1) unstable; urgency=medium
 
   * DATV demod: option to output transport stream to UDP. Implements #313

plugins/channeltx/modam/readme.md

@@ -72,7 +72,7 @@ Clears the CW (Morse) text
 
 <h3>12: Morse keyer controls</h3>
 
-![Morse keyer control GUI](../../../doc/img/ModCWControls.png)
+![Morse keyer control GUI1](../../../doc/img/ModCWControls1.png)
 
 <h4>12.1: CW keying speed</h4>
 
@@ -82,7 +82,7 @@ Sets the CW speed in Words Per Minute (WPM). This is based on the word "PARIS" s
   - Dash: 3 dot lengths
   - Character silence separator: 3 dot lengths
   - Word silence separator: 7 dot lengths
-  
+
 <h4>12.2: Dots keying</h4>
 
 Switch this button to send dots continuously
@@ -103,6 +103,26 @@ Switch this button to auto repeat the text keying
 
 Use this button to stop sending text. When resuming keying restarts at the start of text
 
+![Morse keyer control GUI2](../../../doc/img/ModCWControls2.png)
+
+&#9888; WARNING: what follows is not really useful if you do not use a proper Morse keyer with direct audio feedback. There is a significant audio delay either with the direct monitoring or by monitoring the transmitted signal so keying with this audio as feedback is not practical
+
+12.7: Activate morse keys keyboard control
+
+This disables text or continuous dots or dashes. Toggle input from keyboard. Occasionnaly the focus may get lost and you will have to deactivate and reactivate it to recover the key bindings.
+
+12.8: Iambic or straight
+
+Choose iambic or straight keying style. When straight is selected the dot or dash key may be used.
+
+12.9: Register dot key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dots. The key or key sequence appears next (here dot `.`)
+
+12.10: Register dash key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dashes. The key or key sequence appears next (here dot `.`)
+
 <h3>13: Audio file path</h3>
 
 The path to the selected audio file to be played or dots if unselected

plugins/channeltx/modfreedv/readme.md

@@ -29,7 +29,7 @@ Use this combo box to select which FreeDV standard is used. The following are su
 
 <h3>4: Reverse left and right channels in binaural mode</h3>
 
-Effective only in binaural mode: reverses left and right audio channels so that the left is connected to Q and the right to the I complex signal channel. 
+Effective only in binaural mode: reverses left and right audio channels so that the left is connected to Q and the right to the I complex signal channel.
 
 <h3>4: VU meter selection</h3>
 
@@ -73,7 +73,7 @@ Right click to select audio input device. See [audio management documentation](.
 
 <h3>8: CW (Morse) text</h3>
 
-Enter the text to be keyed when Morse input is active and in text mode. 
+Enter the text to be keyed when Morse input is active and in text mode.
 
 <h3>9: Clear CW text</h3>
 
@@ -81,7 +81,7 @@ Clears the CW (Morse) text
 
 <h3>10: Morse keyer controls</h3>
 
-![Morse keyer control GUI](../../../doc/img/ModCWControls.png)
+![Morse keyer control GUI1](../../../doc/img/ModCWControls1.png)
 
 <h4>10.1: CW keying speed</h4>
 
@@ -91,7 +91,7 @@ Sets the CW speed in Words Per Minute (WPM). This is based on the word "PARIS" s
   - Dash: 3 dot lengths
   - Character silence separator: 3 dot lengths
   - Word silence separator: 7 dot lengths
-  
+
 <h4>10.2: Dots keying</h4>
 
 Switch this button to send dots continuously
@@ -112,6 +112,26 @@ Switch this button to auto repeat the text keying
 
 Use this button to stop sending text. When resuming keying restarts at the start of text
 
+![Morse keyer control GUI2](../../../doc/img/ModCWControls2.png)
+
+&#9888; WARNING: what follows is not really useful if you do not use a proper Morse keyer with direct audio feedback. There is a significant audio delay either with the direct monitoring or by monitoring the transmitted signal so keying with this audio as feedback is not practical
+
+10.7: Activate morse keys keyboard control
+
+This disables text or continuous dots or dashes. Toggle input from keyboard. Occasionnaly the focus may get lost and you will have to deactivate and reactivate it to recover the key bindings.
+
+10.8: Iambic or straight
+
+Choose iambic or straight keying style. When straight is selected the dot or dash key may be used.
+
+10.9: Register dot key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dots. The key or key sequence appears next (here dot `.`)
+
+10.10: Register dash key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dashes. The key or key sequence appears next (here dot `.`)
+
 <h3>11: Audio file path</h3>
 
 The path to the selected audio file to be played or dots if unselected

plugins/channeltx/modnfm/readme.md

@@ -26,7 +26,7 @@ This is the bandwidth in kHz of the channel signal filtered after modulation. It
 
 <h3>6: Audio frequency bandwidth</h3>
 
-This is the bandwidth in khz of the modulating signal filtered before modulation. It can be set in kHz steps from 1 to 20 kHz 
+This is the bandwidth in khz of the modulating signal filtered before modulation. It can be set in kHz steps from 1 to 20 kHz
 
 <h3>7: Frequency deviation</h3>
 
@@ -68,7 +68,7 @@ Right click to select audio input device. See [audio management documentation](.
 
 <h3>11: CTCSS switch</h3>
 
-Checkbox to switch on the CTCSS sub-audio tone 
+Checkbox to switch on the CTCSS sub-audio tone
 
 <h3>12: CTSS tone frequency</h3>
 
@@ -84,7 +84,7 @@ Clears the CW (Morse) text
 
 <h3>16: Morse keyer controls</h3>
 
-![Morse keyer control GUI](../../../doc/img/ModCWControls.png)
+![Morse keyer control GUI1](../../../doc/img/ModCWControls1.png)
 
 <h4>16.1: CW keying speed</h4>
 
@@ -94,7 +94,7 @@ Sets the CW speed in Words Per Minute (WPM). This is based on the word "PARIS" s
   - Dash: 3 dot lengths
   - Character silence separator: 3 dot lengths
   - Word silence separator: 7 dot lengths
-  
+
 <h4>16.2: Dots keying</h4>
 
 Switch this button to send dots continuously
@@ -115,6 +115,26 @@ Switch this button to auto repeat the text keying
 
 Use this button to stop sending text. When resuming keying restarts at the start of text
 
+![Morse keyer control GUI2](../../../doc/img/ModCWControls2.png)
+
+&#9888; WARNING: what follows is not really useful if you do not use a proper Morse keyer with direct audio feedback. There is a significant audio delay either with the direct monitoring or by monitoring the transmitted signal so keying with this audio as feedback is not practical
+
+12.7: Activate morse keys keyboard control
+
+This disables text or continuous dots or dashes. Toggle input from keyboard. Occasionnaly the focus may get lost and you will have to deactivate and reactivate it to recover the key bindings.
+
+12.8: Iambic or straight
+
+Choose iambic or straight keying style. When straight is selected the dot or dash key may be used.
+
+12.9: Register dot key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dots. The key or key sequence appears next (here dot `.`)
+
+12.10: Register dash key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dashes. The key or key sequence appears next (here dot `.`)
+
 <h3>17: Audio file path</h3>
 
 The path to the selected audio file to be played or dots if unselected

plugins/channeltx/modssb/readme.md

@@ -143,7 +143,7 @@ Clears the CW (Morse) text
 
 <h3>16: Morse keyer controls</h3>
 
-![Morse keyer control GUI](../../../doc/img/ModCWControls.png)
+![Morse keyer control GUI1](../../../doc/img/ModCWControls1.png)
 
 <h4>16.1: CW keying speed</h4>
 
@@ -174,6 +174,26 @@ Switch this button to auto repeat the text keying
 
 Use this button to stop sending text. When resuming keying restarts at the start of text
 
+![Morse keyer control GUI2](../../../doc/img/ModCWControls2.png)
+
+&#9888; WARNING: what follows is not really useful if you do not use a proper Morse keyer with direct audio feedback. There is a significant audio delay either with the direct monitoring or by monitoring the transmitted signal so keying with this audio as feedback is not practical
+
+16.7: Activate morse keys keyboard control
+
+This disables text or continuous dots or dashes. Toggle input from keyboard. Occasionnaly the focus may get lost and you will have to deactivate and reactivate it to recover the key bindings.
+
+16.8: Iambic or straight
+
+Choose iambic or straight keying style. When straight is selected the dot or dash key may be used.
+
+16.9: Register dot key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dots. The key or key sequence appears next (here dot `.`)
+
+16.10: Register dash key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dashes. The key or key sequence appears next (here dot `.`)
+
 <h3>17: Audio file path</h3>
 
 The path to the selected audio file to be played or dots if unselected

plugins/channeltx/modwfm/readme.md

@@ -26,7 +26,7 @@ This is the bandwidth in kHz of the channel signal filtered after modulation. It
 
 <h3>6: Audio frequency bandwidth</h3>
 
-This is the bandwidth in khz of the modulating signal filtered before modulation. It can be set in kHz steps from 1 to 20 kHz 
+This is the bandwidth in khz of the modulating signal filtered before modulation. It can be set in kHz steps from 1 to 20 kHz
 
 <h3>7: Frequency deviation</h3>
 
@@ -76,7 +76,7 @@ Clears the CW (Morse) text
 
 <h3>13: Morse keyer controls</h3>
 
-![Morse keyer control GUI](../../../doc/img/ModCWControls.png)
+![Morse keyer control GUI1](../../../doc/img/ModCWControls1.png)
 
 <h4>13.1: CW keying speed</h4>
 
@@ -86,7 +86,7 @@ Sets the CW speed in Words Per Minute (WPM). This is based on the word "PARIS" s
   - Dash: 3 dot lengths
   - Character silence separator: 3 dot lengths
   - Word silence separator: 7 dot lengths
-  
+
 <h4>13.2: Dots keying</h4>
 
 Switch this button to send dots continuously
@@ -107,6 +107,26 @@ Switch this button to auto repeat the text keying
 
 Use this button to stop sending text. When resuming keying restarts at the start of text
 
+![Morse keyer control GUI2](../../../doc/img/ModCWControls2.png)
+
+&#9888; WARNING: what follows is not really useful if you do not use a proper Morse keyer with direct audio feedback. There is a significant audio delay either with the direct monitoring or by monitoring the transmitted signal so keying with this audio as feedback is not practical
+
+13.7: Activate morse keys keyboard control
+
+This disables text or continuous dots or dashes. Toggle input from keyboard. Occasionnaly the focus may get lost and you will have to deactivate and reactivate it to recover the key bindings.
+
+13.8: Iambic or straight
+
+Choose iambic or straight keying style. When straight is selected the dot or dash key may be used.
+
+13.9: Register dot key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dots. The key or key sequence appears next (here dot `.`)
+
+13.10: Register dash key
+
+Click on the button and while selected type a character or character and modifier (Shift + key for example) to select which key is used for dashes. The key or key sequence appears next (here dot `.`)
+
 <h3>14: Audio file path</h3>
 
 The path to the selected audio file to be played or dots if unselected