loctrkd/beesure.py

   1 """
   2 Implementation of the protocol "beesure" used by some watch-trackers
   3 https://www.4p-touch.com/beesure-gps-setracker-server-protocol.html
   4 """
   5
   6 from datetime import datetime, timezone
   7 from enum import Enum
   8 from inspect import isclass
   9 import re
  10 from struct import error, pack, unpack
  11 from time import time
  12 from typing import (
  13     Any,
  14     Callable,
  15     Dict,
  16     List,
  17     Optional,
  18     Tuple,
  19     Type,
  20     TYPE_CHECKING,
  21     Union,
  22 )
  23
  24 __all__ = (
  25     "Stream",
  26     "class_by_prefix",
  27     "enframe",
  28     "inline_response",
  29     "proto_handled",
  30     "parse_message",
  31     "probe_buffer",
  32     "proto_by_name",
  33     "proto_name",
  34     "DecodeError",
  35     "Respond",
  36     "LK",
  37 )
  38
  39 PROTO_PREFIX = "BS:"
  40
  41 ### Deframer ###
  42
  43 MAXBUFFER: int = 65557  # Theoretical max buffer 65536 + 21
  44 RE = re.compile(b"\[(\w\w)\*(\d{10})\*([0-9a-fA-F]{4})\*")
  45
  46
  47 def _framestart(buffer: bytes) -> Tuple[int, str, str, int]:
  48     """
  49     Find the start of the frame in the buffer.
  50     If found, return (offset, vendorId, imei, datalen) tuple.
  51     If not found, set -1 as the value of `offset`
  52     """
  53     mo = RE.search(buffer)
  54     return (
  55         (
  56             mo.start(),
  57             mo.group(1).decode(),
  58             mo.group(2).decode(),
  59             int(mo.group(3), 16),
  60         )
  61         if mo
  62         else (-1, "", "", 0)
  63     )
  64
  65
  66 class Stream:
  67     def __init__(self) -> None:
  68         self.buffer = b""
  69         self.imei: Optional[str] = None
  70         self.datalen: int = 0
  71
  72     def recv(self, segment: bytes) -> List[Union[bytes, str]]:
  73         """
  74         Process next segment of the stream. Return successfully deframed
  75         packets as `bytes` and error messages as `str`.
  76         """
  77         when = time()
  78         self.buffer += segment
  79         if len(self.buffer) > MAXBUFFER:
  80             # We are receiving junk. Let's drop it or we run out of memory.
  81             self.buffer = b""
  82             return [f"More than {MAXBUFFER} unparseable data, dropping"]
  83         msgs: List[Union[bytes, str]] = []
  84         while True:
  85             if not self.datalen:  # we have not seen packet start yet
  86                 toskip, _, imei, datalen = _framestart(self.buffer)
  87                 if toskip < 0:  # No frames, continue reading
  88                     break
  89                 if toskip > 0:  # Should not happen, report
  90                     msgs.append(
  91                         f"Skipping {toskip} bytes of undecodable data"
  92                         f' "{self.buffer[:toskip][:64]=!r}"'
  93                     )
  94                     self.buffer = self.buffer[toskip:]
  95                     # From this point, buffer starts with a packet header
  96                 if self.imei is None:
  97                     self.imei = imei
  98                 if self.imei != imei:
  99                     msgs.append(
 100                         f"Packet's imei {imei} mismatches"
 101                         f" previous value {self.imei}, old value kept"
 102                     )
 103                 self.datalen = datalen
 104             if len(self.buffer) < self.datalen + 21:  # Incomplete packet
 105                 break
 106             # At least one complete packet is present in the buffer
 107             if chr(self.buffer[self.datalen + 20]) == "]":
 108                 msgs.append(self.buffer[: self.datalen + 21])
 109             else:
 110                 msgs.append(
 111                     f"Packet does not end with ']'"
 112                     f" at {self.datalen+20}: {self.buffer=!r}"
 113                 )
 114             self.buffer = self.buffer[self.datalen + 21 :]
 115             self.datalen = 0
 116         return msgs
 117
 118     def close(self) -> bytes:
 119         ret = self.buffer
 120         self.buffer = b""
 121         self.imei = None
 122         self.datalen = 0
 123         return ret
 124
 125
 126 def enframe(buffer: bytes, imei: Optional[str] = None) -> bytes:
 127     assert imei is not None and len(imei) == 10
 128     off, vid, _, dlen = _framestart(buffer)
 129     assert off == 0
 130     return f"[{vid:2s}*{imei:10s}*{dlen:04X}*".encode() + buffer[20:]
 131
 132
 133 ### Parser/Constructor ###
 134
 135
 136 class DecodeError(Exception):
 137     def __init__(self, e: Exception, **kwargs: Any) -> None:
 138         super().__init__(e)
 139         for k, v in kwargs.items():
 140             setattr(self, k, v)
 141
 142
 143 def maybe(typ: type) -> Callable[[Any], Any]:
 144     return lambda x: None if x is None else typ(x)
 145
 146
 147 def intx(x: Union[str, int]) -> int:
 148     if isinstance(x, str):
 149         x = int(x, 0)
 150     return x
 151
 152
 153 def boolx(x: Union[str, bool]) -> bool:
 154     if isinstance(x, str):
 155         if x.upper() in ("ON", "TRUE", "1"):
 156             return True
 157         if x.upper() in ("OFF", "FALSE", "0"):
 158             return False
 159         raise ValueError(str(x) + " could not be parsed as a Boolean")
 160     return x
 161
 162
 163 class MetaPkt(type):
 164     """
 165     For each class corresponding to a message, automatically create
 166     two nested classes `In` and `Out` that also inherit from their
 167     "nest". Class attribute `IN_KWARGS` defined in the "nest" is
 168     copied to the `In` nested class under the name `KWARGS`, and
 169     likewise, `OUT_KWARGS` of the nest class is copied as `KWARGS`
 170     to the nested class `Out`. In addition, method `encode` is
 171     defined in both classes equal to `in_encode()` and `out_encode()`
 172     respectively.
 173     """
 174
 175     if TYPE_CHECKING:
 176
 177         def __getattr__(self, name: str) -> Any:
 178             pass
 179
 180         def __setattr__(self, name: str, value: Any) -> None:
 181             pass
 182
 183     def __new__(
 184         cls: Type["MetaPkt"],
 185         name: str,
 186         bases: Tuple[type, ...],
 187         attrs: Dict[str, Any],
 188     ) -> "MetaPkt":
 189         newcls = super().__new__(cls, name, bases, attrs)
 190         newcls.In = super().__new__(
 191             cls,
 192             name + ".In",
 193             (newcls,) + bases,
 194             {
 195                 "KWARGS": newcls.IN_KWARGS,
 196                 "decode": newcls.in_decode,
 197                 "encode": newcls.in_encode,
 198             },
 199         )
 200         newcls.Out = super().__new__(
 201             cls,
 202             name + ".Out",
 203             (newcls,) + bases,
 204             {
 205                 "KWARGS": newcls.OUT_KWARGS,
 206                 "decode": newcls.out_decode,
 207                 "encode": newcls.out_encode,
 208             },
 209         )
 210         return newcls
 211
 212
 213 class Respond(Enum):
 214     NON = 0  # Incoming, no response needed
 215     INL = 1  # Birirectional, use `inline_response()`
 216     EXT = 2  # Birirectional, use external responder
 217
 218
 219 class BeeSurePkt(metaclass=MetaPkt):
 220     RESPOND = Respond.NON  # Do not send anything back by default
 221     PROTO: str
 222     IN_KWARGS: Tuple[Tuple[str, Callable[[Any], Any], Any], ...] = ()
 223     OUT_KWARGS: Tuple[Tuple[str, Callable[[Any], Any], Any], ...] = ()
 224     KWARGS: Tuple[Tuple[str, Callable[[Any], Any], Any], ...] = ()
 225     In: Type["BeeSurePkt"]
 226     Out: Type["BeeSurePkt"]
 227
 228     if TYPE_CHECKING:
 229
 230         def __getattr__(self, name: str) -> Any:
 231             pass
 232
 233         def __setattr__(self, name: str, value: Any) -> None:
 234             pass
 235
 236     def __init__(self, *args: Any, **kwargs: Any):
 237         """
 238         Construct the object _either_ from (length, payload),
 239         _or_ from the values of individual fields
 240         """
 241         assert not args or (len(args) == 4 and not kwargs)
 242         if args:  # guaranteed to be two arguments at this point
 243             self.vendor, self.imei, self.datalength, self.payload = args
 244             try:
 245                 self.decode(*self.payload)
 246             except error as e:
 247                 raise DecodeError(e, obj=self)
 248         else:
 249             for kw, typ, dfl in self.KWARGS:
 250                 setattr(self, kw, typ(kwargs.pop(kw, dfl)))
 251             if kwargs:
 252                 raise ValueError(
 253                     self.__class__.__name__ + " stray kwargs " + str(kwargs)
 254                 )
 255
 256     def __repr__(self) -> str:
 257         return "{}({})".format(
 258             self.__class__.__name__,
 259             ", ".join(
 260                 "{}={}".format(
 261                     k,
 262                     'bytes.fromhex("{}")'.format(v.hex())
 263                     if isinstance(v, bytes)
 264                     else v.__repr__(),
 265                 )
 266                 for k, v in self.__dict__.items()
 267                 if not k.startswith("_")
 268             ),
 269         )
 270
 271     def decode(self, *args: str) -> None:
 272         ...
 273
 274     def in_decode(self, *args: str) -> None:
 275         # Overridden in subclasses, otherwise do not decode payload
 276         return
 277
 278     def out_decode(self, *args: str) -> None:
 279         # Overridden in subclasses, otherwise do not decode payload
 280         return
 281
 282     def encode(self) -> str:
 283         ...
 284
 285     def in_encode(self) -> str:
 286         # Necessary to emulate terminal, which is not implemented
 287         raise NotImplementedError(
 288             self.__class__.__name__ + ".encode() not implemented"
 289         )
 290
 291     def out_encode(self) -> str:
 292         # Overridden in subclasses, otherwise command verb only
 293         return self.PROTO
 294
 295     @property
 296     def packed(self) -> bytes:
 297         buffer = self.encode().encode()
 298         return f"[LT*0000000000*{len(buffer):04X}*".encode() + buffer + b"]"
 299
 300
 301 class UNKNOWN(BeeSurePkt):
 302     PROTO = "UNKNOWN"
 303
 304
 305 class LK(BeeSurePkt):
 306     PROTO = "LK"
 307     RESPOND = Respond.INL
 308
 309     def in_decode(self, *args: str) -> None:
 310         numargs = len(args)
 311         if numargs > 1:
 312             self.step = args[1]
 313         if numargs > 2:
 314             self.tumbling_number = args[2]
 315         if numargs > 3:
 316             self.battery_percentage = args[3]
 317
 318     def in_encode(self) -> str:
 319         return "LK"
 320
 321
 322 class CONFIG(BeeSurePkt):
 323     PROTO = "CONFIG"
 324
 325
 326 class ICCID(BeeSurePkt):
 327     PROTO = "ICCID"
 328
 329
 330 class UD(BeeSurePkt):
 331     PROTO = "UD"
 332
 333     def in_decode(self, *args: str) -> None:
 334         (
 335             _,
 336             self.date,
 337             self.time,
 338             self.gps_valid,
 339             self.lat,
 340             self.nors,
 341             self.lon,
 342             self.eorw,
 343             self.speed,
 344             self.direction,
 345             self.altitude,
 346             self.num_of_sats,
 347             self.gsm_strength_percentage,
 348             self.battery_percentage,
 349             self.pedometer,
 350             self.tubmling_times,
 351             self.device_status,
 352         ) = args[:17]
 353         rest_args = args[17:]
 354         self.base_stations_number = int(rest_args[0])
 355         self.base_stations = rest_args[1 : 4 + 3 * self.base_stations_number]
 356         rest_args = rest_args[3 + 3 * self.base_stations_number + 1 :]
 357         self.wifi_ap_number = int(rest_args[0])
 358         self.wifi_ap = rest_args[1 : self.wifi_ap_number]
 359         # rest_args = rest_args[self_wifi_ap_number+1:]
 360         self.positioning_accuracy = rest_args[-1]
 361
 362
 363 class UD2(BeeSurePkt):
 364     PROTO = "UD2"
 365
 366
 367 class TKQ(BeeSurePkt):
 368     PROTO = "TKQ"
 369     RESPOND = Respond.INL
 370
 371
 372 class TKQ2(BeeSurePkt):
 373     PROTO = "TKQ2"
 374     RESPOND = Respond.INL
 375
 376
 377 class AL(BeeSurePkt):
 378     PROTO = "AL"
 379     RESPOND = Respond.INL
 380
 381
 382 # Build dicts protocol number -> class and class name -> protocol number
 383 CLASSES = {}
 384 PROTOS = {}
 385 if True:  # just to indent the code, sorry!
 386     for cls in [
 387         cls
 388         for name, cls in globals().items()
 389         if isclass(cls)
 390         and issubclass(cls, BeeSurePkt)
 391         and not name.startswith("_")
 392     ]:
 393         if hasattr(cls, "PROTO"):
 394             CLASSES[cls.PROTO] = cls
 395             PROTOS[cls.__name__] = cls.PROTO
 396
 397
 398 def class_by_prefix(
 399     prefix: str,
 400 ) -> Union[Type[BeeSurePkt], List[Tuple[str, str]]]:
 401     lst = [
 402         (name, proto)
 403         for name, proto in PROTOS.items()
 404         if name.upper().startswith(prefix.upper())
 405     ]
 406     if len(lst) != 1:
 407         return lst
 408     _, proto = lst[0]
 409     return CLASSES[proto]
 410
 411
 412 def proto_handled(proto: str) -> bool:
 413     return proto.startswith(PROTO_PREFIX)
 414
 415
 416 def proto_name(obj: Union[MetaPkt, BeeSurePkt]) -> str:
 417     return PROTO_PREFIX + (
 418         obj.__class__.__name__ if isinstance(obj, BeeSurePkt) else obj.__name__
 419     )
 420
 421
 422 def proto_by_name(name: str) -> str:
 423     return PROTO_PREFIX + PROTOS.get(name, "UNKNOWN")
 424
 425
 426 def proto_of_message(packet: bytes) -> str:
 427     return PROTO_PREFIX + packet[20:-1].split(b",")[0].decode()
 428
 429
 430 def imei_from_packet(packet: bytes) -> Optional[str]:
 431     toskip, _, imei, _ = _framestart(packet)
 432     if toskip == 0 and imei != "":
 433         return imei
 434     return None
 435
 436
 437 def is_goodbye_packet(packet: bytes) -> bool:
 438     return False
 439
 440
 441 def inline_response(packet: bytes) -> Optional[bytes]:
 442     proto = packet[20:-1].split(b",")[0].decode()
 443     if proto in CLASSES:
 444         cls = CLASSES[proto]
 445         if cls.RESPOND is Respond.INL:
 446             return cls.Out().packed
 447     return None
 448
 449
 450 def probe_buffer(buffer: bytes) -> bool:
 451     return bool(RE.search(buffer))
 452
 453
 454 def parse_message(packet: bytes, is_incoming: bool = True) -> BeeSurePkt:
 455     """From a packet (without framing bytes) derive the XXX.In object"""
 456     toskip, vendor, imei, datalength = _framestart(packet)
 457     payload = packet[20:-1].decode().split(",")
 458     proto = payload[0] if len(payload) > 0 else ""
 459     if proto not in CLASSES:
 460         cause: Union[DecodeError, ValueError, IndexError] = ValueError(
 461             f"Proto {proto} is unknown"
 462         )
 463     else:
 464         try:
 465             if is_incoming:
 466                 return CLASSES[proto].In(vendor, imei, datalength, payload)
 467             else:
 468                 return CLASSES[proto].Out(vendor, imei, datalength, payload)
 469         except (DecodeError, ValueError, IndexError) as e:
 470             cause = e
 471     if is_incoming:
 472         retobj = UNKNOWN.In(vendor, imei, datalength, payload)
 473     else:
 474         retobj = UNKNOWN.Out(vendor, imei, datalength, payload)
 475     retobj.PROTO = proto  # Override class attr with object attr
 476     retobj.cause = cause
 477     return retobj