]> www.average.org Git - loctrkd.git/blobdiff - gps303/gps303proto.py
Make constructor of protocol objects more elegant
[loctrkd.git] / gps303 / gps303proto.py
index 04f535057ae2d6b95d7a3f25c75de2309cd3a293..136f86ba3df3e5a47044bfac09536cd691a1f45e 100755 (executable)
@@ -118,13 +118,21 @@ class MetaPkt(type):
             cls,
             name + ".In",
             (newcls,) + bases,
-            {"KWARGS": newcls.IN_KWARGS, "encode": newcls.in_encode},
+            {
+                "KWARGS": newcls.IN_KWARGS,
+                "decode": newcls.in_decode,
+                "encode": newcls.in_encode,
+            },
         )
         newcls.Out = super().__new__(
             cls,
             name + ".Out",
             (newcls,) + bases,
-            {"KWARGS": newcls.OUT_KWARGS, "encode": newcls.out_encode},
+            {
+                "KWARGS": newcls.OUT_KWARGS,
+                "decode": newcls.out_decode,
+                "encode": newcls.out_encode,
+            },
         )
         return newcls
 
@@ -138,20 +146,25 @@ class Respond(Enum):
 class GPS303Pkt(metaclass=MetaPkt):
     RESPOND = Respond.NON  # Do not send anything back by default
     PROTO: int
-    # Have these kwargs for now, TODO redo
-    IN_KWARGS = (("length", int, 0), ("payload", bytes, b""))
+    IN_KWARGS = ()
     OUT_KWARGS = ()
 
     def __init__(self, *args, **kwargs):
-        assert len(args) == 0
-        for kw, typ, dfl in self.KWARGS:
-            setattr(self, kw, typ(kwargs.pop(kw, dfl)))
-        if kwargs:
-            print("KWARGS", self.KWARGS)
-            print("kwargs", kwargs)
-            raise TypeError(
-                self.__class__.__name__ + " stray kwargs " + str(kwargs)
-            )
+        """
+        Construct the object _either_ from (length, payload),
+        _or_ from the values of individual fields
+        """
+        assert not args or (len(args) == 2 and not kwargs)
+        if args:  # guaranteed to be two arguments at this point
+            self.length, self.payload = args
+            self.decode(self.length, self.payload)
+        else:
+            for kw, typ, dfl in self.KWARGS:
+                setattr(self, kw, typ(kwargs.pop(kw, dfl)))
+            if kwargs:
+                raise ValueError(
+                    self.__class__.__name__ + " stray kwargs " + str(kwargs)
+                )
 
     def __repr__(self):
         return "{}({})".format(
@@ -168,12 +181,24 @@ class GPS303Pkt(metaclass=MetaPkt):
             ),
         )
 
+    def in_decode(self, length, packet):
+        # Overridden in subclasses, otherwise do not decode payload
+        return
+
+    def out_decode(self, length, packet):
+        # Necessary to emulate terminal, which is not implemented
+        raise NotImplementedError(
+            self.__class__.__name__ + ".decode() not implemented"
+        )
+
     def in_encode(self):
+        # Necessary to emulate terminal, which is not implemented
         raise NotImplementedError(
             self.__class__.__name__ + ".encode() not implemented"
         )
 
     def out_encode(self):
+        # Overridden in subclasses, otherwise make empty payload
         return b""
 
     @property
@@ -182,10 +207,6 @@ class GPS303Pkt(metaclass=MetaPkt):
         length = len(payload) + 1
         return pack("BB", length, self.PROTO) + payload
 
-    @classmethod
-    def from_packet(cls, length, payload):
-        return cls.In(payload=payload, length=length)
-
 
 class UNKNOWN(GPS303Pkt):
     PROTO = 256  # > 255 is impossible in real packets
@@ -196,9 +217,7 @@ class LOGIN(GPS303Pkt):
     RESPOND = Respond.INL
     # Default response for ACK, can also respond with STOP_UPLOAD
 
-    @classmethod
-    def from_packet(cls, length, payload):
-        self = super().from_packet(length, payload)
+    def in_decode(self, length, payload):
         self.imei = payload[:-1].hex()
         self.ver = unpack("B", payload[-1:])[0]
         return self
@@ -223,15 +242,14 @@ class HEARTBEAT(GPS303Pkt):
 class _GPS_POSITIONING(GPS303Pkt):
     RESPOND = Respond.INL
 
-    @classmethod
-    def from_packet(cls, length, payload):
-        self = super().from_packet(length, payload)
+    def in_decode(self, length, payload):
         self.dtime = payload[:6]
         if self.dtime == b"\0\0\0\0\0\0":
             self.devtime = None
         else:
