pylabrobot.pumps.pump.Pump#
- class pylabrobot.pumps.pump.Pump(name: str, size_x: float, size_y: float, size_z: float, backend: PumpBackend, category: str | None = None, model: str | None = None, calibration: PumpCalibration | None = None)#
Bases:
Machine
Frontend for a (peristaltic) pump.
Attributes
Get the name of this resource.
Methods
__init__
(name, size_x, size_y, size_z, backend)assign_child_resource
(resource, location[, ...])Assign a child resource to this resource.
center
([x, y, z])Get the center of this resource.
centers
([xn, yn, zn])Get equally spaced points in the x, y, and z directions.
copy
()Copy this resource.
deregister_did_assign_resource_callback
(callback)Remove a callback that will be called after a resource is assigned to this resource.
Remove a callback that will be called after a resource is unassigned from this resource.
deregister_state_update_callback
(callback)Remove a callback that will be called when the state of the resource changes.
Remove a callback that will be called before a resource is assigned to this resource.
Remove a callback that will be called before a resource is unassigned from this resource.
deserialize
(data)Deserialize a resource from a dictionary.
Get the absolute location of this resource, probably within the
pylabrobot.resources.Deck
.Recursively get all children of this resource.
get_resource
(name)Get a resource by name.
Get the size of this resource in the z-direction.
halt
()Halt the pump.
load_all_state
(state)Load state for this resource and all children.
load_from_json_file
(json_file)Loads resources from a JSON file.
load_state
(state)Load state for this resource only.
Load the state of this resource and all children from a JSON file.
pump_volume
(speed, volume)Run the pump at specified speed for the specified volume.
register_did_assign_resource_callback
(callback)Add a callback that will be called after a resource is assigned to this resource.
register_did_unassign_resource_callback
(callback)Add a callback that will be called after a resource is unassigned from this resource.
register_state_update_callback
(callback)Register a callback that will be called when the state of the resource changes.
register_will_assign_resource_callback
(callback)Add a callback that will be called before a resource is assigned to this resource.
Add a callback that will be called before a resource is unassigned from this resource.
rotate
(degrees)Rotate counter clockwise by the given number of degrees.
rotated
(degrees)Return a copy of this resource rotated by the given number of degrees.
run_continuously
(speed)Run continuously at a given speed.
run_for_duration
(speed, duration)Run the pump at specified speed for the specified duration.
run_revolutions
(num_revolutions)Run a given number of revolutions.
save
(fn[, indent])Save a resource to a JSON file.
save_state_to_file
(fn[, indent])Save the state of this resource and all children to a JSON file.
Serialize this resource.
Serialize the state of this resource and all children.
Serialize the state of this resource only.
setup
()stop
()unassign
()Unassign this resource from its parent.
unassign_child_resource
(resource)Unassign a child resource from this resource.