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

testbed/swarmit/protocol.py

@@ -4,7 +4,7 @@ import dataclasses
 from dataclasses import dataclass
 from enum import Enum, IntEnum
 
-from dotbot.protocol import Packet, PacketFieldMetadata, register_parser
+from dotbot.protocol import Payload, PayloadFieldMetadata, register_parser
 
 
 class StatusType(Enum):
@@ -14,6 +14,7 @@ class StatusType(Enum):
     Running = 1
     Stopping = 2
     Resetting = 3
+    Programming = 4
 
 
 class SwarmitPayloadType(IntEnum):
@@ -29,8 +30,6 @@ class SwarmitPayloadType(IntEnum):
 
     # 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
@@ -44,17 +43,13 @@ class SwarmitPayloadType(IntEnum):
 
 
 @dataclass
-class PayloadRequest(Packet):
+class PayloadRequest(Payload):
     """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),
-        ]
+    metadata: list[PayloadFieldMetadata] = dataclasses.field(
+        default_factory=lambda: []
     )
 
-    device_id: int = 0x0000000000000000
-
 
 @dataclass
 class PayloadStatusRequest(PayloadRequest):
@@ -72,61 +67,53 @@ class PayloadStopRequest(PayloadRequest):
 
 
 @dataclass
-class PayloadResetRequest(Packet):
+class PayloadResetRequest(Payload):
     """Dataclass that holds an application reset request packet."""
 
-    metadata: list[PacketFieldMetadata] = dataclasses.field(
+    metadata: list[PayloadFieldMetadata] = 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),
+            PayloadFieldMetadata(name="pos_x", length=4),
+            PayloadFieldMetadata(name="pos_y", length=4),
         ]
     )
 
-    device_id: int = 0
     pos_x: int = 0
     pos_y: int = 0
 
 
 @dataclass
-class PayloadOTAStartRequest(Packet):
+class PayloadOTAStartRequest(Payload):
     """Dataclass that holds an OTA start packet."""
 
-    metadata: list[PacketFieldMetadata] = dataclasses.field(
+    metadata: list[PayloadFieldMetadata] = dataclasses.field(
         default_factory=lambda: [
-            PacketFieldMetadata(name="device_id", disp="id", length=8),
-            PacketFieldMetadata(name="fw_length", disp="len.", length=4),
-            PacketFieldMetadata(
+            PayloadFieldMetadata(name="fw_length", disp="len.", length=4),
+            PayloadFieldMetadata(
                 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):
+class PayloadOTAChunkRequest(Payload):
     """Dataclass that holds an OTA chunk packet."""
 
-    metadata: list[PacketFieldMetadata] = dataclasses.field(
+    metadata: list[PayloadFieldMetadata] = 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),
+            PayloadFieldMetadata(name="index", disp="idx", length=4),
+            PayloadFieldMetadata(name="count", disp="size"),
+            PayloadFieldMetadata(name="sha", type_=bytes, length=8),
+            PayloadFieldMetadata(name="chunk", type_=bytes, length=0),
         ]
     )
 
-    device_id: int = 0x0000000000000000
     index: int = 0
     count: int = 0
+    sha: bytes = dataclasses.field(default_factory=lambda: bytearray)
     chunk: bytes = dataclasses.field(default_factory=lambda: bytearray)
 
 
@@ -134,112 +121,72 @@ class PayloadOTAChunkRequest(Packet):
 
 
 @dataclass
-class PayloadStatusNotification(Packet):
+class PayloadStatusNotification(Payload):
     """Dataclass that holds an application status notification packet."""
 
-    metadata: list[PacketFieldMetadata] = dataclasses.field(
+    metadata: list[PayloadFieldMetadata] = dataclasses.field(
         default_factory=lambda: [
-            PacketFieldMetadata(name="device_id", disp="id", length=8),
-            PacketFieldMetadata(name="status", disp="st."),
+            PayloadFieldMetadata(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):
+class PayloadOTAStartAckNotification(Payload):
     """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),
-        ]
+    metadata: list[PayloadFieldMetadata] = dataclasses.field(
+        default_factory=lambda: []
     )
 
-    device_id: int = 0x0000000000000000
-
 
 @dataclass
-class PayloadOTAChunkAckNotification(Packet):
+class PayloadOTAChunkAckNotification(Payload):
     """Dataclass that holds an application OTA chunk ACK notification packet."""
 
-    metadata: list[PacketFieldMetadata] = dataclasses.field(
+    metadata: list[PayloadFieldMetadata] = 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"),
+            PayloadFieldMetadata(name="index", disp="idx", length=4),
         ]
     )
 
-    device_id: int = 0x0000000000000000
     index: int = 0
-    hashes_match: int = 0
 
 
 @dataclass
-class PayloadEventNotification(Packet):
+class PayloadEventNotification(Payload):
     """Dataclass that holds an event notification packet."""
 
