Config documentation

loraprs_config.h

@@ -7,8 +7,9 @@ namespace LoraPrs {
   
 struct Config
 {
-  bool IsClientMode;    // true - client mode, false - server mode
-  
+  bool IsClientMode;    // false - server mode, true - client mode (disables wifi and aprsis)
+
+  // lora protocol parameters
   long LoraFreq;        // lora frequency, e.g. 433.775e6
   long LoraBw;          // lora bandwidth, e.g. 125e3
   int LoraSf;           // lora spreading factor, e.g. 12
@@ -17,11 +18,23 @@ struct Config
   int LoraSync;         // lora sync word/packet id, 0x3f
   bool LoraEnableCrc;   // lora crc check enabled
 
+  // lora hardware pinouts and isr
   byte LoraPinSs;       // lora ss pin
   byte LoraPinRst;      // lora rst pin
   byte LoraPinDio0;     // lora dio0 pin
-  bool LoraUseIsr;      // true to use interrupts, false for polling, e.g. if Dio0 is not connected
+  bool LoraUseIsr;      // true to use interrupts, false for fallback polling, e.g. if Dio0 is not connected
 
+  // bluetooth
+  String BtName;        // bluetooth device name for the client, set to empty string to disable bluetooth in server mode
+
+  // wifi
+  String WifiSsid;      // wifi access point name
+  String WifiKey;       // wifi access point key
+
+  // kiss
+  bool EnableKissExtensions; // true - enable kiss extensions for radio control and signal reports
+
+  // aprsis connectivity
   int AprsPort;         // aprs server port, 14580
   String AprsHost;      // aprs server hostname, rotate.aprs2.net
   String AprsLogin;     // aprs callsign to use, e.g. N0CALL-1
@@ -29,12 +42,8 @@ struct Config
   String AprsFilter;    // aprs filter, see http://www.aprs-is.net/javAPRSFilter.aspx, do not include filter directive, just space separated values
   String AprsRawBeacon; // aprs string for server beacon, e.g. NOCALL-1>APZMDM,WIDE1-1:!0000.00N/00000.00E#LoRA 433.775MHz/BW125/SF12/CR7/0xf3
   int AprsRawBeaconPeriodMinutes; // aprs beacon period
-  
-  String BtName;        // bluetooth device name for the client
-  
-  String WifiSsid;      // wifi access point name
-  String WifiKey;       // wifi access point key
 
+  // aprs logic
   bool EnableSignalReport;              // true - append signal report on server side for the client to be sent to APRS-IS
   bool EnableAutoFreqCorrection;        // true - correct own frequency based on received packet frequency deviation
   bool EnablePersistentAprsConnection;  // true - keep aprs-is connection active all the time
@@ -42,7 +51,6 @@ struct Config
   bool EnableIsToRf;                    // true - enable APRS-IS to RF submission
   bool EnableRepeater;                  // true - digirepeat incoming packets based on WIDEn-n paths
   bool EnableBeacon;                    // true - send AprsRawBeacon to RF and APRS-IS if EnableRfToIs is true
-  bool EnableKissExtensions;            // true - enable kiss extensions for radio control and signal reports
 };
 
 } // LoraPrs