fix(flomni): save a gripper reference image at the empty/occupied checks #340

Merged
holler merged 2 commits from fix/flomni_store_ref_images into main 2026-10-26 14:13:50 +01:00
2 changed files with 99 additions and 4 deletions

No files matched your search

@@ -777,6 +777,7 @@ class FlomniSampleTransferMixin:
self.check_sensor_connected()
sample_in_gripper = dev.flomni_samples.is_sample_in_gripper()
self._ftransfer_capture_gripper_image(file_suffix="get_gripper_empty_check")
if sample_in_gripper:
raise FlomniError(
"The gripper does carry a sample. Cannot proceed getting another sample."
@@ -836,6 +837,7 @@ class FlomniSampleTransferMixin:
sample_in_gripper = dev.flomni_samples.is_sample_in_gripper()
# dev.flomni_samples.sample_in_gripper.get()
self._ftransfer_capture_gripper_image(file_suffix="put_gripper_occupied_check")
if not sample_in_gripper:
raise FlomniError("The gripper does not carry a sample.")
@@ -1117,16 +1119,25 @@ class FlomniSampleTransferMixin:
self.transfer_step += 1
if self.ftransfer_confirm_dialog("All OK? Continue?", "y"):
print("OK. continue.")
data = self.client.connector.get_last(
MessageEndpoints.device_preview("cam_flomni_gripper", "preview")
)["data"].data
self.save_reference_image(data, file_suffix=f"{step_name}_{self.transfer_step}")
self._ftransfer_capture_gripper_image(file_suffix=f"{step_name}_{self.transfer_step}")
dev.ftransy.controller.socket_put_confirmed("confirm=1")
else:
print("Stopping.")
self.ftransfer_abort()
raise FlomniError("User abort sample transfer.")
def _ftransfer_capture_gripper_image(self, file_suffix: str = ""):
"""Grab the latest gripper-camera preview and write it to disk via
save_reference_image(). Used at every gripper state decision point
(empty/occupied checks and the "All OK?" motion-loop confirms) so
the sample transfer log has a visual record of the gripper at each
step, not just the final confirm.
"""
data = self.client.connector.get_last(
MessageEndpoints.device_preview("cam_flomni_gripper", "preview")
)["data"].data
self.save_reference_image(data, file_suffix=file_suffix)
def save_reference_image(self, image: np.ndarray, file_suffix: str = ""):
suffix = f"_{file_suffix}_" or "_"
# Save the reference image to a file
@@ -0,0 +1,84 @@
"""Tests that flomni's gripper-empty/gripper-occupied sample-transfer
checks capture a gripper camera reference image, not just the final
"All OK?" confirm (see csaxs_bec/bec_ipython_client/plugins/omny/AI_docs/
OPEN_ISSUES.md, "flomni has no equivalent gate to save at").
Uses a bare FlomniSampleTransferMixin instance (bypassing Flomni's heavy
__init__), same pattern as test_lamni_account_change_reset.py.
"""
import pytest
import csaxs_bec.bec_ipython_client.plugins.flomni.flomni as flomni_module
from csaxs_bec.bec_ipython_client.plugins.flomni.flomni import (
FlomniError,
FlomniSampleTransferMixin,
)
class FakeConnector:
def __init__(self, image):
self.image = image
self.requested_endpoints = []
def get_last(self, endpoint):
self.requested_endpoints.append(endpoint)
return {"data": type("Msg", (), {"data": self.image})()}
class FakeClient:
def __init__(self, image="gripper-cam-frame"):
self.connector = FakeConnector(image)
class FakeFlomniSamples:
def __init__(self, sample_in_gripper):
self._sample_in_gripper = sample_in_gripper
def is_sample_in_gripper(self):
return self._sample_in_gripper
class _FakeDev:
def __init__(self, sample_in_gripper):
self.flomni_samples = FakeFlomniSamples(sample_in_gripper)
def make_flomni(sample_in_gripper):
flomni_module.dev = _FakeDev(sample_in_gripper)
obj = object.__new__(FlomniSampleTransferMixin)
obj.client = FakeClient()
obj.check_tray_in = lambda: None
obj.check_sensor_connected = lambda: None
obj.saved_images = []
obj.save_reference_image = lambda image, file_suffix="": obj.saved_images.append(
(image, file_suffix)
)
return obj
def test_get_sample_captures_image_before_raising_when_gripper_occupied():
flomni = make_flomni(sample_in_gripper=True)
with pytest.raises(FlomniError, match="does carry a sample"):
flomni.ftransfer_get_sample(5)
assert flomni.saved_images == [("gripper-cam-frame", "get_gripper_empty_check")]
def test_put_sample_captures_image_before_raising_when_gripper_empty():
flomni = make_flomni(sample_in_gripper=False)
with pytest.raises(FlomniError, match="does not carry a sample"):
flomni.ftransfer_put_sample(5)
assert flomni.saved_images == [("gripper-cam-frame", "put_gripper_occupied_check")]
def test_capture_gripper_image_fetches_preview_and_saves_it():
flomni = make_flomni(sample_in_gripper=False)
flomni._ftransfer_capture_gripper_image(file_suffix="my_suffix")
assert flomni.saved_images == [("gripper-cam-frame", "my_suffix")]
assert flomni.client.connector.requested_endpoints