opentrons 8.6.0a1__py3-none-any.whl

opentrons/calibration_storage/ot2/mark_bad_calibration.py

@@ -0,0 +1,27 @@
+import typing
+
+from opentrons.util.helpers import utc_now
+
+from .. import types as local_types
+
+from .models import v1
+
+
+CalibrationType = typing.TypeVar(
+    "CalibrationType",
+    v1.PipetteOffsetCalibration,
+    v1.InstrumentOffsetModel,
+    v1.TipLengthCalibration,
+    v1.TipLengthModel,
+    v1.DeckCalibrationModel,
+)
+
+
+def mark_bad(
+    calibration: CalibrationType,
+    source_marked_bad: local_types.SourceType,
+) -> CalibrationType:
+    calibration.status = v1.CalibrationStatus(
+        markedBad=True, source=source_marked_bad, markedAt=utc_now()
+    )
+    return calibration

opentrons/calibration_storage/ot2/models/v1.py

@@ -0,0 +1,149 @@
+import typing
+
+from typing_extensions import Literal
+from pydantic import field_validator, BaseModel, Field, PlainSerializer
+from datetime import datetime
+
+from opentrons_shared_data.pipette.types import LabwareUri
+
+from opentrons.types import Point
+from opentrons.calibration_storage import types
+
+DatetimeType = typing.Annotated[
+    datetime,
+    PlainSerializer(lambda x: x.isoformat(), when_used="json"),
+]
+
+
+class CalibrationStatus(BaseModel):
+    markedBad: bool = False
+    source: typing.Optional[types.SourceType] = None
+    markedAt: typing.Optional[DatetimeType] = None
+
+
+# Schemas used to store the data types
+# TODO(lc 09-01-2022) We should ensure that all pydantic models are
+# in camel case, but for now, the schemas are following the format
+# they are currently saved in on the OT-2 to avoid a large migration.
+class TipLengthModel(BaseModel):
+    tipLength: float = Field(..., description="Tip length data found from calibration.")
+    lastModified: DatetimeType = Field(
+        ..., description="The last time this tip length was calibrated."
+    )
+    source: types.SourceType = Field(
+        default=types.SourceType.factory, description="The source of calibration."
+    )
+    status: CalibrationStatus = Field(
+        default_factory=CalibrationStatus,
+        description="The status of the calibration data.",
+    )
+    # Old data may have a `uri` field, replaced later by `definitionHash`.
+    # uri: typing.Union[LabwareUri, Literal[""]] = Field(
+    #    ..., description="The tiprack URI associated with the tip length data."
+    # )
+    definitionHash: str = Field(
+        ..., description="The tiprack hash associated with the tip length data."
+    )
+
+    @field_validator("tipLength")
+    @classmethod
+    def ensure_tip_length_positive(cls, tipLength: float) -> float:
+        if tipLength < 0.0:
+            raise ValueError("Tip Length must be a positive number")
+        return tipLength
+
+
+class DeckCalibrationModel(BaseModel):
+    attitude: types.AttitudeMatrix = Field(
+        ..., description="Attitude matrix for deck found from calibration."
+    )
+    last_modified: typing.Optional[DatetimeType] = Field(
+        default=None, description="The last time this deck was calibrated."
+    )
+    source: types.SourceType = Field(
+        default=types.SourceType.factory, description="The source of calibration."
+    )
+    pipette_calibrated_with: typing.Optional[str] = Field(
+        default=None, description="The pipette id used to calibrate the deck."
+    )
+    tiprack: typing.Optional[str] = Field(
+        default=None, description="The tiprack id used to calibrate the deck."
+    )
+    status: CalibrationStatus = Field(
+        default_factory=CalibrationStatus,
+        description="The status of the calibration data.",
+    )
+
+
+class InstrumentOffsetModel(BaseModel):
+    offset: Point = Field(..., description="Instrument offset found from calibration.")
+    tiprack: str = Field(..., description="Tiprack used to calibrate this offset")
+    uri: str = Field(
+        ..., description="The URI of the labware used for instrument offset"
+    )
+    last_modified: DatetimeType = Field(
+        ..., description="The last time this instrument was calibrated."
+    )
+    source: types.SourceType = Field(
+        default=types.SourceType.factory, description="The source of calibration."
+    )
+    status: CalibrationStatus = Field(
+        default_factory=CalibrationStatus,
+        description="The status of the calibration data.",
+    )
+
+
+# TODO(lc 09-19-2022) We need to refactor the calibration endpoints
+# so that we only need to use one data model schema. This model is a
+# temporary workaround to match with current behavior.
+class PipetteOffsetCalibration(BaseModel):
+    pipette: str = Field(..., description="Pipette id associated with calibration.")
+    mount: str = Field(
+        ..., description="The mount that this pipette was calibrated with."
+    )
+    offset: Point = Field(..., description="Instrument offset found from calibration.")
+    tiprack: str = Field(..., description="Tiprack used to calibrate this offset")
+    uri: str = Field(
+        ..., description="The URI of the labware used for instrument offset"
+    )
+    last_modified: DatetimeType = Field(
+        ..., description="The last time this instrument was calibrated."
+    )
+    source: types.SourceType = Field(
+        default=types.SourceType.factory, description="The source of calibration."
+    )
+    status: CalibrationStatus = Field(
+        default_factory=CalibrationStatus,
+        description="The status of the calibration data.",
+    )
+
+
+# TODO(lc 09-19-2022) We need to refactor the calibration endpoints
+# so that we only need to use one data model schema. This model is a
+# temporary workaround to match with current behavior.
+class TipLengthCalibration(BaseModel):
+    pipette: str = Field(..., description="Pipette id associated with calibration.")
+    tiprack: str = Field(
+        ..., description="The tiprack hash associated with this tip length data."
+    )
+    tipLength: float = Field(..., description="Tip length data found from calibration.")
+    lastModified: DatetimeType = Field(
+        ..., description="The last time this tip length was calibrated."
+    )
+    source: types.SourceType = Field(
+        default=types.SourceType.factory, description="The source of calibration."
+    )
+    status: CalibrationStatus = Field(
+        default_factory=CalibrationStatus,
+        description="The status of the calibration data.",
+    )
+    uri: typing.Union[LabwareUri, Literal[""]] = Field(
+        ..., description="The tiprack URI associated with the tip length data."
+    )
+
+    @field_validator("tipLength")
+    @classmethod
+    def ensure_tip_length_positive(cls, tipLength: float) -> float:
+        if tipLength < 0.0:
+            raise ValueError("Tip Length must be a positive number")
+        return tipLength

