Command summary and default settings

Hamlabs · Mar 16, 2024 · 631d1f2 · 631d1f2
1 parent f090a60
commit 631d1f2
Show file tree

Hide file tree

Showing 2 changed files with 96 additions and 155 deletions.
diff --git a/COMMANDS b/COMMANDS
@@ -3,169 +3,110 @@
 # System commands
 ########################
 
-free        Get the total size of heap memory available     
-            FIXME change to 'mem'
-
-sysinfo     System info
-
-restart     Restart the program
-
-tasks       Get information about running tasks"
-
-time        Current date and time 
-
-log         Console logging level
-            <tag>|* [<level>|delete]
-
-regex	    Regex test				REMOVE
-
-nmea	    Monitor GPS NMEA datastream
-	    [raw]
-
-disp	    Test display			REMOVE
-
-tone	    Tone generator test
-
-ptt	    Key transmitter
-
-radio	    Radio on
-
 fw-upgrade  Firmware upgrade
+trk-reset   Reset track storage  
+ls          List files  
+rm          Remove file
+format      Format filesystem
+write       Write to file
+read        Read from file
+free        Get the total size of heap memory available
+sysinfo     System info    
+restart     Restart the program
+tasks       Get information about running tasks
+log         Set loglevel (for debugging/development)
+time        Get date and time
+nmea        Monitor GPS NMEA datastream
+tone        tone generator test
+ptt         Transmitter on
+fw-upgrade  Firmware upgrade (OTA)
 
+vbatt       Read battery voltage
+shutdown    Shut down system (put in deep sleep)
+
+adc         Read ADC (not on T-TWR)
+adcref      ADC reference value (millivolts) (not on T-TWR)
 
 
-
 ########################### 
 # Wifi/internet commands
 ###########################
 
-wifi        WIFI on/off - WIFI.on                       
-
-wifi-join   Join WiFi AP as a station
-
-wifi-scan   Scan for wifi access points 
-
-wifi-info   Info about WIFI
-
-ap-ssid     WIFI SoftAP SSID setting - WIFIAP.SSID                  
-            FIXME: If empty, show default!!!
-
-ap-auth     WIFI SoftAP password - WIFIAP.AUTH  
-
-ap-ip       WIFI_SoftAP IP address - WIFIAP.IP    
-
-
-ap          Edit list of access point alternatives. Index 1-6.
-            [<index> [<ssid>|delete [<password>]]] 
-
-httpd       Control webserver
-            on | off            
-            FIXME: Additional command for setting auth info
-
-connect     Open internet connection (host,port)                    TODO   
-            <host> <port>
-
-ipaddr      Get IP address from WIFI module		                    TODO        
-
-fw-url      URL for firmware upgrade
-
-fw-cert     Certificate for firmware upgrade
-
-
-
-
+mdns         Scan for MDNS services
+wifi-scan    Scan for wifi access points  
+wifi-info    Info about WIFI connection
+wifi         WIFI On/Off setting
+softap       Soft AP On/Off setting
+ap           List or change AP alternatives
+ap-ssid      WIFI SoftAP SSID setting
+ap-auth      WIFI SoftAP password
+ap-ip        WIFI_SoftAP IP address
+ap-sta       WIFI SoftAP Connected stations
+api-key      REST API Key
+api-origins  Allowed origins for REST API webclients
+fw-url       URL for firmware update
+fw-cert      Certificate for firmware update
+connect      Connect to internet server
 
 
 
-#########################
-# Misc TODO commands
-#########################
+############################
+# APRS and radio commands
+############################
 
