Pipette Tip Layout

The PipetteTipLayout schema describes the arrangement of pipette tips within a tip box, used when issuing pipette tip commands.

Related T-code Commands: - ADD_PIPETTE_TIP_GROUP - PICK_UP_PIPETTE_TIP - PUT_DOWN_PIPETTE_TIP

Documentation

TCode pipette tip layout schema.

pydantic model tcode_api.schemas.pipette_tip_layout.PipetteTipLayout

Data structure representing the layout of pipette tips in a box.

Note:

This class is designed to allow non-standard use cases, like adding partially filled pipette tip boxes to the deck with the :class:ADD_LABWARE command.

Show JSON schema

{
   "title": "PipetteTipLayout",
   "description": "Data structure representing the layout of pipette tips in a box.\n\n:note: This class is designed to allow non-standard use cases, like adding partially filled\n    pipette tip boxes to the deck with the :class:``ADD_LABWARE`` command.",
   "type": "object",
   "properties": {
      "schema_version": {
         "const": 1,
         "default": 1,
         "title": "Schema Version",
         "type": "integer"
      },
      "type": {
         "const": "PipetteTipLayout",
         "default": "PipetteTipLayout",
         "title": "Type",
         "type": "string"
      },
      "layout": {
         "description": "A 2D list representing the layout of pipette tips in the box. The list contains either 0 or 1, where 1 represents a slot holding a pipette tip and 0 represents an empty slot.",
         "items": {
            "items": {
               "type": "integer"
            },
            "type": "array"
         },
         "title": "Layout",
         "type": "array"
      }
   },
   "required": [
      "layout"
   ]
}

Config:

• strict: bool = True

• extra: str = ignore

Fields:

• layout (list[list[int]])

• schema_version (Literal[1])

• type (Literal['PipetteTipLayout'])

classmethod empty(row_count=8, column_count=12)

Create a layout with no pipette tips.

Parameters:

• row_count (int) – The number of rows in the pipette tip box (default: 8).

• column_count (int) – The number of columns in the pipette tip box (default: 12).

Return type:

Self

Returns:

A PipetteTipLayout with all slots empty (0).

classmethod full(row_count=8, column_count=12)

Create a layout with all pipette tips filled.

Parameters:

• row_count (int) – The number of rows in the pipette tip box (default: 8).

• column_count (int) – The number of columns in the pipette tip box (default: 12).

Return type:

Self

Returns:

A PipetteTipLayout with all slots filled (1).

field type: Literal['PipetteTipLayout'] = 'PipetteTipLayout'

field schema_version: Literal[1] = 1

field layout: list[list[int]] [Required]

A 2D list representing the layout of pipette tips in the box. The list contains either 0 or 1, where 1 represents a slot holding a pipette tip and 0 represents an empty slot.