From f4ba5dfefcaf97de78510dbd1bac5949acb941b1 Mon Sep 17 00:00:00 2001
From: gullradriel <3157857+gullradriel@users.noreply.github.com>
Date: Fri, 12 May 2023 19:01:12 +0200
Subject: [PATCH] Created Freq manager (markdown)

---
 Freq-manager.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 Freq-manager.md

diff --git a/Freq-manager.md b/Freq-manager.md
new file mode 100644
index 0000000..4338693
--- /dev/null
+++ b/Freq-manager.md
@@ -0,0 +1,69 @@
+# Freqman file format
+
+As a start a warning: the freqman GUI have not been improved and may show partial results.
+Starting from nightly 12/05/2023 the freqman file support empty lines, comment lines, anything which is not matching one of the described fields is ignored.
+
+## Description of the fields
+`'f=freq' for one SINGLE frequency entry`
+
+`'a=start_frequency,b=end_frequency' for a RANGE entry`
+
+`'r=ham_relay_rx_freq,t=ham_relay_tx_freq' for a HAMRADIO entry`
+
+`m=modulation`
+
+`bw=bandwidth`
+
+`s=step`
+
+`d=description`
+
+**All fields except 'f=' or 'a=,b=' 'r=,t=' are mandatory**. If nothing specified actual value is used, even if actual value is 'not set'
+
+Any application using the original load_freqman_file will only load frequencies, and will try to populate a range in the list instead of manually stepping in. For developers: I've made a new load_freqman_file_ex func which do return an old list format depending on the parameters
+
+The Recon app is using the old as the new format, taking informations in account when they exist.
+
+## Freqman file example 
+
+`f=468000000`
+
+`f=468000000,d=Single Freq`
+
+`f=468000000,m=AM,d=Single Freq AM`
+
+`f=468000000,m=NFM,d=Single Freq NFM`
+
+`f=468000000,m=WFM,d=Single Freq WFM`
+
+`f=468000000,m=AM,bw=DSB 9k,d=Single Freq AM DSB`
+
+`f=468000000,m=AM,bw=USB,d=Single Freq AM USB`
+
+`f=468000000,m=AM,bw=LSB,d=Single Freq AM LSB`
+
+`a=87000000,b=110000000`
+
+`a=87000000,b=110000000,m=AM,s=100kHz,d=AM radio search`
+
+`a=87000000,b=110000000,m=AM,bw=DSB 9k,s=250kHz,d=AM radio search LSB`
+
+`a=87000000,b=110000000,m=WFM,bw=200k,s=50kHz,d=WFM radio search s=50kHz`
+
+`r=430150000,t=430550000`
+
+`r=430150000,t=430550000,d=HAM radio`
+
+`r=430150000,t=430550000,m=AM,bw=DSB 9k,d=HAM radio`
+
+
+## Possible values for modulation/bandwidth
+
+* AM  ( DSB 9k , DSB 6k , USB+3k , LSB-3k , CW )
+* NFM ( 8k5 , 11k , 16k )
+* WFM ( 200k , 180k , 40k )
+
+## Possible values for Steps
+
+* 5kHz , 6.25kHz , 8.33kHz , 9kHz , 10kHz , 12.kHz , 15kHz , 25kHz , 50kHz , 100kHz , 250kHz , 500kHz , 1MHz
+