opentrons/calibration_storage/ot2/pipette_offset.py

@@ -0,0 +1,129 @@
+import json
+import typing
+import logging
+from pydantic import ValidationError
+from dataclasses import asdict
+
+from opentrons import config, types
+
+from .. import file_operators as io, types as local_types
+
+from .models import v1
+
+from opentrons.types import Mount, Point
+from opentrons.util.helpers import utc_now
+
+log = logging.getLogger(__name__)
+
+# Delete Pipette Offset Calibrations
+
+
+def delete_pipette_offset_file(pipette: str, mount: Mount) -> None:
+    """
+    Delete pipette offset file based on mount and pipette serial number
+
+    :param pipette: pipette serial number
+    :param mount: pipette mount
+    """
+    offset_dir = config.get_opentrons_path("pipette_calibration_dir")
+    offset_path = offset_dir / mount.name.lower() / f"{pipette}.json"
+    io.delete_file(offset_path)
+
+
+def clear_pipette_offset_calibrations() -> None:
+    """
+    Delete all pipette offset calibration files.
+    """
+    io._remove_json_files_in_directories(
+        config.get_opentrons_path("pipette_calibration_dir")
+    )
+
+
+# Save Pipette Offset Calibrations
+
+
+def save_pipette_calibration(
+    offset: Point,
+    pip_id: str,
+    mount: Mount,
+    tiprack_hash: str,
+    tiprack_uri: str,
+    cal_status: typing.Optional[
+        typing.Union[local_types.CalibrationStatus, v1.CalibrationStatus]
+    ] = None,
+) -> None:
+    pip_dir = config.get_opentrons_path("pipette_calibration_dir") / mount.name.lower()
+
+    if isinstance(cal_status, local_types.CalibrationStatus):
+        cal_status_model = v1.CalibrationStatus(**asdict(cal_status))
+    elif isinstance(cal_status, v1.CalibrationStatus):
+        cal_status_model = cal_status
+    else:
+        cal_status_model = v1.CalibrationStatus()
+
+    pipette_calibration = v1.InstrumentOffsetModel(
+        offset=offset,
+        tiprack=tiprack_hash,
+        uri=tiprack_uri,
+        last_modified=utc_now(),
+        source=local_types.SourceType.user,
+        status=cal_status_model,
+    )
+    io.save_to_file(pip_dir, pip_id, pipette_calibration)
+
+
+# Get Pipette Offset Calibrations
+
+
+def get_pipette_offset(
+    pipette_id: str, mount: Mount
+) -> typing.Optional[v1.InstrumentOffsetModel]:
+    try:
+        pipette_calibration_filepath = (
+            config.get_opentrons_path("pipette_calibration_dir")
+            / mount.name.lower()
+            / f"{pipette_id}.json"
+        )
+        return v1.InstrumentOffsetModel(
+            **io.read_cal_file(pipette_calibration_filepath)
+        )
+    except FileNotFoundError:
+        log.debug(f"Calibrations for {pipette_id} on {mount} does not exist.")
+        return None
+    except (json.JSONDecodeError, ValidationError):
+        log.warning(
+            f"Malformed calibrations for {pipette_id} on {mount}. Please factory reset your calibrations.",
+            exc_info=True,
+        )
+        # TODO: Delete the bad calibration here maybe?
+        return None
+
+
+def get_all_pipette_offset_calibrations() -> typing.List[v1.PipetteOffsetCalibration]:
+    """
+    A helper function that will list all of the pipette offset
+    calibrations.
+
+    :return: A list of dictionary objects representing all of the
+    pipette offset calibration files found on the robot.
+    """
+    pipette_calibration_dir = config.get_opentrons_path("pipette_calibration_dir")
+    pipette_calibration_list = []
+    for filepath in pipette_calibration_dir.glob("**/*.json"):
+        pipette_id = filepath.stem
+        mount = Mount.string_to_mount(filepath.parent.stem)
+        calibration = get_pipette_offset(pipette_id, mount)
+        if calibration:
+            pipette_calibration_list.append(
+                v1.PipetteOffsetCalibration(
+                    pipette=pipette_id,
+                    mount=mount.name.lower(),
+                    offset=types.Point(*calibration.offset),
+                    tiprack=calibration.tiprack,
+                    uri=calibration.uri,
+                    last_modified=calibration.last_modified,
+                    source=calibration.source,
+                    status=calibration.status,
+                )
+            )
+    return pipette_calibration_list