+teston      HDLC encoder test
+testpacket  Send test APRS packet
+listen      Monitor radio channel
+trklog-get  Get track record      
+trklog-put  Put track record  
+
+mycall      My callsign
+dest        APRS destination address
+digipath    APRS Digipeater path
+symbol      APRS symbol (sym-table symbol)
+osymbol     APRS symbol for objects (sym-table symbol)
+objectid    ID prefix for object reports
+comment     APRS posreport comment
+txdelay     APRS TXDELAY setting
+txtail      APRS TXTAIL setting
+repeat      # Times to repeat posreports (0-3)
+
+trklog-int  Interval for track logging (seconds)
+trklog-ttl  Max time to keep tracklog entries (hours)
+trklog-key  KEY for authenticating tracklog-messages to Polaric Server
+trklog-url  URL for posting tracklog updates to Polaric Server
+maxframe    APRS max frames in a transmission
+maxpause    Tracking max pause (10 sec units)
+minpause    Tracking min pause (10 sec units)
+mindist     Tracking min distance (meters)
+statustime  Status report time (10 sec units)
+turnlimit   Threshold for change of direction
+txfreq      TX frequency (100 Hz units)"
+rxfreq      RX frequency (100 Hz units)
+squelch     Squelch setting (1-8)
+miclevel    Miclevel setting (1-8)
+
+timestamp   Timestamp setting
+compress    Compress setting
+altitude    Altitude setting
+
+digi        Digipeater setting 
+igate       Igate setting
+digi-wide1  Digipeater fill-in mode (WIDE1) 
+digi-sar    Digipeater preemption on 'SAR'
+igate-host  Igate server host
+igate-port  Igate server port
+igate-user  Igate server user
+igate-pass  Igate server passcode
+
+tracklog    Track logging
+trklog-post Track log automatic post to server
+radio       Radio module power on
+tracker     APRS tracker setting
+reportbeep  Beep when report is sent
+extraturn   Send extra posreport in turns
+igtrack     Send posreports directly to APRS/IS when available   
+txmon       Tx monitor
+
+txlow"      Tx power low (T-TWR only)
 
-freq        Set/get freguency of radio   
-	    <rxfreq> [<txfreq>]
-
-squelch     Set/get squelch level of receiver (1-8)     
-            <level>
-
-volume      Set/get volume level of receiver       
-
-miclevel    Set/get mic sensitivity level (1-8)    
-	    <level>
-
-txpower     Set/get TX power (hi=1W, lo=0.5W)      
-            hi | lo
-
-txdelay     Set/get TX delay (flags before frame)  
-	    <n>
-
-txtail      Set/get TX tail (flags after frame)    
-	    <n>
-
-maxframe    Get/get max frames in one transmission 
-
-ptt        Turn on/off transmitter
-	   on | off
-
-radio      Turn on/off radio    
-	   on | off
-
-txtone     Send 1200Hz (lo) or 2200Hz (hi) tone
-	   hi | lo | off
-
-testpacket Send test APRS packet                  
-
-teston     Generate test signal with data byte    
-
-listen     Listen to radio                       
-
-converse   Converse mode                          
-
-gps        Control GPS module     
-	   on | off | nmea | pos | test
-
-txmon      Monitor transmitted packets on/off     
-
-tracker    Tracker on/off        
-	   on | off
-
-mycall     Set/get tracker's APRS callsign        
-
-dest       Set/get APRS destination address      
-
-symbol     Set/get APRS symbol                    
-
-path       Set/get APRS digipeater path           
-
-timestamp  Timestamp on/off                       
-
-compress   Compressed positions on/off            
-
-altitude   Altidude in reports on/off            
-
-reportbeep Beep when reporting on/off            
-
-repeat     Repeat posisition report (piggybacked)
-
-extraturn  Extra report on turn (piggybacked)     
-
-turnlimit  Change in heading that trigger report  
-
-maxpause   Max pause (seconds/10) before report   
-
-minpause   Min pause (seconds/10) before report   
-
-mindist    Min moved distance (meters) before report
-
-digipeater Digipeater settings 
-	   info | on | off | wide1 | sar
-	   FIXME: rename, split
-
-igate      Igate settings 
-	   info | on | off | host | port | username | passcode | filter
-	   FIXME: rename, split
-
-igtrack    Tracking through internet gate on/off    
-
-statustime Time (seconds/10) between status messages
-
diff --git a/main/default_param.h b/main/default_param.h
@@ -4,8 +4,8 @@
 #define DFL_TRKLOG_URL   "https://localhost/trklog"
 #define DFL_DEST         "APAR31"
 #define DFL_DIGIPATH     ""
-#define DFL_SYMBOL       "/]"
-#define DFL_OBJ_SYMBOL   "/]"
+#define DFL_SYMBOL       "/["
+#define DFL_OBJ_SYMBOL   "/["
 #define DFL_OBJ_ID       "MARK-"
 #define DFL_REP_COMMENT  "Arctic Tracker"
 #define DFL_IGATE_HOST   "aprs.no"