"proto_handled",
"parse_message",
"probe_buffer",
- "proto_name",
"DecodeError",
"Respond",
)
### 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)
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()
class TK(BeeSurePkt):
+ BINARY = True
RESPOND = Respond.INL
def in_decode(self, *args: Any) -> None:
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 proto_of_message(packet: bytes) -> str:
return PROTO_PREFIX + packet[20:-1].split(b",")[0].decode()
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(cls)[:16], False)
+ (cls.proto_name(), False)
for cls in CLASSES.values()
if hasattr(cls, "rectified")
]