Convert annotations to match odin PVI

Author: shihab-dls

src/ophyd_async/fastcs/odin/_odin_io.py

@@ -12,9 +12,10 @@
     PathProvider,
     SignalR,
     SignalRW,
+    SignalW,
     StrictEnum,
     observe_value,
-    set_and_wait_for_value,
+    set_and_wait_for_other_value,
 )
 from ophyd_async.fastcs.core import fastcs_connector
 
@@ -29,17 +30,18 @@ class OdinNode(Device):
 
 
 class OdinHdfIO(Device):
-    capture: SignalRW[Writing]
-    num_captured: SignalR[int]
-    num_to_capture: SignalRW[int]
-    image_height: SignalRW[int]
-    image_width: SignalRW[int]
-    num_row_chunks: SignalRW[int]
-    num_col_chunks: SignalRW[int]
-    num_frames_chunks: SignalRW[int]
-    file_path: SignalRW[str]
-    file_name: SignalRW[str]
-    data_type: SignalRW[str]
+    writing: SignalR[Writing]
+    config_hdf_write: SignalW[Writing]
+    frames_written: SignalR[int]
+    config_hdf_frames: SignalRW[int]
+    dataset_data_dims_0: SignalRW[int]
+    dataset_data_dims_1: SignalRW[int]
+    dataset_data_chunks_0: SignalRW[int]
+    dataset_data_chunks_1: SignalRW[int]
+    dataset_data_chunks_2: SignalRW[int]
+    config_hdf_file_path: SignalRW[str]
+    config_hdf_file_prefix: SignalRW[str]
+    dataset_data_datatype: SignalRW[str]
     nodes = DeviceVector[OdinNode]
 
     def __init__(self, uri: str, name: str = ""):
@@ -62,26 +64,27 @@ async def open(self, multiplier: int = 1) -> dict[str, DataKey]:
         info = self._path_provider(device_name=self._name_provider())
 
         await asyncio.gather(
-            self._drv.file_path.set(str(info.directory_path)),
-            self._drv.file_name.set(info.filename),
-            self._drv.data_type.set(
+            self._drv.config_hdf_file_path.set(str(info.directory_path)),
+            self._drv.config_hdf_file_prefix.set(info.filename),
+            self._drv.dataset_data_datatype.set(
                 "uint16"
             ),  # TODO: Get from eiger https://github.com/bluesky/ophyd-async/issues/529
-            self._drv.num_to_capture.set(0),
+            self._drv.config_hdf_frames.set(0),
         )
 
-        await self._drv.capture.set(Writing.ON)
+        await self._drv.config_hdf_write.set(Writing.ON)
 
         return await self._describe()
 
     async def _describe(self) -> dict[str, DataKey]:
         data_shape = await asyncio.gather(
-            self._drv.image_height.get_value(), self._drv.image_width.get_value()
+            self._drv.dataset_data_dims_0.get_value(),
+            self._drv.dataset_data_dims_1.get_value(),
         )
 
         return {
             "data": DataKey(
-                source=self._drv.file_name.source,
+                source=self._drv.config_hdf_file_prefix.source,
                 shape=list(data_shape),
                 dtype="array",
                 # TODO: Use correct type based on eiger https://github.com/bluesky/ophyd-async/issues/529
@@ -93,15 +96,17 @@ async def _describe(self) -> dict[str, DataKey]:
     async def observe_indices_written(
         self, timeout: float
     ) -> AsyncGenerator[int, None]:
-        async for num_captured in observe_value(self._drv.num_captured, timeout):
+        async for num_captured in observe_value(self._drv.frames_written, timeout):
             yield num_captured
 
     async def get_indices_written(self) -> int:
-        return await self._drv.num_captured.get_value()
+        return await self._drv.frames_written.get_value()
 
     def collect_stream_docs(self, indices_written: int) -> AsyncIterator[StreamAsset]:
         # TODO: Correctly return stream https://github.com/bluesky/ophyd-async/issues/530
         raise NotImplementedError()
 
     async def close(self) -> None:
-        await set_and_wait_for_value(self._drv.capture, Writing.OFF)
+        await set_and_wait_for_other_value(
+            self._drv.config_hdf_write, Writing.OFF, self._drv.writing, Writing.OFF
+        )

tests/fastcs/odin/test_odin_io.py

@@ -29,8 +29,12 @@ async def test_when_open_called_then_file_correctly_set(
 
     await writer.open()
 
-    get_mock_put(driver.file_path).assert_called_once_with(str(tmp_path), wait=ANY)
-    get_mock_put(driver.file_name).assert_called_once_with(expected_filename, wait=ANY)
+    get_mock_put(driver.config_hdf_file_path).assert_called_once_with(
+        str(tmp_path), wait=ANY
+    )
+    get_mock_put(driver.config_hdf_file_prefix).assert_called_once_with(
+        expected_filename, wait=ANY
+    )
 
 
 async def test_when_open_called_then_all_expected_signals_set(
@@ -39,18 +43,20 @@ async def test_when_open_called_then_all_expected_signals_set(
     driver, writer = odin_driver_and_writer
     await writer.open()
 
-    get_mock_put(driver.data_type).assert_called_once_with("uint16", wait=ANY)
-    get_mock_put(driver.num_to_capture).assert_called_once_with(0, wait=ANY)
+    get_mock_put(driver.dataset_data_datatype).assert_called_once_with(
+        "uint16", wait=ANY
+    )
+    get_mock_put(driver.config_hdf_frames).assert_called_once_with(0, wait=ANY)
 
-    get_mock_put(driver.capture).assert_called_once_with(Writing.ON, wait=ANY)
+    get_mock_put(driver.config_hdf_write).assert_called_once_with(Writing.ON, wait=ANY)
 
 
 async def test_given_data_shape_set_when_open_called_then_describe_has_correct_shape(
     odin_driver_and_writer: OdinDriverAndWriter,
 ):
     driver, writer = odin_driver_and_writer
-    set_mock_value(driver.image_width, 1024)
-    set_mock_value(driver.image_height, 768)
+    set_mock_value(driver.dataset_data_dims_1, 1024)
+    set_mock_value(driver.dataset_data_dims_0, 768)
     description = await writer.open()
     assert description["data"]["shape"] == [768, 1024]
 
@@ -60,4 +66,4 @@ async def test_when_closed_then_data_capture_turned_off(
 ):
     driver, writer = odin_driver_and_writer
     await writer.close()
-    get_mock_put(driver.capture).assert_called_once_with(Writing.OFF, wait=ANY)
+    get_mock_put(driver.config_hdf_write).assert_called_once_with(Writing.OFF, wait=ANY)