opentrons/calibration_storage/ot2/tip_length.py

@@ -0,0 +1,281 @@
+import json
+import typing
+import logging
+from pydantic import ValidationError
+from dataclasses import asdict
+
+from opentrons import config
+
+from .. import file_operators as io, helpers, types as local_types
+from opentrons_shared_data.pipette.types import LabwareUri
+
+from opentrons.protocols.api_support.constants import OPENTRONS_NAMESPACE
+from opentrons.util.helpers import utc_now
+
+
+from .models import v1
+
+if typing.TYPE_CHECKING:
+    from opentrons_shared_data.labware.types import LabwareDefinition2
+
+
+log = logging.getLogger(__name__)
+# Get Tip Length Calibration
+
+
+def _convert_tip_length_model_to_dict(
+    to_dict: typing.Dict[LabwareUri, v1.TipLengthModel],
+) -> typing.Dict[LabwareUri, typing.Any]:
+    # TODO[pydantic]: supported in Pydantic V2
+    # This is a workaround since pydantic doesn't have a nice way to
+    # add encoders when converting to a dict.
+    dict_of_tip_lengths = {}
+    for key, item in to_dict.items():
+        dict_of_tip_lengths[key] = json.loads(item.model_dump_json())
+    return dict_of_tip_lengths
+
+
+def tip_lengths_for_pipette(
+    pipette_id: str,
+) -> typing.Dict[LabwareUri, v1.TipLengthModel]:
+    try:
+        tip_length_filepath = config.get_tip_length_cal_path() / f"{pipette_id}.json"
+        all_tip_lengths_for_pipette = io.read_cal_file(tip_length_filepath)
+    except FileNotFoundError:
+        log.debug(f"Tip length calibrations not found for {pipette_id}")
+        return {}
+    except json.JSONDecodeError:
+        log.warning(
+            f"Tip length calibration is malformed for {pipette_id}", exc_info=True
+        )
+        return {}
+
+    tip_lengths: typing.Dict[LabwareUri, v1.TipLengthModel] = {}
+
+    for tiprack_identifier, data in all_tip_lengths_for_pipette.items():
+        # We normally key these calibrations by their tip rack URI,
+        # but older software had them keyed by their tip rack hash.
+        # Migrate from the old format, if necessary.
+        tiprack_identifier_is_uri = "/" in tiprack_identifier
+        if not tiprack_identifier_is_uri:
+            data["definitionHash"] = tiprack_identifier
+            uri = data.pop("uri", None)
+            if uri is None:
+                # We don't have a way to migrate old records without a URI,
+                # so skip over them.
+                continue
+            else:
+                tiprack_identifier = uri
+
+        try:
+            tip_lengths[LabwareUri(tiprack_identifier)] = v1.TipLengthModel(**data)
+        except ValidationError:
+            log.warning(
+                f"Tip length calibration is malformed for {tiprack_identifier} on {pipette_id}",
+                exc_info=True,
+            )
+    return tip_lengths
+
+
+def load_tip_length_calibration(
+    pip_id: str, definition: "LabwareDefinition2"
+) -> v1.TipLengthModel:
+    """
+    Function used to grab the current tip length associated
+    with a particular tiprack.
+
+    :param pip_id: pipette you are using
+    :param definition: full definition of the tiprack
+    """
+    labware_uri = helpers.uri_from_definition(definition)
+    load_name = definition["parameters"]["loadName"]
+    try:
+        return tip_lengths_for_pipette(pip_id)[labware_uri]
+    except KeyError as e:
+        raise local_types.TipLengthCalNotFound(
+            f"Tip length of {load_name} has not been "
+            f"calibrated for this pipette: {pip_id} and cannot"
+            "be loaded"
+        ) from e
+
+
+def get_all_tip_length_calibrations() -> typing.List[v1.TipLengthCalibration]:
+    """
+    A helper function that will list all of the tip length calibrations.
+
+    :return: A list of dictionary objects representing all of the
+    tip length calibration files found on the robot.
+    """
+    all_tip_lengths_available = []
+    tip_length_dir_path = config.get_tip_length_cal_path()
+    for filepath in tip_length_dir_path.glob("**/*.json"):
+        if filepath.stem == "index":
+            continue
+        tip_lengths = tip_lengths_for_pipette(filepath.stem)
+        for tiprack_uri, tip_length in tip_lengths.items():
+            all_tip_lengths_available.append(
+                v1.TipLengthCalibration(
+                    pipette=filepath.stem,
+                    tiprack=tip_length.definitionHash,
+                    tipLength=tip_length.tipLength,
+                    lastModified=tip_length.lastModified,
+                    source=tip_length.source,
+                    status=tip_length.status,
+                    uri=tiprack_uri,
+                )
+            )
+    return all_tip_lengths_available
+
+
+def get_custom_tiprack_definition_for_tlc(labware_uri: str) -> "LabwareDefinition2":
+    """
+    Return the custom tiprack definition saved in the custom tiprack directory
+    during tip length calibration
+    """
+    custom_tiprack_dir = config.get_custom_tiprack_def_path()
+    custom_tiprack_path = custom_tiprack_dir / f"{labware_uri}.json"
+    try:
+        with open(custom_tiprack_path, "rb") as f:
+            return typing.cast(
+                "LabwareDefinition2",
+                json.loads(f.read().decode("utf-8")),
+            )
+    except FileNotFoundError:
+        raise FileNotFoundError(
+            f"Custom tiprack {labware_uri} not found in the custom tiprack"
+            "directory on the robot. Please recalibrate tip length and "
+            "pipette offset with this tiprack before performing calibration "
+            "health check."
+        )
+
+
+# Delete Tip Length Calibration
+
+
+def delete_tip_length_calibration(
+    pipette_id: str,
+    tiprack_uri: typing.Optional[LabwareUri] = None,
+    tiprack_hash: typing.Optional[str] = None,
+) -> None:
+    """
+    Delete tip length calibration based on an optional tiprack uri or
+    tiprack hash and pipette serial number.
+
+    :param tiprack_uri: tiprack uri
+    :param tiprack_hash: tiprack uri
+    :param pipette: pipette serial number
+    """
+    tip_lengths = tip_lengths_for_pipette(pipette_id)
+    tip_length_dir = config.get_tip_length_cal_path()
+    if tiprack_uri in tip_lengths:
+        # maybe make modify and delete same file?
+        del tip_lengths[tiprack_uri]
+
+        if tip_lengths:
+            dict_of_tip_lengths = _convert_tip_length_model_to_dict(tip_lengths)
+            io.save_to_file(tip_length_dir, pipette_id, dict_of_tip_lengths)
+        else:
+            io.delete_file(tip_length_dir / f"{pipette_id}.json")
+    elif tiprack_hash and any(
+        tiprack_hash in v.model_dump() for v in tip_lengths.values()
+    ):
+        # NOTE this is for backwards compatibilty only
+        # TODO delete this check once the tip_length DELETE router
+        # no longer depends on a tiprack hash
+        for k, v in tip_lengths.items():
+            if tiprack_hash in v.model_dump():
+                tip_lengths.pop(k)
+        if tip_lengths:
+            dict_of_tip_lengths = _convert_tip_length_model_to_dict(tip_lengths)
+            io.save_to_file(tip_length_dir, pipette_id, dict_of_tip_lengths)
+        else:
+            io.delete_file(tip_length_dir / f"{pipette_id}.json")
+    else:
+        raise local_types.TipLengthCalNotFound(
+            f"Tip length for uri {tiprack_uri} and hash {tiprack_hash} has not been "
+            f"calibrated for this pipette: {pipette_id} and cannot"
+            "be loaded"
+        )
+
+
+def clear_tip_length_calibration() -> None:
+    """
+    Delete all tip length calibration files.
+    """
+    offset_dir = config.get_tip_length_cal_path()
+    try:
+        io._remove_json_files_in_directories(offset_dir)
+    except FileNotFoundError:
+        pass
+
+
+# Save Tip Length Calibration
+
+
+def create_tip_length_data(
+    definition: "LabwareDefinition2",
+    length: float,
+    cal_status: typing.Optional[
+        typing.Union[local_types.CalibrationStatus, v1.CalibrationStatus]
+    ] = None,
+) -> typing.Dict[LabwareUri, v1.TipLengthModel]:
+    """
+    Function to correctly format tip length data.
+
+    :param definition: full labware definition
+    :param length: the tip length to save
+    """
+    labware_hash = helpers.hash_labware_def(definition)
+    labware_uri = helpers.uri_from_definition(definition)
+
+    if isinstance(cal_status, local_types.CalibrationStatus):
+        cal_status_model = v1.CalibrationStatus(**asdict(cal_status))
+    elif isinstance(cal_status, v1.CalibrationStatus):
+        cal_status_model = cal_status
+    else:
+        cal_status_model = v1.CalibrationStatus()
+    tip_length_data = v1.TipLengthModel(
+        tipLength=length,
+        lastModified=utc_now(),
+        source=local_types.SourceType.user,
+        status=cal_status_model,
+        definitionHash=labware_hash,
+    )
+
+    if not definition.get("namespace") == OPENTRONS_NAMESPACE:
+        _save_custom_tiprack_definition(labware_uri, definition)
+
+    data = {labware_uri: tip_length_data}
+    return data
+
+
+def _save_custom_tiprack_definition(
+    labware_uri: str,
+    definition: "LabwareDefinition2",
+) -> None:
+    namespace, load_name, version = labware_uri.split("/")
+    custom_tr_dir_path = config.get_custom_tiprack_def_path()
+    custom_namespace_dir = custom_tr_dir_path / f"{namespace}/{load_name}"
+
+    io.save_to_file(custom_namespace_dir, version, definition)
+
+
+def save_tip_length_calibration(
+    pip_id: str,
+    tip_length_cal: typing.Dict[LabwareUri, v1.TipLengthModel],
+) -> None:
+    """
+    Function used to save tip length calibration to file.
+
+    :param pip_id: pipette id to associate with this tip length
+    :param tip_length_cal: results of the data created using
+           :meth:`create_tip_length_data`
+    """
+    tip_length_dir_path = config.get_tip_length_cal_path()
+
+    all_tip_lengths = tip_lengths_for_pipette(pip_id)
+
+    all_tip_lengths.update(tip_length_cal)
+
+    dict_of_tip_lengths = _convert_tip_length_model_to_dict(all_tip_lengths)
+    io.save_to_file(tip_length_dir_path, pip_id, dict_of_tip_lengths)

