update modeslive command

pyModeS/extra/tcpclient.py

@@ -18,15 +18,15 @@ else:
 
 
 class BaseClient(Thread):
-    def __init__(self, host, port, rawtype):
+    def __init__(self, host, port, datatype):
         Thread.__init__(self)
         self.host = host
         self.port = port
         self.buffer = []
         self.socket = None
-        self.rawtype = rawtype
-        if self.rawtype not in ["avr", "beast", "skysense"]:
-            print("rawtype must be either avr, beast or skysense")
+        self.datatype = datatype
+        if self.datatype not in ["raw", "beast", "skysense"]:
+            print("datatype must be either raw, beast or skysense")
             os._exit(1)
 
     def connect(self):
@@ -35,16 +35,18 @@ class BaseClient(Thread):
         self.socket.setsockopt(zmq.RCVTIMEO, 2000)
         self.socket.connect("tcp://%s:%s" % (self.host, self.port))
 
-    def read_avr_buffer(self):
-        # -- testing --
-        # for b in self.buffer:
-        #     print(chr(b), b)
-
-        # Append message with 0-9,A-F,a-f, until stop sign
+    def read_raw_buffer(self):
+        """ Read raw ADS-B data type.
 
+        String strats with "*" and ends with ";". For example:
+            *5d484ba898f8c6;
+            *8d400cd5990d7e9a10043e5e6da0;
+            *a0001498be800030aa0000c7a75f;
+        """
         messages = []
 
         msg_stop = False
+        self.current_msg = ""
         for b in self.buffer:
             if b == 59:
                 msg_stop = True
@@ -54,7 +56,9 @@ class BaseClient(Thread):
                 msg_stop = False
                 self.current_msg = ""
 
-            if (not msg_stop) and (48 <= b <= 57 or 65 <= b <= 70 or 97 <= b <= 102):
+            if (not msg_stop) and (
+                48 <= b <= 57 or 65 <= b <= 70 or 97 <= b <= 102
+            ):
                 self.current_msg = self.current_msg + chr(b)
 
         self.buffer = []
@@ -62,7 +66,8 @@ class BaseClient(Thread):
         return messages
 
     def read_beast_buffer(self):
-        """
+        """Handle mode-s beast data type.
+
         <esc> "1" : 6 byte MLAT timestamp, 1 byte signal level,
             2 byte Mode-AC
         <esc> "2" : 6 byte MLAT timestamp, 1 byte signal level,
