Updated Channel Rx plugins (markdown)

master
f4exb 2019-12-16 16:58:01 +01:00
rodzic 5e7fc5c024
commit b1b6e6daa7
1 zmienionych plików z 29 dodań i 15 usunięć

@ -6,6 +6,12 @@ One nice thing about this approach is that any number of different channels can
The plugins documented here are:
## Channel analyzer plugin
This plugin has no audio output and is used to visualize and analyze signals. It has a spectrum and scope combined display the spectrum and the scope sharing the same trigger which helps in visualizing the spectrum of pulsed signals. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/chanalyzer/readme.md)
Note that the old Channel Analyzer plugin was decommissioned in favor of the "New Generation" NG suffixed plugin that was renamed simply "Channel Analyzer"
## AM demod plugin
This plugin is used to listen to AM stations such as air traffic or AM broadcast. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demodam/readme.md)
@ -14,13 +20,9 @@ This plugin is used to listen to AM stations such as air traffic or AM broadcast
This plugin can be used to watch amateur analog television (ATV). This is black and white and there is no sound carrier. Low refresh rates (FPS) and small number of lines are implemented to support NBTV (Narrow Band TV). The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demodatv/readme.md)
## Frequency tracker plugin
## DATV demod plugin
This plugin can be used to track the center frequency of a carrier. It will try to adjust its center frequency on the carrier center frequency. It is normally used in conjunction with a utility program that monitors the plugin center frequency via reverse API. This utility can then make use of this information to control other plugins or any other purpose. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/freqtracker/readme.md)
## NFM demod plugin
This plugin is used to listen to a narrow band FM station such as PMR or Amateur Radio. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demodnfm/readme.md)
This plugin can be used to watch digital amateur analog television (DATV). Accepted standards are DVB-S and DVB-S2. Please note that DVB-S2 does not perform very well and needs a high SNR (>20dB) to work properly. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demoddatv/readme.md)
## DSD (Digital Speech Decoder) demod plugin
@ -37,20 +39,38 @@ For the moment only the type can be detected for the following protocols:
More information and user interface description can be found [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demoddsd/readme.md)
## FreeDV demodulator plugin
This plugin can be used to demodulate and decode FreeDV signals (see: https://freedv.org). Not all modes are supported. More information and user interface description can be found [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demodfreedv/readme.md)
## LoRa demod plugin
This plugin can be used to visualize and decode LoRa (Long Range) modulation designed by Semtech. It comes from the original source code and decoding technique has been preserved as is. It has been reported that it works in some cases but there is no formal support for it.
## NFM demod plugin
This plugin is used to listen to a narrow band FM station such as PMR or Amateur Radio. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demodnfm/readme.md)
## SSB demod plugin
This plugin is used to listen to SSB (possibly DSB) or CW stations such as Amateur Radio. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demodssb/readme.md)
## Channel analyzer plugin
## WFM demod plugin
This plugin has no audio output and is used to visualize and analyze signals. It has a spectrum and scope combined display the spectrum and the scope sharing the same trigger which helps in visualizing the spectrum of pulsed signals. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/chanalyzer/readme.md)
It is just the wideband version of the NFM demod plugin. It has no de-emphasis nor possibility of stereo output. If you plan to listen to wideband broadcast FM you should rather use the Broadcast FM demod plugin. The user interface description and more details can be found [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demodwfm/readme.md)
Note that the old Channel Analyzer plugin was decommissioned in favor of the "New Generation" NG suffixed plugin that was renamed simply "Channel Analyzer"
## Frequency tracker plugin
This plugin can be used to track the center frequency of a carrier. It will try to adjust its center frequency on the carrier center frequency. It is normally used in conjunction with a utility program that monitors the plugin center frequency via reverse API. This utility can then make use of this information to control other plugins or any other purpose. The user interface is described [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/freqtracker/readme.md)
## Local sink plugin
This plugin sends I/Q samples from the baseband to a Local Input plugin source in another device set. It is basically the same as the Remote Sink channel plugin but pipes the samples internally instead of sending them over the network. The user interface is described [here](https://github.com/f4exb/sdrangel/tree/master/plugins/channelrx/localsink/readme.md)
## Remote sink plugin
This plugin sends I/Q samples to another SDRangel instance that uses a Remote input sample source plugin to receive the samples. The user interface is described [here](https://github.com/f4exb/sdrangel/tree/master/plugins/channelrx/remotesink/readme.md)
## UDP sink plugin
This plugin can be used to send samples to a listening application over the network using UDP blocks. For example this can be used to make a connection to GNUradio using its UDP source block. Optionally the audio at 48kHz sample rate can be returned to this plugin to be incorporated in the audio mix. The user interface description and more details can be found [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/udpsrc/readme.md)
@ -59,9 +79,6 @@ For an example of usage with `multimon-ng` to decode APRS look at https://github
This is different from the Daemon sink which purpose is to send the full baseband with no further filtering nor decimating.
## WFM demod plugin
It is just the wideband version of the NFM demod plugin. It has no de-emphasis nor possibility of stereo output. If you plan to listen to wideband broadcast FM you should rather use the Broadcast FM demod plugin. The user interface description and more details can be found [here](https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/demodwfm/readme.md)
# Undocumented (yet) plugins
@ -69,6 +86,3 @@ It is just the wideband version of the NFM demod plugin. It has no de-emphasis n
This plugin is used to listen to broadcast FM stations with possible stereo output and RDS decoding
## LoRa demod plugin
This plugin can be used to visualize and decode LoRa (Long Range) modulation designed by Semtech. It comes from the original source code and decoding technique has been preserved as is. It has been reported that it works in some cases but there is no formal support for it.