opentrons/calibration_storage/ot3/__init__.py

@@ -0,0 +1,31 @@
+from . import (
+    models,
+    gripper_offset as gripper_offset,
+)
+from .pipette_offset import (
+    save_pipette_calibration,
+    clear_pipette_offset_calibrations,
+    get_pipette_offset,
+    delete_pipette_offset_file,
+)
+from .module_offset import (
+    save_module_calibration,
+    clear_module_offset_calibrations,
+    get_module_offset,
+    delete_module_offset_file,
+    load_all_module_offsets,
+)
+
+__all__ = [
+    "models",
+    "gripper_offset",
+    "save_pipette_calibration",
+    "clear_pipette_offset_calibrations",
+    "get_pipette_offset",
+    "delete_pipette_offset_file",
+    "save_module_calibration",
+    "clear_module_offset_calibrations",
+    "get_module_offset",
+    "delete_module_offset_file",
+    "load_all_module_offsets",
+]

opentrons/calibration_storage/ot3/deck_attitude.py

@@ -0,0 +1,83 @@
+import json
+import logging
+from pydantic import ValidationError
+from typing import Optional, Union, no_type_check
+from dataclasses import asdict
+
+from opentrons import config
+from opentrons.util.helpers import utc_now
+
+
+from .. import file_operators as io, types as local_types
+
+from .models import v1
+
+log = logging.getLogger(__name__)
+
+
+# Delete Belt Calibration
+
+
+@no_type_check
+def delete_robot_belt_attitude() -> None:
+    """
+    Delete the robot belt attitude calibration.
+    """
+    gantry_path = (
+        config.get_opentrons_path("robot_calibration_dir") / "belt_calibration.json"
+    )
+
+    io.delete_file(gantry_path)
+
+
+# Save Belt Calibration
+
+
+@no_type_check
+def save_robot_belt_attitude(
+    transform: local_types.AttitudeMatrix,
+    pip_id: Optional[str],
+    source: Optional[local_types.SourceType] = None,
+    cal_status: Optional[
+        Union[local_types.CalibrationStatus, local_types.CalibrationStatus]
+    ] = None,
+) -> None:
+    robot_dir = config.get_opentrons_path("robot_calibration_dir")
+
+    if isinstance(cal_status, local_types.CalibrationStatus):
+        cal_status_model = v1.CalibrationStatus(**asdict(cal_status))
+    elif isinstance(cal_status, v1.CalibrationStatus):
+        cal_status_model = cal_status
+    else:
+        cal_status_model = v1.CalibrationStatus()
+
+    gantry_calibration = v1.BeltCalibrationModel(
+        attitude=transform,
+        pipetteCalibratedWith=pip_id,
+        lastModified=utc_now(),
+        source=source or local_types.SourceType.user,
+        status=cal_status_model,
+    )
+    # convert to schema + validate json conversion
+    io.save_to_file(robot_dir, "belt_calibration", gantry_calibration)
+
+
+# Get Belt Calibration
+
+
+@no_type_check
+def get_robot_belt_attitude() -> Optional[v1.BeltCalibrationModel]:
+    belt_calibration_path = (
+        config.get_opentrons_path("robot_calibration_dir") / "belt_calibration.json"
+    )
+    try:
+        return v1.BeltCalibrationModel(**io.read_cal_file(belt_calibration_path))
+    except FileNotFoundError:
+        log.warning("Belt calibration not found.")
+        pass
+    except (json.JSONDecodeError, ValidationError):
+        log.warning(
+            "Belt calibration is malformed. Please factory reset your calibrations.",
+            exc_info=True,
+        )
+    return None