)
from types import SimpleNamespace
+from .protomodule import ProtoClass
+from .common import (
+ CoordReport,
+ HintReport,
+ StatusReport,
+ Report,
+)
+
__all__ = (
"Stream",
"class_by_prefix",
"proto_handled",
"parse_message",
"probe_buffer",
- "proto_name",
"DecodeError",
"Respond",
- "LK",
)
+MODNAME = __name__.split(".")[-1]
PROTO_PREFIX = "BS:"
### Deframer ###
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
### 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)
return lx
-class MetaPkt(type):
- """
- For each class corresponding to a message, automatically create
- two nested classes `In` and `Out` that also inherit from their
- "nest". Class attribute `IN_KWARGS` defined in the "nest" is
- copied to the `In` nested class under the name `KWARGS`, and
- likewise, `OUT_KWARGS` of the nest class is copied as `KWARGS`
- to the nested class `Out`. In addition, method `encode` is
- defined in both classes equal to `in_encode()` and `out_encode()`
- respectively.
- """
-
- if TYPE_CHECKING:
-
- def __getattr__(self, name: str) -> Any:
- pass
-
- def __setattr__(self, name: str, value: Any) -> None:
- pass
-
- def __new__(
- cls: Type["MetaPkt"],
- name: str,
- bases: Tuple[type, ...],
- attrs: Dict[str, Any],
- ) -> "MetaPkt":
- newcls = super().__new__(cls, name, bases, attrs)
- newcls.In = super().__new__(
- cls,
- name + ".In",
- (newcls,) + bases,
- {
- "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,
- "decode": newcls.out_decode,
- "encode": newcls.out_encode,
- },
- )
- return newcls
-
-
class Respond(Enum):
NON = 0 # Incoming, no response needed
INL = 1 # Birirectional, use `inline_response()`
EXT = 2 # Birirectional, use external responder
-class BeeSurePkt(metaclass=MetaPkt):
+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], ...] = ()
# 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()
pass
-class LK(BeeSurePkt):
- RESPOND = Respond.INL
-
- def in_decode(self, *args: str) -> None:
- numargs = len(args)
- if numargs > 0:
- self.step = args[0]
- if numargs > 1:
- self.tumbling_number = args[1]
- if numargs > 2:
- self.battery_percentage = args[2]
-
- def in_encode(self) -> str:
- return "LK"
-
-
-class CONFIG(BeeSurePkt):
- pass
-
+class _SET_PHONE(BeeSurePkt):
+ OUT_KWARGS = (("phonenumber", str, ""),)
-class ICCID(BeeSurePkt):
- pass
+ def out_encode(self) -> str:
+ self.phonenumber: str
+ return self.phonenumber
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),
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 = [
self.latitude = p.lat * p.nors
self.longitude = p.lon * p.eorw
+ 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,
+ altitude=self.altitude,
+ speed=self.speed,
+ direction=self.direction,
+ latitude=self.latitude,
+ longitude=self.longitude,
+ )
+ else:
+ return MODNAME, HintReport(
+ devtime=str(self.devtime),
+ battery_percentage=self.battery_percentage,
+ mcc=self.mcc,
+ mnc=self.mnc,
+ gsm_cells=self.gsm_cells,
+ wifi_aps=self.wifi_aps,
+ )
-class UD(_LOC_DATA):
- pass
+class AL(_LOC_DATA):
+ RESPOND = Respond.INL
-class UD2(_LOC_DATA):
+
+class CALL(_SET_PHONE):
pass
-class TKQ(BeeSurePkt):
- RESPOND = Respond.INL
+class CENTER(_SET_PHONE):
+ pass
-class TKQ2(BeeSurePkt):
- RESPOND = Respond.INL
+class CONFIG(BeeSurePkt):
+ pass
-class AL(_LOC_DATA):
- RESPOND = Respond.INL
+class CR(BeeSurePkt):
+ pass
-class CR(BeeSurePkt):
+class FIND(BeeSurePkt):
pass
return str(self.number)
+class ICCID(BeeSurePkt):
+ pass
+
+
+class LK(BeeSurePkt):
+ RESPOND = Respond.INL
+
+ def in_decode(self, *args: str) -> None:
+ numargs = len(args)
+ if numargs > 0:
+ self.step = args[0]
+ if numargs > 1:
+ self.tumbling_number = args[1]
+ if numargs > 2:
+ self.battery_percentage = args[2]
+
+ def in_encode(self) -> str:
+ 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, ""),)
+
+ def out_encode(self) -> str:
+ 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, []),
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
class TK(BeeSurePkt):
+ BINARY = True
RESPOND = Respond.INL
def in_decode(self, *args: Any) -> None:
return "1" # 0 - receive failure, 1 - receive success
+class TKQ(BeeSurePkt):
+ RESPOND = Respond.INL
+
+
+class TKQ2(BeeSurePkt):
+ RESPOND = Respond.INL
+
+
+class UD(_LOC_DATA):
+ pass
+
+
+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!
return proto.startswith(PROTO_PREFIX)
-def proto_name(obj: Union[MetaPkt, 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]:
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:
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:
def exposed_protos() -> List[Tuple[str, bool]]:
return [
- (proto_name(UD), True),
- (proto_name(UD2), 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
projects / loctrkd.git / blobdiff