Source code for mwings.parsers.app_cue_pal_event

# -*- coding:utf-8 -*-
# Written for Python 3.12
# Formatted with Black

# Packet parser for App_CUE (PAL Move or Dice mode)

from datetime import datetime
from typing import Any, final

from overrides import override
from pydantic import Field, field_serializer

from .. import common


[docs] @final class ParsedPacket(common.ParsedPacketBase): """Dataclass for parsed packets from App_CUE (PAL Move or Dice mode) Attributes ---------- ai1_voltage: common.UInt16 Voltage for AI1 port in mV accel_event: common.AccelEvent Accel event """ ai1_voltage: common.UInt16 = Field(default=0, ge=0, le=3700) accel_event: common.AccelEvent = Field(default=common.AccelEvent.NONE)
[docs] @field_serializer("accel_event") def serialize_accel_event(self, accel_event: common.AccelEvent) -> str: """Print accel_event in readable names for JSON or something Parameters ---------- accel_event : common.AccelEvent Accel event Returns ------- str Serialized text for JSON or something """ return accel_event.name
[docs] @final class PacketParser(common.PacketParserBase): """Packet parser for App_CUE (PAL Move or Dice mode)"""
[docs] @staticmethod @override def is_valid(bare_packet: common.BarePacket) -> bool: """Check the given bare packet is valid or not Parameters ---------- bare_packet : common.BarePacket Bare packet content Returns ------- bool True if valid Notes ----- Static overridden method """ if ( (bare_packet.u8_at(0) & 0x80) == 0x80 and (bare_packet.u8_at(7) & 0x80) == 0x80 and bare_packet.u8_at(12) == 0x80 and bare_packet.u8_at(13) == 0x03 and len(bare_packet.payload) == 43 ): return True return False
[docs] @staticmethod @override def parse(bare_packet: common.BarePacket) -> ParsedPacket | None: """Try to parse the given bare packet Parameters ---------- bare_packet : common.BarePacket Bare packet content Returns ------- ParsedPacket | None Parsed packet data if valid else None Notes ----- Static overridden method """ if not PacketParser.is_valid(bare_packet): return None parsed_packet_data: dict[str, Any] = { "time_parsed": datetime.now(common.Timezone), "packet_type": common.PacketType.APP_CUE_PAL_EVENT, "sequence_number": bare_packet.u16_at(5), "source_serial_id": bare_packet.u32_at(7), "source_logical_id": bare_packet.u8_at(11), "lqi": bare_packet.u8_at(4), "supply_voltage": bare_packet.u16_at(34), "ai1_voltage": bare_packet.u16_at(40), "accel_event": common.AccelEvent( bare_packet.u8_at(26) if bare_packet.u8_at(24) == 0x04 else 0xFF ), } return ParsedPacket(**parsed_packet_data)