grahamwhaley / DSPham

A Teensy based DSP audio processor
GNU General Public License v3.0
24 stars 7 forks source link

Document the display values #18

Open grahamwhaley opened 3 years ago

grahamwhaley commented 3 years ago

We cover the display layout in the README, but we don't explain what the values of each entry mean. It would help users if we documented this better. Here is a very quick rundown for starters:

top line

When not in CW mode, the top line displays the current active settings slot (00-10), and the name of the slot (SSB etc, or Empty if the slot contains no settings. When in CW mode, the decoded CW scrolls across the top line, from right to left.

Status line

The status line is always displayed, and the each status item/position has a fixed function. They are, in order from left to right:

Input volume

Shows 'bars' indicating the input signal volume level. A single '.' is the lowest level. Four 'bars' is a high level. If input clipping (volume too high) is detected then an ! will appear for 0.5s.

Bandpass filter

Indicates which bandpass filter is active. Values are:

Noise blanker

Shows if the noise blanker is on or off. Shows - for off, and an 'impulse' type character (similar to ~ or a slanted N) when active.

Auto notch

Shows if the noise blaner is enabled or not. Shows - when it is off, and a stylised V when it is on.

AGC mode

Shows which, if any, AGC (like) method is in use. Values are:

Noise reduction

Shows which noise reduction algorithm is active. Values are:

CPU utilisation

Shows a rough estimate of the amount of CPU time that is being consumed doing the processing. Generally a fairly low number.

CW tuning aid

A rough guide to help tune in the CW decoder. The CW decoder 'listens' to the centre frequency defined for the active bandpass filter. The tuning aid listens for the 'loudest' tone in the signal, and shows one of five symbols to reflect how the detected tone relates to the bandpass:

CW WPM

Shows the current detected CW word per minute speed as detected by the decoder that is active. Note, if using the Bayesian decoder there can be some delay between signals being heard and the WPM and decoded characters being printed.