-    metadata: list[PacketFieldMetadata] = dataclasses.field(
+    metadata: list[PayloadFieldMetadata] = 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(
+            PayloadFieldMetadata(name="timestamp", disp="ts", length=4),
+            PayloadFieldMetadata(name="count", disp="len."),
+            PayloadFieldMetadata(
                 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):
+class PayloadMessage(Payload):
     """Dataclass that holds a message packet."""
 
-    metadata: list[PacketFieldMetadata] = dataclasses.field(
+    metadata: list[PayloadFieldMetadata] = dataclasses.field(
         default_factory=lambda: [
-            PacketFieldMetadata(name="device_id", disp="id", length=8),
-            PacketFieldMetadata(name="count", disp="len."),
-            PacketFieldMetadata(
+            PayloadFieldMetadata(name="count", disp="len."),
+            PayloadFieldMetadata(
                 name="message", disp="msg", type_=bytes, length=0
             ),
         ]
     )
 
-    device_id: int = 0x0000000000000000
     count: int = 0
     message: bytes = dataclasses.field(default_factory=lambda: bytearray)
 
@@ -269,14 +216,6 @@ def register_parsers():
         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,

swarmit-0.3.0.dist-info/METADATA

@@ -1,101 +0,0 @@
-Metadata-Version: 2.4
-Name: swarmit
-Version: 0.3.0
-Summary: Run Your Own Robot Swarm Testbed.
-Project-URL: Homepage, https://github.com/DotBots/swarmit
-Project-URL: Bug Tracker, https://github.com/DotBots/swarmit/issues
-Author-email: Alexandre Abadie <alexandre.abadie@inria.fr>
-License: BSD
-License-File: AUTHORS
-License-File: LICENSE
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: MacOS
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.7
-Requires-Dist: click==8.1.7
-Requires-Dist: cryptography==43.0.1
-Requires-Dist: paho-mqtt>=2.1.0
-Requires-Dist: pydotbot==0.22.0
-Requires-Dist: pyserial==3.5
-Requires-Dist: rich==13.8.1
-Requires-Dist: structlog==24.4.0
-Requires-Dist: tqdm==4.66.5
-Description-Content-Type: text/markdown
-
- # SwarmIT
-
- SwarmIT provides a embedded C port for nRF53 as well as Python based services to
- easily build and deploy a robotic swarm infrastructure testbed.
- ARM TrustZone is used to create a sandboxed user environment on each device
- under test, without requiring a control co-processor attached to it.
-
-## Features
-
-- Experiment management: start, stop, monitor and status check
-- Deploy a custom firmware on all or on a subset of robots of a swarm testbed
-- Resilient robot state: even when crashed by buggy user code, the robot can be reprogrammed remotely and wirelessly
-
-## Usage
-
-### Embedded C code
-
-SwarmIT embedded C code can be built using
-[Segger Embedded Studio (SES)](https://www.segger.com/products/development-tools/embedded-studio/).
-
-To provision a device, follow the following steps:
-1. open [netcore.emProject](device/network_core/netcore.emProject)
-and [bootloader.emProject](device/bootloader/bootloader.emProject) in SES
-2. build and load the netcore application on the nRF53 network core,
-3. build and load the bootloader application on the nRF53 application core.
-
-The device is now ready.
-
-### Gateway
-
-The communication between the computer and the swarm devices is performed via a
-gateway board connected via USB to the computer.
-The gateway board is a Nordic nRF53840DK.
-
-The firmware to run on the gateway can also be compiled and flash using SES.
-The SES project to open is located at [gateway.emProject](gateway/gateway.emProject).
-
-After flashing the gateway firmware, LED1 on the DK should blink fast during 1s.
-
-### Python CLI script
-
-The Python CLI script provides commands for flashing, starting and stopping user
-code on the device, as well as monitoring and checking the status of devices
-in the swarm.
-
-The Python CLI script connects via a virtual COM port to the gateway connected to
-the computer.
-
-The Python CLI script is available on PyPI. Install it using:
-
-```
-pip install swarmit
-```
-
-Default usage:
-
-```
-swarmit --help
-Usage: swarmit [OPTIONS] COMMAND [ARGS]...
-
-Options:
-  -p, --port TEXT         Serial port to use to send the bitstream to the
-                          gateway. Default: /dev/ttyACM0.
-  -b, --baudrate INTEGER  Serial port baudrate. Default: 1000000.
-  -d, --devices TEXT      Subset list of devices to interact with, separated
-                          with ,
-  --help                  Show this message and exit.
-
-Commands:
-  flash
-  monitor
-  start
-  status
-  stop
-```

swarmit-0.3.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-dotbot-firmware/doc/sphinx/conf.py,sha256=uQJVglqE9HoqMXJf5nbmCVCLSSGbqfiSr5ZQbE7HsLk,6211
-testbed/cli/main.py,sha256=FjGbeRkEKT48drOT79Tphfotl23lFV3RgNS_92fsnT4,10741
-testbed/swarmit/__init__.py,sha256=VrXpHDu3erkzwl_WXrqINBm9xWkcyUy53IQOj042dOs,22
-testbed/swarmit/adapter.py,sha256=jX3SJ_Z-cOqERa2Oh-KerzY-5eY6FFicbufGyDPapME,2899
-testbed/swarmit/controller.py,sha256=o0rXvLC-9gyizlz73kr4Q2YQ3Tk5dd5cCAxaoBShh04,21451
-testbed/swarmit/protocol.py,sha256=JOXUAGDBY2bI9exw7UMivtjm9a8hi0081_1s4haHx-4,8477
-swarmit-0.3.0.dist-info/METADATA,sha256=-9rqDCAmXS7WwCVOquKYvDcjJCo8YpY7OX9QQz7tSAY,3324
-swarmit-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-swarmit-0.3.0.dist-info/entry_points.txt,sha256=R6BGQe6I1FcI5B2jo7Dr-Gh6-Rjn1Ykx3uAGuV5rVTo,50
-swarmit-0.3.0.dist-info/licenses/AUTHORS,sha256=o2cH3J5JkbZssK_1zYj0m8PHiGiILV0lySR6_hoWKK0,45
-swarmit-0.3.0.dist-info/licenses/LICENSE,sha256=j97C1uBc5chpQWi4bv_2SrqExuvKaJK2Ch6L2LFkoc4,1492
-swarmit-0.3.0.dist-info/RECORD,,