From 2b895d4cf2d96ad2b33fb91792c692c09fd5a21d Mon Sep 17 00:00:00 2001 From: Daniele Forsi Date: Mon, 29 Apr 2024 01:17:07 +0200 Subject: [PATCH 1/3] Fix description --- plugins/channeltx/modam/readme.md | 2 +- plugins/channeltx/modfreedv/readme.md | 2 +- plugins/channeltx/modnfm/readme.md | 2 +- plugins/channeltx/modssb/readme.md | 2 +- plugins/channeltx/modwfm/readme.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/plugins/channeltx/modam/readme.md b/plugins/channeltx/modam/readme.md index 930792f2c..873600992 100644 --- a/plugins/channeltx/modam/readme.md +++ b/plugins/channeltx/modam/readme.md @@ -129,7 +129,7 @@ Click on the button and while selected type a character or character and modifie 12a.5: 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 `.`) +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 minus sign `-`)

13: Audio file path

diff --git a/plugins/channeltx/modfreedv/readme.md b/plugins/channeltx/modfreedv/readme.md index bb6092816..d6aa4ebf7 100644 --- a/plugins/channeltx/modfreedv/readme.md +++ b/plugins/channeltx/modfreedv/readme.md @@ -138,7 +138,7 @@ Click on the button and while selected type a character or character and modifie 10a.5: 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 `.`) +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 minus sign `-`)

11: Audio file path

diff --git a/plugins/channeltx/modnfm/readme.md b/plugins/channeltx/modnfm/readme.md index 4da22bc42..88e320afc 100644 --- a/plugins/channeltx/modnfm/readme.md +++ b/plugins/channeltx/modnfm/readme.md @@ -227,7 +227,7 @@ Click on the button and while selected type a character or character and modifie 17a.5: 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 `.`) +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 minus sign `-`)

19: Audio file path

diff --git a/plugins/channeltx/modssb/readme.md b/plugins/channeltx/modssb/readme.md index e032187e8..4724ca578 100644 --- a/plugins/channeltx/modssb/readme.md +++ b/plugins/channeltx/modssb/readme.md @@ -218,7 +218,7 @@ Click on the button and while selected type a character or character and modifie 16b.5: 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 `.`) +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 minus sign `-`)

17: Audio file path

diff --git a/plugins/channeltx/modwfm/readme.md b/plugins/channeltx/modwfm/readme.md index 92e675b7b..e28bc0326 100644 --- a/plugins/channeltx/modwfm/readme.md +++ b/plugins/channeltx/modwfm/readme.md @@ -133,7 +133,7 @@ Click on the button and while selected type a character or character and modifie 13b.5: 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 `.`) +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 minus sign `-`)

14: Audio file path

From b1643ee9b57bb4878d51d68a6746e3305c0d82f9 Mon Sep 17 00:00:00 2001 From: Daniele Forsi Date: Mon, 29 Apr 2024 13:58:37 +0200 Subject: [PATCH 2/3] Fix typos --- plugins/channelmimo/doa2/readme.md | 2 +- plugins/channelrx/chanalyzer/readme.md | 2 +- plugins/channelrx/demoddsd/readme.md | 2 +- plugins/channelrx/demodft8/readme.md | 2 +- plugins/channelrx/demodm17/readme.md | 2 +- plugins/channelrx/demodradiosonde/readme.md | 2 +- plugins/channelrx/sigmffilesink/readme.md | 2 +- plugins/channeltx/modatv/readme.md | 4 ++-- plugins/feature/remotecontrol/readme.md | 4 ++-- plugins/samplesource/aaroniartsainput/readme.md | 4 ++-- plugins/samplesource/audioinput/readme.md | 2 +- plugins/samplesource/kiwisdr/readme.md | 2 +- plugins/samplesource/sdrplayv3/readme.md | 2 +- scriptsapi/Readme.md | 2 +- sdrgui/deviceuserargs.md | 2 +- sdrgui/gui/spectrum.md | 2 +- sdrgui/gui/spectrummarkers.md | 2 +- 17 files changed, 20 insertions(+), 20 deletions(-) diff --git a/plugins/channelmimo/doa2/readme.md b/plugins/channelmimo/doa2/readme.md index dfb736ab9..77061e5f0 100644 --- a/plugins/channelmimo/doa2/readme.md +++ b/plugins/channelmimo/doa2/readme.md @@ -94,7 +94,7 @@ The slider moves the channel center frequency roughly from the lower to the high

A.8. Center filter in passband

