Eiger exts logic

.vscode/launch.json

@@ -4,6 +4,18 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "Eiger",
+            "type": "python",
+            "request": "launch",
+            "module": "tickit",
+            "justMyCode": false,
+            "console": "integratedTerminal",
+            "args": [
+                "all",
+                "examples/configs/eiger/eiger.yaml"
+            ]
+        },
         {
             "name": "Debug Unit Test",
             "type": "python",

pyproject.toml

@@ -12,9 +12,11 @@ classifiers = [
 ]
 description = "Devices for tickit, an event-based device simulation framework"
 dependencies = [
-    "tickit<0.2.3",
+    "tickit==0.2.3",
     "typing_extensions",
     "softioc",
+    "pydantic>1",
+    "apischema"
 ] 
 dynamic = ["version"]
 license.file = "LICENSE"

src/tickit_devices/eiger/__init__.py

@@ -22,6 +22,6 @@ def __call__(self) -> Component:  # noqa: D102
             device=EigerDevice(),
             adapters=[
                 EigerRESTAdapter(host=self.host, port=self.port),
-                EigerZMQAdapter(zmq_host=self.zmq_host, zmq_port=self.zmq_port),
+                EigerZMQAdapter(host=self.zmq_host, port=self.zmq_port),
             ],
         )

src/tickit_devices/eiger/data/dummy_image.py

@@ -1,6 +1,5 @@
 from dataclasses import dataclass
-from pathlib import Path
-from typing import List
+from typing import List, Tuple
 
 
 @dataclass
@@ -12,9 +11,10 @@ class Image:
     dtype: str
     data: bytes
     encoding: str
+    shape: Tuple[int, int]
 
     @classmethod
-    def create_dummy_image(cls, index: int) -> "Image":
+    def create_dummy_image(cls, index: int, shape: Tuple[int, int]) -> "Image":
         """Returns an Image object wrapping the dummy blob using the metadata provided.
 
         Args:
@@ -27,7 +27,7 @@ def create_dummy_image(cls, index: int) -> "Image":
         hsh = str(hash(data))
         dtype = "uint16"
         encoding = "bs16-lz4<"
-        return Image(index, hsh, dtype, data, encoding)
+        return Image(index, hsh, dtype, data, encoding, shape)
 
 
 _DUMMY_IMAGE_BLOBS: List[bytes] = []
@@ -44,8 +44,7 @@ def dummy_image_blob() -> bytes:
     """
     if not _DUMMY_IMAGE_BLOBS:
         with open(
-            Path(Path(__file__).parent.parent, "resources", "frame_sample"),
-            "rb",
+            "src/tickit_devices/eiger/resources/frame_sample", "rb"
         ) as frame_file:
             _DUMMY_IMAGE_BLOBS.append(frame_file.read())
     return _DUMMY_IMAGE_BLOBS[0]

src/tickit_devices/eiger/data/schema.py

@@ -0,0 +1,73 @@
+from typing import Any, Dict, Iterable, Tuple, Union
+
+from pydantic.v1 import BaseModel
+from zmq import Frame
+
+Json = Dict[str, Any]
+Sendable = Union[bytes, Frame, memoryview]
+MultipartMessage = Iterable[Sendable]
+
+DEFAULT_HEADER_TYPE = "dheader-1.0"
+
+
+class AcquisitionSeriesHeader(BaseModel):
+    """Sent before a series of images (and associated headers)."""
+
+    header_detail: str
+    series: int
+    htype: str = DEFAULT_HEADER_TYPE
+
+
+class AcquisitionSeriesFooter(BaseModel):
+    """Sent at the end of a series of images (and associated headers)."""
+
+    series: int
+    htype: str = "dseries_end-1.0"
+
+
+class AcquisitionDetailsHeader(BaseModel):
+    """Describes an additional dataset sent at the beginning of a series.
+
+    Used when header_detail is set to all in AcquisitionSeriesHeader.
+    """
+
+    htype: str = DEFAULT_HEADER_TYPE
+    shape: Tuple[int, int]
+    type: str
+
+
+class ImageHeader(BaseModel):
+    """Sent before a detector image blob.
+
+    Metadata about the acquisition operation.
+    """
+
+    frame: int
+    hash: str
+    series: int
+    htype: str = "dimage-1.0"
+
+
+class ImageCharacteristicsHeader(BaseModel):
+    """Sent before a detector image blob.
+
+    Metadata about the image.
+    """
+
+    encoding: str
+    shape: Tuple[int, int]
+    size: int
+    type: str
+    htype: str = "dimage_d-1.0"
+
+
+class ImageConfigHeader(BaseModel):
+    """Sent before a detector image blob.
+
+    Describes the metrics on the image acquisition.
+    """
+
+    real_time: float
+    start_time: float
+    stop_time: float
+    htype: str = "dconfig-1.0"