Labware Holders

Labware holders are the data structures that specify where labware should be placed on a robot or deck. They can be referenced by name or by the id of a parent labware.

Related T-code Commands: - ADD_LABWARE - PICK_UP_LABWARE

Documentation

TCode labware holder schemas.

pydantic model tcode_api.schemas.labware_holder.LabwareHolderName

LabwareHolder specified by name and target robot.

Show JSON schema

{
   "title": "LabwareHolderName",
   "description": "LabwareHolder specified by name and target robot.",
   "type": "object",
   "properties": {
      "schema_version": {
         "const": 1,
         "default": 1,
         "title": "Schema Version",
         "type": "integer"
      },
      "type": {
         "const": "LabwareHolderName",
         "default": "LabwareHolderName",
         "title": "Type",
         "type": "string"
      },
      "robot_id": {
         "description": "TCode-assigned robot id. Assigned previously with :class:``ADD_ROBOT`` command. ",
         "title": "Robot Id",
         "type": "string"
      },
      "name": {
         "description": "Name of the labware holder, as defined in the robot's configuration. Most often, this will be a deck slot in the format \"DeckSlot_#\".",
         "title": "Name",
         "type": "string"
      }
   },
   "required": [
      "robot_id",
      "name"
   ]
}

Config:

• strict: bool = True

• extra: str = ignore

Fields:

• name (str)

• robot_id (str)

• schema_version (Literal[1])

• type (Literal['LabwareHolderName'])

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

field schema_version: Literal[1] = 1

field robot_id: str [Required]

TCode-assigned robot id. Assigned previously with :class:ADD_ROBOT command.

field name: str [Required]

Name of the labware holder, as defined in the robot’s configuration. Most often, this will be a deck slot in the format “DeckSlot_#”.

pydantic model tcode_api.schemas.labware_holder.LabwareId

LabwareHolder specifed by a TCode-assigned labware ID.

Show JSON schema

{
   "title": "LabwareId",
   "description": "LabwareHolder specifed by a TCode-assigned labware ID.",
   "type": "object",
   "properties": {
      "schema_version": {
         "const": 1,
         "default": 1,
         "title": "Schema Version",
         "type": "integer"
      },
      "type": {
         "const": "LabwareId",
         "default": "LabwareId",
         "title": "Type",
         "type": "string"
      },
      "id": {
         "description": "TCode ID of the labware to target, assigned previously by the :class:``ADD_LABWARE`` command.",
         "title": "Id",
         "type": "string"
      }
   },
   "required": [
      "id"
   ]
}

Config:

• strict: bool = True

• extra: str = ignore

Fields:

• id (str)

• schema_version (Literal[1])

• type (Literal['LabwareId'])

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

field schema_version: Literal[1] = 1

field id: str [Required]

TCode ID of the labware to target, assigned previously by the :class:ADD_LABWARE command.