swarmit 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

testbed/swarmit/protocol.py

@@ -0,0 +1,292 @@
+"""Swarmit protocol definition."""
+
+import dataclasses
+from dataclasses import dataclass
+from enum import Enum, IntEnum
+
+from dotbot.protocol import Packet, PacketFieldMetadata, register_parser
+
+
+class StatusType(Enum):
+    """Types of device status."""
+
+    Bootloader = 0
+    Running = 1
+    Stopping = 2
+    Resetting = 3
+
+
+class SwarmitPayloadType(IntEnum):
+    """Types of DotBot payload types."""
+
+    # Requests
+    SWARMIT_REQUEST_STATUS = 0x80
+    SWARMIT_REQUEST_START = 0x81
+    SWARMIT_REQUEST_STOP = 0x82
+    SWARMIT_REQUEST_RESET = 0x83
+    SWARMIT_REQUEST_OTA_START = 0x84
+    SWARMIT_REQUEST_OTA_CHUNK = 0x85
+
+    # Notifications
+    SWARMIT_NOTIFICATION_STATUS = 0x90
+    SWARMIT_NOTIFICATION_STARTED = 0x91
+    SWARMIT_NOTIFICATION_STOPPED = 0x92
+    SWARMIT_NOTIFICATION_OTA_START_ACK = 0x93
+    SWARMIT_NOTIFICATION_OTA_CHUNK_ACK = 0x94
+    SWARMIT_NOTIFICATION_EVENT_GPIO = 0x95
+    SWARMIT_NOTIFICATION_EVENT_LOG = 0x96
+
+    # Custom messages
+    SWARMIT_MESSAGE = 0xA0
+
+
+# Requests
+
+
+@dataclass
+class PayloadRequest(Packet):
+    """Dataclass that holds an application request packet (start/stop/status)."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+
+
+@dataclass
+class PayloadStatusRequest(PayloadRequest):
+    """Dataclass that holds an application status request packet."""
+
+
+@dataclass
+class PayloadStartRequest(PayloadRequest):
+    """Dataclass that holds an application start request packet."""
+
+
+@dataclass
+class PayloadStopRequest(PayloadRequest):
+    """Dataclass that holds an application stop request packet."""
+
+
+@dataclass
+class PayloadResetRequest(Packet):
+    """Dataclass that holds an application reset request packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+            PacketFieldMetadata(name="pos_x", length=4),
+            PacketFieldMetadata(name="pos_y", length=4),
+        ]
+    )
+
+    device_id: int = 0
+    pos_x: int = 0
+    pos_y: int = 0
+
+
+@dataclass
+class PayloadOTAStartRequest(Packet):
+    """Dataclass that holds an OTA start packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+            PacketFieldMetadata(name="fw_length", disp="len.", length=4),
+            PacketFieldMetadata(
+                name="fw_chunk_counts", disp="chunks", length=4
+            ),
+            PacketFieldMetadata(
+                name="fw_hash", disp="hash.", type_=bytes, length=32
+            ),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+    fw_length: int = 0
+    fw_chunk_count: int = 0
+    fw_hash: bytes = dataclasses.field(default_factory=lambda: bytearray)
+
+
+@dataclass
+class PayloadOTAChunkRequest(Packet):
+    """Dataclass that holds an OTA chunk packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+            PacketFieldMetadata(name="index", disp="idx", length=4),
+            PacketFieldMetadata(name="count", disp="size"),
+            PacketFieldMetadata(name="chunk", type_=bytes, length=0),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+    index: int = 0
+    count: int = 0
+    chunk: bytes = dataclasses.field(default_factory=lambda: bytearray)
+
+
+# Notifications
+
+
+@dataclass
+class PayloadStatusNotification(Packet):
+    """Dataclass that holds an application status notification packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+            PacketFieldMetadata(name="status", disp="st."),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+    status: StatusType = StatusType.Bootloader
+
+
+@dataclass
+class PayloadStartedNotification(Packet):
+    """Dataclass that holds an application started notification packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+
+
+@dataclass
+class PayloadStoppedNotification(Packet):
+    """Dataclass that holds an application stopped notification packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+
+
+@dataclass
+class PayloadOTAStartAckNotification(Packet):
+    """Dataclass that holds an application OTA start ACK notification packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+
+
+@dataclass
+class PayloadOTAChunkAckNotification(Packet):
+    """Dataclass that holds an application OTA chunk ACK notification packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+            PacketFieldMetadata(name="index", disp="idx", length=4),
+            PacketFieldMetadata(name="hashes_match", disp="match"),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+    index: int = 0
+    hashes_match: int = 0
+
+
+@dataclass
+class PayloadEventNotification(Packet):
+    """Dataclass that holds an event notification packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+            PacketFieldMetadata(name="timestamp", disp="ts", length=4),
+            PacketFieldMetadata(name="count", disp="len."),
+            PacketFieldMetadata(
+                name="data", disp="data", type_=bytes, length=0
+            ),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+    timestamp: int = 0
+    count: int = 0
+    data: bytes = dataclasses.field(default_factory=lambda: bytearray)
+
+
+@dataclass
+class PayloadMessage(Packet):
+    """Dataclass that holds a message packet."""
+
+    metadata: list[PacketFieldMetadata] = dataclasses.field(
+        default_factory=lambda: [
+            PacketFieldMetadata(name="device_id", disp="id", length=8),
+            PacketFieldMetadata(name="count", disp="len."),
+            PacketFieldMetadata(
+                name="message", disp="msg", type_=bytes, length=0
+            ),
+        ]
+    )
+
+    device_id: int = 0x0000000000000000
+    count: int = 0
+    message: bytes = dataclasses.field(default_factory=lambda: bytearray)
+
+
+def register_parsers():
+    # Register all swarmit specific parsers at module level
+    register_parser(
+        SwarmitPayloadType.SWARMIT_REQUEST_STATUS,
+        PayloadStatusRequest,
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_REQUEST_START, PayloadStartRequest
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_REQUEST_STOP, PayloadStopRequest
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_REQUEST_RESET, PayloadResetRequest
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_REQUEST_OTA_START, PayloadOTAStartRequest
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_REQUEST_OTA_CHUNK, PayloadOTAChunkRequest
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_NOTIFICATION_STATUS,
+        PayloadStatusNotification,
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_NOTIFICATION_STARTED,
+        PayloadStartedNotification,
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_NOTIFICATION_STOPPED,
+        PayloadStoppedNotification,
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_NOTIFICATION_OTA_START_ACK,
+        PayloadOTAStartAckNotification,
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_NOTIFICATION_OTA_CHUNK_ACK,
+        PayloadOTAChunkAckNotification,
+    )
+    register_parser(
+        SwarmitPayloadType.SWARMIT_NOTIFICATION_EVENT_LOG,
+        PayloadEventNotification,
+    )
+    register_parser(SwarmitPayloadType.SWARMIT_MESSAGE, PayloadMessage)

swarmit-0.2.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-testbed/cli/main.py,sha256=_mZJx_W549A_5FVMylU0jNXvCG_6cAcDj2fRMAoU65o,19689
-swarmit-0.2.0.dist-info/METADATA,sha256=OkItUGFQ29DNW2xHUkOZLwYG0Mj9smwnmY9vjIlAt2Q,3279
-swarmit-0.2.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-swarmit-0.2.0.dist-info/entry_points.txt,sha256=R6BGQe6I1FcI5B2jo7Dr-Gh6-Rjn1Ykx3uAGuV5rVTo,50
-swarmit-0.2.0.dist-info/licenses/AUTHORS,sha256=o2cH3J5JkbZssK_1zYj0m8PHiGiILV0lySR6_hoWKK0,45
-swarmit-0.2.0.dist-info/licenses/LICENSE,sha256=j97C1uBc5chpQWi4bv_2SrqExuvKaJK2Ch6L2LFkoc4,1492
-swarmit-0.2.0.dist-info/RECORD,,