@@ -77,7 +82,6 @@ class BaseClient(Thread):
         timestamp:
         wiki.modesbeast.com/Radarcape:Firmware_Versions#The_GPS_timestamp
         """
-
         messages_mlat = []
         msg = []
         i = 0
@@ -224,7 +228,11 @@ class BaseClient(Thread):
                 msg = "".join("%02X" % j for j in payload)
                 i += 14  # Both message types use 14 bytes
                 tsbin = self.buffer[i : i + 6]
-                sec = ((tsbin[0] & 0x7F) << 10) | (tsbin[1] << 2) | (tsbin[2] >> 6)
+                sec = (
+                    ((tsbin[0] & 0x7F) << 10)
+                    | (tsbin[1] << 2)
+                    | (tsbin[2] >> 6)
+                )
                 nano = (
                     ((tsbin[2] & 0x3F) << 24)
                     | (tsbin[3] << 16)
@@ -264,11 +272,11 @@ class BaseClient(Thread):
                 #     continue
                 # -- Removed!! Cause delay in low data rate scenario --
 
-                if self.rawtype == "beast":
+                if self.datatype == "beast":
                     messages = self.read_beast_buffer()
-                elif self.rawtype == "avr":
-                    messages = self.read_avr_buffer()
-                elif self.rawtype == "skysense":
+                elif self.datatype == "raw":
+                    messages = self.read_raw_buffer()
+                elif self.datatype == "skysense":
                     messages = self.read_skysense_buffer()
 
                 if not messages:
@@ -299,7 +307,7 @@ if __name__ == "__main__":
     # for testing purpose only
     host = sys.argv[1]
     port = int(sys.argv[2])
-    rawtype = sys.argv[3]
-    client = BaseClient(host=host, port=port, rawtype=rawtype)
+    datatype = sys.argv[3]
+    client = BaseClient(host=host, port=port, datatype=datatype)
     client.daemon = True
     client.run()

pyModeS/streamer/modeslive

@@ -19,59 +19,68 @@ ADSB_TS = []
 COMMB_MSG = []
 COMMB_TS = []
 
+support_rawtypes = ["raw", "beast", "skysense"]
+
 parser = argparse.ArgumentParser()
 parser.add_argument(
-    "--source", help="rtlsdr or tcp", required=True, default="tcp"
+    "--source",
+    help='Choose data source, "rtlsdr" or "net"',
+    required=True,
+    default="net",
+)
+parser.add_argument(
+    "--connect",
+    help="Define server, port and data type. Supported data types are: %s"
+    % support_rawtypes,
+    nargs=3,
+    metavar=("SERVER", "PORT", "DATATYPE"),
+    default=None,
+    required=False,
 )
-parser.add_argument("--server", help="server address or IP", default=None)
-parser.add_argument("--port", help="raw data port", default=None)
-parser.add_argument("--rawtype", help="beast, avr or skysense", default=None)
 parser.add_argument(
     "--latlon",
-    help="receiver position",
+    help="Receiver latitude and longitude, needed for the surface position, default none",
     nargs=2,
     metavar=("LAT", "LON"),
-    required=True,
+    default=None,
+    required=False,
 )
 parser.add_argument(
     "--show-uncertainty",
     dest="uncertainty",
-    help="display uncertaint values, default off",
+    help="Display uncertainty values, default off",
     action="store_true",
     required=False,
     default=False,
 )
 parser.add_argument(
     "--dumpto",
-    help="folder to dump decoded output",
+    help="Folder to dump decoded output, default none",
     required=False,
     default=None,
 )
 args = parser.parse_args()
 
 SOURCE = args.source
-SERVER = args.server
-PORT = args.port
-RAWTYPE = args.rawtype
-LAT0 = float(args.latlon[0])
-LON0 = float(args.latlon[1])
+LATLON = args.latlon
 UNCERTAINTY = args.uncertainty
 DUMPTO = args.dumpto
 
 if SOURCE == "rtlsdr":
     pass
-elif SOURCE == "tcp":
-    if SERVER is None:
-        print("You must specify the server for TCP source.")
-        sys.exit(1)
-    if PORT is None:
-        print("You must specify the port for TCP source.")
-        sys.exit(1)
-    if RAWTYPE is None:
-        print("You must specify the rawtype for TCP source.")
-        sys.exit(1)
+elif SOURCE == "net":
+    if args.connect is None:
+        print("Error: --connect argument must not be empty.")
+    else:
+        SERVER, PORT, DATATYPE = args.connect
+        if DATATYPE not in support_rawtypes:
+            print(
+                "Data type not supported, avaiable ones are %s"
+                % support_rawtypes
+            )
+
 else:
-    print("Source must be rtlsdr or tcp.")
+    print('Source must be "rtlsdr" or "net".')
     sys.exit(1)
 
 if DUMPTO is not None:
@@ -157,8 +166,8 @@ class ModesRtlReader(RtlReader):
 # redirect all stdout to null, avoiding messing up with the screen
 sys.stdout = open(os.devnull, "w")
 
-if SOURCE == "tcp":
-    client = ModesClient(host=SERVER, port=PORT, rawtype=RAWTYPE)
+if SOURCE == "net":
+    client = ModesClient(host=SERVER, port=PORT, rawtype=DATATYPE)
     client.daemon = True
     client.start()
 elif SOURCE == "rtlsdr":
@@ -167,7 +176,7 @@ elif SOURCE == "rtlsdr":
     rtl.daemon = True
     rtl.start()
 
-stream = Stream(lat0=LAT0, lon0=LON0, dumpto=DUMPTO)
+stream = Stream(latlon=LATLON, dumpto=DUMPTO)
 
 try:
     screen = Screen(uncertainty=UNCERTAINTY)

pyModeS/streamer/stream.py

@@ -7,12 +7,16 @@ import pyModeS as pms
 
 
 class Stream:
-    def __init__(self, lat0, lon0, dumpto=None):
+    def __init__(self, latlon=None, dumpto=None):
 
         self.acs = dict()
 
-        self.lat0 = lat0
-        self.lon0 = lon0
+        if latlon is not None:
+            self.lat0 = float(latlon[0])
+            self.lon0 = float(latlon[1])
+        else:
+            self.lat0 = None
+            self.lon0 = None
 
         self.t = 0
         self.cache_timeout = 60  # seconds