+            yr, mo, da, hr, mi, se = unpack("BBBBBB", self.dtime)
             self.devtime = datetime(
-                *unpack("BBBBBB", self.dtime), tzinfo=timezone.utc
+                2000 + yr, mo, da, hr, mi, se, tzinfo=timezone.utc
             )
         self.gps_data_length = payload[6] >> 4
         self.gps_nb_sat = payload[6] & 0x0F
@@ -241,7 +259,7 @@ class _GPS_POSITIONING(GPS303Pkt):
         flip_lat = not bool(flags & 0b0000010000000000)  # bit 5
         self.heading = flags & 0b0000001111111111  # bits 6 - last
         self.latitude = lat / (30000 * 60) * (-1 if flip_lat else 1)
-        self.longitude = lon / (30000 * 60) * (-2 if flip_lon else 1)
+        self.longitude = lon / (30000 * 60) * (-1 if flip_lon else 1)
         self.speed = speed
         self.flags = flags
         return self
@@ -265,21 +283,13 @@ class STATUS(GPS303Pkt):
     RESPOND = Respond.EXT
     OUT_KWARGS = (("upload_interval", int, 25),)
 
-    @classmethod
-    def from_packet(cls, length, payload):
-        self = super().from_packet(length, payload)
-        if len(payload) == 5:
-            (
-                self.batt,
-                self.ver,
-                self.timezone,
-                self.intvl,
-                self.signal,
-            ) = unpack("BBBBB", payload)
-        elif len(payload) == 4:
-            self.batt, self.ver, self.timezone, self.intvl = unpack(
-                "BBBB", payload
-            )
+    def in_decode(self, length, payload):
+        self.batt, self.ver, self.timezone, self.intvl = unpack(
+            "BBBB", payload[:4]
+        )
+        if len(payload) > 4:
+            self.signal = payload[4]
+        else:
             self.signal = None
         return self
 
@@ -307,9 +317,7 @@ class WHITELIST_TOTAL(GPS303Pkt):  # Server sends to initiage sync (0x58)
 
 
 class _WIFI_POSITIONING(GPS303Pkt):
-    @classmethod
-    def from_packet(cls, length, payload):
-        self = super().from_packet(length, payload)
+    def in_decode(self, length, payload):
         self.dtime = payload[:6]
         if self.dtime == b"\0\0\0\0\0\0":
             self.devtime = None
@@ -474,9 +482,7 @@ class ALARM_CLOCK(GPS303Pkt):
 class STOP_ALARM(GPS303Pkt):
     PROTO = 0x56
 
-    @classmethod
-    def from_packet(cls, length, payload):
-        self = super().from_packet(length, payload)
+    def in_decode(self, length, payload):
         self.flag = payload[0]
         return self
 
@@ -541,9 +547,7 @@ class WIFI_POSITIONING(_WIFI_POSITIONING):
 class MANUAL_POSITIONING(GPS303Pkt):
     PROTO = 0x80
 
-    @classmethod
-    def from_packet(cls, length, payload):
-        self = super().from_packet(length, payload)
+    def in_decode(self, length, payload):
         self.flag = payload[0] if len(payload) > 0 else None
         self.reason = {
             1: "Incorrect time",
@@ -578,9 +582,7 @@ class POSITION_UPLOAD_INTERVAL(GPS303Pkt):
     RESPOND = Respond.EXT
     OUT_KWARGS = (("interval", int, 10),)
 
-    @classmethod
-    def from_packet(cls, length, payload):
-        self = super().from_packet(length, payload)
+    def in_decode(self, length, payload):
         self.interval = unpack("!H", payload[:2])
         return self
 
@@ -593,12 +595,10 @@ class SOS_ALARM(GPS303Pkt):
 
 
 class UNKNOWN_B3(GPS303Pkt):
-    PROTO = 0xb3
+    PROTO = 0xB3
     IN_KWARGS = (("asciidata", str, ""),)
 
-    @classmethod
-    def from_packet(cls, length, payload):
-        self = super().from_packet(length, payload)
+    def in_decode(self, length, payload):
         self.asciidata = payload.decode()
         return self
 
@@ -649,12 +649,12 @@ def inline_response(packet):
 
 
 def parse_message(packet):
-    """ From a packet (without framing bytes) derive the XXX.In object """
+    """From a packet (without framing bytes) derive the XXX.In object"""
     length, proto = unpack("BB", packet[:2])
     payload = packet[2:]
     if proto in CLASSES:
-        return CLASSES[proto].from_packet(length, payload)
+        return CLASSES[proto].In(length, payload)
     else:
-        retobj = UNKNOWN.from_packet(length, payload)
+        retobj = UNKNOWN.In(length, payload)
         retobj.PROTO = proto  # Override class attr with object attr
         return retobj