-Use this button to center the filter in the middle of the passband automatically. This sets all filters to center i.e CCC... +Use this button to center the filter in the middle of the passband automatically. This sets all filters to center i.e. CCC... The resulting filter chain sequence is represented in (A.3) diff --git a/plugins/channelrx/chanalyzer/readme.md b/plugins/channelrx/chanalyzer/readme.md index 51772af2a..88f610d2b 100644 --- a/plugins/channelrx/chanalyzer/readme.md +++ b/plugins/channelrx/chanalyzer/readme.md @@ -216,7 +216,7 @@ This slider lets you move the start of traces on display. Each step moves the tr

12. Trace length

-This slider lets you control the full length of the trace. Each step increases the corresponding amount of samples by 4800 samples with a minimum of 4800 samples and a maximum of 20*4800 = 96000 samples. The duration of a full trace appears on the left of the slider and he corresponding number of samples appears as a tooltip. +This slider lets you control the full length of the trace. Each step increases the corresponding amount of samples by 4800 samples with a minimum of 4800 samples and a maximum of 20*4800 = 96000 samples. The duration of a full trace appears on the left of the slider and the corresponding number of samples appears as a tooltip.

13. Trace sample rate

diff --git a/plugins/channelrx/demoddsd/readme.md b/plugins/channelrx/demoddsd/readme.md index ff1868efc..fd01604a4 100644 --- a/plugins/channelrx/demoddsd/readme.md +++ b/plugins/channelrx/demoddsd/readme.md @@ -554,7 +554,7 @@ This button tunes the stroke of the points displayed on B.1. The trace has limit

B.16: Trace decay

-This button tunes the persistence decay of the points displayed on B.1. The trace has limited persistence based on alpha blending. This controls the alpha value of the black screen printed at the end of each trace and thus the trace points decay time. The value is 255 minus he displayed value using 8 bit unsigned integers. +This button tunes the persistence decay of the points displayed on B.1. The trace has limited persistence based on alpha blending. This controls the alpha value of the black screen printed at the end of each trace and thus the trace points decay time. The value is 255 minus the displayed value using 8 bit unsigned integers. - A value of 0 yields no persistence - A value of 255 yields infinite persistence diff --git a/plugins/channelrx/demodft8/readme.md b/plugins/channelrx/demodft8/readme.md index 983298064..ddc6b8977 100644 --- a/plugins/channelrx/demodft8/readme.md +++ b/plugins/channelrx/demodft8/readme.md @@ -95,7 +95,7 @@ This is the volume of the audio signal in dB from -10 (0.1) to 40 (10000). It ca This shows the level of the signal entering the FT8 demodulator and decoder and peaks (shown by the tiny red vertical bar) should never exceed 100%. In fact there is a 10% guard so 100% is actually 90% of the signal volume. Note that the decoder will work well even with a few % volume however you should try to set the volume (A.10) so that big signals reach at least ~20% to have the best dynamic range. -Because this volume is based on he RF signal strength it can vary in large proportions and will be more stable if AGC (A.7) is engaged. +Because this volume is based on the RF signal strength it can vary in large proportions and will be more stable if AGC (A.7) is engaged.

B: Demodulator baseband spectrum

diff --git a/plugins/channelrx/demodm17/readme.md b/plugins/channelrx/demodm17/readme.md index dda181751..8af7c2fb4 100644 --- a/plugins/channelrx/demodm17/readme.md +++ b/plugins/channelrx/demodm17/readme.md @@ -209,7 +209,7 @@ This button tunes the stroke of the points displayed on C1.1. The trace has limi

C1.8.4: Trace decay

