PF400

PF400

Brooks PF400 dispenser documentation. This page describes all available commands and their parameters for controlling the PF400 instrument.

Table of Contents

  1. Overview
  2. Configuration
  3. Commands
    1. Move
    2. GraspPlate
    3. ReleasePlate
    4. Transfer
    5. Wait
    6. RetrievePlate
    7. DropOffPlate
    8. PickLid
    9. PlaceLid
    10. Engage
    11. Release
    12. Unwind
    13. RunSequence
    14. GetCurrentLocation
    15. Jog
    16. RawCommand
    17. RegisterMotionProfile
    18. LoadWaypoints
    19. LoadLabware

Overview

Device Information

Manufacturer: Brooks
Category: Dispenser
Package: com.science.foundry.tools.grpc_interfaces.pf400

Configuration

Configuration Parameters

Parameter Type Description
host string IP address or hostname of the PF400
port int32 Port number for communication
joints int32 Number of robot joints
gpl_version string GPL (Guidance Programming Language) version

Commands

Move

Moves the robot to a specified location.

Parameters

Parameter Type Required Description
location string Yes Target location name
motion_profile string No Motion profile to use for movement
approach_height int32 No Height to approach from (mm)

GraspPlate

Grasps a plate with specified parameters.

Parameters

Parameter Type Description
width int32 Gripper width setting
speed int32 Gripper closing speed
force int32 Gripping force

ReleasePlate

Releases the currently held plate.

Parameters

Parameter Type Description
width int32 Gripper opening width
speed int32 Gripper opening speed

Transfer

Transfers a plate from source to destination.

Parameters

Parameter Type Required Description
source_nest string Yes Source location name
destination_nest string Yes Destination location name
labware string Yes Labware type being transferred
motion_profile string No Motion profile for transfer

Wait

Waits for a specified duration.

Parameters

Parameter Type Description
duration int32 Wait duration in milliseconds

RetrievePlate

Retrieves a plate from a specified location.

Parameters

Parameter Type Required Description
labware string Yes Labware type to retrieve
location string Yes Location to retrieve from
approach_height float No Approach height (mm)
motion_profile string No Motion profile to use

DropOffPlate

Drops off a plate at a specified location.

Parameters

Parameter Type Required Description
labware string Yes Labware type to drop off
location string Yes Location to drop off at
approach_height float No Approach height (mm)
motion_profile string No Motion profile to use

PickLid

Picks up a plate lid.

Parameters

Parameter Type Required Description
labware string Yes Labware type
location string Yes Location of the lid
motion_profile string No Motion profile to use
pick_from_plate bool No Whether to pick from plate
approach_height float No Approach height (mm)

PlaceLid

Places a lid on a plate or location.

Parameters

Parameter Type Required Description
labware string Yes Labware type
location string Yes Location to place lid
motion_profile string No Motion profile to use
place_on_plate bool No Whether to place on plate
approach_height float No Approach height (mm)

Engage

Engages the gripper.

Parameters

No parameters required

Release

Releases the gripper.

Parameters

No parameters required

Unwind

Unwinds the robot to prevent cable strain.

Parameters

No parameters required

RunSequence

Runs a predefined sequence.

Parameters

Parameter Type Description
sequence_name string Name of the sequence to run
labware string Labware type for the sequence

GetCurrentLocation

Gets the current robot location.

Parameters

No parameters required

Jog

Jogs the robot along a specified axis.

Parameters

Parameter Type Description
axis string Axis to jog (e.g., "X", "Y", "Z")
distance float Distance to jog (mm)

RawCommand

Sends a raw command to the PF400.

Parameters

Parameter Type Description
command string Raw GPL command string

RegisterMotionProfile

Registers a custom motion profile.

Parameters

Parameter Type Description
id int32 Profile ID
speed float Movement speed
speed2 float Secondary speed parameter
accel float Acceleration
decel float Deceleration
accel_ramp float Acceleration ramp
decel_ramp float Deceleration ramp
inrange float In-range tolerance
straight int32 Straight-line movement flag

LoadWaypoints

Loads waypoint definitions.

Parameters

Parameter Type Description
waypoints google.protobuf.Struct Waypoint configuration structure

LoadLabware

Loads labware definitions.

Parameters

Parameter Type Description
labwares google.protobuf.Struct Labware configuration structure

Table of contents