mirror of
https://github.com/f4exb/sdrangel.git
synced 2024-11-25 01:18:38 -05:00
Fix spelling
Fixed with: find . -name '*.md' -exec codespell --ignore-words-list=cach,doas,ehr,inout,lits,nd,verry --summary --write-changes {} \+ and then running the same command with --interactive=2: find . -name '*.md' -exec codespell --ignore-words-list=cach,doas,ehr,inout,lits,nd,verry --summary --write-changes --interactive=2 {} \+
This commit is contained in:
parent
f5b91fff53
commit
812f2ee452
@ -130,7 +130,7 @@ The compass needle shows the antennas direction with the white arrow towards ant
|
||||
|
||||
<h4>C.1.4 Blind sector</h4>
|
||||
|
||||
The darker area on the compass background shows the sector where no readings can be made when the distance between the two antennas (baseline distance set in C.6) is larger than the half of the wavelength displayed in (C.5). Check the principle of operation section at the ned of the document for details.
|
||||
The darker area on the compass background shows the sector where no readings can be made when the distance between the two antennas (baseline distance set in C.6) is larger than the half of the wavelength displayed in (C.5). Check the principle of operation section at the end of the document for details.
|
||||
|
||||
<h3>C.2 Positive DOA angle (Port side)</h3>
|
||||
|
||||
@ -158,7 +158,7 @@ This is the threshold of squared magnitude in dB above which DOA processing take
|
||||
|
||||
![DOA2 XY display](../../../doc/img/DOA2_plugin_xy.png)
|
||||
|
||||
In this exaple setting a squelch value of -55~-50 dB will select the narrow peak corresponding to samples giving the most accurate DOA measurements.
|
||||
In this example setting a squelch value of -55~-50 dB will select the narrow peak corresponding to samples giving the most accurate DOA measurements.
|
||||
|
||||
This threshold can also be used with transient signals to activate DOA processing only when the signal is present effectively acting like a squelch in FM modes.
|
||||
|
||||
@ -168,7 +168,7 @@ This is the number of FFT series used for DOA calculation thus the weighting ave
|
||||
|
||||
<h2>Principle of operation</h2>
|
||||
|
||||
DOA estimation is based on the "FFT" correlation funtion and active only when selected with (A.2). FFT analysis helps in removing non essential contributions and is more efficient than simple product wutn conjugate (A.B*).
|
||||
DOA estimation is based on the "FFT" correlation function and active only when selected with (A.2). FFT analysis helps in removing non essential contributions and is more efficient than simple product wutn conjugate (A.B*).
|
||||
|
||||
It assumes that channel A is connected to antenna 1 or antenna of reference (device stream 0) and channel B is connected antenna 2 the second antenna (device stream 1) in the following configuration:
|
||||
|
||||
@ -204,7 +204,7 @@ In general the angle can be calculated from the baseline distance D (distance be
|
||||
φ = π D cos(θ) / (λ/2) ⇒
|
||||
cos(θ) = (φ / π) . ((λ/2) / D)
|
||||
|
||||
If D is larger than λ/2 the possible values of cos(θ) do not cover the whole [-1:1] interval and thus there is a blind sector at the front of antenna 2 and the back of antenna 1 which is shown onthe compass as a darker area (C.1.4). However signals coming from this blind sector will fold into the valid sector. Putting antennas further apart than λ/2 can give more accurate measurements inside the valid sector at the condition you already validated the assunption that the incoming wave angle is insde the valid sector and that no significant signal from the blind sector can influence the masurement. One can imagine having a pair of directive antennas placed at a distance for which the valid sector matches the antenna system lobe for final accurate measurement.
|
||||
If D is larger than λ/2 the possible values of cos(θ) do not cover the whole [-1:1] interval and thus there is a blind sector at the front of antenna 2 and the back of antenna 1 which is shown on the compass as a darker area (C.1.4). However signals coming from this blind sector will fold into the valid sector. Putting antennas further apart than λ/2 can give more accurate measurements inside the valid sector at the condition you already validated the assunption that the incoming wave angle is inside the valid sector and that no significant signal from the blind sector can influence the masurement. One can imagine having a pair of directive antennas placed at a distance for which the valid sector matches the antenna system lobe for final accurate measurement.
|
||||
|
||||
If D is smaller than λ/2 extreme incoming angles (0 or π) yield smaller φ which will be compensated by the (λ/2) / D factor however with less accuracy.
|
||||
|
||||
|
@ -275,11 +275,11 @@ The table displays the decoded ADS-B and Mode-S data for each aircraft along sid
|
||||
* L Mode - Lateral navigation mode. This may be LNAV (Lateral navigation) or APP (Approach). (ADS-B)
|
||||
* Baro - Baro setting in mb. (ADS-B / Mode-S)
|
||||
* H Wnd - Headwind in knots or kilometers per hour. Negative values indicate a tailwind. (Derived from Mode-S)
|
||||
* OAT - Outside air temperature in degrees Celsuis, estimated from Mach and TAS. (Derived from Mode-S)
|
||||
* OAT - Outside air temperature in degrees Celsius, estimated from Mach and TAS. (Derived from Mode-S)
|
||||
* Wnd - Wind speed in knots or kilometers per hour. (Mode-S)
|
||||
* Wnd - Wind direction in degrees. (Mode-S)
|
||||
* P - Average static air pressure in hectopascals. (Mode-S)
|
||||
* T - Static air temperature in degrees Celsuis. (Mode-S)
|
||||
* T - Static air temperature in degrees Celsius. (Mode-S)
|
||||
* U - Humidity in percent. (Mode-S)
|
||||
* Latitude (Lat) - Vertical position coordinate, in decimal degrees. North positive. (ADS-B)
|
||||
* Longitude (Lon) - Horizontal position coordinate, in decimal degrees. East positive. (ADS-B)
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
This plugin can be used to demodulate AIS (Automatic Identification System) messages. AIS can be used to track ships and other marine vessels at sea, that are equipped with AIS transponders. It is also used by shore-side infrastructure known as base stations, aids-to-navigation such as buoys and some search and rescue aircraft.
|
||||
|
||||
AIS is broadcast globally on 25kHz channels at 161.975MHz and 162.025MHz, with other frequencies being used regionally or for special purposes. This demodulator is single channel, so if you wish to decode multiple channels simulatenously, you will need to add one AIS demodulator per frequency. As most AIS messages are on 161.975MHz and 162.025MHz, you can set the center frequency as 162MHz, with a sample rate of 100k+Sa/s, with one AIS demod with an input offset -25kHz and another at +25kHz.
|
||||
AIS is broadcast globally on 25kHz channels at 161.975MHz and 162.025MHz, with other frequencies being used regionally or for special purposes. This demodulator is single channel, so if you wish to decode multiple channels simultaneously, you will need to add one AIS demodulator per frequency. As most AIS messages are on 161.975MHz and 162.025MHz, you can set the center frequency as 162MHz, with a sample rate of 100k+Sa/s, with one AIS demod with an input offset -25kHz and another at +25kHz.
|
||||
|
||||
The AIS demodulators can send received messages to the [AIS feature](../../feature/ais/readme.md), which displays a table combining the latest data for vessels amalgamated from multiple demodulators and sends their positiosn to the [Map Feature](../../feature/map/readme.ais) for display in 2D or 3D.
|
||||
|
||||
|
@ -16,7 +16,7 @@ Use the wheels to adjust the frequency shift in Hz from the center frequency of
|
||||
|
||||
<h3>2: PLL and synchronous AM</h2>
|
||||
|
||||
Use this toggle button to turn on or off the PLL locking and synchronous AM detection. When on the input signal is mixed with the NCO of the PLL that locks to the carrier of the AM transmission. Then the signal is processed as a DSB or SSB (see control 3) modulated signal. The main advantage compared to enveloppe detection is a better resilience to carrier selective fading. This does not prevents all selective fading distorsion but addresses the most annoying.
|
||||
Use this toggle button to turn on or off the PLL locking and synchronous AM detection. When on the input signal is mixed with the NCO of the PLL that locks to the carrier of the AM transmission. Then the signal is processed as a DSB or SSB (see control 3) modulated signal. The main advantage compared to envelope detection is a better resilience to carrier selective fading. This does not prevents all selective fading distortion but addresses the most annoying.
|
||||
|
||||
When the PLL is locked the icon lights up in green. The frequency shift from carrier appears in the tooltip. Locking indicator is pretty sharp with about +/- 100 Hz range.
|
||||
|
||||
|
@ -168,7 +168,7 @@ The "EWS" indicator lights up if a EWS message is received. Next is the emergenc
|
||||
|
||||
<h3>C.20: Current text line</h3>
|
||||
|
||||
The "TXT" indicator ligths up if a text element is received. Next the current radio text line is displayed.
|
||||
The "TXT" indicator lights up if a text element is received. Next the current radio text line is displayed.
|
||||
|
||||
<h3>C.21: Clear previous text line</h3>
|
||||
|
||||
@ -194,7 +194,7 @@ Station data: program PI and service names list.
|
||||
|
||||
Station frequencies list.
|
||||
|
||||
<h3>C.27: EON alernate frequencies</h3>
|
||||
<h3>C.27: EON alternate frequencies</h3>
|
||||
|
||||
Station alternate frequencies list.
|
||||
|
||||
|
@ -109,7 +109,7 @@ This is the Spread Factor parameter of the ChirpChat signal. This is the log2 of
|
||||
|
||||
The LoRa standard specifies 0 (no DE) or 2 (DE active). The ChirpChat DE range is extended to all values between 0 and 4 bits.
|
||||
|
||||
This is the log2 of the number of FFT bins used for one symbol. Extending the numbe of FFT bins per symbol decreases the probability to detect the wrong symbol as an adjacent bin. It can also overcome frequency drift on long messages.
|
||||
This is the log2 of the number of FFT bins used for one symbol. Extending the number of FFT bins per symbol decreases the probability to detect the wrong symbol as an adjacent bin. It can also overcome frequency drift on long messages.
|
||||
|
||||
In practice it is difficult to make correct decodes if only one FFT bin is used to code one symbol (DE=0) therefore it is recommended to use a DE factor of 2 or more. With medium SNR DE=1 can still achieve good results.
|
||||
|
||||
|
@ -106,7 +106,7 @@ Callsign of the recipient. When an empty callsign is used it means the transmiss
|
||||
|
||||
<h3>B.3: Type information</h3>
|
||||
|
||||
Displays the transmision type information contained in the LSF (Link Setup Frame).
|
||||
Displays the transmission type information contained in the LSF (Link Setup Frame).
|
||||
|
||||
- First word first part (before colon):
|
||||
- **PKT**: Packet
|
||||
|
@ -4,7 +4,7 @@
|
||||
|
||||
This plugin sends I/Q samples from the baseband via TCP/IP across a network to a client application.
|
||||
The client application could be SDRangel using the [Remote TCP Input](../../samplesource/remotetcpinput/readme.md) plugin or a rtl_tcp compatible application.
|
||||
This means that applications using rtl_tcp protcol can connect to the wide variety of SDRs supported by SDRangel.
|
||||
This means that applications using rtl_tcp protocol can connect to the wide variety of SDRs supported by SDRangel.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
|
@ -172,7 +172,7 @@ This is the "TO" of APRS message. There is a choice between "APRS¨, "APZ¨, "CQ
|
||||
|
||||
<h4>C.6.2.4: Via identifier</h4>
|
||||
|
||||
This is the "VIA" of APRS mesage. There is a choice between "WIDE2-2", "ARISS" or custom.
|
||||
This is the "VIA" of APRS message. There is a choice between "WIDE2-2", "ARISS" or custom.
|
||||
|
||||
<h4>C.6.2.5: Data payload</h4>
|
||||
|
||||
|
@ -127,7 +127,7 @@ Gain in dB before compression
|
||||
|
||||
<h4>13.3: Audio compressor threshold</h4>
|
||||
|
||||
Threshold in dB above which compression applies a.k.a. "knee" point. The lower the value the harder is the compression and consequently higher the distorsion.
|
||||
Threshold in dB above which compression applies a.k.a. "knee" point. The lower the value the harder is the compression and consequently higher the distortion.
|
||||
|
||||
<h4>13.4: Tone input select</h4>
|
||||
|
||||
|
@ -32,7 +32,7 @@ Note that on first start the list in (4) is empty therefore you must press this
|
||||
|
||||
Use this combo box to select which channel to control. The list item is formatted this way:
|
||||
|
||||
- R ot T for a source (Rx) or sink (Tx) device set
|
||||
- R or T for a source (Rx) or sink (Tx) device set
|
||||
- The sequence number of the device set
|
||||
- The sequence number of the channel after the semicolon separator
|
||||
- The type of channel
|
||||
|
@ -115,7 +115,7 @@ When clicked, opens the Map Display Settings dialog:
|
||||
![Map Display Settings Dialog](../../../doc/img/Map_plugin_display_settings.png)
|
||||
|
||||
The top half of the dialog allows customization of how objects from different SDRangel
|
||||
plugins are dispayed on the 2D and 3D maps. This includes:
|
||||
plugins are displayed on the 2D and 3D maps. This includes:
|
||||
|
||||
* Whether images are displayed on the 2D map and whether 3D models are displayed on the 2D map.
|
||||
* Whether labels are displayed giving the name of the object.
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
<h2>Introduction</h2>
|
||||
|
||||
The Packet Error Rate (PER) Tester feature can be used to measure the packet error rate over digital, packet based protcols such as AX.25 (Packet mod/demod), LoRa (ChipChat mod/demod), AIS and 802.15.4.
|
||||
The Packet Error Rate (PER) Tester feature can be used to measure the packet error rate over digital, packet based protocols such as AX.25 (Packet mod/demod), LoRa (ChipChat mod/demod), AIS and 802.15.4.
|
||||
|
||||
The PER Tester feature allows you to define the contents of the packets to transmit, which can include a per-packet 32-bit identifier, as well as a user-defined or random payload, how many packets are sent and the interval between them.
|
||||
|
||||
|
@ -103,7 +103,7 @@ available via the selected protocol. The available devices will be added to the
|
||||
|
||||
The device name is the name assigned by the selected protocol. If you wish to use a different label for the device in the GUI, this can be entered in the Label field.
|
||||
|
||||
The Controls and Sensors tables allow you to customize which are contols and sensors are visible in the GUI, via the checkbox in the Enable column.
|
||||
The Controls and Sensors tables allow you to customize which are controls and sensors are visible in the GUI, via the checkbox in the Enable column.
|
||||
|
||||
The Left Label and Right Label fields hold the text that will be displayed either side of the control or sensor in the GUI.
|
||||
The Left Label is initialised with the device name and the Right Label is initialised with the units.
|
||||
@ -124,7 +124,7 @@ The Y Axis field below the table determines whether each series will have it's o
|
||||
The Layout fields control how the Controls and Sensors will be laid-out in the GUI. This can be set to be either Horizontally or Vertically.
|
||||
|
||||
When the Protocol is set to VISA, additional buttons will be displayed under the tables that allow controls and sensors to be added or removed, as unlike when selecting
|
||||
TP-Link and Home Assitant devices, these are not automatically defined for most instruments. Some basic controls are included for Rigol DP832 and Siglent SSA3032X.
|
||||
TP-Link and Home Assistant devices, these are not automatically defined for most instruments. Some basic controls are included for Rigol DP832 and Siglent SSA3032X.
|
||||
|
||||
<h3>VISA Control Dialog</h3>
|
||||
|
||||
|
@ -95,7 +95,7 @@ On the Settings tab, you can set:
|
||||
* The maximum elevation angle in degrees supported by your rotator. 180 degree support is beneficial for passes that pass through 360/0 degrees, to avoid the rotator having to do a complete rotation mid pass.
|
||||
* A speech warning to be given on AOS. See below for a list of variable substitutions.
|
||||
* A speech warning to be given on LOS.
|
||||
* A command/script to be executed on AOS. This applies to all satellites. It is also possible to set a per-satellite command in the SDRangel Control dialog. See below for a list of variable substitions.
|
||||
* A command/script to be executed on AOS. This applies to all satellites. It is also possible to set a per-satellite command in the SDRangel Control dialog. See below for a list of variable substitutions.
|
||||
* A command/script to be executed on LOS. This applies to all satellites. It is also possible to set a per-satellite command in the SDRangel Control dialog.
|
||||
* The Doppler correction period in seconds, which controls how frequently Doppler correction is applied. Which channels have Doppler correction applied is set on a per-channel basis in the SDRangel Control dialog.
|
||||
|
||||
|
@ -122,4 +122,4 @@ This label turns green when data has been transmitted to the device.
|
||||
- **U**: turns red if stream experiences underruns
|
||||
- **D**: turns red if stream experiences packet drop outs
|
||||
|
||||
The stream warning indicators are reset when the acqusition is started.
|
||||
The stream warning indicators are reset when the acquisition is started.
|
||||
|
@ -14,7 +14,7 @@ Device start / stop button.
|
||||
|
||||
- Blue triangle icon: device is ready and can be started
|
||||
- Green square icon: device is running and can be stopped
|
||||
- Red square icon: an error has occured with the connection to the remote device. The plugin will continually try to reconnect.
|
||||
- Red square icon: an error has occurred with the connection to the remote device. The plugin will continually try to reconnect.
|
||||
|
||||
<h3>2: Center frequency</h3>
|
||||
|
||||
@ -47,7 +47,7 @@ Use this button to activate RTL-SDR's direct sampling mode. This can be used to
|
||||
<h3>9: Sample rate</h3>
|
||||
|
||||
Specify the remote device's sample rate in samples per second (S/s). This is the sample rate between the remote device and remote server.
|
||||
This field allows an arbitry rate to be entered. However, some devices are limited in the rates they support, so you should be careful
|
||||
This field allows an arbitrary rate to be entered. However, some devices are limited in the rates they support, so you should be careful
|
||||
only to enter a supported value, otherwise there may be a mismatch between the displayed rate and the actual rate.
|
||||
|
||||
<h3>10: Decimation</h3>
|
||||
@ -115,14 +115,14 @@ If the remote server is using the RTL0 protocol, the GUI will not be updated, wh
|
||||
Determines how many seconds of I/Q samples are buffered locally from the remote device, before being processed in SDRangel.
|
||||
More buffering can handle more network congestion and other network problems, without gaps in the output, but increases the latency in changes to remote device settings.
|
||||
|
||||
<h3>23: Input buffer guage</h3>
|
||||
<h3>23: Input buffer gauge</h3>
|
||||
|
||||
Shows how much data is in the input buffer. Typically this will be just under the pre-fill setting.
|
||||
If it becomes empty, the plugin will pause outputting of data until the buffer is refilled to the pre-fill level.
|
||||
If the buffer repeatedly runs empty, this suggests you do not have enough network bandwidth for the current combination
|
||||
of channel sample rate and sample bit depth. Reducing these to lower values may be required for uninterupted data.
|
||||
of channel sample rate and sample bit depth. Reducing these to lower values may be required for uninterrupted data.
|
||||
|
||||
<h3>24: Output buffer guage</h3>
|
||||
<h3>24: Output buffer gauge</h3>
|
||||
|
||||
Shows how much data is in the output buffer. This should typically be empty. If not empty, this suggests your CPU can't keep up with the amount of data being received.
|
||||
|
||||
|
@ -134,7 +134,7 @@ This label turns green when data is being received from the device.
|
||||
- **O**: turns red if stream experiences overruns
|
||||
- **T**: turns red if stream experiences timeouts
|
||||
|
||||
The stream warning indicators are reset when the acqusition is started.
|
||||
The stream warning indicators are reset when the acquisition is started.
|
||||
|
||||
<h2>Dependendices</h2>
|
||||
|
||||
|
@ -73,7 +73,7 @@ You can control the SDRangel application (server or GUI) by the means of the RES
|
||||
|
||||
The API documentation is accessible online when the SDRangel application (GUI or server) is running at the address and port specified in the program options. The default is [http://127.0.0.1:8091](http://127.0.0.1:8091).
|
||||
|
||||
The documentation home page dispays two links on the left:
|
||||
The documentation home page displays two links on the left:
|
||||
|
||||
![API documentation home](../doc/img/APIdocHome.png)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user