X-Git-Url: http://average.org/gitweb/?a=blobdiff_plain;f=loctrkd%2Fbeesure.py;h=dcf16ba227fd7ca585baa9371595e19307917fe9;hb=6eff65f7b03bc66a479df0fd694250e1e0b7c5ae;hp=ad351cb0126b3c3616169802e36150d39b1a2371;hpb=b965fecb08f4149f6f91770e9d6bb6d79f53f11e;p=loctrkd.git diff --git a/loctrkd/beesure.py b/loctrkd/beesure.py index ad351cb..dcf16ba 100755 --- a/loctrkd/beesure.py +++ b/loctrkd/beesure.py @@ -39,7 +39,6 @@ __all__ = ( "proto_handled", "parse_message", "probe_buffer", - "proto_name", "DecodeError", "Respond", ) @@ -117,7 +116,7 @@ class Stream: else: msgs.append( f"Packet does not end with ']'" - f" at {self.datalen+20}: {self.buffer=!r}" + f" at {self.datalen+20}: {self.buffer[:64]=!r}" ) self.buffer = self.buffer[self.datalen + 21 :] self.datalen = 0 @@ -141,6 +140,14 @@ def enframe(buffer: bytes, imei: Optional[str] = None) -> bytes: ### Parser/Constructor ### +class classproperty: + def __init__(self, f: Callable[[Any], str]) -> None: + self.f = f + + def __get__(self, obj: Any, owner: Any) -> str: + return self.f(owner) + + class DecodeError(Exception): def __init__(self, e: Exception, **kwargs: Any) -> None: super().__init__(e) @@ -200,6 +207,7 @@ class Respond(Enum): class BeeSurePkt(ProtoClass): + BINARY = False RESPOND = Respond.NON # Do not send anything back by default IN_KWARGS: Tuple[Tuple[str, Callable[[Any], Any], Any], ...] = () OUT_KWARGS: Tuple[Tuple[str, Callable[[Any], Any], Any], ...] = () @@ -278,14 +286,21 @@ class BeeSurePkt(ProtoClass): # Overridden in subclasses, otherwise command verb only return "" - @property - def PROTO(self) -> str: + @classproperty + def PROTO(cls: "BeeSurePkt") -> str: + """Name of the class without possible .In / .Out suffix""" + proto: str try: - proto, _ = self.__class__.__name__.split(".") + proto, _ = cls.__name__.split(".") except ValueError: - proto = self.__class__.__name__ + proto = cls.__name__ return proto + @classmethod + def proto_name(cls) -> str: + """Name of the command as used externally""" + return PROTO_PREFIX + cls.PROTO[:16] + @property def packed(self) -> bytes: data = self.encode() @@ -297,6 +312,14 @@ class UNKNOWN(BeeSurePkt): pass +class _SET_PHONE(BeeSurePkt): + OUT_KWARGS = (("phonenumber", str, ""),) + + def out_encode(self) -> str: + self.phonenumber: str + return self.phonenumber + + class _LOC_DATA(BeeSurePkt): def in_decode(self, *args: str) -> None: p = SimpleNamespace() @@ -358,7 +381,10 @@ class _LOC_DATA(BeeSurePkt): self.longitude = p.lon * p.eorw def rectified(self) -> Report: - if self.gps_valid: + # self.gps_valid is supposed to mean it, but it does not. Perfectly + # good looking coordinates, with ten satellites, still get 'V'. + # I suspect that in reality, 'A' means "hint data is absent". + if self.gps_valid or self.num_of_sats > 3: return CoordReport( devtime=str(self.devtime), battery_percentage=self.battery_percentage, @@ -384,6 +410,14 @@ class AL(_LOC_DATA): RESPOND = Respond.INL +class CALL(_SET_PHONE): + pass + + +class CENTER(_SET_PHONE): + pass + + class CONFIG(BeeSurePkt): pass @@ -392,6 +426,10 @@ class CR(BeeSurePkt): pass +class FIND(BeeSurePkt): + pass + + class FLOWER(BeeSurePkt): OUT_KWARGS = (("number", int, 1),) @@ -420,6 +458,13 @@ class LK(BeeSurePkt): return "LK" +class LZ(BeeSurePkt): + OUT_KWARGS = (("language", int, 1), ("timezone", int, 0)) + + def out_encode(self) -> str: + return f"{self.language},{self.timezone}" + + class MESSAGE(BeeSurePkt): OUT_KWARGS = (("message", str, ""),) @@ -427,6 +472,10 @@ class MESSAGE(BeeSurePkt): return str(self.message.encode("utf_16_be").hex()) +class MONITOR(BeeSurePkt): + pass + + class _PHB(BeeSurePkt): OUT_KWARGS: Tuple[Tuple[str, Callable[[Any], Any], Any], ...] = ( ("entries", pblist, []), @@ -466,14 +515,6 @@ class SOS(BeeSurePkt): return ",".join(self.phonenumbers) -class _SET_PHONE(BeeSurePkt): - OUT_KWARGS = (("phonenumber", str, ""),) - - def out_encode(self) -> str: - self.phonenumber: str - return self.phonenumber - - class SOS1(_SET_PHONE): pass @@ -487,6 +528,7 @@ class SOS3(_SET_PHONE): class TK(BeeSurePkt): + BINARY = True RESPOND = Respond.INL def in_decode(self, *args: Any) -> None: @@ -520,6 +562,13 @@ class UD2(_LOC_DATA): pass +class UPLOAD(BeeSurePkt): + OUT_KWARGS = (("interval", int, 600),) + + def out_encode(self) -> str: + return str(self.interval) + + # Build dicts protocol number -> class and class name -> protocol number CLASSES = {} if True: # just to indent the code, sorry! @@ -553,14 +602,15 @@ def proto_handled(proto: str) -> bool: return proto.startswith(PROTO_PREFIX) -def proto_name(obj: Union[Type[BeeSurePkt], BeeSurePkt]) -> str: - return PROTO_PREFIX + ( - obj.__class__.__name__ if isinstance(obj, BeeSurePkt) else obj.__name__ - ) +def _local_proto(packet: bytes) -> str: + try: + return packet[20:-1].split(b",")[0].decode() + except UnicodeDecodeError: + return "UNKNOWN" def proto_of_message(packet: bytes) -> str: - return PROTO_PREFIX + packet[20:-1].split(b",")[0].decode() + return PROTO_PREFIX + _local_proto(packet) def imei_from_packet(packet: bytes) -> Optional[str]: @@ -575,7 +625,7 @@ def is_goodbye_packet(packet: bytes) -> bool: def inline_response(packet: bytes) -> Optional[bytes]: - proto = packet[20:-1].split(b",")[0].decode() + proto = _local_proto(packet) if proto in CLASSES: cls = CLASSES[proto] if cls.RESPOND is Respond.INL: @@ -590,27 +640,30 @@ def probe_buffer(buffer: bytes) -> bool: def parse_message(packet: bytes, is_incoming: bool = True) -> BeeSurePkt: """From a packet (without framing bytes) derive the XXX.In object""" toskip, vendor, imei, datalength = _framestart(packet) + bsplits = packet[20:-1].split(b",", 1) try: - splits = packet[20:-1].decode().split(",") - proto = splits[0] if len(splits) > 0 else "" - payload: Union[List[str], bytes] = splits[1:] + proto = bsplits[0].decode("ascii") except UnicodeDecodeError: - bsplits = packet[20:-1].split(b",", 1) - if len(bsplits) == 2: - proto = bsplits[0].decode("ascii") - payload = bsplits[1] - if proto not in CLASSES: - cause: Union[DecodeError, ValueError, IndexError] = ValueError( - f"Proto {proto} is unknown" - ) + proto = str(bsplits[0]) + if len(bsplits) == 2: + rest = bsplits[1] else: + rest = b"" + if proto in CLASSES: + cls = CLASSES[proto].In if is_incoming else CLASSES[proto].Out + payload = ( + # Some people encode their SSIDs in non-utf8 + rest + if cls.BINARY + else rest.decode("Windows-1252").split(",") + ) try: - if is_incoming: - return CLASSES[proto].In(vendor, imei, datalength, payload) - else: - return CLASSES[proto].Out(vendor, imei, datalength, payload) + return cls(vendor, imei, datalength, payload) except (DecodeError, ValueError, IndexError) as e: - cause = e + cause: Union[DecodeError, ValueError, IndexError] = e + else: + payload = rest + cause = ValueError(f"Proto {proto} is unknown") if is_incoming: retobj = UNKNOWN.In(vendor, imei, datalength, payload) else: @@ -622,7 +675,7 @@ def parse_message(packet: bytes, is_incoming: bool = True) -> BeeSurePkt: def exposed_protos() -> List[Tuple[str, bool]]: return [ - (proto_name(cls)[:16], False) + (cls.proto_name(), False) for cls in CLASSES.values() if hasattr(cls, "rectified") ]