mx-bluesky 1.5.10__py3-none-any.whl → 1.5.12__py3-none-any.whl

mx_bluesky/{hyperion → common}/experiment_plans/pin_tip_centring_plan.py

@@ -4,7 +4,7 @@ import bluesky.plan_stubs as bps
 import pydantic
 from blueapi.core import BlueskyContext
 from bluesky.utils import Msg
-from dodal.devices.backlight import Backlight
+from dodal.devices.motors import XYZOmegaStage
 from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.oav_parameters import OAV_CONFIG_JSON, OAVParameters
 from dodal.devices.oav.pin_image_recognition import PinTipDetection, Tip
@@ -14,27 +14,26 @@ from dodal.devices.oav.utils import (
     get_move_required_so_that_beam_is_at_pixel,
     wait_for_tip_to_be_found,
 )
-from dodal.devices.smargon import Smargon
 
+from mx_bluesky.common.device_setup_plans.gonio import (
+    move_gonio_warn_on_out_of_range,
+)
 from mx_bluesky.common.device_setup_plans.setup_oav import pre_centring_setup_oav
+from mx_bluesky.common.parameters.constants import HardwareConstants
 from mx_bluesky.common.utils.context import device_composite_from_context
-from mx_bluesky.common.utils.exceptions import SampleException, catch_exception_and_warn
+from mx_bluesky.common.utils.exceptions import SampleError, catch_exception_and_warn
 from mx_bluesky.common.utils.log import LOGGER
-from mx_bluesky.hyperion.device_setup_plans.smargon import (
-    move_smargon_warn_on_out_of_range,
-)
-from mx_bluesky.hyperion.parameters.constants import CONST
 
 DEFAULT_STEP_SIZE = 0.5
+CONST = HardwareConstants()
 
 
 @pydantic.dataclasses.dataclass(config={"arbitrary_types_allowed": True})
 class PinTipCentringComposite:
     """All devices which are directly or indirectly required by this plan"""
 
-    backlight: Backlight
     oav: OAV
-    smargon: Smargon
+    gonio: XYZOmegaStage
     pin_tip_detection: PinTipDetection
 
 
