]> www.average.org Git - loctrkd.git/blobdiff - loctrkd/beesure.py
Implement sending commands from the web interface
[loctrkd.git] / loctrkd / beesure.py
index baf14dbee9600eb25252f9d44ea38c80fac0890a..e782c736189ca5d74a3f0cc188c7973672660c13 100755 (executable)
@@ -23,6 +23,12 @@ from typing import (
 from types import SimpleNamespace
 
 from .protomodule import ProtoClass
+from .common import (
+    CoordReport,
+    HintReport,
+    StatusReport,
+    Report,
+)
 
 __all__ = (
     "Stream",
@@ -33,11 +39,11 @@ __all__ = (
     "proto_handled",
     "parse_message",
     "probe_buffer",
-    "proto_name",
     "DecodeError",
     "Respond",
 )
 
+MODNAME = __name__.split(".")[-1]
 PROTO_PREFIX = "BS:"
 
 ### Deframer ###
@@ -111,7 +117,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
@@ -135,6 +141,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)
@@ -194,6 +208,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], ...] = ()
@@ -272,14 +287,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()
@@ -291,6 +313,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()
@@ -313,7 +343,7 @@ class _LOC_DATA(BeeSurePkt):
                 (self, "pedometer", int),
                 (self, "tubmling_times", int),
                 (self, "device_status", lambda x: int(x, 16)),
-                (self, "base_stations_number", int),
+                (self, "gsm_cells_number", int),
                 (self, "connect_base_station_number", int),
                 (self, "mcc", int),
                 (self, "mnc", int),
@@ -323,11 +353,11 @@ class _LOC_DATA(BeeSurePkt):
             setattr(obj, attr, func(val))  # type: ignore
         rest_args = args[20:]
         # (area_id, cell_id, strength)*
-        self.base_stations = [
-            tuple(int(el) for el in rest_args[i * 3 : 3 + i * 3])
-            for i in range(self.base_stations_number)
+        self.gsm_cells: List[Tuple[int, int, int]] = [
+            tuple(int(el) for el in rest_args[i * 3 : 3 + i * 3])  # type: ignore
+            for i in range(self.gsm_cells_number)
         ]
-        rest_args = rest_args[3 * self.base_stations_number :]
+        rest_args = rest_args[3 * self.gsm_cells_number :]
         self.wifi_aps_number = int(rest_args[0])
         # (SSID, MAC, strength)*
         self.wifi_aps = [
@@ -351,10 +381,12 @@ class _LOC_DATA(BeeSurePkt):
         self.latitude = p.lat * p.nors
         self.longitude = p.lon * p.eorw
 
-    def rectified(self) -> SimpleNamespace:  # JSON-able dict
-        if self.gps_valid:
-            return SimpleNamespace(
-                type="location",
+    def rectified(self) -> Tuple[str, Report]:
+        # 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 MODNAME, CoordReport(
                 devtime=str(self.devtime),
                 battery_percentage=self.battery_percentage,
                 accuracy=self.positioning_accuracy,
@@ -365,13 +397,12 @@ class _LOC_DATA(BeeSurePkt):
                 longitude=self.longitude,
             )
         else:
-            return SimpleNamespace(
-                type="approximate_location",
+            return MODNAME, HintReport(
                 devtime=str(self.devtime),
                 battery_percentage=self.battery_percentage,
                 mcc=self.mcc,
                 mnc=self.mnc,
-                base_stations=self.base_stations,
+                gsm_cells=self.gsm_cells,
                 wifi_aps=self.wifi_aps,
             )
 
@@ -380,6 +411,14 @@ class AL(_LOC_DATA):
     RESPOND = Respond.INL
 
 
+class CALL(_SET_PHONE):
+    pass
+
+
+class CENTER(_SET_PHONE):
+    pass
+
+
 class CONFIG(BeeSurePkt):
     pass
 
@@ -388,6 +427,10 @@ class CR(BeeSurePkt):
     pass
 
 
+class FIND(BeeSurePkt):
+    pass
+
+
 class FLOWER(BeeSurePkt):
     OUT_KWARGS = (("number", int, 1),)
 
@@ -416,6 +459,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, ""),)
 
@@ -423,6 +473,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, []),
@@ -462,14 +516,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
 
@@ -483,6 +529,7 @@ class SOS3(_SET_PHONE):
 
 
 class TK(BeeSurePkt):
+    BINARY = True
     RESPOND = Respond.INL
 
     def in_decode(self, *args: Any) -> None:
@@ -516,6 +563,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!
@@ -549,14 +603,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]:
@@ -571,7 +626,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:
@@ -586,27 +641,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:
@@ -618,7 +676,17 @@ def parse_message(packet: bytes, is_incoming: bool = True) -> BeeSurePkt:
 
 def exposed_protos() -> List[Tuple[str, bool]]:
     return [
-        (proto_name(cls), False)
+        (cls.proto_name(), False)
         for cls in CLASSES.values()
         if hasattr(cls, "rectified")
     ]
+
+
+def make_response(cmd: str, imei: str, **kwargs: Any) -> Optional[BeeSurePkt]:
+    if cmd == "poweroff":
+        return POWEROFF.Out()
+    elif cmd == "refresh":
+        return MONITOR.Out()
+    elif cmd == "message":
+        return MESSAGE.Out(message=kwargs.get("txt", "Hello"))
+    return None