__all__ = (
"handle_packet",
+ "inline_response",
"make_object",
"make_response",
"parse_message",
"proto_by_name",
- "set_config",
"GPS303Pkt",
"UNKNOWN",
"LOGIN",
class GPS303Pkt:
PROTO: int
- CONFIG = None
+ INLINE = True
def __init__(self, *args, **kwargs):
assert len(args) == 0
def to_packet(self):
return pack("BB", self.length, self.PROTO) + self.payload
- def response(self, *args):
- if len(args) == 0:
- return None
- assert len(args) == 1 and isinstance(args[0], bytes)
- payload = args[0]
+ @classmethod
+ def make_packet(cls, payload):
+ assert isinstance(payload, bytes)
length = len(payload) + 1
if length > 6:
length -= 6
- return pack("BB", length, self.PROTO) + payload
+ return pack("BB", length, cls.PROTO) + payload
+
+ @classmethod
+ def inline_response(cls, packet):
+ if cls.INLINE:
+ return cls.make_packet(b"")
+ else:
+ return None
class UNKNOWN(GPS303Pkt):
PROTO = 256 # > 255 is impossible in real packets
+ INLINE = False
class LOGIN(GPS303Pkt):
self.ver = unpack("B", payload[-1:])[0]
return self
- def response(self):
- return super().response(b"")
-
class SUPERVISION(GPS303Pkt): # Server sends supervision number status
PROTO = 0x05
+ INLINE = False
def response(self, supnum=0):
# 1: The device automatically answers Pickup effect
# 2: Automatically Answering Two-way Calls
# 3: Ring manually answer the two-way call
- return super().response(b"")
+ return self.make_packet(pack("B", supnum))
class HEARTBEAT(GPS303Pkt):
self.flags = flags
return self
- def response(self):
- return super().response(self.dtime)
+ @classmethod
+ def inline_response(cls, packet):
+ return cls.make_packet(packet[2:8])
class GPS_POSITIONING(_GPS_POSITIONING):
class STATUS(GPS303Pkt):
PROTO = 0x13
+ INLINE = False
@classmethod
def from_packet(cls, length, payload):
return self
def response(self, upload_interval=25): # Set interval in minutes
- return super().response(pack("B", upload_interval))
+ return self.make_packet(pack("B", upload_interval))
class HIBERNATION(GPS303Pkt):
class RESET(GPS303Pkt): # Device sends when it got reset SMS
PROTO = 0x15
+ INLINE = False
def response(self): # Server can send to initiate factory reset
- return super().response(b"")
+ return self.make_packet(b"")
class WHITELIST_TOTAL(GPS303Pkt): # Server sends to initiage sync (0x58)
PROTO = 0x16
+ INLINE = False
def response(self, number=3): # Number of whitelist entries
- return super().response(pack("B", number))
+ return self.make_packet(pack("B", number))
class _WIFI_POSITIONING(GPS303Pkt):
class WIFI_OFFLINE_POSITIONING(_WIFI_POSITIONING):
PROTO = 0x17
- def response(self):
- return super().response(self.dtime)
+ @classmethod
+ def inline_response(cls, packet):
+ return cls.make_packet(packet[2:8])
class TIME(GPS303Pkt):
PROTO = 0x30
- def response(self):
- payload = pack("!HBBBBB", *datetime.utcnow().timetuple()[:6])
- return super().response(payload)
+ @classmethod
+ def inline_response(cls, packet):
+ return pack(
+ "!BBHBBBBB", 7, cls.PROTO, *datetime.utcnow().timetuple()[:6]
+ )
class PROHIBIT_LBS(GPS303Pkt):
PROTO = 0x33
+ INLINE = False
def response(self, status=1): # Server sent, 0-off, 1-on
- return super().response(pack("B", status))
+ return self.make_packet(pack("B", status))
class MOM_PHONE(GPS303Pkt):
class STOP_UPLOAD(GPS303Pkt): # Server response to LOGIN to thwart the device
PROTO = 0x44
- def response(self):
- return super().response(b"")
-
class STOP_ALARM(GPS303Pkt):
PROTO = 0x56
class SETUP(GPS303Pkt):
PROTO = 0x57
+ INLINE = False
def response(
self,
]
+ [b";".join([el.encode() for el in phoneNumbers])]
)
- return super().response(payload)
+ return self.make_packet(payload)
class SYNCHRONOUS_WHITELIST(GPS303Pkt):
class WIFI_POSITIONING(_WIFI_POSITIONING):
PROTO = 0x69
+ INLINE = False
def response(self, lat=None, lon=None):
if lat is None or lon is None:
payload = "{:+#010.8g},{:+#010.8g}".format(lat, lon).encode(
"ascii"
)
- return super().response(payload)
+ return self.make_packet(payload)
class MANUAL_POSITIONING(GPS303Pkt):
PROTO = 0x80
+ INLINE = False
class BATTERY_CHARGE(GPS303Pkt):
class POSITION_UPLOAD_INTERVAL(GPS303Pkt):
PROTO = 0x98
+ INLINE = False
@classmethod
def from_packet(cls, length, payload):
self.interval = unpack("!H", payload[:2])
return self
- def response(self):
- return super().response(pack("!H", self.interval))
+ def response(self, interval=10):
+ return self.make_packet(pack("!H", interval))
class SOS_ALARM(GPS303Pkt):
def proto_of_message(packet):
- return unpack("B", packet[1:2])
+ return unpack("B", packet[1:2])[0]
+
+
+def inline_response(packet):
+ proto = proto_of_message(packet)
+ if proto in CLASSES:
+ return CLASSES[proto].inline_response(packet)
+ else:
+ return None
def make_object(length, proto, payload):
payload = packet[2:]
adjust = 2 if proto == STATUS.PROTO else 4 # Weird special case
if (
- proto
- not in (WIFI_POSITIONING.PROTO, WIFI_OFFLINE_POSITIONING.PROTO)
+ proto not in (WIFI_POSITIONING.PROTO, WIFI_OFFLINE_POSITIONING.PROTO)
and length > 1
and len(payload) + adjust != length
):
def make_response(msg, **kwargs): # DEPRECATED
inframe = msg.response(**kwargs)
return None if inframe is None else b"xx" + inframe + b"\r\n"
-
-
-def set_config(config): # Note that we are setting _class_ attribute
- GPS303Pkt.CONFIG = config