@@ -53,7 +52,7 @@ def trigger_and_return_pin_tip(
 
 def move_pin_into_view(
     pin_tip_device: PinTipDetection,
-    smargon: Smargon,
+    gonio: XYZOmegaStage,
     step_magnitude_mm: float = DEFAULT_STEP_SIZE,
     max_steps: int = 2,
 ) -> Generator[Msg, None, Pixel]:
@@ -63,13 +62,13 @@ def move_pin_into_view(
 
     Args:
         pin_tip_device (PinTipDetection): The device being used to detect the pin
-        smargon (Smargon): The gonio to move the tip
+        gonio (XYZOmegaStage): The stage(gonio) to move the tip
         step_magnitude_mm (float, optional): Distance to move the gonio (in mm) for each
                                     step of the search. Defaults to 0.5.
         max_steps (int, optional): The number of steps to search with. Defaults to 2.
 
     Raises:
-        SampleException: Error if the pin tip is never found
+        SampleError: Error if the pin tip is never found
 
     Returns:
         Tuple[int, int]: The location of the pin tip in pixels
@@ -88,25 +87,25 @@ def move_pin_into_view(
         direction_multiple = -1 if tip_xy_px[0] == 0 else 1
         step_vector_mm = step_magnitude_mm * direction_multiple
 
-        smargon_x = yield from bps.rd(smargon.x.user_readback)
-        ideal_move_to_find_pin = float(smargon_x) + step_vector_mm
-        high_limit = yield from bps.rd(smargon.x.high_limit_travel)
-        low_limit = yield from bps.rd(smargon.x.low_limit_travel)
+        stage_x = yield from bps.rd(gonio.x.user_readback)
+        ideal_move_to_find_pin = float(stage_x) + step_vector_mm
+        high_limit = yield from bps.rd(gonio.x.high_limit_travel)
+        low_limit = yield from bps.rd(gonio.x.low_limit_travel)
         move_within_limits = max(min(ideal_move_to_find_pin, high_limit), low_limit)
         if move_within_limits != ideal_move_to_find_pin:
             LOGGER.warning(
                 f"Pin tip is off screen, and moving {step_vector_mm}mm would cross limits, "
                 f"moving to {move_within_limits} instead"
             )
-        yield from bps.mv(smargon.x, move_within_limits)
+        yield from bps.mv(gonio.x, move_within_limits)
 
         # Some time for the view to settle after the move
-        yield from bps.sleep(CONST.HARDWARE.OAV_REFRESH_DELAY)
+        yield from bps.sleep(CONST.OAV_REFRESH_DELAY)
 
     tip_xy_px = yield from trigger_and_return_pin_tip(pin_tip_device)
 
     if not pin_tip_valid(tip_xy_px):
-        raise SampleException(
+        raise SampleError(
             "Pin tip centring failed - pin too long/short/bent and out of range"
         )
     else:
@@ -127,7 +126,7 @@ def pin_tip_centre_plan(
                                     to be.
     """
     oav: OAV = composite.oav
-    smargon: Smargon = composite.smargon
+    gonio: XYZOmegaStage = composite.gonio
     oav_params = OAVParameters("pinTipCentring", oav_config_file)
 
     pin_tip_setup = composite.pin_tip_detection
@@ -139,10 +138,10 @@ def pin_tip_centre_plan(
     def offset_and_move(tip: Pixel):
         pixel_to_move_to = (tip[0] + tip_offset_px, tip[1])
         position_mm = yield from get_move_required_so_that_beam_is_at_pixel(
-            smargon, pixel_to_move_to, oav
+            gonio, pixel_to_move_to, oav
         )
         LOGGER.info(f"Tip centring moving to : {position_mm}")
-        yield from move_smargon_warn_on_out_of_range(smargon, position_mm)
+        yield from move_gonio_warn_on_out_of_range(gonio, position_mm)
 
     LOGGER.info(f"Tip offset in pixels: {tip_offset_px}")
 
@@ -152,10 +151,10 @@ def pin_tip_centre_plan(
 
     yield from pre_centring_setup_oav(oav, oav_params, pin_tip_setup)
 
-    tip = yield from move_pin_into_view(pin_tip_detect, smargon)
+    tip = yield from move_pin_into_view(pin_tip_detect, gonio)
     yield from offset_and_move(tip)
 
-    yield from bps.mvr(smargon.omega, -90)
+    yield from bps.mvr(gonio.omega, -90)
 
     # need to wait for the OAV image to update
     # See #673 for improvements

mx_bluesky/common/external_interaction/callbacks/common/grid_detection_callback.py

@@ -83,12 +83,17 @@ class GridDetectionCallback(CallbackBase):
         beam_x = data["oav-beam_centre_i"]
         beam_y = data["oav-beam_centre_j"]
 
+        x_direction = data["oav-x_direction"]
+        y_direction = data["oav-y_direction"]
+        z_direction = data["oav-z_direction"]
+
         position_grid_start_mm = calculate_x_y_z_of_pixel(
             current_xyz,
             smargon_omega,
             centre_of_first_box,
             (beam_x, beam_y),
             (microns_per_pixel_x, microns_per_pixel_y),
+            (x_direction, y_direction, z_direction),
         )
         LOGGER.info(f"Calculated start position {position_grid_start_mm}")
 

mx_bluesky/common/external_interaction/callbacks/common/ispyb_callback_base.py

@@ -5,14 +5,10 @@ from collections.abc import Callable, Sequence
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, TypeVar, cast
 
-from dodal.beamline_specific_utils.i03 import beam_size_from_aperture
 from dodal.devices.detector import DetectorParams
 from dodal.devices.detector.det_resolution import resolution
 from dodal.devices.synchrotron import SynchrotronMode
 
-from mx_bluesky.common.external_interaction.callbacks.common.logging_callback import (
-    format_doc_for_log,
-)
 from mx_bluesky.common.external_interaction.callbacks.common.plan_reactive_callback import (
     PlanReactiveCallback,
 )
@@ -28,8 +24,12 @@ from mx_bluesky.common.external_interaction.ispyb.ispyb_store import (
 from mx_bluesky.common.external_interaction.ispyb.ispyb_utils import get_ispyb_config
 from mx_bluesky.common.parameters.components import DiffractionExperimentWithSample
 from mx_bluesky.common.parameters.constants import DocDescriptorNames
-from mx_bluesky.common.utils.log import ISPYB_ZOCALO_CALLBACK_LOGGER, set_dcgid_tag
-from mx_bluesky.common.utils.utils import convert_eV_to_angstrom
+from mx_bluesky.common.utils.log import (
+    ISPYB_ZOCALO_CALLBACK_LOGGER,
+    format_doc_for_log,
+    set_dcgid_tag,
+)
+from mx_bluesky.common.utils.utils import convert_ev_to_angstrom
 
 D = TypeVar("D")
 if TYPE_CHECKING:
@@ -43,9 +43,9 @@ def _update_based_on_energy(
 ):
     """If energy has been read as part of this reading then add it into the data
     collection info along with the other fields that depend on it."""
-    if energy_kev := doc["data"].get("dcm-energy_in_kev", None):
+    if energy_kev := doc["data"].get("dcm-energy_in_keV", None):
         energy_ev = energy_kev * 1000
-        wavelength_angstroms = convert_eV_to_angstrom(energy_ev)
+        wavelength_angstroms = convert_ev_to_angstrom(energy_ev)
         data_collection_info.wavelength = wavelength_angstroms
         data_collection_info.resolution = resolution(
             detector_params,
@@ -147,18 +147,16 @@ class BaseISPyBCallback(PlanReactiveCallback):
         )
         return scan_data_infos
 
-    def _handle_ispyb_transmission_flux_read(self, doc) -> Sequence[ScanDataInfo]:
+    def _handle_ispyb_transmission_flux_read(
+        self, doc: Event
+    ) -> Sequence[ScanDataInfo]:
         assert self.params
         aperture = doc["data"]["aperture_scatterguard-selected_aperture"]
-        aperture_radius = doc["data"]["aperture_scatterguard-radius"]
-        beamsize = beam_size_from_aperture(aperture_radius)
-        beamsize_x_mm = beamsize.x_um / 1000 if beamsize.x_um else None
-        beamsize_y_mm = beamsize.y_um / 1000 if beamsize.y_um else None
+        beamsize_x_mm = doc["data"]["beamsize-x_um"] / 1000
+        beamsize_y_mm = doc["data"]["beamsize-y_um"] / 1000
         hwscan_data_collection_info = DataCollectionInfo(
             beamsize_at_samplex=beamsize_x_mm,
             beamsize_at_sampley=beamsize_y_mm,
-            focal_spot_size_at_samplex=beamsize_x_mm,
-            focal_spot_size_at_sampley=beamsize_y_mm,
             flux=doc["data"]["flux-flux_reading"],
         )
         if transmission := doc["data"]["attenuator-actual_transmission"]:

mx_bluesky/common/external_interaction/callbacks/common/ispyb_mapping.py

@@ -4,15 +4,14 @@ from mx_bluesky.common.external_interaction.ispyb.data_model import (
     DataCollectionGroupInfo,
     DataCollectionInfo,
 )
-from mx_bluesky.common.external_interaction.ispyb.ispyb_store import (
-    EIGER_FILE_SUFFIX,
-    I03_EIGER_DETECTOR,
-)
 from mx_bluesky.common.external_interaction.ispyb.ispyb_utils import (
     get_current_time_string,
 )
 from mx_bluesky.common.parameters.components import DiffractionExperimentWithSample
 
+I03_EIGER_DETECTOR = 78
+EIGER_FILE_SUFFIX = "h5"
+
 
 def populate_data_collection_group(params: DiffractionExperimentWithSample):
     dcg_info = DataCollectionGroupInfo(
@@ -31,7 +30,6 @@ def populate_remaining_data_collection_info(
 ):
     data_collection_info.visit_string = params.visit
     data_collection_info.parent_id = data_collection_group_id
-    data_collection_info.sample_id = params.sample_id
     data_collection_info.detector_id = I03_EIGER_DETECTOR
     data_collection_info.comments = comment
     data_collection_info.detector_distance = params.detector_params.detector_distance

mx_bluesky/common/external_interaction/callbacks/common/plan_reactive_callback.py

@@ -40,7 +40,7 @@ class PlanReactiveCallback(CallbackBase):
         self.log = log
 
     def _run_activity_gated(self, name: str, func, doc, override=False):
-        # Runs `func` if self.active is True or overide is true. Override can be used
+        # Runs `func` if self.active is True or override is true. Override can be used
         # to run the function even after setting self.active to False, i.e. in the last
         # handler of a run.
 

mx_bluesky/common/external_interaction/callbacks/common/zocalo_callback.py

@@ -9,7 +9,7 @@ from dodal.devices.zocalo import ZocaloStartInfo, ZocaloTrigger
 from mx_bluesky.common.parameters.constants import (
     DocDescriptorNames,
 )
-from mx_bluesky.common.utils.exceptions import ISPyBDepositionNotMade
+from mx_bluesky.common.utils.exceptions import ISPyBDepositionNotMadeError
 from mx_bluesky.common.utils.log import ISPYB_ZOCALO_CALLBACK_LOGGER
 
 if TYPE_CHECKING:
@@ -89,7 +89,7 @@ class ZocaloCallback(CallbackBase):
                 f"Zocalo handler received stop document, for run {doc.get('run_start')}."
             )
             if not self._started_zocalo_collections:
-                raise ISPyBDepositionNotMade(
+                raise ISPyBDepositionNotMadeError(
                     f"No ISPyB IDs received by the end of {self.triggering_plan=}"
                 )
             for info in self._started_zocalo_collections:

mx_bluesky/common/external_interaction/callbacks/sample_handling/sample_handling_callback.py

@@ -12,7 +12,7 @@ from mx_bluesky.common.external_interaction.ispyb.exp_eye_store import (
     BLSampleStatus,
     ExpeyeInteraction,
 )
-from mx_bluesky.common.utils.exceptions import CrystalNotFoundException, SampleException
+from mx_bluesky.common.utils.exceptions import CrystalNotFoundError, SampleError
 from mx_bluesky.common.utils.log import ISPYB_ZOCALO_CALLBACK_LOGGER
 
 
@@ -47,7 +47,7 @@ class SampleHandlingCallback(PlanReactiveCallback):
             expeye = ExpeyeInteraction()
             if doc["exit_status"] != "success":
                 reason = doc.get("reason", "")
-                exception_type, message = SampleException.type_and_message_from_reason(
+                exception_type, message = SampleError.type_and_message_from_reason(
                     reason
                 )
                 self.log.info(
@@ -83,7 +83,7 @@ class SampleHandlingCallback(PlanReactiveCallback):
 
     def _decode_sample_status(self, exception_type: str) -> BLSampleStatus:
         match exception_type:
-            case SampleException.__name__ | CrystalNotFoundException.__name__:
+            case SampleError.__name__ | CrystalNotFoundError.__name__:
                 return BLSampleStatus.ERROR_SAMPLE
         return BLSampleStatus.ERROR_BEAMLINE
 

mx_bluesky/common/external_interaction/callbacks/xray_centre/ispyb_callback.py

@@ -40,8 +40,8 @@ from mx_bluesky.common.parameters.components import DiffractionExperimentWithSam
 from mx_bluesky.common.parameters.constants import DocDescriptorNames, PlanNameConstants
 from mx_bluesky.common.parameters.gridscan import GridCommon
 from mx_bluesky.common.utils.exceptions import (
-    ISPyBDepositionNotMade,
-    SampleException,
+    ISPyBDepositionNotMadeError,
+    SampleError,
 )
 from mx_bluesky.common.utils.log import ISPYB_ZOCALO_CALLBACK_LOGGER, set_dcgid_tag
 from mx_bluesky.common.utils.utils import number_of_frames_from_scan_spec
@@ -87,7 +87,7 @@ class GridscanISPyBCallback(BaseISPyBCallback):
     To use, subscribe the Bluesky RunEngine to an instance of this class.
     E.g.:
         ispyb_handler_callback = FGSISPyBCallback(parameters)
-        RE.subscribe(ispyb_handler_callback)
+        run_engine.subscribe(ispyb_handler_callback)
     Or decorate a plan using bluesky.preprocessors.subs_decorator.
 
     See: https://blueskyproject.io/bluesky/callbacks.html#ways-to-invoke-callbacks
@@ -240,7 +240,7 @@ class GridscanISPyBCallback(BaseISPyBCallback):
             f"{y_steps} by {z_steps}."
         )
 
-        self._populate_axis_info(data_collection_info, omega)
+        self._populate_axis_info(data_collection_info, doc["data"])
 
         scan_data_info = ScanDataInfo(
             data_collection_info=data_collection_info,
@@ -254,15 +254,15 @@ class GridscanISPyBCallback(BaseISPyBCallback):
         self._oav_snapshot_event_idx += 1
         return [scan_data_info]
 
-    def _populate_axis_info(
-        self, data_collection_info: DataCollectionInfo, omega_start: float | None
-    ):
-        if omega_start is not None:
+    def _populate_axis_info(self, data_collection_info: DataCollectionInfo, doc: dict):
+        if (omega_start := doc.get("smargon-omega")) is not None:
             omega_in_gda_space = -omega_start
             data_collection_info.omega_start = omega_in_gda_space
             data_collection_info.axis_start = omega_in_gda_space
             data_collection_info.axis_end = omega_in_gda_space
             data_collection_info.axis_range = 0
+        if (chi_start := doc.get("smargon-chi")) is not None:
+            data_collection_info.chi_start = chi_start
 
     def populate_info_for_update(
         self,
@@ -303,8 +303,10 @@ class GridscanISPyBCallback(BaseISPyBCallback):
                 f"with uid: {self.uid_to_finalize_on}."
             )
             if self.ispyb_ids == IspybIds():
-                raise ISPyBDepositionNotMade("ispyb was not initialised at run start")
-            exception_type, message = SampleException.type_and_message_from_reason(
+                raise ISPyBDepositionNotMadeError(
+                    "ispyb was not initialised at run start"
+                )
+            exception_type, message = SampleError.type_and_message_from_reason(
                 doc.get("reason", "")
             )
             if exception_type:

mx_bluesky/common/external_interaction/callbacks/xray_centre/nexus_callback.py

@@ -33,7 +33,7 @@ class GridscanNexusFileCallback(PlanReactiveCallback):
     To use, subscribe the Bluesky RunEngine to an instance of this class.
     E.g.:
         nexus_file_handler_callback = NexusFileCallback(parameters)
-        RE.subscribe(nexus_file_handler_callback)
+        run_engine.subscribe(nexus_file_handler_callback)
     Or decorate a plan using bluesky.preprocessors.subs_decorator.
 
     See: https://blueskyproject.io/bluesky/callbacks.html#ways-to-invoke-callbacks
@@ -89,7 +89,7 @@ class GridscanNexusFileCallback(PlanReactiveCallback):
                     nexus_writer.beam,
                     nexus_writer.attenuator,
                 ) = create_beam_and_attenuator_parameters(
-                    data["dcm-energy_in_kev"],
+                    data["dcm-energy_in_keV"],
                     data["flux-flux_reading"],
                     data["attenuator-actual_transmission"],
                 )

mx_bluesky/common/external_interaction/config_server.py

@@ -9,8 +9,8 @@ from pydantic import TypeAdapter
 
 from mx_bluesky.common.parameters.constants import (
     GDA_DOMAIN_PROPERTIES_PATH,
-    FeatureSetting,
-    FeatureSettingources,
+    FeatureSettings,
+    FeatureSettingSources,
     OavConstants,
 )
 from mx_bluesky.common.utils.log import LOGGER
@@ -19,13 +19,13 @@ FEATURE_FLAG_CACHE_LENGTH_S = 60 * 5
 # Used by the config server when refreshing its cache
 _JSON_CONFIG_PATHS = [OavConstants.OAV_CONFIG_JSON]
 
-T = TypeVar("T", bound=FeatureSetting)
+T = TypeVar("T", bound=FeatureSettings)
 
 
 class MXConfigClient(ConfigServer, Generic[T]):
     def __init__(
         self,
-        feature_sources: type[FeatureSettingources],
+        feature_sources: type[FeatureSettingSources],
         feature_dc: type[T],
         url: str = "https://daq-config.diamond.ac.uk",
     ):

mx_bluesky/common/external_interaction/ispyb/data_model.py

@@ -1,3 +1,8 @@
+"""
+TODO replace these with autogenerated schema classes from the ExpEye API
+https://github.com/DiamondLightSource/mx-bluesky/issues/1419
+"""
+
 from dataclasses import asdict, dataclass
 from enum import Enum
 
@@ -18,6 +23,9 @@ class DataCollectionGroupInfo:
 
 @dataclass(kw_only=True)
 class DataCollectionInfo:
+    # This is used internally to keep track of the DataCollectionGroup ID
+    parent_id: int | None = None
+
     omega_start: float | None = None
     data_collection_number: int | None = None
     xtal_snapshot1: str | None = None
@@ -28,15 +36,12 @@ class DataCollectionInfo:
     n_images: int | None = None
     axis_range: float | None = None
     axis_end: float | None = None
+    chi_start: float | None = None
     kappa_start: float | None = None
 
-    parent_id: int | None = None
     visit_string: str | None = None
-    sample_id: int | None = None
     detector_id: int | None = None
     axis_start: float | None = None
-    focal_spot_size_at_samplex: float | None = None
-    focal_spot_size_at_sampley: float | None = None
     slitgap_vertical: float | None = None
     slitgap_horizontal: float | None = None
     beamsize_at_samplex: float | None = None
@@ -60,6 +65,8 @@ class DataCollectionInfo:
     synchrotron_mode: str | None = None
     undulator_gap1: float | None = None
     start_time: str | None = None
+    end_time: str | None = None
+    run_status: str | None = None
 
 
 @dataclass

mx_bluesky/common/external_interaction/ispyb/exp_eye_store.py

@@ -7,11 +7,17 @@ from event_model.documents import Event
 from requests import JSONDecodeError, patch, post
 from requests.auth import AuthBase
 
+from mx_bluesky.common.external_interaction.ispyb.data_model import (
+    DataCollectionGridInfo,
+    DataCollectionGroupInfo,
+    DataCollectionInfo,
+    DataCollectionPositionInfo,
+)
 from mx_bluesky.common.external_interaction.ispyb.ispyb_utils import (
     get_current_time_string,
     get_ispyb_config,
 )
-from mx_bluesky.common.utils.exceptions import ISPyBDepositionNotMade
+from mx_bluesky.common.utils.exceptions import ISPyBDepositionNotMadeError
 
 RobotActionID = int
 
@@ -33,14 +39,16 @@ def _get_base_url_and_token() -> tuple[str, str]:
     return expeye_config["url"], expeye_config["token"]
 
 
-def _send_and_get_response(auth, url, data, send_func) -> dict:
-    response = send_func(url, auth=auth, json=data)
+def _send_and_get_response(auth, url, data, send_func, query_params=None) -> dict:
+    response = send_func(url, auth=auth, json=data, params=query_params)
     if not response.ok:
         try:
             resp_txt = str(response.json())
         except JSONDecodeError:
             resp_txt = str(response)
-        raise ISPyBDepositionNotMade(f"Could not write {data} to {url}: {resp_txt}")
+        raise ISPyBDepositionNotMadeError(
+            f"Could not write {data} to {url}: {resp_txt}"
+        )
     return response.json()
 
 
@@ -179,3 +187,154 @@ class ExpeyeInteraction:
             bl_sample_status=response["blSampleStatus"],
             container_id=response["containerId"],
         )
+
+    def create_data_group(
+        self, proposal_reference: str, visit_number: int, data: DataCollectionGroupInfo
+    ) -> int:
+        response = _send_and_get_response(
+            self._auth,
+            self._base_url + f"/proposals/{proposal_reference}/sessions/"
+            f"{visit_number}/data-groups",
+            _data_collection_group_info_to_json(data),
+            post,
+        )
+        return response["dataCollectionGroupId"]
+
+    def update_data_group(self, group_id: int, data: DataCollectionGroupInfo):
+        _send_and_get_response(
+            self._auth,
+            self._base_url + f"/data-groups/{group_id}",
+            _data_collection_group_info_to_json(data),
+            patch,
+        )
+
+    def create_data_collection(self, group_id: int, data: DataCollectionInfo) -> int:
+        response = _send_and_get_response(
+            self._auth,
+            self._base_url + f"/data-groups/{group_id}/data-collections",
+            _data_collection_info_to_json(data),
+            post,
+        )
+        return response["dataCollectionId"]
+
+    def update_data_collection(
+        self,
+        data_collection_id: int,
+        data: DataCollectionInfo,
+        append_comment: bool = False,
+    ):
+        _send_and_get_response(
+            self._auth,
+            self._base_url + f"/data-collections/{data_collection_id}",
+            _data_collection_info_to_json(data),
+            patch,
+            {"appendComment": "true"} if append_comment else None,
+        )
+
+    def create_position(
+        self, data_collection_id: int, data: DataCollectionPositionInfo
+    ):
+        _send_and_get_response(
+            self._auth,
+            self._base_url + f"/data-collections/{data_collection_id}/position",
+            _position_info_to_json(data),
+            post,
+        )
+
+    def create_grid(self, data_collection_id: int, data: DataCollectionGridInfo) -> int:
+        response = _send_and_get_response(
+            self._auth,
+            self._base_url + f"/data-collections/{data_collection_id}/grids",
+            _grid_info_to_json(data),
+            post,
+        )
+        return response["gridInfoId"]
+
+
+def _none_to_absent(json: dict) -> dict:
+    for key in [key for key in json if json[key] is None]:
+        del json[key]
+    return json
+
+
+def _data_collection_group_info_to_json(data: DataCollectionGroupInfo) -> dict:
+    return _none_to_absent(
+        {
+            "experimentType": data.experiment_type,
+            "sampleId": data.sample_id,
+            "actualSampleBarcode": data.sample_barcode,
+            "comments": data.comments,
+        }
+    )
+
+
+def _data_collection_info_to_json(data: DataCollectionInfo) -> dict:
+    return _none_to_absent(
+        {
+            "omegaStart": data.omega_start,
+            "dataCollectionNumber": data.data_collection_number,
+            "xtalSnapshotFullPath1": data.xtal_snapshot1,
+            "xtalSnapshotFullPath2": data.xtal_snapshot2,
+            "xtalSnapshotFullPath3": data.xtal_snapshot3,
+            "xtalSnapshotFullPath4": data.xtal_snapshot4,
+            "numberOfImages": data.n_images,
+            "axisRange": data.axis_range,
+            "axisEnd": data.axis_end,
+            "chiStart": data.chi_start,
+            "kappaStart": data.kappa_start,
+            "detectorId": data.detector_id,
+            "axisStart": data.axis_start,
+            "slitGapVertical": data.slitgap_vertical,
+            "slitGapHorizontal": data.slitgap_horizontal,
+            "beamSizeAtSampleX": data.beamsize_at_samplex,
+            "beamSizeAtSampleY": data.beamsize_at_sampley,
+            "transmission": data.transmission,
+            "comments": data.comments,
+            "detectorDistance": data.detector_distance,
+            "exposureTime": data.exp_time,
+            "imageDirectory": data.imgdir,
+            "fileTemplate": data.file_template,
+            "imagePrefix": data.imgprefix,
+            "imageSuffix": data.imgsuffix,
+            "numberOfPasses": data.n_passes,
+            "overlap": data.overlap,
+            "flux": data.flux,
+            "startImageNumber": data.start_image_number,
+            "resolution": data.resolution,
+            "wavelength": data.wavelength,
+            "xBeam": data.xbeam,
+            "yBeam": data.ybeam,
+            "synchrotronMode": data.synchrotron_mode,
+            "undulatorGap1": data.undulator_gap1,
+            "startTime": data.start_time,
+            "endTime": data.end_time,
+            "runStatus": data.run_status,
+        }
+    )
+
+
+def _position_info_to_json(data: DataCollectionPositionInfo) -> dict:
+    return _none_to_absent(
+        {
+            "posX": data.pos_x,
+            "posY": data.pos_y,
+            "posZ": data.pos_z,
+        }
+    )
+
+
+def _grid_info_to_json(data: DataCollectionGridInfo) -> dict:
+    return _none_to_absent(
+        {
+            "snapshotOffsetXPixel": data.snapshot_offset_x_pixel,
+            "snapshotOffsetYPixel": data.snapshot_offset_y_pixel,
+            "dx": data.dx_in_mm,
+            "dy": data.dy_in_mm,
+            "stepsX": data.steps_x,
+            "stepsY": data.steps_y,
+            "orientation": data.orientation.value,
+            "pixelsPerMicronX": 1 / data.microns_per_pixel_x,
+            "pixelsPerMicronY": 1 / data.microns_per_pixel_y,
+            "snaked": data.snaked,
+        }
+    )