-This button tunes the persistence decay of the points displayed on C1.1.1. The trace has limited persistence based on alpha blending. This controls the alpha value of the black screen printed at the end of each trace and thus the trace points decay time. The value is 255 minus he displayed value using 8 bit unsigned integers. +This button tunes the persistence decay of the points displayed on C1.1.1. The trace has limited persistence based on alpha blending. This controls the alpha value of the black screen printed at the end of each trace and thus the trace points decay time. The value is 255 minus the displayed value using 8 bit unsigned integers. - A value of 0 yields no persistence - A value of 255 yields infinite persistence diff --git a/plugins/channelrx/demodradiosonde/readme.md b/plugins/channelrx/demodradiosonde/readme.md index 482f1f6d2..8fab4e4b4 100644 --- a/plugins/channelrx/demodradiosonde/readme.md +++ b/plugins/channelrx/demodradiosonde/readme.md @@ -4,7 +4,7 @@ This plugin can be used to demodulate RS41 radiosonde weather balloon signals. Radiosondes typically transmit on 400-406MHz and are in the sky around the world for around 1 hour around 00:00 UTC. -RS41 radiosondes transmit data frames every second, containing position, velocity and PTU (Pressure, Temperature and Humidity) readings. The radios use GFSK modulation, with �2.4kHz deviation at 4,800 baud. Reed Solomon encoding is used for ECC (Error Checking and Correction). +RS41 radiosondes transmit data frames every second, containing position, velocity and PTU (Pressure, Temperature and Humidity) readings. The radios use GFSK modulation, with ±2.4kHz deviation at 4,800 baud. Reed Solomon encoding is used for ECC (Error Checking and Correction). The Radiosonde demodulator can forward received data to the [Radiosonde feature](../../feature/radiosonde/readme.md), which can plot charts showing how altitude and PTU vary over time, and also plot the position of the radiosonde on the 2D and 3D maps. diff --git a/plugins/channelrx/sigmffilesink/readme.md b/plugins/channelrx/sigmffilesink/readme.md index dcf5299d6..4bcf64b3a 100644 --- a/plugins/channelrx/sigmffilesink/readme.md +++ b/plugins/channelrx/sigmffilesink/readme.md @@ -35,7 +35,7 @@ Use this control to decimate the baseband samples by a power of two. Consequentl

3: Number of sample bits

-Recording number of bits for an I or Q sample. Can be 8, 16 or 32 resulting in ci8_le, ci16_le or ci32_le file format respectively. 32 bit samples are actually coded as 24 bits i.e the 8 most significant bits are zero. +Recording number of bits for an I or Q sample. Can be 8, 16 or 32 resulting in ci8_le, ci16_le or ci32_le file format respectively. 32 bit samples are actually coded as 24 bits i.e. the 8 most significant bits are zero. This recording format is defined for the whole file you cannot have different formats per capture. diff --git a/plugins/channeltx/modatv/readme.md b/plugins/channeltx/modatv/readme.md index cd0e89127..1b7cc639d 100644 --- a/plugins/channeltx/modatv/readme.md +++ b/plugins/channeltx/modatv/readme.md @@ -75,7 +75,7 @@ The video signal can modulate the carrier in the following modes:

A.2: FM deviation percentage of total bandwidth

