diff --git a/doc/img/FreqDisplay_plugin.png b/doc/img/FreqDisplay_plugin.png new file mode 100644 index 000000000..5147e8f9e Binary files /dev/null and b/doc/img/FreqDisplay_plugin.png differ diff --git a/doc/img/FreqDisplay_plugin_transparent.png b/doc/img/FreqDisplay_plugin_transparent.png new file mode 100644 index 000000000..262bf8ba4 Binary files /dev/null and b/doc/img/FreqDisplay_plugin_transparent.png differ diff --git a/plugins/feature/freqdisplay/readme.md b/plugins/feature/freqdisplay/readme.md new file mode 100644 index 000000000..18f533f39 --- /dev/null +++ b/plugins/feature/freqdisplay/readme.md @@ -0,0 +1,68 @@ +

Frequency Display Plugin

+ +

Introduction

+ +The Frequency Display plugin displays the center frequency and/or power of a selected channel. +The displayed values are scaled to the size of the window, so can be made large enough to be visible from a distance. +Optionally, the values can be spoken whenever they change, which may be useful when tuning circuits or antennas and the screen isn't visible. + +

Interface

+ +![Frequency Display plugin GUI](../../../doc/img/FreqDisplay_plugin.png) + +

1: Channel

+ +Select which TX or RX channel to display the centre frequency or power for. + +In order for the power to be able to displayed, the channel must include a value with the channelPowerDB key in its channel report. + +

2: Display

+ +Choose the text to display: + +* Frequency - displays the selected channel's (1) centre frequency in Hz. +* Power - displays the selected channel's (1) power in dB. +* Frequency & Power - displays the selected channel's (1) centre frequency in Hz and power in dB. + +

3: T - Transparent

+ +When Transparent mode is checked, only the centre frequency and/or power will be displayed with a transparent background, +so it can be overlaid on other windows. + +![Transparent Frequency Display](../../../doc/img/FreqDisplay_plugin_transparent.png) + +When in transparent mode, the text can be repositioning by clicking and dragging it. +To exit transparent mode, right click on any of the text, and select "Exit transparent mode" from the pop-up menu. + +

4: Speech

+ +When Speech mode is checked, whenever the displayed frequency and/or power value changes, the new value will be spoken. + +

5: Units

+ +Specify the units for the frequency value: + +* Hz +* kHz +* MHz +* GHz + +

6: U - Display Units

+ +When the U button is checked, units will be displayed and spoken. + +

7: Freq DP - Frequency Decimal Places

+ +Freq DP specifies the number of decimal places used to display frequency values, when the units (5) are not Hz. + +

8: Power DP - Power Decimal Places

+ +Power DP specifies the number of decimal places used to display power values. + +

9: Font

+ +Select the font used to display frequency and power values. + +

10: Font Colour

+ +Select the colour for the font used to display frequency and power values.