pylabrobot.agilent.benchcel.BenchCelLabwareSettings#

class pylabrobot.agilent.benchcel.BenchCelLabwareSettings(name: str, plate_size_x: float, plate_size_y: float, plate_size_z: float, stacking_thickness: float, robot_gripper_offset: float, stacker_gripper_offset: float, sensor_offset: float, gripper_open_position: float = -1.0, gripper_holding_plate_position: float = 8.0, gripper_holding_stack_position: float = 8.5, orientation_sensor_threshold: int = 100, plate_presence_threshold: int = 225, sensor_intensity: int = 50, error_correction_offset: float = 0.0, can_be_lidded: bool = False, lidded_plate_stacking_thickness: float | None = None, lidded_plate_thickness: float | None = None, lidded_plate_resting_height: float | None = None, lidded_plate_gripper_offset: float | None = None, lidded_plate_gripper_position: float | None = None, lidded_plate_departure_height: float | None = None, can_be_sealed: bool = False, sealed_plate_stacking_thickness: float | None = None, sealed_plate_thickness: float | None = None, stack_plate_presence_threshold: int = 50, rack_presence_threshold: int = 3, additional_release_height: float = 2.0, low_pressure_warning: int = 30, tilt_margin: float = 2.0, tilt_margin_enabled: bool = False, notch_settings: PlateNotchSettings = <factory>, identifier: str | None = None, source: str | None = None)#

Bases: object

BenchCel/VWorks labware settings paired with PLR plate dimensions.

Parameters:

  • name (str) – Human-readable labware name.

  • plate_size_x (float) – Full outside plate length in mm.

  • plate_size_y (float) – Full outside plate width in mm.

  • plate_size_z (float) – Full outside plate height in mm.

  • stacking_thickness (float) – Vertical pitch of nested plates in the BenchCel stacker. This is usually smaller than full plate height because plates nest.

  • robot_gripper_offset (float) – BenchCel robot gripper contact height from the bottom of the plate. This maps to Plate.preferred_pickup_location.z.

  • stacker_gripper_offset (float) – Stacker clamp/gripper contact height from the bottom of the plate.

  • sensor_offset (float)

  • gripper_open_position (float)

  • gripper_holding_plate_position (float)

  • gripper_holding_stack_position (float)

  • orientation_sensor_threshold (int)

  • plate_presence_threshold (int)

  • sensor_intensity (int)

  • error_correction_offset (float)

  • can_be_lidded (bool)

  • lidded_plate_stacking_thickness (float | None)

  • lidded_plate_thickness (float | None)

  • lidded_plate_resting_height (float | None)

  • lidded_plate_gripper_offset (float | None)

  • lidded_plate_gripper_position (float | None)

  • lidded_plate_departure_height (float | None)

  • can_be_sealed (bool)

  • sealed_plate_stacking_thickness (float | None)

  • sealed_plate_thickness (float | None)

  • stack_plate_presence_threshold (int)

  • rack_presence_threshold (int)

  • additional_release_height (float)

  • low_pressure_warning (int)

  • tilt_margin (float)

  • tilt_margin_enabled (bool)

  • notch_settings (PlateNotchSettings)

  • identifier (str | None)

  • source (str | None)

Attributes

additional_release_height

can_be_lidded

can_be_sealed

error_correction_offset

gripper_holding_plate_position

gripper_holding_stack_position

gripper_open_position

identifier

lidded_plate_departure_height

lidded_plate_gripper_offset

lidded_plate_gripper_position

lidded_plate_resting_height

lidded_plate_stacking_thickness

lidded_plate_thickness

low_pressure_warning

orientation_sensor_threshold

plate_presence_threshold

rack_presence_threshold

sealed_plate_stacking_thickness

sealed_plate_thickness

sensor_intensity

source

stack_plate_presence_threshold

tilt_margin

tilt_margin_enabled

name

plate_size_x

plate_size_y

plate_size_z

stacking_thickness

robot_gripper_offset

stacker_gripper_offset

sensor_offset

notch_settings

Methods

__init__(name, plate_size_x, plate_size_y, ...)

apply_to_plate(plate, *[, ...])

Set PLR pickup metadata on plate using this BenchCel profile.

dimension_differences(plate)

Return profile minus plate-resource dimensions for each axis.

effective_plate_height(*[, sealed, lidded])

Return full outside plate height for PLR rack/site sizing.

effective_stacking_thickness(*[, sealed, lidded])

Return the BenchCel stack pitch for the selected labware state.

from_device_payload(payload, *[, name, ...])

Decode a 77-byte 0x7d payload back into settings.

from_dict(data)

Deserialize settings from to_dict().

from_plate(plate, **kwargs)

Calculate BenchCel settings from a PLR plate resource.

from_xml_file(path, *[, plate_size_x, ...])

Parse a user-supplied BenchCel/VWorks XML file.

preferred_pickup_location(plate)

Return a PLR preferred pickup location using the BenchCel robot offset.

robot_pickup_distance_from_top(*[, sealed, ...])

Return PLR pickup_distance_from_top implied by RobotGripperOffset.

to_device_payload()

Encode the 77-byte 0x7d BenchCel labware-settings payload.

to_dict()

Return JSON-serialisable settings.

validate_plate_dimensions(plate, *[, ...])

Raise if a PLR plate resource differs too far from this BenchCel profile.