-Use this button to control FM deviation in FM modulation mode. This is a percentage of total available channel bandwidth. e.g for the sample rate of 2997 kS/s of the screenshot and a percentage of 19% this yields a full deviation of 2997 × 0.19 = 569.43 kHz that is ±284.715 kHz +Use this button to control FM deviation in FM modulation mode. This is a percentage of total available channel bandwidth. e.g. for the sample rate of 2997 kS/s of the screenshot and a percentage of 19% this yields a full deviation of 2997 × 0.19 = 569.43 kHz that is ±284.715 kHz ☞ You can adjust this value and see the result for yourself. A good starting point is half of the signal bandwidth. @@ -124,7 +124,7 @@ This controls the frame synchronization scheme and number of black lines: - PAL625: this is the PAL 625 lines standard with 25 FPS. Since only black and white (luminance) is supported this corresponds to any of the B,G,I or L PAL standards - PAL525: this is the PAL 525 lines standard with 30 FPS. This corresponds to the PAL M standard. - 819L: this is the 819 lines system F (Belgium). - - ShI: this is an experimental mode that uses the least possible vertical sync lines as possible. That is one line for a long synchronization pulse and one line equalizing (short) pulses level to reset the vertical sync condition. Thus only 2 lines are consumed for vertical sync and the rest is left to the image. In this mode the frames are interleaved. In this mode the frames are interleaved and an odd number of lines should be used. + - ShI: this is an experimental mode that uses the least possible vertical sync lines as possible. That is one line for a long synchronization pulse and one line equalizing (short) pulses level to reset the vertical sync condition. Thus only 2 lines are consumed for vertical sync and the rest is left to the image. In this mode the frames are interleaved and an odd number of lines should be used. - ShNI: this is the same as above but with non interleaved frames. - HSkip: this is the horizontal sync skip technique for vertical synchronization. This has been in use in the first TV experiments with a small number of lines. This method just skips one horizontal synchronization pulse to mark the last or the first line (here it is the last). This method does not use any full line for vertical sync and all lines can be used for the image thus it suits the modes with a small number of lines. With more lines however the risk of missing pulses gets higher in adverse conditions because the pulses get shorter and may get swallowed by a stray pulse or a stray pulse can be taken for a valid one. In this case two images might get out of sync instead of just two lines. In practice this is suitable up to 90~120 lines. diff --git a/plugins/feature/remotecontrol/readme.md b/plugins/feature/remotecontrol/readme.md index 0cbf75ec2..6c668b5f3 100644 --- a/plugins/feature/remotecontrol/readme.md +++ b/plugins/feature/remotecontrol/readme.md @@ -141,7 +141,7 @@ The VISA Control Dialog allows the specification of a control for a VISA device. * String - For a text string. * List - For a list of text strings, selectable from a ComboBox in the GUI. * Button - For a button that executes a specific command, but does not have any state to be displayed. E.g. for a Reset button that executes *RST. -* Units - The units of the control, if applicable. E.g V or Volts for a voltage control. This field is used as the default value for the Right Label in the GUI. +* Units - The units of the control, if applicable. E.g. V or Volts for a voltage control. This field is used as the default value for the Right Label in the GUI. * Set state - SCPI commands that set the state in the device. The value of the control in the GUI can be substituted in to the command by using %d for boolean and integer, %f for float and %s for strings. * Get state - SCPI commands that get the state in the device. This is used to update the control in the GUI. If multiple queries are specified, the value is taken from the last response. @@ -157,5 +157,5 @@ The VISA Sensor Dialog allows the specification of a sensor for a VISA device. B * Boolean - For on/off, true/false and 1/0 values. * Float - For real numbers. * String - For text strings. -* Units - The units of the sensor, if applicable. E.g A or Amps for a current sensor. This field is used as the default value for the Right Label in the GUI and also for the Chart Y-axis label. +* Units - The units of the sensor, if applicable. E.g. A or Amps for a current sensor. This field is used as the default value for the Right Label in the GUI and also for the Chart Y-axis label. * Get state - SCPI commands that get the state of the sensor from the device. diff --git a/plugins/samplesource/aaroniartsainput/readme.md b/plugins/samplesource/aaroniartsainput/readme.md index c40124c3c..f5c5826e0 100644 --- a/plugins/samplesource/aaroniartsainput/readme.md +++ b/plugins/samplesource/aaroniartsainput/readme.md @@ -28,7 +28,7 @@ The top and bottom bars of the device window are described [here](../../../sdrgu

1: Start/Stop

-This button is used to start the "device" i.e connect to the remote and start stream or stop the "device" i.e. stop stream and disconnect from the remote. The button shows the following faces: +This button is used to start the "device" i.e. connect to the remote and start stream or stop the "device" i.e. stop stream and disconnect from the remote. The button shows the following faces: - Blue triangle icon: device is ready and can be started - Green square icon: device is running and can be stopped @@ -39,7 +39,7 @@ This is the stream sample rate in S/s with multiplier. It should be equal to wha

3: Frequency

-This is the center frequency received in he stream meta data. When setting it, it will try to set the center frequency of the `IQ Demodulator` in RTSA suite the closest to the `HTTP server`. +This is the center frequency received in the stream meta data. When setting it, it will try to set the center frequency of the `IQ Demodulator` in RTSA suite the closest to the `HTTP server`.

4: Stream sample rate

diff --git a/plugins/samplesource/audioinput/readme.md b/plugins/samplesource/audioinput/readme.md index 5fec694b6..8607abdf4 100644 --- a/plugins/samplesource/audioinput/readme.md +++ b/plugins/samplesource/audioinput/readme.md @@ -58,7 +58,7 @@ A control to set the input volume. This is not supported by all input audio devi This controls how the left and right audio channels map on to the IQ channels. -* Mono L - Real samples are taken from the left audio channel and are heterodyned by the fourth of the sample rate (fs/4) to obtain complex samples. Therefore the spectrum of the complex baseband is centered at the fourth of the sample rate (fs/4). As per Nyquist rule only a bandwidth of half of the sample rate (fs/2) is available for real signals. Frequencies outside the [0, fs/2] interval are artefacts and can be eliminated by decimating by a factor of 2. +* Mono L - Real samples are taken from the left audio channel and are heterodyned by the fourth of the sample rate (fs/4) to obtain complex samples. Therefore the spectrum of the complex baseband is centered at the fourth of the sample rate (fs/4). As per Nyquist rule only a bandwidth of half of the sample rate (fs/2) is available for real signals. Frequencies outside the [0, fs/2] interval are artifacts and can be eliminated by decimating by a factor of 2. * Mono R - Same as above but takes the right audio channel for the real signal. * I=L, Q=R - The left audio channel is driven to the I channel. The right audio channel is driven to the Q channel for a complex (analytic signal)input. * I=R, Q=L - The right audio channel is driven to the I channel. The left audio channel is driven to the Q channel for a complex (analytic signal)input. diff --git a/plugins/samplesource/kiwisdr/readme.md b/plugins/samplesource/kiwisdr/readme.md index fb0ce4998..71f020d36 100644 --- a/plugins/samplesource/kiwisdr/readme.md +++ b/plugins/samplesource/kiwisdr/readme.md @@ -12,7 +12,7 @@ The top and bottom bars of the device window are described [here](../../../sdrgu

1: Start/Stop

-This button is used to start the "device" i.e connect to the remote and start stream or stop the "device" i.e. stop stream and disconnect from the remote. The button shows the following faces: +This button is used to start the "device" i.e. connect to the remote and start stream or stop the "device" i.e. stop stream and disconnect from the remote. The button shows the following faces: - Blue triangle icon: device is ready and can be started - Green square icon: device is running and can be stopped diff --git a/plugins/samplesource/sdrplayv3/readme.md b/plugins/samplesource/sdrplayv3/readme.md index 85401bfc4..524c2aa7d 100644 --- a/plugins/samplesource/sdrplayv3/readme.md +++ b/plugins/samplesource/sdrplayv3/readme.md @@ -123,7 +123,7 @@ This selects the IF frequency between these values:

17: Sample rate

-Sets the ADC IQ sample rats from 2M to 10.66M Hz. +Sets the ADC IQ sample rates from 2M to 10.66M Hz.

18: Decimation

diff --git a/scriptsapi/Readme.md b/scriptsapi/Readme.md index 6c6108e0c..81fbdf642 100644 --- a/scriptsapi/Readme.md +++ b/scriptsapi/Readme.md @@ -281,7 +281,7 @@ This file drives how channels in the connected SDRangel instance are managed. Refer to supervisord documentation. -Example of `superscanner.conf` file to put in your `/etc//etc/supervisor/conf.d/` folder (add it in the `[include]` section of `/etc/supervisor/supervisord.conf`). Environment variable `PYTHONUNBUFFERED=1` is important for the log tail to work correctly. +Example of `superscanner.conf` file to put in your `/etc/supervisor/conf.d/` folder (add it in the `[include]` section of `/etc/supervisor/supervisord.conf`). Environment variable `PYTHONUNBUFFERED=1` is important for the log tail to work correctly. ``` [program:superscanner] diff --git a/sdrgui/deviceuserargs.md b/sdrgui/deviceuserargs.md index 4d7a5df47..f7e13b19b 100644 --- a/sdrgui/deviceuserargs.md +++ b/sdrgui/deviceuserargs.md @@ -1,6 +1,6 @@

Devices user arguments management

-The user can give arguments in the form of a string related to a specific device that appears in the list of enumerated device. At the moment these arguments are related to a specific hardware and its sequence in enumeration. For example `LimeSDR,0` for the first Lime SDR, `LimeSDR,1` for the second Lime SDR ... +The user can give arguments in the form of a string related to a specific device that appears in the list of enumerated devices. At the moment these arguments are related to a specific hardware and its sequence in enumeration. For example `LimeSDR,0` for the first Lime SDR, `LimeSDR,1` for the second Lime SDR ... The corresponding plugin can make use of this user string in any way it finds useful. At present this is used only by the SoapySDR input/output plugins to override the `kwargs` (keyword arguments) at device open time (the `driver` argument is preserved as defined in the enumeration) diff --git a/sdrgui/gui/spectrum.md b/sdrgui/gui/spectrum.md index 2ba316c3b..018a2e9e8 100644 --- a/sdrgui/gui/spectrum.md +++ b/sdrgui/gui/spectrum.md @@ -282,7 +282,7 @@ This is the range of display in dB. You can select values between 1 and 100 in 1

B.5.4: FPS capping

-The refresh rate of the spectrum is capped by this value in FPS i.e the refresh period in seconds is 1 ÷ FPS. The default value is 20 and corresponds to general usage. You may use a lower value to limit GPU usage and power consumption. You may also use a higher value for an even more reactive display. "NL" corresponds to "No Limit". With "No Limit" the spectrum update will be triggered immediately when a new FFT is calculated. Note that actual refresh rate will be limited by other factors related to hardware and graphics drivers. +The refresh rate of the spectrum is capped by this value in FPS i.e. the refresh period in seconds is 1 ÷ FPS. The default value is 20 and corresponds to general usage. You may use a lower value to limit GPU usage and power consumption. You may also use a higher value for an even more reactive display. "NL" corresponds to "No Limit". With "No Limit" the spectrum update will be triggered immediately when a new FFT is calculated. Note that actual refresh rate will be limited by other factors related to hardware and graphics drivers. The refresh period is limited anyway by the FFT period which is the FFT size divided by the baseband sampling rate and multiplied by the fixed average or max size (3A.5) in case these features are engaged (3A.4). Setting a resulting FFT refresh time above the refresh rate will make sure that a short burst is not missed particularly when using the max mode. diff --git a/sdrgui/gui/spectrummarkers.md b/sdrgui/gui/spectrummarkers.md index 9f10c866b..3018ec6eb 100644 --- a/sdrgui/gui/spectrummarkers.md +++ b/sdrgui/gui/spectrummarkers.md @@ -75,7 +75,7 @@ Use this slider to adjust the power position of the marker. The units are in dB

11. Peak detection

-Activates or de-activates peak detection. With peak detection engaged markers with type "Cur" or "Max" will be automatically set to frequency (bin) of maximum power. The first marker in index order with "Cur" or "Max" will be set to the highest peak in magnitude then next marker to next peak in magnitude order etc,,, Markers of type "Cur" will track current peaks and markers of type "Max" will track peak maxima making it more suitable for transient signals. +Activates or de-activates peak detection. With peak detection engaged markers with type "Cur" or "Max" will be automatically set to frequency (bin) of maximum power. The first marker in index order with "Cur" or "Max" will be set to the highest peak in magnitude then next marker to next peak in magnitude order etc. Markers of type "Cur" will track current peaks and markers of type "Max" will track peak maxima making it more suitable for transient signals.

Waterfall markers tab

From 31dc594b468899ac1e44fe2aab7015f7c67ab76b Mon Sep 17 00:00:00 2001 From: Daniele Forsi Date: Mon, 29 Apr 2024 14:13:00 +0200 Subject: [PATCH 3/3] Fix Markdown --- plugins/channelrx/demodatv/readme.md | 2 +- plugins/channelrx/demodft8/readme.md | 2 +- plugins/channelrx/noisefigure/readme.md | 2 +- plugins/channeltx/modpsk31/readme.md | 2 +- plugins/channeltx/modrtty/readme.md | 2 +- plugins/samplesink/limesdroutput/readme.md | 6 +++--- plugins/samplesink/usrpoutput/readme.md | 2 +- plugins/samplesink/xtrxoutput/readme.md | 4 ++-- plugins/samplesource/aaroniartsainput/readme.md | 2 +- plugins/samplesource/usrpinput/readme.md | 5 +++-- sdrgui/audio.md | 2 +- swagger/docker/readme.md | 4 +++- 12 files changed, 19 insertions(+), 16 deletions(-) diff --git a/plugins/channelrx/demodatv/readme.md b/plugins/channelrx/demodatv/readme.md index db13e20b3..27b1dea5c 100644 --- a/plugins/channelrx/demodatv/readme.md +++ b/plugins/channelrx/demodatv/readme.md @@ -268,7 +268,7 @@ Use this slider to adjust the black level of the video signal on a 0 to 1V scale

12: Horizontal synchronization pulse length

-This is the length in time units of a horizontal or line synchronization pulse. The value depends on the nominal line length as described above. The pulse length is derived from the 4.7 μs pulse of a 625 lines and 25 FPS standard system with a 64 μs line length. For example with a 625 lines &#times; 12 FPS transmission that has a line length of ≈133.33 μs this is (4.7 ÷ 64) × 133.33 ≈ 9.79 μs. +This is the length in time units of a horizontal or line synchronization pulse. The value depends on the nominal line length as described above. The pulse length is derived from the 4.7 μs pulse of a 625 lines and 25 FPS standard system with a 64 μs line length. For example with a 625 lines × 12 FPS transmission that has a line length of ≈133.33 μs this is (4.7 ÷ 64) × 133.33 ≈ 9.79 μs.

C: Image

diff --git a/plugins/channelrx/demodft8/readme.md b/plugins/channelrx/demodft8/readme.md index ddc6b8977..554c87cea 100644 --- a/plugins/channelrx/demodft8/readme.md +++ b/plugins/channelrx/demodft8/readme.md @@ -167,7 +167,7 @@ The file name is constructed as follows where date is the day date in YYYYMMDD f Files will be stored in the system application data location in the `ft8/logs` folder. The application data location depends on the O/S: - - Linux: ~/.local/share/f4exb/SDRangel + - Linux: `~/.local/share/f4exb/SDRangel` - Windows: C:\Users\<your user>\AppData\Local\f4exb\SDRangel

C.9: Record baseband

diff --git a/plugins/channelrx/noisefigure/readme.md b/plugins/channelrx/noisefigure/readme.md index 9c51e20fd..115cf1026 100644 --- a/plugins/channelrx/noisefigure/readme.md +++ b/plugins/channelrx/noisefigure/readme.md @@ -4,7 +4,7 @@ This plugin can be used to calculate the noise figure (NF) of a receiver (SDR as well as optionally one or more LNAs). It uses the Y-factor method and requires a calibrated noise source. -The noise figure of a receiver is important, as it determines the noise floor: Noise floor (dBm) = 10*log10(1000kT)+NF+10*log10(BW) +The noise figure of a receiver is important, as it determines the noise floor: Noise floor (dBm) = 10\*log10(1000kT)+NF+10\*log10(BW) The noise figure will vary with frequency and gain settings. Typically, the noise figure will increase with frequency and decrease with gain. When measuring noise figure, AGC should be disabled. diff --git a/plugins/channeltx/modpsk31/readme.md b/plugins/channeltx/modpsk31/readme.md index fb0e5bd90..038e6ac05 100644 --- a/plugins/channeltx/modpsk31/readme.md +++ b/plugins/channeltx/modpsk31/readme.md @@ -74,7 +74,7 @@ Right click to open a dialog to adjust additional Transmit Settings, including t Predefined text supports the following variable substitutions: * ${callsign} - Gets replaced with the station name from Preferences > My Position -* ${location} = Gets replaced with the Maidenhead locator for the position specified under Preferences > My Position +* ${location} - Gets replaced with the Maidenhead locator for the position specified under Preferences > My Position The substitutions are applied when the Transmit Settings dialog is closed. diff --git a/plugins/channeltx/modrtty/readme.md b/plugins/channeltx/modrtty/readme.md index 2e9be4b4c..f83372bfb 100644 --- a/plugins/channeltx/modrtty/readme.md +++ b/plugins/channeltx/modrtty/readme.md @@ -111,7 +111,7 @@ Right click to open a dialog to adjust additional Transmit Settings, including t Predefined text supports the following variable substitutions: * ${callsign} - Gets replaced with the station name from Preferences > My Position -* ${location} = Gets replaced with the Maidenhead locator for the position specified under Preferences > My Position +* ${location} - Gets replaced with the Maidenhead locator for the position specified under Preferences > My Position The substitutions are applied when the Transmit Settings dialog is closed. diff --git a/plugins/samplesink/limesdroutput/readme.md b/plugins/samplesink/limesdroutput/readme.md index b52451f22..d5d4aab2f 100644 --- a/plugins/samplesink/limesdroutput/readme.md +++ b/plugins/samplesink/limesdroutput/readme.md @@ -189,9 +189,9 @@ Use this slider to adjust the global gain of the Tx chain. LimeSuite software au

15: Antenna selection

- - ** No **: no output - - ** Lo **: Tx low range 30 MHz to 1.9 GHz - - ** Hi **: Tx high range: 2 GHz and above + - **No**: no output + - **Lo**: Tx low range 30 MHz to 1.9 GHz + - **Hi**: Tx high range: 2 GHz and above

16: Stream status indicator

diff --git a/plugins/samplesink/usrpoutput/readme.md b/plugins/samplesink/usrpoutput/readme.md index 091807757..812ddcf1b 100644 --- a/plugins/samplesink/usrpoutput/readme.md +++ b/plugins/samplesink/usrpoutput/readme.md @@ -4,7 +4,7 @@ This output sample sink plugin sends its samples to a [USRP device](https://www.ettus.com/products/). -When using a USRP device over a network, you have to create a non discoverable device reference in the [user arguments dialog](https://github.com/f4exb/sdrangel/blob/master/sdrgui/deviceuserargs.md) from the main window Preferences > Devices menu. You must use the USRP hardware ID then specify the device address with an addr parameter in the user arguments for example: addr=192.168.1.10. Note that this will become effective once SDRangel is restarted. +When using a USRP device over a network, you have to create a non discoverable device reference in the [user arguments dialog](https://github.com/f4exb/sdrangel/blob/master/sdrgui/deviceuserargs.md) from the main window Preferences > Devices menu. You must use the USRP hardware ID then specify the device address with an addr parameter in the user arguments for example: `addr=192.168.1.10`. Note that this will become effective once SDRangel is restarted.

Interface

diff --git a/plugins/samplesink/xtrxoutput/readme.md b/plugins/samplesink/xtrxoutput/readme.md index 76d1e2ca0..47592349a 100644 --- a/plugins/samplesink/xtrxoutput/readme.md +++ b/plugins/samplesink/xtrxoutput/readme.md @@ -151,8 +151,8 @@ Use this slider to adjust the PAD gain of the Tx chain. With the current version

15: Antenna selection

- - ** Hi **: Tx high range - - ** Wi **: Tx wide range: you should use this one (default) + - **Hi**: Tx high range + - **Wi**: Tx wide range: you should use this one (default)

16: Stream status indicator

diff --git a/plugins/samplesource/aaroniartsainput/readme.md b/plugins/samplesource/aaroniartsainput/readme.md index f5c5826e0..e7e91dd45 100644 --- a/plugins/samplesource/aaroniartsainput/readme.md +++ b/plugins/samplesource/aaroniartsainput/readme.md @@ -43,7 +43,7 @@ This is the center frequency received in the stream meta data. When setting it,

4: Stream sample rate

-This is sample rate (actually the frequency span) received in the stream meta data. When setting it, it will try to set the sample rate and frequency span of the IQ Demodulator` in RTSA suite the closest to the `HTTP server`. +This is sample rate (actually the frequency span) received in the stream meta data. When setting it, it will try to set the sample rate and frequency span of the `IQ Demodulator` in RTSA suite the closest to the `HTTP server`.

5: Remote address and port

diff --git a/plugins/samplesource/usrpinput/readme.md b/plugins/samplesource/usrpinput/readme.md index 30479c3ec..572268f50 100644 --- a/plugins/samplesource/usrpinput/readme.md +++ b/plugins/samplesource/usrpinput/readme.md @@ -4,7 +4,7 @@ This input sample source plugin gets its samples from a [USRP device](https://www.ettus.com/product-categories/usrp-bus-series/). -When using a USRP device over a network, you have to create a non discoverable device reference in the [user arguments dialog](https://github.com/f4exb/sdrangel/blob/master/sdrgui/deviceuserargs.md) from the main window Preferences > Devices menu. You must use the USRP hardware ID then specify the device address with an addr parameter in the user arguments for example: addr=192.168.1.10. Note that this will become effective once SDRangel is restarted. +When using a USRP device over a network, you have to create a non discoverable device reference in the [user arguments dialog](https://github.com/f4exb/sdrangel/blob/master/sdrgui/deviceuserargs.md) from the main window Preferences > Devices menu. You must use the USRP hardware ID then specify the device address with an addr parameter in the user arguments for example: `addr=192.168.1.10`. Note that this will become effective once SDRangel is restarted.

Interface

@@ -140,5 +140,6 @@ The stream warning indicators are reset when the acquisition is started. On Ubuntu 20, the libuhd-dev package should be installed. The FPGA images then need to be downloaded with: +```shell sudo /usr/lib/uhd/utils/uhd_images_downloader.py - +``` diff --git a/sdrgui/audio.md b/sdrgui/audio.md index 13037abda..40f3861c1 100644 --- a/sdrgui/audio.md +++ b/sdrgui/audio.md @@ -107,7 +107,7 @@ Check this box to activate the RTP protocol over UDP. RTP parameters are as foll - Channels: 1 for mono (Left, Right and Mixed copy channels mode); 2 for stereo (Stereo copy channels mode) - Address and port: destination address and port (local on the client machine) -You may read the RTP stream using a SDP file (extension `.sdp`) that can be read with any program supporting SDP files (VLC, MX player, ffmpeg, ...). For a mono 48000 S/s stream at address `192.168.0.34:9998 and L16 codec the contents of the file would be as follows: +You may read the RTP stream using a SDP file (extension `.sdp`) that can be read with any program supporting SDP files (VLC, MX player, ffmpeg, ...). For a mono 48000 S/s stream at address `192.168.0.34:9998` and L16 codec the contents of the file would be as follows: ``` c=IN IP4 192.168.0.34 diff --git a/swagger/docker/readme.md b/swagger/docker/readme.md index 246d18dc6..3ec65185e 100644 --- a/swagger/docker/readme.md +++ b/swagger/docker/readme.md @@ -10,9 +10,11 @@ The SDRangel source tree is mounted in both containers as writable so the genera

Install Docker on Ubuntu

+```shell sudo apt install docker.io docker-buildx docker-compose sudo usermod -aG docker $USER -* reboot * +sudo reboot +```

Server