pylabrobot.only_fans.fan.Fan#
- class pylabrobot.only_fans.fan.Fan(backend: FanBackend, name)#
Bases:
Machine
Front end for Fans.
Attributes
Get the name of this resource.
Methods
__init__
(backend, name)Initialize a Fan.
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
()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[, allow_marshal])Deserialize a resource from a dictionary.
get_absolute_location
([x, y, z])Get the absolute location of this resource, probably within the
pylabrobot.resources.Deck
.Get the absolute rotation of this resource.
Get the absolute size in the x direction.
Get the absolute size in the y direction.
Get the absolute size in the z direction.
Recursively get all children of this resource.
get_anchor
(x, y, z)Get a relative location within the resource.
get_resource
(name)Get a resource by name.
Local size in the x direction.
Local size in the y direction.
Local size in the z direction.
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.
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
([x, y, z])Rotate counter-clockwise by the given number of degrees.
rotated
([x, y, z])Return a copy of this resource rotated by the given number of degrees.
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
(**backend_kwargs)stop
()Stop the fan and close the connection.
turn_off
()Turn the fan off, but do not close the connection.
turn_on
(intensity[, duration])Run the fan
unassign
()Unassign this resource from its parent.
unassign_child_resource
(resource)Unassign a child resource from this resource.
- Parameters:
backend (FanBackend)